CurrencyInputBaseOptions

Configuration shared by the hook and the component.

Extended by

allowNegative?: boolean;

Allow negative amounts (refunds, adjustments).

false

country?: string;

Convenience: combined into ${language}-${country} when locale is absent.

currency: string;

ISO-4217 currency code, e.g. 'EUR', 'BGN', 'JPY'. Required.

currencyDisplay?: CurrencyDisplay;

How the currency is displayed.

'symbol'

formatMode?: FormatMode;

When the field formats. 'live' (default) formats as you type with a stable caret; 'blur' shows a plain number while focused.

'live'

language?: string;

Convenience: combined into ${language}-${country} when locale is absent.

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?: number;

Cap on fraction digits. Defaults to the currency’s own default (JPY → 0, EUR → 2, KWD → 3).

minimumFractionDigits?: number;

Floor on fraction digits in the formatted value.

numberingSystem?: string;

Override the numbering system, e.g. 'latn' to force ASCII digits.

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?: (raw) => string;

Transform browser input before locale-aware sanitization.

Parameter	Type
`raw`	`string`

string