{"_id":"@bsherman-dev/use-typewriter","name":"@bsherman-dev/use-typewriter","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@bsherman-dev/use-typewriter","version":"1.0.0","description":"A versatile custom React hook for adding a typing effect to text.","main":"use-typewriter.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/83au/use-typewriter.git"},"keywords":["react","hook","hooks","typewriter","typing-effect","js","javascript"],"author":{"name":"Beau Sherman"},"license":"ISC","peerDependencies":{"react":"^18.2.0","react-dom":"^18.2.0"},"gitHead":"42f95f174d52df29782e9f41964a5136fb1d5ba1","bugs":{"url":"https://github.com/83au/use-typewriter/issues"},"homepage":"https://github.com/83au/use-typewriter#readme","_id":"@bsherman-dev/use-typewriter@1.0.0","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-9Lem6CoH7VQXJ1aWo4hu3ERy00NLv2j4W0k3EtQacFtiFvZhthXlK79GGQDofzo6yomOXs1fwtdzjrG74HJOww==","shasum":"48e748fd5a0764641fc850f3caaeee30599eda34","tarball":"https://registry.npmjs.org/@bsherman-dev/use-typewriter/-/use-typewriter-1.0.0.tgz","fileCount":3,"unpackedSize":3840,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD15AuXwlL3zwtosSDvRuNq05bqGqdGhtJBBClSLHVLkQIhAJr1867U1WZO08sWPg7cJl3n6a4yxfoqbTkAaUbevFMc"}]},"_npmUser":{"name":"bsherman-dev","email":"contact@beausherman.dev"},"directories":{},"maintainers":[{"name":"bsherman-dev","email":"contact@beausherman.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-typewriter_1.0.0_1685586061511_0.9894773236650887"},"_hasShrinkwrap":false}},"time":{"created":"2023-06-01T02:21:01.448Z","1.0.0":"2023-06-01T02:21:01.651Z","modified":"2023-06-01T02:21:01.813Z"},"maintainers":[{"name":"bsherman-dev","email":"contact@beausherman.dev"}],"description":"A versatile custom React hook for adding a typing effect to text.","homepage":"https://github.com/83au/use-typewriter#readme","keywords":["react","hook","hooks","typewriter","typing-effect","js","javascript"],"repository":{"type":"git","url":"git+https://github.com/83au/use-typewriter.git"},"author":{"name":"Beau Sherman"},"bugs":{"url":"https://github.com/83au/use-typewriter/issues"},"license":"ISC","readme":"# React useTypewriter\n\n<!-- [NPM Repository](https://www.npmjs.com/package/use-typewriter-hook) -->\n\n## Installation\n\nYou can install React useTypewriter with one command\n\n```shell\n\n# with npm\nnpm i @bsherman-dev/use-typewriter\n\n```\n\n## Options\n\n| Name      | Type               | Default value  | Description                                                     |\n| --------- | ------------------ | -------------- | --------------------------------------------------------------- |\n| text      | String or String[] | \"Hello World!\" | Strings to type out when using this tool.                       |\n| direction | String             | \"forward\"      | Option for whether to type or delete the characters of the text |\n| repeat    | Number             | 0              | The number of times for the animation to repeat                 |\n| speed     | Number             | 200            | The delay between each character when typing.                   |\n\n## Examples\n\n### Most Basic example\n\n```jsx\nimport useTypewriter from '@bsherman-dev/use-typewriter';\nimport './App.css';\n\nfunction App() {\n  const message = useTypewriter();\n  return <h1>{message}</h1>;\n}\n\nexport default App;\n```\n\n<!-- Add video clip here -->\n\n### Custom cursor with multiple strings being looped\n\n```jsx\nimport React from 'react';\nimport useTypewriter from '@bsherman-dev/use-typewriter';\n\nfunction App() {\n  const languages = ['HTML.', 'CSS.', 'JavaScript.'];\n  const message = useTypewriter({\n    text: languages,\n    direction: 'both',\n    repeat: -1,\n    speed: 100,\n  });\n  return <h1>Hi! I like to code in {message}</h1>;\n}\n\nexport default App;\n```\n\n<!-- Add video clip here -->\n\n<!-- ## CSS file for styling for four examples above -->\n","readmeFilename":"README.md"}