Struct FormField 

pub struct FormField { /* private fields */ }

A labelled control, with the secondary text a typist needs around it.

The description and the error are both shown. An error is information the description did not already carry — what went wrong this time, on top of what the field is for — so it is added rather than substituted. The one exception is an error worded exactly like the description, which would otherwise be printed twice; then only the error is drawn, because it is the one that also carries the failure.

Implementations

impl FormField

pub fn new(ident: impl Into<Ident>, label: impl Into<SharedString>) -> Self

pub fn control(self, control: impl Into<SharedString>) -> Self

The semantic id of the control this label names.

The label publishes the association, so a test that knows only what a field is called can find the control it belongs to.

pub fn description(self, description: impl Into<SharedString>) -> Self

What the field is for, shown whether or not anything went wrong.

pub fn error(self, error: impl Into<SharedString>) -> Self

What the host says is wrong, in the host’s own words.

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

The keystroke that operates the control without the pointer.

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

pub fn is_invalid(&self) -> bool

Trait Implementations

impl Debug for FormField

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

Formats the value using the given formatter.

impl IntoElement for FormField

type Element = ViewElement<FormField>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl ParentElement for FormField

fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>)

Extend this element’s children with the given child elements.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Add a single child element to this element.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Add multiple child elements to this element.

impl RenderOnce for FormField

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.