@k8ordo/ui

CopyButton

テキストをクリップボードにコピーし、コピーしたことを示すボタンです。

インポート

ts
import { CopyButton } from '@k8ordo/ui';

使い方

押すとアイコンが2秒間チェックに変わります。隣のライブリージョンを通じて、スクリーンリーダーが「コピーしました」と読み上げます。書き込みに失敗したときはエラーのアイコンになります。ボタンの名前は変わりません。

tsx
<CopyButton value="pnpm add @k8ordo/ui" label="Copy command" size="sm" />

アイコンだけ

iconOnlyを付けると透明なIconButtonになります。labelはツールチップと読み上げの名前になります。

tsx
<CopyButton value={code} label="Copy code" iconOnly size="sm" />
<CopyButton value={code} label="Copy code" iconOnly />
<CopyButton value={code} label="Copy code" iconOnly size="lg" />

押したときに作るテキスト

valueには関数も渡せ、Promiseを返してもかまいません。関数は押したときに呼ばれ、返したPromiseはそのままClipboardItemに渡ります。テキストが後から決まっても書き込みはクリックの中で始まるので、awaitのあとの書き込みを拒むSafariでも動きます。

tsx
'use client';

<CopyButton label="Copy link" value={() => window.location.href} />

// A promise is fine too: the write still starts inside the click
<CopyButton
  label="Copy as Markdown"
  value={async () => (await fetch(`/blog/${slug}.md`)).text()}
/>

Props

value
Type: string|(() => string | Promise<string>)
Default: -
disabled?
Type: boolean
Default: false
iconOnly?
Type: boolean
Default: false
label?
Type: string
Default: -
size?
Type: 'sm'|'md'|'lg'
Default: 'md'
PropTypeDefault
valuestring|(() => string | Promise<string>)-
disabled?booleanfalse
iconOnly?booleanfalse
label?string-
size?'sm'|'md'|'lg''md'
k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。