README.md

react-hooks ·

A collection of Reacts hooks used in Flywire

Install

Add the dependency to your package.json:

npm i @flywire/react-hooks

Development

Install dependencies:

npm install

Run tests

npm run test

Hooks

• useDebounce
• useFormState
• useIdleTimer
• useOnClickOutside
• useOnScroll
• useStep
• useThrottle
• useToggle
• useValidate

Releases

To create a new release, make all the changes that you need and commit them, then execute:

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]

For example:

npm version patch
npm publish

or for a beta:

npm version prepatch
npm publish --tag beta

This will bump the package.json version, build a new bundle, commit, push the changes tagging them to a new release.

Then create a PR and request the review from other project commiters. Once accepted and merged to master, execute npm publish from master branch.