Struct ChoiceField

Source

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

Expand description

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

Implementations§

Source §

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));

Source §

impl<F> ChoiceField<F>

Source

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.

Source §

impl<F> ChoiceField<F>

Source

pub fn options(self, options: impl IntoOptions) -> Self

Static options: values that are their own label (["draft", "published"]), (value, label) pairs, or a #[derive(Options)] enum’s options().

Source

pub fn multiple(self) -> Self

Takes several options: a checkbox per option, posting the field’s key once per checked box. A record form’s many-to-many field (Vec<K> with #[form(relationship = R)]) is one; parse_list reads one in an action’s input.

It offers at most MAX_RELATIONSHIP_OPTIONS records: past them it lists none but the chosen ones, and refuses a submission choosing another. A record form’s edit re-checks only the keys the record does not link yet. searchable filters the listed options as the user types. A condition cannot watch it, and it cannot depend on another field.

Source

pub fn searchable(self) -> Self

Filters options as the user types, fetching from the relationship past the option cap.

Source

pub fn relationship<R>(self) -> Self
where R: OptionSource + 'static,

Loads options from a related source’s tenant-scoped query, each valued by its primary key and labelled by the source’s label, degrading to type-to-search past the option cap.

A resource’s options carry its record_title, the title its detail page shows. relationship_labelled labels one field’s options otherwise.

Source

pub fn depends_on<M, T>( self, parent: &impl Watched<F>, column: impl Into<Path<M, T>>, ) -> Self
where M: Send + Sync + 'static, T: FormScalar + IntoExpr<T> + Send + Sync + 'static,

Offers only the related rows whose column column equals the value parent posts: the cities of the chosen country. The browser fetches the options again when parent changes, and a submission must name a row of the posted parent value. A blank parent offers none.

column belongs to the relationship’s source model; mounting refuses another model, a choice without a relationship, and a parent the schema does not place.

Source

pub fn relationship_labelled<R>( self, label: impl Fn(&R::Model) -> String + Send + Sync + 'static, ) -> Self
where R: OptionSource + 'static,

Loads options as relationship does, labelling each by label instead of the source’s label: to tell apart records that share a title. The option’s record loads without its relations.