ドキュメントを検索

Field

ラベル、説明、エラーメッセージをフォームコントロールに関連付けます。

フォームフィールド用のWAI-ARIA APGパターンはありません。Fieldはネイティブの<label>、<input>、<textarea>要素を使用し、それらをfor、aria-describedby、aria-invalidで関連付けます。

We'll never share your email.
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>
  );
});

インストール#

個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。

pnpm add @leve-ui/field

構造#

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を表示し、入力欄を無効としてマークします。このデモでは、入力欄をクリアするとエラーが表示されます。

Disabled#

Rootのdisabledは入力欄を無効化します。

必須#

Rootのrequiredは入力欄を必須にします。

Textarea#

複数行のテキストにはField.Textareaを使用します。

Tell us about yourself.

APIリファレンス#

Root#

Propデフォルト型
ids–{ control?: string; label?: string; description?: string; errorMessage?: string }

パーツの要素IDを上書きします。IDはここでのみ上書きできます(adr/0024)。

invalidfalseboolean

コントロールを無効(aria-invalid)としてマークし、ErrorMessageを表示します。

disabledfalseboolean

コントロールを無効化します。

requiredfalseboolean

コントロールを必須としてマークします。

hasDescriptionfalseboolean

Field.Descriptionがレンダリングされるときにtrueに設定され、コントロールがそれによって説明されるようになります(aria-describedby)。

すべての<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-invalidFieldが無効な場合に存在
data-disabledFieldが無効化されている場合に存在
data-requiredFieldが必須の場合に存在

Field内では、forはコントロールを指します。

Input#

Propデフォルト型
bind:value–Signal<string>

inputの値と双方向同期されるシグナル。

invalidfalseboolean

コントロールを無効(aria-invalid="true"、data-invalid)としてマークします。Fieldの内部では、Fieldが無効である間、コントロールも無効になります。

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の値と双方向同期されるシグナル。

invalidfalseboolean

コントロールを無効(aria-invalid="true"、data-invalid)としてマークします。Fieldの内部では、Fieldが無効である間、コントロールも無効になります。

すべての<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-invalidFieldが無効な場合に存在
data-disabledFieldが無効化されている場合に存在
data-requiredFieldが必須の場合に存在

ErrorMessage#

独自のpropはありません。 すべての<div>属性を受け入れます。

データ属性値
data-leve-field-error-message常に存在
data-invalidFieldが無効な場合に存在
data-disabledFieldが無効化されている場合に存在
data-requiredFieldが必須の場合に存在

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自体にはキーボード操作はありません。