@financial-times/dotcom-types-navigation 7.3.1 → 7.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +95 -0
- package/package.json +3 -3
package/index.d.ts
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
export type TNavMenuKeys =
|
|
2
|
+
| 'account'
|
|
3
|
+
| 'anon'
|
|
4
|
+
| 'drawer-international'
|
|
5
|
+
| 'drawer-uk'
|
|
6
|
+
| 'footer'
|
|
7
|
+
| 'navbar-international'
|
|
8
|
+
| 'navbar-uk'
|
|
9
|
+
| 'navbar-right'
|
|
10
|
+
| 'navbar-right-anon'
|
|
11
|
+
| 'navbar-simple'
|
|
12
|
+
| 'user'
|
|
13
|
+
|
|
14
|
+
export type TNavMenuKeysForEdition =
|
|
15
|
+
| 'account'
|
|
16
|
+
| 'anon'
|
|
17
|
+
| 'drawer'
|
|
18
|
+
| 'footer'
|
|
19
|
+
| 'navbar'
|
|
20
|
+
| 'navbar-right'
|
|
21
|
+
| 'navbar-right-anon'
|
|
22
|
+
| 'navbar-simple'
|
|
23
|
+
| 'user'
|
|
24
|
+
|
|
25
|
+
export type TNavMenus = { [key in TNavMenuKeys]: TNavMenu }
|
|
26
|
+
|
|
27
|
+
export type TNavMenusForEdition = { [key in TNavMenuKeysForEdition]: TNavMenu }
|
|
28
|
+
|
|
29
|
+
export type TNavigationData = TNavMenusForEdition &
|
|
30
|
+
TNavSubNavigation & {
|
|
31
|
+
editions: TNavEditions
|
|
32
|
+
subscribeAction?: TNavAction
|
|
33
|
+
currentPath?: string
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export type TNavMenu = {
|
|
37
|
+
label: string | null
|
|
38
|
+
items: TNavMenuItem[]
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/** Menu data for the footer will be split into "columns" by the Next navigation API */
|
|
42
|
+
export type TNavMenuWithColumns = {
|
|
43
|
+
label: string | null
|
|
44
|
+
items: TNavMenuItem[][]
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export type TNavMenuItem = {
|
|
48
|
+
label: string
|
|
49
|
+
url: string | null
|
|
50
|
+
submenu?: TNavMenu | TNavMenuWithColumns
|
|
51
|
+
selected?: boolean
|
|
52
|
+
meganav?: TNavMeganav[]
|
|
53
|
+
disableTracking?: boolean
|
|
54
|
+
index?: number
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export type TNavMeganav = INavMeganavSections | INavMeganavArticles
|
|
58
|
+
|
|
59
|
+
export interface INavMeganavSections {
|
|
60
|
+
component: 'sectionlist'
|
|
61
|
+
dataset: 'subsections'
|
|
62
|
+
title: string
|
|
63
|
+
/** This data has been split into "columns" by the Next navigation API */
|
|
64
|
+
data?: TNavMenuItem[][]
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface INavMeganavArticles {
|
|
68
|
+
component: 'articlelist'
|
|
69
|
+
dataset: 'popular'
|
|
70
|
+
title: string
|
|
71
|
+
data?: TNavMenuItem[]
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export type TNavSubNavigation = {
|
|
75
|
+
breadcrumb?: TNavMenuItem[]
|
|
76
|
+
subsections?: TNavMenuItem[]
|
|
77
|
+
'subsections-right'?: TNavMenuItem[]
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export type TNavEditions = {
|
|
81
|
+
current: TNavEdition
|
|
82
|
+
others: TNavEdition[]
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export type TNavEdition = {
|
|
86
|
+
name: string
|
|
87
|
+
id: string
|
|
88
|
+
url: string
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export type TNavAction = {
|
|
92
|
+
name: string
|
|
93
|
+
id: string
|
|
94
|
+
url: string
|
|
95
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@financial-times/dotcom-types-navigation",
|
|
3
|
-
"version": "7.3.
|
|
3
|
+
"version": "7.3.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"npm": "7.x || 8.x"
|
|
19
19
|
},
|
|
20
20
|
"files": [
|
|
21
|
-
"
|
|
21
|
+
"index.d.ts"
|
|
22
22
|
],
|
|
23
23
|
"repository": {
|
|
24
24
|
"type": "git",
|
|
@@ -32,4 +32,4 @@
|
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"check-engine": "^1.10.1"
|
|
34
34
|
}
|
|
35
|
-
}
|
|
35
|
+
}
|