@spectrum-web-components/breadcrumbs 1.2.0-beta.0 → 1.2.0-beta.2

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.
@@ -0,0 +1,498 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "sp-breadcrumb-item.js",
8
+ "declarations": [],
9
+ "exports": [
10
+ {
11
+ "kind": "custom-element-definition",
12
+ "name": "sp-breadcrumb-item",
13
+ "declaration": {
14
+ "name": "BreadcrumbItem",
15
+ "module": "/src/BreadcrumbItem.js"
16
+ }
17
+ }
18
+ ]
19
+ },
20
+ {
21
+ "kind": "javascript-module",
22
+ "path": "sp-breadcrumbs.js",
23
+ "declarations": [],
24
+ "exports": [
25
+ {
26
+ "kind": "custom-element-definition",
27
+ "name": "sp-breadcrumbs",
28
+ "declaration": {
29
+ "name": "Breadcrumbs",
30
+ "module": "/src/Breadcrumbs.js"
31
+ }
32
+ }
33
+ ]
34
+ },
35
+ {
36
+ "kind": "javascript-module",
37
+ "path": "src/BreadcrumbItem.js",
38
+ "declarations": [
39
+ {
40
+ "kind": "class",
41
+ "description": "",
42
+ "name": "BreadcrumbItem",
43
+ "members": [
44
+ {
45
+ "kind": "field",
46
+ "name": "value",
47
+ "type": {
48
+ "text": "string | undefined"
49
+ },
50
+ "privacy": "public",
51
+ "default": "undefined",
52
+ "attribute": "value"
53
+ },
54
+ {
55
+ "kind": "field",
56
+ "name": "isLastOfType",
57
+ "type": {
58
+ "text": "boolean"
59
+ },
60
+ "privacy": "private",
61
+ "default": "false",
62
+ "attribute": "isLastOfType"
63
+ },
64
+ {
65
+ "kind": "field",
66
+ "name": "focusElement",
67
+ "type": {
68
+ "text": "HTMLElement"
69
+ },
70
+ "privacy": "public",
71
+ "readonly": true
72
+ },
73
+ {
74
+ "kind": "method",
75
+ "name": "announceSelected",
76
+ "privacy": "private",
77
+ "return": {
78
+ "type": {
79
+ "text": "void"
80
+ }
81
+ },
82
+ "parameters": [
83
+ {
84
+ "name": "value",
85
+ "type": {
86
+ "text": "string"
87
+ }
88
+ }
89
+ ]
90
+ },
91
+ {
92
+ "kind": "method",
93
+ "name": "handleClick",
94
+ "privacy": "protected",
95
+ "return": {
96
+ "type": {
97
+ "text": "void"
98
+ }
99
+ },
100
+ "parameters": [
101
+ {
102
+ "name": "event",
103
+ "optional": true,
104
+ "type": {
105
+ "text": "Event"
106
+ }
107
+ }
108
+ ]
109
+ },
110
+ {
111
+ "kind": "method",
112
+ "name": "handleKeyDown",
113
+ "privacy": "protected",
114
+ "return": {
115
+ "type": {
116
+ "text": "void"
117
+ }
118
+ },
119
+ "parameters": [
120
+ {
121
+ "name": "event",
122
+ "type": {
123
+ "text": "KeyboardEvent"
124
+ }
125
+ }
126
+ ]
127
+ },
128
+ {
129
+ "kind": "method",
130
+ "name": "renderLink",
131
+ "privacy": "protected",
132
+ "return": {
133
+ "type": {
134
+ "text": "TemplateResult"
135
+ }
136
+ }
137
+ },
138
+ {
139
+ "kind": "method",
140
+ "name": "renderSeparator",
141
+ "privacy": "private",
142
+ "return": {
143
+ "type": {
144
+ "text": "TemplateResult"
145
+ }
146
+ }
147
+ }
148
+ ],
149
+ "attributes": [
150
+ {
151
+ "name": "value",
152
+ "type": {
153
+ "text": "string | undefined"
154
+ },
155
+ "default": "undefined",
156
+ "fieldName": "value"
157
+ },
158
+ {
159
+ "name": "isLastOfType",
160
+ "type": {
161
+ "text": "boolean"
162
+ },
163
+ "default": "false",
164
+ "fieldName": "isLastOfType"
165
+ }
166
+ ],
167
+ "mixins": [
168
+ {
169
+ "name": "LikeAnchor",
170
+ "package": "@spectrum-web-components/shared/src/like-anchor.js"
171
+ }
172
+ ],
173
+ "superclass": {
174
+ "name": "Focusable",
175
+ "package": "@spectrum-web-components/shared/src/focusable.js"
176
+ },
177
+ "tagName": "sp-breadcrumb-item",
178
+ "customElement": true
179
+ }
180
+ ],
181
+ "exports": [
182
+ {
183
+ "kind": "js",
184
+ "name": "BreadcrumbItem",
185
+ "declaration": {
186
+ "name": "BreadcrumbItem",
187
+ "module": "src/BreadcrumbItem.js"
188
+ }
189
+ }
190
+ ]
191
+ },
192
+ {
193
+ "kind": "javascript-module",
194
+ "path": "src/Breadcrumbs.js",
195
+ "declarations": [
196
+ {
197
+ "kind": "class",
198
+ "description": "",
199
+ "name": "Breadcrumbs",
200
+ "slots": [
201
+ {
202
+ "description": "change the default icon of the action menu",
203
+ "name": "icon"
204
+ },
205
+ {
206
+ "description": "Breadcrumb item to always display",
207
+ "name": "root"
208
+ },
209
+ {
210
+ "description": "Breadcrumb items",
211
+ "name": ""
212
+ }
213
+ ],
214
+ "members": [
215
+ {
216
+ "kind": "field",
217
+ "name": "maxVisibleItems",
218
+ "type": {
219
+ "text": "number"
220
+ },
221
+ "privacy": "public",
222
+ "default": "4",
223
+ "description": "Override the maximum number of visible items",
224
+ "attribute": "max-visible-items"
225
+ },
226
+ {
227
+ "kind": "field",
228
+ "name": "label",
229
+ "type": {
230
+ "text": "string"
231
+ },
232
+ "privacy": "public",
233
+ "default": "''",
234
+ "description": "Accessible name for the Breadcrumbs component",
235
+ "attribute": "label"
236
+ },
237
+ {
238
+ "kind": "field",
239
+ "name": "menuLabel",
240
+ "type": {
241
+ "text": "string"
242
+ },
243
+ "privacy": "public",
244
+ "default": "'More items'",
245
+ "description": "Change the default label of the action menu",
246
+ "attribute": "menu-label"
247
+ },
248
+ {
249
+ "kind": "field",
250
+ "name": "compact",
251
+ "type": {
252
+ "text": "boolean"
253
+ },
254
+ "privacy": "public",
255
+ "default": "false",
256
+ "description": "compact option is useful for reducing the height of the breadcrumbs",
257
+ "attribute": "compact"
258
+ },
259
+ {
260
+ "kind": "field",
261
+ "name": "breadcrumbsElements",
262
+ "type": {
263
+ "text": "BreadcrumbElement[]"
264
+ },
265
+ "privacy": "private"
266
+ },
267
+ {
268
+ "kind": "field",
269
+ "name": "rootElement",
270
+ "type": {
271
+ "text": "BreadcrumbElement[]"
272
+ },
273
+ "privacy": "private"
274
+ },
275
+ {
276
+ "kind": "field",
277
+ "name": "list",
278
+ "type": {
279
+ "text": "HTMLUListElement"
280
+ },
281
+ "privacy": "private"
282
+ },
283
+ {
284
+ "kind": "field",
285
+ "name": "items",
286
+ "type": {
287
+ "text": "BreadcrumbItem[]"
288
+ },
289
+ "privacy": "private",
290
+ "default": "[]"
291
+ },
292
+ {
293
+ "kind": "field",
294
+ "name": "visibleItems",
295
+ "type": {
296
+ "text": "number"
297
+ },
298
+ "privacy": "private",
299
+ "default": "0"
300
+ },
301
+ {
302
+ "kind": "field",
303
+ "name": "resizeObserver",
304
+ "type": {
305
+ "text": "ResizeObserver | undefined"
306
+ },
307
+ "privacy": "private"
308
+ },
309
+ {
310
+ "kind": "field",
311
+ "name": "firstRender",
312
+ "type": {
313
+ "text": "boolean"
314
+ },
315
+ "privacy": "private",
316
+ "default": "true"
317
+ },
318
+ {
319
+ "kind": "field",
320
+ "name": "menuRef",
321
+ "type": {
322
+ "text": "Ref<ActionMenu>"
323
+ },
324
+ "privacy": "private"
325
+ },
326
+ {
327
+ "kind": "field",
328
+ "name": "hasMenu",
329
+ "type": {
330
+ "text": "boolean"
331
+ },
332
+ "privacy": "private",
333
+ "readonly": true
334
+ },
335
+ {
336
+ "kind": "method",
337
+ "name": "calculateBreadcrumbItemsWidth",
338
+ "privacy": "private",
339
+ "return": {
340
+ "type": {
341
+ "text": "void"
342
+ }
343
+ },
344
+ "description": "We need to understand how much space (px) each breadcrumb item occupies,\nin order to know if it fits the available horizontal space."
345
+ },
346
+ {
347
+ "kind": "method",
348
+ "name": "adjustOverflow",
349
+ "privacy": "private",
350
+ "return": {
351
+ "type": {
352
+ "text": "void"
353
+ }
354
+ },
355
+ "description": "Calculate which breadcrumbs fit in the viewport, and which should be hidden."
356
+ },
357
+ {
358
+ "kind": "method",
359
+ "name": "announceChange",
360
+ "privacy": "private",
361
+ "return": {
362
+ "type": {
363
+ "text": "void"
364
+ }
365
+ },
366
+ "parameters": [
367
+ {
368
+ "name": "value",
369
+ "type": {
370
+ "text": "string"
371
+ }
372
+ }
373
+ ]
374
+ },
375
+ {
376
+ "kind": "method",
377
+ "name": "handleSelect",
378
+ "privacy": "private",
379
+ "return": {
380
+ "type": {
381
+ "text": "void"
382
+ }
383
+ },
384
+ "parameters": [
385
+ {
386
+ "name": "event",
387
+ "type": {
388
+ "text": "CustomEvent<BreadcrumbSelectDetail> & { target: BreadcrumbItem }"
389
+ }
390
+ }
391
+ ]
392
+ },
393
+ {
394
+ "kind": "method",
395
+ "name": "handleMenuChange",
396
+ "privacy": "private",
397
+ "return": {
398
+ "type": {
399
+ "text": "void"
400
+ }
401
+ },
402
+ "parameters": [
403
+ {
404
+ "name": "event",
405
+ "type": {
406
+ "text": "Event & { target: ActionMenu }"
407
+ }
408
+ }
409
+ ]
410
+ },
411
+ {
412
+ "kind": "method",
413
+ "name": "renderMenu",
414
+ "privacy": "protected",
415
+ "return": {
416
+ "type": {
417
+ "text": "TemplateResult"
418
+ }
419
+ },
420
+ "description": "The truncation menu when there is not enough space to display all the breadcrumbs.\nIt displays all options within a breadcrumb.\nItems are listed with the hierarchy ordered from top (root) to bottom\nand include the currently selected item."
421
+ },
422
+ {
423
+ "kind": "method",
424
+ "name": "slotChangeHandler",
425
+ "privacy": "private",
426
+ "return": {
427
+ "type": {
428
+ "text": "Promise<void>"
429
+ }
430
+ },
431
+ "description": "Breadcrumbs were added / removed, we need to recalculate the width of each item\nand adjust the overflow accordingly."
432
+ }
433
+ ],
434
+ "events": [
435
+ {
436
+ "description": "Announces the selected breadcrumb item",
437
+ "name": "change"
438
+ }
439
+ ],
440
+ "attributes": [
441
+ {
442
+ "name": "max-visible-items",
443
+ "type": {
444
+ "text": "number"
445
+ },
446
+ "default": "4",
447
+ "description": "Override the maximum number of visible items",
448
+ "fieldName": "maxVisibleItems"
449
+ },
450
+ {
451
+ "name": "label",
452
+ "type": {
453
+ "text": "string"
454
+ },
455
+ "default": "''",
456
+ "description": "Accessible name for the Breadcrumbs component",
457
+ "fieldName": "label"
458
+ },
459
+ {
460
+ "name": "menu-label",
461
+ "type": {
462
+ "text": "string"
463
+ },
464
+ "default": "'More items'",
465
+ "description": "Change the default label of the action menu",
466
+ "fieldName": "menuLabel"
467
+ },
468
+ {
469
+ "name": "compact",
470
+ "type": {
471
+ "text": "boolean"
472
+ },
473
+ "default": "false",
474
+ "description": "compact option is useful for reducing the height of the breadcrumbs",
475
+ "fieldName": "compact"
476
+ }
477
+ ],
478
+ "superclass": {
479
+ "name": "SpectrumElement",
480
+ "package": "@spectrum-web-components/base"
481
+ },
482
+ "tagName": "sp-breadcrumbs",
483
+ "customElement": true
484
+ }
485
+ ],
486
+ "exports": [
487
+ {
488
+ "kind": "js",
489
+ "name": "Breadcrumbs",
490
+ "declaration": {
491
+ "name": "Breadcrumbs",
492
+ "module": "src/Breadcrumbs.js"
493
+ }
494
+ }
495
+ ]
496
+ }
497
+ ]
498
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spectrum-web-components/breadcrumbs",
3
- "version": "1.2.0-beta.0",
3
+ "version": "1.2.0-beta.2",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -67,11 +67,11 @@
67
67
  "lit-html"
