layouts/sidebar
The default layout: the classic drawer on the left edge, opened by the
handle there or by Ctrl+Shift+M. Its header carries the wordmark, the
theme pill, the layout toggle, fullscreen, and gaming mode; a row of tiles
toggles the streams; a touch client gets the soft keys under them; every
panel is a section below, each folding on its own. The sections hold the
same panels the toolbar carries, drawn in this layout's own skin
(sidebar.css), and the stats section's switch lays the strip over the
stream. Entering fullscreen or gaming mode folds the drawer, and the
handle goes with gaming mode, so the session has the pointer.
Reads toggleDashboard (Ctrl+Shift+M) from the core and posts
sidebarVisibilityChanged as the drawer opens and closes; the panels
speak to the core themselves.
Functions
Tile()
function Tile(__namedParameters): Element;Defined in: layouts/sidebar.tsx:44
One stream toggle tile.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { active: boolean; label: string; className?: string; onClick: () => void; children: ReactNode; } |
__namedParameters.active | boolean |
__namedParameters.label | string |
__namedParameters.className? | string |
__namedParameters.onClick | () => void |
__namedParameters.children | ReactNode |
Returns
Element
HeaderButton()
function HeaderButton(__namedParameters): Element;Defined in: layouts/sidebar.tsx:53
One of the header's buttons, beside the theme and layout toggles.
Parameters
Returns
Element
Section()
function Section(__namedParameters): Element;Defined in: layouts/sidebar.tsx:72
One folding section of the drawer: a header button and, while open, its body.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | SectionProps |
Returns
Element
SidebarLayout()
function SidebarLayout(): Element;Defined in: layouts/sidebar.tsx:85
The drawer, its handle, and the sections.
Returns
Element
References
SidebarLayout
Re-exports SidebarLayout