Struct Input 

pub struct Input<T: 'static = String> { /* private fields */ }

Small box to write some text.

Normal

fn app() -> impl IntoElement {
    let value = use_state(String::new);
    Input::new(value).placeholder("Type here")
}

Filled

fn app() -> impl IntoElement {
    let value = use_state(String::new);
    Input::new(value).placeholder("Type here").filled()
}

Flat

fn app() -> impl IntoElement {
    let value = use_state(String::new);
    Input::new(value).placeholder("Type here").flat()
}

Value types

The value can be of any type implementing InputType, for example numbers.

fn app() -> impl IntoElement {
    let value = use_state(|| 50u8);
    Input::new(value).placeholder("Age")
}

Preview

Implementations

impl<T: InputType> Input<T>

pub fn new(value: impl Into<Writable<T>>) -> Self

pub fn enabled(self, enabled: impl Into<bool>) -> Self

pub fn placeholder(self, placeholder: impl Into<Cow<'static, str>>) -> Self

pub fn on_validate( self, on_validate: impl Into<EventHandler<InputValidator>>, ) -> Self

pub fn on_submit(self, on_submit: impl Into<EventHandler<T>>) -> Self

pub fn mode(self, mode: InputMode) -> Self

pub fn auto_focus(self, auto_focus: impl Into<bool>) -> Self

pub fn width(self, width: impl Into<Size>) -> Self

pub fn theme_colors(self, theme: InputColorsThemePartial) -> Self

pub fn theme_layout(self, theme: InputLayoutThemePartial) -> Self

pub fn text_align(self, text_align: impl Into<TextAlign>) -> Self

pub fn style_variant(self, style_variant: impl Into<InputStyleVariant>) -> Self

pub fn layout_variant( self, layout_variant: impl Into<InputLayoutVariant>, ) -> Self

pub fn filled(self) -> Self

Shortcut for Self::style_variant with InputStyleVariant::Filled.

pub fn flat(self) -> Self

Shortcut for Self::style_variant with InputStyleVariant::Flat.

pub fn compact(self) -> Self

Shortcut for Self::layout_variant with InputLayoutVariant::Compact.

pub fn expanded(self) -> Self

Shortcut for Self::layout_variant with InputLayoutVariant::Expanded.

pub fn a11y_id(self, a11y_id: impl Into<AccessibilityId>) -> Self

pub fn leading(self, leading: impl Into<Element>) -> Self

Optional element rendered before the text input.

pub fn trailing(self, trailing: impl Into<Element>) -> Self

Optional element rendered after the text input.

pub fn on_pre_key_down( self, on_pre_key_down: impl Into<Callback<Event<KeyboardEventData>, bool>>, ) -> Self

Sets a pre-handler called for each key event. Return true to let the input process it, false to skip. The callback may call stop_propagation() / prevent_default() directly.

Trait Implementations

impl<T: Clone + 'static> Clone for Input<T>

fn clone(&self) -> Input<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: InputType> Component for Input<T>

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl<T: 'static> CornerRadiusExt for Input<T>

fn with_corner_radius(self, corner_radius: f32) -> Self

Round all four corners to the given radius in pixels.

fn rounded_none(self) -> Self

Shortcut for corner_radius(0.) - removes border radius.

fn rounded(self) -> Self

Shortcut for corner_radius(6.) - default border radius.

fn rounded_sm(self) -> Self

Shortcut for corner_radius(4.) - small border radius.

fn rounded_md(self) -> Self

Shortcut for corner_radius(6.) - medium border radius.

fn rounded_lg(self) -> Self

Shortcut for corner_radius(8.) - large border radius.

fn rounded_xl(self) -> Self

Shortcut for corner_radius(12.) - extra large border radius.

fn rounded_2xl(self) -> Self

Shortcut for corner_radius(16.) - extra large border radius.

fn rounded_3xl(self) -> Self

Shortcut for corner_radius(24.) - extra large border radius.

fn rounded_4xl(self) -> Self

Shortcut for corner_radius(32.) - extra large border radius.

fn rounded_full(self) -> Self

Shortcut for corner_radius(99.) - fully rounded (pill shape).

impl<T: 'static> InputColorsThemePartialExt for Input<T>

fn background(self, background: impl Into<Color>) -> Self

fn focus_background(self, focus_background: impl Into<Color>) -> Self

fn border_fill(self, border_fill: impl Into<Color>) -> Self

fn focus_border_fill(self, focus_border_fill: impl Into<Color>) -> Self

fn color(self, color: impl Into<Color>) -> Self

fn placeholder_color(self, placeholder_color: impl Into<Color>) -> Self

impl<T: 'static> InputLayoutThemePartialExt for Input<T>

fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

fn inner_margin(self, inner_margin: impl Into<Gaps>) -> Self

impl<T: 'static> KeyExt for Input<T>

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl<T: PartialEq + 'static> PartialEq for Input<T>

fn eq(&self, other: &Input<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: 'static> StructuralPartialEq for Input<T>