Struct TextColumn 

pub struct TextColumn<M, T> { /* private fields */ }

A column of one field, rendered as text and bound through a Lens for sorting and search.

tablo_core::TextColumn::new(tablo_core::lens!(User.name))
    .searchable()
    .sortable();
tablo_core::TextColumn::new(tablo_core::lens!(User.age))
    .sortable()
    .format(|age| format!("{age} years"));

The cell is the value’s FormScalar::to_label, an Options enum’s label or any other type’s form spelling, unless format says otherwise. Only a string field is searchable.

A column presents its value as a badge, in a color, with a muted description line under it, or as a right-aligned numeric or money amount:

use tablo_core::{Currency, TextColumn, lens};

TextColumn::new(lens!(Order.number)).description(|order: &Order| order.customer.clone());
TextColumn::new(lens!(Order.status)).badge();
TextColumn::new(lens!(Order.total_cents)).money(Currency::USD.minor_units());

Implementations

impl<M, T> TextColumn<M, T>

where M: Model,

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

where T: FormScalar + Send + Sync + 'static,

Bind a column to the field lens reads, which must be one field of the model.

pub fn format<L: Into<Text>>( self, format: impl Fn(&T) -> L + Send + Sync + 'static, ) -> Self

Render the field’s value through format: a String, or a Text the request’s locale spells.

pub fn badge(self) -> Self

Show the value as a badge, with a dot in its color: an Options enum’s #[option(color = "…")], or the color declared here.

pub fn color( self, color: impl Fn(&T) -> Option<Color> + Send + Sync + 'static, ) -> Self

Color the value: its badge’s dot, or its text when it is no badge.

pub fn description( self, description: impl Fn(&M) -> String + Send + Sync + 'static, ) -> Self

Show description(row) as a muted line under the value, such as a customer’s email under their name. Search, sort and export read the value alone.

The description may read any field, so a resource that restricts a field refuses the column until reading declares the ones it reads.

pub fn reading(self, reads: Reads<M>) -> Self

Declare the fields the description reads, beside the column’s own.

pub fn align(self, alignment: Alignment) -> Self

Align the header and the cells.

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.

impl<M, T> TextColumn<M, T>

where M: Model, T: Numeric + 'static,

pub fn numeric(self, decimals: u8) -> Self

Spell the value as a number with decimals digits after the point and its thousands grouped, 12,345.60, aligned to the end with equal-width digits.

pub fn money(self, currency: Currency) -> Self

Spell the value as an amount of currency, $1,234.50, aligned to the end with equal-width digits.

impl<M, T> TextColumn<M, T>

where M: Model + Send + Sync + 'static, T: Field<Inner = String> + Send + Sync + 'static,

pub fn searchable(self) -> Self

Join the table’s search with a substring match on this string field.

Trait Implementations

impl<M, T> Clone for TextColumn<M, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M, T> Column<M> for TextColumn<M, T>

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

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

A portable, escaped substring match.

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 alignment(&self) -> Alignment

Where the header and the cells align their content.

fn is_searchable(&self) -> bool

Whether the column joins the table’s search.

fn is_sortable(&self) -> bool

Whether the header links to a sort on this column.

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

The ordering a sort on this column applies.

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 includes(&self) -> Includes<M>

The relations text, cell and entry read.

impl<M, T> Debug for TextColumn<M, T>

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

Formats the value using the given formatter.

impl<M, T> IntoColumns<M> for TextColumn<M, T>

where Self: Column<M> + 'static,

impl<M, T> IntoDetail<M> for TextColumn<M, T>

where Self: Column<M> + 'static,

fn into_detail(self) -> Detail<M>