@m3e/fab-menu 1.0.0-rc.1

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,687 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "src/FabMenuElement.ts",
8
+ "declarations": [
9
+ {
10
+ "kind": "class",
11
+ "description": "",
12
+ "name": "M3eFabMenuElement",
13
+ "cssProperties": [
14
+ {
15
+ "description": "Vertical gap between menu items.",
16
+ "name": "--m3e-fab-menu-spacing"
17
+ },
18
+ {
19
+ "description": "Maximum width of the menu.",
20
+ "name": "--m3e-fab-menu-max-width"
21
+ },
22
+ {
23
+ "description": "Foreground color for primary variant items.",
24
+ "name": "--m3e-primary-fab-color"
25
+ },
26
+ {
27
+ "description": "Container color for primary variant items.",
28
+ "name": "--m3e-primary-fab-container-color"
29
+ },
30
+ {
31
+ "description": "Hover background color for primary variant items.",
32
+ "name": "--m3e-primary-fab-hover-color"
33
+ },
34
+ {
35
+ "description": "Focus background color for primary variant items.",
36
+ "name": "--m3e-primary-fab-focus-color"
37
+ },
38
+ {
39
+ "description": "Ripple color for primary variant items.",
40
+ "name": "--m3e-primary-fab-ripple-color"
41
+ },
42
+ {
43
+ "description": "Foreground color for secondary variant items.",
44
+ "name": "--m3e-secondary-fab-color"
45
+ },
46
+ {
47
+ "description": "Container color for secondary variant items.",
48
+ "name": "--m3e-secondary-fab-container-color"
49
+ },
50
+ {
51
+ "description": "Hover background color for secondary variant items.",
52
+ "name": "--m3e-secondary-fab-hover-color"
53
+ },
54
+ {
55
+ "description": "Focus background color for secondary variant items.",
56
+ "name": "--m3e-secondary-fab-focus-color"
57
+ },
58
+ {
59
+ "description": "Ripple color for secondary variant items.",
60
+ "name": "--m3e-secondary-fab-ripple-color"
61
+ },
62
+ {
63
+ "description": "Foreground color for tertiary variant items.",
64
+ "name": "--m3e-tertiary-fab-color"
65
+ },
66
+ {
67
+ "description": "Container color for tertiary variant items.",
68
+ "name": "--m3e-tertiary-fab-container-color"
69
+ },
70
+ {
71
+ "description": "Hover background color for tertiary variant items.",
72
+ "name": "--m3e-tertiary-fab-hover-color"
73
+ },
74
+ {
75
+ "description": "Focus background color for tertiary variant items.",
76
+ "name": "--m3e-tertiary-fab-focus-color"
77
+ },
78
+ {
79
+ "description": "Ripple color for tertiary variant items.",
80
+ "name": "--m3e-tertiary-fab-ripple-color"
81
+ }
82
+ ],
83
+ "slots": [
84
+ {
85
+ "description": "Renders the contents of the menu.",
86
+ "name": ""
87
+ }
88
+ ],
89
+ "members": [
90
+ {
91
+ "kind": "field",
92
+ "name": "#fabTabIndex",
93
+ "privacy": "private",
94
+ "type": {
95
+ "text": "number | undefined"
96
+ }
97
+ },
98
+ {
99
+ "kind": "field",
100
+ "name": "#trigger",
101
+ "privacy": "private",
102
+ "type": {
103
+ "text": "HTMLElement | undefined"
104
+ }
105
+ },
106
+ {
107
+ "kind": "field",
108
+ "name": "#anchoringCleanup",
109
+ "privacy": "private",
110
+ "type": {
111
+ "text": "() => void | undefined"
112
+ }
113
+ },
114
+ {
115
+ "kind": "field",
116
+ "name": "#listManager",
117
+ "privacy": "private",
118
+ "readonly": true
119
+ },
120
+ {
121
+ "kind": "field",
122
+ "name": "#keyDownHandler",
123
+ "privacy": "private",
124
+ "readonly": true
125
+ },
126
+ {
127
+ "kind": "field",
128
+ "name": "#documentClickHandler",
129
+ "privacy": "private",
130
+ "readonly": true
131
+ },
132
+ {
133
+ "kind": "field",
134
+ "name": "#scrollController",
135
+ "privacy": "private",
136
+ "readonly": true,
137
+ "default": "new ScrollController(this, { target: null, callback: () => this.hide() })"
138
+ },
139
+ {
140
+ "kind": "field",
141
+ "name": "#toggleHandler",
142
+ "privacy": "private",
143
+ "readonly": true
144
+ },
145
+ {
146
+ "kind": "field",
147
+ "name": "variant",
148
+ "type": {
149
+ "text": "FabMenuVariant"
150
+ },
151
+ "default": "\"primary\"",
152
+ "description": "The appearance variant of the menu.",
153
+ "attribute": "variant",
154
+ "reflects": true
155
+ },
156
+ {
157
+ "kind": "field",
158
+ "name": "isOpen",
159
+ "description": "Whether the menu is open.",
160
+ "readonly": true
161
+ },
162
+ {
163
+ "kind": "method",
164
+ "name": "show",
165
+ "return": {
166
+ "type": {
167
+ "text": "Promise<void>"
168
+ }
169
+ },
170
+ "parameters": [
171
+ {
172
+ "name": "trigger",
173
+ "type": {
174
+ "text": "HTMLElement"
175
+ },
176
+ "description": "The element that triggered the menu."
177
+ }
178
+ ],
179
+ "description": "Opens the menu."
180
+ },
181
+ {
182
+ "kind": "method",
183
+ "name": "hide",
184
+ "return": {
185
+ "type": {
186
+ "text": "void"
187
+ }
188
+ },
189
+ "parameters": [
190
+ {
191
+ "name": "restoreFocus",
192
+ "default": "false",
193
+ "type": {
194
+ "text": "boolean"
195
+ },
196
+ "description": "A value indicating whether to restore focus to the menu's trigger.",
197
+ "optional": true
198
+ }
199
+ ],
200
+ "description": "Hides the menu."
201
+ },
202
+ {
203
+ "kind": "method",
204
+ "name": "toggle",
205
+ "return": {
206
+ "type": {
207
+ "text": "Promise<void>"
208
+ }
209
+ },
210
+ "parameters": [
211
+ {
212
+ "name": "trigger",
213
+ "type": {
214
+ "text": "HTMLElement"
215
+ },
216
+ "description": "The element that triggered the menu."
217
+ }
218
+ ],
219
+ "description": "Toggles the menu."
220
+ },
221
+ {
222
+ "kind": "method",
223
+ "name": "#handleSlotChange",
224
+ "privacy": "private",
225
+ "return": {
226
+ "type": {
227
+ "text": "void"
228
+ }
229
+ }
230
+ },
231
+ {
232
+ "kind": "method",
233
+ "name": "#handleKeyDown",
234
+ "privacy": "private",
235
+ "return": {
236
+ "type": {
237
+ "text": "void"
238
+ }
239
+ },
240
+ "parameters": [
241
+ {
242
+ "name": "e",
243
+ "type": {
244
+ "text": "KeyboardEvent"
245
+ }
246
+ }
247
+ ]
248
+ },
249
+ {
250
+ "kind": "method",
251
+ "name": "#handleDocumentClick",
252
+ "privacy": "private",
253
+ "return": {
254
+ "type": {
255
+ "text": "void"
256
+ }
257
+ },
258
+ "parameters": [
259
+ {
260
+ "name": "e",
261
+ "type": {
262
+ "text": "MouseEvent"
263
+ }
264
+ }
265
+ ]
266
+ },
267
+ {
268
+ "kind": "method",
269
+ "name": "#attachFab",
270
+ "privacy": "private",
271
+ "return": {
272
+ "type": {
273
+ "text": "void"
274
+ }
275
+ }
276
+ },
277
+ {
278
+ "kind": "method",
279
+ "name": "#detachFab",
280
+ "privacy": "private",
281
+ "return": {
282
+ "type": {
283
+ "text": "void"
284
+ }
285
+ }
286
+ }
287
+ ],
288
+ "attributes": [
289
+ {
290
+ "description": "The appearance variant of the menu.",
291
+ "name": "variant",
292
+ "type": {
293
+ "text": "FabMenuVariant"
294
+ },
295
+ "default": "\"primary\"",
296
+ "fieldName": "variant"
297
+ }
298
+ ],
299
+ "mixins": [
300
+ {
301
+ "name": "Role",
302
+ "package": "@m3e/core"
303
+ }
304
+ ],
305
+ "superclass": {
306
+ "name": "LitElement",
307
+ "package": "lit"
308
+ },
309
+ "tagName": "m3e-fab-menu",
310
+ "customElement": true,
311
+ "summary": "A menu, opened from a floating action button (FAB), used to display multiple related actions."
312
+ }
313
+ ],
314
+ "exports": [
315
+ {
316
+ "kind": "js",
317
+ "name": "M3eFabMenuElement",
318
+ "declaration": {
319
+ "name": "M3eFabMenuElement",
320
+ "module": "src/FabMenuElement.ts"
321
+ }
322
+ },
323
+ {
324
+ "kind": "custom-element-definition",
325
+ "name": "m3e-fab-menu",
326
+ "declaration": {
327
+ "name": "M3eFabMenuElement",
328
+ "module": "src/FabMenuElement.ts"
329
+ }
330
+ }
331
+ ]
332
+ },
333
+ {
334
+ "kind": "javascript-module",
335
+ "path": "src/FabMenuItemElement.ts",
336
+ "declarations": [
337
+ {
338
+ "kind": "class",
339
+ "description": "An item of a floating action button (FAB) menu.",
340
+ "name": "M3eFabMenuItemElement",
341
+ "cssProperties": [
342
+ {
343
+ "description": "Height of the menu item.",
344
+ "name": "--m3e-fab-menu-item-height"
345
+ },
346
+ {
347
+ "description": "Font size of the menu item label.",
348
+ "name": "--m3e-fab-menu-item-font-size"
349
+ },
350
+ {
351
+ "description": "Font weight of the menu item label.",
352
+ "name": "--m3e-fab-menu-item-font-weight"
353
+ },
354
+ {
355
+ "description": "Line height of the menu item label.",
356
+ "name": "--m3e-fab-menu-item-line-height"
357
+ },
358
+ {
359
+ "description": "Letter spacing of the menu item label.",
360
+ "name": "--m3e-fab-menu-item-tracking"
361
+ },
362
+ {
363
+ "description": "Border radius of the menu item.",
364
+ "name": "--m3e-fab-menu-item-shape"
365
+ },
366
+ {
367
+ "description": "Padding at the start of the menu item.",
368
+ "name": "--m3e-fab-menu-item-leading-space"
369
+ },
370
+ {
371
+ "description": "Padding at the end of the menu item.",
372
+ "name": "--m3e-fab-menu-item-trailing-space"
373
+ },
374
+ {
375
+ "description": "Gap between icon and label.",
376
+ "name": "--m3e-fab-menu-item-spacing"
377
+ },
378
+ {
379
+ "description": "Size of the icon in the menu item.",
380
+ "name": "--m3e-fab-menu-item-icon-size"
381
+ }
382
+ ],
383
+ "slots": [
384
+ {
385
+ "description": "Renders the label of the item.",
386
+ "name": ""
387
+ },
388
+ {
389
+ "description": "Renders an icon before the items's label.",
390
+ "name": "icon"
391
+ }
392
+ ],
393
+ "members": [
394
+ {
395
+ "kind": "field",
396
+ "name": "_elevation",
397
+ "type": {
398
+ "text": "M3eElevationElement | undefined"
399
+ },
400
+ "privacy": "private",
401
+ "readonly": true
402
+ },
403
+ {
404
+ "kind": "field",
405
+ "name": "_focusRing",
406
+ "type": {
407
+ "text": "M3eFocusRingElement | undefined"
408
+ },
409
+ "privacy": "private",
410
+ "readonly": true
411
+ },
412
+ {
413
+ "kind": "field",
414
+ "name": "_stateLayer",
415
+ "type": {
416
+ "text": "M3eStateLayerElement | undefined"
417
+ },
418
+ "privacy": "private",
419
+ "readonly": true
420
+ },
421
+ {
422
+ "kind": "field",
423
+ "name": "_ripple",
424
+ "type": {
425
+ "text": "M3eRippleElement | undefined"
426
+ },
427
+ "privacy": "private",
428
+ "readonly": true
429
+ },
430
+ {
431
+ "kind": "field",
432
+ "name": "#clickHandler",
433
+ "privacy": "private",
434
+ "readonly": true
435
+ },
436
+ {
437
+ "kind": "field",
438
+ "name": "menu",
439
+ "type": {
440
+ "text": "M3eFabMenuElement | null"
441
+ },
442
+ "description": "The floating action button (FAB) menu to which this item belongs.",
443
+ "readonly": true
444
+ },
445
+ {
446
+ "kind": "method",
447
+ "name": "#handleClick",
448
+ "privacy": "private",
449
+ "return": {
450
+ "type": {
451
+ "text": "void"
452
+ }
453
+ },
454
+ "parameters": [
455
+ {
456
+ "name": "e",
457
+ "type": {
458
+ "text": "Event"
459
+ }
460
+ }
461
+ ]
462
+ }
463
+ ],
464
+ "attributes": [
465
+ {
466
+ "description": "Whether the element is disabled.",
467
+ "name": "disabled"
468
+ },
469
+ {
470
+ "description": "A value indicating whether the `target` of the link button will be downloaded, optionally specifying the new name of the file.",
471
+ "name": "download"
472
+ },
473
+ {
474
+ "description": "The URL to which the link button points.",
475
+ "name": "href"
476
+ },
477
+ {
478
+ "description": "The relationship between the `target` of the link button and the document.",
479
+ "name": "rel"
480
+ },
481
+ {
482
+ "description": "The target of the link button.",
483
+ "name": "target"
484
+ }
485
+ ],
486
+ "mixins": [
487
+ {
488
+ "name": "KeyboardClick",
489
+ "package": "@m3e/core"
490
+ },
491
+ {
492
+ "name": "LinkButton",
493
+ "package": "@m3e/core"
494
+ },
495
+ {
496
+ "name": "Disabled",
497
+ "package": "@m3e/core"
498
+ },
499
+ {
500
+ "name": "AttachInternals",
501
+ "package": "@m3e/core"
502
+ },
503
+ {
504
+ "name": "Role",
505
+ "package": "@m3e/core"
506
+ }
507
+ ],
508
+ "superclass": {
509
+ "name": "LitElement",
510
+ "package": "lit"
511
+ },
512
+ "tagName": "m3e-menu-item",
513
+ "customElement": true
514
+ }
515
+ ],
516
+ "exports": [
517
+ {
518
+ "kind": "js",
519
+ "name": "M3eFabMenuItemElement",
520
+ "declaration": {
521
+ "name": "M3eFabMenuItemElement",
522
+ "module": "src/FabMenuItemElement.ts"
523
+ }
524
+ },
525
+ {
526
+ "kind": "custom-element-definition",
527
+ "name": "m3e-fab-menu-item",
528
+ "declaration": {
529
+ "name": "M3eFabMenuItemElement",
530
+ "module": "src/FabMenuItemElement.ts"
531
+ }
532
+ }
533
+ ]
534
+ },
535
+ {
536
+ "kind": "javascript-module",
537
+ "path": "src/FabMenuTriggerElement.ts",
538
+ "declarations": [
539
+ {
540
+ "kind": "class",
541
+ "description": "An element, nested within a clickable element, used to open a floating action button (FAB) menu.",
542
+ "name": "M3eFabMenuTriggerElement",
543
+ "members": [
544
+ {
545
+ "kind": "field",
546
+ "name": "#clickHandler",
547
+ "privacy": "private",
548
+ "readonly": true
549
+ },
550
+ {
551
+ "kind": "field",
552
+ "name": "menu",
553
+ "type": {
554
+ "text": "M3eFabMenuElement | null"
555
+ },
556
+ "description": "The menu triggered by the element.",
557
+ "readonly": true
558
+ },
559
+ {
560
+ "kind": "method",
561
+ "name": "attach",
562
+ "return": {
563
+ "type": {
564
+ "text": "void"
565
+ }
566
+ },
567
+ "parameters": [
568
+ {
569
+ "name": "control",
570
+ "type": {
571
+ "text": "HTMLElement"
572
+ }
573
+ }
574
+ ]
575
+ },
576
+ {
577
+ "kind": "method",
578
+ "name": "detach",
579
+ "return": {
580
+ "type": {
581
+ "text": "void"
582
+ }
583
+ }
584
+ },
585
+ {
586
+ "kind": "method",
587
+ "name": "#handleClick",
588
+ "privacy": "private",
589
+ "return": {
590
+ "type": {
591
+ "text": "void"
592
+ }
593
+ },
594
+ "parameters": [
595
+ {
596
+ "name": "e",
597
+ "type": {
598
+ "text": "Event"
599
+ }
600
+ }
601
+ ]
602
+ }
603
+ ],
604
+ "mixins": [
605
+ {
606
+ "name": "HtmlFor",
607
+ "package": "@m3e/core"
608
+ },
609
+ {
610
+ "name": "Role",
611
+ "package": "@m3e/core"
612
+ }
613
+ ],
614
+ "superclass": {
615
+ "name": "LitElement",
616
+ "package": "lit"
617
+ },
618
+ "tagName": "m3e-fab-menu-trigger",
619
+ "customElement": true
620
+ }
621
+ ],
622
+ "exports": [
623
+ {
624
+ "kind": "js",
625
+ "name": "M3eFabMenuTriggerElement",
626
+ "declaration": {
627
+ "name": "M3eFabMenuTriggerElement",
628
+ "module": "src/FabMenuTriggerElement.ts"
629
+ }
630
+ },
631
+ {
632
+ "kind": "custom-element-definition",
633
+ "name": "m3e-fab-menu-trigger",
634
+ "declaration": {
635
+ "name": "M3eFabMenuTriggerElement",
636
+ "module": "src/FabMenuTriggerElement.ts"
637
+ }
638
+ }
639
+ ]
640
+ },
641
+ {
642
+ "kind": "javascript-module",
643
+ "path": "src/FabMenuVariant.ts",
644
+ "declarations": [],
645
+ "exports": []
646
+ },
647
+ {
648
+ "kind": "javascript-module",
649
+ "path": "src/index.ts",
650
+ "declarations": [],
651
+ "exports": [
652
+ {
653
+ "kind": "js",
654
+ "name": "*",
655
+ "declaration": {
656
+ "name": "*",
657
+ "package": "\"./FabMenuElement\""
658
+ }
659
+ },
660
+ {
661
+ "kind": "js",
662
+ "name": "*",
663
+ "declaration": {
664
+ "name": "*",
665
+ "package": "\"./FabMenuItemElement\""
666
+ }
667
+ },
668
+ {
669
+ "kind": "js",
670
+ "name": "*",
671
+ "declaration": {
672
+ "name": "*",
673
+ "package": "\"./FabMenuTriggerElement\""
674
+ }
675
+ },
676
+ {
677
+ "kind": "js",
678
+ "name": "*",
679
+ "declaration": {
680
+ "name": "*",
681
+ "package": "\"./FabMenuVariant\""
682
+ }
683
+ }
684
+ ]
685
+ }
686
+ ]
687
+ }