@momentum-design/components 0.22.7 → 0.23.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/browser/index.js +154 -106
- package/dist/browser/index.js.map +4 -4
- package/dist/components/virtualizedlist/index.d.ts +7 -0
- package/dist/components/virtualizedlist/index.js +4 -0
- package/dist/components/virtualizedlist/virtualizedlist.component.d.ts +79 -0
- package/dist/components/virtualizedlist/virtualizedlist.component.js +135 -0
- package/dist/components/virtualizedlist/virtualizedlist.constants.d.ts +9 -0
- package/dist/components/virtualizedlist/virtualizedlist.constants.js +10 -0
- package/dist/components/virtualizedlist/virtualizedlist.helper.test.d.ts +22 -0
- package/dist/components/virtualizedlist/virtualizedlist.helper.test.js +79 -0
- package/dist/components/virtualizedlist/virtualizedlist.styles.d.ts +2 -0
- package/dist/components/virtualizedlist/virtualizedlist.styles.js +17 -0
- package/dist/components/virtualizedlist/virtualizedlist.test.component.d.ts +17 -0
- package/dist/components/virtualizedlist/virtualizedlist.test.component.js +79 -0
- package/dist/components/virtualizedlist/virtualizedlist.types.d.ts +8 -0
- package/dist/components/virtualizedlist/virtualizedlist.types.js +1 -0
- package/dist/custom-elements.json +1194 -983
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +3 -2
- package/dist/react/index.js +3 -2
- package/dist/react/virtualizedlist/index.d.ts +15 -0
- package/dist/react/virtualizedlist/index.js +24 -0
- package/package.json +2 -1
@@ -556,218 +556,115 @@
|
|
556
556
|
},
|
557
557
|
{
|
558
558
|
"kind": "javascript-module",
|
559
|
-
"path": "components/
|
559
|
+
"path": "components/avatar/avatar.component.js",
|
560
560
|
"declarations": [
|
561
561
|
{
|
562
562
|
"kind": "class",
|
563
|
-
"description": "The `mdc-
|
564
|
-
"name": "
|
563
|
+
"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.",
|
564
|
+
"name": "Avatar",
|
565
565
|
"cssProperties": [
|
566
566
|
{
|
567
|
-
"description": "
|
568
|
-
"name": "--mdc-
|
569
|
-
},
|
570
|
-
{
|
571
|
-
"description": "The background color of the primary badge.",
|
572
|
-
"name": "--mdc-badge-primary-background-color"
|
573
|
-
},
|
574
|
-
{
|
575
|
-
"description": "The foreground color of the secondary badge.",
|
576
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
577
|
-
},
|
578
|
-
{
|
579
|
-
"description": "The background color of the secondary badge.",
|
580
|
-
"name": "--mdc-badge-secondary-background-color"
|
581
|
-
},
|
582
|
-
{
|
583
|
-
"description": "The foreground color of the success badge.",
|
584
|
-
"name": "--mdc-badge-success-foreground-color"
|
585
|
-
},
|
586
|
-
{
|
587
|
-
"description": "The background color of the success badge.",
|
588
|
-
"name": "--mdc-badge-success-background-color"
|
589
|
-
},
|
590
|
-
{
|
591
|
-
"description": "The foreground color of the warning badge.",
|
592
|
-
"name": "--mdc-badge-warning-foreground-color"
|
567
|
+
"description": "Allows customization of the default background color.",
|
568
|
+
"name": "--mdc-avatar-default-background-color"
|
593
569
|
},
|
594
570
|
{
|
595
|
-
"description": "
|
596
|
-
"name": "--mdc-
|
571
|
+
"description": "Allows customization of the default foreground color.",
|
572
|
+
"name": "--mdc-avatar-default-foreground-color"
|
597
573
|
},
|
598
574
|
{
|
599
|
-
"description": "
|
600
|
-
"name": "--mdc-
|
575
|
+
"description": "Allows customization of the loading indicator background color.",
|
576
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
601
577
|
},
|
602
578
|
{
|
603
|
-
"description": "
|
604
|
-
"name": "--mdc-
|
579
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
580
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
605
581
|
},
|
606
582
|
{
|
607
|
-
"description": "
|
608
|
-
"name": "--mdc-
|
583
|
+
"description": "Allows customization of the loading overlay background color.",
|
584
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
609
585
|
}
|
610
586
|
],
|
611
587
|
"members": [
|
612
588
|
{
|
613
589
|
"kind": "field",
|
614
|
-
"name": "
|
590
|
+
"name": "src",
|
615
591
|
"type": {
|
616
|
-
"text": "
|
592
|
+
"text": "string | undefined"
|
617
593
|
},
|
618
|
-
"description": "
|
619
|
-
"attribute": "
|
620
|
-
"
|
594
|
+
"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.",
|
595
|
+
"attribute": "src",
|
596
|
+
"inheritedFrom": {
|
597
|
+
"name": "AvatarComponentMixin",
|
598
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
599
|
+
}
|
621
600
|
},
|
622
601
|
{
|
623
602
|
"kind": "field",
|
624
|
-
"name": "
|
603
|
+
"name": "initials",
|
625
604
|
"type": {
|
626
|
-
"text": "
|
605
|
+
"text": "string | undefined"
|
627
606
|
},
|
628
|
-
"description": "
|
629
|
-
"
|
630
|
-
"
|
631
|
-
|
607
|
+
"description": "The initials to be displayed for the avatar.",
|
608
|
+
"attribute": "initials",
|
609
|
+
"inheritedFrom": {
|
610
|
+
"name": "AvatarComponentMixin",
|
611
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
612
|
+
}
|
632
613
|
},
|
633
614
|
{
|
634
615
|
"kind": "field",
|
635
|
-
"name": "
|
616
|
+
"name": "presence",
|
636
617
|
"type": {
|
637
|
-
"text": "
|
618
|
+
"text": "PresenceType | undefined"
|
638
619
|
},
|
639
|
-
"description": "
|
640
|
-
"attribute": "
|
620
|
+
"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`",
|
621
|
+
"attribute": "presence",
|
622
|
+
"inheritedFrom": {
|
623
|
+
"name": "AvatarComponentMixin",
|
624
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
625
|
+
}
|
641
626
|
},
|
642
627
|
{
|
643
628
|
"kind": "field",
|
644
|
-
"name": "
|
629
|
+
"name": "size",
|
645
630
|
"type": {
|
646
|
-
"text": "
|
631
|
+
"text": "AvatarSize"
|
647
632
|
},
|
648
|
-
"description": "
|
649
|
-
"default": "
|
650
|
-
"attribute": "
|
651
|
-
"reflects": true
|
633
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
634
|
+
"default": "32",
|
635
|
+
"attribute": "size",
|
636
|
+
"reflects": true,
|
637
|
+
"inheritedFrom": {
|
638
|
+
"name": "AvatarComponentMixin",
|
639
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
640
|
+
}
|
652
641
|
},
|
653
642
|
{
|
654
643
|
"kind": "field",
|
655
|
-
"name": "
|
644
|
+
"name": "counter",
|
656
645
|
"type": {
|
657
|
-
"text": "
|
646
|
+
"text": "number | undefined"
|
658
647
|
},
|
659
|
-
"
|
660
|
-
"
|
661
|
-
"
|
648
|
+
"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`.",
|
649
|
+
"attribute": "counter",
|
650
|
+
"inheritedFrom": {
|
651
|
+
"name": "AvatarComponentMixin",
|
652
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
653
|
+
}
|
662
654
|
},
|
663
655
|
{
|
664
656
|
"kind": "field",
|
665
|
-
"name": "
|
657
|
+
"name": "isTyping",
|
666
658
|
"type": {
|
667
|
-
"text": "
|
668
|
-
},
|
669
|
-
"default": "null",
|
670
|
-
"description": "Aria-label attribute to be set for accessibility",
|
671
|
-
"attribute": "aria-label"
|
672
|
-
},
|
673
|
-
{
|
674
|
-
"kind": "method",
|
675
|
-
"name": "getCounterText",
|
676
|
-
"privacy": "private",
|
677
|
-
"return": {
|
678
|
-
"type": {
|
679
|
-
"text": ""
|
680
|
-
}
|
681
|
-
},
|
682
|
-
"parameters": [
|
683
|
-
{
|
684
|
-
"name": "maxCounter",
|
685
|
-
"type": {
|
686
|
-
"text": "number"
|
687
|
-
},
|
688
|
-
"description": "the maximum limit which can be displayed on the badge"
|
689
|
-
},
|
690
|
-
{
|
691
|
-
"name": "counter",
|
692
|
-
"optional": true,
|
693
|
-
"type": {
|
694
|
-
"text": "number"
|
695
|
-
},
|
696
|
-
"description": "the number to be displayed on the badge"
|
697
|
-
}
|
698
|
-
],
|
699
|
-
"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."
|
700
|
-
},
|
701
|
-
{
|
702
|
-
"kind": "method",
|
703
|
-
"name": "getBadgeIcon",
|
704
|
-
"privacy": "private",
|
705
|
-
"return": {
|
706
|
-
"type": {
|
707
|
-
"text": ""
|
708
|
-
}
|
709
|
-
},
|
710
|
-
"parameters": [
|
711
|
-
{
|
712
|
-
"name": "iconName",
|
713
|
-
"type": {
|
714
|
-
"text": "string"
|
715
|
-
},
|
716
|
-
"description": "the name of the icon from the icon set"
|
717
|
-
},
|
718
|
-
{
|
719
|
-
"name": "backgroundClassPostfix",
|
720
|
-
"type": {
|
721
|
-
"text": "string"
|
722
|
-
},
|
723
|
-
"description": "postfix for the class to style the badge icon."
|
724
|
-
}
|
725
|
-
],
|
726
|
-
"description": "Method to generate the badge icon."
|
727
|
-
},
|
728
|
-
{
|
729
|
-
"kind": "method",
|
730
|
-
"name": "getBadgeDot",
|
731
|
-
"privacy": "private",
|
732
|
-
"return": {
|
733
|
-
"type": {
|
734
|
-
"text": ""
|
735
|
-
}
|
736
|
-
},
|
737
|
-
"description": "Method to generate the badge dot template."
|
738
|
-
},
|
739
|
-
{
|
740
|
-
"kind": "method",
|
741
|
-
"name": "getBadgeCounterText",
|
742
|
-
"privacy": "private",
|
743
|
-
"return": {
|
744
|
-
"type": {
|
745
|
-
"text": ""
|
746
|
-
}
|
747
|
-
},
|
748
|
-
"description": "Method to generate the badge text and counter template."
|
749
|
-
},
|
750
|
-
{
|
751
|
-
"kind": "method",
|
752
|
-
"name": "setRoleByAriaLabel",
|
753
|
-
"privacy": "private",
|
754
|
-
"return": {
|
755
|
-
"type": {
|
756
|
-
"text": "void"
|
757
|
-
}
|
758
|
-
},
|
759
|
-
"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."
|
760
|
-
},
|
761
|
-
{
|
762
|
-
"kind": "method",
|
763
|
-
"name": "getBadgeContentBasedOnType",
|
764
|
-
"privacy": "private",
|
765
|
-
"return": {
|
766
|
-
"type": {
|
767
|
-
"text": ""
|
768
|
-
}
|
659
|
+
"text": "boolean"
|
769
660
|
},
|
770
|
-
"
|
661
|
+
"default": "false",
|
662
|
+
"description": "Represents the typing indicator when the user is typing.",
|
663
|
+
"attribute": "is-typing",
|
664
|
+
"inheritedFrom": {
|
665
|
+
"name": "AvatarComponentMixin",
|
666
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
667
|
+
}
|
771
668
|
},
|
772
669
|
{
|
773
670
|
"kind": "field",
|
@@ -783,244 +680,26 @@
|
|
783
680
|
}
|
784
681
|
}
|
785
682
|
],
|
786
|
-
"
|
683
|
+
"mixins": [
|
787
684
|
{
|
788
|
-
"name": "
|
789
|
-
"
|
790
|
-
"text": "BadgeType | undefined"
|
791
|
-
},
|
792
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
793
|
-
"fieldName": "type"
|
685
|
+
"name": "AvatarComponentMixin",
|
686
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
794
687
|
},
|
795
688
|
{
|
796
|
-
"name": "
|
797
|
-
"
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
"
|
810
|
-
"fieldName": "counter"
|
811
|
-
},
|
812
|
-
{
|
813
|
-
"name": "max-counter",
|
814
|
-
"type": {
|
815
|
-
"text": "number"
|
816
|
-
},
|
817
|
-
"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`.",
|
818
|
-
"default": "99",
|
819
|
-
"fieldName": "maxCounter"
|
820
|
-
},
|
821
|
-
{
|
822
|
-
"name": "overlay",
|
823
|
-
"type": {
|
824
|
-
"text": "boolean"
|
825
|
-
},
|
826
|
-
"default": "false",
|
827
|
-
"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.",
|
828
|
-
"fieldName": "overlay"
|
829
|
-
},
|
830
|
-
{
|
831
|
-
"name": "aria-label",
|
832
|
-
"type": {
|
833
|
-
"text": "string | null"
|
834
|
-
},
|
835
|
-
"default": "null",
|
836
|
-
"description": "Aria-label attribute to be set for accessibility",
|
837
|
-
"fieldName": "ariaLabel"
|
838
|
-
},
|
839
|
-
{
|
840
|
-
"name": "icon-name",
|
841
|
-
"type": {
|
842
|
-
"text": "IconNames | undefined"
|
843
|
-
},
|
844
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
845
|
-
"fieldName": "iconName",
|
846
|
-
"inheritedFrom": {
|
847
|
-
"name": "IconNameMixin",
|
848
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
849
|
-
}
|
850
|
-
}
|
851
|
-
],
|
852
|
-
"mixins": [
|
853
|
-
{
|
854
|
-
"name": "IconNameMixin",
|
855
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
856
|
-
}
|
857
|
-
],
|
858
|
-
"superclass": {
|
859
|
-
"name": "Component",
|
860
|
-
"module": "/src/models"
|
861
|
-
},
|
862
|
-
"tagName": "mdc-badge",
|
863
|
-
"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 */",
|
864
|
-
"customElement": true
|
865
|
-
}
|
866
|
-
],
|
867
|
-
"exports": [
|
868
|
-
{
|
869
|
-
"kind": "js",
|
870
|
-
"name": "default",
|
871
|
-
"declaration": {
|
872
|
-
"name": "Badge",
|
873
|
-
"module": "components/badge/badge.component.js"
|
874
|
-
}
|
875
|
-
}
|
876
|
-
]
|
877
|
-
},
|
878
|
-
{
|
879
|
-
"kind": "javascript-module",
|
880
|
-
"path": "components/avatar/avatar.component.js",
|
881
|
-
"declarations": [
|
882
|
-
{
|
883
|
-
"kind": "class",
|
884
|
-
"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.",
|
885
|
-
"name": "Avatar",
|
886
|
-
"cssProperties": [
|
887
|
-
{
|
888
|
-
"description": "Allows customization of the default background color.",
|
889
|
-
"name": "--mdc-avatar-default-background-color"
|
890
|
-
},
|
891
|
-
{
|
892
|
-
"description": "Allows customization of the default foreground color.",
|
893
|
-
"name": "--mdc-avatar-default-foreground-color"
|
894
|
-
},
|
895
|
-
{
|
896
|
-
"description": "Allows customization of the loading indicator background color.",
|
897
|
-
"name": "--mdc-avatar-loading-indicator-background-color"
|
898
|
-
},
|
899
|
-
{
|
900
|
-
"description": "Allows customization of the loading indicator foreground color.",
|
901
|
-
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
902
|
-
},
|
903
|
-
{
|
904
|
-
"description": "Allows customization of the loading overlay background color.",
|
905
|
-
"name": "--mdc-avatar-loading-overlay-background-color"
|
906
|
-
}
|
907
|
-
],
|
908
|
-
"members": [
|
909
|
-
{
|
910
|
-
"kind": "field",
|
911
|
-
"name": "src",
|
912
|
-
"type": {
|
913
|
-
"text": "string | undefined"
|
914
|
-
},
|
915
|
-
"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.",
|
916
|
-
"attribute": "src",
|
917
|
-
"inheritedFrom": {
|
918
|
-
"name": "AvatarComponentMixin",
|
919
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
920
|
-
}
|
921
|
-
},
|
922
|
-
{
|
923
|
-
"kind": "field",
|
924
|
-
"name": "initials",
|
925
|
-
"type": {
|
926
|
-
"text": "string | undefined"
|
927
|
-
},
|
928
|
-
"description": "The initials to be displayed for the avatar.",
|
929
|
-
"attribute": "initials",
|
930
|
-
"inheritedFrom": {
|
931
|
-
"name": "AvatarComponentMixin",
|
932
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
933
|
-
}
|
934
|
-
},
|
935
|
-
{
|
936
|
-
"kind": "field",
|
937
|
-
"name": "presence",
|
938
|
-
"type": {
|
939
|
-
"text": "PresenceType | undefined"
|
940
|
-
},
|
941
|
-
"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`",
|
942
|
-
"attribute": "presence",
|
943
|
-
"inheritedFrom": {
|
944
|
-
"name": "AvatarComponentMixin",
|
945
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
946
|
-
}
|
947
|
-
},
|
948
|
-
{
|
949
|
-
"kind": "field",
|
950
|
-
"name": "size",
|
951
|
-
"type": {
|
952
|
-
"text": "AvatarSize"
|
953
|
-
},
|
954
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
955
|
-
"default": "32",
|
956
|
-
"attribute": "size",
|
957
|
-
"reflects": true,
|
958
|
-
"inheritedFrom": {
|
959
|
-
"name": "AvatarComponentMixin",
|
960
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
961
|
-
}
|
962
|
-
},
|
963
|
-
{
|
964
|
-
"kind": "field",
|
965
|
-
"name": "counter",
|
966
|
-
"type": {
|
967
|
-
"text": "number | undefined"
|
968
|
-
},
|
969
|
-
"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`.",
|
970
|
-
"attribute": "counter",
|
971
|
-
"inheritedFrom": {
|
972
|
-
"name": "AvatarComponentMixin",
|
973
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
974
|
-
}
|
975
|
-
},
|
976
|
-
{
|
977
|
-
"kind": "field",
|
978
|
-
"name": "isTyping",
|
979
|
-
"type": {
|
980
|
-
"text": "boolean"
|
981
|
-
},
|
982
|
-
"default": "false",
|
983
|
-
"description": "Represents the typing indicator when the user is typing.",
|
984
|
-
"attribute": "is-typing",
|
985
|
-
"inheritedFrom": {
|
986
|
-
"name": "AvatarComponentMixin",
|
987
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
988
|
-
}
|
989
|
-
},
|
990
|
-
{
|
991
|
-
"kind": "field",
|
992
|
-
"name": "iconName",
|
993
|
-
"type": {
|
994
|
-
"text": "IconNames | undefined"
|
995
|
-
},
|
996
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
997
|
-
"attribute": "icon-name",
|
998
|
-
"inheritedFrom": {
|
999
|
-
"name": "IconNameMixin",
|
1000
|
-
"module": "utils/mixins/IconNameMixin.js"
|
1001
|
-
}
|
1002
|
-
}
|
1003
|
-
],
|
1004
|
-
"mixins": [
|
1005
|
-
{
|
1006
|
-
"name": "AvatarComponentMixin",
|
1007
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1008
|
-
},
|
1009
|
-
{
|
1010
|
-
"name": "IconNameMixin",
|
1011
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
1012
|
-
}
|
1013
|
-
],
|
1014
|
-
"superclass": {
|
1015
|
-
"name": "Component",
|
1016
|
-
"module": "/src/models"
|
1017
|
-
},
|
1018
|
-
"tagName": "mdc-avatar",
|
1019
|
-
"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 */",
|
1020
|
-
"customElement": true,
|
1021
|
-
"attributes": [
|
1022
|
-
{
|
1023
|
-
"name": "src",
|
689
|
+
"name": "IconNameMixin",
|
690
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
691
|
+
}
|
692
|
+
],
|
693
|
+
"superclass": {
|
694
|
+
"name": "Component",
|
695
|
+
"module": "/src/models"
|
696
|
+
},
|
697
|
+
"tagName": "mdc-avatar",
|
698
|
+
"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 */",
|
699
|
+
"customElement": true,
|
700
|
+
"attributes": [
|
701
|
+
{
|
702
|
+
"name": "src",
|
1024
703
|
"type": {
|
1025
704
|
"text": "string | undefined"
|
1026
705
|
},
|
@@ -1216,479 +895,800 @@
|
|
1216
895
|
"reflects": true
|
1217
896
|
},
|
1218
897
|
{
|
1219
|
-
"kind": "field",
|
1220
|
-
"name": "postfixIcon",
|
898
|
+
"kind": "field",
|
899
|
+
"name": "postfixIcon",
|
900
|
+
"type": {
|
901
|
+
"text": "string | undefined"
|
902
|
+
},
|
903
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
904
|
+
"attribute": "postfix-icon",
|
905
|
+
"reflects": true
|
906
|
+
},
|
907
|
+
{
|
908
|
+
"kind": "field",
|
909
|
+
"name": "variant",
|
910
|
+
"type": {
|
911
|
+
"text": "ButtonVariant"
|
912
|
+
},
|
913
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
914
|
+
"default": "primary",
|
915
|
+
"attribute": "variant"
|
916
|
+
},
|
917
|
+
{
|
918
|
+
"kind": "field",
|
919
|
+
"name": "size",
|
920
|
+
"type": {
|
921
|
+
"text": "ButtonSize"
|
922
|
+
},
|
923
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
924
|
+
"default": "32",
|
925
|
+
"attribute": "size",
|
926
|
+
"reflects": true,
|
927
|
+
"inheritedFrom": {
|
928
|
+
"name": "Buttonsimple",
|
929
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
930
|
+
}
|
931
|
+
},
|
932
|
+
{
|
933
|
+
"kind": "field",
|
934
|
+
"name": "color",
|
935
|
+
"type": {
|
936
|
+
"text": "ButtonColor"
|
937
|
+
},
|
938
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
939
|
+
"default": "default",
|
940
|
+
"attribute": "color"
|
941
|
+
},
|
942
|
+
{
|
943
|
+
"kind": "field",
|
944
|
+
"name": "role",
|
945
|
+
"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.",
|
946
|
+
"default": "'button'",
|
947
|
+
"attribute": "role",
|
948
|
+
"reflects": true,
|
949
|
+
"type": {
|
950
|
+
"text": "string"
|
951
|
+
},
|
952
|
+
"inheritedFrom": {
|
953
|
+
"name": "Buttonsimple",
|
954
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
955
|
+
}
|
956
|
+
},
|
957
|
+
{
|
958
|
+
"kind": "method",
|
959
|
+
"name": "modifyIconName",
|
960
|
+
"privacy": "private",
|
961
|
+
"parameters": [
|
962
|
+
{
|
963
|
+
"name": "active",
|
964
|
+
"type": {
|
965
|
+
"text": "boolean"
|
966
|
+
},
|
967
|
+
"description": "The active state."
|
968
|
+
}
|
969
|
+
],
|
970
|
+
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
971
|
+
},
|
972
|
+
{
|
973
|
+
"kind": "method",
|
974
|
+
"name": "setVariant",
|
975
|
+
"privacy": "private",
|
976
|
+
"parameters": [
|
977
|
+
{
|
978
|
+
"name": "variant",
|
979
|
+
"type": {
|
980
|
+
"text": "ButtonVariant"
|
981
|
+
},
|
982
|
+
"description": "The variant to set."
|
983
|
+
}
|
984
|
+
],
|
985
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
986
|
+
},
|
987
|
+
{
|
988
|
+
"kind": "method",
|
989
|
+
"name": "setSize",
|
990
|
+
"privacy": "private",
|
991
|
+
"parameters": [
|
992
|
+
{
|
993
|
+
"name": "size",
|
994
|
+
"type": {
|
995
|
+
"text": "PillButtonSize | IconButtonSize"
|
996
|
+
},
|
997
|
+
"description": "The size to set."
|
998
|
+
}
|
999
|
+
],
|
1000
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
|
1001
|
+
},
|
1002
|
+
{
|
1003
|
+
"kind": "method",
|
1004
|
+
"name": "setColor",
|
1005
|
+
"privacy": "private",
|
1006
|
+
"parameters": [
|
1007
|
+
{
|
1008
|
+
"name": "color",
|
1009
|
+
"type": {
|
1010
|
+
"text": "ButtonColor"
|
1011
|
+
},
|
1012
|
+
"description": "The color to set."
|
1013
|
+
}
|
1014
|
+
],
|
1015
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
1016
|
+
},
|
1017
|
+
{
|
1018
|
+
"kind": "method",
|
1019
|
+
"name": "inferButtonType",
|
1020
|
+
"privacy": "private",
|
1021
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
1022
|
+
"parameters": [
|
1023
|
+
{
|
1024
|
+
"description": "default slot of button",
|
1025
|
+
"name": "slot"
|
1026
|
+
}
|
1027
|
+
]
|
1028
|
+
},
|
1029
|
+
{
|
1030
|
+
"kind": "field",
|
1031
|
+
"name": "tabIndex",
|
1032
|
+
"type": {
|
1033
|
+
"text": "number"
|
1034
|
+
},
|
1035
|
+
"default": "0",
|
1036
|
+
"description": "This property specifies the tab order of the element.",
|
1037
|
+
"attribute": "tabIndex",
|
1038
|
+
"reflects": true,
|
1039
|
+
"inheritedFrom": {
|
1040
|
+
"name": "TabIndexMixin",
|
1041
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1042
|
+
}
|
1043
|
+
},
|
1044
|
+
{
|
1045
|
+
"kind": "field",
|
1046
|
+
"name": "disabled",
|
1047
|
+
"type": {
|
1048
|
+
"text": "boolean"
|
1049
|
+
},
|
1050
|
+
"default": "false",
|
1051
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1052
|
+
"attribute": "disabled",
|
1053
|
+
"reflects": true,
|
1054
|
+
"inheritedFrom": {
|
1055
|
+
"name": "DisabledMixin",
|
1056
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1057
|
+
}
|
1058
|
+
},
|
1059
|
+
{
|
1060
|
+
"kind": "field",
|
1061
|
+
"name": "active",
|
1062
|
+
"type": {
|
1063
|
+
"text": "boolean"
|
1064
|
+
},
|
1065
|
+
"default": "false",
|
1066
|
+
"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.",
|
1067
|
+
"attribute": "active",
|
1068
|
+
"reflects": true,
|
1069
|
+
"inheritedFrom": {
|
1070
|
+
"name": "Buttonsimple",
|
1071
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1072
|
+
}
|
1073
|
+
},
|
1074
|
+
{
|
1075
|
+
"kind": "field",
|
1076
|
+
"name": "softDisabled",
|
1077
|
+
"type": {
|
1078
|
+
"text": "boolean"
|
1079
|
+
},
|
1080
|
+
"default": "false",
|
1081
|
+
"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.",
|
1082
|
+
"attribute": "soft-disabled",
|
1083
|
+
"inheritedFrom": {
|
1084
|
+
"name": "Buttonsimple",
|
1085
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1086
|
+
}
|
1087
|
+
},
|
1088
|
+
{
|
1089
|
+
"kind": "field",
|
1090
|
+
"name": "type",
|
1091
|
+
"type": {
|
1092
|
+
"text": "ButtonType"
|
1093
|
+
},
|
1094
|
+
"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.",
|
1095
|
+
"default": "button",
|
1096
|
+
"attribute": "type",
|
1097
|
+
"reflects": true,
|
1098
|
+
"inheritedFrom": {
|
1099
|
+
"name": "Buttonsimple",
|
1100
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1101
|
+
}
|
1102
|
+
},
|
1103
|
+
{
|
1104
|
+
"kind": "method",
|
1105
|
+
"name": "executeAction",
|
1106
|
+
"privacy": "protected",
|
1107
|
+
"inheritedFrom": {
|
1108
|
+
"name": "Buttonsimple",
|
1109
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1110
|
+
}
|
1111
|
+
},
|
1112
|
+
{
|
1113
|
+
"kind": "method",
|
1114
|
+
"name": "setActive",
|
1115
|
+
"privacy": "protected",
|
1116
|
+
"parameters": [
|
1117
|
+
{
|
1118
|
+
"name": "element",
|
1119
|
+
"type": {
|
1120
|
+
"text": "HTMLElement"
|
1121
|
+
},
|
1122
|
+
"description": "The button element"
|
1123
|
+
},
|
1124
|
+
{
|
1125
|
+
"name": "active",
|
1126
|
+
"type": {
|
1127
|
+
"text": "boolean"
|
1128
|
+
},
|
1129
|
+
"description": "The active state of the element"
|
1130
|
+
}
|
1131
|
+
],
|
1132
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
1133
|
+
"inheritedFrom": {
|
1134
|
+
"name": "Buttonsimple",
|
1135
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1136
|
+
}
|
1137
|
+
},
|
1138
|
+
{
|
1139
|
+
"kind": "method",
|
1140
|
+
"name": "setSoftDisabled",
|
1141
|
+
"privacy": "private",
|
1142
|
+
"parameters": [
|
1143
|
+
{
|
1144
|
+
"name": "element",
|
1145
|
+
"type": {
|
1146
|
+
"text": "HTMLElement"
|
1147
|
+
},
|
1148
|
+
"description": "The button element."
|
1149
|
+
},
|
1150
|
+
{
|
1151
|
+
"name": "softDisabled",
|
1152
|
+
"type": {
|
1153
|
+
"text": "boolean"
|
1154
|
+
},
|
1155
|
+
"description": "The soft-disabled state."
|
1156
|
+
}
|
1157
|
+
],
|
1158
|
+
"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.",
|
1159
|
+
"inheritedFrom": {
|
1160
|
+
"name": "Buttonsimple",
|
1161
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1162
|
+
}
|
1163
|
+
},
|
1164
|
+
{
|
1165
|
+
"kind": "method",
|
1166
|
+
"name": "setDisabled",
|
1167
|
+
"privacy": "private",
|
1168
|
+
"parameters": [
|
1169
|
+
{
|
1170
|
+
"name": "element",
|
1171
|
+
"type": {
|
1172
|
+
"text": "HTMLElement"
|
1173
|
+
},
|
1174
|
+
"description": "The button element."
|
1175
|
+
},
|
1176
|
+
{
|
1177
|
+
"name": "disabled",
|
1178
|
+
"type": {
|
1179
|
+
"text": "boolean"
|
1180
|
+
},
|
1181
|
+
"description": "The disabled state."
|
1182
|
+
}
|
1183
|
+
],
|
1184
|
+
"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.",
|
1185
|
+
"inheritedFrom": {
|
1186
|
+
"name": "Buttonsimple",
|
1187
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1188
|
+
}
|
1189
|
+
},
|
1190
|
+
{
|
1191
|
+
"kind": "method",
|
1192
|
+
"name": "triggerClickEvent",
|
1193
|
+
"privacy": "private",
|
1194
|
+
"inheritedFrom": {
|
1195
|
+
"name": "Buttonsimple",
|
1196
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1197
|
+
}
|
1198
|
+
},
|
1199
|
+
{
|
1200
|
+
"kind": "method",
|
1201
|
+
"name": "handleKeyDown",
|
1202
|
+
"privacy": "private",
|
1203
|
+
"parameters": [
|
1204
|
+
{
|
1205
|
+
"name": "event",
|
1206
|
+
"type": {
|
1207
|
+
"text": "KeyboardEvent"
|
1208
|
+
},
|
1209
|
+
"description": "The keyboard event."
|
1210
|
+
}
|
1211
|
+
],
|
1212
|
+
"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.",
|
1213
|
+
"inheritedFrom": {
|
1214
|
+
"name": "Buttonsimple",
|
1215
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1216
|
+
}
|
1217
|
+
},
|
1218
|
+
{
|
1219
|
+
"kind": "method",
|
1220
|
+
"name": "handleKeyUp",
|
1221
|
+
"privacy": "private",
|
1222
|
+
"parameters": [
|
1223
|
+
{
|
1224
|
+
"name": "event",
|
1225
|
+
"type": {
|
1226
|
+
"text": "KeyboardEvent"
|
1227
|
+
},
|
1228
|
+
"description": "The keyboard event."
|
1229
|
+
}
|
1230
|
+
],
|
1231
|
+
"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.",
|
1232
|
+
"inheritedFrom": {
|
1233
|
+
"name": "Buttonsimple",
|
1234
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1235
|
+
}
|
1236
|
+
}
|
1237
|
+
],
|
1238
|
+
"attributes": [
|
1239
|
+
{
|
1240
|
+
"name": "prefix-icon",
|
1241
|
+
"type": {
|
1242
|
+
"text": "string | undefined"
|
1243
|
+
},
|
1244
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1245
|
+
"fieldName": "prefixIcon"
|
1246
|
+
},
|
1247
|
+
{
|
1248
|
+
"name": "postfix-icon",
|
1221
1249
|
"type": {
|
1222
1250
|
"text": "string | undefined"
|
1223
1251
|
},
|
1224
1252
|
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1225
|
-
"
|
1226
|
-
"reflects": true
|
1253
|
+
"fieldName": "postfixIcon"
|
1227
1254
|
},
|
1228
1255
|
{
|
1229
|
-
"kind": "field",
|
1230
1256
|
"name": "variant",
|
1231
1257
|
"type": {
|
1232
1258
|
"text": "ButtonVariant"
|
1233
1259
|
},
|
1234
1260
|
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
1235
1261
|
"default": "primary",
|
1236
|
-
"
|
1262
|
+
"fieldName": "variant"
|
1237
1263
|
},
|
1238
1264
|
{
|
1239
|
-
"kind": "field",
|
1240
1265
|
"name": "size",
|
1241
1266
|
"type": {
|
1242
1267
|
"text": "ButtonSize"
|
1243
1268
|
},
|
1244
1269
|
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1245
1270
|
"default": "32",
|
1246
|
-
"
|
1247
|
-
"reflects": true,
|
1271
|
+
"fieldName": "size",
|
1248
1272
|
"inheritedFrom": {
|
1249
1273
|
"name": "Buttonsimple",
|
1250
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1274
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1251
1275
|
}
|
1252
1276
|
},
|
1253
1277
|
{
|
1254
|
-
"kind": "field",
|
1255
1278
|
"name": "color",
|
1256
1279
|
"type": {
|
1257
1280
|
"text": "ButtonColor"
|
1258
1281
|
},
|
1259
1282
|
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1260
1283
|
"default": "default",
|
1261
|
-
"
|
1284
|
+
"fieldName": "color"
|
1262
1285
|
},
|
1263
1286
|
{
|
1264
|
-
"kind": "field",
|
1265
1287
|
"name": "role",
|
1266
1288
|
"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.",
|
1267
1289
|
"default": "'button'",
|
1268
|
-
"
|
1269
|
-
"reflects": true,
|
1290
|
+
"fieldName": "role",
|
1270
1291
|
"type": {
|
1271
1292
|
"text": "string"
|
1272
1293
|
},
|
1273
1294
|
"inheritedFrom": {
|
1274
1295
|
"name": "Buttonsimple",
|
1275
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1296
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1276
1297
|
}
|
1277
1298
|
},
|
1278
1299
|
{
|
1279
|
-
"kind": "method",
|
1280
|
-
"name": "modifyIconName",
|
1281
|
-
"privacy": "private",
|
1282
|
-
"parameters": [
|
1283
|
-
{
|
1284
|
-
"name": "active",
|
1285
|
-
"type": {
|
1286
|
-
"text": "boolean"
|
1287
|
-
},
|
1288
|
-
"description": "The active state."
|
1289
|
-
}
|
1290
|
-
],
|
1291
|
-
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
1292
|
-
},
|
1293
|
-
{
|
1294
|
-
"kind": "method",
|
1295
|
-
"name": "setVariant",
|
1296
|
-
"privacy": "private",
|
1297
|
-
"parameters": [
|
1298
|
-
{
|
1299
|
-
"name": "variant",
|
1300
|
-
"type": {
|
1301
|
-
"text": "ButtonVariant"
|
1302
|
-
},
|
1303
|
-
"description": "The variant to set."
|
1304
|
-
}
|
1305
|
-
],
|
1306
|
-
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
1307
|
-
},
|
1308
|
-
{
|
1309
|
-
"kind": "method",
|
1310
|
-
"name": "setSize",
|
1311
|
-
"privacy": "private",
|
1312
|
-
"parameters": [
|
1313
|
-
{
|
1314
|
-
"name": "size",
|
1315
|
-
"type": {
|
1316
|
-
"text": "PillButtonSize | IconButtonSize"
|
1317
|
-
},
|
1318
|
-
"description": "The size to set."
|
1319
|
-
}
|
1320
|
-
],
|
1321
|
-
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
|
1322
|
-
},
|
1323
|
-
{
|
1324
|
-
"kind": "method",
|
1325
|
-
"name": "setColor",
|
1326
|
-
"privacy": "private",
|
1327
|
-
"parameters": [
|
1328
|
-
{
|
1329
|
-
"name": "color",
|
1330
|
-
"type": {
|
1331
|
-
"text": "ButtonColor"
|
1332
|
-
},
|
1333
|
-
"description": "The color to set."
|
1334
|
-
}
|
1335
|
-
],
|
1336
|
-
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
1337
|
-
},
|
1338
|
-
{
|
1339
|
-
"kind": "method",
|
1340
|
-
"name": "inferButtonType",
|
1341
|
-
"privacy": "private",
|
1342
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
1343
|
-
"parameters": [
|
1344
|
-
{
|
1345
|
-
"description": "default slot of button",
|
1346
|
-
"name": "slot"
|
1347
|
-
}
|
1348
|
-
]
|
1349
|
-
},
|
1350
|
-
{
|
1351
|
-
"kind": "field",
|
1352
1300
|
"name": "tabIndex",
|
1353
1301
|
"type": {
|
1354
1302
|
"text": "number"
|
1355
1303
|
},
|
1356
1304
|
"default": "0",
|
1357
1305
|
"description": "This property specifies the tab order of the element.",
|
1358
|
-
"
|
1359
|
-
"reflects": true,
|
1306
|
+
"fieldName": "tabIndex",
|
1360
1307
|
"inheritedFrom": {
|
1361
1308
|
"name": "TabIndexMixin",
|
1362
|
-
"module": "utils/mixins/TabIndexMixin.
|
1309
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1363
1310
|
}
|
1364
1311
|
},
|
1365
1312
|
{
|
1366
|
-
"kind": "field",
|
1367
1313
|
"name": "disabled",
|
1368
1314
|
"type": {
|
1369
1315
|
"text": "boolean"
|
1370
1316
|
},
|
1371
1317
|
"default": "false",
|
1372
1318
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1373
|
-
"
|
1374
|
-
"reflects": true,
|
1319
|
+
"fieldName": "disabled",
|
1375
1320
|
"inheritedFrom": {
|
1376
1321
|
"name": "DisabledMixin",
|
1377
|
-
"module": "utils/mixins/DisabledMixin.
|
1322
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1378
1323
|
}
|
1379
1324
|
},
|
1380
1325
|
{
|
1381
|
-
"kind": "field",
|
1382
1326
|
"name": "active",
|
1383
1327
|
"type": {
|
1384
1328
|
"text": "boolean"
|
1385
1329
|
},
|
1386
|
-
"default": "false",
|
1387
|
-
"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.",
|
1388
|
-
"
|
1389
|
-
"
|
1390
|
-
|
1391
|
-
"
|
1392
|
-
|
1393
|
-
|
1330
|
+
"default": "false",
|
1331
|
+
"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.",
|
1332
|
+
"fieldName": "active",
|
1333
|
+
"inheritedFrom": {
|
1334
|
+
"name": "Buttonsimple",
|
1335
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1336
|
+
}
|
1337
|
+
},
|
1338
|
+
{
|
1339
|
+
"name": "soft-disabled",
|
1340
|
+
"type": {
|
1341
|
+
"text": "boolean"
|
1342
|
+
},
|
1343
|
+
"default": "false",
|
1344
|
+
"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.",
|
1345
|
+
"fieldName": "softDisabled",
|
1346
|
+
"inheritedFrom": {
|
1347
|
+
"name": "Buttonsimple",
|
1348
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1349
|
+
}
|
1350
|
+
},
|
1351
|
+
{
|
1352
|
+
"name": "type",
|
1353
|
+
"type": {
|
1354
|
+
"text": "ButtonType"
|
1355
|
+
},
|
1356
|
+
"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.",
|
1357
|
+
"default": "button",
|
1358
|
+
"fieldName": "type",
|
1359
|
+
"inheritedFrom": {
|
1360
|
+
"name": "Buttonsimple",
|
1361
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1362
|
+
}
|
1363
|
+
}
|
1364
|
+
],
|
1365
|
+
"superclass": {
|
1366
|
+
"name": "Buttonsimple",
|
1367
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1368
|
+
},
|
1369
|
+
"tagName": "mdc-button",
|
1370
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
1371
|
+
"customElement": true
|
1372
|
+
}
|
1373
|
+
],
|
1374
|
+
"exports": [
|
1375
|
+
{
|
1376
|
+
"kind": "js",
|
1377
|
+
"name": "default",
|
1378
|
+
"declaration": {
|
1379
|
+
"name": "Button",
|
1380
|
+
"module": "components/button/button.component.js"
|
1381
|
+
}
|
1382
|
+
}
|
1383
|
+
]
|
1384
|
+
},
|
1385
|
+
{
|
1386
|
+
"kind": "javascript-module",
|
1387
|
+
"path": "components/badge/badge.component.js",
|
1388
|
+
"declarations": [
|
1389
|
+
{
|
1390
|
+
"kind": "class",
|
1391
|
+
"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.",
|
1392
|
+
"name": "Badge",
|
1393
|
+
"cssProperties": [
|
1394
|
+
{
|
1395
|
+
"description": "The foreground color of the primary badge.",
|
1396
|
+
"name": "--mdc-badge-primary-foreground-color"
|
1397
|
+
},
|
1398
|
+
{
|
1399
|
+
"description": "The background color of the primary badge.",
|
1400
|
+
"name": "--mdc-badge-primary-background-color"
|
1401
|
+
},
|
1402
|
+
{
|
1403
|
+
"description": "The foreground color of the secondary badge.",
|
1404
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
1405
|
+
},
|
1406
|
+
{
|
1407
|
+
"description": "The background color of the secondary badge.",
|
1408
|
+
"name": "--mdc-badge-secondary-background-color"
|
1409
|
+
},
|
1410
|
+
{
|
1411
|
+
"description": "The foreground color of the success badge.",
|
1412
|
+
"name": "--mdc-badge-success-foreground-color"
|
1413
|
+
},
|
1414
|
+
{
|
1415
|
+
"description": "The background color of the success badge.",
|
1416
|
+
"name": "--mdc-badge-success-background-color"
|
1417
|
+
},
|
1418
|
+
{
|
1419
|
+
"description": "The foreground color of the warning badge.",
|
1420
|
+
"name": "--mdc-badge-warning-foreground-color"
|
1421
|
+
},
|
1422
|
+
{
|
1423
|
+
"description": "The background color of the warning badge.",
|
1424
|
+
"name": "--mdc-badge-warning-background-color"
|
1425
|
+
},
|
1426
|
+
{
|
1427
|
+
"description": "The foreground color of the error badge.",
|
1428
|
+
"name": "--mdc-badge-error-foreground-color"
|
1429
|
+
},
|
1430
|
+
{
|
1431
|
+
"description": "The background color of the error badge.",
|
1432
|
+
"name": "--mdc-badge-error-background-color"
|
1433
|
+
},
|
1434
|
+
{
|
1435
|
+
"description": "The background color of the badge overlay.",
|
1436
|
+
"name": "--mdc-badge-overlay-background-color"
|
1437
|
+
}
|
1438
|
+
],
|
1439
|
+
"members": [
|
1440
|
+
{
|
1441
|
+
"kind": "field",
|
1442
|
+
"name": "type",
|
1443
|
+
"type": {
|
1444
|
+
"text": "BadgeType | undefined"
|
1445
|
+
},
|
1446
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1447
|
+
"attribute": "type",
|
1448
|
+
"reflects": true
|
1449
|
+
},
|
1450
|
+
{
|
1451
|
+
"kind": "field",
|
1452
|
+
"name": "variant",
|
1453
|
+
"type": {
|
1454
|
+
"text": "IconVariant"
|
1455
|
+
},
|
1456
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1457
|
+
"default": "primary",
|
1458
|
+
"attribute": "variant",
|
1459
|
+
"reflects": true
|
1460
|
+
},
|
1461
|
+
{
|
1462
|
+
"kind": "field",
|
1463
|
+
"name": "counter",
|
1464
|
+
"type": {
|
1465
|
+
"text": "number | undefined"
|
1466
|
+
},
|
1467
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1468
|
+
"attribute": "counter"
|
1469
|
+
},
|
1470
|
+
{
|
1471
|
+
"kind": "field",
|
1472
|
+
"name": "maxCounter",
|
1473
|
+
"type": {
|
1474
|
+
"text": "number"
|
1475
|
+
},
|
1476
|
+
"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`.",
|
1477
|
+
"default": "99",
|
1478
|
+
"attribute": "max-counter",
|
1479
|
+
"reflects": true
|
1394
1480
|
},
|
1395
1481
|
{
|
1396
1482
|
"kind": "field",
|
1397
|
-
"name": "
|
1483
|
+
"name": "overlay",
|
1398
1484
|
"type": {
|
1399
1485
|
"text": "boolean"
|
1400
1486
|
},
|
1401
1487
|
"default": "false",
|
1402
|
-
"description": "
|
1403
|
-
"attribute": "
|
1404
|
-
"inheritedFrom": {
|
1405
|
-
"name": "Buttonsimple",
|
1406
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1407
|
-
}
|
1488
|
+
"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.",
|
1489
|
+
"attribute": "overlay"
|
1408
1490
|
},
|
1409
1491
|
{
|
1410
1492
|
"kind": "field",
|
1411
|
-
"name": "
|
1493
|
+
"name": "ariaLabel",
|
1412
1494
|
"type": {
|
1413
|
-
"text": "
|
1495
|
+
"text": "string | null"
|
1414
1496
|
},
|
1415
|
-
"
|
1416
|
-
"
|
1417
|
-
"attribute": "
|
1418
|
-
"reflects": true,
|
1419
|
-
"inheritedFrom": {
|
1420
|
-
"name": "Buttonsimple",
|
1421
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1422
|
-
}
|
1423
|
-
},
|
1424
|
-
{
|
1425
|
-
"kind": "method",
|
1426
|
-
"name": "executeAction",
|
1427
|
-
"privacy": "protected",
|
1428
|
-
"inheritedFrom": {
|
1429
|
-
"name": "Buttonsimple",
|
1430
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1431
|
-
}
|
1497
|
+
"default": "null",
|
1498
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1499
|
+
"attribute": "aria-label"
|
1432
1500
|
},
|
1433
1501
|
{
|
1434
1502
|
"kind": "method",
|
1435
|
-
"name": "
|
1436
|
-
"privacy": "
|
1503
|
+
"name": "getCounterText",
|
1504
|
+
"privacy": "private",
|
1505
|
+
"return": {
|
1506
|
+
"type": {
|
1507
|
+
"text": ""
|
1508
|
+
}
|
1509
|
+
},
|
1437
1510
|
"parameters": [
|
1438
1511
|
{
|
1439
|
-
"name": "
|
1512
|
+
"name": "maxCounter",
|
1440
1513
|
"type": {
|
1441
|
-
"text": "
|
1514
|
+
"text": "number"
|
1442
1515
|
},
|
1443
|
-
"description": "
|
1516
|
+
"description": "the maximum limit which can be displayed on the badge"
|
1444
1517
|
},
|
1445
1518
|
{
|
1446
|
-
"name": "
|
1519
|
+
"name": "counter",
|
1520
|
+
"optional": true,
|
1447
1521
|
"type": {
|
1448
|
-
"text": "
|
1522
|
+
"text": "number"
|
1449
1523
|
},
|
1450
|
-
"description": "
|
1524
|
+
"description": "the number to be displayed on the badge"
|
1451
1525
|
}
|
1452
1526
|
],
|
1453
|
-
"description": "
|
1454
|
-
"inheritedFrom": {
|
1455
|
-
"name": "Buttonsimple",
|
1456
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1457
|
-
}
|
1527
|
+
"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."
|
1458
1528
|
},
|
1459
1529
|
{
|
1460
1530
|
"kind": "method",
|
1461
|
-
"name": "
|
1531
|
+
"name": "getBadgeIcon",
|
1462
1532
|
"privacy": "private",
|
1533
|
+
"return": {
|
1534
|
+
"type": {
|
1535
|
+
"text": ""
|
1536
|
+
}
|
1537
|
+
},
|
1463
1538
|
"parameters": [
|
1464
1539
|
{
|
1465
|
-
"name": "
|
1540
|
+
"name": "iconName",
|
1466
1541
|
"type": {
|
1467
|
-
"text": "
|
1542
|
+
"text": "string"
|
1468
1543
|
},
|
1469
|
-
"description": "
|
1544
|
+
"description": "the name of the icon from the icon set"
|
1470
1545
|
},
|
1471
1546
|
{
|
1472
|
-
"name": "
|
1547
|
+
"name": "backgroundClassPostfix",
|
1473
1548
|
"type": {
|
1474
|
-
"text": "
|
1549
|
+
"text": "string"
|
1475
1550
|
},
|
1476
|
-
"description": "
|
1551
|
+
"description": "postfix for the class to style the badge icon."
|
1477
1552
|
}
|
1478
1553
|
],
|
1479
|
-
"description": "
|
1480
|
-
"inheritedFrom": {
|
1481
|
-
"name": "Buttonsimple",
|
1482
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1483
|
-
}
|
1554
|
+
"description": "Method to generate the badge icon."
|
1484
1555
|
},
|
1485
1556
|
{
|
1486
1557
|
"kind": "method",
|
1487
|
-
"name": "
|
1558
|
+
"name": "getBadgeDot",
|
1488
1559
|
"privacy": "private",
|
1489
|
-
"
|
1490
|
-
{
|
1491
|
-
"
|
1492
|
-
"type": {
|
1493
|
-
"text": "HTMLElement"
|
1494
|
-
},
|
1495
|
-
"description": "The button element."
|
1496
|
-
},
|
1497
|
-
{
|
1498
|
-
"name": "disabled",
|
1499
|
-
"type": {
|
1500
|
-
"text": "boolean"
|
1501
|
-
},
|
1502
|
-
"description": "The disabled state."
|
1560
|
+
"return": {
|
1561
|
+
"type": {
|
1562
|
+
"text": ""
|
1503
1563
|
}
|
1504
|
-
|
1505
|
-
"description": "
|
1506
|
-
"inheritedFrom": {
|
1507
|
-
"name": "Buttonsimple",
|
1508
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1509
|
-
}
|
1564
|
+
},
|
1565
|
+
"description": "Method to generate the badge dot template."
|
1510
1566
|
},
|
1511
1567
|
{
|
1512
1568
|
"kind": "method",
|
1513
|
-
"name": "
|
1569
|
+
"name": "getBadgeCounterText",
|
1514
1570
|
"privacy": "private",
|
1515
|
-
"
|
1516
|
-
"
|
1517
|
-
|
1518
|
-
|
1571
|
+
"return": {
|
1572
|
+
"type": {
|
1573
|
+
"text": ""
|
1574
|
+
}
|
1575
|
+
},
|
1576
|
+
"description": "Method to generate the badge text and counter template."
|
1519
1577
|
},
|
1520
1578
|
{
|
1521
1579
|
"kind": "method",
|
1522
|
-
"name": "
|
1580
|
+
"name": "setRoleByAriaLabel",
|
1523
1581
|
"privacy": "private",
|
1524
|
-
"
|
1525
|
-
{
|
1526
|
-
"
|
1527
|
-
"type": {
|
1528
|
-
"text": "KeyboardEvent"
|
1529
|
-
},
|
1530
|
-
"description": "The keyboard event."
|
1582
|
+
"return": {
|
1583
|
+
"type": {
|
1584
|
+
"text": "void"
|
1531
1585
|
}
|
1532
|
-
|
1533
|
-
"description": "
|
1534
|
-
"inheritedFrom": {
|
1535
|
-
"name": "Buttonsimple",
|
1536
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1537
|
-
}
|
1586
|
+
},
|
1587
|
+
"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."
|
1538
1588
|
},
|
1539
1589
|
{
|
1540
1590
|
"kind": "method",
|
1541
|
-
"name": "
|
1591
|
+
"name": "getBadgeContentBasedOnType",
|
1542
1592
|
"privacy": "private",
|
1543
|
-
"
|
1544
|
-
{
|
1545
|
-
"
|
1546
|
-
"type": {
|
1547
|
-
"text": "KeyboardEvent"
|
1548
|
-
},
|
1549
|
-
"description": "The keyboard event."
|
1593
|
+
"return": {
|
1594
|
+
"type": {
|
1595
|
+
"text": ""
|
1550
1596
|
}
|
1551
|
-
|
1552
|
-
"description": "
|
1597
|
+
},
|
1598
|
+
"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."
|
1599
|
+
},
|
1600
|
+
{
|
1601
|
+
"kind": "field",
|
1602
|
+
"name": "iconName",
|
1603
|
+
"type": {
|
1604
|
+
"text": "IconNames | undefined"
|
1605
|
+
},
|
1606
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1607
|
+
"attribute": "icon-name",
|
1553
1608
|
"inheritedFrom": {
|
1554
|
-
"name": "
|
1555
|
-
"module": "
|
1609
|
+
"name": "IconNameMixin",
|
1610
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1556
1611
|
}
|
1557
1612
|
}
|
1558
1613
|
],
|
1559
1614
|
"attributes": [
|
1560
1615
|
{
|
1561
|
-
"name": "
|
1562
|
-
"type": {
|
1563
|
-
"text": "string | undefined"
|
1564
|
-
},
|
1565
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1566
|
-
"fieldName": "prefixIcon"
|
1567
|
-
},
|
1568
|
-
{
|
1569
|
-
"name": "postfix-icon",
|
1616
|
+
"name": "type",
|
1570
1617
|
"type": {
|
1571
|
-
"text": "
|
1618
|
+
"text": "BadgeType | undefined"
|
1572
1619
|
},
|
1573
|
-
"description": "
|
1574
|
-
"fieldName": "
|
1620
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1621
|
+
"fieldName": "type"
|
1575
1622
|
},
|
1576
1623
|
{
|
1577
1624
|
"name": "variant",
|
1578
1625
|
"type": {
|
1579
|
-
"text": "
|
1626
|
+
"text": "IconVariant"
|
1580
1627
|
},
|
1581
|
-
"description": "
|
1628
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1582
1629
|
"default": "primary",
|
1583
1630
|
"fieldName": "variant"
|
1584
1631
|
},
|
1585
1632
|
{
|
1586
|
-
"name": "
|
1587
|
-
"type": {
|
1588
|
-
"text": "ButtonSize"
|
1589
|
-
},
|
1590
|
-
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1591
|
-
"default": "32",
|
1592
|
-
"fieldName": "size",
|
1593
|
-
"inheritedFrom": {
|
1594
|
-
"name": "Buttonsimple",
|
1595
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1596
|
-
}
|
1597
|
-
},
|
1598
|
-
{
|
1599
|
-
"name": "color",
|
1600
|
-
"type": {
|
1601
|
-
"text": "ButtonColor"
|
1602
|
-
},
|
1603
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1604
|
-
"default": "default",
|
1605
|
-
"fieldName": "color"
|
1606
|
-
},
|
1607
|
-
{
|
1608
|
-
"name": "role",
|
1609
|
-
"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.",
|
1610
|
-
"default": "'button'",
|
1611
|
-
"fieldName": "role",
|
1612
|
-
"type": {
|
1613
|
-
"text": "string"
|
1614
|
-
},
|
1615
|
-
"inheritedFrom": {
|
1616
|
-
"name": "Buttonsimple",
|
1617
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1618
|
-
}
|
1619
|
-
},
|
1620
|
-
{
|
1621
|
-
"name": "tabIndex",
|
1622
|
-
"type": {
|
1623
|
-
"text": "number"
|
1624
|
-
},
|
1625
|
-
"default": "0",
|
1626
|
-
"description": "This property specifies the tab order of the element.",
|
1627
|
-
"fieldName": "tabIndex",
|
1628
|
-
"inheritedFrom": {
|
1629
|
-
"name": "TabIndexMixin",
|
1630
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1631
|
-
}
|
1632
|
-
},
|
1633
|
-
{
|
1634
|
-
"name": "disabled",
|
1633
|
+
"name": "counter",
|
1635
1634
|
"type": {
|
1636
|
-
"text": "
|
1635
|
+
"text": "number | undefined"
|
1637
1636
|
},
|
1638
|
-
"
|
1639
|
-
"
|
1640
|
-
"fieldName": "disabled",
|
1641
|
-
"inheritedFrom": {
|
1642
|
-
"name": "DisabledMixin",
|
1643
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
1644
|
-
}
|
1637
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1638
|
+
"fieldName": "counter"
|
1645
1639
|
},
|
1646
1640
|
{
|
1647
|
-
"name": "
|
1641
|
+
"name": "max-counter",
|
1648
1642
|
"type": {
|
1649
|
-
"text": "
|
1643
|
+
"text": "number"
|
1650
1644
|
},
|
1651
|
-
"
|
1652
|
-
"
|
1653
|
-
"fieldName": "
|
1654
|
-
"inheritedFrom": {
|
1655
|
-
"name": "Buttonsimple",
|
1656
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1657
|
-
}
|
1645
|
+
"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`.",
|
1646
|
+
"default": "99",
|
1647
|
+
"fieldName": "maxCounter"
|
1658
1648
|
},
|
1659
1649
|
{
|
1660
|
-
"name": "
|
1650
|
+
"name": "overlay",
|
1661
1651
|
"type": {
|
1662
1652
|
"text": "boolean"
|
1663
1653
|
},
|
1664
1654
|
"default": "false",
|
1665
|
-
"description": "
|
1666
|
-
"fieldName": "
|
1667
|
-
"inheritedFrom": {
|
1668
|
-
"name": "Buttonsimple",
|
1669
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1670
|
-
}
|
1655
|
+
"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.",
|
1656
|
+
"fieldName": "overlay"
|
1671
1657
|
},
|
1672
1658
|
{
|
1673
|
-
"name": "
|
1659
|
+
"name": "aria-label",
|
1674
1660
|
"type": {
|
1675
|
-
"text": "
|
1661
|
+
"text": "string | null"
|
1676
1662
|
},
|
1677
|
-
"
|
1678
|
-
"
|
1679
|
-
"fieldName": "
|
1663
|
+
"default": "null",
|
1664
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1665
|
+
"fieldName": "ariaLabel"
|
1666
|
+
},
|
1667
|
+
{
|
1668
|
+
"name": "icon-name",
|
1669
|
+
"type": {
|
1670
|
+
"text": "IconNames | undefined"
|
1671
|
+
},
|
1672
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1673
|
+
"fieldName": "iconName",
|
1680
1674
|
"inheritedFrom": {
|
1681
|
-
"name": "
|
1682
|
-
"module": "src/
|
1675
|
+
"name": "IconNameMixin",
|
1676
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1683
1677
|
}
|
1684
1678
|
}
|
1685
1679
|
],
|
1680
|
+
"mixins": [
|
1681
|
+
{
|
1682
|
+
"name": "IconNameMixin",
|
1683
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1684
|
+
}
|
1685
|
+
],
|
1686
1686
|
"superclass": {
|
1687
|
-
"name": "
|
1688
|
-
"module": "/src/
|
1687
|
+
"name": "Component",
|
1688
|
+
"module": "/src/models"
|
1689
1689
|
},
|
1690
|
-
"tagName": "mdc-
|
1691
|
-
"jsDoc": "/**\n * `mdc-
|
1690
|
+
"tagName": "mdc-badge",
|
1691
|
+
"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 */",
|
1692
1692
|
"customElement": true
|
1693
1693
|
}
|
1694
1694
|
],
|
@@ -1697,8 +1697,8 @@
|
|
1697
1697
|
"kind": "js",
|
1698
1698
|
"name": "default",
|
1699
1699
|
"declaration": {
|
1700
|
-
"name": "
|
1701
|
-
"module": "components/
|
1700
|
+
"name": "Badge",
|
1701
|
+
"module": "components/badge/badge.component.js"
|
1702
1702
|
}
|
1703
1703
|
}
|
1704
1704
|
]
|
@@ -2753,273 +2753,79 @@
|
|
2753
2753
|
"privacy": "private",
|
2754
2754
|
"return": {
|
2755
2755
|
"type": {
|
2756
|
-
"text": "void"
|
2757
|
-
}
|
2758
|
-
},
|
2759
|
-
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
2760
|
-
},
|
2761
|
-
{
|
2762
|
-
"kind": "method",
|
2763
|
-
"name": "getArrowIcon",
|
2764
|
-
"privacy": "private",
|
2765
|
-
"return": {
|
2766
|
-
"type": {
|
2767
|
-
"text": ""
|
2768
|
-
}
|
2769
|
-
},
|
2770
|
-
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
2771
|
-
},
|
2772
|
-
{
|
2773
|
-
"kind": "method",
|
2774
|
-
"name": "inferDividerType",
|
2775
|
-
"privacy": "private",
|
2776
|
-
"description": "Infers the type of divider based on the kind of slot present.",
|
2777
|
-
"parameters": [
|
2778
|
-
{
|
2779
|
-
"description": "default slot of divider",
|
2780
|
-
"name": "slot"
|
2781
|
-
}
|
2782
|
-
]
|
2783
|
-
}
|
2784
|
-
],
|
2785
|
-
"attributes": [
|
2786
|
-
{
|
2787
|
-
"name": "orientation",
|
2788
|
-
"type": {
|
2789
|
-
"text": "DividerOrientation"
|
2790
|
-
},
|
2791
|
-
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
2792
|
-
"default": "horizontal",
|
2793
|
-
"fieldName": "orientation"
|
2794
|
-
},
|
2795
|
-
{
|
2796
|
-
"name": "variant",
|
2797
|
-
"type": {
|
2798
|
-
"text": "DividerVariant"
|
2799
|
-
},
|
2800
|
-
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
2801
|
-
"default": "solid",
|
2802
|
-
"fieldName": "variant"
|
2803
|
-
},
|
2804
|
-
{
|
2805
|
-
"name": "arrow-direction",
|
2806
|
-
"type": {
|
2807
|
-
"text": "Directions"
|
2808
|
-
},
|
2809
|
-
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
2810
|
-
"default": "'negative'",
|
2811
|
-
"fieldName": "arrowDirection"
|
2812
|
-
},
|
2813
|
-
{
|
2814
|
-
"name": "button-position",
|
2815
|
-
"type": {
|
2816
|
-
"text": "Directions"
|
2817
|
-
},
|
2818
|
-
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
2819
|
-
"default": "'negative'",
|
2820
|
-
"fieldName": "buttonPosition"
|
2821
|
-
}
|
2822
|
-
],
|
2823
|
-
"superclass": {
|
2824
|
-
"name": "Component",
|
2825
|
-
"module": "/src/models"
|
2826
|
-
},
|
2827
|
-
"tagName": "mdc-divider",
|
2828
|
-
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
2829
|
-
"customElement": true
|
2830
|
-
}
|
2831
|
-
],
|
2832
|
-
"exports": [
|
2833
|
-
{
|
2834
|
-
"kind": "js",
|
2835
|
-
"name": "default",
|
2836
|
-
"declaration": {
|
2837
|
-
"name": "Divider",
|
2838
|
-
"module": "components/divider/divider.component.js"
|
2839
|
-
}
|
2840
|
-
}
|
2841
|
-
]
|
2842
|
-
},
|
2843
|
-
{
|
2844
|
-
"kind": "javascript-module",
|
2845
|
-
"path": "components/formfieldwrapper/formfieldwrapper.component.js",
|
2846
|
-
"declarations": [
|
2847
|
-
{
|
2848
|
-
"kind": "class",
|
2849
|
-
"description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
|
2850
|
-
"name": "FormfieldWrapper",
|
2851
|
-
"slots": [
|
2852
|
-
{
|
2853
|
-
"description": "slot to add the label info icon",
|
2854
|
-
"name": "label-info"
|
2855
|
-
}
|
2856
|
-
],
|
2857
|
-
"members": [
|
2858
|
-
{
|
2859
|
-
"kind": "field",
|
2860
|
-
"name": "label",
|
2861
|
-
"type": {
|
2862
|
-
"text": "string | undefined"
|
2863
|
-
},
|
2864
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2865
|
-
"attribute": "label",
|
2866
|
-
"reflects": true
|
2867
|
-
},
|
2868
|
-
{
|
2869
|
-
"kind": "field",
|
2870
|
-
"name": "id",
|
2871
|
-
"default": "`mdc-input-${uuidv4()}`",
|
2872
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2873
|
-
"attribute": "id"
|
2874
|
-
},
|
2875
|
-
{
|
2876
|
-
"kind": "field",
|
2877
|
-
"name": "helpTextType",
|
2878
|
-
"type": {
|
2879
|
-
"text": "ValidationType"
|
2880
|
-
},
|
2881
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2882
|
-
"attribute": "help-text-type",
|
2883
|
-
"reflects": true
|
2884
|
-
},
|
2885
|
-
{
|
2886
|
-
"kind": "field",
|
2887
|
-
"name": "helpText",
|
2888
|
-
"type": {
|
2889
|
-
"text": "string | undefined"
|
2890
|
-
},
|
2891
|
-
"description": "The help text that is displayed below the input field.",
|
2892
|
-
"attribute": "help-text",
|
2893
|
-
"reflects": true
|
2894
|
-
},
|
2895
|
-
{
|
2896
|
-
"kind": "method",
|
2897
|
-
"name": "renderLabelElement",
|
2898
|
-
"privacy": "protected",
|
2899
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2900
|
-
"return": {
|
2901
|
-
"type": {
|
2902
|
-
"text": ""
|
2903
|
-
}
|
2904
|
-
}
|
2905
|
-
},
|
2906
|
-
{
|
2907
|
-
"kind": "method",
|
2908
|
-
"name": "renderHelpTextIcon",
|
2909
|
-
"privacy": "protected",
|
2910
|
-
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
2911
|
-
"return": {
|
2912
|
-
"type": {
|
2913
|
-
"text": ""
|
2914
|
-
}
|
2915
|
-
}
|
2916
|
-
},
|
2917
|
-
{
|
2918
|
-
"kind": "method",
|
2919
|
-
"name": "renderHelpText",
|
2920
|
-
"privacy": "protected",
|
2921
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
2922
|
-
"return": {
|
2923
|
-
"type": {
|
2924
|
-
"text": ""
|
2925
|
-
}
|
2926
|
-
}
|
2927
|
-
},
|
2928
|
-
{
|
2929
|
-
"kind": "method",
|
2930
|
-
"name": "renderLabel",
|
2931
|
-
"privacy": "protected",
|
2932
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2933
|
-
"return": {
|
2934
|
-
"type": {
|
2935
|
-
"text": ""
|
2756
|
+
"text": "void"
|
2936
2757
|
}
|
2937
|
-
}
|
2758
|
+
},
|
2759
|
+
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
2938
2760
|
},
|
2939
2761
|
{
|
2940
2762
|
"kind": "method",
|
2941
|
-
"name": "
|
2942
|
-
"privacy": "
|
2943
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2763
|
+
"name": "getArrowIcon",
|
2764
|
+
"privacy": "private",
|
2944
2765
|
"return": {
|
2945
2766
|
"type": {
|
2946
2767
|
"text": ""
|
2947
2768
|
}
|
2948
|
-
}
|
2769
|
+
},
|
2770
|
+
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
2949
2771
|
},
|
2950
2772
|
{
|
2951
|
-
"kind": "
|
2952
|
-
"name": "
|
2953
|
-
"
|
2954
|
-
|
2955
|
-
|
2956
|
-
|
2957
|
-
|
2958
|
-
|
2959
|
-
|
2960
|
-
|
2961
|
-
"name": "DisabledMixin",
|
2962
|
-
"module": "utils/mixins/DisabledMixin.js"
|
2963
|
-
}
|
2773
|
+
"kind": "method",
|
2774
|
+
"name": "inferDividerType",
|
2775
|
+
"privacy": "private",
|
2776
|
+
"description": "Infers the type of divider based on the kind of slot present.",
|
2777
|
+
"parameters": [
|
2778
|
+
{
|
2779
|
+
"description": "default slot of divider",
|
2780
|
+
"name": "slot"
|
2781
|
+
}
|
2782
|
+
]
|
2964
2783
|
}
|
2965
2784
|
],
|
2966
2785
|
"attributes": [
|
2967
2786
|
{
|
2968
|
-
"name": "
|
2787
|
+
"name": "orientation",
|
2969
2788
|
"type": {
|
2970
|
-
"text": "
|
2789
|
+
"text": "DividerOrientation"
|
2971
2790
|
},
|
2972
|
-
"description": "
|
2973
|
-
"
|
2974
|
-
|
2975
|
-
{
|
2976
|
-
"name": "id",
|
2977
|
-
"default": "`mdc-input-${uuidv4()}`",
|
2978
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2979
|
-
"fieldName": "id"
|
2791
|
+
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
2792
|
+
"default": "horizontal",
|
2793
|
+
"fieldName": "orientation"
|
2980
2794
|
},
|
2981
2795
|
{
|
2982
|
-
"name": "
|
2796
|
+
"name": "variant",
|
2983
2797
|
"type": {
|
2984
|
-
"text": "
|
2798
|
+
"text": "DividerVariant"
|
2985
2799
|
},
|
2986
|
-
"description": "
|
2987
|
-
"
|
2800
|
+
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
2801
|
+
"default": "solid",
|
2802
|
+
"fieldName": "variant"
|
2988
2803
|
},
|
2989
2804
|
{
|
2990
|
-
"name": "
|
2805
|
+
"name": "arrow-direction",
|
2991
2806
|
"type": {
|
2992
|
-
"text": "
|
2807
|
+
"text": "Directions"
|
2993
2808
|
},
|
2994
|
-
"description": "
|
2995
|
-
"
|
2809
|
+
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
2810
|
+
"default": "'negative'",
|
2811
|
+
"fieldName": "arrowDirection"
|
2996
2812
|
},
|
2997
2813
|
{
|
2998
|
-
"name": "
|
2814
|
+
"name": "button-position",
|
2999
2815
|
"type": {
|
3000
|
-
"text": "
|
2816
|
+
"text": "Directions"
|
3001
2817
|
},
|
3002
|
-
"
|
3003
|
-
"
|
3004
|
-
"fieldName": "
|
3005
|
-
"inheritedFrom": {
|
3006
|
-
"name": "DisabledMixin",
|
3007
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
3008
|
-
}
|
3009
|
-
}
|
3010
|
-
],
|
3011
|
-
"mixins": [
|
3012
|
-
{
|
3013
|
-
"name": "DisabledMixin",
|
3014
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
2818
|
+
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
2819
|
+
"default": "'negative'",
|
2820
|
+
"fieldName": "buttonPosition"
|
3015
2821
|
}
|
3016
2822
|
],
|
3017
2823
|
"superclass": {
|
3018
2824
|
"name": "Component",
|
3019
2825
|
"module": "/src/models"
|
3020
2826
|
},
|
3021
|
-
"tagName": "mdc-
|
3022
|
-
"jsDoc": "/**\n *
|
2827
|
+
"tagName": "mdc-divider",
|
2828
|
+
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
3023
2829
|
"customElement": true
|
3024
2830
|
}
|
3025
2831
|
],
|
@@ -3028,8 +2834,8 @@
|
|
3028
2834
|
"kind": "js",
|
3029
2835
|
"name": "default",
|
3030
2836
|
"declaration": {
|
3031
|
-
"name": "
|
3032
|
-
"module": "components/
|
2837
|
+
"name": "Divider",
|
2838
|
+
"module": "components/divider/divider.component.js"
|
3033
2839
|
}
|
3034
2840
|
}
|
3035
2841
|
]
|
@@ -3172,77 +2978,271 @@
|
|
3172
2978
|
},
|
3173
2979
|
"description": "The icon html element which has been fetched from the icon provider."
|
3174
2980
|
}
|
3175
|
-
],
|
3176
|
-
"description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
|
2981
|
+
],
|
2982
|
+
"description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
|
2983
|
+
},
|
2984
|
+
{
|
2985
|
+
"kind": "method",
|
2986
|
+
"name": "handleIconLoadedFailure",
|
2987
|
+
"privacy": "private",
|
2988
|
+
"parameters": [
|
2989
|
+
{
|
2990
|
+
"name": "error",
|
2991
|
+
"type": {
|
2992
|
+
"text": "unknown"
|
2993
|
+
}
|
2994
|
+
}
|
2995
|
+
],
|
2996
|
+
"description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
2997
|
+
},
|
2998
|
+
{
|
2999
|
+
"kind": "method",
|
3000
|
+
"name": "updateSize",
|
3001
|
+
"privacy": "private",
|
3002
|
+
"description": "Updates the size by setting the width and height"
|
3003
|
+
},
|
3004
|
+
{
|
3005
|
+
"kind": "field",
|
3006
|
+
"name": "computedIconSize",
|
3007
|
+
"privacy": "private",
|
3008
|
+
"readonly": true
|
3009
|
+
}
|
3010
|
+
],
|
3011
|
+
"attributes": [
|
3012
|
+
{
|
3013
|
+
"name": "name",
|
3014
|
+
"type": {
|
3015
|
+
"text": "IconNames | undefined"
|
3016
|
+
},
|
3017
|
+
"description": "Name of the icon (= filename)",
|
3018
|
+
"fieldName": "name"
|
3019
|
+
},
|
3020
|
+
{
|
3021
|
+
"name": "size",
|
3022
|
+
"type": {
|
3023
|
+
"text": "number | undefined"
|
3024
|
+
},
|
3025
|
+
"description": "Size of the icon (works in combination with length unit)",
|
3026
|
+
"fieldName": "size"
|
3027
|
+
},
|
3028
|
+
{
|
3029
|
+
"name": "length-unit",
|
3030
|
+
"type": {
|
3031
|
+
"text": "string | undefined"
|
3032
|
+
},
|
3033
|
+
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
3034
|
+
"fieldName": "lengthUnit"
|
3035
|
+
},
|
3036
|
+
{
|
3037
|
+
"name": "aria-label",
|
3038
|
+
"type": {
|
3039
|
+
"text": "string | null"
|
3040
|
+
},
|
3041
|
+
"default": "null",
|
3042
|
+
"description": "Aria-label attribute to be set for accessibility",
|
3043
|
+
"fieldName": "ariaLabel"
|
3044
|
+
}
|
3045
|
+
],
|
3046
|
+
"superclass": {
|
3047
|
+
"name": "Component",
|
3048
|
+
"module": "/src/models"
|
3049
|
+
},
|
3050
|
+
"tagName": "mdc-icon",
|
3051
|
+
"jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n */",
|
3052
|
+
"customElement": true
|
3053
|
+
}
|
3054
|
+
],
|
3055
|
+
"exports": [
|
3056
|
+
{
|
3057
|
+
"kind": "js",
|
3058
|
+
"name": "default",
|
3059
|
+
"declaration": {
|
3060
|
+
"name": "Icon",
|
3061
|
+
"module": "components/icon/icon.component.js"
|
3062
|
+
}
|
3063
|
+
}
|
3064
|
+
]
|
3065
|
+
},
|
3066
|
+
{
|
3067
|
+
"kind": "javascript-module",
|
3068
|
+
"path": "components/formfieldwrapper/formfieldwrapper.component.js",
|
3069
|
+
"declarations": [
|
3070
|
+
{
|
3071
|
+
"kind": "class",
|
3072
|
+
"description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
|
3073
|
+
"name": "FormfieldWrapper",
|
3074
|
+
"slots": [
|
3075
|
+
{
|
3076
|
+
"description": "slot to add the label info icon",
|
3077
|
+
"name": "label-info"
|
3078
|
+
}
|
3079
|
+
],
|
3080
|
+
"members": [
|
3081
|
+
{
|
3082
|
+
"kind": "field",
|
3083
|
+
"name": "label",
|
3084
|
+
"type": {
|
3085
|
+
"text": "string | undefined"
|
3086
|
+
},
|
3087
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3088
|
+
"attribute": "label",
|
3089
|
+
"reflects": true
|
3090
|
+
},
|
3091
|
+
{
|
3092
|
+
"kind": "field",
|
3093
|
+
"name": "id",
|
3094
|
+
"default": "`mdc-input-${uuidv4()}`",
|
3095
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3096
|
+
"attribute": "id"
|
3097
|
+
},
|
3098
|
+
{
|
3099
|
+
"kind": "field",
|
3100
|
+
"name": "helpTextType",
|
3101
|
+
"type": {
|
3102
|
+
"text": "ValidationType"
|
3103
|
+
},
|
3104
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3105
|
+
"attribute": "help-text-type",
|
3106
|
+
"reflects": true
|
3107
|
+
},
|
3108
|
+
{
|
3109
|
+
"kind": "field",
|
3110
|
+
"name": "helpText",
|
3111
|
+
"type": {
|
3112
|
+
"text": "string | undefined"
|
3113
|
+
},
|
3114
|
+
"description": "The help text that is displayed below the input field.",
|
3115
|
+
"attribute": "help-text",
|
3116
|
+
"reflects": true
|
3117
|
+
},
|
3118
|
+
{
|
3119
|
+
"kind": "method",
|
3120
|
+
"name": "renderLabelElement",
|
3121
|
+
"privacy": "protected",
|
3122
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
3123
|
+
"return": {
|
3124
|
+
"type": {
|
3125
|
+
"text": ""
|
3126
|
+
}
|
3127
|
+
}
|
3128
|
+
},
|
3129
|
+
{
|
3130
|
+
"kind": "method",
|
3131
|
+
"name": "renderHelpTextIcon",
|
3132
|
+
"privacy": "protected",
|
3133
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
3134
|
+
"return": {
|
3135
|
+
"type": {
|
3136
|
+
"text": ""
|
3137
|
+
}
|
3138
|
+
}
|
3139
|
+
},
|
3140
|
+
{
|
3141
|
+
"kind": "method",
|
3142
|
+
"name": "renderHelpText",
|
3143
|
+
"privacy": "protected",
|
3144
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
3145
|
+
"return": {
|
3146
|
+
"type": {
|
3147
|
+
"text": ""
|
3148
|
+
}
|
3149
|
+
}
|
3177
3150
|
},
|
3178
3151
|
{
|
3179
3152
|
"kind": "method",
|
3180
|
-
"name": "
|
3181
|
-
"privacy": "
|
3182
|
-
"
|
3183
|
-
|
3184
|
-
|
3185
|
-
"
|
3186
|
-
"text": "unknown"
|
3187
|
-
}
|
3153
|
+
"name": "renderLabel",
|
3154
|
+
"privacy": "protected",
|
3155
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
3156
|
+
"return": {
|
3157
|
+
"type": {
|
3158
|
+
"text": ""
|
3188
3159
|
}
|
3189
|
-
|
3190
|
-
"description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
3160
|
+
}
|
3191
3161
|
},
|
3192
3162
|
{
|
3193
3163
|
"kind": "method",
|
3194
|
-
"name": "
|
3195
|
-
"privacy": "
|
3196
|
-
"description": "
|
3164
|
+
"name": "renderHelperText",
|
3165
|
+
"privacy": "protected",
|
3166
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
3167
|
+
"return": {
|
3168
|
+
"type": {
|
3169
|
+
"text": ""
|
3170
|
+
}
|
3171
|
+
}
|
3197
3172
|
},
|
3198
3173
|
{
|
3199
3174
|
"kind": "field",
|
3200
|
-
"name": "
|
3201
|
-
"
|
3202
|
-
|
3175
|
+
"name": "disabled",
|
3176
|
+
"type": {
|
3177
|
+
"text": "boolean"
|
3178
|
+
},
|
3179
|
+
"default": "false",
|
3180
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3181
|
+
"attribute": "disabled",
|
3182
|
+
"reflects": true,
|
3183
|
+
"inheritedFrom": {
|
3184
|
+
"name": "DisabledMixin",
|
3185
|
+
"module": "utils/mixins/DisabledMixin.js"
|
3186
|
+
}
|
3203
3187
|
}
|
3204
3188
|
],
|
3205
3189
|
"attributes": [
|
3206
3190
|
{
|
3207
|
-
"name": "
|
3191
|
+
"name": "label",
|
3208
3192
|
"type": {
|
3209
|
-
"text": "
|
3193
|
+
"text": "string | undefined"
|
3210
3194
|
},
|
3211
|
-
"description": "
|
3212
|
-
"fieldName": "
|
3195
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3196
|
+
"fieldName": "label"
|
3213
3197
|
},
|
3214
3198
|
{
|
3215
|
-
"name": "
|
3199
|
+
"name": "id",
|
3200
|
+
"default": "`mdc-input-${uuidv4()}`",
|
3201
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3202
|
+
"fieldName": "id"
|
3203
|
+
},
|
3204
|
+
{
|
3205
|
+
"name": "help-text-type",
|
3216
3206
|
"type": {
|
3217
|
-
"text": "
|
3207
|
+
"text": "ValidationType"
|
3218
3208
|
},
|
3219
|
-
"description": "
|
3220
|
-
"fieldName": "
|
3209
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3210
|
+
"fieldName": "helpTextType"
|
3221
3211
|
},
|
3222
3212
|
{
|
3223
|
-
"name": "
|
3213
|
+
"name": "help-text",
|
3224
3214
|
"type": {
|
3225
3215
|
"text": "string | undefined"
|
3226
3216
|
},
|
3227
|
-
"description": "
|
3228
|
-
"fieldName": "
|
3217
|
+
"description": "The help text that is displayed below the input field.",
|
3218
|
+
"fieldName": "helpText"
|
3229
3219
|
},
|
3230
3220
|
{
|
3231
|
-
"name": "
|
3221
|
+
"name": "disabled",
|
3232
3222
|
"type": {
|
3233
|
-
"text": "
|
3223
|
+
"text": "boolean"
|
3234
3224
|
},
|
3235
|
-
"default": "
|
3236
|
-
"description": "
|
3237
|
-
"fieldName": "
|
3225
|
+
"default": "false",
|
3226
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3227
|
+
"fieldName": "disabled",
|
3228
|
+
"inheritedFrom": {
|
3229
|
+
"name": "DisabledMixin",
|
3230
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
3231
|
+
}
|
3232
|
+
}
|
3233
|
+
],
|
3234
|
+
"mixins": [
|
3235
|
+
{
|
3236
|
+
"name": "DisabledMixin",
|
3237
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
3238
3238
|
}
|
3239
3239
|
],
|
3240
3240
|
"superclass": {
|
3241
3241
|
"name": "Component",
|
3242
3242
|
"module": "/src/models"
|
3243
3243
|
},
|
3244
|
-
"tagName": "mdc-
|
3245
|
-
"jsDoc": "/**\n *
|
3244
|
+
"tagName": "mdc-formfieldwrapper",
|
3245
|
+
"jsDoc": "/**\n * formfieldwrapper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-formfieldwrapper\n *\n * @slot label-info - slot to add the label info icon\n *\n */",
|
3246
3246
|
"customElement": true
|
3247
3247
|
}
|
3248
3248
|
],
|
@@ -3251,8 +3251,8 @@
|
|
3251
3251
|
"kind": "js",
|
3252
3252
|
"name": "default",
|
3253
3253
|
"declaration": {
|
3254
|
-
"name": "
|
3255
|
-
"module": "components/
|
3254
|
+
"name": "FormfieldWrapper",
|
3255
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3256
3256
|
}
|
3257
3257
|
}
|
3258
3258
|
]
|
@@ -6731,6 +6731,217 @@
|
|
6731
6731
|
}
|
6732
6732
|
]
|
6733
6733
|
},
|
6734
|
+
{
|
6735
|
+
"kind": "javascript-module",
|
6736
|
+
"path": "components/virtualizedlist/virtualizedlist.component.js",
|
6737
|
+
"declarations": [
|
6738
|
+
{
|
6739
|
+
"kind": "class",
|
6740
|
+
"description": "`mdc-virtualizedlist` component for creating custom virtualized lists.\nIMPORTANT: This component does not create it's own list/list items.\nUse the setlistdata callback prop to update client state in order to\nPass list/listitems as a child of this component, which this will virtuailze\nThis implementation handles dynamic lists as well as fixed sized lists.\nPlease refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.",
|
6741
|
+
"name": "VirtualizedList",
|
6742
|
+
"slots": [
|
6743
|
+
{
|
6744
|
+
"description": "Client side List with nested list items.",
|
6745
|
+
"name": ""
|
6746
|
+
}
|
6747
|
+
],
|
6748
|
+
"members": [
|
6749
|
+
{
|
6750
|
+
"kind": "field",
|
6751
|
+
"name": "onscroll",
|
6752
|
+
"type": {
|
6753
|
+
"text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
|
6754
|
+
},
|
6755
|
+
"description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
|
6756
|
+
"default": "null",
|
6757
|
+
"attribute": "onscroll"
|
6758
|
+
},
|
6759
|
+
{
|
6760
|
+
"kind": "field",
|
6761
|
+
"name": "virtualizerprops",
|
6762
|
+
"type": {
|
6763
|
+
"text": "VirtualizerProps"
|
6764
|
+
},
|
6765
|
+
"description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
|
6766
|
+
"attribute": "virtualizerprops"
|
6767
|
+
},
|
6768
|
+
{
|
6769
|
+
"kind": "field",
|
6770
|
+
"name": "setlistdata",
|
6771
|
+
"type": {
|
6772
|
+
"text": "(({ virtualItems, measureElement, listStyle }: SetListDataProps) => void) | null"
|
6773
|
+
},
|
6774
|
+
"description": "Callback that gets envoked when updates to the virtualizer interally occur.\nThis must be implemented in such a way that this function will trigger update to parent.\n\nvirtualItems - Array that will be what the client displays on screen. Use this to render\na List of your choosing with these items nested inside as your ListItems.\nmeasureElement - Ref to pass to each ListItem rendered client side.\nEach ListItem should also be be passed key and a data-index (which can be found on the virtualItem).\nlistStyle - This should be passed as the style attribute to your List.",
|
6775
|
+
"default": "null",
|
6776
|
+
"attribute": "setlistdata"
|
6777
|
+
},
|
6778
|
+
{
|
6779
|
+
"kind": "field",
|
6780
|
+
"name": "scrollElementRef",
|
6781
|
+
"type": {
|
6782
|
+
"text": "Ref<HTMLDivElement>"
|
6783
|
+
},
|
6784
|
+
"privacy": "public"
|
6785
|
+
},
|
6786
|
+
{
|
6787
|
+
"kind": "field",
|
6788
|
+
"name": "virtualizer",
|
6789
|
+
"type": {
|
6790
|
+
"text": "Virtualizer<Element, Element> | null"
|
6791
|
+
},
|
6792
|
+
"privacy": "public",
|
6793
|
+
"default": "null"
|
6794
|
+
},
|
6795
|
+
{
|
6796
|
+
"kind": "field",
|
6797
|
+
"name": "virtualizerController",
|
6798
|
+
"type": {
|
6799
|
+
"text": "null"
|
6800
|
+
},
|
6801
|
+
"default": "null"
|
6802
|
+
}
|
6803
|
+
],
|
6804
|
+
"attributes": [
|
6805
|
+
{
|
6806
|
+
"name": "onscroll",
|
6807
|
+
"type": {
|
6808
|
+
"text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
|
6809
|
+
},
|
6810
|
+
"description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
|
6811
|
+
"default": "null",
|
6812
|
+
"fieldName": "onscroll"
|
6813
|
+
},
|
6814
|
+
{
|
6815
|
+
"name": "virtualizerprops",
|
6816
|
+
"type": {
|
6817
|
+
"text": "VirtualizerProps"
|
6818
|
+
},
|
6819
|
+
"description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
|
6820
|
+
"fieldName": "virtualizerprops"
|
6821
|
+
},
|
6822
|
+
{
|
6823
|
+
"name": "setlistdata",
|
6824
|
+
"type": {
|
6825
|
+
"text": "(({ virtualItems, measureElement, listStyle }: SetListDataProps) => void) | null"
|
6826
|
+
},
|
6827
|
+
"description": "Callback that gets envoked when updates to the virtualizer interally occur.\nThis must be implemented in such a way that this function will trigger update to parent.\n\nvirtualItems - Array that will be what the client displays on screen. Use this to render\na List of your choosing with these items nested inside as your ListItems.\nmeasureElement - Ref to pass to each ListItem rendered client side.\nEach ListItem should also be be passed key and a data-index (which can be found on the virtualItem).\nlistStyle - This should be passed as the style attribute to your List.",
|
6828
|
+
"default": "null",
|
6829
|
+
"fieldName": "setlistdata"
|
6830
|
+
}
|
6831
|
+
],
|
6832
|
+
"superclass": {
|
6833
|
+
"name": "Component",
|
6834
|
+
"module": "/src/models"
|
6835
|
+
},
|
6836
|
+
"tagName": "mdc-virtualizedlist",
|
6837
|
+
"jsDoc": "/**\n * `mdc-virtualizedlist` component for creating custom virtualized lists.\n * IMPORTANT: This component does not create it's own list/list items.\n * Use the setlistdata callback prop to update client state in order to\n * Pass list/listitems as a child of this component, which this will virtuailze\n * This implementation handles dynamic lists as well as fixed sized lists.\n * Please refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.\n *\n * @tagname mdc-virtualizedlist\n *\n * @slot - Client side List with nested list items.\n */",
|
6838
|
+
"customElement": true
|
6839
|
+
}
|
6840
|
+
],
|
6841
|
+
"exports": [
|
6842
|
+
{
|
6843
|
+
"kind": "js",
|
6844
|
+
"name": "default",
|
6845
|
+
"declaration": {
|
6846
|
+
"name": "VirtualizedList",
|
6847
|
+
"module": "components/virtualizedlist/virtualizedlist.component.js"
|
6848
|
+
}
|
6849
|
+
}
|
6850
|
+
]
|
6851
|
+
},
|
6852
|
+
{
|
6853
|
+
"kind": "javascript-module",
|
6854
|
+
"path": "components/virtualizedlist/virtualizedlist.test.component.js",
|
6855
|
+
"declarations": [
|
6856
|
+
{
|
6857
|
+
"kind": "class",
|
6858
|
+
"description": "",
|
6859
|
+
"name": "VirtualizedWrapper",
|
6860
|
+
"members": [
|
6861
|
+
{
|
6862
|
+
"kind": "field",
|
6863
|
+
"name": "onscroll",
|
6864
|
+
"type": {
|
6865
|
+
"text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
|
6866
|
+
},
|
6867
|
+
"default": "null",
|
6868
|
+
"attribute": "onscroll"
|
6869
|
+
},
|
6870
|
+
{
|
6871
|
+
"kind": "field",
|
6872
|
+
"name": "virtualizerprops",
|
6873
|
+
"type": {
|
6874
|
+
"text": "VirtualizerProps"
|
6875
|
+
},
|
6876
|
+
"default": "{ count: 100, estimateSize: () => 100 }",
|
6877
|
+
"attribute": "virtualizerprops"
|
6878
|
+
},
|
6879
|
+
{
|
6880
|
+
"kind": "field",
|
6881
|
+
"name": "list",
|
6882
|
+
"type": {
|
6883
|
+
"text": "TemplateResult<1>"
|
6884
|
+
},
|
6885
|
+
"default": "html``"
|
6886
|
+
},
|
6887
|
+
{
|
6888
|
+
"kind": "field",
|
6889
|
+
"name": "listItemTexts"
|
6890
|
+
},
|
6891
|
+
{
|
6892
|
+
"kind": "method",
|
6893
|
+
"name": "updateListItemTextArray",
|
6894
|
+
"privacy": "private"
|
6895
|
+
},
|
6896
|
+
{
|
6897
|
+
"kind": "method",
|
6898
|
+
"name": "setListData",
|
6899
|
+
"privacy": "private",
|
6900
|
+
"parameters": [
|
6901
|
+
{
|
6902
|
+
"name": "{ virtualItems, measureElement, listStyle }",
|
6903
|
+
"type": {
|
6904
|
+
"text": "SetListDataProps"
|
6905
|
+
}
|
6906
|
+
}
|
6907
|
+
]
|
6908
|
+
}
|
6909
|
+
],
|
6910
|
+
"attributes": [
|
6911
|
+
{
|
6912
|
+
"name": "onscroll",
|
6913
|
+
"type": {
|
6914
|
+
"text": "((this: GlobalEventHandlers, ev: Event) => any) | null"
|
6915
|
+
},
|
6916
|
+
"default": "null",
|
6917
|
+
"fieldName": "onscroll"
|
6918
|
+
},
|
6919
|
+
{
|
6920
|
+
"name": "virtualizerprops",
|
6921
|
+
"type": {
|
6922
|
+
"text": "VirtualizerProps"
|
6923
|
+
},
|
6924
|
+
"default": "{ count: 100, estimateSize: () => 100 }",
|
6925
|
+
"fieldName": "virtualizerprops"
|
6926
|
+
}
|
6927
|
+
],
|
6928
|
+
"superclass": {
|
6929
|
+
"name": "Component",
|
6930
|
+
"module": "/src/models"
|
6931
|
+
}
|
6932
|
+
}
|
6933
|
+
],
|
6934
|
+
"exports": [
|
6935
|
+
{
|
6936
|
+
"kind": "js",
|
6937
|
+
"name": "default",
|
6938
|
+
"declaration": {
|
6939
|
+
"name": "VirtualizedWrapper",
|
6940
|
+
"module": "components/virtualizedlist/virtualizedlist.test.component.js"
|
6941
|
+
}
|
6942
|
+
}
|
6943
|
+
]
|
6944
|
+
},
|
6734
6945
|
{
|
6735
6946
|
"kind": "javascript-module",
|
6736
6947
|
"path": "utils/mixins/AvatarComponentMixin.js",
|