Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/ink-link
Link component for Ink
https://github.com/sindresorhus/ink-link
cli ink ink-component jsx nodejs npm-package react
Last synced: about 2 months ago
JSON representation
Link component for Ink
- Host: GitHub
- URL: https://github.com/sindresorhus/ink-link
- Owner: sindresorhus
- License: mit
- Created: 2018-03-25T15:01:24.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-06-10T18:33:47.000Z (over 1 year ago)
- Last Synced: 2024-04-14T09:55:30.961Z (5 months ago)
- Topics: cli, ink, ink-component, jsx, nodejs, npm-package, react
- Language: TypeScript
- Size: 29.3 KB
- Stars: 165
- Watchers: 4
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-list - ink-link
README
# ink-link
> Link component for [Ink](https://github.com/vadimdemedes/ink)
Creates clickable links in the terminal!
## Install
```sh
npm install ink-link
```## Usage
```js
import React from 'react';
import {render, Text} from 'ink';
import Link from 'ink-link';render(
My Website
);
```## API
### ``
[Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)
For unsupported terminals, the link will be printed in parens after the text: `My website (https://sindresorhus.com)`.
#### url
Type: `string`
The URL to link to.
#### fallback
Type: `boolean`\
Default: `true`Determines whether the URL should be printed in parens after the text for unsupported terminals: `My website (https://sindresorhus.com)`.
## Related
- [terminal-link](https://github.com/sindresorhus/terminal-link) - Create clickable links in the terminal
- [ink-gradient](https://github.com/sindresorhus/ink-gradient) - Gradient color component for Ink
- [ink-big-text](https://github.com/sindresorhus/ink-big-text) - Awesome text component for Ink