インポート
コードをコピー
import { Combobox } from '@k8ordo/ui';使い方
入力すると一覧が開きます。値が変わるのは、クリックかEnterで候補を選んだときだけです。入力の途中でフォーカスを外すと、選んだ候補の表示名に戻ります。空にしてフォーカスを外すと、選択が外れます。↓と↑で一覧を開いて移動し、Alt+↓は開くだけです。Escapeで閉じ、もう一度押すと入力した文字が消えます。複数を選ぶならAutocompleteを使います。
縦書きプレビューに切り替え
- Hokkaido
- Tokyo
- Kanagawa
- Aichi
- Kyoto
- Osaka
- Fukuoka
コードをコピー
<Combobox aria-label="Prefecture" name="prefecture" options={prefectures} />サーバーへの問い合わせ
searchを渡すと、入力するたびに呼ばれて候補を受け取ります。入力し直すと前の呼び出しのsignalが中断されるので、fetchに渡してください。検索している間は、一覧にaria-busyが付きます。失敗と0件は一覧に表示し、読み上げでも知らせます。optionsは入力する前に見せる候補になります。
縦書きプレビューに切り替え
該当なし
コードをコピー
<Combobox
aria-label="City"
name="city"
search={async (query, { signal }) => {
const response = await fetch(
`/api/cities?q=${encodeURIComponent(query)}`,
{ signal },
);
return response.json();
}}
/>@k8ordo/formとの組み合わせ
z.enum()から作ったinputをそのまま展開できます。選んだ値は見えない<select>で送られるので、requiredやルールがそのまま効きます。フォームのリセットと、送信に失敗したときのフォーカスの移動も働きます。
コードをコピー
// schema.ts
export const addressSchema = z.object({
prefecture: z.enum(['hokkaido', 'tokyo', 'osaka']),
});
// address-form.tsx
const prefecture = form.field('prefecture');
<FormControl
errorText={prefecture.error}
invalid={prefecture.invalid}
label="Prefecture"
required={prefecture.required}
renderInput={(props) => (
<Combobox {...props} {...prefecture.input} options={prefectures} />
)}
/>Props
defaultValue?- Type:
string - Default: -
invalid?- Type:
boolean - Default:
false onChange?- Type:
(value: string) => void - Default: -
options?- Type:
readonly Option[] - Default: -
ref?- Type:
Ref<HTMLInputElement> - Default: -
search?- Type:
ComboboxSearch - Default: -
type?- Type:
string - Default: -
value?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
defaultValue? | string | - |
invalid? | boolean | false |
onChange? | (value: string) => void | - |
options? | readonly Option[] | - |
ref? | Ref<HTMLInputElement> | - |
search? | ComboboxSearch | - |
type? | string | - |
value? | string | - |
継承する属性(内部で固定するものを除く): InputHTMLAttributes<HTMLInputElement>
ラベルやプレースホルダーなど、このコンポーネントが描く文言は、propsで指定しないと文言辞書から読まれます。差し替え方は次を見てください: コンポーネントの文言