📏 A resizable component for React.
CodeSandbox
CodeSandbox(TypeScript)
$ npm install --save re-resizable<Resizable
defaultSize={{
width:320,
height:200,
}}
>
Sample with default size
</Resizable>If you use size props, please manage state by yourself.
<Resizable
size={{ width: this.state.width, height: this.state.height }}
onResizeStop={(e, direction, ref, d) => {
this.setState({
width: this.state.width + d.width,
height: this.state.height + d.height,
});
}}
>
Sample with size
</Resizable>Specifies the width and height that the dragged item should start at.
For example, you can set 300, '300px', 50%.
If both defaultSize and size omitted, set 'auto'.
defaultSize will be ignored when size set.
The size property is used to set the size of the component.
For example, you can set 300, '300px', 50%.
Use size if you need to control size state by yourself.
The className property is used to set the custom className of a resizable component.
The style property is used to set the custom style of a resizable component.
The minWidth property is used to set the minimum width of a resizable component. Defaults to 10px.
The minHeight property is used to set the minimum height of a resizable component. Defaults to 10px.
The maxWidth property is used to set the maximum width of a resizable component.
The maxHeight property is used to set the maximum height of a resizable component.
The grid property is used to specify the increments that resizing should snap to. Defaults to [1, 1].
The snap property is used to specify absolute pixel values that resizing should snap to. x and y are both optional, allowing you to only include the axis you want to define. Defaults to null.
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.
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.
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.
Specifies resize boundaries.
The handleStyles 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.
The handleClasses property is used to set the className of one or more resize handles.
The handleComponent property is used to pass a React Component to be rendered as one or more resize handle. For example, this could be used to use an arrow icon as a handle..
The handleWrapperStyle property is used to override the style of resize handles wrapper.
The handleWrapperClass property is used to override the className of resize handles wrapper.
The enable 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 }.
ResizeStartCallBack type is below.
type ResizeStartCallback = (
e: SyntheticMouseEvent<HTMLDivElement> | SyntheticTouchEvent<HTMLDivElement>,
dir: ResizableDirection,
refToElement: HTMLDivElement,
) => void;Calls when resizable component resize start.
The scale property is used in the scenario where the resizable element is a descendent of an element using css scaling (e.g. - transform: scale(0.5)).
ResizeCallback type is below.
type ResizeCallback = (
event: MouseEvent | TouchEvent,
direction: ResizableDirection,
refToElement: HTMLDivElement,
delta: NumberSize,
) => void;Calls when resizable component resizing.
ResizeCallback type is below.
type ResizeCallback = (
event: MouseEvent | TouchEvent,
direction: ResizableDirection,
refToElement: HTMLDivElement,
delta: NumberSize,
) => void;Calls when resizable component resize stop.
Update component size.
grid, snap, max/minWidth, max/minHeight props is ignored, when this method called.
- for example
class YourComponent extends Component {
...
update() {
this.resizable.updateSize({ width: 200, height: 300 });
}
render() {
return (
<Resizable ref={c => { this.resizable = c; }}>
example
</Resizable>
);
}
...
}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 to help us easily isolate it.
npm test- Add scale props #388
- Fix auto having "px" appended #382
- Adjust initial left position of element to 0 for safari fix. #374
- Fix flow type #364
- added snap to
index.d.ts.
- added feature: absolute snap dimensions #337
- fix: fix behavior when set auto
- fix: fix behavior which is set percentage size and absolute position
- fix: Fixed
index.d.ts,HTMLElementtoHTMLDivElementand other. - fix: Fixed
index.d.tsto allow number for aspectLatio. - fix: downgrade
rollupversion, because v0.61.0 breakre-resizablebuild.
- fix: Fixed
index.d.ts,HTMLElementtoHTMLDivElementand other.
- fix: Fixed
index.d.tsto allow number for aspectLatio.
- fix: Fixed
index.d.tsto allowHTMLDivElementproperties. #292
- fix: Fixed
Array.fromerror in IE11
- fix: Fixed behavior when nested #220
- fix: #218 size not updated when zero props pass
- fix: use
relativeposition when get base size
- chore: upgrade flow-bin
- fix: base finder
- fix: add mouse leave
- fix: fix type issues in index.d.ts.
- fix: fixed bug where base could not be found
- fix: add guard to avoid error without parent
- fix: bug behavior with flex layout
- chore: refactor
- chore: update deps
- chore: update d.ts
- chore: add some stories
- Fixed a bug, when resizing sometimes causes text-selection in some browser #182
- Fixed a bug,
autooverwritten by px value #179
- Allow 0 as minWidth and minHeight #178
- Add a option for passing custom handle components #170
- Fixed a bug, Text select while resizing in IE11 #166
- Fixed a bug, Element width id="__resizable0" breaks my layout #162
- Additional height and width with lockAspectRatio #163
- Use ES5-compatible prototype methods #160
- Fix using right click on resize #152
- Add workaround when base Node not found.
- Update index.d.ts, Fixes #153
- Remove
widthandheight. - Add
defaultSizeandsize,
- Fix flowtype annotation.
- Remove
extendsProps.
You can add extendsProps as follows.
<Resizable data-foo="foo" />
- fix typo.
ResizeStartCallBack->ResizeStartCallback.
- export
ResizeDirectiontype. - rename
CallbacktoResizeCallback.
- Fix flow filename.
- Change logo
- Change package name,
react-resizable-box->re-resizable. - Add
handleWrapperStyleandhandleWrapperClassprops. - Change behavior that is set percentage size to width or height as props.
- Support percentage max/min size.
- Use rollup.
- Fix props name.
-
handersClasses->handleClasses -
handersStyles->handleStyles
-
- Remove
shouldUpdateComponent(#135). - Remove
lodash.isEqual.
- Update README.
- Fix remove event listener
- Fix receiveProps. (related #85)
- Update dev dependencies.
- Modify index.js.flow.
- Remove offset state.
- Use
border-box. - Fix boundary size.
- Add offset state for rnd component.
- Update index.js.flow
- Use
flowtype. - Change callback args.
- Change some props name.
- isResizable => enable.
- customClass => className.
- customStyle => style.
- handleStyle => handlerStyles.
- handleClass => handlerClasses.
- Add bounds feature.
- Fix min/max size checker when aspect ratio locked.
- Fix cursor
- Fix npm readme
- Add index.d.ts.
- Fix resize glitch when aspct ratio locked.
- Fixing issue on resizing with touch events
- Add
extendsPropsprop to other props (e.g.data-*,aria-*, and other ).
- Support siver side rendering #43
- Add
updateSizemethod.
- Add
lockAspectRatioproperty.
- Avoid unnecessary rendering on resizer
- Fix onTouchStart bind timing to avoid re-rendering
- Support preserving auto size #40 (thanks @noradaiko)
- Add
gridprops to snap grid. (thanks @paulyoung)
- Add
userSelect: nonewhen resize get srated. - Add shouldComponentUpdate.
- Add handle custom className.
- Add module export plugin for
require.
- Update document.
- Add size argument to resizeStart callback.
- Fix bug
- Fix delta value bug
- Add delta argument to onResize and onResizeStop callback.
- Rename and add resizer.
- Support react v15
- ESLint run when push
- Add mousedown event object to
onResizeStartcallback argument.
- Support
'px'and'%'for width and height props.
The MIT License (MIT)
Copyright (c) 2018 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.