Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bokuweb/react-rnd

🖱 A resizable and draggable component for React.
https://github.com/bokuweb/react-rnd

component drag draggable react resizable resize

Last synced: 6 days ago
JSON representation

🖱 A resizable and draggable component for React.

Host: GitHub
URL: https://github.com/bokuweb/react-rnd
Owner: bokuweb
License: mit
Created: 2016-01-02T07:47:27.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2024-07-30T03:13:32.000Z (3 months ago)
Last Synced: 2024-07-30T23:30:19.325Z (3 months ago)
Topics: component, drag, draggable, react, resizable, resize
Language: TypeScript
Homepage: https://bokuweb.github.io/react-rnd/stories
Size: 27.7 MB
Stars: 3,844
Watchers: 23
Forks: 322
Open Issues: 163
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-react-cn - react-resizable-and-movable - A resizable and draggable component for React (Uncategorized / Uncategorized)
best-of-react - GitHub - 46% open · ⏱️ 26.05.2024): (Drag & Drop)

README

A resizable and draggable component for React.

## Table of Contents

* [Screenshot](#Screenshot)
* [Live Demo](#live-demo)
* [Storybook](#storybook)
* [CodeSandbox](#codesandbox)
* [Install](#install)
* [Usage](#usage)
* [Props](#props)
* [Instance API](#instance-api)
* [updateSize(size: { width: number | string, height: number | string }): void](#updateSize-void)
* [updatePosition({ x: number, y: number }): void](#updatePosition-void)
* [Test](#test)
* [Related](#related)
* [Changelog](#changelog)
* [License](#license)

## Screenshot

https://codesandbox.io/s/xpm699v4lp

## Live Demo

### Storybook

[Storybook](http://bokuweb.github.io/react-rnd/stories)

### CodeSandbox

[![Edit y3997qply9](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/y3997qply9)
[CodeSandbox(with default)](https://codesandbox.io/s/y3997qply9)
[CodeSandbox(with size and position)](https://codesandbox.io/s/my4kjly94x)
[CodeSandbox(with typescript)](https://codesandbox.io/s/j1vvkpo9wv)
[CodeSandbox(with hooks)](https://codesandbox.io/p/sandbox/pensive-babycat-8kxhnr)

## Install

- use npm

```sh
npm i -S react-rnd
```

- use yarn

```sh
yarn add react-rnd
```

## Usage

### Example with `default`

``` javascript

Rnd

```

### Example with `position` and `size`

``` javascript
{ this.setState({ x: d.x, y: d.y }) }}
onResizeStop={(e, direction, ref, delta, position) => {
this.setState({
width: ref.style.width,
height: ref.style.height,
...position,
});
}}
>
001

```

## Props

#### `default: { x: number; y: number; width?: number | string; height?: number | string; };`

The `width` and `height` property is used to set the default size of the component.
For example, you can set `300`, `'300px'`, `50%`.
If omitted, set `'auto'`.

The `x` and `y` property is used to set the default position of the component.

#### `size?: { width: (number | string), height: (number | string) };`

The `size` property is used to set size of the component.
For example, you can set 300, '300px', 50%.

Use `size` if you need to control size state by yourself.

#### `position?: { x: number, y: number };`

The `position` property is used to set position of the component.
Use `position` if you need to control size state by yourself.

see, following example.

``` javascript
{ this.setState({ x: d.x, y: d.y }) }}
onResize={(e, direction, ref, delta, position) => {
this.setState({
width: ref.offsetWidth,
height: ref.offsetHeight,
...position,
});
}}
>
001

```

#### `className?: string;`

The `className` property is used to set the custom `className` of the component.

#### `style?: { [key: string]: string };`

The `style` property is used to set the custom `style` of the component.

#### `minWidth?: number | string;`

The `minWidth` property is used to set the minimum width of the component.
For example, you can set `300`, `'300px'`, `50%`.

#### `minHeight?: number | string;`

The `minHeight` property is used to set the minimum height of the component.
For example, you can set `300`, `'300px'`, `50%`.

#### `maxWidth?: number | string;`

The `maxWidth` property is used to set the maximum width of the component.
For example, you can set `300`, `'300px'`, `50%`.

#### `maxHeight?: number | string`;

The `maxHeight` property is used to set the maximum height of the component.
For example, you can set `300`, `'300px'`, `50%`.

#### `resizeGrid?: [number, number];`

The `resizeGrid` property is used to specify the increments that resizing should snap to. Defaults to `[1, 1]`.

#### `dragGrid?: [number, number];`

The `dragGrid` property is used to specify the increments that moving should snap to. Defaults to `[1, 1]`.

#### `lockAspectRatio?: boolean | number;`

The `lockAspectRatio` property is used to lock aspect ratio.
Set to `true` to lock the aspect ratio based on the initial size.
Set to a numeric value to lock a specific aspect ratio (such as `16/9`).
If set to numeric, make sure to set initial height/width to values with correct aspect ratio.
If omitted, set `false`.

#### `lockAspectRatioExtraWidth?: number;`

The `lockAspectRatioExtraWidth` property enables a resizable component to maintain an aspect ratio plus extra width.
For instance, a video could be displayed 16:9 with a 50px side bar.
If omitted, set `0`.

#### `scale?: number;`

Specifies the scale of the canvas you are dragging or resizing this element on. This allows
you to, for example, get the correct drag / resize deltas while you are zoomed in or out via
a transform or matrix in the parent of this element.
If omitted, set `1`.

#### `lockAspectRatioExtraHeight?: number;`

The `lockAspectRatioExtraHeight` property enables a resizable component to maintain an aspect ratio plus extra height.
For instance, a video could be displayed 16:9 with a 50px header bar.
If omitted, set `0`.

#### `dragHandleClassName?: string;`

Specifies a selector to be used as the handle that initiates drag.
Example: `handle`.

#### `resizeHandleStyles?: HandleStyles;`

The `resizeHandleStyles` property is used to override the style of one or more resize handles.
Only the axis you specify will have its handle style replaced.
If you specify a value for `right` it will completely replace the styles for the `right` resize handle,
but other handle will still use the default styles.

``` javascript

export type HandleStyles = {
bottom?: React.CSSProperties,
bottomLeft?: React.CSSProperties,
bottomRight?: React.CSSProperties,
left?: React.CSSProperties,
right?: React.CSSProperties,
top?: React.CSSProperties,
topLeft?: React.CSSProperties,
topRight?: React.CSSProperties
}
```

#### `resizeHandleClasses?: HandleClasses;`

The `resizeHandleClasses` property is used to set the className of one or more resize handles.

``` javascript
type HandleClasses = {
bottom?: string;
bottomLeft?: string;
bottomRight?: string;
left?: string;
right?: string;
top?: string;
topLeft?: string;
topRight?: string;
}
```

#### `resizeHandleComponent?`: HandleCompoent;`

The `resizeHandleComponent` allows you to pass a custom React component as the resize handle.

``` javascript
type HandleComponent = {
top?: React.ReactElement;
right?: React.ReactElement;
bottom?: React.ReactElement;
left?: React.ReactElement;
topRight?: React.ReactElement;
bottomRight?: React.ReactElement;
bottomLeft?: React.ReactElement;
topLeft?: React.ReactElement;
}
```

#### `resizeHandleWrapperClass?: string;`

The `resizeHandleWrapperClass` property is used to set css class name of resize handle wrapper(`span`) element.

#### `resizeHandleWrapperStyle?: Style;`

The `resizeHandleWrapperStyle` property is used to set css class name of resize handle wrapper(`span`) element.

#### `enableResizing?: ?Enable;`

The `enableResizing` property is used to set the resizable permission of the component.

The permission of `top`, `right`, `bottom`, `left`, `topRight`, `bottomRight`, `bottomLeft`, `topLeft` direction resizing.
If omitted, all resizer are enabled.
If you want to permit only right direction resizing, set `{ top:false, right:true, bottom:false, left:false, topRight:false, bottomRight:false, bottomLeft:false, topLeft:false }`.

``` javascript
export type Enable = {
bottom?: boolean;
bottomLeft?: boolean;
bottomRight?: boolean;
left?: boolean;
right?: boolean;
top?: boolean;
topLeft?: boolean;
topRight?: boolean;
} | boolean
```

#### `disableDragging?: boolean;`

The `disableDragging` property disables dragging completely.

#### `cancel?: string;`

The `cancel` property disables specifies a selector to be used to prevent drag initialization (e.g. `.body`).

#### `dragAxis?: 'x' | 'y' | 'both' | 'none'`

The direction of allowed movement (dragging) allowed ('x','y','both','none').

#### `bounds?: string; | Element`

Specifies movement boundaries. Accepted values:
- `parent` restricts movement within the node's offsetParent
(nearest node with position relative or absolute)
- `window`, `body`, Selector like `.fooClassName` or
- `Element`.

#### `enableUserSelectHack?: boolean;`

By default, we add 'user-select:none' attributes to the document body
to prevent ugly text selection during drag. If this is causing problems
for your app, set this to `false`.

#### `scale?: number;`

Specifies the scale of the canvas your are resizing and dragging this element on. This allows
you to, for example, get the correct resize and drag deltas while you are zoomed in or out via
a transform or matrix in the parent of this element.
If omitted, set `1`.

## Callback

#### `onResizeStart?: RndResizeStartCallback;`

`RndResizeStartCallback` type is below.

``` javascript
export type RndResizeStartCallback = (
e: SyntheticMouseEvent | SyntheticTouchEvent,
dir: ResizeDirection,
refToElement: React.ElementRef<'div'>,
) => void;
```

Calls when resizable component resize start.

#### `onResize?: RndResizeCallback;`

`RndResizeCallback` type is below.

``` javascript
export type RndResizeCallback = (
e: MouseEvent | TouchEvent,
dir: ResizeDirection,
refToElement: React.ElementRef<'div'>,
delta: ResizableDelta,
position: Position,
) => void;
```

Calls when resizable component resizing.

#### `onResizeStop?: RndResizeCallback;`

`RndResizeCallback` type is below.

``` javascript
export type RndResizeCallback = (
e: MouseEvent | TouchEvent,
dir: ResizeDirection,
refToElement: React.ElementRef<'div'>,
delta: ResizableDelta,
position: Position,
) => void;
```

Calls when resizable component resize stop.

#### `onDragStart: DraggableEventHandler;`

Callback called on dragging start.

``` javascript
type DraggableData = {
node: HTMLElement,
x: number,
y: number,
deltaX: number, deltaY: number,
lastX: number, lastY: number
};

type DraggableEventHandler = (
e: SyntheticMouseEvent | SyntheticTouchEvent, data: DraggableData,
) => void | false;
```

#### `onDrag: DraggableEventHandler;`

`onDrag` called with the following parameters:

``` javascript
type DraggableData = {
node: HTMLElement,
x: number,
y: number,
deltaX: number, deltaY: number,
lastX: number, lastY: number
};

type DraggableEventHandler = (
e: SyntheticMouseEvent | SyntheticTouchEvent, data: DraggableData,
) => void | false;
```

#### `onDragStop: DraggableEventHandler;`

`onDragStop` called on dragging stop.

``` javascript
type DraggableData = {
node: HTMLElement,
x: number,
y: number,
deltaX: number, deltaY: number,
lastX: number, lastY: number
};

type DraggableEventHandler = (
e: SyntheticMouseEvent | SyntheticTouchEvent, data: DraggableData,
) => void | false;
```

## Instance API

#### `updateSize(size: { width: string | number, height: string | number })`

Update component size.
For example, you can set `300`, `'300px'`, `50%`.

- for example

``` js
class YourComponent extends Component {

...

update() {
this.rnd.updateSize({ width: 200, height: 300 });
}

render() {
return (
{ this.rnd = c; }} ...rest >
example

);
}
...
}
```

#### `updatePosition({ x: number, y: number }): void`

Update component position.
`grid` `bounds` props is ignored, when this method called.

- for example

``` js
class YourComponent extends Component {

...

update() {
this.rnd.updatePosition({ x: 200, y: 300 });
}

render() {
return (
{ this.rnd = c; }} ...rest >
example

);
}

...
}
```

#### `allowAnyClick?: boolean`

If set to `true`, will allow dragging on non left-button clicks.

## Test

``` sh
npm t
```

## Contribute

If you have a feature request, please add it as an issue or make a pull request.

If you have a bug to report, please reproduce the bug in [CodeSandbox](https://codesandbox.io/s/y3997qply9) to help us easily isolate it.

## Changelog

#### v10.4.13

- Upgrade `re-resizable` to `6.10.0`

#### v10.4.12

- Fixes $945, When using vite and resizing from other than right and bottom - the element is shaking weirdly.

- Upgrade `re-resizable` to `6.9.17`
- Fixes #942, define callback refs inline to work with latest versions of Next.js / React.

#### v10.4.10

- Upgrade `re-resizable` to `6.9.14`

#### v10.4.7

- Fixed a bug, `maxHeight` does not work with `%` #914

#### v10.4.6

- Upgrade `re-resizable` to `6.9.11`
- Upgrade `react-draggable` to `4.4.6`
- Fixed a bug, wrong position in `onDrag` #910

#### v10.4.1

- Support Element for bounds.

#### v10.3.7

- Upgrade `re-resizable` to `6.9.6`
- Add peer deps.

#### v10.3.6

- Upgrade `re-resizable` to `6.9.2`
- Upgrade `react-draggable` to v4.4.4

#### v10.3.5

- Upgrade `re-resizable` to `6.9.1`

#### v10.3.4

- Fixed a bound check with locked aspect ratio (fully fixes #209)

#### v10.3.1, v10.3.2

- Fixed a bug, top and left resize issue, caused by "position" #792

#### v10.3.0

- Fixed a callback position when dragAxis specified

#### v10.2.5

- Fixed a glitch when dragAxis is enabled and component is being resized #780

#### v10.2.3

- Fixed a bug, if set minWidth or minHeight with `px`, reize dowes not work. #739

#### v10.2.0

- Upgrade `react-draggable` to v4.4.3
- Add `allowAnyClick` props.
- Add `nodeRef` props.

#### v10.1.10

- Downgrade `react-draggable` to v4.2.0 #690

#### v10.1.9

- Update `react-draggable` to v4.3.1

#### v10.1.8

- Update `re-resizable` to v6.3.2

#### v10.1.7

- A minor fix for a bug with forwarding of cancelling indication of an onDrag event. (#667)

#### v10.1.6

- Fixes #641 without causing other issues with typing.

#### v10.1.5

- Fixed a bug, react-draggable not bundling with rollup #641

#### v10.1.4

- Fixed a bug, box moves when resized #622

#### v10.1.3

- Fixed a bug, position is wrong when onResize #618

#### v10.1.2

- Upgrade re-resizable to 6.1.1
- Upgrade react-draggable to 4.1.0

#### v10.1.1

- Upgrade re-resizable to 6.1.0

#### v10.1.0

- Implement resizeHandleComponent #591
- Update dependency react-draggable to v4

#### v10.0.0

- Fix: Fix #526
- Feat: Add `onMouseUp` callback.
- Feat: Use `React.pureComponent`

#### v9.2.0

- Chore: Use `re-resizablev5`

#### v9.1.2

- Fix: Fixes memory leak #499

#### v9.1.1

- Fix: Add `scale` props to index.js.flow.

#### v9.1.0

- Feat: Add `scale` props. #482
- Feat: Upgrade deps.

#### v9.0.4

- Fix: cursor style #469

#### v9.0.3

- update dependency re-resizable to v4.9.3 #444

#### v9.0.2

- fix: resizeHandleWrapperClass warning shown in console #428

#### v9.0.1

- fix: Allow additional props in typescript.

#### v9.0.0

- fix: change `default export` to `export` #405

#### v8.0.2

- fix: fixed a bug, `bounds` is ignored when lock aspect ratio set.
- feat: add `body` to bounds props.

#### v8.0.1

- fix: [#221] fixed a bug, maxwidth / height not applied.

#### v8.0.0

- fix: fixed some position and resizing bug.
- fix: [#209] bounds `window`. you can check [here](http://bokuweb.github.io/react-rnd/stories/?selectedKind=bounds&selectedStory=window%20controlled&full=0&addons=1&stories=1&panelRight=0&addonPanel=storybook%2Factions%2Factions-panel).
- fix: [#317] add onMouseDown. i.e) ``
- [BREAKING] fix: [#335] add . to `dragHandleClassName` automatically, Please pass string (i.e `handle`.
- [BREAKING] fix: remove `extendsProps`. Please add extends props directly. i.e) ``
- [BREAKING] fix: remove `z` props. Please add `zIndex` via `style` props. i.e) ``

#### v8.0.0-beta.2

- fix: Upgrade `re-resizable` to fix percentage size and bare behavior.

#### v8.0.0-beta.1

- fix: Fixed a bug, controlled position does not work correctly.
- feat: Use `typescript` instead of `flowype`.

#### v8.0.0-beta.0

- fix: Remove dummy `

`, `isMounted` state and `setParentPosition()`.

#### v7.4.3

- fix: Add `props,children` to dummy `

` to render children in first.

#### v7.4.2 (unpublished)

fix: `isMounted` and `(!this.state.isMounted) return

` line #356

#### v7.4.1

- fix: Fixed Array.from error in IE11

#### v7.4.0

- fix: add `enableUserSelectHack?: boolean;`.

#### v7.3.1

- chore(deps): upgrade deps
- chore(deps): upgrade lint and remove unused state
- chore(deps): install prettier

#### v7.3.0

- chore(deps): upgrade re-resizable

#### v7.2.0

- Support for cancel feature of react-draggable #206

#### v7.1.5

- Fixed a issue #199 Add enableUserSelectHack props to react-draggable

#### v7.1.4

- Fixed a issue #188 maxWidth and maxHeight props don't respect after resize

#### v7.1.3

- Fixed a bug, `extendProps` is not passed correctly.
- Fixed a bug, `bounds` is not work correctly. (#162)

#### v7.1.1 / v7.1.2

- Add internal props.

#### v7.1.0

- Add `size`.
- Add `position`.

#### v7.0.0

- Add `default` instead of `x`, `y`, `width`, `height`.
- Add `resizeHandleWrapperClass` and `resizeHandleWrapperStyle`.

#### v6.0.1

- Remove unnecessary types.

#### v6.0.0

- Use rollup.
- Support % min/max size.
- Change props, remove `default` and add `x`, `y`, `width`, `height`.
- Rename `dragHandlersXXXX` and `resizeHandlersXXXX` props to `dragHandleXXXX` and `resizeHandleXXXX`.

#### v5.1.3

- Fix cursor style, set `normal` to cursor style when `dragHandlerClassName` is not empty.

#### v5.1.2

- Add position `relative` when component will update.

#### v5.1.1

- Add `top: 0`, `left: 0`.
- Add position `relative` when parent position equals `static`.

#### v5.1.0

- Update dependencies(`react-draggable v3`, `flow-bin v0.53`, and other...)

#### v5.0.9

- Fix bug new `z` props is not applied to state.

#### v5.0.8

- Add `extendsProps`. #129

#### v5.0.7

- Add `disableDragging` props.

#### v5.0.6

- Fix flow error.

#### v5.0.5

- Add index.js.flow

#### v5.0.4

- Fix Issue #117.

#### v5.0.3

- Fix `updateZIndex`.
- Fix `updateSize`.
- Fix left and top bounds.

#### v5.0.2

- Fix argument events #100

#### v5.0.1

- Fix example
- Update README

#### v5.0.0

- Fix resize bounds.
- Modify API.
- Use original `react-draggable`.

#### v4.2.1

- Added `updateZIndex`, method to updated component `zIndex` state.

#### v4.2.0

- Pass the new position in the onResizeStop callback #60

#### v4.1.0

- Pass the new position along in the resize callback #55

#### v4.0.1

- Fix style props to applt zIndex chaned.

#### v4.0.0

- Rename `react-rnd`.
- Remove `canUpdatePositionByParent` property.
- Remove `canUpdateSizeByParent` property.
- Remove `initiAsResizing` property.
- Change `x`, `y`, `width` and `height` property to `initial`.
- Add `updateSize`, `updatePosition`, method to updated conponent state.
- Add `lockAspectRatio` property to lock aspect ratio when resizing.

#### v3.0.0

- Add `canUpdatePositionByParent` property.

#### v2.0.0

- Fix bug, resize and grid not work properly.

#### v1.2.0

- Add `grid` props to snap grid. (thanks @paulyoung)
- Fix bug, moveAxis not work properly.

#### v1.1.3

- Fix situations when on dragStop you wanted to revert to 0,0 position #39
- Add `canUpdateSizeByParent` props #38

#### v1.1.2

- Add object.assign transform

#### v1.1.0

- Add add module exports plugin for `require`

#### v1.0.1

- Bug fix

#### v1.0.0

- Support react v15.x
- Support left, top resizer
- Remove start props, use width, height, x, and y.

#### v0.5.3

- Add handle selector

## License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.