CurrencyInputBaseOptions
Configuration shared by the hook and the component.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”allowNegative?
Section titled “allowNegative?”optional allowNegative?: boolean;Allow negative amounts (refunds, adjustments).
Default
Section titled “Default”falsecountry?
Section titled “country?”optional country?: string;Convenience: combined into ${language}-${country} when locale is absent.
currency
Section titled “currency”currency: string;ISO-4217 currency code, e.g. 'EUR', 'BGN', 'JPY'. Required.
currencyDisplay?
Section titled “currencyDisplay?”optional currencyDisplay?: CurrencyDisplay;How the currency is displayed.
Default
Section titled “Default”'symbol'formatMode?
Section titled “formatMode?”optional formatMode?: FormatMode;When the field formats. 'live' (default) formats as you type with a
stable caret; 'blur' shows a plain number while focused.
Default
Section titled “Default”'live'language?
Section titled “language?”optional language?: string;Convenience: combined into ${language}-${country} when locale is absent.
locale?
Section titled “locale?”optional locale?: string;BCP-47 locale, e.g. 'bg-BG'. Takes precedence over language/country.
When all three are omitted the runtime default locale is used.
maximumFractionDigits?
Section titled “maximumFractionDigits?”optional maximumFractionDigits?: number;Cap on fraction digits. Defaults to the currency’s own default (JPY → 0, EUR → 2, KWD → 3).
minimumFractionDigits?
Section titled “minimumFractionDigits?”optional minimumFractionDigits?: number;Floor on fraction digits in the formatted value.
Default
Section titled “Default”0numberingSystem?
Section titled “numberingSystem?”optional numberingSystem?: string;Override the numbering system, e.g. 'latn' to force ASCII digits.
optional step?: number;Amount added/subtracted by ArrowUp/ArrowDown. Omit to leave arrow keys untouched. The result is rounded to the currency’s fraction precision.
transformRawValue?
Section titled “transformRawValue?”optional transformRawValue?: (raw) => string;Transform browser input before locale-aware sanitization.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
raw | string |
Returns
Section titled “Returns”string