# Clipboard

Copy-to-clipboard button with success feedback



<ComponentPreview base="ink" name="clipboard-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/clipboard
    ```
  </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 src="registry/bases/ink/hooks/use-unicode.ts" title="hooks/use-unicode.ts" />

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

      <ComponentSource src="registry/bases/ink/hooks/use-interaction.tsx" title="hooks/use-interaction.tsx" />

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

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

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

Usage [#usage]

```tsx
import { Clipboard } from "@/components/ui/clipboard";
```

```tsx
<Clipboard value="npm install termcn" label="Install command" />
```

API Reference [#api-reference]

Clipboard [#clipboard]

| Prop             | Type     | Default     |
| ---------------- | -------- | ----------- |
| `value`          | `string` | `required`  |
| `label`          | `string` | -           |
| `successMessage` | `string` | `"Copied!"` |
| `timeout`        | `number` | `2000`      |

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.