Struct TextField 

pub struct TextField<F = ()>(/* private fields */);

A text field: Field::text, or a record form’s text control (F is the form).

Implementations

impl<F> TextField<F>

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

pub fn name(&self) -> &str

pub fn visible_when( self, watched: &impl Watched<F>, values: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Shows the field only while watched posts one of values: an option’s value, or true for a checked toggle. A hidden field posts nothing, so an edit keeps its stored value and a create takes its blank answer; a field with no blank answer cannot be conditional.

let kind = Field::choice(Customer::fields().kind()).options(["person", "company"]);
let vat = Field::text(Customer::fields().vat_number()).visible_when(&kind, ["company"]);
Schema::new((kind, vat));

impl<F> TextField<F>

pub fn custom(self, control: impl Control + 'static) -> CustomField<F>

Renders the field with an app’s Control instead, as Field::custom does: how a record form’s control takes a custom input. The field keeps its key and label; the replaced control’s own modifiers, such as email, unique or options, are dropped with it.

impl<F> TextField<F>

pub fn choice(self) -> ChoiceField<F>

Renders the field as a choice instead, as Field::choice does, ready for options or relationship. Unlike #[form(relationship = ..)], it leaves the record form’s derived table and detail page as they are. The replaced control’s own modifiers are dropped with it.

impl<F> TextField<F>

pub fn email(self) -> Self

Validate the value as an email address, and render type="email".

pub fn password(self) -> Self

Render type="password": the browser masks the value, and a refused form renders the control empty rather than echoing the password back into the page.

pub fn unique(self) -> Self

Probes a unique index before the write.

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

The control’s placeholder text.

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

Render a <textarea> of rows lines rather than a one-line input, for a column holding prose.

Trait Implementations

impl<F> From<TextField<F>> for Field

fn from(builder: TextField<F>) -> Field

Converts to this type from the input type.

impl<F> IntoSchema<F> for TextField<F>

fn into_schema(self) -> Schema<F>

impl<F> Watched<F> for TextField<F>