@k8ordo/ui

コンポーネント

@k8ordo/uiのすべてのコンポーネントです。カードを選ぶと、動く例とpropsの一覧が見られます。

Buttons

クリックで操作を実行するボタンです。colorとvariantで見た目を選びます。

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

アイコンだけのボタンです。labelが必須で、ツールチップと読み上げの名前になります。

矢印キーで移動するボタンのまとまりです。エディタの書式のボタンのように、関連する操作を1か所に並べるときに使います。

Navigation

テキストのリンクです。外部のリンクには新しいタブのアイコンが付きます。

今のページまでの階層を示すパンくずリストです。

前後のボタンと現在の位置だけのページ送りです。ページ番号の一覧はありません。

見出しごとにまとめたリンクのサイドナビです。今のページは傍線で示します。

手順のステップを順に並べ、完了したステップと現在のステップを示します。複数の画面に分かれたフォームの進み具合に使います。

ページの目次です。今読んでいる見出しを示します。

タブで内容を切り替えます。パネルはクロスフェードで切り替わり、キーボード操作はWAI-ARIAのtabsに従います。

Forms

決まった候補から複数を選ぶ入力欄です。選んだものはタグで並び、1つずつ外せます。

月の表から日付を1つ選ぶカレンダーです。値はYYYY-MM-DDで、フォームには何も送りません。

チェックボックスです。ラベルはlabelで渡し、onChangeはcheckedを受け取ります。

選択肢をカードで見せる複数選択です。説明や図を添えて、選択肢を大きく見せたいときに使います。

複数のチェックボックスを、1つの配列の値として扱うグループです。

色を#rrggbbで選ぶ入力欄です。色相と彩度、明度のつまみと、見本から選べます。

候補から1つを選ぶ入力欄です。入力した文字で候補を絞り込むか、searchでサーバーに問い合わせます。

ブラウザの日付の入力欄(type="date")です。値はYYYY-MM-DDの文字列です。

日付の入力欄と、ポップオーバーで開くカレンダーの組み合わせです。

ファイルを選ぶ入力欄です。選ぶボタンとドロップ領域、選んだファイルの一覧を組み合わせて作ります。

<form>のラッパーです。actionにServer ActionかURLを渡して送信します。

入力欄にラベルとヘルプ、エラーの表示を付けるラッパーです。入力欄はrenderInputで描きます。

数値の入力欄です。矢印キーと増減のボタンでstepずつ変わり、空のときの値はnullです。

表示と非表示を切り替えるボタンの付いた、パスワードの入力欄です。

ラジオボタンのグループです。選択肢はoptionsに渡し、onChangeは選んだvalueを受け取ります。

選択肢をカードで見せる単一選択です。説明や図を添えて、選択肢を大きく見せたいときに使います。

2つのつまみで範囲を選ぶスライダーです。価格の下限と上限のように、1組の値を選ぶときに使います。

選択肢から1つを選ぶ<select>です。選択肢はoptionsに{ value, label }で渡します。

つまみが1つのスライダーです。音量のように、範囲の中の1つの値を選ぶときに使います。

オンとオフを切り替えるスイッチです。設定の切り替えのように、すぐに反映される項目に使います。

複数行のテキストの入力欄です。autoResizeを付けると、高さが入力に合わせて変わります。

1行のテキストの入力欄です。typeを渡すと、メールアドレスや日付などブラウザの入力欄になります。

Data Display

開閉できる節です。見出しを押すと本文が開きます。

ユーザーの画像です。画像が無いときは、fallbackの文字かアイコンを出します。

状態や分類を示す小さなラベルです。toneで状態の色が決まります。

内容をまとめるカードです。既定は影の付いた見た目で、bg-subtleのページに置くことを想定しています。

スクロールスナップで1枚ずつ止まるスライドと、前後のボタンです。自動再生はありません。

インラインのコードです。文中のAPI名やファイル名に使います。

サーバーでハイライトし、コピーのボタンを添えたコードブロックです。入口は@k8ordo/ui/code-blockです。

並べ替えと行の選択、列の表示切り替えができる表です。状態はすべて呼び出し側が持ちます。

見出しです。levelでh1からh6の要素を選びます。

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

MarkdownやMDXから描いたHTMLに、本文の組版を戻すコンテナです。記事の本文を包みます。

<table>の意味を保ったまま、横にはみ出す幅をスクロールできる表です。

枝を開閉できる階層の一覧です。ファイルツリーやアウトラインに使い、キーボード操作はWAI-ARIAのtreeに従います。

Feedback

操作の結果やアプリの状態を知らせます。表示されるとスクリーンリーダーが読み上げます。

本文の中に置く注記です。補足や落とし穴を、段落やコードを含めて書けます。

リストや表、検索の結果が空のときの表示です。その旨と、次にできる操作を示します。

進み具合を示すバーです。valueを省くと、進み具合が分からない表示になります。

読み込み中の内容の代わりに置くプレースホルダーです。

読み込み中を示すスピナーです。

画面の下に一時的に出る通知です。useToastのopenで表示します。

Overlays

入力した文字でコマンドを絞り込み、キーボードだけで実行するパレットです。

右クリックした位置に開くメニューです。ファイルの行のように、要素ごとの操作を出すときに使います。

Modalの中に置く見出しと本文、閉じるボタンの組です。

画面の端から出るパネルです。ナビゲーションや補助の操作を、ページを離れずに出すときに使います。

ボタンから開くメニューです。項目はlabelとonActionで作り、SubMenuで入れ子にできます。

ボタンを押すと開く一覧から1つを選びます。1ページの件数のように、フォームの外で設定を選ぶときに使います。

<dialog>で画面の前面に開くオーバーレイです。DialogとDrawerの土台で、中身を自由に置くときは直接使います。

トリガーの要素の近くに開くポップオーバーです。位置はCSS Anchor Positioningで決めます。

ホバーとフォーカスで補足を出すツールチップです。

Layout

CSSグリッドで子要素を並べます。列数を固定するか、auto-fillとauto-fitで幅に合わせます。

仕切りをドラッグするか矢印キーで動かして、2枚のパネルの大きさを分けます。

区切りの線です。節の間や、横に並んだ要素の間に置きます。

子要素を縦か横に、同じ間隔で並べます。gapは間隔のトークンから選びます。

Observers

子要素が画面やスクロール領域に入っているかを知らせます。遅延読み込みや、スクロールに合わせた表示に使います。

子要素の大きさが変わったときにonChangeを呼びます。

Icons

@k8ordo/ui/iconsのアイコンの一覧です。どれもaria-hiddenの<svg>で、名前は周りのボタンなどが持ちます。名前は用途でなく、描いてある形から付けています。

k8ordo

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