@3mo/navigation 0.1.0
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/dist/INavigation.d.ts +35 -0
- package/dist/INavigation.d.ts.map +1 -0
- package/dist/INavigation.js +2 -0
- package/dist/Navigation.d.ts +75 -0
- package/dist/Navigation.d.ts.map +1 -0
- package/dist/Navigation.js +304 -0
- package/dist/NavigationBar.d.ts +32 -0
- package/dist/NavigationBar.d.ts.map +1 -0
- package/dist/NavigationBar.js +90 -0
- package/dist/NavigationBarItem.d.ts +30 -0
- package/dist/NavigationBarItem.d.ts.map +1 -0
- package/dist/NavigationBarItem.js +108 -0
- package/dist/NavigationDrawer.d.ts +38 -0
- package/dist/NavigationDrawer.d.ts.map +1 -0
- package/dist/NavigationDrawer.js +89 -0
- package/dist/NavigationGroup.d.ts +22 -0
- package/dist/NavigationGroup.d.ts.map +1 -0
- package/dist/NavigationGroup.js +17 -0
- package/dist/NavigationLink.d.ts +24 -0
- package/dist/NavigationLink.d.ts.map +1 -0
- package/dist/NavigationLink.js +33 -0
- package/dist/NavigationPresentation.d.ts +8 -0
- package/dist/NavigationPresentation.d.ts.map +1 -0
- package/dist/NavigationPresentation.js +1 -0
- package/dist/NavigationRail.d.ts +52 -0
- package/dist/NavigationRail.d.ts.map +1 -0
- package/dist/NavigationRail.js +213 -0
- package/dist/NavigationRailItem.d.ts +28 -0
- package/dist/NavigationRailItem.d.ts.map +1 -0
- package/dist/NavigationRailItem.js +103 -0
- package/dist/NavigationTree.d.ts +33 -0
- package/dist/NavigationTree.d.ts.map +1 -0
- package/dist/NavigationTree.js +87 -0
- package/dist/NavigationTreeItem.d.ts +19 -0
- package/dist/NavigationTreeItem.d.ts.map +1 -0
- package/dist/NavigationTreeItem.js +115 -0
- package/dist/custom-elements.json +1208 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +20 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +49 -0
|
@@ -0,0 +1,1208 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "experimental",
|
|
3
|
+
"tags": [
|
|
4
|
+
{
|
|
5
|
+
"name": "mo-navigation",
|
|
6
|
+
"path": ".\\packages\\Navigation\\Navigation.ts",
|
|
7
|
+
"description": "The application's shell: a header, the page beside or beneath it, and the navigations presented as\nwhichever of `bar`, `rail` and `drawer` fits.\n\n`presentations` is the order they are preferred in, and the first one which fits is the one shown —\nthe bar as long as its navigations fit its row, the rail as long as the page keeps\n`--mo-navigation-min-content-size` beside it, and the drawer, which always fits. Demoting the bar is\ntherefore a matter of leaving it out of the order rather than of replacing the shell.",
|
|
8
|
+
"attributes": [
|
|
9
|
+
{
|
|
10
|
+
"name": "navigations",
|
|
11
|
+
"description": "The navigations to present.",
|
|
12
|
+
"type": "INavigation[]",
|
|
13
|
+
"default": "\"new Array<INavigation>()\""
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "presentations",
|
|
17
|
+
"description": "The presentations to choose from, most preferred first. Defaults to `bar` then `drawer`.",
|
|
18
|
+
"type": "NavigationPresentation[]",
|
|
19
|
+
"default": "\"new Array<NavigationPresentation>('bar', 'drawer')\""
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "presentation",
|
|
23
|
+
"description": "The presentation being shown. Derived, and reflected for styling.",
|
|
24
|
+
"type": "NavigationPresentation",
|
|
25
|
+
"default": "\"bar\""
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "heading",
|
|
29
|
+
"description": "The application's heading, shown in the header and above the drawer's navigations.",
|
|
30
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "drawerOpen",
|
|
34
|
+
"description": "Whether the drawer is open. Only of consequence while the drawer is the presentation.",
|
|
35
|
+
"type": "boolean",
|
|
36
|
+
"default": "false"
|
|
37
|
+
}
|
|
38
|
+
],
|
|
39
|
+
"properties": [
|
|
40
|
+
{
|
|
41
|
+
"name": "navigationBar",
|
|
42
|
+
"type": "NavigationBar | null"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "navigationRail",
|
|
46
|
+
"type": "NavigationRail | null"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"name": "menuButton",
|
|
50
|
+
"type": "HTMLElement | null"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "navigations",
|
|
54
|
+
"attribute": "navigations",
|
|
55
|
+
"description": "The navigations to present.",
|
|
56
|
+
"type": "INavigation[]",
|
|
57
|
+
"default": "\"new Array<INavigation>()\""
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "presentations",
|
|
61
|
+
"attribute": "presentations",
|
|
62
|
+
"description": "The presentations to choose from, most preferred first. Defaults to `bar` then `drawer`.",
|
|
63
|
+
"type": "NavigationPresentation[]",
|
|
64
|
+
"default": "\"new Array<NavigationPresentation>('bar', 'drawer')\""
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "presentation",
|
|
68
|
+
"attribute": "presentation",
|
|
69
|
+
"description": "The presentation being shown. Derived, and reflected for styling.",
|
|
70
|
+
"type": "NavigationPresentation",
|
|
71
|
+
"default": "\"bar\""
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "heading",
|
|
75
|
+
"attribute": "heading",
|
|
76
|
+
"description": "The application's heading, shown in the header and above the drawer's navigations.",
|
|
77
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"name": "drawerOpen",
|
|
81
|
+
"attribute": "drawerOpen",
|
|
82
|
+
"description": "Whether the drawer is open. Only of consequence while the drawer is the presentation.",
|
|
83
|
+
"type": "boolean",
|
|
84
|
+
"default": "false"
|
|
85
|
+
}
|
|
86
|
+
],
|
|
87
|
+
"slots": [
|
|
88
|
+
{
|
|
89
|
+
"name": "",
|
|
90
|
+
"description": "The page."
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "logo",
|
|
94
|
+
"description": "Placed at the start of the header, and at the top of the rail."
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"name": "end",
|
|
98
|
+
"description": "Placed at the end of the header."
|
|
99
|
+
}
|
|
100
|
+
],
|
|
101
|
+
"cssProperties": [
|
|
102
|
+
{
|
|
103
|
+
"name": "--mo-navigation-min-content-size",
|
|
104
|
+
"description": "How much room the page keeps beside the rail. Defaults to `32rem`, which puts the rail's threshold at Material's medium window."
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "--mo-navigation-rail-size",
|
|
108
|
+
"description": "How wide the rail's strip is. Defaults to `5.5rem`."
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "--mo-navigation-rail-panel-size",
|
|
112
|
+
"description": "How wide the rail's panel is. Defaults to `17rem`."
|
|
113
|
+
}
|
|
114
|
+
],
|
|
115
|
+
"cssParts": [
|
|
116
|
+
{
|
|
117
|
+
"name": "app-bar",
|
|
118
|
+
"description": "The header above the page."
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "content",
|
|
122
|
+
"description": "What the page is placed in."
|
|
123
|
+
}
|
|
124
|
+
]
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"name": "mo-navigation-bar",
|
|
128
|
+
"path": ".\\packages\\Navigation\\NavigationBar.ts",
|
|
129
|
+
"description": "The navigations as a horizontal row, each group opening its destinations as a dropdown.\n\nIt reports through `hasOverflow` whether its navigations still fit, which is what an orchestrating\n`mo-navigation` decides by whether the bar is the presentation it can afford.",
|
|
130
|
+
"attributes": [
|
|
131
|
+
{
|
|
132
|
+
"name": "navigations",
|
|
133
|
+
"description": "The navigations to present.",
|
|
134
|
+
"type": "INavigation[]",
|
|
135
|
+
"default": "\"new Array<INavigation>()\""
|
|
136
|
+
}
|
|
137
|
+
],
|
|
138
|
+
"properties": [
|
|
139
|
+
{
|
|
140
|
+
"name": "invoke",
|
|
141
|
+
"type": "EventDispatcher<INavigation>"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"name": "role",
|
|
145
|
+
"type": "\"navigation\"",
|
|
146
|
+
"default": "\"navigation\""
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"name": "items",
|
|
150
|
+
"type": "readonly NavigationBarItem[]"
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"name": "hasOverflow",
|
|
154
|
+
"type": "boolean"
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"name": "navigations",
|
|
158
|
+
"attribute": "navigations",
|
|
159
|
+
"description": "The navigations to present.",
|
|
160
|
+
"type": "INavigation[]",
|
|
161
|
+
"default": "\"new Array<INavigation>()\""
|
|
162
|
+
}
|
|
163
|
+
],
|
|
164
|
+
"events": [
|
|
165
|
+
{
|
|
166
|
+
"name": "invoke",
|
|
167
|
+
"description": "Dispatched with the navigation which was invoked.",
|
|
168
|
+
"type": "CustomEvent<INavigation>"
|
|
169
|
+
}
|
|
170
|
+
]
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"name": "mo-navigation-bar-item",
|
|
174
|
+
"path": ".\\packages\\Navigation\\NavigationBarItem.ts",
|
|
175
|
+
"description": "A navigation of a navigation bar: a destination, or a group opening its destinations as a dropdown.",
|
|
176
|
+
"attributes": [
|
|
177
|
+
{
|
|
178
|
+
"name": "navigation",
|
|
179
|
+
"description": "The navigation this item stands for.",
|
|
180
|
+
"type": "INavigation"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "open",
|
|
184
|
+
"description": "Whether the group's dropdown is open.",
|
|
185
|
+
"type": "boolean",
|
|
186
|
+
"default": "false"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "data-current",
|
|
190
|
+
"description": "Whether this navigation, or one nested in it, is the page being shown.",
|
|
191
|
+
"type": "boolean",
|
|
192
|
+
"default": "false"
|
|
193
|
+
}
|
|
194
|
+
],
|
|
195
|
+
"properties": [
|
|
196
|
+
{
|
|
197
|
+
"name": "invoke",
|
|
198
|
+
"type": "EventDispatcher<INavigation>"
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "tabIndex",
|
|
202
|
+
"type": "number",
|
|
203
|
+
"default": "0"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "navigation",
|
|
207
|
+
"attribute": "navigation",
|
|
208
|
+
"description": "The navigation this item stands for.",
|
|
209
|
+
"type": "INavigation"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "open",
|
|
213
|
+
"attribute": "open",
|
|
214
|
+
"description": "Whether the group's dropdown is open.",
|
|
215
|
+
"type": "boolean",
|
|
216
|
+
"default": "false"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "current",
|
|
220
|
+
"attribute": "data-current",
|
|
221
|
+
"description": "Whether this navigation, or one nested in it, is the page being shown.",
|
|
222
|
+
"type": "boolean",
|
|
223
|
+
"default": "false"
|
|
224
|
+
}
|
|
225
|
+
],
|
|
226
|
+
"events": [
|
|
227
|
+
{
|
|
228
|
+
"name": "invoke",
|
|
229
|
+
"description": "Dispatched with the destination which was invoked.",
|
|
230
|
+
"type": "CustomEvent<INavigation>"
|
|
231
|
+
}
|
|
232
|
+
]
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "mo-navigation-drawer",
|
|
236
|
+
"path": ".\\packages\\Navigation\\NavigationDrawer.ts",
|
|
237
|
+
"description": "Every navigation as a tree, in a modal drawer over the page.",
|
|
238
|
+
"attributes": [
|
|
239
|
+
{
|
|
240
|
+
"name": "navigations",
|
|
241
|
+
"description": "The navigations to present.",
|
|
242
|
+
"type": "INavigation[]",
|
|
243
|
+
"default": "\"new Array<INavigation>()\""
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"name": "open",
|
|
247
|
+
"description": "Whether the drawer is open.",
|
|
248
|
+
"type": "boolean",
|
|
249
|
+
"default": "false"
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
"name": "heading",
|
|
253
|
+
"description": "Placed above the tree.",
|
|
254
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
255
|
+
}
|
|
256
|
+
],
|
|
257
|
+
"properties": [
|
|
258
|
+
{
|
|
259
|
+
"name": "openChange",
|
|
260
|
+
"type": "EventDispatcher<boolean>"
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "navigations",
|
|
264
|
+
"attribute": "navigations",
|
|
265
|
+
"description": "The navigations to present.",
|
|
266
|
+
"type": "INavigation[]",
|
|
267
|
+
"default": "\"new Array<INavigation>()\""
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "open",
|
|
271
|
+
"attribute": "open",
|
|
272
|
+
"description": "Whether the drawer is open.",
|
|
273
|
+
"type": "boolean",
|
|
274
|
+
"default": "false"
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
"name": "heading",
|
|
278
|
+
"attribute": "heading",
|
|
279
|
+
"description": "Placed above the tree.",
|
|
280
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
281
|
+
}
|
|
282
|
+
],
|
|
283
|
+
"events": [
|
|
284
|
+
{
|
|
285
|
+
"name": "openChange",
|
|
286
|
+
"description": "Dispatched with the new state whenever the drawer opens or closes.",
|
|
287
|
+
"type": "CustomEvent<boolean>"
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"name": "invoke",
|
|
291
|
+
"description": "Dispatched with the destination which was invoked, on its way up from the tree.",
|
|
292
|
+
"type": "CustomEvent"
|
|
293
|
+
}
|
|
294
|
+
],
|
|
295
|
+
"cssProperties": [
|
|
296
|
+
{
|
|
297
|
+
"name": "--mo-navigation-drawer-width",
|
|
298
|
+
"description": "How wide the drawer is. Defaults to `292px`."
|
|
299
|
+
}
|
|
300
|
+
]
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"name": "mo-navigation-rail",
|
|
304
|
+
"path": ".\\packages\\Navigation\\NavigationRail.ts",
|
|
305
|
+
"description": "The navigations as a vertical strip at the leading edge, each one an icon with its label beneath it.\n\nA group's destinations are shown in a panel beside the strip: docked next to the page while there is\nroom for both, and overlaid over the page while there is not.",
|
|
306
|
+
"attributes": [
|
|
307
|
+
{
|
|
308
|
+
"name": "navigations",
|
|
309
|
+
"description": "The navigations to present.",
|
|
310
|
+
"type": "INavigation[]",
|
|
311
|
+
"default": "\"new Array<INavigation>()\""
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "docked",
|
|
315
|
+
"description": "Whether the panel stands beside the page rather than over it.",
|
|
316
|
+
"type": "boolean",
|
|
317
|
+
"default": "false"
|
|
318
|
+
}
|
|
319
|
+
],
|
|
320
|
+
"properties": [
|
|
321
|
+
{
|
|
322
|
+
"name": "invoke",
|
|
323
|
+
"type": "EventDispatcher<INavigation>"
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "items",
|
|
327
|
+
"type": "NavigationRailItem[]"
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"name": "shownNavigation",
|
|
331
|
+
"description": "The navigation whose destinations the panel shows.",
|
|
332
|
+
"type": "INavigation | undefined"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "navigations",
|
|
336
|
+
"attribute": "navigations",
|
|
337
|
+
"description": "The navigations to present.",
|
|
338
|
+
"type": "INavigation[]",
|
|
339
|
+
"default": "\"new Array<INavigation>()\""
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
"name": "docked",
|
|
343
|
+
"attribute": "docked",
|
|
344
|
+
"description": "Whether the panel stands beside the page rather than over it.",
|
|
345
|
+
"type": "boolean",
|
|
346
|
+
"default": "false"
|
|
347
|
+
}
|
|
348
|
+
],
|
|
349
|
+
"events": [
|
|
350
|
+
{
|
|
351
|
+
"name": "invoke",
|
|
352
|
+
"description": "Dispatched with the destination which was invoked.",
|
|
353
|
+
"type": "CustomEvent<INavigation>"
|
|
354
|
+
}
|
|
355
|
+
],
|
|
356
|
+
"slots": [
|
|
357
|
+
{
|
|
358
|
+
"name": "header",
|
|
359
|
+
"description": "Placed above the navigations, e.g. a logo or a button which creates something."
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"name": "footer",
|
|
363
|
+
"description": "Placed below the navigations."
|
|
364
|
+
}
|
|
365
|
+
],
|
|
366
|
+
"cssProperties": [
|
|
367
|
+
{
|
|
368
|
+
"name": "--mo-navigation-rail-size",
|
|
369
|
+
"description": "How wide the strip is. Defaults to `5.5rem`."
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "--mo-navigation-rail-panel-size",
|
|
373
|
+
"description": "How wide the panel is. Defaults to `17rem`."
|
|
374
|
+
}
|
|
375
|
+
],
|
|
376
|
+
"cssParts": [
|
|
377
|
+
{
|
|
378
|
+
"name": "strip",
|
|
379
|
+
"description": "The strip of navigations."
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"name": "panel",
|
|
383
|
+
"description": "The panel holding the destinations of the navigation being shown."
|
|
384
|
+
}
|
|
385
|
+
]
|
|
386
|
+
},
|
|
387
|
+
{
|
|
388
|
+
"name": "mo-navigation-rail-item",
|
|
389
|
+
"path": ".\\packages\\Navigation\\NavigationRailItem.ts",
|
|
390
|
+
"description": "A navigation of a navigation rail: an icon with its label beneath it.",
|
|
391
|
+
"attributes": [
|
|
392
|
+
{
|
|
393
|
+
"name": "navigation",
|
|
394
|
+
"description": "The navigation this item stands for.",
|
|
395
|
+
"type": "INavigation"
|
|
396
|
+
},
|
|
397
|
+
{
|
|
398
|
+
"name": "data-current",
|
|
399
|
+
"description": "Whether this navigation, or one nested in it, is the page being shown.",
|
|
400
|
+
"type": "boolean",
|
|
401
|
+
"default": "false"
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "selected",
|
|
405
|
+
"description": "Whether the rail is showing this navigation's destinations.",
|
|
406
|
+
"type": "boolean",
|
|
407
|
+
"default": "false"
|
|
408
|
+
}
|
|
409
|
+
],
|
|
410
|
+
"properties": [
|
|
411
|
+
{
|
|
412
|
+
"name": "tabIndex",
|
|
413
|
+
"type": "number",
|
|
414
|
+
"default": "0"
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "navigation",
|
|
418
|
+
"attribute": "navigation",
|
|
419
|
+
"description": "The navigation this item stands for.",
|
|
420
|
+
"type": "INavigation"
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"name": "current",
|
|
424
|
+
"attribute": "data-current",
|
|
425
|
+
"description": "Whether this navigation, or one nested in it, is the page being shown.",
|
|
426
|
+
"type": "boolean",
|
|
427
|
+
"default": "false"
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"name": "selected",
|
|
431
|
+
"attribute": "selected",
|
|
432
|
+
"description": "Whether the rail is showing this navigation's destinations.",
|
|
433
|
+
"type": "boolean",
|
|
434
|
+
"default": "false"
|
|
435
|
+
}
|
|
436
|
+
],
|
|
437
|
+
"cssParts": [
|
|
438
|
+
{
|
|
439
|
+
"name": "indicator",
|
|
440
|
+
"description": "The shape behind the icon, which marks the navigation the page belongs to."
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"name": "label",
|
|
444
|
+
"description": "The label beneath the icon."
|
|
445
|
+
}
|
|
446
|
+
]
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "mo-navigation-tree",
|
|
450
|
+
"path": ".\\packages\\Navigation\\NavigationTree.ts",
|
|
451
|
+
"description": "The navigations as a tree of rows: a group is a row which opens, a destination is a row which navigates.\nThe row of the page being shown is revealed, so that a deep destination is on screen right away.",
|
|
452
|
+
"attributes": [
|
|
453
|
+
{
|
|
454
|
+
"name": "navigations",
|
|
455
|
+
"description": "The navigations to present.",
|
|
456
|
+
"type": "INavigation[]",
|
|
457
|
+
"default": "\"new Array<INavigation>()\""
|
|
458
|
+
}
|
|
459
|
+
],
|
|
460
|
+
"properties": [
|
|
461
|
+
{
|
|
462
|
+
"name": "invoke",
|
|
463
|
+
"type": "EventDispatcher<INavigation>"
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "navigations",
|
|
467
|
+
"attribute": "navigations",
|
|
468
|
+
"description": "The navigations to present.",
|
|
469
|
+
"type": "INavigation[]",
|
|
470
|
+
"default": "\"new Array<INavigation>()\""
|
|
471
|
+
}
|
|
472
|
+
],
|
|
473
|
+
"events": [
|
|
474
|
+
{
|
|
475
|
+
"name": "invoke",
|
|
476
|
+
"description": "Dispatched with the destination which was invoked.",
|
|
477
|
+
"type": "CustomEvent<INavigation>"
|
|
478
|
+
}
|
|
479
|
+
],
|
|
480
|
+
"cssParts": [
|
|
481
|
+
{
|
|
482
|
+
"name": "tree",
|
|
483
|
+
"description": "The tree holding the rows."
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "item",
|
|
487
|
+
"description": "Every row of the tree."
|
|
488
|
+
}
|
|
489
|
+
]
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"name": "mo-navigation-tree-item",
|
|
493
|
+
"path": ".\\packages\\Navigation\\NavigationTreeItem.ts",
|
|
494
|
+
"description": "A row of a navigation tree: a destination, or a group of them which opens.",
|
|
495
|
+
"attributes": [
|
|
496
|
+
{
|
|
497
|
+
"name": "data-current",
|
|
498
|
+
"description": "Whether this row, or a row nested in it, is the page being shown.",
|
|
499
|
+
"type": "boolean",
|
|
500
|
+
"default": "false"
|
|
501
|
+
},
|
|
502
|
+
{
|
|
503
|
+
"name": "value",
|
|
504
|
+
"description": "What the tree reports this item as. An item without one is not in the tree's `value`.",
|
|
505
|
+
"type": "string | undefined"
|
|
506
|
+
},
|
|
507
|
+
{
|
|
508
|
+
"name": "open",
|
|
509
|
+
"description": "Whether the nested items are shown.",
|
|
510
|
+
"type": "boolean",
|
|
511
|
+
"default": "false"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"name": "selected",
|
|
515
|
+
"description": "Whether the item starts out selected.",
|
|
516
|
+
"type": "boolean",
|
|
517
|
+
"default": "false"
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "disabled",
|
|
521
|
+
"description": "Neither navigable nor selectable.",
|
|
522
|
+
"type": "boolean",
|
|
523
|
+
"default": "false"
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"name": "icon",
|
|
527
|
+
"description": "An icon before the content.",
|
|
528
|
+
"type": "MaterialIcon | undefined"
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "data-separator",
|
|
532
|
+
"description": "Whether a divider parts this row from the one before it."
|
|
533
|
+
}
|
|
534
|
+
],
|
|
535
|
+
"properties": [
|
|
536
|
+
{
|
|
537
|
+
"name": "current",
|
|
538
|
+
"attribute": "data-current",
|
|
539
|
+
"description": "Whether this row, or a row nested in it, is the page being shown.",
|
|
540
|
+
"type": "boolean",
|
|
541
|
+
"default": "false"
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"name": "openChange",
|
|
545
|
+
"type": "EventDispatcher<boolean>"
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "items",
|
|
549
|
+
"description": "The nested items.",
|
|
550
|
+
"type": "TreeItem[]"
|
|
551
|
+
},
|
|
552
|
+
{
|
|
553
|
+
"name": "value",
|
|
554
|
+
"attribute": "value",
|
|
555
|
+
"description": "What the tree reports this item as. An item without one is not in the tree's `value`.",
|
|
556
|
+
"type": "string | undefined"
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "open",
|
|
560
|
+
"attribute": "open",
|
|
561
|
+
"description": "Whether the nested items are shown.",
|
|
562
|
+
"type": "boolean",
|
|
563
|
+
"default": "false"
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "selected",
|
|
567
|
+
"attribute": "selected",
|
|
568
|
+
"description": "Whether the item starts out selected.",
|
|
569
|
+
"type": "boolean",
|
|
570
|
+
"default": "false"
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"name": "disabled",
|
|
574
|
+
"attribute": "disabled",
|
|
575
|
+
"description": "Neither navigable nor selectable.",
|
|
576
|
+
"type": "boolean",
|
|
577
|
+
"default": "false"
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"name": "icon",
|
|
581
|
+
"attribute": "icon",
|
|
582
|
+
"description": "An icon before the content.",
|
|
583
|
+
"type": "MaterialIcon | undefined"
|
|
584
|
+
}
|
|
585
|
+
],
|
|
586
|
+
"events": [
|
|
587
|
+
{
|
|
588
|
+
"name": "openChange",
|
|
589
|
+
"description": "Whether the nested items are shown, whenever that changes. It bubbles, which is how the tree follows its items.",
|
|
590
|
+
"type": "CustomEvent<boolean>"
|
|
591
|
+
}
|
|
592
|
+
],
|
|
593
|
+
"slots": [
|
|
594
|
+
{
|
|
595
|
+
"name": "",
|
|
596
|
+
"description": "The content of the row."
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "start",
|
|
600
|
+
"description": "Placed before the content, in place of the icon."
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"name": "end",
|
|
604
|
+
"description": "Placed after the content."
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"name": "children",
|
|
608
|
+
"description": "The nested items, which a `mo-tree-item` child joins on its own."
|
|
609
|
+
}
|
|
610
|
+
],
|
|
611
|
+
"cssParts": [
|
|
612
|
+
{
|
|
613
|
+
"name": "row",
|
|
614
|
+
"description": "The row: the item without its nested items."
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "indicator",
|
|
618
|
+
"description": "The chevron which opens and closes the row."
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"name": "group",
|
|
622
|
+
"description": "What the nested items sit in, and what slides and fades as the row opens and closes."
|
|
623
|
+
}
|
|
624
|
+
]
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "mo-navigation",
|
|
628
|
+
"path": ".\\packages\\Navigation\\dist\\Navigation.d.ts",
|
|
629
|
+
"description": "The application's shell: a header, the page beside or beneath it, and the navigations presented as\nwhichever of `bar`, `rail` and `drawer` fits.\n\n`presentations` is the order they are preferred in, and the first one which fits is the one shown —\nthe bar as long as its navigations fit its row, the rail as long as the page keeps\n`--mo-navigation-min-content-size` beside it, and the drawer, which always fits. Demoting the bar is\ntherefore a matter of leaving it out of the order rather than of replacing the shell.",
|
|
630
|
+
"attributes": [
|
|
631
|
+
{
|
|
632
|
+
"name": "navigations",
|
|
633
|
+
"description": "The navigations to present.",
|
|
634
|
+
"type": "INavigation[]"
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
"name": "presentations",
|
|
638
|
+
"description": "The presentations to choose from, most preferred first. Defaults to `bar` then `drawer`.",
|
|
639
|
+
"type": "NavigationPresentation[]"
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "presentation",
|
|
643
|
+
"description": "The presentation being shown. Derived, and reflected for styling.",
|
|
644
|
+
"type": "NavigationPresentation"
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
"name": "heading",
|
|
648
|
+
"description": "The application's heading, shown in the header and above the drawer's navigations.",
|
|
649
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
"name": "drawerOpen",
|
|
653
|
+
"description": "Whether the drawer is open. Only of consequence while the drawer is the presentation.",
|
|
654
|
+
"type": "boolean"
|
|
655
|
+
}
|
|
656
|
+
],
|
|
657
|
+
"properties": [
|
|
658
|
+
{
|
|
659
|
+
"name": "navigationBar",
|
|
660
|
+
"type": "NavigationBar | null"
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
"name": "navigationRail",
|
|
664
|
+
"type": "NavigationRail | null"
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "menuButton",
|
|
668
|
+
"type": "HTMLElement | null"
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"name": "navigations",
|
|
672
|
+
"attribute": "navigations",
|
|
673
|
+
"description": "The navigations to present.",
|
|
674
|
+
"type": "INavigation[]"
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"name": "presentations",
|
|
678
|
+
"attribute": "presentations",
|
|
679
|
+
"description": "The presentations to choose from, most preferred first. Defaults to `bar` then `drawer`.",
|
|
680
|
+
"type": "NavigationPresentation[]"
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "presentation",
|
|
684
|
+
"attribute": "presentation",
|
|
685
|
+
"description": "The presentation being shown. Derived, and reflected for styling.",
|
|
686
|
+
"type": "NavigationPresentation"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"name": "heading",
|
|
690
|
+
"attribute": "heading",
|
|
691
|
+
"description": "The application's heading, shown in the header and above the drawer's navigations.",
|
|
692
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"name": "drawerOpen",
|
|
696
|
+
"attribute": "drawerOpen",
|
|
697
|
+
"description": "Whether the drawer is open. Only of consequence while the drawer is the presentation.",
|
|
698
|
+
"type": "boolean"
|
|
699
|
+
}
|
|
700
|
+
],
|
|
701
|
+
"slots": [
|
|
702
|
+
{
|
|
703
|
+
"name": "",
|
|
704
|
+
"description": "The page."
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "logo",
|
|
708
|
+
"description": "Placed at the start of the header, and at the top of the rail."
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"name": "end",
|
|
712
|
+
"description": "Placed at the end of the header."
|
|
713
|
+
}
|
|
714
|
+
],
|
|
715
|
+
"cssProperties": [
|
|
716
|
+
{
|
|
717
|
+
"name": "--mo-navigation-min-content-size",
|
|
718
|
+
"description": "How much room the page keeps beside the rail. Defaults to `32rem`, which puts the rail's threshold at Material's medium window."
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
"name": "--mo-navigation-rail-size",
|
|
722
|
+
"description": "How wide the rail's strip is. Defaults to `5.5rem`."
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"name": "--mo-navigation-rail-panel-size",
|
|
726
|
+
"description": "How wide the rail's panel is. Defaults to `17rem`."
|
|
727
|
+
}
|
|
728
|
+
],
|
|
729
|
+
"cssParts": [
|
|
730
|
+
{
|
|
731
|
+
"name": "app-bar",
|
|
732
|
+
"description": "The header above the page."
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "content",
|
|
736
|
+
"description": "What the page is placed in."
|
|
737
|
+
}
|
|
738
|
+
]
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
"name": "mo-navigation-bar",
|
|
742
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationBar.d.ts",
|
|
743
|
+
"description": "The navigations as a horizontal row, each group opening its destinations as a dropdown.\n\nIt reports through `hasOverflow` whether its navigations still fit, which is what an orchestrating\n`mo-navigation` decides by whether the bar is the presentation it can afford.",
|
|
744
|
+
"attributes": [
|
|
745
|
+
{
|
|
746
|
+
"name": "navigations",
|
|
747
|
+
"description": "The navigations to present.",
|
|
748
|
+
"type": "INavigation[]"
|
|
749
|
+
}
|
|
750
|
+
],
|
|
751
|
+
"properties": [
|
|
752
|
+
{
|
|
753
|
+
"name": "invoke",
|
|
754
|
+
"type": "EventDispatcher<INavigation>"
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"name": "role",
|
|
758
|
+
"type": "\"navigation\"",
|
|
759
|
+
"default": "\"navigation\""
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"name": "items",
|
|
763
|
+
"type": "readonly NavigationBarItem[]"
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"name": "hasOverflow",
|
|
767
|
+
"type": "boolean"
|
|
768
|
+
},
|
|
769
|
+
{
|
|
770
|
+
"name": "navigations",
|
|
771
|
+
"attribute": "navigations",
|
|
772
|
+
"description": "The navigations to present.",
|
|
773
|
+
"type": "INavigation[]"
|
|
774
|
+
}
|
|
775
|
+
],
|
|
776
|
+
"events": [
|
|
777
|
+
{
|
|
778
|
+
"name": "invoke",
|
|
779
|
+
"description": "Dispatched with the navigation which was invoked.",
|
|
780
|
+
"type": "CustomEvent<INavigation>"
|
|
781
|
+
}
|
|
782
|
+
]
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "mo-navigation-bar-item",
|
|
786
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationBarItem.d.ts",
|
|
787
|
+
"description": "A navigation of a navigation bar: a destination, or a group opening its destinations as a dropdown.",
|
|
788
|
+
"attributes": [
|
|
789
|
+
{
|
|
790
|
+
"name": "navigation",
|
|
791
|
+
"description": "The navigation this item stands for.",
|
|
792
|
+
"type": "INavigation"
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "open",
|
|
796
|
+
"description": "Whether the group's dropdown is open.",
|
|
797
|
+
"type": "boolean"
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
"name": "data-current",
|
|
801
|
+
"description": "Whether this navigation, or one nested in it, is the page being shown."
|
|
802
|
+
}
|
|
803
|
+
],
|
|
804
|
+
"properties": [
|
|
805
|
+
{
|
|
806
|
+
"name": "invoke",
|
|
807
|
+
"type": "EventDispatcher<INavigation>"
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"name": "current",
|
|
811
|
+
"type": "boolean"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"name": "tabIndex",
|
|
815
|
+
"type": "number"
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"name": "navigation",
|
|
819
|
+
"attribute": "navigation",
|
|
820
|
+
"description": "The navigation this item stands for.",
|
|
821
|
+
"type": "INavigation"
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"name": "open",
|
|
825
|
+
"attribute": "open",
|
|
826
|
+
"description": "Whether the group's dropdown is open.",
|
|
827
|
+
"type": "boolean"
|
|
828
|
+
}
|
|
829
|
+
],
|
|
830
|
+
"events": [
|
|
831
|
+
{
|
|
832
|
+
"name": "invoke",
|
|
833
|
+
"description": "Dispatched with the destination which was invoked.",
|
|
834
|
+
"type": "CustomEvent<INavigation>"
|
|
835
|
+
}
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "mo-navigation-drawer",
|
|
840
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationDrawer.d.ts",
|
|
841
|
+
"description": "Every navigation as a tree, in a modal drawer over the page.",
|
|
842
|
+
"attributes": [
|
|
843
|
+
{
|
|
844
|
+
"name": "navigations",
|
|
845
|
+
"description": "The navigations to present.",
|
|
846
|
+
"type": "INavigation[]"
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "open",
|
|
850
|
+
"description": "Whether the drawer is open.",
|
|
851
|
+
"type": "boolean"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"name": "heading",
|
|
855
|
+
"description": "Placed above the tree.",
|
|
856
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
857
|
+
}
|
|
858
|
+
],
|
|
859
|
+
"properties": [
|
|
860
|
+
{
|
|
861
|
+
"name": "openChange",
|
|
862
|
+
"type": "EventDispatcher<boolean>"
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"name": "navigations",
|
|
866
|
+
"attribute": "navigations",
|
|
867
|
+
"description": "The navigations to present.",
|
|
868
|
+
"type": "INavigation[]"
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
"name": "open",
|
|
872
|
+
"attribute": "open",
|
|
873
|
+
"description": "Whether the drawer is open.",
|
|
874
|
+
"type": "boolean"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "heading",
|
|
878
|
+
"attribute": "heading",
|
|
879
|
+
"description": "Placed above the tree.",
|
|
880
|
+
"type": "string | HTMLTemplateResult | undefined"
|
|
881
|
+
}
|
|
882
|
+
],
|
|
883
|
+
"events": [
|
|
884
|
+
{
|
|
885
|
+
"name": "openChange",
|
|
886
|
+
"description": "Dispatched with the new state whenever the drawer opens or closes.",
|
|
887
|
+
"type": "CustomEvent<boolean>"
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
"name": "invoke",
|
|
891
|
+
"description": "Dispatched with the destination which was invoked, on its way up from the tree.",
|
|
892
|
+
"type": "CustomEvent"
|
|
893
|
+
}
|
|
894
|
+
],
|
|
895
|
+
"cssProperties": [
|
|
896
|
+
{
|
|
897
|
+
"name": "--mo-navigation-drawer-width",
|
|
898
|
+
"description": "How wide the drawer is. Defaults to `292px`."
|
|
899
|
+
}
|
|
900
|
+
]
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"name": "mo-navigation-rail",
|
|
904
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationRail.d.ts",
|
|
905
|
+
"description": "The navigations as a vertical strip at the leading edge, each one an icon with its label beneath it.\n\nA group's destinations are shown in a panel beside the strip: docked next to the page while there is\nroom for both, and overlaid over the page while there is not.",
|
|
906
|
+
"attributes": [
|
|
907
|
+
{
|
|
908
|
+
"name": "navigations",
|
|
909
|
+
"description": "The navigations to present.",
|
|
910
|
+
"type": "INavigation[]"
|
|
911
|
+
},
|
|
912
|
+
{
|
|
913
|
+
"name": "docked",
|
|
914
|
+
"description": "Whether the panel stands beside the page rather than over it.",
|
|
915
|
+
"type": "boolean"
|
|
916
|
+
}
|
|
917
|
+
],
|
|
918
|
+
"properties": [
|
|
919
|
+
{
|
|
920
|
+
"name": "invoke",
|
|
921
|
+
"type": "EventDispatcher<INavigation>"
|
|
922
|
+
},
|
|
923
|
+
{
|
|
924
|
+
"name": "items",
|
|
925
|
+
"type": "NavigationRailItem[]"
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"name": "shownNavigation",
|
|
929
|
+
"description": "The navigation whose destinations the panel shows.",
|
|
930
|
+
"type": "INavigation | undefined"
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"name": "navigations",
|
|
934
|
+
"attribute": "navigations",
|
|
935
|
+
"description": "The navigations to present.",
|
|
936
|
+
"type": "INavigation[]"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "docked",
|
|
940
|
+
"attribute": "docked",
|
|
941
|
+
"description": "Whether the panel stands beside the page rather than over it.",
|
|
942
|
+
"type": "boolean"
|
|
943
|
+
}
|
|
944
|
+
],
|
|
945
|
+
"events": [
|
|
946
|
+
{
|
|
947
|
+
"name": "invoke",
|
|
948
|
+
"description": "Dispatched with the destination which was invoked.",
|
|
949
|
+
"type": "CustomEvent<INavigation>"
|
|
950
|
+
}
|
|
951
|
+
],
|
|
952
|
+
"slots": [
|
|
953
|
+
{
|
|
954
|
+
"name": "header",
|
|
955
|
+
"description": "Placed above the navigations, e.g. a logo or a button which creates something."
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
"name": "footer",
|
|
959
|
+
"description": "Placed below the navigations."
|
|
960
|
+
}
|
|
961
|
+
],
|
|
962
|
+
"cssProperties": [
|
|
963
|
+
{
|
|
964
|
+
"name": "--mo-navigation-rail-size",
|
|
965
|
+
"description": "How wide the strip is. Defaults to `5.5rem`."
|
|
966
|
+
},
|
|
967
|
+
{
|
|
968
|
+
"name": "--mo-navigation-rail-panel-size",
|
|
969
|
+
"description": "How wide the panel is. Defaults to `17rem`."
|
|
970
|
+
}
|
|
971
|
+
],
|
|
972
|
+
"cssParts": [
|
|
973
|
+
{
|
|
974
|
+
"name": "strip",
|
|
975
|
+
"description": "The strip of navigations."
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "panel",
|
|
979
|
+
"description": "The panel holding the destinations of the navigation being shown."
|
|
980
|
+
}
|
|
981
|
+
]
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "mo-navigation-rail-item",
|
|
985
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationRailItem.d.ts",
|
|
986
|
+
"description": "A navigation of a navigation rail: an icon with its label beneath it.",
|
|
987
|
+
"attributes": [
|
|
988
|
+
{
|
|
989
|
+
"name": "navigation",
|
|
990
|
+
"description": "The navigation this item stands for.",
|
|
991
|
+
"type": "INavigation"
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"name": "selected",
|
|
995
|
+
"description": "Whether the rail is showing this navigation's destinations.",
|
|
996
|
+
"type": "boolean"
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"name": "data-current",
|
|
1000
|
+
"description": "Whether this navigation, or one nested in it, is the page being shown."
|
|
1001
|
+
}
|
|
1002
|
+
],
|
|
1003
|
+
"properties": [
|
|
1004
|
+
{
|
|
1005
|
+
"name": "current",
|
|
1006
|
+
"type": "boolean"
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
"name": "tabIndex",
|
|
1010
|
+
"type": "number"
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"name": "navigation",
|
|
1014
|
+
"attribute": "navigation",
|
|
1015
|
+
"description": "The navigation this item stands for.",
|
|
1016
|
+
"type": "INavigation"
|
|
1017
|
+
},
|
|
1018
|
+
{
|
|
1019
|
+
"name": "selected",
|
|
1020
|
+
"attribute": "selected",
|
|
1021
|
+
"description": "Whether the rail is showing this navigation's destinations.",
|
|
1022
|
+
"type": "boolean"
|
|
1023
|
+
}
|
|
1024
|
+
],
|
|
1025
|
+
"cssParts": [
|
|
1026
|
+
{
|
|
1027
|
+
"name": "indicator",
|
|
1028
|
+
"description": "The shape behind the icon, which marks the navigation the page belongs to."
|
|
1029
|
+
},
|
|
1030
|
+
{
|
|
1031
|
+
"name": "label",
|
|
1032
|
+
"description": "The label beneath the icon."
|
|
1033
|
+
}
|
|
1034
|
+
]
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"name": "mo-navigation-tree",
|
|
1038
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationTree.d.ts",
|
|
1039
|
+
"description": "The navigations as a tree of rows: a group is a row which opens, a destination is a row which navigates.\nThe row of the page being shown is revealed, so that a deep destination is on screen right away.",
|
|
1040
|
+
"attributes": [
|
|
1041
|
+
{
|
|
1042
|
+
"name": "navigations",
|
|
1043
|
+
"description": "The navigations to present.",
|
|
1044
|
+
"type": "INavigation[]"
|
|
1045
|
+
}
|
|
1046
|
+
],
|
|
1047
|
+
"properties": [
|
|
1048
|
+
{
|
|
1049
|
+
"name": "invoke",
|
|
1050
|
+
"type": "EventDispatcher<INavigation>"
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "navigations",
|
|
1054
|
+
"attribute": "navigations",
|
|
1055
|
+
"description": "The navigations to present.",
|
|
1056
|
+
"type": "INavigation[]"
|
|
1057
|
+
}
|
|
1058
|
+
],
|
|
1059
|
+
"events": [
|
|
1060
|
+
{
|
|
1061
|
+
"name": "invoke",
|
|
1062
|
+
"description": "Dispatched with the destination which was invoked.",
|
|
1063
|
+
"type": "CustomEvent<INavigation>"
|
|
1064
|
+
}
|
|
1065
|
+
],
|
|
1066
|
+
"cssParts": [
|
|
1067
|
+
{
|
|
1068
|
+
"name": "tree",
|
|
1069
|
+
"description": "The tree holding the rows."
|
|
1070
|
+
},
|
|
1071
|
+
{
|
|
1072
|
+
"name": "item",
|
|
1073
|
+
"description": "Every row of the tree."
|
|
1074
|
+
}
|
|
1075
|
+
]
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
"name": "mo-navigation-tree-item",
|
|
1079
|
+
"path": ".\\packages\\Navigation\\dist\\NavigationTreeItem.d.ts",
|
|
1080
|
+
"description": "A row of a navigation tree: a destination, or a group of them which opens.",
|
|
1081
|
+
"attributes": [
|
|
1082
|
+
{
|
|
1083
|
+
"name": "value",
|
|
1084
|
+
"description": "What the tree reports this item as. An item without one is not in the tree's `value`.",
|
|
1085
|
+
"type": "string | undefined"
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"name": "open",
|
|
1089
|
+
"description": "Whether the nested items are shown.",
|
|
1090
|
+
"type": "boolean",
|
|
1091
|
+
"default": "false"
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"name": "selected",
|
|
1095
|
+
"description": "Whether the item starts out selected.",
|
|
1096
|
+
"type": "boolean",
|
|
1097
|
+
"default": "false"
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"name": "disabled",
|
|
1101
|
+
"description": "Neither navigable nor selectable.",
|
|
1102
|
+
"type": "boolean",
|
|
1103
|
+
"default": "false"
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"name": "icon",
|
|
1107
|
+
"description": "An icon before the content.",
|
|
1108
|
+
"type": "MaterialIcon | undefined"
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"name": "data-current",
|
|
1112
|
+
"description": "Whether this row, or a row nested in it, is the page being shown."
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
"name": "data-separator",
|
|
1116
|
+
"description": "Whether a divider parts this row from the one before it."
|
|
1117
|
+
}
|
|
1118
|
+
],
|
|
1119
|
+
"properties": [
|
|
1120
|
+
{
|
|
1121
|
+
"name": "current",
|
|
1122
|
+
"type": "boolean"
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "openChange",
|
|
1126
|
+
"type": "EventDispatcher<boolean>"
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"name": "items",
|
|
1130
|
+
"description": "The nested items.",
|
|
1131
|
+
"type": "TreeItem[]"
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
"name": "value",
|
|
1135
|
+
"attribute": "value",
|
|
1136
|
+
"description": "What the tree reports this item as. An item without one is not in the tree's `value`.",
|
|
1137
|
+
"type": "string | undefined"
|
|
1138
|
+
},
|
|
1139
|
+
{
|
|
1140
|
+
"name": "open",
|
|
1141
|
+
"attribute": "open",
|
|
1142
|
+
"description": "Whether the nested items are shown.",
|
|
1143
|
+
"type": "boolean",
|
|
1144
|
+
"default": "false"
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"name": "selected",
|
|
1148
|
+
"attribute": "selected",
|
|
1149
|
+
"description": "Whether the item starts out selected.",
|
|
1150
|
+
"type": "boolean",
|
|
1151
|
+
"default": "false"
|
|
1152
|
+
},
|
|
1153
|
+
{
|
|
1154
|
+
"name": "disabled",
|
|
1155
|
+
"attribute": "disabled",
|
|
1156
|
+
"description": "Neither navigable nor selectable.",
|
|
1157
|
+
"type": "boolean",
|
|
1158
|
+
"default": "false"
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "icon",
|
|
1162
|
+
"attribute": "icon",
|
|
1163
|
+
"description": "An icon before the content.",
|
|
1164
|
+
"type": "MaterialIcon | undefined"
|
|
1165
|
+
}
|
|
1166
|
+
],
|
|
1167
|
+
"events": [
|
|
1168
|
+
{
|
|
1169
|
+
"name": "openChange",
|
|
1170
|
+
"description": "Whether the nested items are shown, whenever that changes. It bubbles, which is how the tree follows its items.",
|
|
1171
|
+
"type": "CustomEvent<boolean>"
|
|
1172
|
+
}
|
|
1173
|
+
],
|
|
1174
|
+
"slots": [
|
|
1175
|
+
{
|
|
1176
|
+
"name": "",
|
|
1177
|
+
"description": "The content of the row."
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
"name": "start",
|
|
1181
|
+
"description": "Placed before the content, in place of the icon."
|
|
1182
|
+
},
|
|
1183
|
+
{
|
|
1184
|
+
"name": "end",
|
|
1185
|
+
"description": "Placed after the content."
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"name": "children",
|
|
1189
|
+
"description": "The nested items, which a `mo-tree-item` child joins on its own."
|
|
1190
|
+
}
|
|
1191
|
+
],
|
|
1192
|
+
"cssParts": [
|
|
1193
|
+
{
|
|
1194
|
+
"name": "row",
|
|
1195
|
+
"description": "The row: the item without its nested items."
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"name": "indicator",
|
|
1199
|
+
"description": "The chevron which opens and closes the row."
|
|
1200
|
+
},
|
|
1201
|
+
{
|
|
1202
|
+
"name": "group",
|
|
1203
|
+
"description": "What the nested items sit in, and what slides and fades as the row opens and closes."
|
|
1204
|
+
}
|
|
1205
|
+
]
|
|
1206
|
+
}
|
|
1207
|
+
]
|
|
1208
|
+
}
|