Home

Awesome

Ngx Typewriter Component

@omnedia/ngx-typewriter is a lightweight and easy-to-use angular library for creating typewriter effects in your web applications. <br> It uses RxJS to manage the typewriting effect, ensuring smooth and customizable animations. <br>

Installation

You can install the library via npm:

npm install @omnedia/ngx-typewriter

Usage

First, import the Component class from the library:

import { NgxTypewriterComponent } from '@omnedia/ngx-typewriter';

@Component({
  ...
  imports: [
    ...
    NgxTypewriterComponent,
  ],
  ...
})

Then, create an DOM Element of the TypeWriter:

words: string[] = ['Im', 'typed', 'one', 'after', 'another'];
<om-typewriter
        [words]="words"
      ></om-typewriter>

API

<om-typewriter
        [words]="words"
        [disableLoop]="true"
        [writeSpeed]="writeSpeed in Ms"
        [deleteDelay]="deleteDelay in Ms"
        [writeDelay]="writeDelay in Ms"
        styleClass="your-custom-class"
      ></om-typewriter>

Starts the typewriter effect.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Contact

For any questions or suggestions, please open an issue or reach out to me at markus.block@omnedia.com.