# ink-big-text

> Awesome text component for Ink

Latest version **2.0.0** (published 2023-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install ink-big-text
pnpm add ink-big-text
yarn add ink-big-text
bun add ink-big-text
```

## Health

**Score 28/100 (F)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-03-24 |
| First published | 2018-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/ink-big-text) |
| Module format | ESM |
| Node | >=14.16 |
| Dependencies | 2 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 143 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | ink-component, ink, component, text, font, big, large, string, react, jsx, terminal, term, console, command-line |

## Links

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

## Dependencies (2)

- [cfonts](https://npm.io/package/cfonts.md) ^3.1.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1

## 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

- 2.0.0 (latest) — 2023-03-24
- 1.2.0 — 2020-07-26
- 1.1.0 — 2020-05-23
- 1.0.1 — 2019-03-07
- 1.0.0 — 2019-03-07
- 0.3.0 — 2018-05-16
- 0.2.0 — 2018-04-08
- 0.1.0 — 2018-04-07

## README

# ink-big-text

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

![](screenshot.png)

## Install

```sh
npm install ink-big-text
```

## 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

### `<BigText/>`

Props except for `text` are passed as options to [`cfonts`](https://github.com/dominikwilkowski/cfonts). The only difference is that the `background` option is named `backgroundColor` here. See the prop types in [`index.js`](index.js) for more.

## Related

- [ink-gradient](https://github.com/sindresorhus/ink-gradient) - Gradient color component for Ink
- [ink-box](https://github.com/sindresorhus/ink-box) - Box component for Ink
- [ink-link](https://github.com/sindresorhus/ink-link) - Link component for Ink

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