Struct Input 

pub struct Input<M = ()>(/* private fields */);

input: a single-line text field.

Implementations

impl<M> Input<M>

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

Identity among siblings: keeps the node’s id (and Tern’s view state) across reorders. A string, or an integer.

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

A name of yours, exposed to CSS as data-role.

pub fn tone(self, tone: impl Into<Tone>) -> Self

The semantic color of the node’s chrome.

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

Keeps the node mounted but not laid out.

pub fn mark(self, mark: impl Into<Mark>) -> Self

A transient selection mark drawn over the node.

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

The accessible name of a node that shows no text.

pub fn hovercard<N>(self, card: impl Into<Node<N>>) -> Self

A floating card of card’s tree shown while the pointer rests on the node, in place of title. Sent id-less (ids, keys and handlers inside are ignored); an older Tern ignores it.

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

A link: ⌘-click opens it; copy and open use it.

pub fn grow(self, grow: f64) -> Self

Flex grow inside a row or col.

pub fn shrink(self, shrink: f64) -> Self

Flex shrink inside a row or col.

pub fn basis(self, basis: impl Into<Basis>) -> Self

Flex basis: a fraction of the parent, or the content’s size.

pub fn prop(self, name: &str, value: impl Serialize) -> Self

Sets any prop untyped; null removes it.

pub fn min(self, min: Bound) -> Self

Lower size bounds.

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

A tooltip.

pub fn max(self, max: Bound) -> Self

Upper size bounds (a max.h also clips the node).

pub fn actions(self, actions: Actions) -> Self

What a pointer does, by action name.

pub fn on_click(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on a click (sets actions.click to "click" unless the node names its click action itself).

pub fn on_dblclick(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on a double click (sets actions.dblclick to "dblclick" unless the node names it).

pub fn on_menu(self, act: impl Into<String>, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Adds act to the context menu and sends msg when it is picked.

pub fn on_action(self, act: impl Into<String>, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on action events whose action is act (name or name=value).

pub fn on_action_with( self, act: impl Into<String>, f: impl Fn(&Action) -> M + Send + Sync + 'static, ) -> Self

Maps action events whose action is act to a message.

pub fn on_toggle(self, f: impl Fn(bool) -> M + Send + Sync + 'static) -> Self

Maps toggle events (the new collapsed; a menu, select or trace line that opened is not collapsed) to a message.

pub fn on_select(self, f: impl Fn(&str) -> M + Send + Sync + 'static) -> Self

Maps select events (the item) to a message. On a list’s item the item’s own handler runs first.

pub fn on_activate(self, f: impl Fn(&str) -> M + Send + Sync + 'static) -> Self

Maps activate events (the item) to a message.

pub fn on_change(self, f: impl Fn(&Change) -> M + Send + Sync + 'static) -> Self

Maps change events to a message.

pub fn on_focus(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on focus events (a click asked for the keys).

pub fn on_edit(self, f: impl Fn(&Edit) -> M + Send + Sync + 'static) -> Self

Maps edit events (native editing) to a message.

pub fn on_undo(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on undo events.

pub fn on_send(self, f: impl Fn(&str) -> M + Send + Sync + 'static) -> Self

Maps send events (the text to submit) to a message.

impl<M> Input<M>

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

The text.

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

The caret, UTF-16.

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

The selection anchor, UTF-16.

pub fn decor(self, value: impl Into<Vec<Decor>>) -> Self

Styled ranges.

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

An inline completion after the caret.

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

Dim text while empty.

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

Spans before the text.

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

A vim mode label.

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

The text is code in this language.

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

Not editable.

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

Accepts an atomic send.

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

Input cannot be read yet: Tern keeps what is typed until this clears.

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

The look (default field with any addon, else well).

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

A leading icon.

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

In a sans region, keep the mono face for the text.

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

A clear × while there is text; sends action clear.

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

A mono well before the text.

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

A mono well after the text.

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

A mono unit after the text, inside the field.

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

An attached ⌃⌄ segment; sends action inc / dec.

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

Draws a • per character, with an eye that reveals it.

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

A secret’s shown state.

pub fn buttons(self, value: impl Into<Vec<ActButton>>) -> Self

Buttons attached to the ring, in order.

pub fn keys<K: Into<String>>(self, keys: impl IntoIterator<Item = K>) -> Self

The keycap of the chord that reaches the field, shown while it is idle and empty.

Trait Implementations

impl<M> Clone for Input<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Input<M>

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

Formats the value using the given formatter.

impl<M> From<Input<M>> for Slot<M>

fn from(n: Input<M>) -> Self

Converts to this type from the input type.

impl<M> From<Input<M>> for Node<M>

fn from(n: Input<M>) -> Self

Converts to this type from the input type.

impl<M> From<Input<M>> for View<M>

A bare node is main’s one child.

fn from(n: Input<M>) -> Self

Converts to this type from the input type.

impl<M> From<Node<M>> for Input<M>

fn from(node: Node<M>) -> Self

Converts to this type from the input type.