Struct FormField 

pub struct FormField<V> { /* private fields */ }

A labeled form field with a hint and validation messages.

Errors appear once the value is non-empty or the form was submitted (see FormField::show_errors), so empty forms do not start out red.

use ravenrs_reactive::State;
use ravenrs_widgets::{FormField, TextField, Ui, validate};

let email = State::new("raven@".to_string());
let field = FormField::new("Email", TextField::new(email.binding()))
    .hint("We never share it.")
    .validate(email.binding(), validate::email);
assert!(field.error().is_some());

email.set("raven@example.com".into());
assert_eq!(field.error(), None);

let mut ui = Ui::new(field, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations

impl<V> FormField<V>

where V: View,

pub fn new(label: impl Into<String>, content: V) -> FormField<V>

A field with this label above content.

pub fn accessible_name(self, name: impl Into<String>) -> FormField<V>

What screen readers call the control, instead of the label: for a label that only makes sense next to what is around it.

pub fn accessible_description(self, text: impl Into<String>) -> FormField<V>

What screen readers say after its name, instead of the hint. An error or a note still comes first.

pub fn required(self) -> FormField<V>

Marks the label with * and adds the validate::required rule (for the value set by FormField::validate).

pub fn error_text(self, error: Option<String>) -> FormField<V>

What is wrong, as something else found out, such as rules that read a database.

pub fn label_ink(self, ink: Semantic) -> FormField<V>

The color of its label, instead of the usual one.

pub fn tint(self, fill: Semantic) -> FormField<V>

A faint color behind the field, to call attention to it.

pub fn note_text(self, note: Option<String>, tone: Tone) -> FormField<V>

Something to know under the content, with an icon, which is not an error. An error replaces it.

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

A muted caption under the content.

pub fn validate( self, value: Binding<String>, rule: impl Fn(&str) -> Result<(), String> + 'static, ) -> FormField<V>

Validates value with rule (rules run in order; the first error shows).

pub fn show_errors(self, show: bool) -> FormField<V>

Shows errors even for empty values (e.g. after a submit attempt).

pub fn error(&self) -> Option<String>

The first error for the current value, if any.

Trait Implementations

impl<V> Debug for FormField<V>

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

Formats the value using the given formatter.

impl<V> View for FormField<V>

where V: View,

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.