# zanata-react-resizable-box

> Resizable component for React.

Latest version **0.2.4** (published 2016-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install zanata-react-resizable-box
pnpm add zanata-react-resizable-box
yarn add zanata-react-resizable-box
bun add zanata-react-resizable-box
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2016-03-15 |
| First published | 2016-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2667 |
| Author | davidmason |
| Maintainers | davidmason |
| Keywords | react, resize, resizable, component |

## Links

- npm: https://www.npmjs.com/package/zanata-react-resizable-box
- Repository: https://github.com/bokuweb/react-resizable-box
- Homepage: https://github.com/davidmason/react-resizable-box
- Issues: https://github.com/davidmason/react-resizable-box/issues
- npm.io page: https://npm.io/package/zanata-react-resizable-box

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.2.4 (latest) — 2016-03-15

## README

# react-resizable-box

Resizable component for React.

[![Build Status](https://travis-ci.org/bokuweb/react-resizable-box.svg)](https://travis-ci.org/bokuweb/react-resizable-box)
[![Code Climate](https://codeclimate.com/github/bokuweb/react-resizable-box/badges/gpa.svg)](https://codeclimate.com/github/bokuweb/react-resizable-box)
[![License](http://img.shields.io/npm/l/object.assign.svg)](https://github.com/bokuweb/react-resizable-box#license)

## Demo

![screenshot](https://github.com/bokuweb/react-resizable-box/blob/master/docs/screenshot.gif?raw=true)
See demo: [http://bokuweb.github.io/react-resizable-box/example/](http://bokuweb.github.io/react-resizable-box/example/)


## Installation

```sh
npm i react-resizable-box
```

## Overview

### Basic

``` javascript
<Resizable
  customClass="item"
  width={320}
  height={200}
>
  Basic Sample
</Resizable>
```

### With min/max width and height

``` javascript
<Resizable
  customClass="item"
  width={320}
  height={200}
  minWidth={160}
  minHeight={160}
  maxWidth={480}
  maxHeight={480}
>
  min size is 160px x 160px, max size is 480px x 480px.
</Resizable>
```

## Props

#### `width`: PropTypes.number

The `width` property is used to set the width of a resizable component.

#### `height`: PropTypes.number

The `height` property is used to set the width of a resizable component.

#### `minWidth`: PropTypes.number

The `minWidth` property is used to set the minimum width of a resizable component.

#### `minHeight`: PropTypes.number

The `minHeight` property is used to set the minimum height of a resizable component.

#### `maxWidth`: PropTypes.number

The `maxWidth` property is used to set the maximum width of a resizable component.

#### `maxHeight`: PropTypes.number

The `maxheight` property is used to set the maximum height of a resizable component.

#### `customClass`: PropTypes.string

The `customClass` property is used to set the custom `className` of a resizable component.

#### customStyle: Proptypes.object

The `customStyle` property is used to set the custom `classStyle` of a resizable component.

#### `invert`: PropTypes.shape({ x: PropTypes.bool, y: PropTypes.bool })

The `invert` property is used to reverse the direction of dragging that makes the box bigger.

The default is `{ x: false, y: false }` to drag right to make the box wider and down to
make the box taller, with handles on the right, bottom, and bottom-right corner.

Setting `invert` to `true` for an axis will change the drag direction and move the
handles to the opposite side.

If you set `{ x: false, y: true }`, there will be a handle on the top to drag up,
a handle on the top-right to drag up and right, and the normal handle on the right
to drag right.

#### `isResizable`: Proptypes.shape({ x: PropTypes.bool, y: PropTypes.bool, xy: PropTypes.bool })

The `isResizable` property is used to set the resizable permission of a resizable component.

The permission of `x`, `y`, `xy` direction resizing.
If omitted, `x`, `y`, `xy` direction resizing is enabled.
If you want to permit only x direction resizing, set `{ x:true, y:false, xy:false }`.

#### `onClick`: PropTypes.func

Calls when resizable component clicked.

#### `onTouchStart`: PropTypes.func

Calls when resizable component touched.

#### `onDoubleClick`: PropTypes.func

Calls when resizable component double clicked.

#### `onResizeStart`: PropTypes.func

Calls when resizable component resize starts.
Calls back with (`direction: string`)

- direction: `x` or `y` or `xy`

#### `onResize`: PropTypes.func

Calls when resizable component resize.
Calls back with (`direction: string`, `styleSize: object`, `boundingClientRect: object`)

- direction: `x` or `y` or `xy`
- styleSize: `{ width, height }`
  - this argument is {style.width, style.height} resizable component(`div` element).
- boundingClientRect: `{ width`, height }`
  - this argument is `width` and `height` of `resizable.getBoundingClientRect()`.

For example, when `<Resizable width={100} height={200} style={{ padding: '20px'}} onResize={...} />` mounted and resize 'x', this callback is called with `('x', { width: 100, height: 200 }, { width: 140, height: 240 })`

#### `onResizeStop`: PropTypes.func

Calls back with (`direction: string`, `styleSize: object`, `boundingClientRect: object`)

- direction: `x` or `y` or `xy`
- styleSize: `{ width, height }`
  - this argument is {style.width, style.height} resizable component(`div` element).
- boundingClientRect: `{ width`, height }`
  - this argument is `width` and `height` of `resizable.getBoundingClientRect()`.

For example, when `<Resizable width={100} height={200} style={{ padding: '20px'}} onResize={...} />` mounted and resize 'x', this callback is called with `('x', { width: 100, height: 200 }, { width: 140, height: 240 })`

## Test

``` sh
npm test
```

## License

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.

---
_Source: https://npm.io/package/zanata-react-resizable-box · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._