A text animation component for Ink
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
src
.babelrc
.editorconfig
.eslintrc
.gitattributes
.gitignore
.npmrc
.travis.yml
LICENSE
README.md
example.jsx
package.json

README.md

ink-text-animation

Build Status

A text animation component for Ink

Install

$ npm install --save ink-text-animation

Usage

import { h, render, Text } from 'ink';
import TextAnimation from 'ink-text-animation';

render(
  <div>
    <TextAnimation>
      <Text>{`Look at me, I'm moving!`}</Text>
    </TextAnimation>
  </div>
);

API

<TextAnimation />

Accepts a string or an Ink component as children.

Props

name

Type: string
Default: rainbow
Values: rainbow pulse glitch radar neon

The name of the animation. You can find all the available animations in the chalk-animations README.

speed

Type: number
Default: 1

The speed of the animation.


License

MIT © Yarden Sod-Moriah