ink-gradient

ink-gradient

Gradient color component for Ink

Install

npm install ink-gradient

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

<Gradient>

It accepts a string or Ink component as children. For example, <Box/>.

Props

children

The content to colorize.

Multiple <Text> children are treated as separate nodes, which preserves layout when <Gradient> is placed inside a <Box flexDirection="column">.

If you want a continuous gradient across multiple lines, pass a single string or a single <Text> with \n.

name

Type: string

The name of a built-in gradient.

Mutually exclusive with colors.

colors

Type: string[] | object[]

Colors to use to make the gradient.

Mutually exclusive with name.

Related

• ink-big-text - Awesome text component for Ink
• ink-link - Link component for Ink

Similar packages

Other packages similar to ink-gradient

chalk

Chalk is a popular package for styling terminal strings in Node.js. While it doesn't specifically focus on gradients, it provides a wide range of text styling options, including colors, background colors, and text decorations. Chalk is more versatile for general text styling, whereas ink-gradient is specialized for gradient effects in Ink applications.

gradient-string

Gradient-string is a package that allows you to apply gradient colors to strings in the terminal. It is similar to ink-gradient in that it focuses on gradient effects, but it is not specifically designed for use with Ink applications. Gradient-string can be used in any Node.js application to create colorful text outputs.