Input

The input component is an input field that users can type into.

Basic Example

The on_blur event handler is called when focus has left the input for example, it’s called when the user clicks outside of a focused text input.

Hello World!

The on_change event handler is called when the value of input has changed.

Hello World!

Behind the scenes, the input component is implemented as a debounced input to avoid sending individual state updates per character to the backend while the user is still typing. This allows a state variable to directly control the value prop from the backend without the user experiencing input lag.

Submitting a form using input

The name prop is needed to submit with its owning form as part of a name/value pair.

When the required prop is True, it indicates that the user must input text before the owning form can be submitted.

The type is set here to password. The element is presented as a one-line plain text editor control in which the text is obscured so that it cannot be read. The type prop can take any value of email, file, password, text and several others. Learn more here.

Example Form

Results:

{}

To learn more about how to use forms in the Form docs.

Setting a value without using a State var

Set the value of the specified reference element, without needing to link it up to a State var. This is an alternate way to modify the value of the input.

API Reference

rx.input

Captures user input with an optional slot for buttons and icons.

Test

Prop	Type \| Values	Interactive
`size`	`"1" \| "2" \| ...`
`variant`	`"classic" \| "surface" \| ...`
`color_scheme`	`"tomato" \| "red" \| ...`
`radius`	`"none" \| "small" \| ...`
`auto_complete`	`bool`	false
`default_value`	`str`
`disabled`	`bool`	false
`max_length`	`int`
`min_length`	`int`
`name`	`str`
`placeholder`	`str`
`read_only`	`bool`	false
`required`	`bool`	false
`type`	`str`
`value`	`Union[str, int, float]`
`list`	`str`
`accept`	`str`
`alt`	`str`
`auto_focus`	`bool`	false
`capture`	`"True" \| "False" \| ...`
`checked`	`bool`
`default_checked`	`bool`
`form`	`str`
`form_action`	`str`
`form_enc_type`	`str`
`form_method`	`str`
`form_no_validate`	`bool`	false
`form_target`	`str`
`max`	`Union[str, int, float]`
`min`	`Union[str, int, float]`
`multiple`	`bool`	false
`pattern`	`str`
`src`	`str`
`step`	`Union[str, int, float]`

Event Triggers

See the full list of default event triggers

Trigger	Description
`on_focus`	Fired when the textarea is focused.
`on_blur`	Fired when the textarea is blurred.
`on_key_down`	Fired when a key is pressed down.
`on_key_up`	Fired when a key is released.
`on_change`	Fired when the value of the textarea changes.

rx.input.slot

Contains icons or buttons associated with an Input.

Prop	Type \| Values	Default	Interactive
`color_scheme`	`"tomato" \| "red" \| ...`
`side`	`"left" \| "right"`

Event Triggers

See the full list of default event triggers