@hanwenbo/x-web-pro-components 0.0.1

package/lib/components/layout/index.d.ts

@@ -0,0 +1,182 @@
+import React from 'react';
+export * from './components/Help';
+export interface BreadcrumbItem {
+    title: React.ReactNode;
+    href?: string;
+}
+export interface MenuDataItem {
+    children?: MenuDataItem[];
+    hideInMenu?: boolean;
+    icon?: React.ReactNode;
+    key?: React.Key;
+    name?: React.ReactNode;
+    path?: string;
+    [key: string]: any;
+}
+export interface RouteContextType {
+    breadcrumb?: BreadcrumbItem[];
+    collapsed?: boolean;
+    currentMenu?: MenuDataItem;
+    isMobile?: boolean;
+    title?: React.ReactNode;
+}
+export declare const RouteContext: React.Context<RouteContextType>;
+export interface PageContainerProps {
+    title?: React.ReactNode;
+    subTitle?: React.ReactNode;
+    extra?: React.ReactNode;
+    content?: React.ReactNode;
+    footer?: React.ReactNode;
+    children?: React.ReactNode;
+    breadcrumb?: BreadcrumbItem[];
+    ghost?: boolean;
+    loading?: boolean;
+    tabList?: Array<{
+        key: string;
+        tab: React.ReactNode;
+    }>;
+    tabActiveKey?: string;
+    onTabChange?: (key: string) => void;
+    className?: string;
+    style?: React.CSSProperties;
+    bodyClassName?: string;
+    bodyStyle?: React.CSSProperties;
+}
+export interface FooterToolbarProps {
+    children?: React.ReactNode;
+    extra?: React.ReactNode;
+    className?: string;
+}
+export interface DefaultFooterLink {
+    key?: React.Key;
+    title: React.ReactNode;
+    href?: string;
+}
+export interface DefaultFooterProps {
+    links?: DefaultFooterLink[];
+    copyright?: React.ReactNode;
+    className?: string;
+}
+export interface AppItemProps {
+    desc?: React.ReactNode;
+    icon?: React.ReactNode;
+    title: React.ReactNode;
+    url?: string;
+}
+export interface AppListProps {
+    apps?: AppItemProps[];
+    className?: string;
+}
+export interface TopNavHeaderProps {
+    title?: React.ReactNode;
+    subTitle?: React.ReactNode;
+    logo?: React.ReactNode;
+    content?: React.ReactNode;
+    actions?: React.ReactNode;
+    fixed?: boolean;
+    navTheme?: 'light' | 'dark';
+    className?: string;
+}
+export interface SettingDrawerState {
+    colorPrimary?: string;
+    colorWeak?: boolean;
+    contentWidth?: 'Fluid' | 'Fixed';
+    fixedHeader?: boolean;
+    fixSiderbar?: boolean;
+    layout?: 'side' | 'top' | 'mix';
+    navTheme?: 'light' | 'dark';
+    splitMenus?: boolean;
+}
+export interface SettingDrawerProps {
+    children?: React.ReactNode;
+    className?: string;
+    collapse?: boolean;
+    onCollapseChange?: (collapse: boolean) => void;
+    onOpenChange?: (open: boolean) => void;
+    onSettingChange?: (settings: SettingDrawerState) => void;
+    open?: boolean;
+    settings?: SettingDrawerState;
+}
+export declare type FooterProps = DefaultFooterProps;
+export declare type HeaderProps = TopNavHeaderProps;
+export declare type PageHeaderProps = PageContainerProps;
+export declare type ProSettings = SettingDrawerState;
+export declare type Settings = SettingDrawerState;
+export declare const LayoutSettingsContext: React.Context<SettingDrawerState | undefined>;
+export interface GetPageTitleProps {
+    appList?: Array<{
+        title?: React.ReactNode;
+    }>;
+    breadcrumb?: Record<string, MenuDataItem>;
+    breadcrumbMap?: Map<string, MenuDataItem>;
+    formatMessage?: (data: {
+        id: any;
+        defaultMessage?: string;
+    }) => string;
+    menu?: {
+        locale?: boolean;
+    };
+    pageName?: React.ReactNode;
+    pathname?: string;
+    title?: React.ReactNode;
+}
+export interface GetMenuDataResult {
+    breadcrumb: Record<string, MenuDataItem>;
+    menuData: MenuDataItem[];
+}
+export interface ProLayoutProps extends React.HTMLAttributes<HTMLDivElement> {
+    title?: React.ReactNode;
+    logo?: React.ReactNode;
+    content?: React.ReactNode;
+    actions?: React.ReactNode;
+    breadcrumb?: BreadcrumbItem[];
+    collapsed?: boolean;
+    collapsedButtonRender?: React.ReactNode | ((collapsed?: boolean) => React.ReactNode);
+    contentStyle?: React.CSSProperties;
+    currentMenu?: MenuDataItem;
+    contentWidth?: 'Fluid' | 'Fixed';
+    fixedHeader?: boolean;
+    fixSiderbar?: boolean;
+    layout?: 'side' | 'top' | 'mix';
+    location?: {
+        pathname?: string;
+        [key: string]: any;
+    };
+    menuData?: MenuDataItem[];
+    menuDataRender?: (menuData: MenuDataItem[]) => MenuDataItem[];
+    menuFooterRender?: (props: ProLayoutProps) => React.ReactNode;
+    menuItemRender?: (item: MenuDataItem, defaultDom: React.ReactNode) => React.ReactNode;
+    menuRender?: (props: ProLayoutProps, defaultDom: React.ReactNode) => React.ReactNode;
+    navTheme?: 'light' | 'dark';
+    onMenuHeaderClick?: () => void;
+    siderWidth?: number;
+    splitMenus?: boolean;
+    headerRender?: (props: ProLayoutProps, defaultDom: React.ReactNode) => React.ReactNode;
+    token?: Record<string, any>;
+}
+export declare const getMenuData: (routes?: MenuDataItem[], menuDataRender?: ((menuData: MenuDataItem[]) => MenuDataItem[]) | undefined) => GetMenuDataResult;
+export declare const getPageTitle: ({ title, pageName, appList, breadcrumb, breadcrumbMap, formatMessage, menu, pathname }: GetPageTitleProps, ignoreTitle?: boolean) => string;
+export declare const getPageTitleInfo: ({ title, pageName, appList, breadcrumb, breadcrumbMap, formatMessage, menu, pathname }: GetPageTitleProps, ignoreTitle?: boolean) => {
+    id: string;
+    pageName: string;
+    title: string;
+};
+export declare const ProBreadcrumb: React.FC<{
+    items?: BreadcrumbItem[];
+}>;
+export declare const PageLoading: React.FC<{
+    tip?: React.ReactNode;
+}>;
+export declare const GridContent: React.FC<React.HTMLAttributes<HTMLDivElement>>;
+export declare const WrapContent: React.FC<React.HTMLAttributes<HTMLDivElement>>;
+export declare const AppList: React.FC<AppListProps>;
+export declare const FooterToolbar: React.FC<FooterToolbarProps>;
+export declare const DefaultFooter: React.FC<DefaultFooterProps>;
+export declare const TopNavHeader: React.FC<TopNavHeaderProps>;
+export declare const DefaultHeader: React.FC<TopNavHeaderProps>;
+export declare const SettingDrawer: React.FC<SettingDrawerProps>;
+export declare const PageContainer: React.FC<PageContainerProps>;
+export declare const ProPageHeader: React.FC<PageContainerProps>;
+export declare const PageHeader: React.FC<PageContainerProps>;
+export declare const ProLayout: React.FC<ProLayoutProps>;
+export default ProLayout;