InputMaskコンポーネントは、数値、日付、通貨、メールアドレス、電話番号など、特定のフォーマットで入力を行うために使用されます。
import { InputMask } from 'primereact/inputmask';
InputMaskは、valueとonChangeプロパティに加えて、マスクを定義するmaskプロパティを使用して、制御された入力として使用されます。
<InputMask value={value} onChange={(e) => setValue(e.target.value)} mask="99-999999" placeholder="99-999999" />
マスクフォーマットは、英字を表すa、数字を表す9、英数字を表す*といった定義の組み合わせで構成できます。さらに、(、 )、-などのフォーマット文字も使用できます。
<label htmlFor="ssn" className="font-bold block mb-2">SSN</label>
<InputMask id="ssn" mask="999-99-9999" placeholder="999-99-9999"></InputMask>
<label htmlFor="phone" className="font-bold block mb-2">Phone</label>
<InputMask id="phone" mask="(999) 999-9999" placeholder="(999) 999-9999"></InputMask>
<label htmlFor="serial" className="font-bold block mb-2">Serial</label>
<InputMask id="serial" mask="a*-999-a999" placeholder="a*-999-a999"></InputMask>
入力がマスク定義を満たしていない場合、デフォルトではクリアされます。autoClearプロパティを使用してこの動作を制御します。また、?を使用して、疑問符以降のものをオプションとしてマークします。
<InputMask value={value} onChange={(e) => setValue(e.target.value)} mask="(999) 999-9999? x99999" placeholder="(999) 999-9999? x99999" />
マスクのデフォルトのプレースホルダーはアンダースコアですが、slotCharプロパティを使用してカスタマイズできます。
<InputMask value={value} onChange={(e) => setValue(e.target.value)} mask="99/99/9999" placeholder="99/99/9999" slotChar="mm/dd/yyyy" />
フォーカスされると、入力フィールドの上にフロートラベルが表示されます。フロートラベルのドキュメントで詳細をご覧ください。
<FloatLabel>
<InputMask id="ssn_input" value={value} onChange={(e) => setValue(e.target.value)} mask="999-99-9999" />
<label htmlFor="ssn_input">SSN</label>
</FloatLabel>
variantプロパティをfilledとして指定すると、デフォルトのoutlinedスタイルよりも視覚的な強調表示が高いコンポーネントが表示されます。
<InputMask variant="filled" value={value} onChange={(e) => setValue(e.target.value)} mask="99-999999" placeholder="99-999999" />
invalidプロパティを使用して無効状態を表示し、検証失敗を示します。フォーム検証ライブラリと統合する際にこのスタイルを使用できます。
<InputMask invalid mask="99-999999" placeholder="99-999999" />
disabledが存在する場合、要素は編集およびフォーカスできません。
<InputMask mask="99-999999" placeholder="99-999999" disabled />
InputMaskコンポーネントはネイティブの入力要素をレンダリングし、暗黙的に渡されたプロパティを含みます。コンポーネントを記述する値は、labelタグとidプロパティの組み合わせ、またはaria-labelledby、 aria-labelプロパティを使用して指定できます。
<label htmlFor="date">Date</label>
<InputMask id="date" />
<span id="phone">Phone</span>
<InputMask aria-labelledby="phone" />
<InputMask aria-label="Age" />
| キー | 機能 |
|---|---|
| tab | フォーカスを入力に移動します。 |