Struct AdminSidebarWidget 

pub struct AdminSidebarWidget {
    pub template: String,
    pub data: HashMap<String, Value>,
}

Provides a way to add widgets to the sidebar by loading a template and populating it with the provided data.

For more-interactive widgets see the AdminSidebarWidget::htmx constructor which allows you to include a widget from any HTML-serving URL using htmx.

Fields

template: String

data: HashMap<String, Value>

Implementations

impl AdminSidebarWidget

pub fn htmx(url: impl ToString) -> Self

Examples found in repository

examples/full-admin.rs (line 80)

    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
        let admin: &mut AdminState<_> = state.provide_mut();

        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
        admin.add_auth_provider(TestAuthProvider);
        admin.add_login_provider(TestLoginProvider);

        admin.add_navigation(
            AdminNavigationGroup::new("Example").add(
                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
            ),
        );

        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible

        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));

        admin.register_entity_handler(EntityHandler::<
            S,
            TestEntityCreateForm,
            TestEntityUpdateForm,
            TestEntityListing,
        >::new("Example"));

        Ok(())
    }

pub fn new(template: impl ToString) -> Self

pub fn data<S: Serialize>(self, name: impl ToString, value: S) -> Self

pub fn hx_trigger(self, trigger: impl ToString) -> Self

Trait Implementations

impl Clone for AdminSidebarWidget

fn clone(&self) -> AdminSidebarWidget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdminSidebarWidget

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

Formats the value using the given formatter.

impl Default for AdminSidebarWidget

fn default() -> AdminSidebarWidget

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AdminSidebarWidget

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AdminSidebarWidget

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.