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