@momentum-design/components 0.22.4 → 0.22.6
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 +88 -75
- package/dist/browser/index.js.map +4 -4
- package/dist/components/checkbox/checkbox.component.d.ts +9 -1
- package/dist/components/checkbox/checkbox.component.js +21 -3
- package/dist/components/checkboxgroup/checkboxgroup.component.d.ts +43 -0
- package/dist/components/checkboxgroup/checkboxgroup.component.js +94 -0
- package/dist/components/checkboxgroup/checkboxgroup.constants.d.ts +2 -0
- package/dist/components/checkboxgroup/checkboxgroup.constants.js +3 -0
- package/dist/components/checkboxgroup/checkboxgroup.styles.d.ts +2 -0
- package/dist/components/checkboxgroup/checkboxgroup.styles.js +9 -0
- package/dist/components/checkboxgroup/index.d.ts +8 -0
- package/dist/components/checkboxgroup/index.js +5 -0
- package/dist/components/icon/icon.component.d.ts +9 -2
- package/dist/components/icon/icon.component.js +36 -5
- package/dist/components/icon/icon.utils.d.ts +2 -2
- package/dist/components/icon/icon.utils.js +2 -8
- package/dist/components/iconprovider/iconprovider.component.d.ts +31 -0
- package/dist/components/iconprovider/iconprovider.component.js +20 -1
- package/dist/components/iconprovider/iconprovider.constants.d.ts +1 -0
- package/dist/components/iconprovider/iconprovider.constants.js +1 -0
- package/dist/components/iconprovider/iconprovider.context.d.ts +2 -0
- package/dist/components/iconprovider/iconprovider.context.js +3 -0
- package/dist/custom-elements.json +1012 -846
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/checkboxgroup/index.d.ts +17 -0
- package/dist/react/checkboxgroup/index.js +26 -0
- package/dist/react/iconprovider/index.d.ts +6 -0
- package/dist/react/iconprovider/index.js +6 -0
- package/dist/react/index.d.ts +4 -3
- package/dist/react/index.js +4 -3
- package/package.json +1 -1
@@ -2,6 +2,250 @@
|
|
2
2
|
"schemaVersion": "1.0.0",
|
3
3
|
"readme": "",
|
4
4
|
"modules": [
|
5
|
+
{
|
6
|
+
"kind": "javascript-module",
|
7
|
+
"path": "components/avatar/avatar.component.js",
|
8
|
+
"declarations": [
|
9
|
+
{
|
10
|
+
"kind": "class",
|
11
|
+
"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.",
|
12
|
+
"name": "Avatar",
|
13
|
+
"cssProperties": [
|
14
|
+
{
|
15
|
+
"description": "Allows customization of the default background color.",
|
16
|
+
"name": "--mdc-avatar-default-background-color"
|
17
|
+
},
|
18
|
+
{
|
19
|
+
"description": "Allows customization of the default foreground color.",
|
20
|
+
"name": "--mdc-avatar-default-foreground-color"
|
21
|
+
},
|
22
|
+
{
|
23
|
+
"description": "Allows customization of the loading indicator background color.",
|
24
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
25
|
+
},
|
26
|
+
{
|
27
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
28
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
29
|
+
},
|
30
|
+
{
|
31
|
+
"description": "Allows customization of the loading overlay background color.",
|
32
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
33
|
+
}
|
34
|
+
],
|
35
|
+
"members": [
|
36
|
+
{
|
37
|
+
"kind": "field",
|
38
|
+
"name": "src",
|
39
|
+
"type": {
|
40
|
+
"text": "string | undefined"
|
41
|
+
},
|
42
|
+
"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.",
|
43
|
+
"attribute": "src",
|
44
|
+
"inheritedFrom": {
|
45
|
+
"name": "AvatarComponentMixin",
|
46
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
47
|
+
}
|
48
|
+
},
|
49
|
+
{
|
50
|
+
"kind": "field",
|
51
|
+
"name": "initials",
|
52
|
+
"type": {
|
53
|
+
"text": "string | undefined"
|
54
|
+
},
|
55
|
+
"description": "The initials to be displayed for the avatar.",
|
56
|
+
"attribute": "initials",
|
57
|
+
"inheritedFrom": {
|
58
|
+
"name": "AvatarComponentMixin",
|
59
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
60
|
+
}
|
61
|
+
},
|
62
|
+
{
|
63
|
+
"kind": "field",
|
64
|
+
"name": "presence",
|
65
|
+
"type": {
|
66
|
+
"text": "PresenceType | undefined"
|
67
|
+
},
|
68
|
+
"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`",
|
69
|
+
"attribute": "presence",
|
70
|
+
"inheritedFrom": {
|
71
|
+
"name": "AvatarComponentMixin",
|
72
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
73
|
+
}
|
74
|
+
},
|
75
|
+
{
|
76
|
+
"kind": "field",
|
77
|
+
"name": "size",
|
78
|
+
"type": {
|
79
|
+
"text": "AvatarSize"
|
80
|
+
},
|
81
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
82
|
+
"default": "32",
|
83
|
+
"attribute": "size",
|
84
|
+
"reflects": true,
|
85
|
+
"inheritedFrom": {
|
86
|
+
"name": "AvatarComponentMixin",
|
87
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
88
|
+
}
|
89
|
+
},
|
90
|
+
{
|
91
|
+
"kind": "field",
|
92
|
+
"name": "counter",
|
93
|
+
"type": {
|
94
|
+
"text": "number | undefined"
|
95
|
+
},
|
96
|
+
"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`.",
|
97
|
+
"attribute": "counter",
|
98
|
+
"inheritedFrom": {
|
99
|
+
"name": "AvatarComponentMixin",
|
100
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
101
|
+
}
|
102
|
+
},
|
103
|
+
{
|
104
|
+
"kind": "field",
|
105
|
+
"name": "isTyping",
|
106
|
+
"type": {
|
107
|
+
"text": "boolean"
|
108
|
+
},
|
109
|
+
"default": "false",
|
110
|
+
"description": "Represents the typing indicator when the user is typing.",
|
111
|
+
"attribute": "is-typing",
|
112
|
+
"inheritedFrom": {
|
113
|
+
"name": "AvatarComponentMixin",
|
114
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
115
|
+
}
|
116
|
+
},
|
117
|
+
{
|
118
|
+
"kind": "field",
|
119
|
+
"name": "iconName",
|
120
|
+
"type": {
|
121
|
+
"text": "IconNames | undefined"
|
122
|
+
},
|
123
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
124
|
+
"attribute": "icon-name",
|
125
|
+
"inheritedFrom": {
|
126
|
+
"name": "IconNameMixin",
|
127
|
+
"module": "utils/mixins/IconNameMixin.js"
|
128
|
+
}
|
129
|
+
}
|
130
|
+
],
|
131
|
+
"mixins": [
|
132
|
+
{
|
133
|
+
"name": "AvatarComponentMixin",
|
134
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
135
|
+
},
|
136
|
+
{
|
137
|
+
"name": "IconNameMixin",
|
138
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
139
|
+
}
|
140
|
+
],
|
141
|
+
"superclass": {
|
142
|
+
"name": "Component",
|
143
|
+
"module": "/src/models"
|
144
|
+
},
|
145
|
+
"tagName": "mdc-avatar",
|
146
|
+
"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 */",
|
147
|
+
"customElement": true,
|
148
|
+
"attributes": [
|
149
|
+
{
|
150
|
+
"name": "src",
|
151
|
+
"type": {
|
152
|
+
"text": "string | undefined"
|
153
|
+
},
|
154
|
+
"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.",
|
155
|
+
"fieldName": "src",
|
156
|
+
"inheritedFrom": {
|
157
|
+
"name": "AvatarComponentMixin",
|
158
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
159
|
+
}
|
160
|
+
},
|
161
|
+
{
|
162
|
+
"name": "initials",
|
163
|
+
"type": {
|
164
|
+
"text": "string | undefined"
|
165
|
+
},
|
166
|
+
"description": "The initials to be displayed for the avatar.",
|
167
|
+
"fieldName": "initials",
|
168
|
+
"inheritedFrom": {
|
169
|
+
"name": "AvatarComponentMixin",
|
170
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
171
|
+
}
|
172
|
+
},
|
173
|
+
{
|
174
|
+
"name": "presence",
|
175
|
+
"type": {
|
176
|
+
"text": "PresenceType | undefined"
|
177
|
+
},
|
178
|
+
"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`",
|
179
|
+
"fieldName": "presence",
|
180
|
+
"inheritedFrom": {
|
181
|
+
"name": "AvatarComponentMixin",
|
182
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
183
|
+
}
|
184
|
+
},
|
185
|
+
{
|
186
|
+
"name": "size",
|
187
|
+
"type": {
|
188
|
+
"text": "AvatarSize"
|
189
|
+
},
|
190
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
191
|
+
"default": "32",
|
192
|
+
"fieldName": "size",
|
193
|
+
"inheritedFrom": {
|
194
|
+
"name": "AvatarComponentMixin",
|
195
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
196
|
+
}
|
197
|
+
},
|
198
|
+
{
|
199
|
+
"name": "counter",
|
200
|
+
"type": {
|
201
|
+
"text": "number | undefined"
|
202
|
+
},
|
203
|
+
"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`.",
|
204
|
+
"fieldName": "counter",
|
205
|
+
"inheritedFrom": {
|
206
|
+
"name": "AvatarComponentMixin",
|
207
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
208
|
+
}
|
209
|
+
},
|
210
|
+
{
|
211
|
+
"name": "is-typing",
|
212
|
+
"type": {
|
213
|
+
"text": "boolean"
|
214
|
+
},
|
215
|
+
"default": "false",
|
216
|
+
"description": "Represents the typing indicator when the user is typing.",
|
217
|
+
"fieldName": "isTyping",
|
218
|
+
"inheritedFrom": {
|
219
|
+
"name": "AvatarComponentMixin",
|
220
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
221
|
+
}
|
222
|
+
},
|
223
|
+
{
|
224
|
+
"name": "icon-name",
|
225
|
+
"type": {
|
226
|
+
"text": "IconNames | undefined"
|
227
|
+
},
|
228
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
229
|
+
"fieldName": "iconName",
|
230
|
+
"inheritedFrom": {
|
231
|
+
"name": "IconNameMixin",
|
232
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
233
|
+
}
|
234
|
+
}
|
235
|
+
]
|
236
|
+
}
|
237
|
+
],
|
238
|
+
"exports": [
|
239
|
+
{
|
240
|
+
"kind": "js",
|
241
|
+
"name": "default",
|
242
|
+
"declaration": {
|
243
|
+
"name": "Avatar",
|
244
|
+
"module": "components/avatar/avatar.component.js"
|
245
|
+
}
|
246
|
+
}
|
247
|
+
]
|
248
|
+
},
|
5
249
|
{
|
6
250
|
"kind": "javascript-module",
|
7
251
|
"path": "components/avatarbutton/avatarbutton.component.js",
|
@@ -877,260 +1121,16 @@
|
|
877
1121
|
},
|
878
1122
|
{
|
879
1123
|
"kind": "javascript-module",
|
880
|
-
"path": "components/
|
1124
|
+
"path": "components/bullet/bullet.component.js",
|
881
1125
|
"declarations": [
|
882
1126
|
{
|
883
1127
|
"kind": "class",
|
884
|
-
"description": "
|
885
|
-
"name": "
|
1128
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1129
|
+
"name": "Bullet",
|
886
1130
|
"cssProperties": [
|
887
1131
|
{
|
888
|
-
"description": "
|
889
|
-
"name": "--mdc-
|
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",
|
1024
|
-
"type": {
|
1025
|
-
"text": "string | undefined"
|
1026
|
-
},
|
1027
|
-
"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.",
|
1028
|
-
"fieldName": "src",
|
1029
|
-
"inheritedFrom": {
|
1030
|
-
"name": "AvatarComponentMixin",
|
1031
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1032
|
-
}
|
1033
|
-
},
|
1034
|
-
{
|
1035
|
-
"name": "initials",
|
1036
|
-
"type": {
|
1037
|
-
"text": "string | undefined"
|
1038
|
-
},
|
1039
|
-
"description": "The initials to be displayed for the avatar.",
|
1040
|
-
"fieldName": "initials",
|
1041
|
-
"inheritedFrom": {
|
1042
|
-
"name": "AvatarComponentMixin",
|
1043
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1044
|
-
}
|
1045
|
-
},
|
1046
|
-
{
|
1047
|
-
"name": "presence",
|
1048
|
-
"type": {
|
1049
|
-
"text": "PresenceType | undefined"
|
1050
|
-
},
|
1051
|
-
"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`",
|
1052
|
-
"fieldName": "presence",
|
1053
|
-
"inheritedFrom": {
|
1054
|
-
"name": "AvatarComponentMixin",
|
1055
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1056
|
-
}
|
1057
|
-
},
|
1058
|
-
{
|
1059
|
-
"name": "size",
|
1060
|
-
"type": {
|
1061
|
-
"text": "AvatarSize"
|
1062
|
-
},
|
1063
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1064
|
-
"default": "32",
|
1065
|
-
"fieldName": "size",
|
1066
|
-
"inheritedFrom": {
|
1067
|
-
"name": "AvatarComponentMixin",
|
1068
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1069
|
-
}
|
1070
|
-
},
|
1071
|
-
{
|
1072
|
-
"name": "counter",
|
1073
|
-
"type": {
|
1074
|
-
"text": "number | undefined"
|
1075
|
-
},
|
1076
|
-
"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`.",
|
1077
|
-
"fieldName": "counter",
|
1078
|
-
"inheritedFrom": {
|
1079
|
-
"name": "AvatarComponentMixin",
|
1080
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1081
|
-
}
|
1082
|
-
},
|
1083
|
-
{
|
1084
|
-
"name": "is-typing",
|
1085
|
-
"type": {
|
1086
|
-
"text": "boolean"
|
1087
|
-
},
|
1088
|
-
"default": "false",
|
1089
|
-
"description": "Represents the typing indicator when the user is typing.",
|
1090
|
-
"fieldName": "isTyping",
|
1091
|
-
"inheritedFrom": {
|
1092
|
-
"name": "AvatarComponentMixin",
|
1093
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1094
|
-
}
|
1095
|
-
},
|
1096
|
-
{
|
1097
|
-
"name": "icon-name",
|
1098
|
-
"type": {
|
1099
|
-
"text": "IconNames | undefined"
|
1100
|
-
},
|
1101
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1102
|
-
"fieldName": "iconName",
|
1103
|
-
"inheritedFrom": {
|
1104
|
-
"name": "IconNameMixin",
|
1105
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
1106
|
-
}
|
1107
|
-
}
|
1108
|
-
]
|
1109
|
-
}
|
1110
|
-
],
|
1111
|
-
"exports": [
|
1112
|
-
{
|
1113
|
-
"kind": "js",
|
1114
|
-
"name": "default",
|
1115
|
-
"declaration": {
|
1116
|
-
"name": "Avatar",
|
1117
|
-
"module": "components/avatar/avatar.component.js"
|
1118
|
-
}
|
1119
|
-
}
|
1120
|
-
]
|
1121
|
-
},
|
1122
|
-
{
|
1123
|
-
"kind": "javascript-module",
|
1124
|
-
"path": "components/bullet/bullet.component.js",
|
1125
|
-
"declarations": [
|
1126
|
-
{
|
1127
|
-
"kind": "class",
|
1128
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1129
|
-
"name": "Bullet",
|
1130
|
-
"cssProperties": [
|
1131
|
-
{
|
1132
|
-
"description": "background color of the bullet",
|
1133
|
-
"name": "--mdc-bullet-background-color"
|
1132
|
+
"description": "background color of the bullet",
|
1133
|
+
"name": "--mdc-bullet-background-color"
|
1134
1134
|
},
|
1135
1135
|
{
|
1136
1136
|
"description": "small size value of the bullet",
|
@@ -1192,174 +1192,207 @@
|
|
1192
1192
|
},
|
1193
1193
|
{
|
1194
1194
|
"kind": "javascript-module",
|
1195
|
-
"path": "components/
|
1195
|
+
"path": "components/checkbox/checkbox.component.js",
|
1196
1196
|
"declarations": [
|
1197
1197
|
{
|
1198
1198
|
"kind": "class",
|
1199
|
-
"description": "
|
1200
|
-
"name": "
|
1201
|
-
"
|
1199
|
+
"description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.",
|
1200
|
+
"name": "Checkbox",
|
1201
|
+
"cssProperties": [
|
1202
|
+
{
|
1203
|
+
"description": "Allows customization of the background color on hover.",
|
1204
|
+
"name": "--mdc-checkbox-background-color-hover"
|
1205
|
+
},
|
1206
|
+
{
|
1207
|
+
"description": "Border color in high contrast.",
|
1208
|
+
"name": "--mdc-checkbox-border-color"
|
1209
|
+
},
|
1210
|
+
{
|
1211
|
+
"description": "Background color for a selected checkbox.",
|
1212
|
+
"name": "--mdc-checkbox-checked-background-color"
|
1213
|
+
},
|
1214
|
+
{
|
1215
|
+
"description": "Background color for a selected checkbox when hovered.",
|
1216
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
1217
|
+
},
|
1218
|
+
{
|
1219
|
+
"description": "Background color for a selected checkbox when pressed.",
|
1220
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
1221
|
+
},
|
1222
|
+
{
|
1223
|
+
"description": "Background color for a disabled checkbox.",
|
1224
|
+
"name": "--mdc-checkbox-disabled-background-color"
|
1225
|
+
},
|
1202
1226
|
{
|
1203
|
-
"description": "
|
1204
|
-
"name": ""
|
1205
|
-
}
|
1206
|
-
],
|
1207
|
-
"members": [
|
1227
|
+
"description": "Border color for a disabled checkbox.",
|
1228
|
+
"name": "--mdc-checkbox-disabled-border-color"
|
1229
|
+
},
|
1208
1230
|
{
|
1209
|
-
"
|
1210
|
-
"name": "
|
1211
|
-
"type": {
|
1212
|
-
"text": "string | undefined"
|
1213
|
-
},
|
1214
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1215
|
-
"attribute": "prefix-icon",
|
1216
|
-
"reflects": true
|
1231
|
+
"description": "Background color for a disabled, selected checkbox.",
|
1232
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
1217
1233
|
},
|
1218
1234
|
{
|
1219
|
-
"
|
1220
|
-
"name": "
|
1221
|
-
"type": {
|
1222
|
-
"text": "string | undefined"
|
1223
|
-
},
|
1224
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1225
|
-
"attribute": "postfix-icon",
|
1226
|
-
"reflects": true
|
1235
|
+
"description": "Icon color for a disabled checkbox.",
|
1236
|
+
"name": "--mdc-checkbox-disabled-icon-color"
|
1227
1237
|
},
|
1228
1238
|
{
|
1229
|
-
"
|
1230
|
-
"name": "
|
1231
|
-
"type": {
|
1232
|
-
"text": "ButtonVariant"
|
1233
|
-
},
|
1234
|
-
"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
|
-
"default": "primary",
|
1236
|
-
"attribute": "variant"
|
1239
|
+
"description": "Background color for an unselected checkbox.",
|
1240
|
+
"name": "--mdc-checkbox-icon-background-color"
|
1237
1241
|
},
|
1238
1242
|
{
|
1239
|
-
"
|
1240
|
-
"name": "
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1244
|
-
"
|
1245
|
-
"default": "32",
|
1246
|
-
"attribute": "size",
|
1247
|
-
"reflects": true,
|
1248
|
-
"inheritedFrom": {
|
1249
|
-
"name": "Buttonsimple",
|
1250
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1251
|
-
}
|
1243
|
+
"description": "Default background color for an unselected checkbox.",
|
1244
|
+
"name": "--mdc-checkbox-icon-border-color"
|
1245
|
+
},
|
1246
|
+
{
|
1247
|
+
"description": "Icon color for an unselected checkbox.",
|
1248
|
+
"name": "--mdc-checkbox-icon-color"
|
1252
1249
|
},
|
1250
|
+
{
|
1251
|
+
"description": "Background color for a selected checkbox when pressed.",
|
1252
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
1253
|
+
}
|
1254
|
+
],
|
1255
|
+
"members": [
|
1253
1256
|
{
|
1254
1257
|
"kind": "field",
|
1255
|
-
"name": "
|
1258
|
+
"name": "checked",
|
1256
1259
|
"type": {
|
1257
|
-
"text": "
|
1260
|
+
"text": "boolean"
|
1258
1261
|
},
|
1259
|
-
"
|
1260
|
-
"
|
1261
|
-
"attribute": "
|
1262
|
+
"default": "false",
|
1263
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
1264
|
+
"attribute": "checked",
|
1265
|
+
"reflects": true
|
1262
1266
|
},
|
1263
1267
|
{
|
1264
1268
|
"kind": "field",
|
1265
|
-
"name": "
|
1266
|
-
"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
|
-
"default": "'button'",
|
1268
|
-
"attribute": "role",
|
1269
|
-
"reflects": true,
|
1269
|
+
"name": "indeterminate",
|
1270
1270
|
"type": {
|
1271
|
-
"text": "
|
1271
|
+
"text": "boolean"
|
1272
1272
|
},
|
1273
|
-
"
|
1274
|
-
|
1275
|
-
|
1276
|
-
|
1273
|
+
"default": "false",
|
1274
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
1275
|
+
"attribute": "indeterminate",
|
1276
|
+
"reflects": true
|
1277
1277
|
},
|
1278
1278
|
{
|
1279
1279
|
"kind": "method",
|
1280
|
-
"name": "
|
1280
|
+
"name": "setFormValue",
|
1281
1281
|
"privacy": "private",
|
1282
|
-
"
|
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."
|
1282
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
1292
1283
|
},
|
1293
1284
|
{
|
1294
1285
|
"kind": "method",
|
1295
|
-
"name": "
|
1286
|
+
"name": "toggleState",
|
1296
1287
|
"privacy": "private",
|
1297
|
-
"
|
1298
|
-
{
|
1299
|
-
"
|
1300
|
-
"type": {
|
1301
|
-
"text": "ButtonVariant"
|
1302
|
-
},
|
1303
|
-
"description": "The variant to set."
|
1288
|
+
"return": {
|
1289
|
+
"type": {
|
1290
|
+
"text": "void"
|
1304
1291
|
}
|
1305
|
-
|
1306
|
-
"description": "
|
1292
|
+
},
|
1293
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
1307
1294
|
},
|
1308
1295
|
{
|
1309
1296
|
"kind": "method",
|
1310
|
-
"name": "
|
1311
|
-
"privacy": "
|
1297
|
+
"name": "handleChange",
|
1298
|
+
"privacy": "public",
|
1299
|
+
"return": {
|
1300
|
+
"type": {
|
1301
|
+
"text": "void"
|
1302
|
+
}
|
1303
|
+
},
|
1312
1304
|
"parameters": [
|
1313
1305
|
{
|
1314
|
-
"name": "
|
1306
|
+
"name": "event",
|
1315
1307
|
"type": {
|
1316
|
-
"text": "
|
1317
|
-
}
|
1318
|
-
"description": "The size to set."
|
1308
|
+
"text": "Event"
|
1309
|
+
}
|
1319
1310
|
}
|
1320
1311
|
],
|
1321
|
-
"description": "
|
1312
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
1322
1313
|
},
|
1323
1314
|
{
|
1324
1315
|
"kind": "method",
|
1325
|
-
"name": "
|
1316
|
+
"name": "handleKeyDown",
|
1326
1317
|
"privacy": "private",
|
1318
|
+
"return": {
|
1319
|
+
"type": {
|
1320
|
+
"text": "void"
|
1321
|
+
}
|
1322
|
+
},
|
1327
1323
|
"parameters": [
|
1328
1324
|
{
|
1329
|
-
"name": "
|
1325
|
+
"name": "event",
|
1330
1326
|
"type": {
|
1331
|
-
"text": "
|
1327
|
+
"text": "KeyboardEvent"
|
1332
1328
|
},
|
1333
|
-
"description": "The
|
1329
|
+
"description": "The keyboard event."
|
1334
1330
|
}
|
1335
1331
|
],
|
1336
|
-
"description": "
|
1332
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
1337
1333
|
},
|
1338
1334
|
{
|
1339
|
-
"kind": "
|
1340
|
-
"name": "
|
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
|
-
]
|
1335
|
+
"kind": "field",
|
1336
|
+
"name": "internals"
|
1349
1337
|
},
|
1350
1338
|
{
|
1351
1339
|
"kind": "field",
|
1352
|
-
"name": "
|
1340
|
+
"name": "helpTextType",
|
1353
1341
|
"type": {
|
1354
|
-
"text": "
|
1342
|
+
"text": "ValidationType"
|
1355
1343
|
},
|
1356
|
-
"
|
1357
|
-
"
|
1358
|
-
"attribute": "tabIndex",
|
1344
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
1345
|
+
"attribute": "help-text-type",
|
1359
1346
|
"reflects": true,
|
1347
|
+
"default": "undefined as unknown",
|
1360
1348
|
"inheritedFrom": {
|
1361
|
-
"name": "
|
1362
|
-
"module": "
|
1349
|
+
"name": "FormfieldWrapper",
|
1350
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1351
|
+
}
|
1352
|
+
},
|
1353
|
+
{
|
1354
|
+
"kind": "field",
|
1355
|
+
"name": "name",
|
1356
|
+
"type": {
|
1357
|
+
"text": "string"
|
1358
|
+
},
|
1359
|
+
"default": "''",
|
1360
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
1361
|
+
"attribute": "name",
|
1362
|
+
"reflects": true,
|
1363
|
+
"inheritedFrom": {
|
1364
|
+
"name": "NameMixin",
|
1365
|
+
"module": "utils/mixins/NameMixin.js"
|
1366
|
+
}
|
1367
|
+
},
|
1368
|
+
{
|
1369
|
+
"kind": "field",
|
1370
|
+
"name": "value",
|
1371
|
+
"type": {
|
1372
|
+
"text": "string"
|
1373
|
+
},
|
1374
|
+
"default": "''",
|
1375
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
1376
|
+
"attribute": "value",
|
1377
|
+
"reflects": true,
|
1378
|
+
"inheritedFrom": {
|
1379
|
+
"name": "ValueMixin",
|
1380
|
+
"module": "utils/mixins/ValueMixin.js"
|
1381
|
+
}
|
1382
|
+
},
|
1383
|
+
{
|
1384
|
+
"kind": "field",
|
1385
|
+
"name": "dataAriaLabel",
|
1386
|
+
"type": {
|
1387
|
+
"text": "string | null"
|
1388
|
+
},
|
1389
|
+
"default": "null",
|
1390
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
1391
|
+
"attribute": "data-aria-label",
|
1392
|
+
"reflects": true,
|
1393
|
+
"inheritedFrom": {
|
1394
|
+
"name": "DataAriaLabelMixin",
|
1395
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
1363
1396
|
}
|
1364
1397
|
},
|
1365
1398
|
{
|
@@ -1379,255 +1412,182 @@
|
|
1379
1412
|
},
|
1380
1413
|
{
|
1381
1414
|
"kind": "field",
|
1382
|
-
"name": "
|
1415
|
+
"name": "label",
|
1383
1416
|
"type": {
|
1384
|
-
"text": "
|
1417
|
+
"text": "string | undefined"
|
1385
1418
|
},
|
1386
|
-
"
|
1387
|
-
"
|
1388
|
-
"attribute": "active",
|
1419
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
1420
|
+
"attribute": "label",
|
1389
1421
|
"reflects": true,
|
1390
1422
|
"inheritedFrom": {
|
1391
|
-
"name": "
|
1392
|
-
"module": "components/
|
1423
|
+
"name": "FormfieldWrapper",
|
1424
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1393
1425
|
}
|
1394
1426
|
},
|
1395
1427
|
{
|
1396
1428
|
"kind": "field",
|
1397
|
-
"name": "
|
1398
|
-
"
|
1399
|
-
|
1400
|
-
|
1401
|
-
"default": "false",
|
1402
|
-
"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.",
|
1403
|
-
"attribute": "soft-disabled",
|
1429
|
+
"name": "id",
|
1430
|
+
"default": "`mdc-input-${uuidv4()}`",
|
1431
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
1432
|
+
"attribute": "id",
|
1404
1433
|
"inheritedFrom": {
|
1405
|
-
"name": "
|
1406
|
-
"module": "components/
|
1434
|
+
"name": "FormfieldWrapper",
|
1435
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1407
1436
|
}
|
1408
1437
|
},
|
1409
1438
|
{
|
1410
1439
|
"kind": "field",
|
1411
|
-
"name": "
|
1440
|
+
"name": "helpText",
|
1412
1441
|
"type": {
|
1413
|
-
"text": "
|
1442
|
+
"text": "string | undefined"
|
1414
1443
|
},
|
1415
|
-
"description": "
|
1416
|
-
"
|
1417
|
-
"attribute": "type",
|
1444
|
+
"description": "The help text that is displayed below the input field.",
|
1445
|
+
"attribute": "help-text",
|
1418
1446
|
"reflects": true,
|
1419
1447
|
"inheritedFrom": {
|
1420
|
-
"name": "
|
1421
|
-
"module": "components/
|
1448
|
+
"name": "FormfieldWrapper",
|
1449
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1422
1450
|
}
|
1423
1451
|
},
|
1424
1452
|
{
|
1425
1453
|
"kind": "method",
|
1426
|
-
"name": "
|
1454
|
+
"name": "renderLabelElement",
|
1427
1455
|
"privacy": "protected",
|
1456
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
1457
|
+
"return": {
|
1458
|
+
"type": {
|
1459
|
+
"text": ""
|
1460
|
+
}
|
1461
|
+
},
|
1428
1462
|
"inheritedFrom": {
|
1429
|
-
"name": "
|
1430
|
-
"module": "components/
|
1463
|
+
"name": "FormfieldWrapper",
|
1464
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1431
1465
|
}
|
1432
1466
|
},
|
1433
1467
|
{
|
1434
1468
|
"kind": "method",
|
1435
|
-
"name": "
|
1469
|
+
"name": "renderHelpTextIcon",
|
1436
1470
|
"privacy": "protected",
|
1437
|
-
"
|
1438
|
-
|
1439
|
-
|
1440
|
-
"
|
1441
|
-
"text": "HTMLElement"
|
1442
|
-
},
|
1443
|
-
"description": "The button element"
|
1444
|
-
},
|
1445
|
-
{
|
1446
|
-
"name": "active",
|
1447
|
-
"type": {
|
1448
|
-
"text": "boolean"
|
1449
|
-
},
|
1450
|
-
"description": "The active state of the element"
|
1471
|
+
"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.",
|
1472
|
+
"return": {
|
1473
|
+
"type": {
|
1474
|
+
"text": ""
|
1451
1475
|
}
|
1452
|
-
|
1453
|
-
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
1476
|
+
},
|
1454
1477
|
"inheritedFrom": {
|
1455
|
-
"name": "
|
1456
|
-
"module": "components/
|
1478
|
+
"name": "FormfieldWrapper",
|
1479
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1457
1480
|
}
|
1458
1481
|
},
|
1459
1482
|
{
|
1460
1483
|
"kind": "method",
|
1461
|
-
"name": "
|
1462
|
-
"privacy": "
|
1463
|
-
"
|
1464
|
-
|
1465
|
-
|
1466
|
-
"
|
1467
|
-
"text": "HTMLElement"
|
1468
|
-
},
|
1469
|
-
"description": "The button element."
|
1470
|
-
},
|
1471
|
-
{
|
1472
|
-
"name": "softDisabled",
|
1473
|
-
"type": {
|
1474
|
-
"text": "boolean"
|
1475
|
-
},
|
1476
|
-
"description": "The soft-disabled state."
|
1484
|
+
"name": "renderHelpText",
|
1485
|
+
"privacy": "protected",
|
1486
|
+
"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.",
|
1487
|
+
"return": {
|
1488
|
+
"type": {
|
1489
|
+
"text": ""
|
1477
1490
|
}
|
1478
|
-
|
1479
|
-
"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.",
|
1491
|
+
},
|
1480
1492
|
"inheritedFrom": {
|
1481
|
-
"name": "
|
1482
|
-
"module": "components/
|
1493
|
+
"name": "FormfieldWrapper",
|
1494
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1483
1495
|
}
|
1484
1496
|
},
|
1485
1497
|
{
|
1486
1498
|
"kind": "method",
|
1487
|
-
"name": "
|
1488
|
-
"privacy": "
|
1489
|
-
"
|
1490
|
-
|
1491
|
-
|
1492
|
-
"
|
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."
|
1499
|
+
"name": "renderLabel",
|
1500
|
+
"privacy": "protected",
|
1501
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
1502
|
+
"return": {
|
1503
|
+
"type": {
|
1504
|
+
"text": ""
|
1503
1505
|
}
|
1504
|
-
|
1505
|
-
"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.",
|
1506
|
-
"inheritedFrom": {
|
1507
|
-
"name": "Buttonsimple",
|
1508
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1509
|
-
}
|
1510
|
-
},
|
1511
|
-
{
|
1512
|
-
"kind": "method",
|
1513
|
-
"name": "triggerClickEvent",
|
1514
|
-
"privacy": "private",
|
1506
|
+
},
|
1515
1507
|
"inheritedFrom": {
|
1516
|
-
"name": "
|
1517
|
-
"module": "components/
|
1508
|
+
"name": "FormfieldWrapper",
|
1509
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1518
1510
|
}
|
1519
1511
|
},
|
1520
1512
|
{
|
1521
1513
|
"kind": "method",
|
1522
|
-
"name": "
|
1523
|
-
"privacy": "
|
1524
|
-
"
|
1525
|
-
|
1526
|
-
|
1527
|
-
"
|
1528
|
-
"text": "KeyboardEvent"
|
1529
|
-
},
|
1530
|
-
"description": "The keyboard event."
|
1514
|
+
"name": "renderHelperText",
|
1515
|
+
"privacy": "protected",
|
1516
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
1517
|
+
"return": {
|
1518
|
+
"type": {
|
1519
|
+
"text": ""
|
1531
1520
|
}
|
1532
|
-
|
1533
|
-
"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.",
|
1521
|
+
},
|
1534
1522
|
"inheritedFrom": {
|
1535
|
-
"name": "
|
1536
|
-
"module": "components/
|
1523
|
+
"name": "FormfieldWrapper",
|
1524
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
1537
1525
|
}
|
1538
|
-
}
|
1526
|
+
}
|
1527
|
+
],
|
1528
|
+
"events": [
|
1539
1529
|
{
|
1540
|
-
"
|
1541
|
-
|
1542
|
-
"privacy": "private",
|
1543
|
-
"parameters": [
|
1544
|
-
{
|
1545
|
-
"name": "event",
|
1546
|
-
"type": {
|
1547
|
-
"text": "KeyboardEvent"
|
1548
|
-
},
|
1549
|
-
"description": "The keyboard event."
|
1550
|
-
}
|
1551
|
-
],
|
1552
|
-
"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.",
|
1553
|
-
"inheritedFrom": {
|
1554
|
-
"name": "Buttonsimple",
|
1555
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1530
|
+
"type": {
|
1531
|
+
"text": "EventConstructor"
|
1556
1532
|
}
|
1557
1533
|
}
|
1558
1534
|
],
|
1559
1535
|
"attributes": [
|
1560
1536
|
{
|
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",
|
1537
|
+
"name": "checked",
|
1570
1538
|
"type": {
|
1571
|
-
"text": "
|
1539
|
+
"text": "boolean"
|
1572
1540
|
},
|
1573
|
-
"
|
1574
|
-
"
|
1541
|
+
"default": "false",
|
1542
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
1543
|
+
"fieldName": "checked"
|
1575
1544
|
},
|
1576
1545
|
{
|
1577
|
-
"name": "
|
1546
|
+
"name": "indeterminate",
|
1578
1547
|
"type": {
|
1579
|
-
"text": "
|
1548
|
+
"text": "boolean"
|
1580
1549
|
},
|
1581
|
-
"
|
1582
|
-
"
|
1583
|
-
"fieldName": "
|
1550
|
+
"default": "false",
|
1551
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
1552
|
+
"fieldName": "indeterminate"
|
1584
1553
|
},
|
1585
1554
|
{
|
1586
|
-
"name": "
|
1555
|
+
"name": "name",
|
1587
1556
|
"type": {
|
1588
|
-
"text": "
|
1557
|
+
"text": "string"
|
1589
1558
|
},
|
1590
|
-
"
|
1591
|
-
"
|
1592
|
-
"fieldName": "
|
1559
|
+
"default": "''",
|
1560
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
1561
|
+
"fieldName": "name",
|
1593
1562
|
"inheritedFrom": {
|
1594
|
-
"name": "
|
1595
|
-
"module": "src/
|
1563
|
+
"name": "NameMixin",
|
1564
|
+
"module": "src/utils/mixins/NameMixin.ts"
|
1596
1565
|
}
|
1597
1566
|
},
|
1598
1567
|
{
|
1599
|
-
"name": "
|
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",
|
1568
|
+
"name": "value",
|
1612
1569
|
"type": {
|
1613
1570
|
"text": "string"
|
1614
1571
|
},
|
1572
|
+
"default": "''",
|
1573
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
1574
|
+
"fieldName": "value",
|
1615
1575
|
"inheritedFrom": {
|
1616
|
-
"name": "
|
1617
|
-
"module": "src/
|
1576
|
+
"name": "ValueMixin",
|
1577
|
+
"module": "src/utils/mixins/ValueMixin.ts"
|
1618
1578
|
}
|
1619
1579
|
},
|
1620
1580
|
{
|
1621
|
-
"name": "
|
1581
|
+
"name": "data-aria-label",
|
1622
1582
|
"type": {
|
1623
|
-
"text": "
|
1583
|
+
"text": "string | null"
|
1624
1584
|
},
|
1625
|
-
"default": "
|
1626
|
-
"description": "
|
1627
|
-
"fieldName": "
|
1585
|
+
"default": "null",
|
1586
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
1587
|
+
"fieldName": "dataAriaLabel",
|
1628
1588
|
"inheritedFrom": {
|
1629
|
-
"name": "
|
1630
|
-
"module": "src/utils/mixins/
|
1589
|
+
"name": "DataAriaLabelMixin",
|
1590
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
1631
1591
|
}
|
1632
1592
|
},
|
1633
1593
|
{
|
@@ -1644,52 +1604,83 @@
|
|
1644
1604
|
}
|
1645
1605
|
},
|
1646
1606
|
{
|
1647
|
-
"name": "
|
1607
|
+
"name": "label",
|
1648
1608
|
"type": {
|
1649
|
-
"text": "
|
1609
|
+
"text": "string | undefined"
|
1650
1610
|
},
|
1651
|
-
"
|
1652
|
-
"
|
1653
|
-
"fieldName": "active",
|
1611
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
1612
|
+
"fieldName": "label",
|
1654
1613
|
"inheritedFrom": {
|
1655
|
-
"name": "
|
1656
|
-
"module": "src/components/
|
1614
|
+
"name": "FormfieldWrapper",
|
1615
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1657
1616
|
}
|
1658
1617
|
},
|
1659
1618
|
{
|
1660
|
-
"name": "
|
1619
|
+
"name": "id",
|
1620
|
+
"default": "`mdc-input-${uuidv4()}`",
|
1621
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
1622
|
+
"fieldName": "id",
|
1623
|
+
"inheritedFrom": {
|
1624
|
+
"name": "FormfieldWrapper",
|
1625
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1626
|
+
}
|
1627
|
+
},
|
1628
|
+
{
|
1629
|
+
"name": "help-text-type",
|
1661
1630
|
"type": {
|
1662
|
-
"text": "
|
1631
|
+
"text": "ValidationType"
|
1663
1632
|
},
|
1664
|
-
"
|
1665
|
-
"
|
1666
|
-
"fieldName": "softDisabled",
|
1633
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
1634
|
+
"fieldName": "helpTextType",
|
1667
1635
|
"inheritedFrom": {
|
1668
|
-
"name": "
|
1669
|
-
"module": "src/components/
|
1636
|
+
"name": "FormfieldWrapper",
|
1637
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1670
1638
|
}
|
1671
1639
|
},
|
1672
1640
|
{
|
1673
|
-
"name": "
|
1641
|
+
"name": "help-text",
|
1674
1642
|
"type": {
|
1675
|
-
"text": "
|
1643
|
+
"text": "string | undefined"
|
1676
1644
|
},
|
1677
|
-
"description": "
|
1678
|
-
"
|
1679
|
-
"fieldName": "type",
|
1645
|
+
"description": "The help text that is displayed below the input field.",
|
1646
|
+
"fieldName": "helpText",
|
1680
1647
|
"inheritedFrom": {
|
1681
|
-
"name": "
|
1682
|
-
"module": "src/components/
|
1648
|
+
"name": "FormfieldWrapper",
|
1649
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1683
1650
|
}
|
1684
1651
|
}
|
1685
1652
|
],
|
1653
|
+
"mixins": [
|
1654
|
+
{
|
1655
|
+
"name": "NameMixin",
|
1656
|
+
"module": "/src/utils/mixins/NameMixin"
|
1657
|
+
},
|
1658
|
+
{
|
1659
|
+
"name": "ValueMixin",
|
1660
|
+
"module": "/src/utils/mixins/ValueMixin"
|
1661
|
+
},
|
1662
|
+
{
|
1663
|
+
"name": "DataAriaLabelMixin",
|
1664
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
1665
|
+
}
|
1666
|
+
],
|
1686
1667
|
"superclass": {
|
1687
|
-
"name": "
|
1688
|
-
"module": "/src/components/
|
1668
|
+
"name": "FormfieldWrapper",
|
1669
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
1689
1670
|
},
|
1690
|
-
"tagName": "mdc-
|
1691
|
-
"jsDoc": "/**\n *
|
1692
|
-
"customElement": true
|
1671
|
+
"tagName": "mdc-checkbox",
|
1672
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-checkbox\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-checkbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-checkbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-color - Icon color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n */",
|
1673
|
+
"customElement": true,
|
1674
|
+
"slots": [
|
1675
|
+
{
|
1676
|
+
"description": "slot to add the label info icon",
|
1677
|
+
"name": "label-info",
|
1678
|
+
"inheritedFrom": {
|
1679
|
+
"name": "FormfieldWrapper",
|
1680
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
1681
|
+
}
|
1682
|
+
}
|
1683
|
+
]
|
1693
1684
|
}
|
1694
1685
|
],
|
1695
1686
|
"exports": [
|
@@ -1697,8 +1688,8 @@
|
|
1697
1688
|
"kind": "js",
|
1698
1689
|
"name": "default",
|
1699
1690
|
"declaration": {
|
1700
|
-
"name": "
|
1701
|
-
"module": "components/
|
1691
|
+
"name": "Checkbox",
|
1692
|
+
"module": "components/checkbox/checkbox.component.js"
|
1702
1693
|
}
|
1703
1694
|
}
|
1704
1695
|
]
|
@@ -2002,382 +1993,442 @@
|
|
2002
1993
|
},
|
2003
1994
|
{
|
2004
1995
|
"kind": "javascript-module",
|
2005
|
-
"path": "components/
|
1996
|
+
"path": "components/button/button.component.js",
|
2006
1997
|
"declarations": [
|
2007
1998
|
{
|
2008
1999
|
"kind": "class",
|
2009
|
-
"description": "
|
2010
|
-
"name": "
|
2011
|
-
"
|
2012
|
-
{
|
2013
|
-
"description": "Allows customization of the background color on hover.",
|
2014
|
-
"name": "--mdc-checkbox-background-color-hover"
|
2015
|
-
},
|
2016
|
-
{
|
2017
|
-
"description": "Border color in high contrast.",
|
2018
|
-
"name": "--mdc-checkbox-border-color"
|
2019
|
-
},
|
2020
|
-
{
|
2021
|
-
"description": "Background color for a selected checkbox.",
|
2022
|
-
"name": "--mdc-checkbox-checked-background-color"
|
2023
|
-
},
|
2024
|
-
{
|
2025
|
-
"description": "Background color for a selected checkbox when hovered.",
|
2026
|
-
"name": "--mdc-checkbox-checked-background-color-hover"
|
2027
|
-
},
|
2028
|
-
{
|
2029
|
-
"description": "Background color for a selected checkbox when pressed.",
|
2030
|
-
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
2031
|
-
},
|
2032
|
-
{
|
2033
|
-
"description": "Background color for a disabled checkbox.",
|
2034
|
-
"name": "--mdc-checkbox-disabled-background-color"
|
2035
|
-
},
|
2036
|
-
{
|
2037
|
-
"description": "Border color for a disabled checkbox.",
|
2038
|
-
"name": "--mdc-checkbox-disabled-border-color"
|
2039
|
-
},
|
2000
|
+
"description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton 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\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton 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\nButton 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.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
|
2001
|
+
"name": "Button",
|
2002
|
+
"slots": [
|
2040
2003
|
{
|
2041
|
-
"description": "
|
2042
|
-
"name": "
|
2043
|
-
}
|
2004
|
+
"description": "Text label of the button.",
|
2005
|
+
"name": ""
|
2006
|
+
}
|
2007
|
+
],
|
2008
|
+
"members": [
|
2044
2009
|
{
|
2045
|
-
"
|
2046
|
-
"name": "
|
2010
|
+
"kind": "field",
|
2011
|
+
"name": "prefixIcon",
|
2012
|
+
"type": {
|
2013
|
+
"text": "string | undefined"
|
2014
|
+
},
|
2015
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2016
|
+
"attribute": "prefix-icon",
|
2017
|
+
"reflects": true
|
2047
2018
|
},
|
2048
2019
|
{
|
2049
|
-
"
|
2050
|
-
"name": "
|
2020
|
+
"kind": "field",
|
2021
|
+
"name": "postfixIcon",
|
2022
|
+
"type": {
|
2023
|
+
"text": "string | undefined"
|
2024
|
+
},
|
2025
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2026
|
+
"attribute": "postfix-icon",
|
2027
|
+
"reflects": true
|
2051
2028
|
},
|
2052
2029
|
{
|
2053
|
-
"
|
2054
|
-
"name": "
|
2030
|
+
"kind": "field",
|
2031
|
+
"name": "variant",
|
2032
|
+
"type": {
|
2033
|
+
"text": "ButtonVariant"
|
2034
|
+
},
|
2035
|
+
"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.",
|
2036
|
+
"default": "primary",
|
2037
|
+
"attribute": "variant"
|
2055
2038
|
},
|
2056
2039
|
{
|
2057
|
-
"
|
2058
|
-
"name": "
|
2040
|
+
"kind": "field",
|
2041
|
+
"name": "size",
|
2042
|
+
"type": {
|
2043
|
+
"text": "ButtonSize"
|
2044
|
+
},
|
2045
|
+
"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.",
|
2046
|
+
"default": "32",
|
2047
|
+
"attribute": "size",
|
2048
|
+
"reflects": true,
|
2049
|
+
"inheritedFrom": {
|
2050
|
+
"name": "Buttonsimple",
|
2051
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2052
|
+
}
|
2059
2053
|
},
|
2060
|
-
{
|
2061
|
-
"description": "Background color for a selected checkbox when pressed.",
|
2062
|
-
"name": "--mdc-checkbox-pressed-icon-color"
|
2063
|
-
}
|
2064
|
-
],
|
2065
|
-
"members": [
|
2066
2054
|
{
|
2067
2055
|
"kind": "field",
|
2068
|
-
"name": "
|
2056
|
+
"name": "color",
|
2069
2057
|
"type": {
|
2070
|
-
"text": "
|
2058
|
+
"text": "ButtonColor"
|
2071
2059
|
},
|
2072
|
-
"
|
2073
|
-
"
|
2074
|
-
"attribute": "
|
2075
|
-
"reflects": true
|
2060
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2061
|
+
"default": "default",
|
2062
|
+
"attribute": "color"
|
2076
2063
|
},
|
2077
2064
|
{
|
2078
2065
|
"kind": "field",
|
2079
|
-
"name": "
|
2066
|
+
"name": "role",
|
2067
|
+
"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.",
|
2068
|
+
"default": "'button'",
|
2069
|
+
"attribute": "role",
|
2070
|
+
"reflects": true,
|
2080
2071
|
"type": {
|
2081
|
-
"text": "
|
2072
|
+
"text": "string"
|
2082
2073
|
},
|
2083
|
-
"
|
2084
|
-
|
2085
|
-
|
2086
|
-
|
2074
|
+
"inheritedFrom": {
|
2075
|
+
"name": "Buttonsimple",
|
2076
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2077
|
+
}
|
2087
2078
|
},
|
2088
2079
|
{
|
2089
2080
|
"kind": "method",
|
2090
|
-
"name": "
|
2081
|
+
"name": "modifyIconName",
|
2091
2082
|
"privacy": "private",
|
2092
|
-
"
|
2083
|
+
"parameters": [
|
2084
|
+
{
|
2085
|
+
"name": "active",
|
2086
|
+
"type": {
|
2087
|
+
"text": "boolean"
|
2088
|
+
},
|
2089
|
+
"description": "The active state."
|
2090
|
+
}
|
2091
|
+
],
|
2092
|
+
"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."
|
2093
2093
|
},
|
2094
2094
|
{
|
2095
2095
|
"kind": "method",
|
2096
|
-
"name": "
|
2096
|
+
"name": "setVariant",
|
2097
2097
|
"privacy": "private",
|
2098
|
-
"
|
2099
|
-
|
2100
|
-
"
|
2098
|
+
"parameters": [
|
2099
|
+
{
|
2100
|
+
"name": "variant",
|
2101
|
+
"type": {
|
2102
|
+
"text": "ButtonVariant"
|
2103
|
+
},
|
2104
|
+
"description": "The variant to set."
|
2101
2105
|
}
|
2102
|
-
|
2103
|
-
"description": "
|
2106
|
+
],
|
2107
|
+
"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."
|
2104
2108
|
},
|
2105
2109
|
{
|
2106
2110
|
"kind": "method",
|
2107
|
-
"name": "
|
2108
|
-
"privacy": "
|
2109
|
-
"
|
2110
|
-
|
2111
|
-
"
|
2111
|
+
"name": "setSize",
|
2112
|
+
"privacy": "private",
|
2113
|
+
"parameters": [
|
2114
|
+
{
|
2115
|
+
"name": "size",
|
2116
|
+
"type": {
|
2117
|
+
"text": "PillButtonSize | IconButtonSize"
|
2118
|
+
},
|
2119
|
+
"description": "The size to set."
|
2112
2120
|
}
|
2113
|
-
|
2121
|
+
],
|
2122
|
+
"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."
|
2123
|
+
},
|
2124
|
+
{
|
2125
|
+
"kind": "method",
|
2126
|
+
"name": "setColor",
|
2127
|
+
"privacy": "private",
|
2114
2128
|
"parameters": [
|
2115
2129
|
{
|
2116
|
-
"name": "
|
2130
|
+
"name": "color",
|
2117
2131
|
"type": {
|
2118
|
-
"text": "
|
2119
|
-
}
|
2132
|
+
"text": "ButtonColor"
|
2133
|
+
},
|
2134
|
+
"description": "The color to set."
|
2135
|
+
}
|
2136
|
+
],
|
2137
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
2138
|
+
},
|
2139
|
+
{
|
2140
|
+
"kind": "method",
|
2141
|
+
"name": "inferButtonType",
|
2142
|
+
"privacy": "private",
|
2143
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2144
|
+
"parameters": [
|
2145
|
+
{
|
2146
|
+
"description": "default slot of button",
|
2147
|
+
"name": "slot"
|
2120
2148
|
}
|
2121
|
-
]
|
2122
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new event."
|
2123
|
-
},
|
2124
|
-
{
|
2125
|
-
"kind": "field",
|
2126
|
-
"name": "internals"
|
2127
|
-
},
|
2128
|
-
{
|
2129
|
-
"kind": "field",
|
2130
|
-
"name": "helpTextType",
|
2131
|
-
"type": {
|
2132
|
-
"text": "ValidationType"
|
2133
|
-
},
|
2134
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2135
|
-
"attribute": "help-text-type",
|
2136
|
-
"reflects": true,
|
2137
|
-
"default": "undefined as unknown",
|
2138
|
-
"inheritedFrom": {
|
2139
|
-
"name": "FormfieldWrapper",
|
2140
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2141
|
-
}
|
2149
|
+
]
|
2142
2150
|
},
|
2143
2151
|
{
|
2144
2152
|
"kind": "field",
|
2145
|
-
"name": "
|
2153
|
+
"name": "tabIndex",
|
2146
2154
|
"type": {
|
2147
|
-
"text": "
|
2155
|
+
"text": "number"
|
2148
2156
|
},
|
2149
|
-
"default": "
|
2150
|
-
"description": "
|
2151
|
-
"attribute": "
|
2157
|
+
"default": "0",
|
2158
|
+
"description": "This property specifies the tab order of the element.",
|
2159
|
+
"attribute": "tabIndex",
|
2152
2160
|
"reflects": true,
|
2153
2161
|
"inheritedFrom": {
|
2154
|
-
"name": "
|
2155
|
-
"module": "
|
2162
|
+
"name": "Buttonsimple",
|
2163
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2156
2164
|
}
|
2157
2165
|
},
|
2158
2166
|
{
|
2159
2167
|
"kind": "field",
|
2160
|
-
"name": "
|
2168
|
+
"name": "disabled",
|
2161
2169
|
"type": {
|
2162
|
-
"text": "
|
2170
|
+
"text": "boolean"
|
2163
2171
|
},
|
2164
|
-
"default": "
|
2165
|
-
"description": "Indicates the
|
2166
|
-
"attribute": "
|
2172
|
+
"default": "false",
|
2173
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2174
|
+
"attribute": "disabled",
|
2167
2175
|
"reflects": true,
|
2168
2176
|
"inheritedFrom": {
|
2169
|
-
"name": "
|
2170
|
-
"module": "
|
2177
|
+
"name": "Buttonsimple",
|
2178
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2171
2179
|
}
|
2172
2180
|
},
|
2173
2181
|
{
|
2174
2182
|
"kind": "field",
|
2175
|
-
"name": "
|
2183
|
+
"name": "active",
|
2176
2184
|
"type": {
|
2177
|
-
"text": "
|
2185
|
+
"text": "boolean"
|
2178
2186
|
},
|
2179
|
-
"default": "
|
2180
|
-
"description": "
|
2181
|
-
"attribute": "
|
2187
|
+
"default": "false",
|
2188
|
+
"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.",
|
2189
|
+
"attribute": "active",
|
2182
2190
|
"reflects": true,
|
2183
2191
|
"inheritedFrom": {
|
2184
|
-
"name": "
|
2185
|
-
"module": "
|
2192
|
+
"name": "Buttonsimple",
|
2193
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2186
2194
|
}
|
2187
2195
|
},
|
2188
2196
|
{
|
2189
2197
|
"kind": "field",
|
2190
|
-
"name": "
|
2198
|
+
"name": "softDisabled",
|
2191
2199
|
"type": {
|
2192
2200
|
"text": "boolean"
|
2193
2201
|
},
|
2194
2202
|
"default": "false",
|
2195
|
-
"description": "Indicates whether the
|
2196
|
-
"attribute": "disabled",
|
2197
|
-
"reflects": true,
|
2203
|
+
"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.",
|
2204
|
+
"attribute": "soft-disabled",
|
2198
2205
|
"inheritedFrom": {
|
2199
|
-
"name": "
|
2200
|
-
"module": "
|
2206
|
+
"name": "Buttonsimple",
|
2207
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2201
2208
|
}
|
2202
2209
|
},
|
2203
2210
|
{
|
2204
2211
|
"kind": "field",
|
2205
|
-
"name": "
|
2212
|
+
"name": "type",
|
2206
2213
|
"type": {
|
2207
|
-
"text": "
|
2214
|
+
"text": "ButtonType"
|
2208
2215
|
},
|
2209
|
-
"description": "
|
2210
|
-
"
|
2216
|
+
"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.",
|
2217
|
+
"default": "button",
|
2218
|
+
"attribute": "type",
|
2211
2219
|
"reflects": true,
|
2212
2220
|
"inheritedFrom": {
|
2213
|
-
"name": "
|
2214
|
-
"module": "components/
|
2221
|
+
"name": "Buttonsimple",
|
2222
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2215
2223
|
}
|
2216
2224
|
},
|
2217
2225
|
{
|
2218
|
-
"kind": "
|
2219
|
-
"name": "
|
2220
|
-
"
|
2221
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2222
|
-
"attribute": "id",
|
2226
|
+
"kind": "method",
|
2227
|
+
"name": "executeAction",
|
2228
|
+
"privacy": "protected",
|
2223
2229
|
"inheritedFrom": {
|
2224
|
-
"name": "
|
2225
|
-
"module": "components/
|
2230
|
+
"name": "Buttonsimple",
|
2231
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2226
2232
|
}
|
2227
2233
|
},
|
2228
2234
|
{
|
2229
|
-
"kind": "
|
2230
|
-
"name": "
|
2231
|
-
"
|
2232
|
-
|
2233
|
-
|
2234
|
-
|
2235
|
-
|
2236
|
-
|
2235
|
+
"kind": "method",
|
2236
|
+
"name": "setActive",
|
2237
|
+
"privacy": "protected",
|
2238
|
+
"parameters": [
|
2239
|
+
{
|
2240
|
+
"name": "element",
|
2241
|
+
"type": {
|
2242
|
+
"text": "HTMLElement"
|
2243
|
+
},
|
2244
|
+
"description": "The button element"
|
2245
|
+
},
|
2246
|
+
{
|
2247
|
+
"name": "active",
|
2248
|
+
"type": {
|
2249
|
+
"text": "boolean"
|
2250
|
+
},
|
2251
|
+
"description": "The active state of the element"
|
2252
|
+
}
|
2253
|
+
],
|
2254
|
+
"description": "Sets the aria-pressed attribute based on the active state of the button.",
|
2237
2255
|
"inheritedFrom": {
|
2238
|
-
"name": "
|
2239
|
-
"module": "components/
|
2256
|
+
"name": "Buttonsimple",
|
2257
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2240
2258
|
}
|
2241
2259
|
},
|
2242
2260
|
{
|
2243
2261
|
"kind": "method",
|
2244
|
-
"name": "
|
2245
|
-
"privacy": "
|
2246
|
-
"
|
2247
|
-
|
2248
|
-
|
2249
|
-
"
|
2262
|
+
"name": "setSoftDisabled",
|
2263
|
+
"privacy": "private",
|
2264
|
+
"parameters": [
|
2265
|
+
{
|
2266
|
+
"name": "element",
|
2267
|
+
"type": {
|
2268
|
+
"text": "HTMLElement"
|
2269
|
+
},
|
2270
|
+
"description": "The button element."
|
2271
|
+
},
|
2272
|
+
{
|
2273
|
+
"name": "softDisabled",
|
2274
|
+
"type": {
|
2275
|
+
"text": "boolean"
|
2276
|
+
},
|
2277
|
+
"description": "The soft-disabled state."
|
2250
2278
|
}
|
2251
|
-
|
2279
|
+
],
|
2280
|
+
"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.",
|
2252
2281
|
"inheritedFrom": {
|
2253
|
-
"name": "
|
2254
|
-
"module": "components/
|
2282
|
+
"name": "Buttonsimple",
|
2283
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2255
2284
|
}
|
2256
2285
|
},
|
2257
2286
|
{
|
2258
2287
|
"kind": "method",
|
2259
|
-
"name": "
|
2260
|
-
"privacy": "
|
2261
|
-
"
|
2262
|
-
|
2263
|
-
|
2264
|
-
"
|
2288
|
+
"name": "setDisabled",
|
2289
|
+
"privacy": "private",
|
2290
|
+
"parameters": [
|
2291
|
+
{
|
2292
|
+
"name": "element",
|
2293
|
+
"type": {
|
2294
|
+
"text": "HTMLElement"
|
2295
|
+
},
|
2296
|
+
"description": "The button element."
|
2297
|
+
},
|
2298
|
+
{
|
2299
|
+
"name": "disabled",
|
2300
|
+
"type": {
|
2301
|
+
"text": "boolean"
|
2302
|
+
},
|
2303
|
+
"description": "The disabled state."
|
2265
2304
|
}
|
2266
|
-
|
2305
|
+
],
|
2306
|
+
"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.",
|
2267
2307
|
"inheritedFrom": {
|
2268
|
-
"name": "
|
2269
|
-
"module": "components/
|
2308
|
+
"name": "Buttonsimple",
|
2309
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2270
2310
|
}
|
2271
2311
|
},
|
2272
2312
|
{
|
2273
2313
|
"kind": "method",
|
2274
|
-
"name": "
|
2275
|
-
"privacy": "
|
2276
|
-
"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.",
|
2277
|
-
"return": {
|
2278
|
-
"type": {
|
2279
|
-
"text": ""
|
2280
|
-
}
|
2281
|
-
},
|
2314
|
+
"name": "triggerClickEvent",
|
2315
|
+
"privacy": "private",
|
2282
2316
|
"inheritedFrom": {
|
2283
|
-
"name": "
|
2284
|
-
"module": "components/
|
2317
|
+
"name": "Buttonsimple",
|
2318
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2285
2319
|
}
|
2286
2320
|
},
|
2287
2321
|
{
|
2288
2322
|
"kind": "method",
|
2289
|
-
"name": "
|
2290
|
-
"privacy": "
|
2291
|
-
"
|
2292
|
-
|
2293
|
-
|
2294
|
-
"
|
2323
|
+
"name": "handleKeyDown",
|
2324
|
+
"privacy": "private",
|
2325
|
+
"parameters": [
|
2326
|
+
{
|
2327
|
+
"name": "event",
|
2328
|
+
"type": {
|
2329
|
+
"text": "KeyboardEvent"
|
2330
|
+
},
|
2331
|
+
"description": "The keyboard event."
|
2295
2332
|
}
|
2296
|
-
|
2333
|
+
],
|
2334
|
+
"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.",
|
2297
2335
|
"inheritedFrom": {
|
2298
|
-
"name": "
|
2299
|
-
"module": "components/
|
2336
|
+
"name": "Buttonsimple",
|
2337
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2300
2338
|
}
|
2301
2339
|
},
|
2302
2340
|
{
|
2303
2341
|
"kind": "method",
|
2304
|
-
"name": "
|
2305
|
-
"privacy": "
|
2306
|
-
"
|
2307
|
-
|
2308
|
-
|
2309
|
-
"
|
2342
|
+
"name": "handleKeyUp",
|
2343
|
+
"privacy": "private",
|
2344
|
+
"parameters": [
|
2345
|
+
{
|
2346
|
+
"name": "event",
|
2347
|
+
"type": {
|
2348
|
+
"text": "KeyboardEvent"
|
2349
|
+
},
|
2350
|
+
"description": "The keyboard event."
|
2310
2351
|
}
|
2311
|
-
|
2352
|
+
],
|
2353
|
+
"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.",
|
2312
2354
|
"inheritedFrom": {
|
2313
|
-
"name": "
|
2314
|
-
"module": "components/
|
2355
|
+
"name": "Buttonsimple",
|
2356
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2315
2357
|
}
|
2316
2358
|
}
|
2317
2359
|
],
|
2318
|
-
"
|
2360
|
+
"attributes": [
|
2319
2361
|
{
|
2362
|
+
"name": "prefix-icon",
|
2320
2363
|
"type": {
|
2321
|
-
"text": "
|
2322
|
-
}
|
2323
|
-
|
2324
|
-
|
2325
|
-
|
2364
|
+
"text": "string | undefined"
|
2365
|
+
},
|
2366
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2367
|
+
"fieldName": "prefixIcon"
|
2368
|
+
},
|
2326
2369
|
{
|
2327
|
-
"name": "
|
2370
|
+
"name": "postfix-icon",
|
2328
2371
|
"type": {
|
2329
|
-
"text": "
|
2372
|
+
"text": "string | undefined"
|
2330
2373
|
},
|
2331
|
-
"
|
2332
|
-
"
|
2333
|
-
"fieldName": "checked"
|
2374
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2375
|
+
"fieldName": "postfixIcon"
|
2334
2376
|
},
|
2335
2377
|
{
|
2336
|
-
"name": "
|
2378
|
+
"name": "variant",
|
2337
2379
|
"type": {
|
2338
|
-
"text": "
|
2380
|
+
"text": "ButtonVariant"
|
2339
2381
|
},
|
2340
|
-
"
|
2341
|
-
"
|
2342
|
-
"fieldName": "
|
2382
|
+
"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.",
|
2383
|
+
"default": "primary",
|
2384
|
+
"fieldName": "variant"
|
2343
2385
|
},
|
2344
2386
|
{
|
2345
|
-
"name": "
|
2387
|
+
"name": "size",
|
2346
2388
|
"type": {
|
2347
|
-
"text": "
|
2389
|
+
"text": "ButtonSize"
|
2348
2390
|
},
|
2349
|
-
"
|
2350
|
-
"
|
2351
|
-
"fieldName": "
|
2391
|
+
"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.",
|
2392
|
+
"default": "32",
|
2393
|
+
"fieldName": "size",
|
2352
2394
|
"inheritedFrom": {
|
2353
|
-
"name": "
|
2354
|
-
"module": "src/
|
2395
|
+
"name": "Buttonsimple",
|
2396
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2355
2397
|
}
|
2356
2398
|
},
|
2357
2399
|
{
|
2358
|
-
"name": "
|
2400
|
+
"name": "color",
|
2401
|
+
"type": {
|
2402
|
+
"text": "ButtonColor"
|
2403
|
+
},
|
2404
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2405
|
+
"default": "default",
|
2406
|
+
"fieldName": "color"
|
2407
|
+
},
|
2408
|
+
{
|
2409
|
+
"name": "role",
|
2410
|
+
"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.",
|
2411
|
+
"default": "'button'",
|
2412
|
+
"fieldName": "role",
|
2359
2413
|
"type": {
|
2360
2414
|
"text": "string"
|
2361
2415
|
},
|
2362
|
-
"default": "''",
|
2363
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2364
|
-
"fieldName": "value",
|
2365
2416
|
"inheritedFrom": {
|
2366
|
-
"name": "
|
2367
|
-
"module": "src/
|
2417
|
+
"name": "Buttonsimple",
|
2418
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2368
2419
|
}
|
2369
2420
|
},
|
2370
2421
|
{
|
2371
|
-
"name": "
|
2422
|
+
"name": "tabIndex",
|
2372
2423
|
"type": {
|
2373
|
-
"text": "
|
2424
|
+
"text": "number"
|
2374
2425
|
},
|
2375
|
-
"default": "
|
2376
|
-
"description": "
|
2377
|
-
"fieldName": "
|
2426
|
+
"default": "0",
|
2427
|
+
"description": "This property specifies the tab order of the element.",
|
2428
|
+
"fieldName": "tabIndex",
|
2378
2429
|
"inheritedFrom": {
|
2379
|
-
"name": "
|
2380
|
-
"module": "src/
|
2430
|
+
"name": "Buttonsimple",
|
2431
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2381
2432
|
}
|
2382
2433
|
},
|
2383
2434
|
{
|
@@ -2389,88 +2440,163 @@
|
|
2389
2440
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2390
2441
|
"fieldName": "disabled",
|
2391
2442
|
"inheritedFrom": {
|
2392
|
-
"name": "
|
2393
|
-
"module": "src/
|
2443
|
+
"name": "Buttonsimple",
|
2444
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2394
2445
|
}
|
2395
2446
|
},
|
2396
2447
|
{
|
2397
|
-
"name": "
|
2448
|
+
"name": "active",
|
2398
2449
|
"type": {
|
2399
|
-
"text": "
|
2450
|
+
"text": "boolean"
|
2400
2451
|
},
|
2401
|
-
"
|
2402
|
-
"
|
2403
|
-
"
|
2404
|
-
"name": "FormfieldWrapper",
|
2405
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2406
|
-
}
|
2407
|
-
},
|
2408
|
-
{
|
2409
|
-
"name": "id",
|
2410
|
-
"default": "`mdc-input-${uuidv4()}`",
|
2411
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2412
|
-
"fieldName": "id",
|
2452
|
+
"default": "false",
|
2453
|
+
"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.",
|
2454
|
+
"fieldName": "active",
|
2413
2455
|
"inheritedFrom": {
|
2414
|
-
"name": "
|
2415
|
-
"module": "src/components/
|
2456
|
+
"name": "Buttonsimple",
|
2457
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2416
2458
|
}
|
2417
2459
|
},
|
2418
2460
|
{
|
2419
|
-
"name": "
|
2461
|
+
"name": "soft-disabled",
|
2420
2462
|
"type": {
|
2421
|
-
"text": "
|
2463
|
+
"text": "boolean"
|
2422
2464
|
},
|
2423
|
-
"
|
2424
|
-
"
|
2465
|
+
"default": "false",
|
2466
|
+
"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.",
|
2467
|
+
"fieldName": "softDisabled",
|
2425
2468
|
"inheritedFrom": {
|
2426
|
-
"name": "
|
2427
|
-
"module": "src/components/
|
2469
|
+
"name": "Buttonsimple",
|
2470
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2428
2471
|
}
|
2429
2472
|
},
|
2430
2473
|
{
|
2431
|
-
"name": "
|
2474
|
+
"name": "type",
|
2432
2475
|
"type": {
|
2433
|
-
"text": "
|
2476
|
+
"text": "ButtonType"
|
2434
2477
|
},
|
2435
|
-
"description": "
|
2436
|
-
"
|
2478
|
+
"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.",
|
2479
|
+
"default": "button",
|
2480
|
+
"fieldName": "type",
|
2437
2481
|
"inheritedFrom": {
|
2438
|
-
"name": "
|
2439
|
-
"module": "src/components/
|
2482
|
+
"name": "Buttonsimple",
|
2483
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2440
2484
|
}
|
2441
2485
|
}
|
2442
2486
|
],
|
2443
|
-
"
|
2487
|
+
"superclass": {
|
2488
|
+
"name": "Buttonsimple",
|
2489
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2490
|
+
},
|
2491
|
+
"tagName": "mdc-button",
|
2492
|
+
"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 */",
|
2493
|
+
"customElement": true
|
2494
|
+
}
|
2495
|
+
],
|
2496
|
+
"exports": [
|
2497
|
+
{
|
2498
|
+
"kind": "js",
|
2499
|
+
"name": "default",
|
2500
|
+
"declaration": {
|
2501
|
+
"name": "Button",
|
2502
|
+
"module": "components/button/button.component.js"
|
2503
|
+
}
|
2504
|
+
}
|
2505
|
+
]
|
2506
|
+
},
|
2507
|
+
{
|
2508
|
+
"kind": "javascript-module",
|
2509
|
+
"path": "components/checkboxgroup/checkboxgroup.component.js",
|
2510
|
+
"declarations": [
|
2511
|
+
{
|
2512
|
+
"kind": "class",
|
2513
|
+
"description": "`mdc-checkboxgroup` component allows you to select multiple options from a predefined list.\nIt is commonly used in forms where multiple selections are required, such as preferences, filters, or categories.\n\nA checkbox group typically consists of multiple checkboxes grouped together,\neach representing a selectable option. You can check or uncheck options based on their preferences.",
|
2514
|
+
"name": "Checkboxgroup",
|
2515
|
+
"slots": [
|
2444
2516
|
{
|
2445
|
-
"
|
2446
|
-
"
|
2517
|
+
"description": "This is a help text slot.",
|
2518
|
+
"name": "help-text"
|
2447
2519
|
},
|
2448
2520
|
{
|
2449
|
-
"
|
2450
|
-
"
|
2521
|
+
"description": "This is a default slot for children.",
|
2522
|
+
"name": "default"
|
2523
|
+
}
|
2524
|
+
],
|
2525
|
+
"members": [
|
2526
|
+
{
|
2527
|
+
"kind": "field",
|
2528
|
+
"name": "headerText",
|
2529
|
+
"type": {
|
2530
|
+
"text": "string | undefined"
|
2531
|
+
},
|
2532
|
+
"description": "The header text of the checkboxgroup.",
|
2533
|
+
"attribute": "header-text"
|
2451
2534
|
},
|
2452
2535
|
{
|
2453
|
-
"
|
2454
|
-
"
|
2536
|
+
"kind": "method",
|
2537
|
+
"name": "handleKeyDown",
|
2538
|
+
"privacy": "private",
|
2539
|
+
"return": {
|
2540
|
+
"type": {
|
2541
|
+
"text": "void"
|
2542
|
+
}
|
2543
|
+
},
|
2544
|
+
"parameters": [
|
2545
|
+
{
|
2546
|
+
"name": "event",
|
2547
|
+
"type": {
|
2548
|
+
"text": "KeyboardEvent"
|
2549
|
+
},
|
2550
|
+
"description": "The KeyboardEvent"
|
2551
|
+
}
|
2552
|
+
],
|
2553
|
+
"description": "Handles the keydown event on the parent checkbox in the checkboxgroup.\nWhen the user presses the down arrow key, the focus is moved to the next checkbox in the checkboxgroup.\nWhen the user presses the up arrow key, the focus is moved to the previous checkbox in the checkboxgroup."
|
2554
|
+
},
|
2555
|
+
{
|
2556
|
+
"kind": "method",
|
2557
|
+
"name": "navigate",
|
2558
|
+
"privacy": "private",
|
2559
|
+
"return": {
|
2560
|
+
"type": {
|
2561
|
+
"text": "void"
|
2562
|
+
}
|
2563
|
+
},
|
2564
|
+
"parameters": [
|
2565
|
+
{
|
2566
|
+
"name": "origin",
|
2567
|
+
"type": {
|
2568
|
+
"text": "EventTarget | null"
|
2569
|
+
},
|
2570
|
+
"description": "The element that triggered the event."
|
2571
|
+
},
|
2572
|
+
{
|
2573
|
+
"name": "direction",
|
2574
|
+
"type": {
|
2575
|
+
"text": "number"
|
2576
|
+
},
|
2577
|
+
"description": "The direction of navigation, either -1 or 1."
|
2578
|
+
}
|
2579
|
+
],
|
2580
|
+
"description": "Navigate to the next or previous checkbox in the checkboxgroup based on the given origin and direction."
|
2455
2581
|
}
|
2456
2582
|
],
|
2457
|
-
"
|
2458
|
-
"name": "FormfieldWrapper",
|
2459
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
2460
|
-
},
|
2461
|
-
"tagName": "mdc-checkbox",
|
2462
|
-
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-checkbox\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-checkbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-checkbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-color - Icon color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n */",
|
2463
|
-
"customElement": true,
|
2464
|
-
"slots": [
|
2583
|
+
"attributes": [
|
2465
2584
|
{
|
2466
|
-
"
|
2467
|
-
"
|
2468
|
-
|
2469
|
-
|
2470
|
-
|
2471
|
-
|
2585
|
+
"name": "header-text",
|
2586
|
+
"type": {
|
2587
|
+
"text": "string | undefined"
|
2588
|
+
},
|
2589
|
+
"description": "The header text of the checkboxgroup.",
|
2590
|
+
"fieldName": "headerText"
|
2472
2591
|
}
|
2473
|
-
]
|
2592
|
+
],
|
2593
|
+
"superclass": {
|
2594
|
+
"name": "Component",
|
2595
|
+
"module": "/src/models"
|
2596
|
+
},
|
2597
|
+
"tagName": "mdc-checkboxgroup",
|
2598
|
+
"jsDoc": "/**\n * `mdc-checkboxgroup` component allows you to select multiple options from a predefined list.\n * It is commonly used in forms where multiple selections are required, such as preferences, filters, or categories.\n *\n * A checkbox group typically consists of multiple checkboxes grouped together,\n * each representing a selectable option. You can check or uncheck options based on their preferences.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-checkboxgroup\n *\n * @slot help-text - This is a help text slot.\n * @slot default - This is a default slot for children.\n */",
|
2599
|
+
"customElement": true
|
2474
2600
|
}
|
2475
2601
|
],
|
2476
2602
|
"exports": [
|
@@ -2478,8 +2604,8 @@
|
|
2478
2604
|
"kind": "js",
|
2479
2605
|
"name": "default",
|
2480
2606
|
"declaration": {
|
2481
|
-
"name": "
|
2482
|
-
"module": "components/
|
2607
|
+
"name": "Checkboxgroup",
|
2608
|
+
"module": "components/checkboxgroup/checkboxgroup.component.js"
|
2483
2609
|
}
|
2484
2610
|
}
|
2485
2611
|
]
|
@@ -3008,11 +3134,31 @@
|
|
3008
3134
|
"privacy": "private",
|
3009
3135
|
"default": "new AbortController()"
|
3010
3136
|
},
|
3137
|
+
{
|
3138
|
+
"kind": "method",
|
3139
|
+
"name": "prepareIconElement",
|
3140
|
+
"privacy": "private",
|
3141
|
+
"parameters": [
|
3142
|
+
{
|
3143
|
+
"name": "iconData",
|
3144
|
+
"type": {
|
3145
|
+
"text": "string"
|
3146
|
+
},
|
3147
|
+
"description": "The icon string to be parsed"
|
3148
|
+
}
|
3149
|
+
],
|
3150
|
+
"description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
|
3151
|
+
"return": {
|
3152
|
+
"type": {
|
3153
|
+
"text": ""
|
3154
|
+
}
|
3155
|
+
}
|
3156
|
+
},
|
3011
3157
|
{
|
3012
3158
|
"kind": "method",
|
3013
3159
|
"name": "getIconData",
|
3014
3160
|
"privacy": "private",
|
3015
|
-
"description": "
|
3161
|
+
"description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
|
3016
3162
|
},
|
3017
3163
|
{
|
3018
3164
|
"kind": "method",
|
@@ -3117,7 +3263,7 @@
|
|
3117
3263
|
"declarations": [
|
3118
3264
|
{
|
3119
3265
|
"kind": "class",
|
3120
|
-
"description": "IconProvider component, which allows to be consumed from sub components\n(see `providerUtils.consume` for how to consume)\n\nBundling icons will be up to the consumer of this component, such\nthat only a url has to be passed in from which the icons will be\nfetched.",
|
3266
|
+
"description": "IconProvider component, which allows to be consumed from sub components\n(see `providerUtils.consume` for how to consume)\n\nBundling icons will be up to the consumer of this component, such\nthat only a url has to be passed in from which the icons will be\nfetched.\n\nIf `shouldCache` is set to true, the IconProvider will cache the icons\nin a Map to avoid fetching the same icon multiple times over the network.\nThis is useful when the same icon is used multiple times in the application.\nKeep in mind that this cache is not persisted and will be lost when the\nIconProvider is removed from the DOM.",
|
3121
3267
|
"name": "IconProvider",
|
3122
3268
|
"slots": [
|
3123
3269
|
{
|
@@ -3176,6 +3322,17 @@
|
|
3176
3322
|
"attribute": "size",
|
3177
3323
|
"reflects": true
|
3178
3324
|
},
|
3325
|
+
{
|
3326
|
+
"kind": "field",
|
3327
|
+
"name": "shouldCache",
|
3328
|
+
"type": {
|
3329
|
+
"text": "boolean | undefined"
|
3330
|
+
},
|
3331
|
+
"description": "If the IconProvider should cache the icons\nin a Map to avoid fetching the same icon multiple times",
|
3332
|
+
"default": "false",
|
3333
|
+
"attribute": "should-cache",
|
3334
|
+
"reflects": true
|
3335
|
+
},
|
3179
3336
|
{
|
3180
3337
|
"kind": "method",
|
3181
3338
|
"name": "updateValuesInContext",
|
@@ -3227,6 +3384,15 @@
|
|
3227
3384
|
"description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
|
3228
3385
|
"default": "1",
|
3229
3386
|
"fieldName": "size"
|
3387
|
+
},
|
3388
|
+
{
|
3389
|
+
"name": "should-cache",
|
3390
|
+
"type": {
|
3391
|
+
"text": "boolean | undefined"
|
3392
|
+
},
|
3393
|
+
"description": "If the IconProvider should cache the icons\nin a Map to avoid fetching the same icon multiple times",
|
3394
|
+
"default": "false",
|
3395
|
+
"fieldName": "shouldCache"
|
3230
3396
|
}
|
3231
3397
|
],
|
3232
3398
|
"superclass": {
|
@@ -3234,7 +3400,7 @@
|
|
3234
3400
|
"module": "/src/models"
|
3235
3401
|
},
|
3236
3402
|
"tagName": "mdc-iconprovider",
|
3237
|
-
"jsDoc": "/**\n * IconProvider component, which allows to be consumed from sub components\n * (see `providerUtils.consume` for how to consume)\n *\n * Bundling icons will be up to the consumer of this component, such\n * that only a url has to be passed in from which the icons will be\n * fetched.\n *\n * @tagname mdc-iconprovider\n *\n * @slot - children\n */",
|
3403
|
+
"jsDoc": "/**\n * IconProvider component, which allows to be consumed from sub components\n * (see `providerUtils.consume` for how to consume)\n *\n * Bundling icons will be up to the consumer of this component, such\n * that only a url has to be passed in from which the icons will be\n * fetched.\n *\n * If `shouldCache` is set to true, the IconProvider will cache the icons\n * in a Map to avoid fetching the same icon multiple times over the network.\n * This is useful when the same icon is used multiple times in the application.\n * Keep in mind that this cache is not persisted and will be lost when the\n * IconProvider is removed from the DOM.\n *\n * @tagname mdc-iconprovider\n *\n * @slot - children\n */",
|
3238
3404
|
"customElement": true
|
3239
3405
|
}
|
3240
3406
|
],
|