https://github.com/gielcobben/use-typewriter
useTypewriter
https://github.com/gielcobben/use-typewriter
hooks open-source react typescript typewriter
Last synced: about 1 year ago
JSON representation
useTypewriter
- Host: GitHub
- URL: https://github.com/gielcobben/use-typewriter
- Owner: gielcobben
- Created: 2019-07-11T12:12:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T22:51:59.000Z (over 3 years ago)
- Last Synced: 2025-02-27T23:05:47.887Z (over 1 year ago)
- Topics: hooks, open-source, react, typescript, typewriter
- Language: JavaScript
- Homepage: https://gielcobben.github.io/use-typewriter/
- Size: 1.81 MB
- Stars: 43
- Watchers: 1
- Forks: 1
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hook: Typewriter
## Installation
Install using [Yarn](https://yarnpkg.com):
```sh
yarn add use-typewriter
```
or NPM:
```sh
npm install use-typewriter --save
```
## Usage
### Basic
```tsx
import React from "react";
import useTypewriter from "use-typewriter";
const Component = () => {
const currentWord = useTypewriter({
words: ["Hello World"]
});
return
{currentWord};
};
```
## API
### Options
| Name | Type | Default | Required | Description |
| ---------- | -------- | ------- | -------- | ---------------------------------------------- |
| words | string[] | [] | Yes | An array of words you want to be typed. |
| min | number | 10 | No | Minimum amount in ms of delay between letters. |
| max | number | 80 | No | Maximum amount in ms of delay between letters. |
| wordDelay | number | 2000 | No | Delay in ms between words in the array. |
| eraseDelay | number | 1000 | No | Delay in ms before earsing the word |
## License
**use-typewriter** is MIT licensed.