Resizable component for React.
See demo: http://bokuweb.github.io/react-resizable-box/example/
$ npm install --save react-resizable-box<Resizable
className="item"
width={320}
height={200}
>
Basic Sample
</Resizable>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 width property is used to set the initial width of a resizable component.
For example, you can set 300, '300px', 50%.
If omitted, set 'auto'.
The height property is used to set the initial height of a resizable component.
For example, you can set 300, '300px', 50%.
If omitted, set 'auto'.
The minWidth property is used to set the minimum width of a resizable component.
The minHeight property is used to set the minimum height of a resizable component.
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 lockAspectRatio property is used to lock aspect ratio.
If omitted, set false.
Specifies resize boundaries.
The handleStyles property is used to override the style of one or more resize handlers.
Only the axis you specify will have its handler style replaced.
If you specify a value for right it will completely replace the styles for the right resize handler,
but other handler will still use the default styles.
The handlerClasses property is used to set the className of one or more resize handlers.
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 | SyntheticTouchEvent,
dir: Direction,
refToElement: HTMLElement,
) => void;
Calls when resizable component resize start.
Callback type is below.
type Callback = (
event: MouseEvent | TouchEvent,
direction: Direction,
refToElement: HTMLElement,
delta: NumberSize,
) => void;
Calls when resizable component resizing.
Callback type is below.
type Callback = (
event: MouseEvent | TouchEvent,
direction: Direction,
refToElement: HTMLElement,
delta: NumberSize,
) => void;
Calls when resizable component resize startStop.
This property is used to pass the other props to the component.
e.g.
const extendsProps = {
data-foo: 'foo',
onMouseOver: () => {},
};
<Resizable extendsProps={extendsProps} />Update component size.
grid ,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>
);
}
...
}npm test- 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 handler 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) 2017 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.