{"id":23072832,"url":"https://github.com/oda2/react-text-typing","last_synced_at":"2026-02-21T22:25:04.570Z","repository":{"id":37247510,"uuid":"237481385","full_name":"Oda2/react-text-typing","owner":"Oda2","description":"Component that performs the effect of writing","archived":false,"fork":false,"pushed_at":"2024-11-22T11:49:50.000Z","size":2700,"stargazers_count":9,"open_issues_count":14,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-22T12:34:27.599Z","etag":null,"topics":["effects","hacktoberfest","library","react","text"],"latest_commit_sha":null,"homepage":"https://oda2.github.io/react-text-typing/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Oda2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-31T17:29:56.000Z","updated_at":"2024-11-22T11:49:53.000Z","dependencies_parsed_at":"2023-02-12T21:46:06.480Z","dependency_job_id":"68aa58e3-cff6-4721-a00c-d1cd99feefab","html_url":"https://github.com/Oda2/react-text-typing","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oda2%2Freact-text-typing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oda2%2Freact-text-typing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oda2%2Freact-text-typing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oda2%2Freact-text-typing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Oda2","download_url":"https://codeload.github.com/Oda2/react-text-typing/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229923320,"owners_count":18145269,"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":["effects","hacktoberfest","library","react","text"],"created_at":"2024-12-16T07:27:30.314Z","updated_at":"2026-02-21T22:25:04.565Z","avatar_url":"https://github.com/Oda2.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.png\" alt=\"react-text-typing\" width=\"200\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003ereact-text-typing\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  A lightweight React component that creates a realistic typewriter animation effect with cursor blinking.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/react-text-typing\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/react-text-typing?style=flat\u0026color=0075D7\" alt=\"npm version\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Oda2/react-text-typing/actions\"\u003e\n    \u003cimg src=\"https://github.com/Oda2/react-text-typing/actions/workflows/ci.yml/badge.svg\" alt=\"CI\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/github/Oda2/react-text-typing\"\u003e\n    \u003cimg src=\"https://coveralls.io/repos/github/Oda2/react-text-typing/badge.svg?branch=main\" alt=\"Coverage\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://bundlephobia.com/package/react-text-typing\"\u003e\n    \u003cimg src=\"https://img.shields.io/bundlephobia/minzip/react-text-typing?color=0075D7\" alt=\"Bundle Size\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-0075D7.svg\" alt=\"License\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## ✨ Features\n\n- 🎯 **Lightweight** - Zero dependencies, tiny bundle (~11kb gzipped)\n- ⚡ **Performant** - Built with React hooks, optimized for speed\n- 🎨 **Customizable** - Colors, speed, font size, cursor blink\n- ♿ **Accessible** - Semantic HTML, works with screen readers\n- 📦 **Tree-shakeable** - Import only what you need\n- 🔧 **TypeScript** - Full TypeScript support included\n- 🧪 **Well tested** - 100% test coverage\n\n## 📦 Installation\n\n```bash\nnpm install react-text-typing\n```\n\nor\n\n```bash\nyarn add react-text-typing\n```\n\n## 🚀 Quick Start\n\n```tsx\nimport TextTyping from 'react-text-typing';\nimport 'react-text-typing/css';\n\nfunction App() {\n  return \u003cTextTyping text=\"Hello, World!\" /\u003e;\n}\n```\n\n## 💻 Usage\n\n### Basic\n\n```tsx\n\u003cTextTyping text=\"Welcome to my website\" /\u003e\n```\n\n### Custom Speed\n\n```tsx\n\u003cTextTyping text=\"Fast typing\" speed={50} /\u003e\n```\n\n### Custom Colors\n\n```tsx\n\u003cTextTyping text=\"Custom colors\" colorText=\"#ff6b6b\" colorTyping=\"#4ecdc4\" /\u003e\n```\n\n### Disable Cursor Blink\n\n```tsx\n\u003cTextTyping text=\"No blink\" showBlink={false} /\u003e\n```\n\n### Custom Font Size\n\n```tsx\n\u003cTextTyping text=\"Big text\" fontSize=\"3em\" /\u003e\n```\n\n### With Callback\n\n```tsx\n\u003cTextTyping text=\"Callback example\" onComplete={() =\u003e console.log('Done!')} /\u003e\n```\n\n### Custom Component\n\n```tsx\n\u003cTextTyping text=\"Heading\" component=\"h1\" className=\"my-heading\" /\u003e\n```\n\n## 📚 API Reference\n\n| Prop          | Type                  | Default   | Description                            |\n| ------------- | --------------------- | --------- | -------------------------------------- |\n| `text`        | `string`              | Required  | Text to type out                       |\n| `speed`       | `number`              | `500`     | Milliseconds between each character    |\n| `colorText`   | `string`              | `#fff`    | Color of the typed text                |\n| `colorTyping` | `string`              | `#0075D7` | Color of the typing effect             |\n| `showBlink`   | `boolean`             | `true`    | Show/hide cursor blink                 |\n| `fontSize`    | `string`              | `5em`     | Font size of the text                  |\n| `timeTyping`  | `number`              | `10`      | Duration of typing animation (seconds) |\n| `component`   | `string \\| Component` | `\"span\"`  | HTML element or custom component       |\n| `onComplete`  | `() =\u003e void`          | -         | Callback when typing finishes          |\n| `className`   | `string`              | -         | Additional CSS class                   |\n\n## 🎨 Styling\n\nThe component includes default CSS. To customize, you can:\n\n1. **Override CSS variables:**\n\n```tsx\n\u003cTextTyping text=\"Custom\" colorText=\"#ff0000\" colorTyping=\"#00ff00\" /\u003e\n```\n\n2. **Add your own styles:**\n\n```css\n.text-typing {\n  font-family: 'Fira Code', monospace;\n}\n```\n\n3. **Import only CSS and customize:**\n\n```js\nimport 'react-text-typing/css';\n```\n\n## 🛠️ Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Run tests\nnpm test\n\n# Run tests with coverage\nnpm run coverage\n\n# Run Storybook\nnpm run dev\n\n# Build library\nnpm run build:lib\n\n# Lint\nnpm run lint\n```\n\n## 🤝 Contributing\n\nContributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) first.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'feat: add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📖 Storybook\n\nWe use Storybook for component development and documentation. Run `npm run dev` to explore the component in an interactive environment.\n\n## 🐛 Issues\n\nFound a bug? Please [open an issue](https://github.com/Oda2/react-text-typing/issues) with a detailed description.\n\n## 📝 License\n\nMIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n\u003cp align=\"center\"\u003e\n  Made with ❤️ by \u003ca href=\"https://github.com/Oda2\"\u003eRenato Oda\u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foda2%2Freact-text-typing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foda2%2Freact-text-typing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foda2%2Freact-text-typing/lists"}