# Link

OSC 8 clickable hyperlink



<ComponentPreview base="ink" name="link-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/ink/link
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install ink
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="registry/bases/ink/ui/types.ts" title="components/ui/types.ts" />

      <ComponentSource src="registry/bases/ink/themes/default.ts" title="lib/terminal-themes/default.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-theme.ts" title="hooks/use-theme.ts" />

      <ComponentSource base="ink" name="link" title="components/ui/link.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { Link } from "@/components/ui/link";
```

```tsx
<Link href="https://github.com">GitHub</Link>
```

Examples [#examples]

Show URL and terminals without OSC 8 [#show-url-and-terminals-without-osc-8]

`showHref` appends the URL in dim text. When the terminal does not support OSC 8 hyperlinks, the same fallback is used unless you set `fallback={false}` or pass a custom `fallback` function.

<ComponentPreview base="ink" name="link-show-href" />

API Reference [#api-reference]

Link [#link]

| Prop       | Type                                                 | Default    |
| ---------- | ---------------------------------------------------- | ---------- |
| `children` | `ReactNode`                                          | `required` |
| `href`     | `string`                                             | `required` |
| `color`    | `string`                                             | -          |
| `showHref` | `boolean`                                            | `false`    |
| `fallback` | `boolean \| ((text: string, url: string) => string)` | `true`     |

Notes [#notes]

Accessibility [#accessibility]

termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.

* **Keyboard:** `Enter` / `Space` activate the focused action when enabled; `Escape` dismisses or cancels when supported; `Tab` / `Shift+Tab` move through Ink focus targets.
* **Focus and composition:** Input is active only while the component's focus target is focused, enabled, active, and inside the topmost focus scope.
* **Screen reader:** Ink labels and semantic state expose the component without relying on visual styling alone.