Sidebar

Material Design 3-styled sidebar layout web component (lit-material-sidebar) — a two-pane layout that stacks responsively via a container query.

  • 956 B gzipped
  • @lit-material/sidebar 0.0.3
  • Renders on the server

Example

Install

npm install @lit-material/sidebar @lit-material/tokens
import "@lit-material/sidebar";

Link @lit-material/tokens/css/index.css once per page for the colour, type and shape tokens. Install guide

API

<lit-material-sidebar>

A two-pane layout — a fixed-width side panel next to flexible main content — for things like a filter panel beside a list, distinct from lit-material-navigation's drawer/rail (which are app-level navigation chrome, not a general content layout). Stacks to a single column via a @container query on its own size rather than a @media viewport query, so it collapses correctly regardless of where it's nested — a sidebar embedded in a narrow column of an otherwise-wide page still stacks.

Properties

PropertyAttributeTypeDefaultDescription
positionpositionSidebarPosition"start"Which side the panel sits on (before stacking).
panelWidthpanel-widthstring"20rem"The panel's width above the stacking breakpoint. Any valid CSS length.

Slots

SlotDescription
panelThe narrower side content.
defaultThe main content.

CSS parts

PartDescription
panelThe side panel's container.
contentThe main content's container.

Source on GitHub npm