Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ink-big-text

sindresorhus90.5kMIT2.0.0TypeScript support: included

Awesome text component for Ink

ink-component, ink, component, text, font, big, large, string, react, jsx, terminal, term, console, command-line

readme

ink-big-text

Awesome text component for Ink

Install

npm install ink-big-text

Usage

import React from 'react';
import {render} from 'ink';
import Gradient from 'ink-gradient';
import BigText from 'ink-big-text';

render(
    <Gradient name="rainbow">
        <BigText text="unicorns"/>
    </Gradient>
);

API

<BigText/>

Props except for text are passed as options to cfonts. The only difference is that the background option is named backgroundColor here. See the prop types in index.js for more.