UNPKG

2.64 kBTypeScriptView Raw
1import type { ReactNode } from 'react';
2import React from 'react';
3import type { TabsProps, AffixProps, PageHeaderProps, TabPaneProps, SpinProps, BreadcrumbProps } from 'antd';
4import './index.less';
5import type { WithFalse } from '../../typings';
6import type { WaterMarkProps } from '../WaterMark';
7export declare type PageHeaderTabConfig = {
8 /** @name tabs 的列表 */
9 tabList?: (TabPaneProps & {
10 key?: React.ReactText;
11 })[];
12 /** @name 当前选中 tab 的 key */
13 tabActiveKey?: TabsProps['activeKey'];
14 /** @name tab 修改时触发 */
15 onTabChange?: TabsProps['onChange'];
16 /** @name tab 上额外的区域 */
17 tabBarExtraContent?: TabsProps['tabBarExtraContent'];
18 /** @name tabs 的其他配置 */
19 tabProps?: TabsProps;
20 /**
21 * @deprecated 请使用 fixedHeader
22 * @name 固定 PageHeader 到页面顶部
23 */
24 fixHeader?: boolean;
25 /** @name 固定 PageHeader 到页面顶部 */
26 fixedHeader?: boolean;
27};
28export declare type PageContainerProps = {
29 title?: React.ReactNode | false;
30 content?: React.ReactNode;
31 extraContent?: React.ReactNode;
32 prefixCls?: string;
33 footer?: ReactNode[];
34 /** @name 是否显示背景色 */
35 ghost?: boolean;
36 /**
37 * 与 antd 完全相同
38 *
39 * @name PageHeader 的配置
40 */
41 header?: Partial<PageHeaderProps> & {
42 children?: React.ReactNode;
43 };
44 /** @name 自定义 pageHeader */
45 pageHeaderRender?: WithFalse<(props: PageContainerProps) => React.ReactNode>;
46 /**
47 * 与 antd 完全相同
48 *
49 * @name 固钉的配置
50 */
51 affixProps?: Omit<AffixProps, 'children'>;
52 /**
53 * 只加载内容区域
54 *
55 * @name 是否加载
56 */
57 loading?: boolean | SpinProps | React.ReactNode;
58 /** 自定义 breadcrumb,返回false不展示 */
59 breadcrumbRender?: PageHeaderProps['breadcrumbRender'] | false;
60 /** @name 水印的配置 */
61 waterMarkProps?: WaterMarkProps;
62 /** @name 配置面包屑 */
63 breadcrumb?: BreadcrumbProps;
64 children?: React.ReactNode;
65} & PageHeaderTabConfig & Omit<PageHeaderProps, 'title' | 'footer' | 'breadcrumbRender' | 'breadcrumb'>;
66/**
67 * 配置与面包屑相同，只是增加了自动根据路由计算面包屑的功能。此功能必须要在 ProLayout 中使用。
68 *
69 * @param props
70 * @returns
71 */
72declare const ProBreadcrumb: React.FC<BreadcrumbProps>;
73declare const ProPageHeader: React.FC<PageContainerProps & {
74 prefixedClassName: string;
75}>;
76declare const PageContainer: React.FC<PageContainerProps>;
77export { ProPageHeader, ProBreadcrumb };
78export default PageContainer;