Layoutduskmoonimplemented1 demos

ConsolePage

ConsolePage arranges an app bar, sidebar, workspace, and native mobile navigation in a responsive shell.

Import@duskmoon-dev/components/console-page
9API sections
16documented props
1behavior scenarios
Key API
sidebarStatesidebarModeappBarsidebarsidebarHeadersidebarFooter

Usage

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

StylesheetImport @duskmoon-dev/components/styles.css once in the app or docs shell.
StateStart with default props for static examples, then switch to controlled props when state must be shared.
ThemeThe preview inherits the active DuskMoon data-theme value from the docs layout.

Features

Composition primitive

Documents spacing, responsive behavior, and nested regions used to build larger screens.

Stable geometry

Examples keep predictable dimensions so the surrounding UI does not jump while content changes.

Primary API surface

ConsolePage is most often configured through `sidebarState`, `sidebarMode`, `appBar`, `sidebar`.

Covered behavior

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.

Preview
Operations
Workspace · expanded

Interactive usage

authored

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.

Types: packages/components/src/components/console-page/ConsolePage.types.tsScenarios: packages/components/src/components/console-page/ConsolePage.test.tsx
ConsolePagePropsinterface extends Omit<ComponentProps<"div">, "ref">
PropTypeRequiredDescription
sidebarStateConsolePageSidebarStateNosidebarState configures ConsolePage.
sidebarModeConsolePageSidebarStateNosidebarMode configures ConsolePage.
appBarReactNodeNoappBar configures ConsolePage.
sidebarReactNodeNosidebar configures ConsolePage.
sidebarHeaderReactNodeNosidebarHeader configures ConsolePage.
sidebarFooterReactNodeNosidebarFooter configures ConsolePage.
ConsolePageComponentinterface extends ForwardRefExoticComponent< ConsolePageProps & RefAttributes<HTMLDivElement> >
PropTypeRequiredDescription
FrameForwardRefExoticComponent<YesFrame configures ConsolePage.
AppbarForwardRefExoticComponent<YesAppbar configures ConsolePage.
SidebarForwardRefExoticComponent<YesSidebar configures ConsolePage.
SidebarHeaderForwardRefExoticComponent<YesSidebarHeader configures ConsolePage.
SidebarBodyForwardRefExoticComponent<YesSidebarBody configures ConsolePage.
SidebarFooterForwardRefExoticComponent<YesSidebarFooter configures ConsolePage.
MainForwardRefExoticComponent<YesMain configures ConsolePage.
SidebarToggleForwardRefExoticComponent<YesSidebarToggle configures ConsolePage.
MobileTriggerForwardRefExoticComponent<YesMobileTrigger configures ConsolePage.
MobileMenuForwardRefExoticComponent<YesMobileMenu configures ConsolePage.
ConsolePageSidebarModetype
Type definition
ConsolePageSidebarState
ConsolePageFramePropstype
Type definition
Omit<ComponentProps<"div">, "ref">
ConsolePageAppbarPropstype
Type definition
Omit<ComponentProps<"header">, "ref">
ConsolePageSidebarPropstype
Type definition
Omit<ComponentProps<"aside">, "ref">
ConsolePageSidebarBodyPropstype
Type definition
Omit<ComponentProps<"nav">, "ref">
ConsolePageMainPropstype
Type definition
Omit<ComponentProps<"main">, "ref">
ConsolePageButtonPropstype
Type definition
Omit<ComponentProps<"button">, "ref">