Struct Field 

pub struct Field<Msg> { /* private fields */ }

A labelled control: the label, the control the application adds inside, and under it a faint hint or, when there is one, the error in the danger colour with a marker.

The field only lays things out. The application owns the value and its error, and marks the control itself as invalid (TextInput::invalid). The label brightens while the control has focus. Required fields show a faint word after the label; nothing is starred.

Labels sit above the control by default. With Field::label_width they take a column of that width beside the control whenever the field is wide enough, and move above it again on narrow screens.

Style keys: field-label (fg, bold) with states focus and disabled; field-required, field-hint and field-error (fg). The required word is quvyta.form.required; the error marker is the error icon.

Implementations

impl<Msg: 'static> Field<Msg>

pub fn new(label: impl Into<String>) -> Self

A field labelled label. Add its control with View::add_with or FormFields::field.

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

Faint help under the control, shown while there is no error.

pub fn error<S: Into<String>>(self, error: Option<S>) -> Self

The error under the control; None shows the hint instead. Pass FormErrors::get straight in.

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

Shows the faint “required” word after the label.

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

Greys the label out; disable the control as well.

pub fn label_width(self, cells: u16) -> Self

Puts the label in a column cells wide beside the control when the field is at least that wide plus room for a control; otherwise the label stays above.

Trait Implementations

impl<Msg: 'static> Container<Msg> for Field<Msg>

fn set_children(&mut self, children: Vec<Node<Msg>>)

Receives the children built for this widget.

impl<Msg: 'static> Widget<Msg> for Field<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn event(&self, _cx: &mut EventCx<'_, Msg>, _event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.