UNPKG

1.47 kBTypeScriptView Raw
1import type { BreadcrumbProps as AntdBreadcrumbProps } from 'antd';
2import type H from 'history';
3import type { ProSettings } from '../defaultSettings';
4import type { ProLayoutProps } from '../ProLayout';
5import type { MenuDataItem, MessageDescriptor, WithFalse } from '../typing';
6export type BreadcrumbProps = {
7 breadcrumbList?: {
8 title: string;
9 href: string;
10 }[];
11 home?: string;
12 location?: H.Location | {
13 pathname?: string;
14 };
15 menu?: ProSettings['menu'];
16 breadcrumbMap?: Map<string, MenuDataItem>;
17 formatMessage?: (message: MessageDescriptor) => string;
18 breadcrumbRender?: WithFalse<(routers: AntdBreadcrumbProps['routes']) => AntdBreadcrumbProps['routes']>;
19 itemRender?: AntdBreadcrumbProps['itemRender'];
20};
21export declare const getBreadcrumb: (breadcrumbMap: Map<string, MenuDataItem>, url: string) => MenuDataItem;
22export declare const getBreadcrumbFromProps: (props: BreadcrumbProps) => {
23 location: BreadcrumbProps['location'];
24 breadcrumbMap: BreadcrumbProps['breadcrumbMap'];
25};
26export type BreadcrumbListReturn = Pick<AntdBreadcrumbProps, Extract<keyof AntdBreadcrumbProps, 'routes' | 'itemRender'>>;
27/** 将参数转化为面包屑 Convert parameters into breadcrumbs */
28export declare const genBreadcrumbProps: (props: BreadcrumbProps) => AntdBreadcrumbProps['routes'];
29export declare const getBreadcrumbProps: (props: BreadcrumbProps, layoutPros: ProLayoutProps) => BreadcrumbListReturn;