Sparkle Design

Form

フォームはフォームの入力要素・ラベル・ヘルパーテキストを包括して提供するために使用するコンポーネントです。

Form の概要図

Anatomy: 解剖図

Formの構成要素を示す解剖図。1はフォームの概要を表すHeaderエリアを、2はオプションで配置可能なフォームの補足情報を伝えるHelperTextを、3は入力フィールドを配置するFieldエリアを、4はオプションで配置可能なフォームに不正が発生した場合にエラーの詳細内容を伝えるErrorTextを示します。
ItemNameDescriptionComponentOptional
1Headerフォームの概要を表すためのヘッダーエリア—
2HelperTextフォームの補足情報を伝えるためのテキスト要素任意
3Field入力フィールドを配置するエリア—
4ErrorTextフォームに不正が発生した場合にエラーの詳細内容を伝えるためのテキスト要素任意

Options: 選択肢

ErrorText

False (Default)

エラーテキストが非表示のデフォルトの状態です。

True

エラーテキストを有効化するためのオプションです。
フォームに不正がある場合にはエラーテキストを用いてエラー内容を提示します。

HelperText

False (Default)

ヘルパーテキストが非表示のデフォルトの状態です。
ヘルパーテキストがなくてもフォームの入力に支障がない場合は省略することができます。

True

ヘルパーテキストを有効化するためのオプションです。
ラベルとフィールドだけではフォームの入力に支障をきたす場合はヘルパーテキストでフォームを補足します。

True (Default)

ヘッダーを表示するオプションです。
基本的にフォーム要素にはラベルを付与します。

False

ヘッダーを非表示にするオプションです。
ヘッダーがなくてもフォームの情報を伝達できる場合は要素を省略することができます。

isRequired

False (Default)

必須バッジを非表示にするオプションです。

入力が必須ではないフィールドに対してはバッジを非表示とします。

True

必須バッジを表示するオプションです。

入力が必須なフィールドに対して必須バッジを表示します。

isHint

False (Default)

ヒントアイコンを非表示にするオプションです。

入力に関するより詳細な情報が必要ない場合はバッジを非表示とします。

True

ヒントアイコンを表示するオプションです。

入力に関するより詳細な情報を提供するためのヒントアイコンを表示します。

Behaviors: 振る舞い

Hintの表示・非表示

ユーザーがヒントアイコンにマウスをホバーしたりフォーカスすることで表示されます。また、ホバーやフォーカスを解除すると、ツールチップが閉じられます。

Hintの表示・非表示の振る舞いを示す図。「契約番号」というラベルの右側に疑問符アイコンが配置され、その上に「契約番号とは、サービスご契約時に利用する8桁の数字です。」というツールチップが表示されています。

Metrics: 寸法

  • Vertical resizing:Hug
  • Horizontal resizing:Hug
  • Item spacing:4px
Formの寸法仕様を示す図。

Usage: 使い方

Do

入力に関わる情報はプレースホルダーではなくヘルパーテキストで表示してください。

Don’t

プレースホルダーに重要な情報を入力することはアクセシビリティに対応していません。値が入力されるとプレースホルダーが表示されなくなります。

適切な使用例。「契約期間」というグループラベル、「開始日」「終了日」というそれぞれのラベルと入力フィールド、「開始日を入力してください」というエラーメッセージが表示されています。
Do

期間指定など、1つのフォームに2つ以上のinputを含む場合は、それぞれラベルを付与してください。
エラーの対象が明確にわかるように、文脈を提示する必要があります。

Contents: 内容

HelperText

Do

ヘルパーテキストではフィールドに正しく入力するための特定の要件など、ヒントや役立つ情報を伝えます。

Don’t

ヘルパーテキストではラベルと同じ情報を単に繰り返すだけではいけません。ユーザーにとって意味のない情報は追加しないでください。

ErrorText

Do

エラーテキストは、フィールドに何を入力する必要があるか理解できる内容を明確かつ簡潔に伝えてください。

Don’t

エラーテキストは、何が問題なのかを述べて解決方法を推測させるだけではいけません。

曖昧なメッセージはエラーとして認識されない場合もあることを留意してください。

Change log: 変更履歴

DateChanges
2025/6/20ドキュメントを更新
2024/11/22初版を公開
小さな気づきや違和感があれば、お気軽に教えてください。
フィードバック
Chat illustration