NumberInputOptions interface
The number input options.
Signature:
export interface NumberInputOptions
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
autoDecimalDigits? | boolean | (Optional) Whether the decimal symbol is inserted automatically, using the last inputted digits as decimal digits. Default is false (the decimal symbol needs to be inserted manually). | |
autoSign? | boolean | (Optional) Whether the minus symbol is automatically inserted or prevented to be inputted depending on the configured valueRange . Default is true . | |
currency? | string | (Optional) A ISO 4217 currency code, which is required when using NumberFormatStyle.Currency. | |
currencyDisplay? | CurrencyDisplay | (Optional) How to display the currency when using NumberFormatStyle.Currency. | |
exportValueAsInteger? | boolean | (Optional) Whether the number value should be exported as integer instead of float value. Default value is false . | |
formatStyle? | NumberFormatStyle | (Optional) The format style to use. Default value is "decimal" . | |
hideGroupingSeparatorOnFocus? | boolean | (Optional) Whether to hide the grouping separator on focus. Default value is true . | |
hideNegligibleDecimalDigitsOnFocus? | boolean | (Optional) Whether to hide negligible decimal digits on focus. Default value is true . | |
hidePrefixOrSuffixOnFocus? | boolean | (Optional) Whether to hide the prefix or suffix on focus. Default value is true . | |
locale? | string | (Optional) A BCP 47 language tag. Default value is undefined (use the default locale of the Browser) | |
precision? | number | NumberRange | (Optional) The number of displayed decimal digits. Default value is undefined (use the default of the NumberFormatStyle, decimal digits will be hidden for integer numbers). Must be between 0 and 15. | |
step? | number | (Optional) Step size which is used to increment or decrement the value. Default is the smallest possible value depending on the maximum fraction digits. | |
unit? | string | (Optional) A unit identifier, which is required when using NumberFormatStyle.Unit. Pairs of simple units can be concatenated with "-per-" to make a compound unit. | |
unitDisplay? | UnitDisplay | (Optional) How to display the unit when using NumberFormatStyle.Currency. | |
useGrouping? | boolean | (Optional) Whether to use grouping separators such as thousands/lakh/crore separators. Default is true . | |
valueRange? | NumberRange | (Optional) The range of accepted values. Default is undefined (no value range). The validation is triggered on blur and automatically sets the respective threshold if out of range. |