Struct Input 

pub struct Input {
    pub common: Common,
    pub value: Option<String>,
    pub placeholder: Option<String>,
    pub label: Option<Line>,
    pub multiline: Option<bool>,
    pub rows: Option<u16>,
    pub secret: Option<bool>,
    pub max_length: Option<u32>,
    pub disabled: Option<bool>,
    pub on_submit: Option<ActionId>,
    pub on_change: Option<ActionId>,
}

A text field (§4.5.2). Typed text is local state; values collects it on submission (§4.6).

Fields

common: Common

Common node props (key is required for Input).

value: Option<String>

Initial value (also drives the field when it changes).

placeholder: Option<String>

Placeholder.

label: Option<Line>

Field label.

multiline: Option<bool>

Multi-line (default false; intrinsic height rows, default 3).

rows: Option<u16>

Rows when multiline.

secret: Option<bool>

Mask the text.

max_length: Option<u32>

Maximum length.

disabled: Option<bool>

Greyed out.

on_submit: Option<ActionId>

Action on Enter (the string value).

on_change: Option<ActionId>

Action on change, debounced 150 ms (the string value).

Implementations

impl Input

pub fn new(key: impl Into<Key>) -> Self

An input with the given key (used to collect values, §4.6).

pub fn value(self, value: impl Into<String>) -> Self

Sets the initial value.

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

Sets the placeholder.

pub fn label(self, label: impl Into<Line>) -> Self

Sets the label.

pub fn multiline(self, rows: u16) -> Self

Multi-line with the given row count.

pub fn secret(self, secret: bool) -> Self

Masks the text.

pub fn max_length(self, max_length: u32) -> Self

Sets the maximum length.

pub fn disabled(self, disabled: bool) -> Self

Greys the field out.

pub fn on_submit(self, action: impl Into<ActionId>) -> Self

Sets the submit action.

pub fn on_change(self, action: impl Into<ActionId>) -> Self

Sets the change action.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Input

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Input> for Node

fn from(i: Input) -> Self

Converts to this type from the input type.

impl IntoNode for Input

fn into_node(self) -> Node

Converts into a node.

impl PartialEq for Input

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Input

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Input

impl WithCommon for Input

fn common_mut(&mut self) -> &mut Common

Mutable access to the node’s common props.

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

Sets the node key.

fn style(self, style: Style) -> Self

Sets the base style.

fn block(self, block: impl Into<BlockProps>) -> Self

Sets the surrounding block.

fn fallback(self, node: impl Into<Node>) -> Self

Sets the fallback node.