Gathering detailed insights and metrics for re-resizable
Installations
npm install re-resizableDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.17.0
NPM Version
10.8.2
Score
93.9
Supply Chain
95.5
Quality
86
Maintenance
100
Vulnerability
100
License
Releases
8
Contributors
58
Unable to fetch Contributors
Languages
5
TypeScript
JavaScript
HTML
Shell
CSS
TypeScript (95.13%)
JavaScript (3.34%)
HTML (0.89%)
Shell (0.51%)
CSS (0.13%)
Developer
Download Statistics
Total Downloads
104,424,119
Last Day
141,229
Last Week
723,241
Last Month
2,466,314
Last Year
33,834,581
GitHub Statistics
2,505 Stars
1,049 Commits
221 Forks
13 Watching
61 Branches
58 Contributors
Bundle Size
16.59 kB
Minified
4.80 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
6.10.3
Package Id
re-resizable@6.10.3
Unpacked Size
136.55 kB
Size
24.32 kB
File Count
11
NPM Version
10.8.2
Node Version
20.17.0
Publised On
09 Dec 2024
Total Downloads
Cumulative downloads
Total Downloads
104,424,119
Last day
4.9%
141,229
Compared to previous day
Last week
40.6%
723,241
Compared to previous week
Last month
-18%
2,466,314
Compared to previous month
Last year
42.1%
33,834,581
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
51
@babel/cli@babel/core@babel/eslint-parser@babel/plugin-proposal-class-properties@babel/plugin-transform-modules-commonjs@babel/preset-react@babel/preset-typescript@babel/traverse@babel/types@emotion/core@playwright/experimental-ct-react@storybook/addon-info@storybook/addon-options@storybook/react@types/node@types/react@types/react-dom@types/sinonbabel-corebabel-loaderbabel-plugin-external-helpersbabel-plugin-transform-class-propertiesbabel-plugin-transform-object-assignbabel-plugin-transform-object-rest-spreadbabel-polyfillbabel-preset-envbabel-preset-es2015babel-preset-flowbabel-preset-reactbabel-registercross-envgh-pagesnpm-run-all2playwright-coreprettierreactreact-domrolluprollup-plugin-babelrollup-plugin-commonjsrollup-plugin-node-globalsrollup-plugin-node-resolverollup-plugin-replacerollup-plugin-typescript2rollup-watchsinontslinttslint-config-googletslint-config-prettiertslint-plugin-prettiertypescript
Versions
📏 A resizable component for React.
Table of Contents
Screenshot
Live Demo
Storybook
CodeSandbox
CodeSandbox
CodeSandbox(TypeScript)
CodeSandbox(With hooks)
Install
1$ npm install --save re-resizable
Usage
Example with defaultSize
1import { Resizable } from 're-resizable'; 2 3<Resizable 4 defaultSize={{ 5 width: 320, 6 height: 200, 7 }} 8> 9 Sample with default size 10</Resizable>
If you only want to set the width, you can do so by providing just the width property. The height property will automatically be set to auto, which means it will adjust 100% of its parent's height:
1import { Resizable } from 're-resizable'; 2 3<Resizable 4 defaultSize={{ 5 width: 320 6 }} 7> 8 Sample with default size 9</Resizable>
Example with size
If you use size props, please manage state by yourself.
1import { Resizable } from 're-resizable'; 2 3<Resizable 4 size={{ width: this.state.width, height: this.state.height }} 5 onResizeStop={(e, direction, ref, d) => { 6 this.setState({ 7 width: this.state.width + d.width, 8 height: this.state.height + d.height, 9 }); 10 }} 11> 12 Sample with size 13</Resizable>
Props
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.
It accepts viewport as well as parent relative units. For example, you can set 300, 50%, 50vw or 50vh.
Same type of values can be applied to minHeight, maxWidth and maxHeight.
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].
gridGap?: [number, number];
The gridGap property is used to specify any gaps between your grid cells that should be accounted for when resizing. Defaults to [0, 0].
The value provided for each axis will always add the grid gap amount times grid cells spanned minus one.
snap?: { x?: Array<number>, y?: Array<number> };
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.
snapGap?: number
The snapGap property is used to specify the minimum gap required in order to move to the next snapping target. Defaults to 0 which means that snap targets are always used.
resizeRatio?: number | [number, number];
The resizeRatio property is used to set the number of pixels the resizable component scales by compared to the number of pixels the mouse/touch moves. Defaults to 1 (for a 1:1 ratio). The number set is the left side of the ratio, 2 will give a 2:1 ratio.
For [number, number] means [resizeRatioX, resizeRatioY], more precise control.
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.
boundsByDirection?: boolean;
By default max dimensions based on left and top element position.
Width grow to right side, height grow to bottom side.
Set true for detect max dimensions by direction.
For example: enable boundsByDirection when resizable component stick on right side of screen and you want resize by left handler;
false by default.
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 | false;
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.
1type ResizeStartCallback = ( 2 e: SyntheticMouseEvent<HTMLDivElement> | SyntheticTouchEvent<HTMLDivElement>, 3 dir: ResizableDirection, 4 refToElement: HTMLDivElement, 5) => void;
Calls when resizable component resize start.
onResize?: ResizeCallback;
scale?: number;
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)).
as?: string | React.ComponentType;
By default the Resizable component will render a div as a wrapper. The as property is used to change the element used.
Basic
ResizeCallback type is below.
1type ResizeCallback = ( 2 event: MouseEvent | TouchEvent, 3 direction: ResizableDirection, 4 refToElement: HTMLDivElement, 5 delta: NumberSize, 6) => void;
Calls when resizable component resizing.
onResizeStop?: ResizeCallback;
ResizeCallback type is below.
1type ResizeCallback = ( 2 event: MouseEvent | TouchEvent, 3 direction: ResizableDirection, 4 refToElement: HTMLDivElement, 5 delta: NumberSize, 6) => void;
Calls when resizable component resize stop.
Instance API
* updateSize(size: { width: number | string, height: number | string }): void
Update component size.
grid, snap, max/minWidth, max/minHeight props is ignored, when this method called.
- for example
1class YourComponent extends Component { 2 3 // ... 4 5 update() { 6 this.resizable.updateSize({ width: 200, height: 300 }); 7 } 8 9 render() { 10 return ( 11 <Resizable ref={c => { this.resizable = c; }}> 12 example 13 </Resizable> 14 ); 15 } 16 17 // ... 18}
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 to help us easily isolate it.
Test
1npm test
Related
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
6 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 7
Reason
Found 7/25 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/bokuweb/re-resizable/ci.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:49
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Reason
46 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-4wx3-54gh-9fr9
- Warn: Project is vulnerable to: GHSA-xf5p-87ch-gxw2
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-wvhm-4hhf-97x9
- Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w
- Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
- Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
- Warn: Project is vulnerable to: GHSA-3949-f494-cm99
- Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Score
3.7
/10
Last Scanned on 2025-01-13
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More