An Alpine.js plugin to add a typewriter effect to any HTML element.
## 🚀 Installation
### CDN
Include the following `
```
### NPM
```shell
npm install @marcreichel/alpine-typewriter
```
Add the `x-typewriter` directive to your project by importing the package **before** starting Alpine.
```js
import Alpine from 'alpinejs';
import Typewriter from '@marcreichel/alpine-typewriter';
Alpine.plugin(Typewriter);
Alpine.start();
```
## 🪄 Usage
Simply add the `x-typewriter` directive to any HTML element and provide the texts which should be cycled through.
```html
```
### Adjust the speed
By default, a text stays for 2 seconds before being swapped out. This behavior may be adjusted using a modifier like so:
```html
```
or
```html
```
### Add an animated cursor
To add a blinking cursor add the `cursor` modifier like so:
```html
```
## 📄 License
Copyright (c) 2023 Marc Reichel and contributors.
Licensed under the MIT license, see [LICENSE](LICENSE) for details.
