https://github.com/sindresorhus/ink-big-text
Awesome text component for Ink
https://github.com/sindresorhus/ink-big-text
cli figlet ink ink-component jsx nodejs npm-package react
Last synced: about 1 month ago
JSON representation
Awesome text component for Ink
- Host: GitHub
- URL: https://github.com/sindresorhus/ink-big-text
- Owner: sindresorhus
- License: mit
- Created: 2018-04-07T11:17:44.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T04:50:50.000Z (about 1 year ago)
- Last Synced: 2025-03-28T22:21:05.276Z (about 2 months ago)
- Topics: cli, figlet, ink, ink-component, jsx, nodejs, npm-package, react
- Language: TypeScript
- Size: 33.2 KB
- Stars: 117
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# ink-big-text
> Awesome text component for [Ink](https://github.com/vadimdemedes/ink)
## 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(
);
```
## API
### ``
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.tsx`](source/index.tsx#L5) for more.
## Related
- [ink-gradient](https://github.com/sindresorhus/ink-gradient) - Gradient color component for Ink
- [ink-link](https://github.com/sindresorhus/ink-link) - Link component for Ink