Struct SidebarShell 

pub(crate) struct SidebarShell {
    pub(crate) _marker: PhantomData<()>,
    pub(crate) function_component: FunctionComponent<Self>,
}

A shell component that provides a consistent layout with a sidebar and a main content area.

This component is designed to wrap page-specific content, ensuring that the sidebar is always present for navigation. Integrates with crate::pages::sidebar::Sidebar for navigation.

Mobile Support

On mobile displays, the sidebar is hidden by default and can be toggled:

• Menu Toggle Button: Renders a floating menu button to slide the sidebar open.
• Dark Mode Toggle: Floating button to change theme.
• Overlay Backdrop: Dims the screen when the sidebar is open. Clicking it closes the sidebar.
• Auto-Close on Navigation: Automatically closes the sidebar when navigating to a new route.

Components

• crate::pages::sidebar::Sidebar: The navigation sidebar component, accepting mobile open state.
• Main content area: Renders the children passed to this component.

Example

html! {
    <SidebarShell>
        <p>{"Your page content goes here."}</p>
    </SidebarShell>
}

Fields

_marker: PhantomData<()>

function_component: FunctionComponent<Self>

Trait Implementations

impl BaseComponent for SidebarShell

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = SidebarShellProps

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl Debug for SidebarShell

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

Formats the value using the given formatter.

impl FunctionProvider for SidebarShell

type Properties = SidebarShellProps

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.