Skip to content

NumberInput

概要

NumberInput は数値入力コンポーネントです。増減ボタン、キーボード操作、マウスホイール操作、precision による小数制御に対応し、Form / FormItem と統合して使用できます。

サブコンポーネント: Root / Input / Control / IncrementTrigger / DecrementTrigger / Label / ValueText

Usage 使用例

基本(Control + Input)

単独の増減ボタン

制御モード(controlled)

小数点精度 + Label + ValueText

variant / size バリエーション

API Reference

NumberInput.Root Props

PropsTypeDefaultDescription
minnumber最小値です
maxnumber最大値です
stepnumber1増減時の刻み幅です
valuenumber | null制御モード時の現在値です
defaultValuenumber | nullnull非制御モード時の初期値です
onValueChange(details: NumberInputValueChangeDetails) => void値変更時に呼ばれます
oninput(value: number | null) => voidForm 互換用の簡易入力コールバックです
onblur() => voidblur 時に呼ばれます
disabledbooleanfalse無効化します
readOnlybooleanfalse読み取り専用にします
namestringinput 要素の name 属性です
size"xs" | "sm" | "md" | "lg""md"入力欄サイズです
variant"outline" | "filled" | "flushed""outline"見た目のバリエーションです
precisionnumber小数点以下の桁数です
clampValueOnBlurbooleantrueblur 時に min / max へ収めます
allowMouseWheelbooleanfalseフォーカス中にマウスホイールで増減できるようにします
widthstringコンポーネント全体の幅です
classstring追加クラスです
styleRecord<string, string>ルートのインラインスタイルです

NumberInputValueChangeDetails

FieldTypeDescription
valuenumber | null正規化後の数値です
valueAsStringstring表示用に整形された文字列です

NumberInput.Input Props

PropsTypeDefaultDescription
placeholderstringプレースホルダーです
classstring入力欄に追加するクラスです
styleRecord<string, string>入力欄のインラインスタイルです

補助 subcomponents の Props

ComponentProps
NumberInput.Controlclass?: string, style?: Record<string, string>
NumberInput.IncrementTriggerclass?: string, style?: Record<string, string>
NumberInput.DecrementTriggerclass?: string, style?: Record<string, string>
NumberInput.Labelclass?: string, style?: Record<string, string>
NumberInput.ValueTextclass?: string, style?: Record<string, string>

Subcomponents

ComponentDescription
NumberInput.Root値管理、バリデーション、キーボード操作を管理するルートです
NumberInput.Inputテキスト入力フィールドです
NumberInput.Control増減ボタンを縦にまとめるラッパーです
NumberInput.IncrementTrigger値を増やすボタンです
NumberInput.DecrementTrigger値を減らすボタンです
NumberInput.Labelラベル表示です
NumberInput.ValueText現在値の表示専用テキストです

Mithril UI Kit Documentation