Extensions

Press shift + S to search API reference.

React component

InputSynced

View source

Props

interface InputSyncedProps extends SharedInputProps
aria-describedbyundefined | string

A space separated list of description element IDs.

aria-labelledbyundefined | string

A space separated list of label element IDs.

autoCompleteundefined | string

The autoComplete attribute.

autoFocusundefined | false | true

The autoFocus attribute.

classNameundefined | string

Additional class names to apply to the input, separated by spaces.

disabledundefined | false | true

The disabled attribute.

globalConfigKeyGlobalConfigKey

A string key or array key path in GlobalConfig. The input value will always reflect the value stored in GlobalConfig for this key. Changing the input value will update GlobalConfig.

idundefined | string

The id attribute.

maxnumber | string

The max attribute.

maxLengthundefined | number

The maxLength attribute.

minnumber | string

The min attribute.

minLengthundefined | number

The minLength attribute.

nameundefined | string

The name attribute.

patternundefined | string

The pattern attribute.

placeholderundefined | string

The placeholder for the input.

readOnlyundefined | false | true

The readOnly attribute.

requiredundefined | false | true

The required attribute.

sizeControlSizeProp

The size of the input. Defaults to default.

spellCheckundefined | false | true

The spellcheck attribute.

stepnumber | string

The step attribute.

styleReact.CSSProperties

Additional styles to apply to the input.

tabIndexundefined | number

The tabindex attribute.

typeundefined | "number" | "time" | "text" | "date" | "datetime-local" | "email" | "month" | "password" | "search" | "tel" | "url" | "week"

The type for the input. Defaults to text.

onBlur
function (e: FocusEvent<HTMLInputElement>) => unknown

A function to be called when the input loses focus.

onChange
function (e: ChangeEvent<HTMLInputElement>) => unknown

A function to be called when the input changes.

onFocus
function (e: FocusEvent<HTMLInputElement>) => unknown

A function to be called when the input gains focus.