NumericTextBox

Props

NameTypeDescription
defaultValuenumber | nullDefault value
formatstring

# is a placeholder for your numbers.

. or , is a fractional pert separator, use either of them.

The number of # after a fractional separator corresponds to the number of fractional digits.

# => 1000 (any whole number)

#. => 1000

#.# => 1000.0

#.### => 1000.000

You can use prefixes and suffixes alongside with numbers, they must be separated by a space.

# min => 1000 min

from # days => from 1000 days

# is the default format

isDisabledbooleanDisable the component
maxnumberMax allowed number
minnumberMin allowed number
onBlur(event: BlurEvent) => voidBlur handler
onChange(event: ChangeEvent<T>) => voidValue change handler
onEnterPress(event: EnterPressEvent) => voidEnter press handler
onFocus(event: FocusEvent) => voidFocus handler
shouldTrimTrailingZerosbooleanTo trim or not to trim
shouldRender
boolean
Pass false if you don't want the component to appear
stepnumberHow much the value is increased/decreased on mouse events
thousandsSeparatorstringA space by default (1 000 000.00)
valuenumber | nullComponent value
_[className]
[x: string]: unknown
E.g.: _w-48 adds a css class w-48 to the component's outer wrapper.

<L.NumericTextBox
  format='#.# humans'
  onChange={({ component }) => console.log(component.value)}
  _w-48
/>

Validation components' props

NameTypeDescription
form
string
Form name
name
string
Component name
isRequired
boolean
If you don't want the field to be empty
isValid
boolean
Controlled valid state
invalidMessage
ReactNode
Text to show when the value does not match requirements
requiredMessage
ReactNode
Text to show when the field is not filled
shouldValidateUnmounted
boolean
The field can still affect form submission even if it is not rendered
validator
Validator | PredefinedValidator | RegExp | ValidatorObject[]
interface Validator { (value: any): boolean, }

A validator is a function that takes a value and returns true or false depending on the logic it contains

E.g. (value) => value.length > 4

type PredefinedValidator = | 'creditCardNumber' | 'email' | 'url'

See predefined validators

interface ValidatorObject { validator: PredefinedValidator | RegExp | Validator, invalidMessage?: string, }

ValidatorObject is useful wnen you need to validate a value against several validators and show inividual messages for each.
Just use an array of validator objects.

E.g.

[ { validator: (value) => value.length > 4, invalidMessage: 'More than 4 sympols please' }, { validator: /^\w+$/, invalidMessage: 'Only a-z, A-Z, 0-9 and _ are allowed' } ]
<>
<L.NumericTextBox
  onChange={({ component }) => console.log(component.value)}
  form='numeric_form'
  name='numeric'
  isRequired
  requiredMessage='Please enter something'
  validator={(val) => val === 42}
  invalidMessage='The number should be 42'
  _w-48
/>
<br />
<L.Button
  form='numeric_form'
  onClick={({ form }) => console.log(form)}
>
  Click me
</Button>
</>

Customization props

NameType
arrowButtonsRender
inputRender
invalidMessageRender
wrapperRender
({ Element, elementprops, componentProps, componentState }): React.ReactNode
Customization

<L.NumericTextBox
  onChange={({ component }) => console.log(component.value)}
  _w-48
/>