Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
re-resizable
Advanced tools
The re-resizable npm package is a React component that allows you to create resizable components in your application. It provides a simple and flexible way to add resizable functionality to any element, with support for various resizing directions and customizable styles.
Basic Resizable Component
This code demonstrates how to create a basic resizable component using the re-resizable package. The component starts with a default size of 200x200 pixels.
import React from 'react';
import { Resizable } from 're-resizable';
const BasicResizable = () => (
<Resizable
defaultSize={{
width: 200,
height: 200,
}}
>
<div style={{ border: '1px solid black' }}>Resizable Content</div>
</Resizable>
);
export default BasicResizable;
Resizable with Custom Styles
This example shows how to apply custom styles to the resizable component. The border is changed to a dashed blue line, and padding is added.
import React from 'react';
import { Resizable } from 're-resizable';
const StyledResizable = () => (
<Resizable
style={{
border: '2px dashed blue',
padding: '10px',
}}
defaultSize={{
width: 300,
height: 300,
}}
>
<div>Styled Resizable Content</div>
</Resizable>
);
export default StyledResizable;
Resizable with Specific Directions
This code demonstrates how to enable resizing in specific directions. In this example, resizing is enabled only on the right, bottom, and bottom-right corners.
import React from 'react';
import { Resizable } from 're-resizable';
const DirectionalResizable = () => (
<Resizable
enable={{
top: false,
right: true,
bottom: true,
left: false,
topRight: false,
bottomRight: true,
bottomLeft: false,
topLeft: false,
}}
defaultSize={{
width: 400,
height: 400,
}}
>
<div>Directional Resizable Content</div>
</Resizable>
);
export default DirectionalResizable;
The react-resizable package provides similar functionality for creating resizable components in React. It is more lightweight and focuses on providing a minimal API for resizing elements. However, it may lack some of the customization options available in re-resizable.
The react-rnd package combines resizable and draggable functionalities into a single component. It offers a more comprehensive solution if you need both resizing and dragging capabilities. However, it might be more complex to use if you only need resizing.
The react-resizable-box package is another alternative for creating resizable components. It provides a simple API and supports various resizing directions. It is similar to re-resizable but may have fewer customization options.
📏 A resizable component for React.
$ npm install --save re-resizable
defaultSize
<Resizable
defaultSize={{
width:320,
height:200,
}}
>
Sample with default size
</Resizable>
size
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>
defaultSize?: { width: (number | string), height: (number | string) };
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.
size?: { width: (number | string), height: (number | string) };
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.
className?: string;
The className
property is used to set the custom className
of a resizable component.
style?: { [key: string]: string };
The style
property is used to set the custom style
of a resizable component.
minWidth?: number | string;
The minWidth
property is used to set the minimum width of a resizable component. Defaults to 10px.
minHeight?: number | string;
The minHeight
property is used to set the minimum height of a resizable component. Defaults to 10px.
maxWidth?: number | string;
The maxWidth
property is used to set the maximum width of a resizable component.
maxHeight?: number | string
;The maxHeight
property is used to set the maximum height of a resizable component.
grid?: [number, number];
The grid
property is used to specify the increments that resizing 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
.
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
.
bounds?: ('window' | 'parent' | HTMLElement);
Specifies resize boundaries.
handleStyles?: HandleStyles;
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.
handleClasses?: HandleClassName;
The handleClasses
property is used to set the className of one or more resize handles.
handleComponent?: HandleComponent;
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..
handleWrapperStyle?: { [key: string]: string };
The handleWrapperStyle
property is used to override the style of resize handles wrapper.
handleWrapperClass?: string;
The handleWrapperClass
property is used to override the className of resize handles wrapper.
enable?: ?Enable;
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 }
.
onResizeStart?: ResizeStartCallBack;
ResizeStartCallBack
type is below.
type ResizeStartCallback = (
e: SyntheticMouseEvent<HTMLDivElement> | SyntheticTouchEvent<HTMLDivElement>,
dir: Direction,
refToElement: React.ElementRef<'div'>,
) => void;
Calls when resizable component resize start.
onResize?: ResizeCallback;
ResizeCallback
type is below.
type ResizeCallback = (
event: MouseEvent | TouchEvent,
direction: Direction,
refToElement: React.ElementRef<'div'>,
delta: NumberSize,
) => void;
Calls when resizable component resizing.
onResizeStop?: ResizeCallback;
ResizeCallback
type is below.
type ResizeCallback = (
event: MouseEvent | TouchEvent,
direction: Direction,
refToElement: React.ElementRef<'div'>,
delta: NumberSize,
) => void;
Calls when resizable component resize stop.
updateSize(size: { width: number | string, height: number | string }): void
Update component size.
grid
,max/minWidth
, max/minHeight
props is ignored, when this method called.
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
index.d.ts
to allow HTMLDivElement
properties. #292Array.from
error in IE11relative
position when get base sizeauto
overwritten by px value #179width
and height
.defaultSize
and size
,extendsProps
.You can add extendsProps as follows.
<Resizable data-foo="foo" />
ResizeStartCallBack
-> ResizeStartCallback
.ResizeDirection
type.Callback
to ResizeCallback
.react-resizable-box
-> re-resizable
.handleWrapperStyle
and handleWrapperClass
props.handersClasses
-> handleClasses
handersStyles
-> handleStyles
shouldUpdateComponent
(#135).lodash.isEqual
.border-box
.flowtype
.extendsProps
prop to other props (e.g. data-*
, aria-*
, and other ).updateSize
method.lockAspectRatio
property.grid
props to snap grid. (thanks @paulyoung)userSelect: none
when resize get srated.require
.onResizeStart
callback argument.'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.
FAQs
Resizable component for React.
The npm package re-resizable receives a total of 518,068 weekly downloads. As such, re-resizable popularity was classified as popular.
We found that re-resizable demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.