s-m-r-t
Open the s-m-r-t source on GitHub Switch to dark color scheme
← All UI components

Forms and controls

NumericKeypad

No summary has been written for NumericKeypad. Everything below is generated from the declaration shipped in 0.57.40 and describes the real contract.

Public export

typescript
import { NumericKeypad } from '@happyvertical/smrt-ui/forms';
Import path
@happyvertical/smrt-ui/forms
Props
21
Props described
21 of 21
Bindable state
0
Callback events
2
Verified release
0.57.40

Props

NameTypeRequiredDescription
valuestring | number | nullNoTyped text; a number is accepted and re-written as text on the next key.
mode'number' | 'money'No`money` follows the currency's minor-unit exponent. Default `number`.
minnumberNoSmallest acceptable value (major units); below it the keypad shows an error.
maxnumberNoLargest acceptable value (major units).
clampToMaxbooleanNoRefuse a key press that would take the value above `max`.
maxDecimalsnumberNoDigits after the point; 0 is integer-only. Default 0, or the currency's in money mode.
maxLengthnumberNoLongest typed text, counting the point.
currencystringNoISO 4217 code for money mode (sets the minor-unit exponent). Default exponent 2.
minorUnitExponentnumberNoOverride the money minor-unit exponent.
prefixstringNoShown before the display value (a currency symbol).
unitstringNoShown after the display value (a unit such as `pcs`).
labelstringNoAccessible name; defaults to the `labels.region` text.
onChange(detail: NumericKeypadDetail) => voidNoCalled after every change with the parsed entry.
onSubmit(detail: NumericKeypadDetail) => voidNoCalled by the confirm key / Enter; supplying it shows the confirm key.
submitLabelstringNoConfirm key text; defaults to the catalog's "Confirm".
disabledbooleanNoIgnores input and disables every key.
namestringNoField name: posts the typed text (number) or integer minor units (money).
labelsPartial<NumericKeypadLabels>NoText overrides; defaults come from the `ui` i18n catalog.
idstringNoDOM id of the component root.
classstringNoCSS class to apply to the component root.
interactionControlInteractionOptions | falseNoInteraction options or false to disable registration.

Bindable state

This component has no bindable public state.

Callback events

  • onChange(detail: NumericKeypadDetail) => void
  • onSubmit(detail: NumericKeypadDetail) => void

Examples and explanation