Struct WidgetDef 

pub struct WidgetDef { /* private fields */ }

What a Widget declares: how many columns of the grid it spans, and who sees it.

Implementations

impl WidgetDef

pub fn new() -> Self

A def with every default: one column, for every user who may open the page.

pub fn name(self, name: &'static str) -> Self

The widget’s name, its data-widget hook and its key on the page; defaults to its type’s name in kebab case, without Widget and generic arguments: RecentOrdersWidget → recent-orders, Count<Book> → count. Each widget of a page needs a distinct name, so a generic widget mounted twice names each mount.

pub fn span(self, columns: u8) -> Self

Spans columns columns of the grid, at most as many as it has, and at least one. On a narrow screen the grid stacks every widget in one column.

pub fn full_width(self) -> Self

Spans every column of the grid.

pub fn access( self, access: impl Fn(&Cx) -> bool + Send + Sync + 'static, ) -> Self

Whether the request’s user may see the widget. The grid leaves out a widget it refuses and never renders it. Defaults to every user who may open the page.

Trait Implementations

impl Debug for WidgetDef

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

Formats the value using the given formatter.

impl Default for WidgetDef

fn default() -> Self

Returns the “default value” for a type.