ink-flower

flower characters component for ink

Install

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

Usage

const { h, render } = require('ink');
const Flower = require('ink-flower');

render(<Flower text="ABCDEFG" />);

Props

name | type | default | desc ---- | ---- | ---- | ---- text | string | "" | required color | string | "green" | "red", "green", "blue"... e.t.c. -> see also chalk mark | string | "#" | character of dot spacer | number | 2 | margin around each characters inverse | boolean | false |

Supported characters

• uppercase alphabets: A - Z
• numbers: 0 - 9
• others: !, ?, #, $, %, &, ", ', +, -, *, /, (, ), [, ], =, <, >, ^, |, ;, :, _, @, ., ,

Example

code:

<Flower text="ABC" mark="*" />

result:

  *   ****   ***
 * *  *   * *   *
 * *  ****  *    
***** *   * *    
*   * *   * *   *
*   * ****   ***

LICENSE

MIT © 2017 y-takey