Skip to main content

SidebarProps

Struct SidebarProps 

Source
pub struct SidebarProps<'__a> {
    pub open: Expr<bool>,
    pub mobile_open: Expr<bool>,
    pub side: SidebarSide,
    pub variant: SidebarVariant,
    pub collapsible: SidebarCollapsible,
    pub attrs: Attributes,
    pub sheet_attrs: Attributes,
    pub child: Child<'__a>,
}
Expand description

A desktop panel that becomes a sheet over the page below md (48rem).

The --sidebar-* theme tokens control its colors independently of cards, sheets and page content. Nested controls inherit the sidebar palette.

open controls desktop expansion. mobile_open independently controls the mobile sheet, so it can start closed while desktop starts expanded. Pass runtime expressions reading the caller’s signals to make both live. Header, content and footer children are rendered once and shared between viewport sizes, preserving their inputs and signal identities.

attrs apply to the outer wrapper. sheet_attrs apply to the sheet and accept a label, an ID, and event handlers for Escape or backdrop dismissal. Include a close button in the mobile header. Like sheet, this is a visual overlay; focus trapping requires additional application scripting.

Fields§

§open: Expr<bool>§mobile_open: Expr<bool>§side: SidebarSide§variant: SidebarVariant§collapsible: SidebarCollapsible§attrs: Attributes§sheet_attrs: Attributes§child: Child<'__a>

Implementations§

Source§

impl<'__a> SidebarProps<'__a>

Source

pub fn builder() -> SidebarPropsBuilder<'__a>

Returns a SidebarPropsBuilder with no properties set.

Trait Implementations§

Source§

impl<'__a> Props for SidebarProps<'__a>

Source§

type Builder = SidebarPropsBuilder<'__a>

The builder type in its initial state, with no properties set.
Source§

fn builder() -> Self::Builder

Returns a builder with no properties set.

Auto Trait Implementations§

§

impl<'__a> !RefUnwindSafe for SidebarProps<'__a>

§

impl<'__a> !Sync for SidebarProps<'__a>

§

impl<'__a> !UnwindSafe for SidebarProps<'__a>

§

impl<'__a> Freeze for SidebarProps<'__a>

§

impl<'__a> Send for SidebarProps<'__a>

§

impl<'__a> Unpin for SidebarProps<'__a>

§

impl<'__a> UnsafeUnpin for SidebarProps<'__a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more