Resizable and draggable component for React.
See demo: http://bokuweb.github.io/react-rnd/
demo Code: https://github.com/bokuweb/react-rnd/blob/master/docs/src/example.js
npm i react-rnd<Rnd
ref={c => { this.rnd = c; }}
initial={{
x: window.innerWidth / 2 - 200,
y: window.innerHeight / 2 - 80,
width: 400,
height: 160,
}}
style={style}
minWidth={300}
minHeight={160}
maxWidth={800}
maxHeight={300}
bounds={'parent'}
>
<span className="box">
resize and drag me!!
</span>
</Rnd>initial: PropTypes.shape({width: PropTypes.oneOfType([ PropTypes.number, PropTypes.string ]), height: PropTypes.oneOfType([ PropTypes.number, PropTypes.string ]), x: PropTypes.number, y: PropTypes.number }),
The width and height property is used to set the size of a component.
The x and y property is used to set the initial position of the component.
The minWidth property is used to set the minimum width of a component.
The minHeight property is used to set the minimum height of a component.
The maxWidth property is used to set the maximum width of a component.
The maxheight property is used to set the maximum height of a component.
The className property is used to set the custom className of a component.
The style property is used to set the custom style of a component.
resizerHandleStyle: PropTypes.shape({ top: PropTypes.object, right: PropTypes.object, bottom: PropTypes.object, left: PropTypes.object, topRight: PropTypes.object, bottomRight: PropTypes.object, bottomLeft: PropTypes.object, topLeft: PropTypes.object })
The resizerHandleStyle 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.
isResizable: PropTypes.shape({ top: PropTypes.bool, right: PropTypes.bool, bottom: PropTypes.bool, left: PropTypes.bool, topRight: PropTypes.bool, bottomRight: PropTypes.bool, bottomLeft: PropTypes.bool, topLeft: PropTypes.bool })
The isResizable property is used to set the resizable permission of a resizable 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 }.
Calls when resizable component clicked.
Calls when resizable component touched.
Calls when resizable component double clicked.
Calls when resizable component resize starts.
Calls back with (direction: string, styleSize: object, clientSize: object, event: object)
- direction:
top,right,bottom,left,topRight,bottomRight,bottomLeft, andtopLeft. - styleSize:
{ width, height }- this argument is {width, height} of getComputedStyle.
- clientSize:
{ width, height }- this argument is
clientWidthandclientHeight.
- this argument is
- event:
mouse down event
Calls when resizable component resize.
Calls back with (direction: string, styleSize: object, clientSize: object, delta: object, newPos: object)
- direction:
top,right,bottom,left,topRight,bottomRight,bottomLeft, andtopLeft. - styleSize:
{ width, height }- this argument is {width, height} of getComputedStyle.
- clientSize:
{ width, height }- this argument is
clientWidthandclientHeight.
- this argument is
- delta:
{ width, height }- this delta width and height by resize.
- newPos:
{ x, y }- new position of the element.
For example, when <Resizable width={100} height={200} style={{ padding: '20px'}} onResize={...} /> mounted and resize 'right' 20px, this callback is called with ('right', { width: 120, height: 200 }, { width: 160, height: 240 }, {width: 20, height: 0})
Calls back with (direction: string, styleSize: object, clientSize: object, delta: object)
- direction:
top,right,bottom,left,topRight,bottomRight,bottomLeft, andtopLeft. - styleSize:
{ width, height }- this argument is {width, height} of getComputedStyle.
- clientSize:
{ width, height }- this argument is
clientWidthandclientHeight.
- this argument is
- delta:
{ width, height }- this delta width and height by resize.
For example, when <Resizable width={100} height={200} style={{ padding: '20px'}} onResize={...} /> mounted and resize 'right' 20px, this callback is called with ('right', { width: 120, height: 200 }, { width: 160, height: 240 }, {width: 20, height: 0}, {x: 20, y: 0})
The direction of allowed movement (dragging) allowed ('x','y','both','none').
The lockAspectRatio property is used to lock aspect ratio.
If ommited, set false.
Callback called on dragging start.
Callback called on resizing.
onDrag called with the following parameters:
(
event: Event,
ui:{
deltaX: number, deltaY: number,
node: Node
position:
{
left: number, top: number
}
}
)Callback called on dragging stop.
onDragStop called with the following parameters:
(
event: Event,
ui:{
deltaX: number, deltaY: number,
node: Node
position:
{
left: number, top: number
}
}
)Specifies movement boundaries. Accepted values:
parentrestricts movement within the node's offsetParent (nearest node with position relative or absolute), or- An object with
left, top, right, and bottomproperties. These indicate how far in each direction the draggable can be moved.
Specifies a selector to be used as the handle that initiates drag. Example: '.handle'.
The zIndex property is used to set the zindex of a component.
The resizeGrid property is used to specify the increments that resizing should snap to. Defaults to [1, 1].
The moveGrid property is used to specify the increments that moving should snap to. Defaults to [1, 1].
Update component size.
grid ,max/minWidth, max/minHeight props is ignored, when this method called.
- for example
class YourComponent extends Component {
...
update() {
this.rnd.updateSize({ width: 200, height: 300 });
}
render() {
return (
<Rnd ref={c => { this.rnd = c; }}>
example
</Rnd>
);
}
...
}Update component size.
grid bounds props is ignored, when this method called.
- for example
class YourComponent extends Component {
...
update() {
this.rnd.updatePosition({ x: 200, y: 300 });
}
render() {
return (
<Rnd ref={c => { this.rnd = c; }}>
example
</Rnd>
);
}
...
}npm t- Pass the new position in the onResizeStop callback #60
- Pass the new position along in the resize callback #55
- Fix style props to applt zIndex chaned.
- Rename
react-rnd. - Remove
canUpdatePositionByParentproperty. - Remove
canUpdateSizeByParentproperty. - Remove
initiAsResizingproperty. - Change
x,y,widthandheightproperty toinitial. - Add
updateSize,updatePosition, method to updated conponent state. - Add
lockAspectRatioproperty to lock aspect ratio when resizing.
- Add
canUpdatePositionByParentproperty.
- Fix bug, resize and grid not work properly.
- Add
gridprops to snap grid. (thanks @paulyoung) - Fix bug, moveAxis not work properly.
- Fix situations when on dragStop you wanted to revert to 0,0 position #39
- Add
canUpdateSizeByParentprops #38
- Add object.assign transform
- Add add module exports plugin for
require
- Bug fix
- Support react v15.x
- Support left, top resizer
- Remove start props, use width, height, x, and y.
- Add handle selector
The MIT License (MIT)
Copyright (c) 2016 @Bokuweb
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.