JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 47956
  • Score
    100M100P100Q151860F
  • License MIT

Link component for Ink

Package Exports

  • ink-link

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ink-link) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ink-link Build Status

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

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).