@k8ordo/ui

Kbd

キーボードのキーを1つ、キーキャップとして描きます。ショートカットの説明に使います。

インポート

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

使い方

Esc
tsx
<Kbd>Esc</Kbd>

キーの組み合わせ

同時に押すキーは、1キーずつKbdを並べます。

CtrlShiftP
tsx
<Kbd>Ctrl</Kbd>
<Kbd>Shift</Kbd>
<Kbd>P</Kbd>

記号のキー

⌘や⇧のような記号は、そのまま読み上げても意味が通りません。labelを渡すと、見た目は記号のまま、読み上げにはlabelを使います。

CommandK
tsx
<Kbd label="Command">⌘</Kbd>
<Kbd>K</Kbd>

Props

children
Type: string
Default: -
label?
Type: string
Default: -
PropTypeDefault
childrenstring-
label?string-

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLElement>

k8ordo

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