@momentum-design/components 0.42.0 → 0.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +848 -848
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/package.json +1 -1
@@ -467,35 +467,36 @@
|
|
467
467
|
},
|
468
468
|
{
|
469
469
|
"kind": "javascript-module",
|
470
|
-
"path": "components/
|
470
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
471
471
|
"declarations": [
|
472
472
|
{
|
473
473
|
"kind": "class",
|
474
|
-
"description": "The `mdc-
|
475
|
-
"name": "
|
476
|
-
"
|
477
|
-
{
|
478
|
-
"description": "Allows customization of the default background color.",
|
479
|
-
"name": "--mdc-avatar-default-background-color"
|
480
|
-
},
|
481
|
-
{
|
482
|
-
"description": "Allows customization of the default foreground color.",
|
483
|
-
"name": "--mdc-avatar-default-foreground-color"
|
484
|
-
},
|
474
|
+
"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.",
|
475
|
+
"name": "AvatarButton",
|
476
|
+
"members": [
|
485
477
|
{
|
486
|
-
"
|
487
|
-
"name": "
|
478
|
+
"kind": "field",
|
479
|
+
"name": "ariaLabel",
|
480
|
+
"type": {
|
481
|
+
"text": "string | null"
|
482
|
+
},
|
483
|
+
"default": "null",
|
484
|
+
"description": "Aria-label attribute to be set for accessibility",
|
485
|
+
"attribute": "aria-label"
|
488
486
|
},
|
489
487
|
{
|
490
|
-
"
|
491
|
-
"name": "
|
488
|
+
"kind": "method",
|
489
|
+
"name": "setSize",
|
490
|
+
"privacy": "private",
|
491
|
+
"parameters": [
|
492
|
+
{
|
493
|
+
"name": "size",
|
494
|
+
"type": {
|
495
|
+
"text": "AvatarSize"
|
496
|
+
}
|
497
|
+
}
|
498
|
+
]
|
492
499
|
},
|
493
|
-
{
|
494
|
-
"description": "Allows customization of the loading overlay background color.",
|
495
|
-
"name": "--mdc-avatar-loading-overlay-background-color"
|
496
|
-
}
|
497
|
-
],
|
498
|
-
"members": [
|
499
500
|
{
|
500
501
|
"kind": "field",
|
501
502
|
"name": "src",
|
@@ -539,15 +540,15 @@
|
|
539
540
|
"kind": "field",
|
540
541
|
"name": "size",
|
541
542
|
"type": {
|
542
|
-
"text": "
|
543
|
+
"text": "ButtonSize"
|
543
544
|
},
|
544
545
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
545
546
|
"default": "32",
|
546
547
|
"attribute": "size",
|
547
548
|
"reflects": true,
|
548
549
|
"inheritedFrom": {
|
549
|
-
"name": "
|
550
|
-
"module": "
|
550
|
+
"name": "Buttonsimple",
|
551
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
551
552
|
}
|
552
553
|
},
|
553
554
|
{
|
@@ -589,407 +590,363 @@
|
|
589
590
|
"name": "IconNameMixin",
|
590
591
|
"module": "utils/mixins/IconNameMixin.js"
|
591
592
|
}
|
592
|
-
}
|
593
|
-
],
|
594
|
-
"mixins": [
|
595
|
-
{
|
596
|
-
"name": "AvatarComponentMixin",
|
597
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
598
593
|
},
|
599
594
|
{
|
600
|
-
"
|
601
|
-
"
|
602
|
-
}
|
603
|
-
],
|
604
|
-
"superclass": {
|
605
|
-
"name": "Component",
|
606
|
-
"module": "/src/models"
|
607
|
-
},
|
608
|
-
"tagName": "mdc-avatar",
|
609
|
-
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
|
610
|
-
"customElement": true,
|
611
|
-
"attributes": [
|
612
|
-
{
|
613
|
-
"name": "src",
|
595
|
+
"kind": "field",
|
596
|
+
"name": "tabIndex",
|
614
597
|
"type": {
|
615
|
-
"text": "
|
598
|
+
"text": "number"
|
616
599
|
},
|
617
|
-
"
|
618
|
-
"
|
600
|
+
"default": "0",
|
601
|
+
"description": "This property specifies the tab order of the element.",
|
602
|
+
"attribute": "tabIndex",
|
603
|
+
"reflects": true,
|
619
604
|
"inheritedFrom": {
|
620
|
-
"name": "
|
621
|
-
"module": "
|
605
|
+
"name": "TabIndexMixin",
|
606
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
622
607
|
}
|
623
608
|
},
|
624
609
|
{
|
625
|
-
"
|
610
|
+
"kind": "field",
|
611
|
+
"name": "disabled",
|
626
612
|
"type": {
|
627
|
-
"text": "
|
613
|
+
"text": "boolean | undefined"
|
628
614
|
},
|
629
|
-
"description": "
|
630
|
-
"
|
615
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
616
|
+
"default": "undefined",
|
617
|
+
"attribute": "disabled",
|
618
|
+
"reflects": true,
|
631
619
|
"inheritedFrom": {
|
632
|
-
"name": "
|
633
|
-
"module": "
|
620
|
+
"name": "DisabledMixin",
|
621
|
+
"module": "utils/mixins/DisabledMixin.js"
|
634
622
|
}
|
635
623
|
},
|
636
624
|
{
|
637
|
-
"
|
625
|
+
"kind": "field",
|
626
|
+
"name": "active",
|
638
627
|
"type": {
|
639
|
-
"text": "
|
628
|
+
"text": "boolean"
|
640
629
|
},
|
641
|
-
"
|
642
|
-
"
|
630
|
+
"default": "false",
|
631
|
+
"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.",
|
632
|
+
"attribute": "active",
|
633
|
+
"reflects": true,
|
643
634
|
"inheritedFrom": {
|
644
|
-
"name": "
|
645
|
-
"module": "
|
635
|
+
"name": "Buttonsimple",
|
636
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
646
637
|
}
|
647
638
|
},
|
648
639
|
{
|
649
|
-
"
|
640
|
+
"kind": "field",
|
641
|
+
"name": "softDisabled",
|
650
642
|
"type": {
|
651
|
-
"text": "
|
643
|
+
"text": "boolean"
|
652
644
|
},
|
653
|
-
"
|
654
|
-
"
|
655
|
-
"
|
645
|
+
"default": "false",
|
646
|
+
"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.",
|
647
|
+
"attribute": "soft-disabled",
|
656
648
|
"inheritedFrom": {
|
657
|
-
"name": "
|
658
|
-
"module": "
|
649
|
+
"name": "Buttonsimple",
|
650
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
659
651
|
}
|
660
652
|
},
|
661
653
|
{
|
662
|
-
"
|
663
|
-
"
|
664
|
-
|
665
|
-
|
666
|
-
"
|
667
|
-
"
|
654
|
+
"kind": "field",
|
655
|
+
"name": "role",
|
656
|
+
"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.",
|
657
|
+
"default": "button",
|
658
|
+
"attribute": "role",
|
659
|
+
"reflects": true,
|
668
660
|
"inheritedFrom": {
|
669
|
-
"name": "
|
670
|
-
"module": "
|
661
|
+
"name": "Buttonsimple",
|
662
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
671
663
|
}
|
672
664
|
},
|
673
665
|
{
|
674
|
-
"
|
666
|
+
"kind": "field",
|
667
|
+
"name": "type",
|
675
668
|
"type": {
|
676
|
-
"text": "
|
669
|
+
"text": "ButtonType"
|
677
670
|
},
|
678
|
-
"
|
679
|
-
"
|
680
|
-
"
|
671
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
672
|
+
"default": "button",
|
673
|
+
"attribute": "type",
|
674
|
+
"reflects": true,
|
681
675
|
"inheritedFrom": {
|
682
|
-
"name": "
|
683
|
-
"module": "
|
676
|
+
"name": "Buttonsimple",
|
677
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
684
678
|
}
|
685
679
|
},
|
686
680
|
{
|
687
|
-
"
|
688
|
-
"
|
689
|
-
|
690
|
-
},
|
691
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
692
|
-
"fieldName": "iconName",
|
681
|
+
"kind": "method",
|
682
|
+
"name": "executeAction",
|
683
|
+
"privacy": "protected",
|
693
684
|
"inheritedFrom": {
|
694
|
-
"name": "
|
695
|
-
"module": "
|
685
|
+
"name": "Buttonsimple",
|
686
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
696
687
|
}
|
697
|
-
}
|
698
|
-
]
|
699
|
-
}
|
700
|
-
],
|
701
|
-
"exports": [
|
702
|
-
{
|
703
|
-
"kind": "js",
|
704
|
-
"name": "default",
|
705
|
-
"declaration": {
|
706
|
-
"name": "Avatar",
|
707
|
-
"module": "components/avatar/avatar.component.js"
|
708
|
-
}
|
709
|
-
}
|
710
|
-
]
|
711
|
-
},
|
712
|
-
{
|
713
|
-
"kind": "javascript-module",
|
714
|
-
"path": "components/badge/badge.component.js",
|
715
|
-
"declarations": [
|
716
|
-
{
|
717
|
-
"kind": "class",
|
718
|
-
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
719
|
-
"name": "Badge",
|
720
|
-
"cssProperties": [
|
721
|
-
{
|
722
|
-
"description": "The foreground color of the primary badge.",
|
723
|
-
"name": "--mdc-badge-primary-foreground-color"
|
724
688
|
},
|
725
689
|
{
|
726
|
-
"
|
727
|
-
"name": "
|
690
|
+
"kind": "method",
|
691
|
+
"name": "setActive",
|
692
|
+
"privacy": "protected",
|
693
|
+
"parameters": [
|
694
|
+
{
|
695
|
+
"name": "element",
|
696
|
+
"type": {
|
697
|
+
"text": "HTMLElement"
|
698
|
+
},
|
699
|
+
"description": "The button element"
|
700
|
+
},
|
701
|
+
{
|
702
|
+
"name": "active",
|
703
|
+
"type": {
|
704
|
+
"text": "boolean"
|
705
|
+
},
|
706
|
+
"description": "The active state of the element"
|
707
|
+
}
|
708
|
+
],
|
709
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
710
|
+
"inheritedFrom": {
|
711
|
+
"name": "Buttonsimple",
|
712
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
713
|
+
}
|
728
714
|
},
|
729
715
|
{
|
730
|
-
"
|
731
|
-
"name": "
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
749
|
-
|
750
|
-
"
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
"description": "The foreground color of the error badge.",
|
755
|
-
"name": "--mdc-badge-error-foreground-color"
|
756
|
-
},
|
757
|
-
{
|
758
|
-
"description": "The background color of the error badge.",
|
759
|
-
"name": "--mdc-badge-error-background-color"
|
760
|
-
},
|
761
|
-
{
|
762
|
-
"description": "The background color of the badge overlay.",
|
763
|
-
"name": "--mdc-badge-overlay-background-color"
|
764
|
-
}
|
765
|
-
],
|
766
|
-
"members": [
|
767
|
-
{
|
768
|
-
"kind": "field",
|
769
|
-
"name": "type",
|
770
|
-
"type": {
|
771
|
-
"text": "BadgeType | undefined"
|
772
|
-
},
|
773
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
774
|
-
"attribute": "type",
|
775
|
-
"reflects": true
|
776
|
-
},
|
777
|
-
{
|
778
|
-
"kind": "field",
|
779
|
-
"name": "variant",
|
780
|
-
"type": {
|
781
|
-
"text": "IconVariant"
|
782
|
-
},
|
783
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
784
|
-
"default": "primary",
|
785
|
-
"attribute": "variant",
|
786
|
-
"reflects": true
|
787
|
-
},
|
788
|
-
{
|
789
|
-
"kind": "field",
|
790
|
-
"name": "counter",
|
791
|
-
"type": {
|
792
|
-
"text": "number | undefined"
|
793
|
-
},
|
794
|
-
"description": "Counter is the number which can be provided in the badge.",
|
795
|
-
"attribute": "counter"
|
796
|
-
},
|
797
|
-
{
|
798
|
-
"kind": "field",
|
799
|
-
"name": "maxCounter",
|
800
|
-
"type": {
|
801
|
-
"text": "number"
|
802
|
-
},
|
803
|
-
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
804
|
-
"default": "99",
|
805
|
-
"attribute": "max-counter",
|
806
|
-
"reflects": true
|
807
|
-
},
|
808
|
-
{
|
809
|
-
"kind": "field",
|
810
|
-
"name": "overlay",
|
811
|
-
"type": {
|
812
|
-
"text": "boolean"
|
813
|
-
},
|
814
|
-
"default": "false",
|
815
|
-
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
816
|
-
"attribute": "overlay"
|
817
|
-
},
|
818
|
-
{
|
819
|
-
"kind": "field",
|
820
|
-
"name": "ariaLabel",
|
821
|
-
"type": {
|
822
|
-
"text": "string | null"
|
823
|
-
},
|
824
|
-
"default": "null",
|
825
|
-
"description": "Aria-label attribute to be set for accessibility",
|
826
|
-
"attribute": "aria-label"
|
716
|
+
"kind": "method",
|
717
|
+
"name": "setSoftDisabled",
|
718
|
+
"privacy": "private",
|
719
|
+
"parameters": [
|
720
|
+
{
|
721
|
+
"name": "element",
|
722
|
+
"type": {
|
723
|
+
"text": "HTMLElement"
|
724
|
+
},
|
725
|
+
"description": "The button element."
|
726
|
+
},
|
727
|
+
{
|
728
|
+
"name": "softDisabled",
|
729
|
+
"type": {
|
730
|
+
"text": "boolean"
|
731
|
+
},
|
732
|
+
"description": "The soft-disabled state."
|
733
|
+
}
|
734
|
+
],
|
735
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
736
|
+
"inheritedFrom": {
|
737
|
+
"name": "Buttonsimple",
|
738
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
739
|
+
}
|
827
740
|
},
|
828
741
|
{
|
829
742
|
"kind": "method",
|
830
|
-
"name": "
|
743
|
+
"name": "setDisabled",
|
831
744
|
"privacy": "private",
|
832
|
-
"return": {
|
833
|
-
"type": {
|
834
|
-
"text": ""
|
835
|
-
}
|
836
|
-
},
|
837
745
|
"parameters": [
|
838
746
|
{
|
839
|
-
"name": "
|
747
|
+
"name": "element",
|
840
748
|
"type": {
|
841
|
-
"text": "
|
749
|
+
"text": "HTMLElement"
|
842
750
|
},
|
843
|
-
"description": "
|
751
|
+
"description": "The button element."
|
844
752
|
},
|
845
753
|
{
|
846
|
-
"name": "
|
847
|
-
"optional": true,
|
754
|
+
"name": "disabled",
|
848
755
|
"type": {
|
849
|
-
"text": "
|
756
|
+
"text": "boolean"
|
850
757
|
},
|
851
|
-
"description": "
|
758
|
+
"description": "The disabled state."
|
852
759
|
}
|
853
760
|
],
|
854
|
-
"description": "
|
761
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
762
|
+
"inheritedFrom": {
|
763
|
+
"name": "Buttonsimple",
|
764
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
765
|
+
}
|
855
766
|
},
|
856
767
|
{
|
857
768
|
"kind": "method",
|
858
|
-
"name": "
|
769
|
+
"name": "triggerClickEvent",
|
859
770
|
"privacy": "private",
|
860
|
-
"
|
861
|
-
"
|
862
|
-
|
863
|
-
|
864
|
-
},
|
865
|
-
"parameters": [
|
866
|
-
{
|
867
|
-
"name": "iconName",
|
868
|
-
"type": {
|
869
|
-
"text": "string"
|
870
|
-
},
|
871
|
-
"description": "the name of the icon from the icon set"
|
872
|
-
},
|
873
|
-
{
|
874
|
-
"name": "backgroundClassPostfix",
|
875
|
-
"type": {
|
876
|
-
"text": "string"
|
877
|
-
},
|
878
|
-
"description": "postfix for the class to style the badge icon."
|
879
|
-
}
|
880
|
-
],
|
881
|
-
"description": "Method to generate the badge icon."
|
771
|
+
"inheritedFrom": {
|
772
|
+
"name": "Buttonsimple",
|
773
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
774
|
+
}
|
882
775
|
},
|
883
776
|
{
|
884
777
|
"kind": "method",
|
885
|
-
"name": "
|
778
|
+
"name": "handleBlur",
|
886
779
|
"privacy": "private",
|
887
|
-
"
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
}
|
892
|
-
"description": "Method to generate the badge dot template."
|
780
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
781
|
+
"inheritedFrom": {
|
782
|
+
"name": "Buttonsimple",
|
783
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
784
|
+
}
|
893
785
|
},
|
894
786
|
{
|
895
787
|
"kind": "method",
|
896
|
-
"name": "
|
788
|
+
"name": "handleKeyDown",
|
897
789
|
"privacy": "private",
|
898
|
-
"
|
899
|
-
|
900
|
-
"
|
790
|
+
"parameters": [
|
791
|
+
{
|
792
|
+
"name": "event",
|
793
|
+
"type": {
|
794
|
+
"text": "KeyboardEvent"
|
795
|
+
},
|
796
|
+
"description": "The keyboard event."
|
901
797
|
}
|
902
|
-
|
903
|
-
"description": "
|
798
|
+
],
|
799
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
|
800
|
+
"inheritedFrom": {
|
801
|
+
"name": "Buttonsimple",
|
802
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
803
|
+
}
|
904
804
|
},
|
905
805
|
{
|
906
806
|
"kind": "method",
|
907
|
-
"name": "
|
807
|
+
"name": "handleKeyUp",
|
908
808
|
"privacy": "private",
|
909
|
-
"
|
910
|
-
|
911
|
-
"
|
809
|
+
"parameters": [
|
810
|
+
{
|
811
|
+
"name": "event",
|
812
|
+
"type": {
|
813
|
+
"text": "KeyboardEvent"
|
814
|
+
},
|
815
|
+
"description": "The keyboard event."
|
912
816
|
}
|
913
|
-
|
914
|
-
"description": "
|
817
|
+
],
|
818
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
819
|
+
"inheritedFrom": {
|
820
|
+
"name": "Buttonsimple",
|
821
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
822
|
+
}
|
823
|
+
}
|
824
|
+
],
|
825
|
+
"events": [
|
826
|
+
{
|
827
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
828
|
+
"name": "click",
|
829
|
+
"reactName": "onClick",
|
830
|
+
"eventName": "ClickEvent",
|
831
|
+
"inheritedFrom": {
|
832
|
+
"name": "Buttonsimple",
|
833
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
834
|
+
}
|
915
835
|
},
|
916
836
|
{
|
917
|
-
"
|
918
|
-
"name": "
|
919
|
-
"
|
920
|
-
"
|
921
|
-
|
922
|
-
|
923
|
-
|
924
|
-
}
|
925
|
-
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
837
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
838
|
+
"name": "keydown",
|
839
|
+
"reactName": "onKeyDown",
|
840
|
+
"eventName": "KeydownEvent",
|
841
|
+
"inheritedFrom": {
|
842
|
+
"name": "Buttonsimple",
|
843
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
844
|
+
}
|
926
845
|
},
|
927
846
|
{
|
928
|
-
"
|
929
|
-
"name": "
|
930
|
-
"
|
931
|
-
|
932
|
-
},
|
933
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
934
|
-
"attribute": "icon-name",
|
847
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
848
|
+
"name": "keyup",
|
849
|
+
"reactName": "onKeyUp",
|
850
|
+
"eventName": "KeyupEvent",
|
935
851
|
"inheritedFrom": {
|
936
|
-
"name": "
|
937
|
-
"module": "
|
852
|
+
"name": "Buttonsimple",
|
853
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
854
|
+
}
|
855
|
+
},
|
856
|
+
{
|
857
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
858
|
+
"name": "focus",
|
859
|
+
"reactName": "onFocus",
|
860
|
+
"eventName": "FocusEvent",
|
861
|
+
"inheritedFrom": {
|
862
|
+
"name": "Buttonsimple",
|
863
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
938
864
|
}
|
939
865
|
}
|
940
866
|
],
|
941
867
|
"attributes": [
|
942
868
|
{
|
943
|
-
"name": "
|
869
|
+
"name": "aria-label",
|
944
870
|
"type": {
|
945
|
-
"text": "
|
871
|
+
"text": "string | null"
|
946
872
|
},
|
947
|
-
"
|
948
|
-
"
|
873
|
+
"default": "null",
|
874
|
+
"description": "Aria-label attribute to be set for accessibility",
|
875
|
+
"fieldName": "ariaLabel"
|
949
876
|
},
|
950
877
|
{
|
951
|
-
"name": "
|
878
|
+
"name": "src",
|
952
879
|
"type": {
|
953
|
-
"text": "
|
880
|
+
"text": "string | undefined"
|
954
881
|
},
|
955
|
-
"description": "
|
956
|
-
"
|
957
|
-
"
|
882
|
+
"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.",
|
883
|
+
"fieldName": "src",
|
884
|
+
"inheritedFrom": {
|
885
|
+
"name": "AvatarComponentMixin",
|
886
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
887
|
+
}
|
958
888
|
},
|
959
889
|
{
|
960
|
-
"name": "
|
890
|
+
"name": "initials",
|
961
891
|
"type": {
|
962
|
-
"text": "
|
892
|
+
"text": "string | undefined"
|
963
893
|
},
|
964
|
-
"description": "
|
965
|
-
"fieldName": "
|
894
|
+
"description": "The initials to be displayed for the avatar.",
|
895
|
+
"fieldName": "initials",
|
896
|
+
"inheritedFrom": {
|
897
|
+
"name": "AvatarComponentMixin",
|
898
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
899
|
+
}
|
966
900
|
},
|
967
901
|
{
|
968
|
-
"name": "
|
902
|
+
"name": "presence",
|
969
903
|
"type": {
|
970
|
-
"text": "
|
904
|
+
"text": "PresenceType | undefined"
|
971
905
|
},
|
972
|
-
"description": "The
|
973
|
-
"
|
974
|
-
"
|
906
|
+
"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`",
|
907
|
+
"fieldName": "presence",
|
908
|
+
"inheritedFrom": {
|
909
|
+
"name": "AvatarComponentMixin",
|
910
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
911
|
+
}
|
975
912
|
},
|
976
913
|
{
|
977
|
-
"name": "
|
914
|
+
"name": "size",
|
978
915
|
"type": {
|
979
|
-
"text": "
|
916
|
+
"text": "ButtonSize"
|
980
917
|
},
|
981
|
-
"
|
982
|
-
"
|
983
|
-
"fieldName": "
|
918
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
919
|
+
"default": "32",
|
920
|
+
"fieldName": "size",
|
921
|
+
"inheritedFrom": {
|
922
|
+
"name": "Buttonsimple",
|
923
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
924
|
+
}
|
984
925
|
},
|
985
926
|
{
|
986
|
-
"name": "
|
927
|
+
"name": "counter",
|
987
928
|
"type": {
|
988
|
-
"text": "
|
929
|
+
"text": "number | undefined"
|
989
930
|
},
|
990
|
-
"
|
991
|
-
"
|
992
|
-
"
|
931
|
+
"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`.",
|
932
|
+
"fieldName": "counter",
|
933
|
+
"inheritedFrom": {
|
934
|
+
"name": "AvatarComponentMixin",
|
935
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
936
|
+
}
|
937
|
+
},
|
938
|
+
{
|
939
|
+
"name": "is-typing",
|
940
|
+
"type": {
|
941
|
+
"text": "boolean"
|
942
|
+
},
|
943
|
+
"default": "false",
|
944
|
+
"description": "Represents the typing indicator when the user is typing.",
|
945
|
+
"fieldName": "isTyping",
|
946
|
+
"inheritedFrom": {
|
947
|
+
"name": "AvatarComponentMixin",
|
948
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
949
|
+
}
|
993
950
|
},
|
994
951
|
{
|
995
952
|
"name": "icon-name",
|
@@ -1002,126 +959,99 @@
|
|
1002
959
|
"name": "IconNameMixin",
|
1003
960
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
1004
961
|
}
|
1005
|
-
}
|
1006
|
-
],
|
1007
|
-
"mixins": [
|
962
|
+
},
|
1008
963
|
{
|
1009
|
-
"name": "
|
1010
|
-
"
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1021
|
-
],
|
1022
|
-
"exports": [
|
1023
|
-
{
|
1024
|
-
"kind": "js",
|
1025
|
-
"name": "default",
|
1026
|
-
"declaration": {
|
1027
|
-
"name": "Badge",
|
1028
|
-
"module": "components/badge/badge.component.js"
|
1029
|
-
}
|
1030
|
-
}
|
1031
|
-
]
|
1032
|
-
},
|
1033
|
-
{
|
1034
|
-
"kind": "javascript-module",
|
1035
|
-
"path": "components/brandvisual/brandvisual.component.js",
|
1036
|
-
"declarations": [
|
1037
|
-
{
|
1038
|
-
"kind": "class",
|
1039
|
-
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
1040
|
-
"name": "Brandvisual",
|
1041
|
-
"members": [
|
964
|
+
"name": "tabIndex",
|
965
|
+
"type": {
|
966
|
+
"text": "number"
|
967
|
+
},
|
968
|
+
"default": "0",
|
969
|
+
"description": "This property specifies the tab order of the element.",
|
970
|
+
"fieldName": "tabIndex",
|
971
|
+
"inheritedFrom": {
|
972
|
+
"name": "TabIndexMixin",
|
973
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
974
|
+
}
|
975
|
+
},
|
1042
976
|
{
|
1043
|
-
"
|
1044
|
-
"name": "brandVisualData",
|
977
|
+
"name": "disabled",
|
1045
978
|
"type": {
|
1046
|
-
"text": "
|
979
|
+
"text": "boolean | undefined"
|
1047
980
|
},
|
1048
|
-
"
|
981
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
982
|
+
"default": "undefined",
|
983
|
+
"fieldName": "disabled",
|
984
|
+
"inheritedFrom": {
|
985
|
+
"name": "DisabledMixin",
|
986
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
987
|
+
}
|
988
|
+
},
|
989
|
+
{
|
990
|
+
"name": "active",
|
991
|
+
"type": {
|
992
|
+
"text": "boolean"
|
993
|
+
},
|
994
|
+
"default": "false",
|
995
|
+
"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.",
|
996
|
+
"fieldName": "active",
|
997
|
+
"inheritedFrom": {
|
998
|
+
"name": "Buttonsimple",
|
999
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1000
|
+
}
|
1049
1001
|
},
|
1050
1002
|
{
|
1051
|
-
"
|
1052
|
-
"name": "name",
|
1003
|
+
"name": "soft-disabled",
|
1053
1004
|
"type": {
|
1054
|
-
"text": "
|
1005
|
+
"text": "boolean"
|
1055
1006
|
},
|
1056
|
-
"
|
1057
|
-
"
|
1058
|
-
"
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
"privacy": "private"
|
1007
|
+
"default": "false",
|
1008
|
+
"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.",
|
1009
|
+
"fieldName": "softDisabled",
|
1010
|
+
"inheritedFrom": {
|
1011
|
+
"name": "Buttonsimple",
|
1012
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1013
|
+
}
|
1064
1014
|
},
|
1065
1015
|
{
|
1066
|
-
"
|
1067
|
-
"
|
1068
|
-
"
|
1069
|
-
"
|
1070
|
-
|
1071
|
-
|
1072
|
-
|
1073
|
-
|
1074
|
-
},
|
1075
|
-
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1076
|
-
}
|
1077
|
-
],
|
1078
|
-
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1016
|
+
"name": "role",
|
1017
|
+
"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.",
|
1018
|
+
"default": "button",
|
1019
|
+
"fieldName": "role",
|
1020
|
+
"inheritedFrom": {
|
1021
|
+
"name": "Buttonsimple",
|
1022
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1023
|
+
}
|
1079
1024
|
},
|
1080
1025
|
{
|
1081
|
-
"
|
1082
|
-
"
|
1083
|
-
|
1084
|
-
|
1085
|
-
|
1086
|
-
|
1087
|
-
|
1088
|
-
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1092
|
-
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
1026
|
+
"name": "type",
|
1027
|
+
"type": {
|
1028
|
+
"text": "ButtonType"
|
1029
|
+
},
|
1030
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
1031
|
+
"default": "button",
|
1032
|
+
"fieldName": "type",
|
1033
|
+
"inheritedFrom": {
|
1034
|
+
"name": "Buttonsimple",
|
1035
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1036
|
+
}
|
1093
1037
|
}
|
1094
1038
|
],
|
1095
|
-
"
|
1039
|
+
"mixins": [
|
1096
1040
|
{
|
1097
|
-
"
|
1098
|
-
"
|
1099
|
-
"reactName": "onLoad",
|
1100
|
-
"eventName": "LoadEvent"
|
1041
|
+
"name": "AvatarComponentMixin",
|
1042
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1101
1043
|
},
|
1102
1044
|
{
|
1103
|
-
"
|
1104
|
-
"
|
1105
|
-
"reactName": "onError",
|
1106
|
-
"eventName": "ErrorEvent"
|
1107
|
-
}
|
1108
|
-
],
|
1109
|
-
"attributes": [
|
1110
|
-
{
|
1111
|
-
"name": "name",
|
1112
|
-
"type": {
|
1113
|
-
"text": "BrandVisualNames | undefined"
|
1114
|
-
},
|
1115
|
-
"description": "Name of the brandVisual (= filename)",
|
1116
|
-
"fieldName": "name"
|
1045
|
+
"name": "IconNameMixin",
|
1046
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1117
1047
|
}
|
1118
1048
|
],
|
1119
1049
|
"superclass": {
|
1120
|
-
"name": "
|
1121
|
-
"module": "/src/
|
1050
|
+
"name": "Buttonsimple",
|
1051
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1122
1052
|
},
|
1123
|
-
"tagName": "mdc-
|
1124
|
-
"jsDoc": "/**\n * The `mdc-
|
1053
|
+
"tagName": "mdc-avatarbutton",
|
1054
|
+
"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 */",
|
1125
1055
|
"customElement": true
|
1126
1056
|
}
|
1127
1057
|
],
|
@@ -1130,565 +1060,537 @@
|
|
1130
1060
|
"kind": "js",
|
1131
1061
|
"name": "default",
|
1132
1062
|
"declaration": {
|
1133
|
-
"name": "
|
1134
|
-
"module": "components/
|
1063
|
+
"name": "AvatarButton",
|
1064
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1135
1065
|
}
|
1136
1066
|
}
|
1137
1067
|
]
|
1138
1068
|
},
|
1139
1069
|
{
|
1140
1070
|
"kind": "javascript-module",
|
1141
|
-
"path": "components/
|
1071
|
+
"path": "components/avatar/avatar.component.js",
|
1142
1072
|
"declarations": [
|
1143
1073
|
{
|
1144
1074
|
"kind": "class",
|
1145
|
-
"description": "
|
1146
|
-
"name": "
|
1075
|
+
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
1076
|
+
"name": "Avatar",
|
1147
1077
|
"cssProperties": [
|
1148
1078
|
{
|
1149
|
-
"description": "
|
1150
|
-
"name": "--mdc-
|
1079
|
+
"description": "Allows customization of the default background color.",
|
1080
|
+
"name": "--mdc-avatar-default-background-color"
|
1151
1081
|
},
|
1152
1082
|
{
|
1153
|
-
"description": "
|
1154
|
-
"name": "--mdc-
|
1083
|
+
"description": "Allows customization of the default foreground color.",
|
1084
|
+
"name": "--mdc-avatar-default-foreground-color"
|
1155
1085
|
},
|
1156
1086
|
{
|
1157
|
-
"description": "
|
1158
|
-
"name": "--mdc-
|
1087
|
+
"description": "Allows customization of the loading indicator background color.",
|
1088
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
1159
1089
|
},
|
1160
1090
|
{
|
1161
|
-
"description": "
|
1162
|
-
"name": "--mdc-
|
1091
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
1092
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
1093
|
+
},
|
1094
|
+
{
|
1095
|
+
"description": "Allows customization of the loading overlay background color.",
|
1096
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
1163
1097
|
}
|
1164
1098
|
],
|
1165
1099
|
"members": [
|
1100
|
+
{
|
1101
|
+
"kind": "field",
|
1102
|
+
"name": "src",
|
1103
|
+
"type": {
|
1104
|
+
"text": "string | undefined"
|
1105
|
+
},
|
1106
|
+
"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.",
|
1107
|
+
"attribute": "src",
|
1108
|
+
"inheritedFrom": {
|
1109
|
+
"name": "AvatarComponentMixin",
|
1110
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1111
|
+
}
|
1112
|
+
},
|
1113
|
+
{
|
1114
|
+
"kind": "field",
|
1115
|
+
"name": "initials",
|
1116
|
+
"type": {
|
1117
|
+
"text": "string | undefined"
|
1118
|
+
},
|
1119
|
+
"description": "The initials to be displayed for the avatar.",
|
1120
|
+
"attribute": "initials",
|
1121
|
+
"inheritedFrom": {
|
1122
|
+
"name": "AvatarComponentMixin",
|
1123
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1124
|
+
}
|
1125
|
+
},
|
1126
|
+
{
|
1127
|
+
"kind": "field",
|
1128
|
+
"name": "presence",
|
1129
|
+
"type": {
|
1130
|
+
"text": "PresenceType | undefined"
|
1131
|
+
},
|
1132
|
+
"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`",
|
1133
|
+
"attribute": "presence",
|
1134
|
+
"inheritedFrom": {
|
1135
|
+
"name": "AvatarComponentMixin",
|
1136
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1137
|
+
}
|
1138
|
+
},
|
1166
1139
|
{
|
1167
1140
|
"kind": "field",
|
1168
1141
|
"name": "size",
|
1169
1142
|
"type": {
|
1170
|
-
"text": "
|
1143
|
+
"text": "AvatarSize"
|
1171
1144
|
},
|
1172
|
-
"
|
1173
|
-
"
|
1174
|
-
"default": "small",
|
1145
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1146
|
+
"default": "32",
|
1175
1147
|
"attribute": "size",
|
1176
|
-
"reflects": true
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1148
|
+
"reflects": true,
|
1149
|
+
"inheritedFrom": {
|
1150
|
+
"name": "AvatarComponentMixin",
|
1151
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1152
|
+
}
|
1153
|
+
},
|
1180
1154
|
{
|
1181
|
-
"
|
1155
|
+
"kind": "field",
|
1156
|
+
"name": "counter",
|
1182
1157
|
"type": {
|
1183
|
-
"text": "
|
1158
|
+
"text": "number | undefined"
|
1184
1159
|
},
|
1185
|
-
"description": "
|
1186
|
-
"
|
1187
|
-
"
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
"module": "/src/models"
|
1193
|
-
},
|
1194
|
-
"tagName": "mdc-bullet",
|
1195
|
-
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
1196
|
-
"customElement": true
|
1197
|
-
}
|
1198
|
-
],
|
1199
|
-
"exports": [
|
1200
|
-
{
|
1201
|
-
"kind": "js",
|
1202
|
-
"name": "default",
|
1203
|
-
"declaration": {
|
1204
|
-
"name": "Bullet",
|
1205
|
-
"module": "components/bullet/bullet.component.js"
|
1206
|
-
}
|
1207
|
-
}
|
1208
|
-
]
|
1209
|
-
},
|
1210
|
-
{
|
1211
|
-
"kind": "javascript-module",
|
1212
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
1213
|
-
"declarations": [
|
1214
|
-
{
|
1215
|
-
"kind": "class",
|
1216
|
-
"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.",
|
1217
|
-
"name": "AvatarButton",
|
1218
|
-
"members": [
|
1160
|
+
"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`.",
|
1161
|
+
"attribute": "counter",
|
1162
|
+
"inheritedFrom": {
|
1163
|
+
"name": "AvatarComponentMixin",
|
1164
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1165
|
+
}
|
1166
|
+
},
|
1219
1167
|
{
|
1220
1168
|
"kind": "field",
|
1221
|
-
"name": "
|
1169
|
+
"name": "isTyping",
|
1222
1170
|
"type": {
|
1223
|
-
"text": "
|
1171
|
+
"text": "boolean"
|
1224
1172
|
},
|
1225
|
-
"default": "
|
1226
|
-
"description": "
|
1227
|
-
"attribute": "
|
1173
|
+
"default": "false",
|
1174
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1175
|
+
"attribute": "is-typing",
|
1176
|
+
"inheritedFrom": {
|
1177
|
+
"name": "AvatarComponentMixin",
|
1178
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1179
|
+
}
|
1228
1180
|
},
|
1229
1181
|
{
|
1230
|
-
"kind": "
|
1231
|
-
"name": "
|
1232
|
-
"
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1182
|
+
"kind": "field",
|
1183
|
+
"name": "iconName",
|
1184
|
+
"type": {
|
1185
|
+
"text": "IconNames | undefined"
|
1186
|
+
},
|
1187
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1188
|
+
"attribute": "icon-name",
|
1189
|
+
"inheritedFrom": {
|
1190
|
+
"name": "IconNameMixin",
|
1191
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1192
|
+
}
|
1193
|
+
}
|
1194
|
+
],
|
1195
|
+
"mixins": [
|
1196
|
+
{
|
1197
|
+
"name": "AvatarComponentMixin",
|
1198
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1241
1199
|
},
|
1242
1200
|
{
|
1243
|
-
"
|
1201
|
+
"name": "IconNameMixin",
|
1202
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1203
|
+
}
|
1204
|
+
],
|
1205
|
+
"superclass": {
|
1206
|
+
"name": "Component",
|
1207
|
+
"module": "/src/models"
|
1208
|
+
},
|
1209
|
+
"tagName": "mdc-avatar",
|
1210
|
+
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
|
1211
|
+
"customElement": true,
|
1212
|
+
"attributes": [
|
1213
|
+
{
|
1244
1214
|
"name": "src",
|
1245
1215
|
"type": {
|
1246
1216
|
"text": "string | undefined"
|
1247
1217
|
},
|
1248
1218
|
"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.",
|
1249
|
-
"
|
1219
|
+
"fieldName": "src",
|
1250
1220
|
"inheritedFrom": {
|
1251
1221
|
"name": "AvatarComponentMixin",
|
1252
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1222
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1253
1223
|
}
|
1254
1224
|
},
|
1255
1225
|
{
|
1256
|
-
"kind": "field",
|
1257
1226
|
"name": "initials",
|
1258
1227
|
"type": {
|
1259
1228
|
"text": "string | undefined"
|
1260
1229
|
},
|
1261
1230
|
"description": "The initials to be displayed for the avatar.",
|
1262
|
-
"
|
1231
|
+
"fieldName": "initials",
|
1263
1232
|
"inheritedFrom": {
|
1264
1233
|
"name": "AvatarComponentMixin",
|
1265
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1234
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1266
1235
|
}
|
1267
1236
|
},
|
1268
1237
|
{
|
1269
|
-
"kind": "field",
|
1270
1238
|
"name": "presence",
|
1271
1239
|
"type": {
|
1272
1240
|
"text": "PresenceType | undefined"
|
1273
1241
|
},
|
1274
1242
|
"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`",
|
1275
|
-
"
|
1243
|
+
"fieldName": "presence",
|
1276
1244
|
"inheritedFrom": {
|
1277
1245
|
"name": "AvatarComponentMixin",
|
1278
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1246
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1279
1247
|
}
|
1280
1248
|
},
|
1281
1249
|
{
|
1282
|
-
"kind": "field",
|
1283
1250
|
"name": "size",
|
1284
1251
|
"type": {
|
1285
|
-
"text": "
|
1252
|
+
"text": "AvatarSize"
|
1286
1253
|
},
|
1287
1254
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1288
1255
|
"default": "32",
|
1289
|
-
"
|
1290
|
-
"reflects": true,
|
1256
|
+
"fieldName": "size",
|
1291
1257
|
"inheritedFrom": {
|
1292
|
-
"name": "
|
1293
|
-
"module": "
|
1258
|
+
"name": "AvatarComponentMixin",
|
1259
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1294
1260
|
}
|
1295
1261
|
},
|
1296
1262
|
{
|
1297
|
-
"kind": "field",
|
1298
1263
|
"name": "counter",
|
1299
1264
|
"type": {
|
1300
1265
|
"text": "number | undefined"
|
1301
1266
|
},
|
1302
1267
|
"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`.",
|
1303
|
-
"
|
1268
|
+
"fieldName": "counter",
|
1304
1269
|
"inheritedFrom": {
|
1305
1270
|
"name": "AvatarComponentMixin",
|
1306
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1271
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1307
1272
|
}
|
1308
1273
|
},
|
1309
1274
|
{
|
1310
|
-
"
|
1311
|
-
"name": "isTyping",
|
1275
|
+
"name": "is-typing",
|
1312
1276
|
"type": {
|
1313
1277
|
"text": "boolean"
|
1314
1278
|
},
|
1315
1279
|
"default": "false",
|
1316
1280
|
"description": "Represents the typing indicator when the user is typing.",
|
1317
|
-
"
|
1281
|
+
"fieldName": "isTyping",
|
1318
1282
|
"inheritedFrom": {
|
1319
1283
|
"name": "AvatarComponentMixin",
|
1320
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1284
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1321
1285
|
}
|
1322
1286
|
},
|
1323
1287
|
{
|
1324
|
-
"
|
1325
|
-
"name": "iconName",
|
1288
|
+
"name": "icon-name",
|
1326
1289
|
"type": {
|
1327
1290
|
"text": "IconNames | undefined"
|
1328
1291
|
},
|
1329
1292
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1330
|
-
"
|
1293
|
+
"fieldName": "iconName",
|
1331
1294
|
"inheritedFrom": {
|
1332
1295
|
"name": "IconNameMixin",
|
1333
|
-
"module": "utils/mixins/IconNameMixin.
|
1296
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1334
1297
|
}
|
1298
|
+
}
|
1299
|
+
]
|
1300
|
+
}
|
1301
|
+
],
|
1302
|
+
"exports": [
|
1303
|
+
{
|
1304
|
+
"kind": "js",
|
1305
|
+
"name": "default",
|
1306
|
+
"declaration": {
|
1307
|
+
"name": "Avatar",
|
1308
|
+
"module": "components/avatar/avatar.component.js"
|
1309
|
+
}
|
1310
|
+
}
|
1311
|
+
]
|
1312
|
+
},
|
1313
|
+
{
|
1314
|
+
"kind": "javascript-module",
|
1315
|
+
"path": "components/badge/badge.component.js",
|
1316
|
+
"declarations": [
|
1317
|
+
{
|
1318
|
+
"kind": "class",
|
1319
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
1320
|
+
"name": "Badge",
|
1321
|
+
"cssProperties": [
|
1322
|
+
{
|
1323
|
+
"description": "The foreground color of the primary badge.",
|
1324
|
+
"name": "--mdc-badge-primary-foreground-color"
|
1335
1325
|
},
|
1336
1326
|
{
|
1337
|
-
"
|
1338
|
-
"name": "
|
1339
|
-
"type": {
|
1340
|
-
"text": "number"
|
1341
|
-
},
|
1342
|
-
"default": "0",
|
1343
|
-
"description": "This property specifies the tab order of the element.",
|
1344
|
-
"attribute": "tabIndex",
|
1345
|
-
"reflects": true,
|
1346
|
-
"inheritedFrom": {
|
1347
|
-
"name": "TabIndexMixin",
|
1348
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
1349
|
-
}
|
1327
|
+
"description": "The background color of the primary badge.",
|
1328
|
+
"name": "--mdc-badge-primary-background-color"
|
1350
1329
|
},
|
1351
1330
|
{
|
1352
|
-
"
|
1353
|
-
"name": "
|
1354
|
-
"type": {
|
1355
|
-
"text": "boolean | undefined"
|
1356
|
-
},
|
1357
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1358
|
-
"default": "undefined",
|
1359
|
-
"attribute": "disabled",
|
1360
|
-
"reflects": true,
|
1361
|
-
"inheritedFrom": {
|
1362
|
-
"name": "DisabledMixin",
|
1363
|
-
"module": "utils/mixins/DisabledMixin.js"
|
1364
|
-
}
|
1331
|
+
"description": "The foreground color of the secondary badge.",
|
1332
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
1365
1333
|
},
|
1334
|
+
{
|
1335
|
+
"description": "The background color of the secondary badge.",
|
1336
|
+
"name": "--mdc-badge-secondary-background-color"
|
1337
|
+
},
|
1338
|
+
{
|
1339
|
+
"description": "The foreground color of the success badge.",
|
1340
|
+
"name": "--mdc-badge-success-foreground-color"
|
1341
|
+
},
|
1342
|
+
{
|
1343
|
+
"description": "The background color of the success badge.",
|
1344
|
+
"name": "--mdc-badge-success-background-color"
|
1345
|
+
},
|
1346
|
+
{
|
1347
|
+
"description": "The foreground color of the warning badge.",
|
1348
|
+
"name": "--mdc-badge-warning-foreground-color"
|
1349
|
+
},
|
1350
|
+
{
|
1351
|
+
"description": "The background color of the warning badge.",
|
1352
|
+
"name": "--mdc-badge-warning-background-color"
|
1353
|
+
},
|
1354
|
+
{
|
1355
|
+
"description": "The foreground color of the error badge.",
|
1356
|
+
"name": "--mdc-badge-error-foreground-color"
|
1357
|
+
},
|
1358
|
+
{
|
1359
|
+
"description": "The background color of the error badge.",
|
1360
|
+
"name": "--mdc-badge-error-background-color"
|
1361
|
+
},
|
1362
|
+
{
|
1363
|
+
"description": "The background color of the badge overlay.",
|
1364
|
+
"name": "--mdc-badge-overlay-background-color"
|
1365
|
+
}
|
1366
|
+
],
|
1367
|
+
"members": [
|
1366
1368
|
{
|
1367
1369
|
"kind": "field",
|
1368
|
-
"name": "
|
1370
|
+
"name": "type",
|
1369
1371
|
"type": {
|
1370
|
-
"text": "
|
1372
|
+
"text": "BadgeType | undefined"
|
1371
1373
|
},
|
1372
|
-
"
|
1373
|
-
"
|
1374
|
-
"
|
1375
|
-
"reflects": true,
|
1376
|
-
"inheritedFrom": {
|
1377
|
-
"name": "Buttonsimple",
|
1378
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1379
|
-
}
|
1374
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1375
|
+
"attribute": "type",
|
1376
|
+
"reflects": true
|
1380
1377
|
},
|
1381
1378
|
{
|
1382
1379
|
"kind": "field",
|
1383
|
-
"name": "
|
1380
|
+
"name": "variant",
|
1384
1381
|
"type": {
|
1385
|
-
"text": "
|
1382
|
+
"text": "IconVariant"
|
1386
1383
|
},
|
1387
|
-
"
|
1388
|
-
"
|
1389
|
-
"attribute": "
|
1390
|
-
"
|
1391
|
-
"name": "Buttonsimple",
|
1392
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1393
|
-
}
|
1384
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1385
|
+
"default": "primary",
|
1386
|
+
"attribute": "variant",
|
1387
|
+
"reflects": true
|
1394
1388
|
},
|
1395
1389
|
{
|
1396
1390
|
"kind": "field",
|
1397
|
-
"name": "
|
1398
|
-
"
|
1399
|
-
|
1400
|
-
|
1401
|
-
"
|
1402
|
-
"
|
1403
|
-
"name": "Buttonsimple",
|
1404
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1405
|
-
}
|
1391
|
+
"name": "counter",
|
1392
|
+
"type": {
|
1393
|
+
"text": "number | undefined"
|
1394
|
+
},
|
1395
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1396
|
+
"attribute": "counter"
|
1406
1397
|
},
|
1407
1398
|
{
|
1408
1399
|
"kind": "field",
|
1409
|
-
"name": "
|
1400
|
+
"name": "maxCounter",
|
1410
1401
|
"type": {
|
1411
|
-
"text": "
|
1402
|
+
"text": "number"
|
1412
1403
|
},
|
1413
|
-
"description": "
|
1414
|
-
"default": "
|
1415
|
-
"attribute": "
|
1416
|
-
"reflects": true
|
1417
|
-
|
1418
|
-
|
1419
|
-
|
1420
|
-
|
1421
|
-
|
1422
|
-
|
1423
|
-
|
1424
|
-
"
|
1425
|
-
"
|
1426
|
-
"
|
1427
|
-
|
1428
|
-
|
1429
|
-
|
1430
|
-
|
1431
|
-
|
1432
|
-
|
1433
|
-
|
1434
|
-
"
|
1435
|
-
"
|
1436
|
-
|
1437
|
-
"name": "element",
|
1438
|
-
"type": {
|
1439
|
-
"text": "HTMLElement"
|
1440
|
-
},
|
1441
|
-
"description": "The button element"
|
1442
|
-
},
|
1443
|
-
{
|
1444
|
-
"name": "active",
|
1445
|
-
"type": {
|
1446
|
-
"text": "boolean"
|
1447
|
-
},
|
1448
|
-
"description": "The active state of the element"
|
1449
|
-
}
|
1450
|
-
],
|
1451
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
1452
|
-
"inheritedFrom": {
|
1453
|
-
"name": "Buttonsimple",
|
1454
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1455
|
-
}
|
1404
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1405
|
+
"default": "99",
|
1406
|
+
"attribute": "max-counter",
|
1407
|
+
"reflects": true
|
1408
|
+
},
|
1409
|
+
{
|
1410
|
+
"kind": "field",
|
1411
|
+
"name": "overlay",
|
1412
|
+
"type": {
|
1413
|
+
"text": "boolean"
|
1414
|
+
},
|
1415
|
+
"default": "false",
|
1416
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1417
|
+
"attribute": "overlay"
|
1418
|
+
},
|
1419
|
+
{
|
1420
|
+
"kind": "field",
|
1421
|
+
"name": "ariaLabel",
|
1422
|
+
"type": {
|
1423
|
+
"text": "string | null"
|
1424
|
+
},
|
1425
|
+
"default": "null",
|
1426
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1427
|
+
"attribute": "aria-label"
|
1456
1428
|
},
|
1457
1429
|
{
|
1458
1430
|
"kind": "method",
|
1459
|
-
"name": "
|
1431
|
+
"name": "getCounterText",
|
1460
1432
|
"privacy": "private",
|
1433
|
+
"return": {
|
1434
|
+
"type": {
|
1435
|
+
"text": ""
|
1436
|
+
}
|
1437
|
+
},
|
1461
1438
|
"parameters": [
|
1462
1439
|
{
|
1463
|
-
"name": "
|
1440
|
+
"name": "maxCounter",
|
1464
1441
|
"type": {
|
1465
|
-
"text": "
|
1442
|
+
"text": "number"
|
1466
1443
|
},
|
1467
|
-
"description": "
|
1444
|
+
"description": "the maximum limit which can be displayed on the badge"
|
1468
1445
|
},
|
1469
1446
|
{
|
1470
|
-
"name": "
|
1447
|
+
"name": "counter",
|
1448
|
+
"optional": true,
|
1471
1449
|
"type": {
|
1472
|
-
"text": "
|
1450
|
+
"text": "number"
|
1473
1451
|
},
|
1474
|
-
"description": "
|
1452
|
+
"description": "the number to be displayed on the badge"
|
1475
1453
|
}
|
1476
1454
|
],
|
1477
|
-
"description": "
|
1478
|
-
"inheritedFrom": {
|
1479
|
-
"name": "Buttonsimple",
|
1480
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1481
|
-
}
|
1455
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
1482
1456
|
},
|
1483
1457
|
{
|
1484
1458
|
"kind": "method",
|
1485
|
-
"name": "
|
1459
|
+
"name": "getBadgeIcon",
|
1486
1460
|
"privacy": "private",
|
1461
|
+
"return": {
|
1462
|
+
"type": {
|
1463
|
+
"text": ""
|
1464
|
+
}
|
1465
|
+
},
|
1487
1466
|
"parameters": [
|
1488
1467
|
{
|
1489
|
-
"name": "
|
1468
|
+
"name": "iconName",
|
1490
1469
|
"type": {
|
1491
|
-
"text": "
|
1470
|
+
"text": "string"
|
1492
1471
|
},
|
1493
|
-
"description": "
|
1472
|
+
"description": "the name of the icon from the icon set"
|
1494
1473
|
},
|
1495
1474
|
{
|
1496
|
-
"name": "
|
1475
|
+
"name": "backgroundClassPostfix",
|
1497
1476
|
"type": {
|
1498
|
-
"text": "
|
1477
|
+
"text": "string"
|
1499
1478
|
},
|
1500
|
-
"description": "
|
1479
|
+
"description": "postfix for the class to style the badge icon."
|
1501
1480
|
}
|
1502
1481
|
],
|
1503
|
-
"description": "
|
1504
|
-
"inheritedFrom": {
|
1505
|
-
"name": "Buttonsimple",
|
1506
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1507
|
-
}
|
1482
|
+
"description": "Method to generate the badge icon."
|
1508
1483
|
},
|
1509
1484
|
{
|
1510
1485
|
"kind": "method",
|
1511
|
-
"name": "
|
1486
|
+
"name": "getBadgeDot",
|
1512
1487
|
"privacy": "private",
|
1513
|
-
"
|
1514
|
-
"
|
1515
|
-
|
1516
|
-
|
1488
|
+
"return": {
|
1489
|
+
"type": {
|
1490
|
+
"text": ""
|
1491
|
+
}
|
1492
|
+
},
|
1493
|
+
"description": "Method to generate the badge dot template."
|
1517
1494
|
},
|
1518
1495
|
{
|
1519
1496
|
"kind": "method",
|
1520
|
-
"name": "
|
1497
|
+
"name": "getBadgeCounterText",
|
1521
1498
|
"privacy": "private",
|
1522
|
-
"
|
1523
|
-
|
1524
|
-
|
1525
|
-
|
1526
|
-
}
|
1499
|
+
"return": {
|
1500
|
+
"type": {
|
1501
|
+
"text": ""
|
1502
|
+
}
|
1503
|
+
},
|
1504
|
+
"description": "Method to generate the badge text and counter template."
|
1527
1505
|
},
|
1528
1506
|
{
|
1529
1507
|
"kind": "method",
|
1530
|
-
"name": "
|
1508
|
+
"name": "setRoleByAriaLabel",
|
1531
1509
|
"privacy": "private",
|
1532
|
-
"
|
1533
|
-
{
|
1534
|
-
"
|
1535
|
-
"type": {
|
1536
|
-
"text": "KeyboardEvent"
|
1537
|
-
},
|
1538
|
-
"description": "The keyboard event."
|
1510
|
+
"return": {
|
1511
|
+
"type": {
|
1512
|
+
"text": "void"
|
1539
1513
|
}
|
1540
|
-
|
1541
|
-
"description": "
|
1542
|
-
"inheritedFrom": {
|
1543
|
-
"name": "Buttonsimple",
|
1544
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1545
|
-
}
|
1514
|
+
},
|
1515
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
1546
1516
|
},
|
1547
1517
|
{
|
1548
1518
|
"kind": "method",
|
1549
|
-
"name": "
|
1519
|
+
"name": "getBadgeContentBasedOnType",
|
1550
1520
|
"privacy": "private",
|
1551
|
-
"
|
1552
|
-
{
|
1553
|
-
"
|
1554
|
-
"type": {
|
1555
|
-
"text": "KeyboardEvent"
|
1556
|
-
},
|
1557
|
-
"description": "The keyboard event."
|
1521
|
+
"return": {
|
1522
|
+
"type": {
|
1523
|
+
"text": ""
|
1558
1524
|
}
|
1559
|
-
],
|
1560
|
-
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
1561
|
-
"inheritedFrom": {
|
1562
|
-
"name": "Buttonsimple",
|
1563
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1564
|
-
}
|
1565
|
-
}
|
1566
|
-
],
|
1567
|
-
"events": [
|
1568
|
-
{
|
1569
|
-
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
1570
|
-
"name": "click",
|
1571
|
-
"reactName": "onClick",
|
1572
|
-
"eventName": "ClickEvent",
|
1573
|
-
"inheritedFrom": {
|
1574
|
-
"name": "Buttonsimple",
|
1575
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1576
|
-
}
|
1577
|
-
},
|
1578
|
-
{
|
1579
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
1580
|
-
"name": "keydown",
|
1581
|
-
"reactName": "onKeyDown",
|
1582
|
-
"eventName": "KeydownEvent",
|
1583
|
-
"inheritedFrom": {
|
1584
|
-
"name": "Buttonsimple",
|
1585
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1586
|
-
}
|
1587
|
-
},
|
1588
|
-
{
|
1589
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
1590
|
-
"name": "keyup",
|
1591
|
-
"reactName": "onKeyUp",
|
1592
|
-
"eventName": "KeyupEvent",
|
1593
|
-
"inheritedFrom": {
|
1594
|
-
"name": "Buttonsimple",
|
1595
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1596
|
-
}
|
1597
|
-
},
|
1598
|
-
{
|
1599
|
-
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
1600
|
-
"name": "focus",
|
1601
|
-
"reactName": "onFocus",
|
1602
|
-
"eventName": "FocusEvent",
|
1603
|
-
"inheritedFrom": {
|
1604
|
-
"name": "Buttonsimple",
|
1605
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1606
|
-
}
|
1607
|
-
}
|
1608
|
-
],
|
1609
|
-
"attributes": [
|
1610
|
-
{
|
1611
|
-
"name": "aria-label",
|
1612
|
-
"type": {
|
1613
|
-
"text": "string | null"
|
1614
1525
|
},
|
1615
|
-
"
|
1616
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1617
|
-
"fieldName": "ariaLabel"
|
1526
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
1618
1527
|
},
|
1619
1528
|
{
|
1620
|
-
"
|
1529
|
+
"kind": "field",
|
1530
|
+
"name": "iconName",
|
1621
1531
|
"type": {
|
1622
|
-
"text": "
|
1532
|
+
"text": "IconNames | undefined"
|
1623
1533
|
},
|
1624
|
-
"description": "
|
1625
|
-
"
|
1534
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1535
|
+
"attribute": "icon-name",
|
1626
1536
|
"inheritedFrom": {
|
1627
|
-
"name": "
|
1628
|
-
"module": "
|
1537
|
+
"name": "IconNameMixin",
|
1538
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1629
1539
|
}
|
1630
|
-
}
|
1540
|
+
}
|
1541
|
+
],
|
1542
|
+
"attributes": [
|
1631
1543
|
{
|
1632
|
-
"name": "
|
1544
|
+
"name": "type",
|
1633
1545
|
"type": {
|
1634
|
-
"text": "
|
1546
|
+
"text": "BadgeType | undefined"
|
1635
1547
|
},
|
1636
|
-
"description": "
|
1637
|
-
"fieldName": "
|
1638
|
-
"inheritedFrom": {
|
1639
|
-
"name": "AvatarComponentMixin",
|
1640
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1641
|
-
}
|
1548
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1549
|
+
"fieldName": "type"
|
1642
1550
|
},
|
1643
1551
|
{
|
1644
|
-
"name": "
|
1552
|
+
"name": "variant",
|
1645
1553
|
"type": {
|
1646
|
-
"text": "
|
1554
|
+
"text": "IconVariant"
|
1647
1555
|
},
|
1648
|
-
"description": "
|
1649
|
-
"
|
1650
|
-
"
|
1651
|
-
"name": "AvatarComponentMixin",
|
1652
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1653
|
-
}
|
1556
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1557
|
+
"default": "primary",
|
1558
|
+
"fieldName": "variant"
|
1654
1559
|
},
|
1655
1560
|
{
|
1656
|
-
"name": "
|
1561
|
+
"name": "counter",
|
1657
1562
|
"type": {
|
1658
|
-
"text": "
|
1563
|
+
"text": "number | undefined"
|
1659
1564
|
},
|
1660
|
-
"description": "
|
1661
|
-
"
|
1662
|
-
"fieldName": "size",
|
1663
|
-
"inheritedFrom": {
|
1664
|
-
"name": "Buttonsimple",
|
1665
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1666
|
-
}
|
1565
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1566
|
+
"fieldName": "counter"
|
1667
1567
|
},
|
1668
1568
|
{
|
1669
|
-
"name": "counter",
|
1569
|
+
"name": "max-counter",
|
1670
1570
|
"type": {
|
1671
|
-
"text": "number
|
1571
|
+
"text": "number"
|
1672
1572
|
},
|
1673
|
-
"description": "The
|
1674
|
-
"
|
1675
|
-
"
|
1676
|
-
"name": "AvatarComponentMixin",
|
1677
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1678
|
-
}
|
1573
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1574
|
+
"default": "99",
|
1575
|
+
"fieldName": "maxCounter"
|
1679
1576
|
},
|
1680
1577
|
{
|
1681
|
-
"name": "
|
1578
|
+
"name": "overlay",
|
1682
1579
|
"type": {
|
1683
1580
|
"text": "boolean"
|
1684
1581
|
},
|
1685
1582
|
"default": "false",
|
1686
|
-
"description": "
|
1687
|
-
"fieldName": "
|
1688
|
-
|
1689
|
-
|
1690
|
-
|
1691
|
-
|
1583
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1584
|
+
"fieldName": "overlay"
|
1585
|
+
},
|
1586
|
+
{
|
1587
|
+
"name": "aria-label",
|
1588
|
+
"type": {
|
1589
|
+
"text": "string | null"
|
1590
|
+
},
|
1591
|
+
"default": "null",
|
1592
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1593
|
+
"fieldName": "ariaLabel"
|
1692
1594
|
},
|
1693
1595
|
{
|
1694
1596
|
"name": "icon-name",
|
@@ -1701,99 +1603,197 @@
|
|
1701
1603
|
"name": "IconNameMixin",
|
1702
1604
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
1703
1605
|
}
|
1704
|
-
}
|
1606
|
+
}
|
1607
|
+
],
|
1608
|
+
"mixins": [
|
1705
1609
|
{
|
1706
|
-
"name": "
|
1610
|
+
"name": "IconNameMixin",
|
1611
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1612
|
+
}
|
1613
|
+
],
|
1614
|
+
"superclass": {
|
1615
|
+
"name": "Component",
|
1616
|
+
"module": "/src/models"
|
1617
|
+
},
|
1618
|
+
"tagName": "mdc-badge",
|
1619
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
1620
|
+
"customElement": true
|
1621
|
+
}
|
1622
|
+
],
|
1623
|
+
"exports": [
|
1624
|
+
{
|
1625
|
+
"kind": "js",
|
1626
|
+
"name": "default",
|
1627
|
+
"declaration": {
|
1628
|
+
"name": "Badge",
|
1629
|
+
"module": "components/badge/badge.component.js"
|
1630
|
+
}
|
1631
|
+
}
|
1632
|
+
]
|
1633
|
+
},
|
1634
|
+
{
|
1635
|
+
"kind": "javascript-module",
|
1636
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
1637
|
+
"declarations": [
|
1638
|
+
{
|
1639
|
+
"kind": "class",
|
1640
|
+
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
1641
|
+
"name": "Brandvisual",
|
1642
|
+
"members": [
|
1643
|
+
{
|
1644
|
+
"kind": "field",
|
1645
|
+
"name": "brandVisualData",
|
1707
1646
|
"type": {
|
1708
|
-
"text": "
|
1647
|
+
"text": "HTMLElement | undefined"
|
1709
1648
|
},
|
1710
|
-
"
|
1711
|
-
"description": "This property specifies the tab order of the element.",
|
1712
|
-
"fieldName": "tabIndex",
|
1713
|
-
"inheritedFrom": {
|
1714
|
-
"name": "TabIndexMixin",
|
1715
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1716
|
-
}
|
1649
|
+
"privacy": "private"
|
1717
1650
|
},
|
1718
1651
|
{
|
1719
|
-
"
|
1652
|
+
"kind": "field",
|
1653
|
+
"name": "name",
|
1720
1654
|
"type": {
|
1721
|
-
"text": "
|
1655
|
+
"text": "BrandVisualNames | undefined"
|
1722
1656
|
},
|
1723
|
-
"description": "
|
1724
|
-
"
|
1725
|
-
"
|
1726
|
-
"inheritedFrom": {
|
1727
|
-
"name": "DisabledMixin",
|
1728
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
1729
|
-
}
|
1657
|
+
"description": "Name of the brandVisual (= filename)",
|
1658
|
+
"attribute": "name",
|
1659
|
+
"reflects": true
|
1730
1660
|
},
|
1731
1661
|
{
|
1732
|
-
"
|
1733
|
-
"
|
1734
|
-
|
1735
|
-
},
|
1736
|
-
"default": "false",
|
1737
|
-
"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.",
|
1738
|
-
"fieldName": "active",
|
1739
|
-
"inheritedFrom": {
|
1740
|
-
"name": "Buttonsimple",
|
1741
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1742
|
-
}
|
1662
|
+
"kind": "method",
|
1663
|
+
"name": "getBrandVisualData",
|
1664
|
+
"privacy": "private"
|
1743
1665
|
},
|
1744
1666
|
{
|
1745
|
-
"
|
1746
|
-
"
|
1747
|
-
|
1748
|
-
|
1749
|
-
|
1750
|
-
|
1751
|
-
|
1752
|
-
|
1753
|
-
|
1754
|
-
|
1755
|
-
|
1667
|
+
"kind": "method",
|
1668
|
+
"name": "handleBrandVisualLoadedSuccess",
|
1669
|
+
"privacy": "private",
|
1670
|
+
"parameters": [
|
1671
|
+
{
|
1672
|
+
"name": "brandVisualHtml",
|
1673
|
+
"type": {
|
1674
|
+
"text": "HTMLElement"
|
1675
|
+
},
|
1676
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1677
|
+
}
|
1678
|
+
],
|
1679
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1756
1680
|
},
|
1757
1681
|
{
|
1758
|
-
"
|
1759
|
-
"
|
1760
|
-
"
|
1761
|
-
"
|
1762
|
-
|
1763
|
-
|
1764
|
-
|
1765
|
-
|
1682
|
+
"kind": "method",
|
1683
|
+
"name": "handleBrandVisualLoadedFailure",
|
1684
|
+
"privacy": "private",
|
1685
|
+
"parameters": [
|
1686
|
+
{
|
1687
|
+
"name": "error",
|
1688
|
+
"type": {
|
1689
|
+
"text": "unknown"
|
1690
|
+
}
|
1691
|
+
}
|
1692
|
+
],
|
1693
|
+
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
1694
|
+
}
|
1695
|
+
],
|
1696
|
+
"events": [
|
1697
|
+
{
|
1698
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
1699
|
+
"name": "load",
|
1700
|
+
"reactName": "onLoad",
|
1701
|
+
"eventName": "LoadEvent"
|
1766
1702
|
},
|
1767
1703
|
{
|
1768
|
-
"
|
1704
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
1705
|
+
"name": "error",
|
1706
|
+
"reactName": "onError",
|
1707
|
+
"eventName": "ErrorEvent"
|
1708
|
+
}
|
1709
|
+
],
|
1710
|
+
"attributes": [
|
1711
|
+
{
|
1712
|
+
"name": "name",
|
1769
1713
|
"type": {
|
1770
|
-
"text": "
|
1714
|
+
"text": "BrandVisualNames | undefined"
|
1771
1715
|
},
|
1772
|
-
"description": "
|
1773
|
-
"
|
1774
|
-
"fieldName": "type",
|
1775
|
-
"inheritedFrom": {
|
1776
|
-
"name": "Buttonsimple",
|
1777
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1778
|
-
}
|
1716
|
+
"description": "Name of the brandVisual (= filename)",
|
1717
|
+
"fieldName": "name"
|
1779
1718
|
}
|
1780
1719
|
],
|
1781
|
-
"
|
1720
|
+
"superclass": {
|
1721
|
+
"name": "Component",
|
1722
|
+
"module": "/src/models"
|
1723
|
+
},
|
1724
|
+
"tagName": "mdc-brandvisual",
|
1725
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
1726
|
+
"customElement": true
|
1727
|
+
}
|
1728
|
+
],
|
1729
|
+
"exports": [
|
1730
|
+
{
|
1731
|
+
"kind": "js",
|
1732
|
+
"name": "default",
|
1733
|
+
"declaration": {
|
1734
|
+
"name": "Brandvisual",
|
1735
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
1736
|
+
}
|
1737
|
+
}
|
1738
|
+
]
|
1739
|
+
},
|
1740
|
+
{
|
1741
|
+
"kind": "javascript-module",
|
1742
|
+
"path": "components/bullet/bullet.component.js",
|
1743
|
+
"declarations": [
|
1744
|
+
{
|
1745
|
+
"kind": "class",
|
1746
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1747
|
+
"name": "Bullet",
|
1748
|
+
"cssProperties": [
|
1782
1749
|
{
|
1783
|
-
"
|
1784
|
-
"
|
1750
|
+
"description": "background color of the bullet",
|
1751
|
+
"name": "--mdc-bullet-background-color"
|
1785
1752
|
},
|
1786
1753
|
{
|
1787
|
-
"
|
1788
|
-
"
|
1754
|
+
"description": "small size value of the bullet",
|
1755
|
+
"name": "--mdc-bullet-size-small"
|
1756
|
+
},
|
1757
|
+
{
|
1758
|
+
"description": "medium size value of the bullet",
|
1759
|
+
"name": "--mdc-bullet-size-medium"
|
1760
|
+
},
|
1761
|
+
{
|
1762
|
+
"description": "large size value of the bullet",
|
1763
|
+
"name": "--mdc-bullet-size-large"
|
1764
|
+
}
|
1765
|
+
],
|
1766
|
+
"members": [
|
1767
|
+
{
|
1768
|
+
"kind": "field",
|
1769
|
+
"name": "size",
|
1770
|
+
"type": {
|
1771
|
+
"text": "Size"
|
1772
|
+
},
|
1773
|
+
"privacy": "public",
|
1774
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1775
|
+
"default": "small",
|
1776
|
+
"attribute": "size",
|
1777
|
+
"reflects": true
|
1778
|
+
}
|
1779
|
+
],
|
1780
|
+
"attributes": [
|
1781
|
+
{
|
1782
|
+
"name": "size",
|
1783
|
+
"type": {
|
1784
|
+
"text": "Size"
|
1785
|
+
},
|
1786
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1787
|
+
"default": "small",
|
1788
|
+
"fieldName": "size"
|
1789
1789
|
}
|
1790
1790
|
],
|
1791
1791
|
"superclass": {
|
1792
|
-
"name": "
|
1793
|
-
"module": "/src/
|
1792
|
+
"name": "Component",
|
1793
|
+
"module": "/src/models"
|
1794
1794
|
},
|
1795
|
-
"tagName": "mdc-
|
1796
|
-
"jsDoc": "/**\n *
|
1795
|
+
"tagName": "mdc-bullet",
|
1796
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
1797
1797
|
"customElement": true
|
1798
1798
|
}
|
1799
1799
|
],
|
@@ -1802,8 +1802,8 @@
|
|
1802
1802
|
"kind": "js",
|
1803
1803
|
"name": "default",
|
1804
1804
|
"declaration": {
|
1805
|
-
"name": "
|
1806
|
-
"module": "components/
|
1805
|
+
"name": "Bullet",
|
1806
|
+
"module": "components/bullet/bullet.component.js"
|
1807
1807
|
}
|
1808
1808
|
}
|
1809
1809
|
]
|