nfx-ui 0.1.0

package/dist/layouts.d.ts

@@ -0,0 +1,209 @@
+import { Context } from 'react';
+import { JSX } from 'react/jsx-runtime';
+import { MemoExoticComponent } from 'react';
+import { ReactNode } from 'react';
+import { SidebarProps as SidebarProps_2 } from 'react-pro-sidebar';
+
+/** 与 NFX-Identity/console 一致：仪表盘背景由用户偏好（可外部传入或从 profile 解析） */
+export declare const Background: MemoExoticComponent<({ children, background }: BackgroundProps) => JSX.Element>;
+
+declare interface BackgroundProps {
+    children: ReactNode;
+    /** 可选：外部传入的偏好，有则优先使用；否则从 profile.preference 解析。Optional: preference from parent; otherwise parsed from profile. */
+    background?: DashboardBackgroundEnum | null;
+}
+
+/** 仪表盘背景枚举。Dashboard background enum. */
+declare enum DashboardBackgroundEnum {
+    NONE = "none",
+    WAVES = "waves",
+    SQUARES = "squares",
+    LETTER_GLITCH = "letterGlitch",
+    PIXEL_BLAST = "pixelBlast"
+}
+
+export declare const DEFAULT_LAYOUT_MODE = LayoutModeEnum.SHOW;
+
+/** 通用 Footer：只负责布局与样式，内容由外部传入。 */
+export declare const Footer: MemoExoticComponent<({ children, className }: FooterProps) => JSX.Element>;
+
+/** Footer props. */
+export declare interface FooterProps {
+    /** 页脚内容由使用方传入。Footer content passed from parent. */
+    children?: ReactNode;
+    className?: string;
+}
+
+export declare function getLayoutStorage(): Nilable<string>;
+
+/** 通用 Header：只负责布局左右两栏，内容全部由外部传入，内部不获取数据。Generic header: layout only; all content from props. */
+export declare const Header: MemoExoticComponent<({ leftContent, rightContent }: HeaderProps) => JSX.Element>;
+
+/** Header props. */
+export declare interface HeaderProps {
+    /** 左侧内容（如 Logo、SlideDownSwitcher 等），由使用方传入。Left slot; passed from parent. */
+    leftContent?: ReactNode;
+    /** 右侧内容（如语言切换、用户菜单等），由使用方传入。Right slot; passed from parent. */
+    rightContent?: ReactNode;
+}
+
+export declare const LAYOUT_MODE_VALUES: LayoutModeEnum[];
+
+export declare const LAYOUT_STORAGE_KEY = "layout-storage";
+
+export declare const LayoutContext: Context<LayoutContextType | undefined>;
+
+/** useLayout 返回值类型。Return type of useLayout. */
+export declare interface LayoutContextType {
+    /** 侧栏是否展开。Whether sidebar is open. */
+    sidebarOpen: boolean;
+    /** 当前布局模式（显示/隐藏）。Current layout mode (show/hide). */
+    layoutMode: LayoutModeEnum;
+    setSidebarOpen: (open: boolean) => void;
+    toggleSidebar: () => void;
+    closeSidebar: () => void;
+    setLayoutMode: (mode: LayoutModeEnum) => void;
+}
+
+export declare const LayoutFrame: MemoExoticComponent<({ children, headerLeft, headerRight, footerContent, sidebarItems, sidebarCurrentPathname, onSidebarNavigate, sidebarLogoutLabel, onSidebarLogout, bottomLogoutButton, }: LayoutFrameProps) => JSX.Element>;
+
+/** LayoutFrame props. */
+export declare interface LayoutFrameProps {
+    children: ReactNode;
+    /** 可选：Header 左侧内容（如 Logo、SlideDownSwitcher），使用方传入。Optional: header left slot. */
+    headerLeft?: ReactNode;
+    /** 可选：Header 右侧内容（如语言、用户菜单），使用方传入。Optional: header right slot. */
+    headerRight?: ReactNode;
+    /** 可选：Footer 内容（children），使用方传入。Optional: footer content. */
+    footerContent?: ReactNode;
+    /** 可选：侧栏菜单项。Optional: sidebar menu items. */
+    sidebarItems?: SidebarMenuItem[];
+    /** 可选：当前路径，用于高亮。传 useLocation().pathname。Optional: current pathname for active state. */
+    sidebarCurrentPathname?: string;
+    /** 可选：点击菜单项时调用。Optional: called when a sidebar item is clicked. */
+    onSidebarNavigate?: (path: string) => void;
+    /** 可选：侧栏底部登出按钮文案。Optional: logout button label. */
+    sidebarLogoutLabel?: string;
+    /** 可选：侧栏登出回调。Optional: logout handler. */
+    onSidebarLogout?: () => void;
+    /** 可选：侧栏底部登出按钮。Optional: bottom logout button. */
+    bottomLogoutButton?: ReactNode;
+}
+
+/**
+ * 布局模式枚举与常量。Layout mode enum and constants.
+ */
+export declare enum LayoutModeEnum {
+    SHOW = "show",
+    HIDE = "hide"
+}
+
+export declare const LayoutProvider: MemoExoticComponent<({ children, defaultLayoutMode }: LayoutProviderProps) => JSX.Element>;
+
+/** 布局 Provider 的 props。LayoutProvider props. */
+export declare interface LayoutProviderProps {
+    /** 子节点。Children. */
+    children: ReactNode;
+    /** 默认布局模式（显示/隐藏侧栏）。Default layout mode (show/hide sidebar). */
+    defaultLayoutMode?: LayoutModeEnum;
+}
+
+/** 布局切换器 props。LayoutSwitcher props. */
+export declare interface LayoutSwitcherProps {
+    /** 样式状态。Visual status. */
+    status?: "primary" | "default";
+    /** 显示模式标签（未传 getLayoutDisplayName 且无内置翻译时使用）。Show mode label. */
+    showLabel?: string;
+    /** 隐藏模式标签（未传 getLayoutDisplayName 且无内置翻译时使用）。Hide mode label. */
+    hideLabel?: string;
+    /** 根据布局模式返回展示名；未传则使用 showLabel / hideLabel。Display name for layout mode; default uses showLabel/hideLabel. */
+    getLayoutDisplayName?: (mode: LayoutModeEnum) => string;
+    /** 处理布局模式改变。Handle layout mode change. */
+    handleChangeLayoutMode?: (mode: LayoutModeEnum) => void;
+}
+
+export declare const MainWrapper: MemoExoticComponent<({ children, headerLeft, headerRight, footerContent }: MainWrapperProps) => JSX.Element>;
+
+/** MainWrapper props. */
+export declare interface MainWrapperProps {
+    children: (headerHeight: number, footerHeight: number) => ReactNode;
+    headerLeft?: ReactNode;
+    headerRight?: ReactNode;
+    footerContent?: ReactNode;
+}
+
+/**
+ * 可为 null 或 undefined。T | null | undefined.
+ * @example Nilable<boolean> => boolean | null | undefined
+ */
+declare type Nilable<T> = T | null | undefined;
+
+export declare function removeLayoutStorage(): void;
+
+export declare function setLayoutStorage(value: string): void;
+
+export declare const Sidebar: MemoExoticComponent<({ children, collapsed, toggled, onBackdropClick, breakPoint, className, items, currentPathname, onNavigate, logoutLabel, handleLogout, bottomLogoutButton, }: SidebarProps) => JSX.Element>;
+
+/** 侧栏菜单项。Sidebar menu item. */
+export declare interface SidebarMenuItem {
+    label: string;
+    path: string;
+    icon: ReactNode;
+    /** Sub-items for SubMenu. Omit for a leaf item. */
+    children?: SidebarMenuItem[];
+}
+
+/** Sidebar props（扩展 react-pro-sidebar）. */
+export declare interface SidebarProps extends SidebarProps_2 {
+    children?: ReactNode;
+    collapsed?: boolean;
+    toggled?: boolean;
+    onBackdropClick?: () => void;
+    className?: string;
+    /** Menu items. Rendered when no children. */
+    items?: SidebarMenuItem[];
+    /** Current pathname for active state. Pass from useLocation().pathname. */
+    currentPathname?: string;
+    /** Called when a menu item is clicked. Parent should navigate to path. */
+    onNavigate?: (path: string) => void;
+    /** Logout label. */
+    logoutLabel?: string;
+    /** Handle logout. */
+    handleLogout?: () => void;
+    /** Bottom Logout Button. */
+    bottomLogoutButton?: ReactNode;
+}
+
+export declare const SideHideLayout: MemoExoticComponent<({ children, headerHeight, footerHeight, sidebarItems, sidebarCurrentPathname, onSidebarNavigate, sidebarLogoutLabel, onSidebarLogout, }: SideHideLayoutProps) => JSX.Element>;
+
+/** SideHideLayout props. */
+export declare interface SideHideLayoutProps {
+    children: ReactNode;
+    headerHeight: number;
+    footerHeight: number;
+    sidebarItems?: SidebarMenuItem[];
+    sidebarCurrentPathname?: string;
+    onSidebarNavigate?: (path: string) => void;
+    sidebarLogoutLabel?: string;
+    onSidebarLogout?: () => void;
+    bottomLogoutButton?: ReactNode;
+}
+
+export declare const SideShowLayout: MemoExoticComponent<({ children, headerHeight, footerHeight, sidebarItems, sidebarCurrentPathname, onSidebarNavigate, sidebarLogoutLabel, onSidebarLogout, }: SideShowLayoutProps) => JSX.Element>;
+
+/** SideShowLayout props. */
+export declare interface SideShowLayoutProps {
+    children: ReactNode;
+    headerHeight: number;
+    footerHeight: number;
+    sidebarItems?: SidebarMenuItem[];
+    sidebarCurrentPathname?: string;
+    onSidebarNavigate?: (path: string) => void;
+    sidebarLogoutLabel?: string;
+    onSidebarLogout?: () => void;
+    bottomLogoutButton?: ReactNode;
+}
+
+export declare const useLayout: () => LayoutContextType;
+
+export { }