# ink-gradient

> Gradient color component for Ink

Latest version **4.0.1** (published 2026-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install ink-gradient
pnpm add ink-gradient
yarn add ink-gradient
bun add ink-gradient
```

## Health

**Score 58/100 (C)** — status: active.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2026-05-29 |
| First published | 2018-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/ink-gradient) |
| Module format | ESM |
| Node | >=20 |
| Dependencies | 3 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 174 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | ink-component, ink, component, gradient, gradients, color, colors, rainbow, style, styles, react, jsx, terminal, term, console, command-line |

## Links

- npm: https://www.npmjs.com/package/ink-gradient
- Repository: https://github.com/sindresorhus/ink-gradient
- Homepage: https://github.com/sindresorhus/ink-gradient#readme
- Issues: https://github.com/sindresorhus/ink-gradient/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/ink-gradient

## Dependencies (3)

- [strip-ansi](https://npm.io/package/strip-ansi.md) ^7.1.2
- [gradient-string](https://npm.io/package/gradient-string.md) ^3.0.0
- [@types/gradient-string](https://npm.io/package/@types/gradient-string.md) ^1.1.6

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 4.0.1 (latest) — 2026-05-29
- 4.0.0 — 2026-02-03
- 3.0.0 — 2023-06-10
- 2.0.0 — 2020-08-10
- 1.0.0 — 2019-03-07
- 0.1.1 — 2018-04-07
- 0.1.0 — 2018-04-02

## README

# ink-gradient

> Gradient color component for [Ink](https://github.com/vadimdemedes/ink)

![](screenshot.png)

## Install

```sh
npm install ink-gradient
```

## Usage

```js
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/>`](https://github.com/vadimdemedes/ink#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](https://github.com/bokub/gradient-string#available-built-in-gradients).

Mutually exclusive with `colors`.

##### colors

Type: `string[] | object[]`

[Colors to use to make the gradient.](https://github.com/bokub/gradient-string#initialize-a-gradient)

Mutually exclusive with `name`.

## Related

- [ink-big-text](https://github.com/sindresorhus/ink-big-text) - Awesome text component for Ink
- [ink-link](https://github.com/sindresorhus/ink-link) - Link component for Ink

---
_Source: https://npm.io/package/ink-gradient · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._