Struct Input

pub struct Input { /* private fields */ }

Small box to write some text.

Example

fn app() -> impl IntoElement {
    let mut value = use_state(String::new);

    rect()
        .expanded()
        .center()
        .spacing(6.)
        .child(
            Input::new()
                .placeholder("Type your name")
                .value(value.read().clone())
                .onchange(move |v| value.set(v)),
        )
        .child(format!("Your name is {}", value.read()))
}

Preview

Implementations

impl Input

pub fn new() -> Self

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

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

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

pub fn onchange(self, handler: impl FnMut(String) + 'static) -> Self

pub fn onvalidate(self, handler: impl FnMut(InputValidator) + 'static) -> 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(self, theme: InputThemePartial) -> Self

pub fn key(self, key: impl Into<DiffKey>) -> Self

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.

impl InputThemePartialExt for Input

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

fn hover_background(self, hover_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 corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

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

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

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

impl KeyExt for Input

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

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

impl PartialEq for Input

fn eq(&self, other: &Input) -> 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 Render for Input

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl StructuralPartialEq for Input