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 2 months 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 (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T04:50:50.000Z (6 months ago)
• Last Synced: 2024-04-14T09:52:32.443Z (5 months ago)
• Topics: cli, figlet, ink, ink-component, jsx, nodejs, npm-package, react
• Language: TypeScript
• Size: 33.2 KB
• Stars: 110
• Watchers: 3
• Forks: 7
• 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)

![](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(

	

		

	

);

```

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