Field
ラベル、説明、エラーメッセージをフォームコントロールに関連付けます。
フォームフィールド用のWAI-ARIA APGパターンはありません。Fieldはネイティブの<label>、<input>、<textarea>要素を使用し、それらをfor、aria-describedby、aria-invalidで関連付けます。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Field } from '@leve-ui/field';
import styles from './default.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Field.Root hasDescription class="field-default">
<Field.Label class="field-default-label">Email</Field.Label>
<Field.Input type="email" placeholder="[email protected]" class="field-default-input" />
<Field.Description class="field-default-description">
We'll never share your email.
</Field.Description>
</Field.Root>
);
});.field-default {
display: flex;
flex-direction: column;
gap: 6px;
width: 280px;
font-family: inherit;
font-size: 14px;
}
.field-default-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.field-default-input {
height: 36px;
padding: 0 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 14px;
}
.field-default-input::placeholder {
color: light-dark(#475569, #c9ddf0);
opacity: 0.7;
}
.field-default-input:focus-visible {
border-color: #009dfd;
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.field-default-description {
margin: 0;
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
}インストール#
個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。
pnpm add @leve-ui/fieldnpm install @leve-ui/fieldyarn add @leve-ui/fieldbun add @leve-ui/fieldpnpm add @leve-ui/corenpm install @leve-ui/coreyarn add @leve-ui/corebun add @leve-ui/core構造#
import { Field } from '@leve-ui/field'; // or '@leve-ui/core'
<Field.Root>
<Field.Label />
<Field.Input /> {/* or <Field.Textarea /> */}
<Field.Description />
<Field.ErrorMessage />
</Field.Root>
| パーツ | 要素 | 説明 |
|---|---|---|
Field.Root | <div> | 各パーツをラップし、IDおよびinvalid / disabled / requiredの状態を保持します。 |
Field.Label | <label> | コントロールのラベル。 |
Field.Input | <input> | 1行のコントロール。 |
Field.Textarea | <textarea> | 複数行のコントロール。 |
Field.Description | <div> | コントロールのヒント。 |
Field.ErrorMessage | <div> | エラーメッセージ。Rootがinvalidの間のみレンダリングされます。 |
Checkboxなどの他のleve-uiフォームコントロールもFieldの情報を読み取り、Field.Inputの代わりに使用できます。
例#
無効#
RootのinvalidはField.ErrorMessageを表示し、入力欄を無効としてマークします。このデモでは、入力欄をクリアするとエラーが表示されます。
import { component$, useSignal, useStyles$ } from '@builder.io/qwik';
import { Field } from '@leve-ui/field';
import styles from './invalid.css?inline';
export default component$(() => {
useStyles$(styles);
const value = useSignal('leve');
return (
<Field.Root invalid={value.value.trim() === ''} required class="field-invalid">
<Field.Label class="field-invalid-label">Username</Field.Label>
<Field.Input bind:value={value} class="field-invalid-input" />
<Field.ErrorMessage class="field-invalid-error-message">
Username is required.
</Field.ErrorMessage>
</Field.Root>
);
});.field-invalid {
display: flex;
flex-direction: column;
gap: 6px;
width: 280px;
font-family: inherit;
font-size: 14px;
}
.field-invalid-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.field-invalid-input {
height: 36px;
padding: 0 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 14px;
}
.field-invalid-input::placeholder {
color: light-dark(#475569, #c9ddf0);
opacity: 0.7;
}
.field-invalid-input:focus-visible {
border-color: #009dfd;
outline: 2px solid #009dfd;
outline-offset: 2px;
}
/* Set by the library while the field is invalid */
.field-invalid-input[aria-invalid="true"] {
border-color: light-dark(#dc2626, #f87171);
}
.field-invalid-error-message {
margin: 0;
font-size: 13px;
color: light-dark(#dc2626, #f87171);
}Disabled#
Rootのdisabledは入力欄を無効化します。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Field } from '@leve-ui/field';
import styles from './disabled.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Field.Root disabled class="field-disabled">
<Field.Label class="field-disabled-label">Name</Field.Label>
<Field.Input class="field-disabled-input" />
</Field.Root>
);
});.field-disabled {
font-family: inherit;
display: flex;
flex-direction: column;
gap: 6px;
width: 280px;
font-size: 14px;
}
.field-disabled-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.field-disabled-input {
height: 36px;
padding: 0 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 14px;
}
.field-disabled-input::placeholder {
color: light-dark(#475569, #c9ddf0);
opacity: 0.7;
}
.field-disabled-input:focus-visible {
border-color: #009dfd;
outline: 2px solid #009dfd;
outline-offset: 2px;
}
/* Set by the library while the field is disabled */
.field-disabled-input[data-disabled] {
opacity: 0.5;
cursor: not-allowed;
}必須#
Rootのrequiredは入力欄を必須にします。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Field } from '@leve-ui/field';
import styles from './required.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Field.Root required class="field-required">
<Field.Label class="field-required-label">Full name</Field.Label>
<Field.Input class="field-required-input" />
</Field.Root>
);
});.field-required {
display: flex;
flex-direction: column;
gap: 6px;
width: 280px;
font-family: inherit;
font-size: 14px;
}
.field-required-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.field-required-input {
height: 36px;
padding: 0 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 14px;
}
.field-required-input::placeholder {
color: light-dark(#475569, #c9ddf0);
opacity: 0.7;
}
.field-required-input:focus-visible {
border-color: #009dfd;
outline: 2px solid #009dfd;
outline-offset: 2px;
}
/* Mark the label of a required field with an asterisk */
.field-required-label[data-required]::after {
content: " *";
color: light-dark(#dc2626, #f87171);
}Textarea#
複数行のテキストにはField.Textareaを使用します。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Field } from '@leve-ui/field';
import styles from './textarea.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Field.Root hasDescription class="field-textarea">
<Field.Label class="field-textarea-label">Bio</Field.Label>
<Field.Textarea placeholder="I build things with Qwik." class="field-textarea-textarea" />
<Field.Description class="field-textarea-description">
Tell us about yourself.
</Field.Description>
</Field.Root>
);
});.field-textarea {
display: flex;
flex-direction: column;
gap: 6px;
width: 280px;
font-family: inherit;
font-size: 14px;
}
.field-textarea-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.field-textarea-textarea {
min-height: 88px;
padding: 8px 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 14px;
resize: vertical;
}
.field-textarea-textarea::placeholder {
color: light-dark(#475569, #c9ddf0);
opacity: 0.7;
}
.field-textarea-textarea:focus-visible {
border-color: #009dfd;
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.field-textarea-description {
margin: 0;
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
}APIリファレンス#
Root#
| Prop | デフォルト | 型 |
|---|---|---|
| ids | – | { control?: string; label?: string; description?: string; errorMessage?: string } パーツの要素IDを上書きします。IDはここでのみ上書きできます(adr/0024)。 |
| invalid | false | boolean コントロールを無効( |
| disabled | false | boolean コントロールを無効化します。 |
| required | false | boolean コントロールを必須としてマークします。 |
| hasDescription | false | boolean
|
すべての<div>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-field | 常に存在 |
data-invalid | 無効な場合に存在 |
data-disabled | 無効時に存在 |
data-required | 必須の場合に存在 |
パーツのIDはRootのidsでのみ上書きできます。Field内ではパーツのidは無視されます。Field.Descriptionをレンダリングする場合は、コントロールがそれによって説明されるようにhasDescriptionを設定してください(ADR 0024)。
Label#
独自のpropはありません。 すべての<label>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-field-label | 常に存在 |
data-invalid | Fieldが無効な場合に存在 |
data-disabled | Fieldが無効化されている場合に存在 |
data-required | Fieldが必須の場合に存在 |
Field内では、forはコントロールを指します。
Input#
| Prop | デフォルト | 型 |
|---|---|---|
| bind:value | – | Signal<string> inputの値と双方向同期されるシグナル。 |
| invalid | false | boolean コントロールを無効( |
| bind:checked | – | Signal<boolean> チェック状態と双方向同期されるシグナル(checkboxおよびradio input用)。 |
すべての<input>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-field-input | 常に存在 |
data-invalid | 無効な場合に存在 |
data-disabled | 無効時に存在 |
data-required | 必須の場合に存在 |
inputはFieldからdisabledとrequiredを取得します。Fieldの外でも通常の<input>として動作し、その場合はinvalidを渡すことで無効としてマークできます。
Textarea#
| Prop | デフォルト | 型 |
|---|---|---|
| bind:value | – | Signal<string> textareaの値と双方向同期されるシグナル。 |
| invalid | false | boolean コントロールを無効( |
すべての<textarea>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-field-textarea | 常に存在 |
data-invalid | 無効な場合に存在 |
data-disabled | 無効時に存在 |
data-required | 必須の場合に存在 |
textareaはFieldからdisabledとrequiredを取得します。Fieldの外でも通常の<textarea>として動作し、その場合はinvalidを渡すことで無効としてマークできます。
説明#
独自のpropはありません。 すべての<div>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-field-description | 常に存在 |
data-invalid | Fieldが無効な場合に存在 |
data-disabled | Fieldが無効化されている場合に存在 |
data-required | Fieldが必須の場合に存在 |
ErrorMessage#
独自のpropはありません。 すべての<div>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-field-error-message | 常に存在 |
data-invalid | Fieldが無効な場合に存在 |
data-disabled | Fieldが無効化されている場合に存在 |
data-required | Fieldが必須の場合に存在 |
Field内では、Fieldがinvalidでない間、エラーメッセージはレンダリングされません。
アクセシビリティ#
Field.Labelはネイティブの<label>であり、そのforがコントロールを指すため、コントロールに名前を付け、クリックするとコントロールにフォーカスします。- コントロールは、渡された任意の
aria-describedbyの後に、Field.Description(hasDescriptionが設定されている場合)およびField.ErrorMessage(無効な間)を指すaria-describedbyをレンダリングします。 - コントロールは無効な間に
aria-invalid="true"をレンダリングし、ネイティブのdisabled属性およびrequired属性もレンダリングします。 Field.ErrorMessageはrole="alert"を描画するため、エラーが表示されたときにスクリーンリーダーがそれを読み上げます。割り込まずに読み上げるにはrole="status"を渡してください。- 無効化されたコントロールはTabによってスキップされます。
- Field自体にはキーボード操作はありません。