erichartline/dicty-hooks

Home for all reusable dictyBase React hooks

Dicty Hooks 🎣

This is a React library of hooks that can be reused throughout any dictyBase web applications.

Install

yarn add dictyBase/dicty-hooks

To install a specific version, add a tag to the end:

yarn add dictyBase/dicty-hooks#1.0.0

Usage

Examples of how to use each hook are provided individually.

• useFetchRefreshToken
• useIntersectionObserver
• useVirtualList
• useFooter
• useNavbar
• useFetch

Development

• Clone the develop branch of this repository
• Run yarn install
• Create a new branch (i.e. feature/useFoo)
• Add custom hook to /src/hooks
• Add unit tests to /test
• Add export to /src/index.ts
• Add documentation to /docs
• Generate new build yarn build
• Commit all changes and open a pull request. If all checks pass, it is ready to merge to develop.

If you are ready to cut a new release, you can then merge into master. This will trigger a GitHub Action that uses semantic-release to create a new tag.

Note: all content must be written in TypeScript.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Eric Hartline 🐛 💻 🖋 📖 🚧

Siddhartha Basu 🐛 💻 🖋 📖 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Misc badges