-
-
Notifications
You must be signed in to change notification settings - Fork 31.6k
/
MuiPage.ts
48 lines (47 loc) · 1.34 KB
/
MuiPage.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
export interface MuiPage {
pathname: string;
children?: MuiPage[];
disableDrawer?: boolean;
icon?: string;
/**
* Indicates if the pages are regarding some legacy API.
*/
legacy?: boolean;
/**
* Indicates if the pages are only available in some plan.
* @default 'community'
*/
plan?: 'community' | 'pro' | 'premium';
/**
* In case the children have pathnames out of pathname value, use this field to scope other pathnames.
* Pathname can be partial, e.g. '/components/' will cover '/components/button/' and '/components/link/'.
* @deprecated Dead code, to remove.
*/
scopePathnames?: string[];
/**
* Pages are considered to be ordered depth-first.
* If a page should be excluded from this order, set `order: false`.
* You want to set `inSideNav: false` if you don't want the page to appear in an ordered list e.g. for previous/next page navigation.
*/
inSideNav?: boolean;
/**
* Props spread to the Link component.
*/
linkProps?: Record<string, unknown>;
/**
* Subheader to display before navigation links.
*/
subheader?: string;
/**
* Overrides the default page title.
*/
title?: string;
/**
* Indicates if the feature has been recently released.
* @default false
*/
newFeature?: boolean;
}
export interface OrderedMuiPage extends MuiPage {
ordered?: true;
}