@mithrl/design-system 0.1.0 → 0.2.0

package/dist/patterns/workspace-app-shell/WorkspaceAppShell.d.ts

@@ -0,0 +1,105 @@
+import { type HTMLAttributes, type ReactNode } from "react";
+import { type GlobalAppBarProjectSelector, type GlobalAppBarProps } from "../../components/global-app-bar/GlobalAppBar";
+import { type ResizablePanelGroupProps, type ResizablePanelMinimum } from "../../components/resizable-panels/ResizablePanels";
+import { type WorkspaceNavigationProps } from "../../components/workspace-navigation/WorkspaceNavigation";
+import type { ThemeMode } from "../../components/switch/Switch";
+
+export type WorkspaceAppShellLayout = "expanded" | "condensed" | "single";
+type NativeWorkspaceAppShellProps = Omit<HTMLAttributes<HTMLDivElement>, "children">;
+type WorkspaceAppBarConfiguration = Omit<GlobalAppBarProps, "defaultTheme" | "onThemeChange" | "theme" | "workspaceControls">;
+type WorkspaceNavigationConfiguration = Omit<WorkspaceNavigationProps, "presentation">;
+type WorkspaceProjectSelectorConfiguration = Omit<GlobalAppBarProjectSelector, "presentation">;
+export type WorkspaceAppShellProps = NativeWorkspaceAppShellProps & {
+    /** Global App Bar account, brand, and native attributes. */
+    appBar: WorkspaceAppBarConfiguration;
+    /** Project context rendered by the approved Global App Bar selector. */
+    projectSelector: WorkspaceProjectSelectorConfiguration;
+    /** Workspace Navigation content; App Shell selects Inline or Overlay. */
+    navigation: WorkspaceNavigationConfiguration;
+    /** Product-owned Primary Panel content. */
+    primary: ReactNode;
+    /** Product-owned Secondary Panel content. */
+    secondary: ReactNode;
+    /** Controlled active theme for the entire shell. */
+    theme?: ThemeMode;
+    /** Initial active theme for uncontrolled use. */
+    defaultTheme?: ThemeMode;
+    /** Reports a theme request from the Global App Bar. */
+    onThemeChange?: (theme: ThemeMode) => void;
+    /** Controlled Navigation visibility. */
+    navigationOpen?: boolean;
+    /** Initial Navigation visibility. Defaults to open. */
+    defaultNavigationOpen?: boolean;
+    /** Reports explicit Navigation toggle or compact-overlay dismissal. */
+    onNavigationOpenChange?: (open: boolean) => void;
+    /** Controlled Secondary Panel visibility. */
+    secondaryOpen?: boolean;
+    /** Initial Secondary visibility. Defaults to collapsed. */
+    defaultSecondaryOpen?: boolean;
+    /** Reports explicit Secondary toggle requests. */
+    onSecondaryOpenChange?: (open: boolean) => void;
+    /** Controlled Primary share for the persistent desktop split. */
+    split?: number;
+    /** Initial Primary share. Defaults to the approved 60%. */
+    defaultSplit?: number;
+    /** Reports every pointer or keyboard resize. */
+    onSplitChange?: ResizablePanelGroupProps["onValueChange"];
+    /** Reports the final pointer value or each committed keyboard step. */
+    onSplitCommit?: ResizablePanelGroupProps["onValueCommit"];
+    /** Primary minimum-size policy. Defaults to Standard. */
+    primaryMinSize?: ResizablePanelMinimum;
+    /** Secondary minimum in pixels. Defaults to 280px. */
+    secondaryMinSize?: number;
+    /** Accessible splitter label when the Primary region has no visible label. */
+    resizeLabel?: string;
+};
+/**
+ * Complete Workspace layout pattern. It composes the approved Global App Bar,
+ * Workspace Navigation, and Resizable Panels contracts while product code
+ * retains routing, content, data fetching, and persistence ownership.
+ */
+export declare const WorkspaceAppShell: import("react").ForwardRefExoticComponent<NativeWorkspaceAppShellProps & {
+    /** Global App Bar account, brand, and native attributes. */
+    appBar: WorkspaceAppBarConfiguration;
+    /** Project context rendered by the approved Global App Bar selector. */
+    projectSelector: WorkspaceProjectSelectorConfiguration;
+    /** Workspace Navigation content; App Shell selects Inline or Overlay. */
+    navigation: WorkspaceNavigationConfiguration;
+    /** Product-owned Primary Panel content. */
+    primary: ReactNode;
+    /** Product-owned Secondary Panel content. */
+    secondary: ReactNode;
+    /** Controlled active theme for the entire shell. */
+    theme?: ThemeMode;
+    /** Initial active theme for uncontrolled use. */
+    defaultTheme?: ThemeMode;
+    /** Reports a theme request from the Global App Bar. */
+    onThemeChange?: (theme: ThemeMode) => void;
+    /** Controlled Navigation visibility. */
+    navigationOpen?: boolean;
+    /** Initial Navigation visibility. Defaults to open. */
+    defaultNavigationOpen?: boolean;
+    /** Reports explicit Navigation toggle or compact-overlay dismissal. */
+    onNavigationOpenChange?: (open: boolean) => void;
+    /** Controlled Secondary Panel visibility. */
+    secondaryOpen?: boolean;
+    /** Initial Secondary visibility. Defaults to collapsed. */
+    defaultSecondaryOpen?: boolean;
+    /** Reports explicit Secondary toggle requests. */
+    onSecondaryOpenChange?: (open: boolean) => void;
+    /** Controlled Primary share for the persistent desktop split. */
+    split?: number;
+    /** Initial Primary share. Defaults to the approved 60%. */
+    defaultSplit?: number;
+    /** Reports every pointer or keyboard resize. */
+    onSplitChange?: ResizablePanelGroupProps["onValueChange"];
+    /** Reports the final pointer value or each committed keyboard step. */
+    onSplitCommit?: ResizablePanelGroupProps["onValueCommit"];
+    /** Primary minimum-size policy. Defaults to Standard. */
+    primaryMinSize?: ResizablePanelMinimum;
+    /** Secondary minimum in pixels. Defaults to 280px. */
+    secondaryMinSize?: number;
+    /** Accessible splitter label when the Primary region has no visible label. */
+    resizeLabel?: string;
+} & import("react").RefAttributes<HTMLDivElement>>;
+export {};