{"id":17238527,"url":"https://github.com/gielcobben/use-typewriter","last_synced_at":"2025-03-17T11:30:33.505Z","repository":{"id":35022574,"uuid":"196387588","full_name":"gielcobben/use-typewriter","owner":"gielcobben","description":"useTypewriter","archived":false,"fork":false,"pushed_at":"2022-12-10T22:51:59.000Z","size":1895,"stargazers_count":43,"open_issues_count":43,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-27T23:05:47.887Z","etag":null,"topics":["hooks","open-source","react","typescript","typewriter"],"latest_commit_sha":null,"homepage":"https://gielcobben.github.io/use-typewriter/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gielcobben.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-11T12:12:22.000Z","updated_at":"2023-09-07T06:22:20.000Z","dependencies_parsed_at":"2023-01-15T12:15:26.783Z","dependency_job_id":null,"html_url":"https://github.com/gielcobben/use-typewriter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gielcobben%2Fuse-typewriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gielcobben%2Fuse-typewriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gielcobben%2Fuse-typewriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gielcobben%2Fuse-typewriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gielcobben","download_url":"https://codeload.github.com/gielcobben/use-typewriter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858056,"owners_count":20359271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hooks","open-source","react","typescript","typewriter"],"created_at":"2024-10-15T05:45:57.450Z","updated_at":"2025-03-17T11:30:32.954Z","avatar_url":"https://github.com/gielcobben.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hook: Typewriter\n\n## Installation\n\nInstall using [Yarn](https://yarnpkg.com):\n\n```sh\nyarn add use-typewriter\n```\n\nor NPM:\n\n```sh\nnpm install use-typewriter --save\n```\n\n## Usage\n\n### Basic\n\n```tsx\nimport React from \"react\";\nimport useTypewriter from \"use-typewriter\";\n\nconst Component = () =\u003e {\n  const currentWord = useTypewriter({\n    words: [\"Hello World\"]\n  });\n\n  return \u003cdiv\u003e{currentWord}\u003c/div\u003e;\n};\n```\n\n## API\n\n### Options\n\n| Name       | Type     | Default | Required | Description                                    |\n| ---------- | -------- | ------- | -------- | ---------------------------------------------- |\n| words      | string[] | []      | Yes      | An array of words you want to be typed.        |\n| min        | number   | 10      | No       | Minimum amount in ms of delay between letters. |\n| max        | number   | 80      | No       | Maximum amount in ms of delay between letters. |\n| wordDelay  | number   | 2000    | No       | Delay in ms between words in the array.        |\n| eraseDelay | number   | 1000    | No       | Delay in ms before earsing the word            |\n\n## License\n\n**use-typewriter** is MIT licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgielcobben%2Fuse-typewriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgielcobben%2Fuse-typewriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgielcobben%2Fuse-typewriter/lists"}