0.0.6 • Published 9 months ago

ngx-simple-typewriter v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Angular Simple Typewriter

A simple angular standalone component for adding a nice typewriter effect to your project.

NPM JavaScript Style Guide npm bundle size GitHub

npm

npm i ngx-simple-typewriter

Yarn

yarn add ngx-simple-typewriter

Usage

You can use the standalone Typewriter component in your project.

1. Component

import { Component } from '@angular/core';
import { Typewriter } from 'ngx-simple-typewriter';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [Typewriter],
  template: `
    <ngx-typewriter />
  `,
  styles: []
})
export class AppComponent {
}

Component Input Properties

PropTypeOptionsDescriptionDefault
wordsarrayRequiredArray of strings holding the words['Hello', '...']
typeSpeednumberOptionalCharacter typing speed in Milliseconds80
deleteSpeednumberOptionalCharacter deleting speed in Milliseconds50
panelClassstringOptionalCSS classes to be applied for the typewriter text (should be in global stylesheet)''

Usage Example

import { Component } from '@angular/core';
import { Typewriter } from 'ngx-simple-typewriter';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [Typewriter],
  template: `
    <div class="">
      Hello there, I am
      <ngx-typewriter
        [words]="words"
        [typeSpeed]="1000"
        [deleteSpeed]="100"
        [panelClass]="'text-color'"
      />
    </div>
  `,
})
export class AppComponent {
  words = ['Abdullah Mansoor', 'a Software Engineer', 'a Cricket Player'];
}

// global stylesheet (styles.scss)
.text-color {
    color: red;
}

Demo - Not yet

License

MIT © iabu94