# @zippytech/react-notify-resize

> React Component that notifies you whenever it is resized

Latest version **4.0.4** (published 2018-10-30) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @zippytech/react-notify-resize
pnpm add @zippytech/react-notify-resize
yarn add @zippytech/react-notify-resize
bun add @zippytech/react-notify-resize
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.4 |
| Published | 2018-10-30 |
| First published | 2017-02-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 118.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Zippy Technologies |
| Maintainers | zippyui |
| Keywords | react, react-component, resize, notify, event, resizer, resizable, element query |

## Links

- npm: https://www.npmjs.com/package/@zippytech/react-notify-resize
- Repository: https://github.com/zippytech/react-notify-resize
- Homepage: https://github.com/zippytech/react-notify-resize#readme
- Issues: https://github.com/zippytech/react-notify-resize/issues
- npm.io page: https://npm.io/package/@zippytech/react-notify-resize

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 4.0.4 (latest) — 2018-10-30
- 4.0.3 — 2018-10-30
- 4.0.2 — 2018-10-30
- 4.0.1 — 2018-10-30
- 3.0.0 — 2017-04-12
- 2.1.2 — 2017-02-17
- 2.1.1 — 2017-02-15
- 2.1.0 — 2017-02-15

## README

# react-notify-resize

> Get resize notifications on any React element

## Install

```sh
$ npm install --save @zippytech/react-notify-resize
```

## Intro

React Component that notifies you whenever it is resized - by any means.

It can be used as a standalone Component inside the HTML element you want to detect resize on.

Or it can be used as a higher-order function that takes your component and returns a `NotifyResize` wrapped component.

## Usage

In order to use `@zippytech/react-notify-resize - 3.0.0` you need to have `react` and `prop-types` packages installed in your app, since those are peer dependencies for this package. You can use any React version `>=15.0.0`

#### NotifyResize component

```jsx
import React, { Component } from 'react'
import { NotifyResize } from '@zippytech/react-notify-resize'

class MyComponent extends Component {
  render(){
    return <div style={{position: 'relative'}}>
      <NotifyResize onResize={this.onResize.bind(this)} />
    </div>
  }

  onResize({ width, height }){
    //you get notified when the component div is resized
    //the only condition is that it has a relative or absolute position
  }
}
```

##### Props

 * `onResize({ width, height }): Function`
 * `notifyOnMount: Boolean` - if true, calls the `onResize` prop on component mount. Defaults to `false`
 * `measureSize: Function` - a custom function to measure HTMLElement size, if you want to provide one. It needs to return an object with `{width, height}`. By default `node.offsetWidth` and `node.offsetHeight` are used for measuring element size.
 * `shouldComponentUpdate: Function` - a custom function to override the default `shallowequal` implementation. Called with `shouldComponentUpdate(nextProps, currentProps, nextState, currentState)`

#### NotifyResize higher-order function

```jsx
import notifyResize from '@zippytech/react-notify-resize'

class MyComponent extends React.Component {

  render(){
    // the element you want to listen for resize must have position relative
    return <div style={{position: 'relative'}}>
      {
        // Include this helper inside the element you want to listen for resize
        this.props.resizeTool
      }
    </div>
  }

  // will be called on resize if it is defined
  onResize({ width, height }){
    // do something on resize
  }
}

const MyNotifiedComponent = notifyResize(MyComponent)

class App extends React.Component {
  render(){
    return <MyNotifiedComponent onResize={/* called when element changes dimension */} ref="notifier"/>
  }
}
```

Notice that in this case, both the `onResize` instance function is called, if it exists, and the `onResize` prop is called, if it is a function.

You can nest the `resizeTool` prop wherever you want, as long as its parent has a `relative` or `absolute` position.

If you want to get a reference to your actual component, you can access that using `.component`. In the example above, you can use:

```jsx
//if you have a reference to the `app` component
app.refs.notifier.component
````

Not the most elegant access chain, but you can always use the plain component instead of the higher-order function.

## LICENSE

#### [Apache2](./LICENSE)

---
_Source: https://npm.io/package/@zippytech/react-notify-resize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._