Form / ShojiFormField

フォームの状態管理・バリデーション・エラー表示を担うコンポーネント群。ShojiFormField を使うと必須・任意バッジが自動表示され、日本語フォームの慣習に合った見た目になる。

インストール

npx shoji add form

プレビュー

使用例

個人の場合は「個人」と入力してください

使い方

こんなときに使う

  • 登録フォーム・設定フォームなど、複数のフィールドをまとめて管理するとき
  • 必須・任意の区別をバッジで視覚的に示したいとき(ShojiFormField)
  • バリデーションエラーをフィールドごとに表示したいとき

使わないほうがいい場面

  • 単一の Input だけで完結する検索ボックス(Form は不要)

JP 最適化のポイント

  • ShojiFormField は「必須」「任意」バッジを自動表示日本のフォームでは英語圏の * より「(必須)」「(任意)」の表記が一般的
  • エラーメッセージはフィールド直下に表示「何が」間違っているかをすぐ分かるよう近接の法則を適用