68
68
  ],
69
69
  "dependencies": {
70
- "@spectrum-web-components/action-menu": "^1.2.0-beta.0",
71
- "@spectrum-web-components/base": "^1.2.0-beta.0",
72
- "@spectrum-web-components/icons-workflow": "^1.2.0-beta.0",
73
- "@spectrum-web-components/link": "^1.2.0-beta.0",
74
- "@spectrum-web-components/menu": "^1.2.0-beta.0"
70
+ "@spectrum-web-components/action-menu": "^1.2.0-beta.2",
71
+ "@spectrum-web-components/base": "^1.2.0-beta.2",
72
+ "@spectrum-web-components/icons-workflow": "^1.2.0-beta.2",
73
+ "@spectrum-web-components/link": "^1.2.0-beta.2",
74
+ "@spectrum-web-components/menu": "^1.2.0-beta.2"
75
75
  },
76
76
  "devDependencies": {
77
77
  "@spectrum-css/breadcrumb": "10.0.0-s2-foundations.15"
@@ -82,5 +82,5 @@
82
82
  "./sp-*.js",
83
83
  "./**/*.dev.js"
84
84
  ],
85
- "gitHead": "809bd734313fe289067108bf1dea2a48cc103a9f"
85
+ "gitHead": "c0c67a3bdce0642f6a60d11a62fdcb6c1909ca62"
86
86
  }