NumericInputProps

Interface

Props for the TextInput component.

Inherits properties from the HTMLInputElement.

See additional props available from HTMLInputElement.

Properties

autoFocus optional

autoFocus: boolean

If true, the component will automatically get focus when the page is loaded.

defaultValue optional

defaultValue: string | number

The default input element value used when the component is not controlled.

focusOnUpDown optional

focusOnUpDown: boolean

If true, the input element will get focus when the up and down step handlers are clicked.

formatter optional

formatter: function

Specifies the format of the displayed value

Type declaration
    (valuestring | number): string
    Parameters
    • valuestring | number
    Returns 
    string

forwardedRef optional

forwardedRef: any

The reference forwarded to the root input element.

onAcceptValue optional

onAcceptValue: function

Callback fires when the input box is blurred or the enter key is pressed, which is considered to be the complete of the editing process.

Type declaration
    (valuestring | number): void
    Parameters
    • valuestring | number
    Returns 
    void

onChange optional

onChange: function

Callback fires when the value is changed.

Type declaration
    (valuenumber): void
    Parameters
    • valuenumber
    Returns 
    void

onPressEnter optional

onPressEnter: function

Callback fires when the Enter key is pressed.

Type declaration
    (eventKeyboardEvent<HTMLInputElement>): void
    Parameters
    • eventKeyboardEvent<HTMLInputElement>
    Returns 
    void

parser optional

parser: function

Specifies the value extracted from the formatter

Type declaration
    (displayValuestring): string | number
    Parameters
    • displayValuestring
    Returns 
    string | number

precision optional

precision: number

Specifies the precision length of the value (number of decimal dijits).

showHandlers optional

showHandlers: boolean

If true, the component will show the up and down arrow handlers.

size optional

size: ButtonSize

Defines the size of the component. The component will take the default size if the value is undefined.

useTouch optional

useTouch: boolean

If true, the component will support touch on mobile devices.

value optional

value: string | number

The input element value used when the component is controlled.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.