Struct ToggleColumn 

pub struct ToggleColumn<M> { /* private fields */ }

A column of a bool field rendered as a switch that saves the record when it flips.

tablo_core::ToggleColumn::new(tablo_core::lens!(Post.featured));

See Editing in a cell for where the switch renders and what it posts.

Editing in a cell

A list, a relation table or a widget’s record table renders the control on a row whose record the user may update and that is not in the trash, for a field the user may change; anywhere else, and on a detail page, the cell shows the value. The control posts its field alone to the record’s edit route, with the record’s version, so the save runs every check the edit page’s does and lands back on the table. A refused value opens the edit page with its errors.

The mount refuses the column unless the resource’s form edits the field with the matching control, a checkbox or switch here, shown and enabled whatever the other fields hold. Flipping the switch and changing a select save through the runtime’s one line of script; a text input saves on Enter.

The control spells the value as the field’s form spelling, as a derived record form does, so a hand-written RecordForm must read the key as that spelling.

Implementations

impl<M> ToggleColumn<M>

where M: Model,

pub fn new(lens: Lens<M, bool>) -> Self

Bind the column to the bool field lens reads.

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

Replace the label the field’s name gives it.

pub fn width(self, width: ColumnWidth) -> Self

Declare this column’s width.

pub fn toggleable(self) -> Self

Let each reader hide this column from their list; it starts shown.

pub fn hidden_by_default(self) -> Self

Let each reader show this column in their list; it starts hidden.

pub fn sortable(self) -> Self

Make the header a sort link.

Trait Implementations

impl<M> Clone for ToggleColumn<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M> Column<M> for ToggleColumn<M>

where M: Model + Send + Sync + 'static,

fn name(&self) -> &str

The column’s identifier, distinct within its table.

fn label(&self) -> Text

The header text.

fn column_width(&self) -> ColumnWidth

The width the column claims.

fn toggle(&self) -> ColumnToggle

Whether each reader may hide or show the column in their list, and how it starts. A detail page shows every column.

fn reads(&self) -> Option<Reads<M>>

The fields of the row text, cell, entry, search_expr and order_by read, or None when the column does not say.

fn text(&self, cx: &Cx, row: &M) -> String

The row’s value as plain text.

fn cell<'a>(&self, cx: &'a Cx, row: &M) -> BoxView<'a>

The row’s table cell.

fn order_by(&self, descending: bool) -> Option<OrderByExpr>

The ordering a sort on this column applies, or None when the header does not link to a sort on it. A sortable column answers Some either way.

fn entry<'a>(&self, cx: &'a Cx, row: &M) -> BoxView<'a>

The record’s entry on a detail page: the label over the cell.

fn alignment(&self) -> Alignment

Where the header and the cells align their content.

fn search_expr(&self, _term: &str) -> Option<Expr<bool>>

The predicate a search for term adds, or None when the column does not join the table’s search. A column that joins it answers Some for every non-empty, trimmed term.

fn includes(&self) -> Includes<M>

The relations text, cell and entry read.

impl<M> Debug for ToggleColumn<M>

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

Formats the value using the given formatter.

impl<M> IntoColumns<M> for ToggleColumn<M>

where Self: Column<M> + 'static,

impl<M> IntoDetail<M> for ToggleColumn<M>

where Self: Column<M> + 'static,

fn into_detail(self) -> Detail<M>