@momentum-design/components 0.66.0 → 0.66.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.
- package/dist/browser/index.js +203 -196
- package/dist/browser/index.js.map +4 -4
- package/dist/components/formfieldgroup/formfieldgroup.component.js +1 -1
- package/dist/components/formfieldgroup/formfieldgroup.constants.d.ts +1 -5
- package/dist/components/formfieldgroup/formfieldgroup.constants.js +1 -5
- package/dist/components/list/list.component.d.ts +3 -0
- package/dist/components/list/list.component.js +5 -2
- package/dist/components/listitem/index.d.ts +1 -0
- package/dist/components/listitem/index.js +1 -0
- package/dist/components/listitem/listitem.component.d.ts +30 -1
- package/dist/components/listitem/listitem.component.js +65 -3
- package/dist/components/listitem/listitem.constants.d.ts +4 -1
- package/dist/components/listitem/listitem.constants.js +5 -1
- package/dist/components/listitem/listitem.styles.js +20 -8
- package/dist/components/menuitem/index.d.ts +1 -0
- package/dist/components/menuitem/index.js +1 -0
- package/dist/components/menuitem/menuitem.component.js +2 -1
- package/dist/components/option/option.component.d.ts +3 -14
- package/dist/components/option/option.component.js +3 -54
- package/dist/components/option/option.constants.d.ts +1 -2
- package/dist/components/option/option.constants.js +1 -2
- package/dist/components/option/option.styles.js +0 -5
- package/dist/components/tooltip/tooltip.component.d.ts +1 -1
- package/dist/components/tooltip/tooltip.component.js +7 -6
- package/dist/custom-elements.json +749 -504
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/dist/react/listitem/index.d.ts +6 -0
- package/dist/react/listitem/index.js +6 -0
- package/dist/react/option/index.d.ts +2 -0
- package/dist/react/option/index.js +2 -0
- package/dist/utils/roles.d.ts +17 -0
- package/dist/utils/roles.js +16 -0
- package/package.json +1 -1
@@ -309,143 +309,50 @@
|
|
309
309
|
},
|
310
310
|
{
|
311
311
|
"kind": "javascript-module",
|
312
|
-
"path": "components/
|
312
|
+
"path": "components/alertchip/alertchip.component.js",
|
313
313
|
"declarations": [
|
314
314
|
{
|
315
315
|
"kind": "class",
|
316
|
-
"description": "
|
317
|
-
"name": "
|
316
|
+
"description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
|
317
|
+
"name": "AlertChip",
|
318
318
|
"cssProperties": [
|
319
319
|
{
|
320
|
-
"description": "
|
321
|
-
"name": "--mdc-
|
320
|
+
"description": "The color of the label text",
|
321
|
+
"name": "--mdc-chip-color"
|
322
322
|
},
|
323
323
|
{
|
324
|
-
"description": "
|
325
|
-
"name": "--mdc-
|
324
|
+
"description": "The color of the icon",
|
325
|
+
"name": "--mdc-chip-icon-color"
|
326
326
|
},
|
327
327
|
{
|
328
|
-
"description": "
|
329
|
-
"name": "--mdc-
|
328
|
+
"description": "The border color of the alertchip",
|
329
|
+
"name": "--mdc-chip-border-color"
|
330
|
+
},
|
331
|
+
{
|
332
|
+
"description": "The background color of the alertchip",
|
333
|
+
"name": "--mdc-chip-background-color"
|
330
334
|
}
|
331
335
|
],
|
332
336
|
"members": [
|
333
337
|
{
|
334
338
|
"kind": "field",
|
335
|
-
"name": "
|
336
|
-
"type": {
|
337
|
-
"text": "string | null"
|
338
|
-
},
|
339
|
-
"default": "null",
|
340
|
-
"description": "Aria-label attribute to be set for accessibility",
|
341
|
-
"attribute": "aria-label"
|
342
|
-
},
|
343
|
-
{
|
344
|
-
"kind": "method",
|
345
|
-
"name": "setSize",
|
346
|
-
"privacy": "private",
|
347
|
-
"parameters": [
|
348
|
-
{
|
349
|
-
"name": "size",
|
350
|
-
"type": {
|
351
|
-
"text": "AvatarSize"
|
352
|
-
}
|
353
|
-
}
|
354
|
-
]
|
355
|
-
},
|
356
|
-
{
|
357
|
-
"kind": "field",
|
358
|
-
"name": "src",
|
359
|
-
"type": {
|
360
|
-
"text": "string | undefined"
|
361
|
-
},
|
362
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
363
|
-
"attribute": "src",
|
364
|
-
"inheritedFrom": {
|
365
|
-
"name": "AvatarComponentMixin",
|
366
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
367
|
-
}
|
368
|
-
},
|
369
|
-
{
|
370
|
-
"kind": "field",
|
371
|
-
"name": "initials",
|
372
|
-
"type": {
|
373
|
-
"text": "string | undefined"
|
374
|
-
},
|
375
|
-
"description": "The initials to be displayed for the avatar.",
|
376
|
-
"attribute": "initials",
|
377
|
-
"inheritedFrom": {
|
378
|
-
"name": "AvatarComponentMixin",
|
379
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
380
|
-
}
|
381
|
-
},
|
382
|
-
{
|
383
|
-
"kind": "field",
|
384
|
-
"name": "presence",
|
385
|
-
"type": {
|
386
|
-
"text": "PresenceType | undefined"
|
387
|
-
},
|
388
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
389
|
-
"attribute": "presence",
|
390
|
-
"inheritedFrom": {
|
391
|
-
"name": "AvatarComponentMixin",
|
392
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
393
|
-
}
|
394
|
-
},
|
395
|
-
{
|
396
|
-
"kind": "field",
|
397
|
-
"name": "size",
|
398
|
-
"type": {
|
399
|
-
"text": "ButtonSize"
|
400
|
-
},
|
401
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
402
|
-
"default": "32",
|
403
|
-
"attribute": "size",
|
404
|
-
"reflects": true,
|
405
|
-
"inheritedFrom": {
|
406
|
-
"name": "Buttonsimple",
|
407
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
408
|
-
}
|
409
|
-
},
|
410
|
-
{
|
411
|
-
"kind": "field",
|
412
|
-
"name": "counter",
|
413
|
-
"type": {
|
414
|
-
"text": "number | undefined"
|
415
|
-
},
|
416
|
-
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
417
|
-
"attribute": "counter",
|
418
|
-
"inheritedFrom": {
|
419
|
-
"name": "AvatarComponentMixin",
|
420
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
421
|
-
}
|
422
|
-
},
|
423
|
-
{
|
424
|
-
"kind": "field",
|
425
|
-
"name": "isTyping",
|
339
|
+
"name": "variant",
|
426
340
|
"type": {
|
427
|
-
"text": "
|
341
|
+
"text": "VariantType"
|
428
342
|
},
|
429
|
-
"
|
430
|
-
"
|
431
|
-
"attribute": "
|
432
|
-
"inheritedFrom": {
|
433
|
-
"name": "AvatarComponentMixin",
|
434
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
435
|
-
}
|
343
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
344
|
+
"default": "neutral",
|
345
|
+
"attribute": "variant"
|
436
346
|
},
|
437
347
|
{
|
438
348
|
"kind": "field",
|
439
|
-
"name": "
|
349
|
+
"name": "label",
|
440
350
|
"type": {
|
441
|
-
"text": "
|
351
|
+
"text": "string"
|
442
352
|
},
|
443
|
-
"
|
444
|
-
"
|
445
|
-
"
|
446
|
-
"name": "IconNameMixin",
|
447
|
-
"module": "utils/mixins/IconNameMixin.js"
|
448
|
-
}
|
353
|
+
"default": "''",
|
354
|
+
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
355
|
+
"attribute": "label"
|
449
356
|
},
|
450
357
|
{
|
451
358
|
"kind": "field",
|
@@ -507,6 +414,21 @@
|
|
507
414
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
508
415
|
}
|
509
416
|
},
|
417
|
+
{
|
418
|
+
"kind": "field",
|
419
|
+
"name": "size",
|
420
|
+
"type": {
|
421
|
+
"text": "ButtonSize"
|
422
|
+
},
|
423
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
424
|
+
"default": "32",
|
425
|
+
"attribute": "size",
|
426
|
+
"reflects": true,
|
427
|
+
"inheritedFrom": {
|
428
|
+
"name": "Buttonsimple",
|
429
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
430
|
+
}
|
431
|
+
},
|
510
432
|
{
|
511
433
|
"kind": "field",
|
512
434
|
"name": "role",
|
@@ -696,187 +618,85 @@
|
|
696
618
|
}
|
697
619
|
}
|
698
620
|
],
|
699
|
-
"events": [
|
700
|
-
{
|
701
|
-
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
702
|
-
"name": "click",
|
703
|
-
"reactName": "onClick",
|
704
|
-
"inheritedFrom": {
|
705
|
-
"name": "Buttonsimple",
|
706
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
707
|
-
}
|
708
|
-
},
|
709
|
-
{
|
710
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
711
|
-
"name": "keydown",
|
712
|
-
"reactName": "onKeyDown",
|
713
|
-
"inheritedFrom": {
|
714
|
-
"name": "Buttonsimple",
|
715
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
716
|
-
}
|
717
|
-
},
|
718
|
-
{
|
719
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
720
|
-
"name": "keyup",
|
721
|
-
"reactName": "onKeyUp",
|
722
|
-
"inheritedFrom": {
|
723
|
-
"name": "Buttonsimple",
|
724
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
725
|
-
}
|
726
|
-
},
|
727
|
-
{
|
728
|
-
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
729
|
-
"name": "focus",
|
730
|
-
"reactName": "onFocus",
|
731
|
-
"inheritedFrom": {
|
732
|
-
"name": "Buttonsimple",
|
733
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
734
|
-
}
|
735
|
-
}
|
736
|
-
],
|
737
621
|
"attributes": [
|
738
622
|
{
|
739
|
-
"name": "
|
623
|
+
"name": "variant",
|
740
624
|
"type": {
|
741
|
-
"text": "
|
625
|
+
"text": "VariantType"
|
742
626
|
},
|
743
|
-
"
|
744
|
-
"
|
745
|
-
"fieldName": "
|
627
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
628
|
+
"default": "neutral",
|
629
|
+
"fieldName": "variant"
|
746
630
|
},
|
747
631
|
{
|
748
|
-
"name": "
|
632
|
+
"name": "label",
|
749
633
|
"type": {
|
750
|
-
"text": "string
|
634
|
+
"text": "string"
|
751
635
|
},
|
752
|
-
"
|
753
|
-
"
|
754
|
-
"
|
755
|
-
"name": "AvatarComponentMixin",
|
756
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
757
|
-
}
|
636
|
+
"default": "''",
|
637
|
+
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
638
|
+
"fieldName": "label"
|
758
639
|
},
|
759
640
|
{
|
760
|
-
"name": "
|
641
|
+
"name": "tabIndex",
|
761
642
|
"type": {
|
762
|
-
"text": "
|
643
|
+
"text": "number"
|
763
644
|
},
|
764
|
-
"
|
765
|
-
"
|
645
|
+
"default": "0",
|
646
|
+
"description": "This property specifies the tab order of the element.",
|
647
|
+
"fieldName": "tabIndex",
|
766
648
|
"inheritedFrom": {
|
767
|
-
"name": "
|
768
|
-
"module": "src/utils/mixins/
|
649
|
+
"name": "TabIndexMixin",
|
650
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
769
651
|
}
|
770
652
|
},
|
771
653
|
{
|
772
|
-
"name": "
|
654
|
+
"name": "disabled",
|
773
655
|
"type": {
|
774
|
-
"text": "
|
656
|
+
"text": "boolean | undefined"
|
775
657
|
},
|
776
|
-
"description": "
|
777
|
-
"
|
658
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
659
|
+
"default": "undefined",
|
660
|
+
"fieldName": "disabled",
|
778
661
|
"inheritedFrom": {
|
779
|
-
"name": "
|
780
|
-
"module": "src/utils/mixins/
|
662
|
+
"name": "DisabledMixin",
|
663
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
781
664
|
}
|
782
665
|
},
|
783
666
|
{
|
784
|
-
"name": "
|
667
|
+
"name": "active",
|
785
668
|
"type": {
|
786
|
-
"text": "
|
669
|
+
"text": "boolean | undefined"
|
787
670
|
},
|
788
|
-
"description": "
|
789
|
-
"default": "
|
790
|
-
"fieldName": "
|
671
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
672
|
+
"default": "undefined",
|
673
|
+
"fieldName": "active",
|
791
674
|
"inheritedFrom": {
|
792
675
|
"name": "Buttonsimple",
|
793
676
|
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
794
677
|
}
|
795
678
|
},
|
796
679
|
{
|
797
|
-
"name": "
|
680
|
+
"name": "soft-disabled",
|
798
681
|
"type": {
|
799
|
-
"text": "
|
682
|
+
"text": "boolean | undefined"
|
800
683
|
},
|
801
|
-
"description": "
|
802
|
-
"fieldName": "counter",
|
803
|
-
"inheritedFrom": {
|
804
|
-
"name": "AvatarComponentMixin",
|
805
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
806
|
-
}
|
807
|
-
},
|
808
|
-
{
|
809
|
-
"name": "is-typing",
|
810
|
-
"type": {
|
811
|
-
"text": "boolean"
|
812
|
-
},
|
813
|
-
"default": "false",
|
814
|
-
"description": "Represents the typing indicator when the user is typing.",
|
815
|
-
"fieldName": "isTyping",
|
816
|
-
"inheritedFrom": {
|
817
|
-
"name": "AvatarComponentMixin",
|
818
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
819
|
-
}
|
820
|
-
},
|
821
|
-
{
|
822
|
-
"name": "icon-name",
|
823
|
-
"type": {
|
824
|
-
"text": "IconNames | undefined"
|
825
|
-
},
|
826
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
827
|
-
"fieldName": "iconName",
|
828
|
-
"inheritedFrom": {
|
829
|
-
"name": "IconNameMixin",
|
830
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
831
|
-
}
|
832
|
-
},
|
833
|
-
{
|
834
|
-
"name": "tabIndex",
|
835
|
-
"type": {
|
836
|
-
"text": "number"
|
837
|
-
},
|
838
|
-
"default": "0",
|
839
|
-
"description": "This property specifies the tab order of the element.",
|
840
|
-
"fieldName": "tabIndex",
|
841
|
-
"inheritedFrom": {
|
842
|
-
"name": "TabIndexMixin",
|
843
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
844
|
-
}
|
845
|
-
},
|
846
|
-
{
|
847
|
-
"name": "disabled",
|
848
|
-
"type": {
|
849
|
-
"text": "boolean | undefined"
|
850
|
-
},
|
851
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
852
|
-
"default": "undefined",
|
853
|
-
"fieldName": "disabled",
|
854
|
-
"inheritedFrom": {
|
855
|
-
"name": "DisabledMixin",
|
856
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
857
|
-
}
|
858
|
-
},
|
859
|
-
{
|
860
|
-
"name": "active",
|
861
|
-
"type": {
|
862
|
-
"text": "boolean | undefined"
|
863
|
-
},
|
864
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
684
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
865
685
|
"default": "undefined",
|
866
|
-
"fieldName": "
|
686
|
+
"fieldName": "softDisabled",
|
867
687
|
"inheritedFrom": {
|
868
688
|
"name": "Buttonsimple",
|
869
689
|
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
870
690
|
}
|
871
691
|
},
|
872
692
|
{
|
873
|
-
"name": "
|
693
|
+
"name": "size",
|
874
694
|
"type": {
|
875
|
-
"text": "
|
695
|
+
"text": "ButtonSize"
|
876
696
|
},
|
877
|
-
"description": "
|
878
|
-
"default": "
|
879
|
-
"fieldName": "
|
697
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
698
|
+
"default": "32",
|
699
|
+
"fieldName": "size",
|
880
700
|
"inheritedFrom": {
|
881
701
|
"name": "Buttonsimple",
|
882
702
|
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
@@ -919,23 +739,51 @@
|
|
919
739
|
}
|
920
740
|
}
|
921
741
|
],
|
922
|
-
"mixins": [
|
923
|
-
{
|
924
|
-
"name": "AvatarComponentMixin",
|
925
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
926
|
-
},
|
927
|
-
{
|
928
|
-
"name": "IconNameMixin",
|
929
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
930
|
-
}
|
931
|
-
],
|
932
742
|
"superclass": {
|
933
743
|
"name": "Buttonsimple",
|
934
744
|
"module": "/src/components/buttonsimple/buttonsimple.component"
|
935
745
|
},
|
936
|
-
"tagName": "mdc-
|
937
|
-
"jsDoc": "/**\n *
|
938
|
-
"customElement": true
|
746
|
+
"tagName": "mdc-alertchip",
|
747
|
+
"jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n */",
|
748
|
+
"customElement": true,
|
749
|
+
"events": [
|
750
|
+
{
|
751
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
752
|
+
"name": "click",
|
753
|
+
"reactName": "onClick",
|
754
|
+
"inheritedFrom": {
|
755
|
+
"name": "Buttonsimple",
|
756
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
757
|
+
}
|
758
|
+
},
|
759
|
+
{
|
760
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
761
|
+
"name": "keydown",
|
762
|
+
"reactName": "onKeyDown",
|
763
|
+
"inheritedFrom": {
|
764
|
+
"name": "Buttonsimple",
|
765
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
766
|
+
}
|
767
|
+
},
|
768
|
+
{
|
769
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
770
|
+
"name": "keyup",
|
771
|
+
"reactName": "onKeyUp",
|
772
|
+
"inheritedFrom": {
|
773
|
+
"name": "Buttonsimple",
|
774
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
775
|
+
}
|
776
|
+
},
|
777
|
+
{
|
778
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
779
|
+
"name": "focus",
|
780
|
+
"reactName": "onFocus",
|
781
|
+
"inheritedFrom": {
|
782
|
+
"name": "Buttonsimple",
|
783
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
784
|
+
}
|
785
|
+
}
|
786
|
+
]
|
939
787
|
}
|
940
788
|
],
|
941
789
|
"exports": [
|
@@ -943,58 +791,151 @@
|
|
943
791
|
"kind": "js",
|
944
792
|
"name": "default",
|
945
793
|
"declaration": {
|
946
|
-
"name": "
|
947
|
-
"module": "components/
|
794
|
+
"name": "AlertChip",
|
795
|
+
"module": "components/alertchip/alertchip.component.js"
|
948
796
|
}
|
949
797
|
}
|
950
798
|
]
|
951
799
|
},
|
952
800
|
{
|
953
801
|
"kind": "javascript-module",
|
954
|
-
"path": "components/
|
802
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
955
803
|
"declarations": [
|
956
804
|
{
|
957
805
|
"kind": "class",
|
958
|
-
"description": "mdc-
|
959
|
-
"name": "
|
806
|
+
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
807
|
+
"name": "AvatarButton",
|
960
808
|
"cssProperties": [
|
961
809
|
{
|
962
|
-
"description": "
|
963
|
-
"name": "--mdc-
|
964
|
-
},
|
965
|
-
{
|
966
|
-
"description": "The color of the icon",
|
967
|
-
"name": "--mdc-chip-icon-color"
|
810
|
+
"description": "Background color of the overlay in rest state",
|
811
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
968
812
|
},
|
969
813
|
{
|
970
|
-
"description": "
|
971
|
-
"name": "--mdc-
|
814
|
+
"description": "Background color of the overlay in hover state",
|
815
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
972
816
|
},
|
973
817
|
{
|
974
|
-
"description": "
|
975
|
-
"name": "--mdc-
|
818
|
+
"description": "Background color of the overlay in active state",
|
819
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
976
820
|
}
|
977
821
|
],
|
978
822
|
"members": [
|
979
823
|
{
|
980
824
|
"kind": "field",
|
981
|
-
"name": "
|
825
|
+
"name": "ariaLabel",
|
982
826
|
"type": {
|
983
|
-
"text": "
|
827
|
+
"text": "string | null"
|
984
828
|
},
|
985
|
-
"
|
986
|
-
"
|
987
|
-
"attribute": "
|
829
|
+
"default": "null",
|
830
|
+
"description": "Aria-label attribute to be set for accessibility",
|
831
|
+
"attribute": "aria-label"
|
832
|
+
},
|
833
|
+
{
|
834
|
+
"kind": "method",
|
835
|
+
"name": "setSize",
|
836
|
+
"privacy": "private",
|
837
|
+
"parameters": [
|
838
|
+
{
|
839
|
+
"name": "size",
|
840
|
+
"type": {
|
841
|
+
"text": "AvatarSize"
|
842
|
+
}
|
843
|
+
}
|
844
|
+
]
|
988
845
|
},
|
989
846
|
{
|
990
847
|
"kind": "field",
|
991
|
-
"name": "
|
848
|
+
"name": "src",
|
992
849
|
"type": {
|
993
|
-
"text": "string"
|
850
|
+
"text": "string | undefined"
|
994
851
|
},
|
995
|
-
"
|
996
|
-
"
|
997
|
-
"
|
852
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
853
|
+
"attribute": "src",
|
854
|
+
"inheritedFrom": {
|
855
|
+
"name": "AvatarComponentMixin",
|
856
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
857
|
+
}
|
858
|
+
},
|
859
|
+
{
|
860
|
+
"kind": "field",
|
861
|
+
"name": "initials",
|
862
|
+
"type": {
|
863
|
+
"text": "string | undefined"
|
864
|
+
},
|
865
|
+
"description": "The initials to be displayed for the avatar.",
|
866
|
+
"attribute": "initials",
|
867
|
+
"inheritedFrom": {
|
868
|
+
"name": "AvatarComponentMixin",
|
869
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
870
|
+
}
|
871
|
+
},
|
872
|
+
{
|
873
|
+
"kind": "field",
|
874
|
+
"name": "presence",
|
875
|
+
"type": {
|
876
|
+
"text": "PresenceType | undefined"
|
877
|
+
},
|
878
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
879
|
+
"attribute": "presence",
|
880
|
+
"inheritedFrom": {
|
881
|
+
"name": "AvatarComponentMixin",
|
882
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
883
|
+
}
|
884
|
+
},
|
885
|
+
{
|
886
|
+
"kind": "field",
|
887
|
+
"name": "size",
|
888
|
+
"type": {
|
889
|
+
"text": "ButtonSize"
|
890
|
+
},
|
891
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
892
|
+
"default": "32",
|
893
|
+
"attribute": "size",
|
894
|
+
"reflects": true,
|
895
|
+
"inheritedFrom": {
|
896
|
+
"name": "Buttonsimple",
|
897
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
898
|
+
}
|
899
|
+
},
|
900
|
+
{
|
901
|
+
"kind": "field",
|
902
|
+
"name": "counter",
|
903
|
+
"type": {
|
904
|
+
"text": "number | undefined"
|
905
|
+
},
|
906
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
907
|
+
"attribute": "counter",
|
908
|
+
"inheritedFrom": {
|
909
|
+
"name": "AvatarComponentMixin",
|
910
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
911
|
+
}
|
912
|
+
},
|
913
|
+
{
|
914
|
+
"kind": "field",
|
915
|
+
"name": "isTyping",
|
916
|
+
"type": {
|
917
|
+
"text": "boolean"
|
918
|
+
},
|
919
|
+
"default": "false",
|
920
|
+
"description": "Represents the typing indicator when the user is typing.",
|
921
|
+
"attribute": "is-typing",
|
922
|
+
"inheritedFrom": {
|
923
|
+
"name": "AvatarComponentMixin",
|
924
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
925
|
+
}
|
926
|
+
},
|
927
|
+
{
|
928
|
+
"kind": "field",
|
929
|
+
"name": "iconName",
|
930
|
+
"type": {
|
931
|
+
"text": "IconNames | undefined"
|
932
|
+
},
|
933
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
934
|
+
"attribute": "icon-name",
|
935
|
+
"inheritedFrom": {
|
936
|
+
"name": "IconNameMixin",
|
937
|
+
"module": "utils/mixins/IconNameMixin.js"
|
938
|
+
}
|
998
939
|
},
|
999
940
|
{
|
1000
941
|
"kind": "field",
|
@@ -1056,21 +997,6 @@
|
|
1056
997
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
1057
998
|
}
|
1058
999
|
},
|
1059
|
-
{
|
1060
|
-
"kind": "field",
|
1061
|
-
"name": "size",
|
1062
|
-
"type": {
|
1063
|
-
"text": "ButtonSize"
|
1064
|
-
},
|
1065
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1066
|
-
"default": "32",
|
1067
|
-
"attribute": "size",
|
1068
|
-
"reflects": true,
|
1069
|
-
"inheritedFrom": {
|
1070
|
-
"name": "Buttonsimple",
|
1071
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1072
|
-
}
|
1073
|
-
},
|
1074
1000
|
{
|
1075
1001
|
"kind": "field",
|
1076
1002
|
"name": "role",
|
@@ -1260,24 +1186,139 @@
|
|
1260
1186
|
}
|
1261
1187
|
}
|
1262
1188
|
],
|
1189
|
+
"events": [
|
1190
|
+
{
|
1191
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
1192
|
+
"name": "click",
|
1193
|
+
"reactName": "onClick",
|
1194
|
+
"inheritedFrom": {
|
1195
|
+
"name": "Buttonsimple",
|
1196
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1197
|
+
}
|
1198
|
+
},
|
1199
|
+
{
|
1200
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
1201
|
+
"name": "keydown",
|
1202
|
+
"reactName": "onKeyDown",
|
1203
|
+
"inheritedFrom": {
|
1204
|
+
"name": "Buttonsimple",
|
1205
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1206
|
+
}
|
1207
|
+
},
|
1208
|
+
{
|
1209
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
1210
|
+
"name": "keyup",
|
1211
|
+
"reactName": "onKeyUp",
|
1212
|
+
"inheritedFrom": {
|
1213
|
+
"name": "Buttonsimple",
|
1214
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1215
|
+
}
|
1216
|
+
},
|
1217
|
+
{
|
1218
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
1219
|
+
"name": "focus",
|
1220
|
+
"reactName": "onFocus",
|
1221
|
+
"inheritedFrom": {
|
1222
|
+
"name": "Buttonsimple",
|
1223
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1224
|
+
}
|
1225
|
+
}
|
1226
|
+
],
|
1263
1227
|
"attributes": [
|
1264
1228
|
{
|
1265
|
-
"name": "
|
1229
|
+
"name": "aria-label",
|
1266
1230
|
"type": {
|
1267
|
-
"text": "
|
1231
|
+
"text": "string | null"
|
1268
1232
|
},
|
1269
|
-
"
|
1270
|
-
"
|
1271
|
-
"fieldName": "
|
1233
|
+
"default": "null",
|
1234
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1235
|
+
"fieldName": "ariaLabel"
|
1272
1236
|
},
|
1273
1237
|
{
|
1274
|
-
"name": "
|
1238
|
+
"name": "src",
|
1275
1239
|
"type": {
|
1276
|
-
"text": "string"
|
1240
|
+
"text": "string | undefined"
|
1277
1241
|
},
|
1278
|
-
"
|
1279
|
-
"
|
1280
|
-
"
|
1242
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
1243
|
+
"fieldName": "src",
|
1244
|
+
"inheritedFrom": {
|
1245
|
+
"name": "AvatarComponentMixin",
|
1246
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1247
|
+
}
|
1248
|
+
},
|
1249
|
+
{
|
1250
|
+
"name": "initials",
|
1251
|
+
"type": {
|
1252
|
+
"text": "string | undefined"
|
1253
|
+
},
|
1254
|
+
"description": "The initials to be displayed for the avatar.",
|
1255
|
+
"fieldName": "initials",
|
1256
|
+
"inheritedFrom": {
|
1257
|
+
"name": "AvatarComponentMixin",
|
1258
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1259
|
+
}
|
1260
|
+
},
|
1261
|
+
{
|
1262
|
+
"name": "presence",
|
1263
|
+
"type": {
|
1264
|
+
"text": "PresenceType | undefined"
|
1265
|
+
},
|
1266
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
1267
|
+
"fieldName": "presence",
|
1268
|
+
"inheritedFrom": {
|
1269
|
+
"name": "AvatarComponentMixin",
|
1270
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1271
|
+
}
|
1272
|
+
},
|
1273
|
+
{
|
1274
|
+
"name": "size",
|
1275
|
+
"type": {
|
1276
|
+
"text": "ButtonSize"
|
1277
|
+
},
|
1278
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1279
|
+
"default": "32",
|
1280
|
+
"fieldName": "size",
|
1281
|
+
"inheritedFrom": {
|
1282
|
+
"name": "Buttonsimple",
|
1283
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1284
|
+
}
|
1285
|
+
},
|
1286
|
+
{
|
1287
|
+
"name": "counter",
|
1288
|
+
"type": {
|
1289
|
+
"text": "number | undefined"
|
1290
|
+
},
|
1291
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
1292
|
+
"fieldName": "counter",
|
1293
|
+
"inheritedFrom": {
|
1294
|
+
"name": "AvatarComponentMixin",
|
1295
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1296
|
+
}
|
1297
|
+
},
|
1298
|
+
{
|
1299
|
+
"name": "is-typing",
|
1300
|
+
"type": {
|
1301
|
+
"text": "boolean"
|
1302
|
+
},
|
1303
|
+
"default": "false",
|
1304
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1305
|
+
"fieldName": "isTyping",
|
1306
|
+
"inheritedFrom": {
|
1307
|
+
"name": "AvatarComponentMixin",
|
1308
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1309
|
+
}
|
1310
|
+
},
|
1311
|
+
{
|
1312
|
+
"name": "icon-name",
|
1313
|
+
"type": {
|
1314
|
+
"text": "IconNames | undefined"
|
1315
|
+
},
|
1316
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1317
|
+
"fieldName": "iconName",
|
1318
|
+
"inheritedFrom": {
|
1319
|
+
"name": "IconNameMixin",
|
1320
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1321
|
+
}
|
1281
1322
|
},
|
1282
1323
|
{
|
1283
1324
|
"name": "tabIndex",
|
@@ -1331,19 +1372,6 @@
|
|
1331
1372
|
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1332
1373
|
}
|
1333
1374
|
},
|
1334
|
-
{
|
1335
|
-
"name": "size",
|
1336
|
-
"type": {
|
1337
|
-
"text": "ButtonSize"
|
1338
|
-
},
|
1339
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
1340
|
-
"default": "32",
|
1341
|
-
"fieldName": "size",
|
1342
|
-
"inheritedFrom": {
|
1343
|
-
"name": "Buttonsimple",
|
1344
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1345
|
-
}
|
1346
|
-
},
|
1347
1375
|
{
|
1348
1376
|
"name": "role",
|
1349
1377
|
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
@@ -1381,51 +1409,23 @@
|
|
1381
1409
|
}
|
1382
1410
|
}
|
1383
1411
|
],
|
1384
|
-
"
|
1385
|
-
"name": "Buttonsimple",
|
1386
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1387
|
-
},
|
1388
|
-
"tagName": "mdc-alertchip",
|
1389
|
-
"jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n */",
|
1390
|
-
"customElement": true,
|
1391
|
-
"events": [
|
1392
|
-
{
|
1393
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
1394
|
-
"name": "click",
|
1395
|
-
"reactName": "onClick",
|
1396
|
-
"inheritedFrom": {
|
1397
|
-
"name": "Buttonsimple",
|
1398
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1399
|
-
}
|
1400
|
-
},
|
1401
|
-
{
|
1402
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
1403
|
-
"name": "keydown",
|
1404
|
-
"reactName": "onKeyDown",
|
1405
|
-
"inheritedFrom": {
|
1406
|
-
"name": "Buttonsimple",
|
1407
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1408
|
-
}
|
1409
|
-
},
|
1412
|
+
"mixins": [
|
1410
1413
|
{
|
1411
|
-
"
|
1412
|
-
"
|
1413
|
-
"reactName": "onKeyUp",
|
1414
|
-
"inheritedFrom": {
|
1415
|
-
"name": "Buttonsimple",
|
1416
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1417
|
-
}
|
1414
|
+
"name": "AvatarComponentMixin",
|
1415
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1418
1416
|
},
|
1419
1417
|
{
|
1420
|
-
"
|
1421
|
-
"
|
1422
|
-
"reactName": "onFocus",
|
1423
|
-
"inheritedFrom": {
|
1424
|
-
"name": "Buttonsimple",
|
1425
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1426
|
-
}
|
1418
|
+
"name": "IconNameMixin",
|
1419
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1427
1420
|
}
|
1428
|
-
]
|
1421
|
+
],
|
1422
|
+
"superclass": {
|
1423
|
+
"name": "Buttonsimple",
|
1424
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1425
|
+
},
|
1426
|
+
"tagName": "mdc-avatarbutton",
|
1427
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n */",
|
1428
|
+
"customElement": true
|
1429
1429
|
}
|
1430
1430
|
],
|
1431
1431
|
"exports": [
|
@@ -1433,8 +1433,8 @@
|
|
1433
1433
|
"kind": "js",
|
1434
1434
|
"name": "default",
|
1435
1435
|
"declaration": {
|
1436
|
-
"name": "
|
1437
|
-
"module": "components/
|
1436
|
+
"name": "AvatarButton",
|
1437
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1438
1438
|
}
|
1439
1439
|
}
|
1440
1440
|
]
|
@@ -12447,7 +12447,7 @@
|
|
12447
12447
|
"declarations": [
|
12448
12448
|
{
|
12449
12449
|
"kind": "class",
|
12450
|
-
"description": "mdc-listitem component is used to display a label with different types of controls.\nThere can be three types of controls, a radio button, a checkbox on the\nleading side and a toggle on the trailing side.\nThe list item can contain an avatar on the leading side and a badge on the trailing side.\nAdditionally, the list item can contain a side header and a subline text.\n\nThe leading and trailing slots can be used to display controls and text. <br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\nPlease use mdc-list as a parent element even when there is only listitem for a11y purpose.",
|
12450
|
+
"description": "mdc-listitem component is used to display a label with different types of controls.\nThere can be three types of controls, a radio button, a checkbox on the\nleading side and a toggle on the trailing side.\nThe list item can contain an avatar on the leading side and a badge on the trailing side.\nAdditionally, the list item can contain a side header and a subline text.\n\nThe leading and trailing slots can be used to display controls and text. <br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\nPlease use mdc-list as a parent element even when there is only listitem for a11y purpose.\n\nBy providing the tooltip-text attribute, a tooltip will be displayed on hover of the listitem.\nThe placement of the tooltip can be adjusted using the tooltip-placement attribute.\nThis will be helpful when the listitem text is truncated or\nwhen you want to display additional information about the listitem.",
|
12451
12451
|
"name": "ListItem",
|
12452
12452
|
"cssProperties": [
|
12453
12453
|
{
|
@@ -12477,6 +12477,10 @@
|
|
12477
12477
|
{
|
12478
12478
|
"description": "Allows customization of column gap.",
|
12479
12479
|
"name": "--mdc-listitem-column-gap"
|
12480
|
+
},
|
12481
|
+
{
|
12482
|
+
"description": "Allows customization of padding left and right.",
|
12483
|
+
"name": "--mdc-listitem-padding-left-and-right"
|
12480
12484
|
}
|
12481
12485
|
],
|
12482
12486
|
"slots": [
|
@@ -12571,6 +12575,59 @@
|
|
12571
12575
|
"attribute": "subline-text",
|
12572
12576
|
"reflects": true
|
12573
12577
|
},
|
12578
|
+
{
|
12579
|
+
"kind": "field",
|
12580
|
+
"name": "tooltipText",
|
12581
|
+
"type": {
|
12582
|
+
"text": "string | undefined"
|
12583
|
+
},
|
12584
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
12585
|
+
"attribute": "tooltip-text",
|
12586
|
+
"reflects": true
|
12587
|
+
},
|
12588
|
+
{
|
12589
|
+
"kind": "field",
|
12590
|
+
"name": "tooltipPlacement",
|
12591
|
+
"type": {
|
12592
|
+
"text": "PopoverPlacement"
|
12593
|
+
},
|
12594
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
12595
|
+
"default": "'top'",
|
12596
|
+
"attribute": "tooltip-placement",
|
12597
|
+
"reflects": true
|
12598
|
+
},
|
12599
|
+
{
|
12600
|
+
"kind": "method",
|
12601
|
+
"name": "handleClick",
|
12602
|
+
"privacy": "private",
|
12603
|
+
"return": {
|
12604
|
+
"type": {
|
12605
|
+
"text": "void"
|
12606
|
+
}
|
12607
|
+
}
|
12608
|
+
},
|
12609
|
+
{
|
12610
|
+
"kind": "method",
|
12611
|
+
"name": "displayTooltipForLongText",
|
12612
|
+
"privacy": "private",
|
12613
|
+
"return": {
|
12614
|
+
"type": {
|
12615
|
+
"text": "void"
|
12616
|
+
}
|
12617
|
+
},
|
12618
|
+
"description": "Display a tooltip for the listitem.\nCreate the tooltip programmatically after the nearest parent element."
|
12619
|
+
},
|
12620
|
+
{
|
12621
|
+
"kind": "method",
|
12622
|
+
"name": "hideTooltipOnLeave",
|
12623
|
+
"privacy": "private",
|
12624
|
+
"return": {
|
12625
|
+
"type": {
|
12626
|
+
"text": "void"
|
12627
|
+
}
|
12628
|
+
},
|
12629
|
+
"description": "Removes the dynamically created tooltip for long text label on focus or mouse leave.\nThis is triggered on focusout and mouseout events."
|
12630
|
+
},
|
12574
12631
|
{
|
12575
12632
|
"kind": "method",
|
12576
12633
|
"name": "getText",
|
@@ -12729,6 +12786,23 @@
|
|
12729
12786
|
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
12730
12787
|
"fieldName": "sublineText"
|
12731
12788
|
},
|
12789
|
+
{
|
12790
|
+
"name": "tooltip-text",
|
12791
|
+
"type": {
|
12792
|
+
"text": "string | undefined"
|
12793
|
+
},
|
12794
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
12795
|
+
"fieldName": "tooltipText"
|
12796
|
+
},
|
12797
|
+
{
|
12798
|
+
"name": "tooltip-placement",
|
12799
|
+
"type": {
|
12800
|
+
"text": "PopoverPlacement"
|
12801
|
+
},
|
12802
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
12803
|
+
"default": "'top'",
|
12804
|
+
"fieldName": "tooltipPlacement"
|
12805
|
+
},
|
12732
12806
|
{
|
12733
12807
|
"name": "disabled",
|
12734
12808
|
"type": {
|
@@ -12771,7 +12845,7 @@
|
|
12771
12845
|
"module": "/src/models"
|
12772
12846
|
},
|
12773
12847
|
"tagName": "mdc-listitem",
|
12774
|
-
"jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and tertiary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n * @cssproperty --mdc-listitem-column-gap - Allows customization of column gap.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n */",
|
12848
|
+
"jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * By providing the tooltip-text attribute, a tooltip will be displayed on hover of the listitem.\n * The placement of the tooltip can be adjusted using the tooltip-placement attribute.\n * This will be helpful when the listitem text is truncated or\n * when you want to display additional information about the listitem.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and tertiary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n * @cssproperty --mdc-listitem-column-gap - Allows customization of column gap.\n * @cssproperty --mdc-listitem-padding-left-and-right - Allows customization of padding left and right.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n */",
|
12775
12849
|
"customElement": true
|
12776
12850
|
}
|
12777
12851
|
],
|
@@ -12981,6 +13055,79 @@
|
|
12981
13055
|
"module": "components/listitem/listitem.component.js"
|
12982
13056
|
}
|
12983
13057
|
},
|
13058
|
+
{
|
13059
|
+
"kind": "field",
|
13060
|
+
"name": "tooltipText",
|
13061
|
+
"type": {
|
13062
|
+
"text": "string | undefined"
|
13063
|
+
},
|
13064
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
13065
|
+
"attribute": "tooltip-text",
|
13066
|
+
"reflects": true,
|
13067
|
+
"inheritedFrom": {
|
13068
|
+
"name": "ListItem",
|
13069
|
+
"module": "components/listitem/listitem.component.js"
|
13070
|
+
}
|
13071
|
+
},
|
13072
|
+
{
|
13073
|
+
"kind": "field",
|
13074
|
+
"name": "tooltipPlacement",
|
13075
|
+
"type": {
|
13076
|
+
"text": "PopoverPlacement"
|
13077
|
+
},
|
13078
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
13079
|
+
"default": "'top'",
|
13080
|
+
"attribute": "tooltip-placement",
|
13081
|
+
"reflects": true,
|
13082
|
+
"inheritedFrom": {
|
13083
|
+
"name": "ListItem",
|
13084
|
+
"module": "components/listitem/listitem.component.js"
|
13085
|
+
}
|
13086
|
+
},
|
13087
|
+
{
|
13088
|
+
"kind": "method",
|
13089
|
+
"name": "handleClick",
|
13090
|
+
"privacy": "private",
|
13091
|
+
"return": {
|
13092
|
+
"type": {
|
13093
|
+
"text": "void"
|
13094
|
+
}
|
13095
|
+
},
|
13096
|
+
"inheritedFrom": {
|
13097
|
+
"name": "ListItem",
|
13098
|
+
"module": "components/listitem/listitem.component.js"
|
13099
|
+
}
|
13100
|
+
},
|
13101
|
+
{
|
13102
|
+
"kind": "method",
|
13103
|
+
"name": "displayTooltipForLongText",
|
13104
|
+
"privacy": "private",
|
13105
|
+
"return": {
|
13106
|
+
"type": {
|
13107
|
+
"text": "void"
|
13108
|
+
}
|
13109
|
+
},
|
13110
|
+
"description": "Display a tooltip for the listitem.\nCreate the tooltip programmatically after the nearest parent element.",
|
13111
|
+
"inheritedFrom": {
|
13112
|
+
"name": "ListItem",
|
13113
|
+
"module": "components/listitem/listitem.component.js"
|
13114
|
+
}
|
13115
|
+
},
|
13116
|
+
{
|
13117
|
+
"kind": "method",
|
13118
|
+
"name": "hideTooltipOnLeave",
|
13119
|
+
"privacy": "private",
|
13120
|
+
"return": {
|
13121
|
+
"type": {
|
13122
|
+
"text": "void"
|
13123
|
+
}
|
13124
|
+
},
|
13125
|
+
"description": "Removes the dynamically created tooltip for long text label on focus or mouse leave.\nThis is triggered on focusout and mouseout events.",
|
13126
|
+
"inheritedFrom": {
|
13127
|
+
"name": "ListItem",
|
13128
|
+
"module": "components/listitem/listitem.component.js"
|
13129
|
+
}
|
13130
|
+
},
|
12984
13131
|
{
|
12985
13132
|
"kind": "method",
|
12986
13133
|
"name": "getText",
|
@@ -13189,6 +13336,31 @@
|
|
13189
13336
|
"name": "ListItem",
|
13190
13337
|
"module": "src/components/listitem/listitem.component.ts"
|
13191
13338
|
}
|
13339
|
+
},
|
13340
|
+
{
|
13341
|
+
"name": "tooltip-text",
|
13342
|
+
"type": {
|
13343
|
+
"text": "string | undefined"
|
13344
|
+
},
|
13345
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
13346
|
+
"fieldName": "tooltipText",
|
13347
|
+
"inheritedFrom": {
|
13348
|
+
"name": "ListItem",
|
13349
|
+
"module": "src/components/listitem/listitem.component.ts"
|
13350
|
+
}
|
13351
|
+
},
|
13352
|
+
{
|
13353
|
+
"name": "tooltip-placement",
|
13354
|
+
"type": {
|
13355
|
+
"text": "PopoverPlacement"
|
13356
|
+
},
|
13357
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
13358
|
+
"default": "'top'",
|
13359
|
+
"fieldName": "tooltipPlacement",
|
13360
|
+
"inheritedFrom": {
|
13361
|
+
"name": "ListItem",
|
13362
|
+
"module": "src/components/listitem/listitem.component.ts"
|
13363
|
+
}
|
13192
13364
|
}
|
13193
13365
|
],
|
13194
13366
|
"slots": [
|
@@ -13305,6 +13477,14 @@
|
|
13305
13477
|
"name": "ListItem",
|
13306
13478
|
"module": "src/components/listitem/listitem.component.ts"
|
13307
13479
|
}
|
13480
|
+
},
|
13481
|
+
{
|
13482
|
+
"description": "Allows customization of padding left and right.",
|
13483
|
+
"name": "--mdc-listitem-padding-left-and-right",
|
13484
|
+
"inheritedFrom": {
|
13485
|
+
"name": "ListItem",
|
13486
|
+
"module": "src/components/listitem/listitem.component.ts"
|
13487
|
+
}
|
13308
13488
|
}
|
13309
13489
|
]
|
13310
13490
|
}
|
@@ -13464,7 +13644,7 @@
|
|
13464
13644
|
"declarations": [
|
13465
13645
|
{
|
13466
13646
|
"kind": "class",
|
13467
|
-
"description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.",
|
13647
|
+
"description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.\nWe can pass a tooltip which will be displayed on hover of the option label text.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
|
13468
13648
|
"name": "Option",
|
13469
13649
|
"slots": [
|
13470
13650
|
{
|
@@ -13551,56 +13731,15 @@
|
|
13551
13731
|
"reflects": true
|
13552
13732
|
},
|
13553
13733
|
{
|
13554
|
-
"kind": "field",
|
13555
|
-
"name": "ariaLabel",
|
13556
|
-
"type": {
|
13557
|
-
"text": "string | null"
|
13558
|
-
},
|
13559
|
-
"default": "null",
|
13560
|
-
"description": "Any additional description can be provided here for screen readers.",
|
13561
|
-
"attribute": "aria-label",
|
13562
|
-
"reflects": true
|
13563
|
-
},
|
13564
|
-
{
|
13565
|
-
"kind": "method",
|
13566
|
-
"name": "handleClick",
|
13567
|
-
"privacy": "private",
|
13568
|
-
"return": {
|
13569
|
-
"type": {
|
13570
|
-
"text": "void"
|
13571
|
-
}
|
13572
|
-
}
|
13573
|
-
},
|
13574
|
-
{
|
13575
|
-
"kind": "method",
|
13576
|
-
"name": "displayTooltipForLongText",
|
13577
|
-
"privacy": "private",
|
13578
|
-
"return": {
|
13579
|
-
"type": {
|
13580
|
-
"text": "void"
|
13581
|
-
}
|
13582
|
-
},
|
13583
|
-
"parameters": [
|
13584
|
-
{
|
13585
|
-
"name": "event",
|
13586
|
-
"type": {
|
13587
|
-
"text": "FocusEvent | MouseEvent"
|
13588
|
-
},
|
13589
|
-
"description": "A focus or a mouse event."
|
13590
|
-
}
|
13591
|
-
],
|
13592
|
-
"description": "Display a tooltip for long text label with an ellipse at the end.\nCreate the tooltip programmatically after the nearest select component or the parent element."
|
13593
|
-
},
|
13594
|
-
{
|
13595
|
-
"kind": "method",
|
13596
|
-
"name": "hideTooltipOnLeave",
|
13597
|
-
"privacy": "private",
|
13598
|
-
"return": {
|
13599
|
-
"type": {
|
13600
|
-
"text": "void"
|
13601
|
-
}
|
13734
|
+
"kind": "field",
|
13735
|
+
"name": "ariaLabel",
|
13736
|
+
"type": {
|
13737
|
+
"text": "string | null"
|
13602
13738
|
},
|
13603
|
-
"
|
13739
|
+
"default": "null",
|
13740
|
+
"description": "Any additional description can be provided here for screen readers.",
|
13741
|
+
"attribute": "aria-label",
|
13742
|
+
"reflects": true
|
13604
13743
|
},
|
13605
13744
|
{
|
13606
13745
|
"kind": "method",
|
@@ -13848,6 +13987,79 @@
|
|
13848
13987
|
"module": "components/listitem/listitem.component.js"
|
13849
13988
|
}
|
13850
13989
|
},
|
13990
|
+
{
|
13991
|
+
"kind": "field",
|
13992
|
+
"name": "tooltipText",
|
13993
|
+
"type": {
|
13994
|
+
"text": "string | undefined"
|
13995
|
+
},
|
13996
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
13997
|
+
"attribute": "tooltip-text",
|
13998
|
+
"reflects": true,
|
13999
|
+
"inheritedFrom": {
|
14000
|
+
"name": "ListItem",
|
14001
|
+
"module": "components/listitem/listitem.component.js"
|
14002
|
+
}
|
14003
|
+
},
|
14004
|
+
{
|
14005
|
+
"kind": "field",
|
14006
|
+
"name": "tooltipPlacement",
|
14007
|
+
"type": {
|
14008
|
+
"text": "PopoverPlacement"
|
14009
|
+
},
|
14010
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
14011
|
+
"default": "'top'",
|
14012
|
+
"attribute": "tooltip-placement",
|
14013
|
+
"reflects": true,
|
14014
|
+
"inheritedFrom": {
|
14015
|
+
"name": "ListItem",
|
14016
|
+
"module": "components/listitem/listitem.component.js"
|
14017
|
+
}
|
14018
|
+
},
|
14019
|
+
{
|
14020
|
+
"kind": "method",
|
14021
|
+
"name": "handleClick",
|
14022
|
+
"privacy": "private",
|
14023
|
+
"return": {
|
14024
|
+
"type": {
|
14025
|
+
"text": "void"
|
14026
|
+
}
|
14027
|
+
},
|
14028
|
+
"inheritedFrom": {
|
14029
|
+
"name": "ListItem",
|
14030
|
+
"module": "components/listitem/listitem.component.js"
|
14031
|
+
}
|
14032
|
+
},
|
14033
|
+
{
|
14034
|
+
"kind": "method",
|
14035
|
+
"name": "displayTooltipForLongText",
|
14036
|
+
"privacy": "private",
|
14037
|
+
"return": {
|
14038
|
+
"type": {
|
14039
|
+
"text": "void"
|
14040
|
+
}
|
14041
|
+
},
|
14042
|
+
"description": "Display a tooltip for the listitem.\nCreate the tooltip programmatically after the nearest parent element.",
|
14043
|
+
"inheritedFrom": {
|
14044
|
+
"name": "ListItem",
|
14045
|
+
"module": "components/listitem/listitem.component.js"
|
14046
|
+
}
|
14047
|
+
},
|
14048
|
+
{
|
14049
|
+
"kind": "method",
|
14050
|
+
"name": "hideTooltipOnLeave",
|
14051
|
+
"privacy": "private",
|
14052
|
+
"return": {
|
14053
|
+
"type": {
|
14054
|
+
"text": "void"
|
14055
|
+
}
|
14056
|
+
},
|
14057
|
+
"description": "Removes the dynamically created tooltip for long text label on focus or mouse leave.\nThis is triggered on focusout and mouseout events.",
|
14058
|
+
"inheritedFrom": {
|
14059
|
+
"name": "ListItem",
|
14060
|
+
"module": "components/listitem/listitem.component.js"
|
14061
|
+
}
|
14062
|
+
},
|
13851
14063
|
{
|
13852
14064
|
"kind": "method",
|
13853
14065
|
"name": "getText",
|
@@ -14113,6 +14325,31 @@
|
|
14113
14325
|
"name": "ListItem",
|
14114
14326
|
"module": "src/components/listitem/listitem.component.ts"
|
14115
14327
|
}
|
14328
|
+
},
|
14329
|
+
{
|
14330
|
+
"name": "tooltip-text",
|
14331
|
+
"type": {
|
14332
|
+
"text": "string | undefined"
|
14333
|
+
},
|
14334
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
14335
|
+
"fieldName": "tooltipText",
|
14336
|
+
"inheritedFrom": {
|
14337
|
+
"name": "ListItem",
|
14338
|
+
"module": "src/components/listitem/listitem.component.ts"
|
14339
|
+
}
|
14340
|
+
},
|
14341
|
+
{
|
14342
|
+
"name": "tooltip-placement",
|
14343
|
+
"type": {
|
14344
|
+
"text": "PopoverPlacement"
|
14345
|
+
},
|
14346
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
14347
|
+
"default": "'top'",
|
14348
|
+
"fieldName": "tooltipPlacement",
|
14349
|
+
"inheritedFrom": {
|
14350
|
+
"name": "ListItem",
|
14351
|
+
"module": "src/components/listitem/listitem.component.ts"
|
14352
|
+
}
|
14116
14353
|
}
|
14117
14354
|
],
|
14118
14355
|
"mixins": [
|
@@ -14126,7 +14363,7 @@
|
|
14126
14363
|
"module": "/src/components/listitem/listitem.component"
|
14127
14364
|
},
|
14128
14365
|
"tagName": "mdc-option",
|
14129
|
-
"jsDoc": "/**\n * option component, which is used as a list item in a select component.<br/>\n * We can pass an icon which will be displayed in leading position of the option label text.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-option\n *\n * @slot default - This is a default/unnamed slot\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
|
14366
|
+
"jsDoc": "/**\n * option component, which is used as a list item in a select component.<br/>\n * We can pass an icon which will be displayed in leading position of the option label text.\n * We can pass a tooltip which will be displayed on hover of the option label text.\n * The tooltip will be helpful for a long label text which is truncated with ellipsis.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-option\n *\n * @slot default - This is a default/unnamed slot\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
|
14130
14367
|
"customElement": true,
|
14131
14368
|
"cssProperties": [
|
14132
14369
|
{
|
@@ -14184,6 +14421,14 @@
|
|
14184
14421
|
"name": "ListItem",
|
14185
14422
|
"module": "src/components/listitem/listitem.component.ts"
|
14186
14423
|
}
|
14424
|
+
},
|
14425
|
+
{
|
14426
|
+
"description": "Allows customization of padding left and right.",
|
14427
|
+
"name": "--mdc-listitem-padding-left-and-right",
|
14428
|
+
"inheritedFrom": {
|
14429
|
+
"name": "ListItem",
|
14430
|
+
"module": "src/components/listitem/listitem.component.ts"
|
14431
|
+
}
|
14187
14432
|
}
|
14188
14433
|
]
|
14189
14434
|
}
|
@@ -21319,84 +21564,74 @@
|
|
21319
21564
|
},
|
21320
21565
|
{
|
21321
21566
|
"kind": "javascript-module",
|
21322
|
-
"path": "components/
|
21567
|
+
"path": "components/text/text.component.js",
|
21323
21568
|
"declarations": [
|
21324
21569
|
{
|
21325
21570
|
"kind": "class",
|
21326
|
-
"description": "
|
21327
|
-
"name": "
|
21328
|
-
"
|
21329
|
-
{
|
21330
|
-
"description": "Gap between tabs",
|
21331
|
-
"name": "--mdc-tablist-gap"
|
21332
|
-
},
|
21333
|
-
{
|
21334
|
-
"description": "Width of the tablist",
|
21335
|
-
"name": "--mdc-tablist-width"
|
21336
|
-
},
|
21571
|
+
"description": "Text component for creating styled text elements.\nIt has to be mounted within the ThemeProvider to access color and font tokens.\n\nThe `type` attribute allows changing the text style.\nThe `tagname` attribute allows changing the tag name of the text element.\nThe default tag name is `p`.\n\nThe `tagname` attribute should be a valid HTML tag name.\nIf the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n\nThe styling is applied based on the `type` attribute.",
|
21572
|
+
"name": "Text",
|
21573
|
+
"cssParts": [
|
21337
21574
|
{
|
21338
|
-
"description": "
|
21339
|
-
"name": "
|
21575
|
+
"description": "The text element",
|
21576
|
+
"name": "text"
|
21340
21577
|
}
|
21341
21578
|
],
|
21342
21579
|
"slots": [
|
21343
21580
|
{
|
21344
|
-
"description": "slot for
|
21345
|
-
"name": "
|
21581
|
+
"description": "Default slot for text content",
|
21582
|
+
"name": ""
|
21346
21583
|
}
|
21347
21584
|
],
|
21348
21585
|
"members": [
|
21349
21586
|
{
|
21350
21587
|
"kind": "field",
|
21351
|
-
"name": "
|
21588
|
+
"name": "type",
|
21352
21589
|
"type": {
|
21353
|
-
"text": "
|
21590
|
+
"text": "TextType"
|
21354
21591
|
},
|
21355
|
-
"
|
21356
|
-
"
|
21592
|
+
"privacy": "public",
|
21593
|
+
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
21594
|
+
"default": "body-large-regular",
|
21595
|
+
"attribute": "type",
|
21357
21596
|
"reflects": true
|
21358
21597
|
},
|
21359
21598
|
{
|
21360
21599
|
"kind": "field",
|
21361
|
-
"name": "
|
21600
|
+
"name": "tagname",
|
21362
21601
|
"type": {
|
21363
|
-
"text": "
|
21602
|
+
"text": "TagName | undefined"
|
21364
21603
|
},
|
21365
|
-
"
|
21366
|
-
"
|
21367
|
-
|
21368
|
-
|
21369
|
-
"events": [
|
21370
|
-
{
|
21371
|
-
"description": "(React: onChange) This event is dispatched when the tab is selected. Event that fires when user changes the active tab. The function sent as the argument will receive the fired event and the new tab id can be fetched from event.detail.tabId. `(event: CustomEvent) => handleTabChange(event.detail.tabId);`",
|
21372
|
-
"name": "change",
|
21373
|
-
"reactName": "onChange"
|
21604
|
+
"privacy": "public",
|
21605
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
21606
|
+
"attribute": "tagname",
|
21607
|
+
"reflects": true
|
21374
21608
|
}
|
21375
21609
|
],
|
21376
21610
|
"attributes": [
|
21377
21611
|
{
|
21378
|
-
"name": "
|
21612
|
+
"name": "type",
|
21379
21613
|
"type": {
|
21380
|
-
"text": "
|
21614
|
+
"text": "TextType"
|
21381
21615
|
},
|
21382
|
-
"description": "
|
21383
|
-
"
|
21616
|
+
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
21617
|
+
"default": "body-large-regular",
|
21618
|
+
"fieldName": "type"
|
21384
21619
|
},
|
21385
21620
|
{
|
21386
|
-
"name": "
|
21621
|
+
"name": "tagname",
|
21387
21622
|
"type": {
|
21388
|
-
"text": "
|
21623
|
+
"text": "TagName | undefined"
|
21389
21624
|
},
|
21390
|
-
"description": "
|
21391
|
-
"fieldName": "
|
21625
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
21626
|
+
"fieldName": "tagname"
|
21392
21627
|
}
|
21393
21628
|
],
|
21394
21629
|
"superclass": {
|
21395
21630
|
"name": "Component",
|
21396
21631
|
"module": "/src/models"
|
21397
21632
|
},
|
21398
|
-
"tagName": "mdc-
|
21399
|
-
"jsDoc": "/**\n *
|
21633
|
+
"tagName": "mdc-text",
|
21634
|
+
"jsDoc": "/**\n * Text component for creating styled text elements.\n * It has to be mounted within the ThemeProvider to access color and font tokens.\n *\n * The `type` attribute allows changing the text style.\n * The `tagname` attribute allows changing the tag name of the text element.\n * The default tag name is `p`.\n *\n * The `tagname` attribute should be a valid HTML tag name.\n * If the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n *\n * The styling is applied based on the `type` attribute.\n *\n * @tagname mdc-text\n * @slot - Default slot for text content\n *\n * @csspart text - The text element\n */",
|
21400
21635
|
"customElement": true
|
21401
21636
|
}
|
21402
21637
|
],
|
@@ -21405,82 +21640,92 @@
|
|
21405
21640
|
"kind": "js",
|
21406
21641
|
"name": "default",
|
21407
21642
|
"declaration": {
|
21408
|
-
"name": "
|
21409
|
-
"module": "components/
|
21643
|
+
"name": "Text",
|
21644
|
+
"module": "components/text/text.component.js"
|
21410
21645
|
}
|
21411
21646
|
}
|
21412
21647
|
]
|
21413
21648
|
},
|
21414
21649
|
{
|
21415
21650
|
"kind": "javascript-module",
|
21416
|
-
"path": "components/
|
21651
|
+
"path": "components/tablist/tablist.component.js",
|
21417
21652
|
"declarations": [
|
21418
21653
|
{
|
21419
21654
|
"kind": "class",
|
21420
|
-
"description": "
|
21421
|
-
"name": "
|
21422
|
-
"
|
21655
|
+
"description": "Tab list organizes tabs into a container.\n\nChildren of the tab list are `mdc-tab` elements, sent to the default slot.\n\nThe tabs can be navigated using the left/right arrow keys, and selected by clicking,\n or pressing the Enter and Space keys.\n\n**Implicit accessibility rules**\n\n- The element that serves as the container for the set of tabs has role `tablist`.\n- Each element that serves as a tab has role `tab` and is contained within the element with role `tablist`.\n- The active tab element has the state `aria-selected` set to `true`\n and all other tab elements have it set to `false`.\n\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- Each element that contains the `content panel` for a `tab` has role `tabpanel`.\n- The `tablist` element needs to have a label provided by `data-aria-label`.\n- Each element with role `tab` has the property `aria-controls`\n that should refer to its associated `tabpanel` element.\n- Each element with role `tabpanel` has the property `aria-labelledby` referring to its associated `tab` element.\n- If a `tab` element has a popup menu, it needs to have the property `aria-haspopup` set to either `menu` or `true`.",
|
21656
|
+
"name": "TabList",
|
21657
|
+
"cssProperties": [
|
21423
21658
|
{
|
21424
|
-
"description": "
|
21425
|
-
"name": "
|
21659
|
+
"description": "Gap between tabs",
|
21660
|
+
"name": "--mdc-tablist-gap"
|
21661
|
+
},
|
21662
|
+
{
|
21663
|
+
"description": "Width of the tablist",
|
21664
|
+
"name": "--mdc-tablist-width"
|
21665
|
+
},
|
21666
|
+
{
|
21667
|
+
"description": "Margin value for the arrow button",
|
21668
|
+
"name": "--mdc-tablist-arrow-button-margin"
|
21426
21669
|
}
|
21427
21670
|
],
|
21428
21671
|
"slots": [
|
21429
21672
|
{
|
21430
|
-
"description": "
|
21431
|
-
"name": ""
|
21673
|
+
"description": "slot for mdc-tab elements.",
|
21674
|
+
"name": "Default"
|
21432
21675
|
}
|
21433
21676
|
],
|
21434
21677
|
"members": [
|
21435
21678
|
{
|
21436
21679
|
"kind": "field",
|
21437
|
-
"name": "
|
21680
|
+
"name": "activeTabId",
|
21438
21681
|
"type": {
|
21439
|
-
"text": "
|
21682
|
+
"text": "string | undefined"
|
21440
21683
|
},
|
21441
|
-
"
|
21442
|
-
"
|
21443
|
-
"default": "body-large-regular",
|
21444
|
-
"attribute": "type",
|
21684
|
+
"description": "ID of the active tab, defaults to the first tab if not provided",
|
21685
|
+
"attribute": "active-tab-id",
|
21445
21686
|
"reflects": true
|
21446
21687
|
},
|
21447
21688
|
{
|
21448
21689
|
"kind": "field",
|
21449
|
-
"name": "
|
21690
|
+
"name": "dataAriaLabel",
|
21450
21691
|
"type": {
|
21451
|
-
"text": "
|
21692
|
+
"text": "string | undefined"
|
21452
21693
|
},
|
21453
|
-
"
|
21454
|
-
"
|
21455
|
-
|
21456
|
-
|
21694
|
+
"description": "Label for the tablist.\nThis is used when the tablist does not have a visible label.",
|
21695
|
+
"attribute": "data-aria-label"
|
21696
|
+
}
|
21697
|
+
],
|
21698
|
+
"events": [
|
21699
|
+
{
|
21700
|
+
"description": "(React: onChange) This event is dispatched when the tab is selected. Event that fires when user changes the active tab. The function sent as the argument will receive the fired event and the new tab id can be fetched from event.detail.tabId. `(event: CustomEvent) => handleTabChange(event.detail.tabId);`",
|
21701
|
+
"name": "change",
|
21702
|
+
"reactName": "onChange"
|
21457
21703
|
}
|
21458
21704
|
],
|
21459
21705
|
"attributes": [
|
21460
21706
|
{
|
21461
|
-
"name": "
|
21707
|
+
"name": "active-tab-id",
|
21462
21708
|
"type": {
|
21463
|
-
"text": "
|
21709
|
+
"text": "string | undefined"
|
21464
21710
|
},
|
21465
|
-
"description": "
|
21466
|
-
"
|
21467
|
-
"fieldName": "type"
|
21711
|
+
"description": "ID of the active tab, defaults to the first tab if not provided",
|
21712
|
+
"fieldName": "activeTabId"
|
21468
21713
|
},
|
21469
21714
|
{
|
21470
|
-
"name": "
|
21715
|
+
"name": "data-aria-label",
|
21471
21716
|
"type": {
|
21472
|
-
"text": "
|
21717
|
+
"text": "string | undefined"
|
21473
21718
|
},
|
21474
|
-
"description": "
|
21475
|
-
"fieldName": "
|
21719
|
+
"description": "Label for the tablist.\nThis is used when the tablist does not have a visible label.",
|
21720
|
+
"fieldName": "dataAriaLabel"
|
21476
21721
|
}
|
21477
21722
|
],
|
21478
21723
|
"superclass": {
|
21479
21724
|
"name": "Component",
|
21480
21725
|
"module": "/src/models"
|
21481
21726
|
},
|
21482
|
-
"tagName": "mdc-
|
21483
|
-
"jsDoc": "/**\n *
|
21727
|
+
"tagName": "mdc-tablist",
|
21728
|
+
"jsDoc": "/**\n * Tab list organizes tabs into a container.\n *\n * Children of the tab list are `mdc-tab` elements, sent to the default slot.\n *\n * The tabs can be navigated using the left/right arrow keys, and selected by clicking,\n * or pressing the Enter and Space keys.\n *\n * **Implicit accessibility rules**\n *\n * - The element that serves as the container for the set of tabs has role `tablist`.\n * - Each element that serves as a tab has role `tab` and is contained within the element with role `tablist`.\n * - The active tab element has the state `aria-selected` set to `true`\n * and all other tab elements have it set to `false`.\n *\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - Each element that contains the `content panel` for a `tab` has role `tabpanel`.\n * - The `tablist` element needs to have a label provided by `data-aria-label`.\n * - Each element with role `tab` has the property `aria-controls`\n * that should refer to its associated `tabpanel` element.\n * - Each element with role `tabpanel` has the property `aria-labelledby` referring to its associated `tab` element.\n * - If a `tab` element has a popup menu, it needs to have the property `aria-haspopup` set to either `menu` or `true`.\n *\n * @tagname mdc-tablist\n *\n * @dependency mdc-tab\n * @dependency mdc-button\n *\n * @event change - (React: onChange) This event is dispatched when the tab is selected.\n * Event that fires when user changes the active tab.\n * The function sent as the argument will receive the fired event\n * and the new tab id can be fetched from event.detail.tabId.\n *\n * `(event: CustomEvent) => handleTabChange(event.detail.tabId);`\n *\n * @slot Default slot for mdc-tab elements.\n *\n * @cssproperty --mdc-tablist-gap - Gap between tabs\n * @cssproperty --mdc-tablist-width - Width of the tablist\n * @cssproperty --mdc-tablist-arrow-button-margin - Margin value for the arrow button\n */",
|
21484
21729
|
"customElement": true
|
21485
21730
|
}
|
21486
21731
|
],
|
@@ -21489,8 +21734,8 @@
|
|
21489
21734
|
"kind": "js",
|
21490
21735
|
"name": "default",
|
21491
21736
|
"declaration": {
|
21492
|
-
"name": "
|
21493
|
-
"module": "components/
|
21737
|
+
"name": "TabList",
|
21738
|
+
"module": "components/tablist/tablist.component.js"
|
21494
21739
|
}
|
21495
21740
|
}
|
21496
21741
|
]
|