{"id":13531771,"url":"https://github.com/marcreichel/alpine-typewriter","last_synced_at":"2025-08-22T22:49:05.534Z","repository":{"id":57750737,"uuid":"525530726","full_name":"marcreichel/alpine-typewriter","owner":"marcreichel","description":"Little Alpine.js plugin to add a typewriter effect to any HTML element.","archived":false,"fork":false,"pushed_at":"2023-12-20T22:49:01.000Z","size":134,"stargazers_count":100,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-01T14:32:48.861Z","etag":null,"topics":["alpinejs","alpinejs-plugin","hacktoberfest","plugin","typewriter","typewriter-animation","typewriter-effect"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/marcreichel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["marcreichel"]}},"created_at":"2022-08-16T20:20:48.000Z","updated_at":"2024-04-28T21:47:11.000Z","dependencies_parsed_at":"2023-12-19T03:26:11.548Z","dependency_job_id":"39d1a94b-923e-476e-b5a7-2e531e3feaab","html_url":"https://github.com/marcreichel/alpine-typewriter","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcreichel%2Falpine-typewriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcreichel%2Falpine-typewriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcreichel%2Falpine-typewriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcreichel%2Falpine-typewriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcreichel","download_url":"https://codeload.github.com/marcreichel/alpine-typewriter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231449738,"owners_count":18378431,"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":["alpinejs","alpinejs-plugin","hacktoberfest","plugin","typewriter","typewriter-animation","typewriter-effect"],"created_at":"2024-08-01T07:01:05.532Z","updated_at":"2024-12-27T07:09:06.312Z","avatar_url":"https://github.com/marcreichel.png","language":"JavaScript","funding_links":["https://github.com/sponsors/marcreichel"],"categories":["Extensions \u0026 Plugins"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e⌨️ Alpine Typewriter ⌨️\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  An \u003ca href=\"https://alpinejs.dev\"\u003eAlpine.js\u003c/a\u003e plugin to add a typewriter effect to any HTML element.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@marcreichel/alpine-typewriter\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/v/tag/marcreichel/alpine-typewriter?label=version\" alt=\"version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@marcreichel/alpine-typewriter\"\u003e\n    \u003cimg src=\"https://img.badgesize.io/marcreichel/alpine-typewriter/main/dist/alpine-typewriter.min.js.svg?compression=gzip\u0026color=green\" alt=\"Build size\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@marcreichel/alpine-typewriter\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dt/@marcreichel/alpine-typewriter\" alt=\"downloads\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.jsdelivr.com/package/npm/@marcreichel/alpine-typewriter\"\u003e\n    \u003cimg src=\"https://data.jsdelivr.com/v1/package/npm/@marcreichel/alpine-typewriter/badge?style=rounded\" alt=\"JSDelivr\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@marcreichel/alpine-typewriter\"\u003e\n    \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/marcreichel/alpine-typewriter\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitmoji.dev/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg\" alt=\"Gitmoji\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n![hero](examples/hero.gif)\n\n## 🚀 Installation\n\n### CDN\n\nInclude the following `\u003cscript\u003e` tag in the `\u003chead\u003e` of your document, just before Alpine.\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@marcreichel/alpine-typewriter/dist/alpine-typewriter.min.js\" defer\u003e\u003c/script\u003e\n```\n\n### NPM\n\n```shell\nnpm install @marcreichel/alpine-typewriter\n```\n\nAdd the `x-typewriter` directive to your project by importing the package **before** starting Alpine.\n\n```js\nimport Alpine from 'alpinejs';\nimport Typewriter from '@marcreichel/alpine-typewriter';\n\nAlpine.plugin(Typewriter);\n\nAlpine.start();\n```\n\n## 🪄 Usage\n\nSimply add the `x-typewriter` directive to any HTML element and provide the texts which should be cycled through.\n\n```html\n\u003cspan x-data=\"{ texts: ['Hello', 'World'] }\" x-typewriter=\"texts\"\u003e\u003c/span\u003e\n```\n\n### Adjust the speed\n\nBy default, a text stays for 2 seconds before being swapped out. This behavior may be adjusted using a modifier like so:\n\n```html\n\u003cspan x-data=\"{ texts: ['Hello', 'World'] }\" x-typewriter.5s=\"texts\"\u003e\u003c/span\u003e\n```\nor\n\n```html\n\u003cspan x-data=\"{ texts: ['Hello', 'World'] }\" x-typewriter.3000ms=\"texts\"\u003e\u003c/span\u003e\n```\n\n### Add an animated cursor\n\nTo add a blinking cursor add the `cursor` modifier like so:\n\n```html\n\u003cspan x-data=\"{ texts: ['Hello', 'World'] }\" x-typewriter.cursor=\"texts\"\u003e\u003c/span\u003e\n```\n\n## 📄 License\n\nCopyright (c) 2023 Marc Reichel and contributors.\n\nLicensed under the MIT license, see [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcreichel%2Falpine-typewriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcreichel%2Falpine-typewriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcreichel%2Falpine-typewriter/lists"}