anim-txt.js
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

anim-TxT.js

parse-g

the text animator

install

npm i anim-txt.js

use in project

import { AnimateTxT } from 'anim-txt.js';

Actions

Default settings

{
    time: 1500,
    text: 'AnimateTxT!',
    point: '.',
    construct: {
      replace: false,
      backReplace: {
        value: true,
        point: '.',
      },
      time: {
        mode: 'half',
        ms: 1500,
      },
      text: 'AnimateTxT!',
    },
  }

CONSTRUCTOR

Create new animation

const settings = {
  time: { mode: 'half', ms: 1500 },
  replace: false,
  backReplace: {
    value: true,
    point: '#'
  }
};

const myAnim = new AnimateTxT(settings);

settings

{
    replace: boolean,
    backReplace: {
      value: boolean,
      point: string
    },
    time: {
      mode: 'full' | 'half' | 'third',
      ms: number
    },
    text: string
  };

start custom animation ->

myAnim.start();

get settings ->

myAnim.settings;

Point animation

example

AnimateTxT.point({ text: 'my text', point: 'p', all_time: 1500 });

template

AnimateTxT.point({ text: string, point: string, all_time: number });

Print animation

example

AnimateTxT.print({ text: 'my text', all_time: 1500 });

template

AnimateTxT.print({ text: string, all_time: number });

Wawe animation

example

AnimateTxT.wawe({ text: 'my text', all_time: 1500 });

template

AnimateTxT.wawe({ text: string, all_time: number });

Line animation

example

AnimateTxT.line({ text: 'my text', all_time: 1500 });

template

AnimateTxT.line({ text: string, all_time: number });

Package Sidebar

Install

npm i anim-txt.js

Weekly Downloads

0

Version

1.0.5

License

SEE LICENSE IN LICENSE

Unpacked Size

49.7 kB

Total Files

7

Last publish

Collaborators

  • parse-g