debounce-input-decorator

Decorator to easily create debounced React inputs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
debounce-input-decorator
1.0.06 years ago7 years agoMinified + gzip package size for debounce-input-decorator in KB

Readme

debounce-input-decorator Build Status
Decorator to easily create debounced React inputs

Install

Installation of the npm package:
> npm install --save debounce-input-decorator

Usage

You can apply this decorator either to a DOM element or to any React component as long as it accepts onChange and value properties.
import debounceDecorator from 'debounce-input-decorator'
import { Input } from 'reactstrap'

const ReactStrapInputDebounced = debounceDecorator(250)(Input)

const DomInputDebounced = debounceDecorator(250)('input')

Because you usually need a input or textarea, those are provided directly:
import { Input, Textarea } from 'debounce-input-decorator'

<Input
  debounceTimeout={300}
  // ...
/>

Development

# Install dependencies
> yarn

# Run the tests
> yarn test

# Continuously compile
> yarn dev

# Continuously run the tests
> yarn dev-test

# Build for production (automatically called by npm install)
> yarn build

Contributions

Contributions are very welcomed, either on the documentation or on the code.
You may:
you've encountered;
  • fork and create a pull request.

License

ISC © Julien Fontanet