1.1.1 • Published 7 years ago

ink-marquee v1.1.1

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

ink-marquee

marquee component for Ink

Install


$ npm install ink-marquee
# or
$ yarn add ink-marquee

Usage


const { h, render } = require('ink');
const Marquee = require('ink-marquee');

render(<Marquee color="blue" text="long long text" />);

Props

nametypedefaultdesc
textstring""required
colorstring"green""red", "green", "blue"... e.t.c. -> see also chalk
directionstring"rtl"flow direction. "rtl": right to left, "ltr": left to right.
speednumber500flow type. the unit is millisecond
widthnumberwindow(terminal) widthflowable area width.
repeatbooleantruerepeat if flowed

Example

code:

<Marquee text="12" width={3} direction="ltr" speed={1000} repeat={true} />

result:

1__
↓ after 1sec
21_
↓ after 1sec
_21
↓ after 1sec
__2
↓ after 1sec
___
↓ after 1sec
1__

LICENSE

MIT © 2017 y-takey