https://github.com/yardnsm/ink-text-animation

A text animation component for Ink
https://github.com/yardnsm/ink-text-animation

chalk-animation colors ink ink-component react text-animation

Last synced: 3 months ago
JSON representation

A text animation component for Ink

• Host: GitHub
• URL: https://github.com/yardnsm/ink-text-animation
• Owner: yardnsm
• License: mit
• Created: 2018-04-05T12:48:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-15T14:29:11.000Z (over 5 years ago)
• Last Synced: 2024-07-17T18:35:15.678Z (4 months ago)
• Topics: chalk-animation, colors, ink, ink-component, react, text-animation
• Language: JavaScript
• Size: 242 KB
• Stars: 67
• Watchers: 0
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - yardnsm/ink-text-animation - A text animation component for Ink (JavaScript)

README

        
# ink-text-animation

[![Build Status](https://travis-ci.org/yardnsm/ink-text-animation.svg?branch=master)](https://travis-ci.org/yardnsm/ink-text-animation)

> A text animation component for [Ink](https://github.com/vadimdemedes/ink/)

![](.github/screenshot.gif)

## Install

```console

$ npm install --save ink-text-animation

```

## Usage

```javascript

import { h, render, Text } from 'ink';

import TextAnimation from 'ink-text-animation';

render(

  


    

      {`Look at me, I'm moving!`}

    

  

);

```


## API

### ``

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](https://github.com/bokub/chalk-animation#available-animations).

##### speed

Type: `number`


Default: `1`

The speed of the animation.

---

## License

MIT © [Yarden Sod-Moriah](http://yardnsm.net/)