Skip to main content

SidebarProps

Struct SidebarProps 

Source
pub struct SidebarProps {
    pub id: Option<Cow<'static, str>>,
    pub header: Option<Markup>,
    pub footer: Option<Markup>,
    pub default_open: bool,
    pub breakpoint_px: f64,
    pub class: Option<Cow<'static, str>>,
    pub attrs: AttrMap,
    pub children: Children,
}
Expand description

Sidebar — maps to CSS class .sidebar.

Renders a responsive <aside> that behaves as an in-flow column above the breakpoint_px viewport width and as an overlay drawer below it. The matching WASM controller (basecoat-controllers) reads/writes the expanded/collapsed state to localStorage under the key basecoat:sidebar:{id} and toggles the data-state attribute.

The id is required: it is the key used both for the localStorage entry and for matching the sibling toggle button’s aria-controls/ data-sidebar-toggle attribute.

Fields§

§id: Option<Cow<'static, str>>

Unique DOM id — required for the controller and localStorage key.

§header: Option<Markup>

Optional <header class="sidebar-header"> content rendered at the top.

§footer: Option<Markup>

Optional <footer class="sidebar-footer"> content rendered at the bottom.

§default_open: bool

Initial expanded state. Defaults to true. The controller reconciles this against localStorage on hydrate.

§breakpoint_px: f64

Viewport breakpoint in CSS pixels above which the sidebar is in-flow rather than an overlay drawer. Defaults to 768.0 (Tailwind md).

§class: Option<Cow<'static, str>>§attrs: AttrMap§children: Children

Implementations§

Source§

impl SidebarProps

Source

pub const __BASECOAT_EXTEND_FIELD: Option<&'static str>

Source

pub fn builder() -> SidebarPropsBuilder

Create a builder for this prop struct.

Trait Implementations§

Source§

impl Clone for SidebarProps

Source§

fn clone(&self) -> SidebarProps

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SidebarProps

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SidebarProps

Source§

fn default() -> SidebarProps

Returns the “default value” for a type. Read more
Source§

impl From<SidebarPropsBuilder> for SidebarProps

Source§

fn from(b: SidebarPropsBuilder) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.