ConsolePage
ConsolePage arranges an app bar, sidebar, workspace, and native mobile navigation in a responsive shell.
@duskmoon-dev/components/console-pageUsage
When to use
- Use it to build predictable page, toolbar, panel, or grid structure.
- Keep layout primitives responsible for geometry and let child components own behavior.
Implementation notes
Features
Documents spacing, responsive behavior, and nested regions used to build larger screens.
Examples keep predictable dimensions so the surrounding UI does not jump while content changes.
ConsolePage is most often configured through `sidebarState`, `sidebarMode`, `appBar`, `sidebar`.
Maps explicit sidebar state and native mobile navigation
Feature Demos
Feature demos are authored for the component page, then supplemented with behavior scenarios from the component test coverage.
Interactive usage
Cycle three sidebar states and open the native mobile navigation on narrow screens.
Source
import { useState } from "react";
import "@duskmoon-dev/components/styles.css";
import { ConsolePage } from "@duskmoon-dev/components/console-page";
export function ConsolePageDemo() {
const [state, setState] = useState<"expanded" | "compact" | "hidden">("expanded");
const next = { expanded: "compact", compact: "hidden", hidden: "expanded" } as const;
return <ConsolePage sidebarState={state}>
<ConsolePage.Frame>
<ConsolePage.Appbar>
<ConsolePage.SidebarToggle onClick={() => setState(next[state])}>☰</ConsolePage.SidebarToggle>
<ConsolePage.MobileTrigger aria-label="Open navigation">☰</ConsolePage.MobileTrigger>
<ConsolePage.MobileMenu aria-label="Mobile navigation">
<a className="menu-item" href="#overview">Overview</a>
</ConsolePage.MobileMenu>
<strong>Operations</strong>
</ConsolePage.Appbar>
<ConsolePage.Sidebar><ConsolePage.SidebarBody aria-label="Sections">
<a className="drawer-item" href="#overview">Overview</a>
</ConsolePage.SidebarBody></ConsolePage.Sidebar>
<ConsolePage.Main id="overview">Workspace · {state}</ConsolePage.Main>
</ConsolePage.Frame>
</ConsolePage>;
}API
The API reference below lists every parsed exported type or interface for ConsolePage. Start with `sidebarState`, `sidebarMode`, `appBar`, `sidebar` for common usage.
packages/components/src/components/console-page/ConsolePage.types.tsScenarios: packages/components/src/components/console-page/ConsolePage.test.tsx| Prop | Type | Required | Description |
|---|---|---|---|
sidebarState | ConsolePageSidebarState | No | sidebarState configures ConsolePage. |
sidebarMode | ConsolePageSidebarState | No | sidebarMode configures ConsolePage. |
appBar | ReactNode | No | appBar configures ConsolePage. |
sidebar | ReactNode | No | sidebar configures ConsolePage. |
sidebarHeader | ReactNode | No | sidebarHeader configures ConsolePage. |
sidebarFooter | ReactNode | No | sidebarFooter configures ConsolePage. |
| Prop | Type | Required | Description |
|---|---|---|---|
Frame | ForwardRefExoticComponent< | Yes | Frame configures ConsolePage. |
Appbar | ForwardRefExoticComponent< | Yes | Appbar configures ConsolePage. |
Sidebar | ForwardRefExoticComponent< | Yes | Sidebar configures ConsolePage. |
SidebarHeader | ForwardRefExoticComponent< | Yes | SidebarHeader configures ConsolePage. |
SidebarBody | ForwardRefExoticComponent< | Yes | SidebarBody configures ConsolePage. |
SidebarFooter | ForwardRefExoticComponent< | Yes | SidebarFooter configures ConsolePage. |
Main | ForwardRefExoticComponent< | Yes | Main configures ConsolePage. |
SidebarToggle | ForwardRefExoticComponent< | Yes | SidebarToggle configures ConsolePage. |
MobileTrigger | ForwardRefExoticComponent< | Yes | MobileTrigger configures ConsolePage. |
MobileMenu | ForwardRefExoticComponent< | Yes | MobileMenu configures ConsolePage. |
Type definition
ConsolePageSidebarStateType definition
Omit<ComponentProps<"div">, "ref">Type definition
Omit<ComponentProps<"header">, "ref">Type definition
Omit<ComponentProps<"aside">, "ref">Type definition
Omit<ComponentProps<"nav">, "ref">Type definition
Omit<ComponentProps<"main">, "ref">Type definition
Omit<ComponentProps<"button">, "ref">