Struct PageDef 

pub struct PageDef { /* private fields */ }

What a Page declares: its slug, sidebar entry, access and header actions.

Page::declare returns one, and Panel::page_with adjusts it for one panel. Every setting has a default, so a page sets only what differs:

struct MediaLibraryPage;

impl Page for MediaLibraryPage {
    fn declare() -> PageDef {
        PageDef::new().slug("media").icon(tablo_ui::icons::IMAGE)
    }

    async fn render(_cx: &Cx) -> Result<impl View> {
        Ok(())
    }
}

The panel builds the def once when it mounts and serves the result to every request.

Implementations

impl PageDef

pub fn new() -> Self

A def with every default: the slug and label from the page’s type name, and access for every signed-in user.

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

The URL segment under the panel prefix: "media" mounts the page at {panel prefix}/media.

Defaults to the page type’s name without a trailing Page, kebab-cased: MediaLibraryPage → media-library. Panel::home mounts the page at the prefix and does not read it.

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

The sidebar label.

Defaults to the message page-{name} of the panel’s catalogs, else the page type’s name without a trailing Page, in sentence case: MediaLibraryPage reads page-media-library, else Media library.

pub fn icon(self, icon: IconData) -> Self

The icon of the page’s sidebar entry, replacing the icon of a navigation item.

pub fn navigation_order(self, order: i32) -> Self

Where the sidebar entry sorts among the panel’s entries, lowest first; defaults to 0, and entries of equal order keep their registration order. It replaces the order of a navigation item.

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

The labelled sidebar group the entry renders in, such as "Reports"; defaults to none, above every group. It replaces the group of a navigation item.

pub fn navigation(self, item: NavigationItem) -> Self

Replaces the sidebar entry, for one that links somewhere other than the page: NavigationItem::at("Exports", "/admin/reports?tab=exports"). icon, navigation_order and navigation_group still apply to it.

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

Whether the request’s user may open the page. The panel answers 403 and leaves the page out of the sidebar when it answers false. Defaults to every signed-in user.

struct BillingPage;

impl Page for BillingPage {
    fn declare() -> PageDef {
        PageDef::new().access(|cx| auth::user::<Staff>(cx).is_some_and(|staff| staff.admin))
    }

    async fn render(cx: &Cx) -> Result<impl View> {
        Ok(view! { cx => tablo_ui::page(tablo_ui::page_title("Billing")) })
    }
}

pub fn header_action<A: HeaderAction>(self) -> Self

Adds the HeaderAction A after the ones already declared, served at {url}/-/actions/{NAME}. header_action_buttons renders their buttons where render places it. An A::NAME that is not a single URL path segment does not compile.

The actions run for whoever may open the page: a page has no policy. An action that writes a resource’s records asks that resource’s policy in its own can_run.

Trait Implementations

impl Debug for PageDef

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

Formats the value using the given formatter.

impl Default for PageDef

fn default() -> Self

Returns the “default value” for a type.