Skip to content

sindresorhus/ink-link

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ink-link

Link component for Ink

Creates clickable links in the terminal!

Looking for a version compatible with Ink 2.x? Check out this release.

Install

$ npm install ink-link

Usage

import React from 'react';
import {render, Text} from 'ink';
import Link from 'ink-link';

render(
	<Link url="https://sindresorhus.com">
		My <Text color="cyan">Website</Text>
	</Link>
);

API

<Link>

Supported terminals.

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