Medium's like reading time estimation for React.
npm install react-hook-reading-timeMedium's like reading time estimation for React.
react-hook-reading-time helps you estimate how long an article will take to read. It works perfectly with plain text.
* Compatible with both JavaScript and TypeScript
react-hook-reading-time is available on npm. It can be installed with the following command:
``
npm install react-hook-reading-time --save
react-hook-reading-time is available on yarn as well. It can be installed with the following command:
`
yarn add react-hook-reading-time
`js
import { useReadingTime } from "react-hook-reading-time";
const {
text, // 1 min read
minutes, // 1
words, // 168
time, // 0.5309090909090909
} = useReadingTime(text);
`
useReadingTime(text: string)
* – the text to be estimated.
If you think any of the react-hook-reading-time can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.
We'd love to have your helping hand on contributions to react-hook-reading-time` by forking and sending a pull request!
Your contributions are heartily ♡ welcome, recognized and appreciated. (✿◠‿◠)
How to contribute:
- Open pull request with improvements
- Discuss ideas in issues
- Spread the word
- Reach out with any feedback
The MIT License 