@momentum-design/components 0.27.5 → 0.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,250 +2,6 @@
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
- },
249
5
  {
250
6
  "kind": "javascript-module",
251
7
  "path": "components/avatarbutton/avatarbutton.component.js",
@@ -1163,20 +919,264 @@
1163
919
  },
1164
920
  {
1165
921
  "kind": "javascript-module",
1166
- "path": "components/bullet/bullet.component.js",
922
+ "path": "components/avatar/avatar.component.js",
1167
923
  "declarations": [
1168
924
  {
1169
925
  "kind": "class",
1170
- "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
1171
- "name": "Bullet",
926
+ "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.",
927
+ "name": "Avatar",
1172
928
  "cssProperties": [
1173
929
  {
1174
- "description": "background color of the bullet",
1175
- "name": "--mdc-bullet-background-color"
930
+ "description": "Allows customization of the default background color.",
931
+ "name": "--mdc-avatar-default-background-color"
1176
932
  },
1177
933
  {
1178
- "description": "small size value of the bullet",
1179
- "name": "--mdc-bullet-size-small"
934
+ "description": "Allows customization of the default foreground color.",
935
+ "name": "--mdc-avatar-default-foreground-color"
936
+ },
937
+ {
938
+ "description": "Allows customization of the loading indicator background color.",
939
+ "name": "--mdc-avatar-loading-indicator-background-color"
940
+ },
941
+ {
942
+ "description": "Allows customization of the loading indicator foreground color.",
943
+ "name": "--mdc-avatar-loading-indicator-foreground-color"
944
+ },
945
+ {
946
+ "description": "Allows customization of the loading overlay background color.",
947
+ "name": "--mdc-avatar-loading-overlay-background-color"
948
+ }
949
+ ],
950
+ "members": [
951
+ {
952
+ "kind": "field",
953
+ "name": "src",
954
+ "type": {
955
+ "text": "string | undefined"
956
+ },
957
+ "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.",
958
+ "attribute": "src",
959
+ "inheritedFrom": {
960
+ "name": "AvatarComponentMixin",
961
+ "module": "utils/mixins/AvatarComponentMixin.js"
962
+ }
963
+ },
964
+ {
965
+ "kind": "field",
966
+ "name": "initials",
967
+ "type": {
968
+ "text": "string | undefined"
969
+ },
970
+ "description": "The initials to be displayed for the avatar.",
971
+ "attribute": "initials",
972
+ "inheritedFrom": {
973
+ "name": "AvatarComponentMixin",
974
+ "module": "utils/mixins/AvatarComponentMixin.js"
975
+ }
976
+ },
977
+ {
978
+ "kind": "field",
979
+ "name": "presence",
980
+ "type": {
981
+ "text": "PresenceType | undefined"
982
+ },
983
+ "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`",
984
+ "attribute": "presence",
985
+ "inheritedFrom": {
986
+ "name": "AvatarComponentMixin",
987
+ "module": "utils/mixins/AvatarComponentMixin.js"
988
+ }
989
+ },
990
+ {
991
+ "kind": "field",
992
+ "name": "size",
993
+ "type": {
994
+ "text": "AvatarSize"
995
+ },
996
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
997
+ "default": "32",
998
+ "attribute": "size",
999
+ "reflects": true,
1000
+ "inheritedFrom": {
1001
+ "name": "AvatarComponentMixin",
1002
+ "module": "utils/mixins/AvatarComponentMixin.js"
1003
+ }
1004
+ },
1005
+ {
1006
+ "kind": "field",
1007
+ "name": "counter",
1008
+ "type": {
1009
+ "text": "number | undefined"
1010
+ },
1011
+ "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`.",
1012
+ "attribute": "counter",
1013
+ "inheritedFrom": {
1014
+ "name": "AvatarComponentMixin",
1015
+ "module": "utils/mixins/AvatarComponentMixin.js"
1016
+ }
1017
+ },
1018
+ {
1019
+ "kind": "field",
1020
+ "name": "isTyping",
1021
+ "type": {
1022
+ "text": "boolean"
1023
+ },
1024
+ "default": "false",
1025
+ "description": "Represents the typing indicator when the user is typing.",
1026
+ "attribute": "is-typing",
1027
+ "inheritedFrom": {
1028
+ "name": "AvatarComponentMixin",
1029
+ "module": "utils/mixins/AvatarComponentMixin.js"
1030
+ }
1031
+ },
1032
+ {
1033
+ "kind": "field",
1034
+ "name": "iconName",
1035
+ "type": {
1036
+ "text": "IconNames | undefined"
1037
+ },
1038
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1039
+ "attribute": "icon-name",
1040
+ "inheritedFrom": {
1041
+ "name": "IconNameMixin",
1042
+ "module": "utils/mixins/IconNameMixin.js"
1043
+ }
1044
+ }
1045
+ ],
1046
+ "mixins": [
1047
+ {
1048
+ "name": "AvatarComponentMixin",
1049
+ "module": "/src/utils/mixins/AvatarComponentMixin"
1050
+ },
1051
+ {
1052
+ "name": "IconNameMixin",
1053
+ "module": "/src/utils/mixins/IconNameMixin"
1054
+ }
1055
+ ],
1056
+ "superclass": {
1057
+ "name": "Component",
1058
+ "module": "/src/models"
1059
+ },
1060
+ "tagName": "mdc-avatar",
1061
+ "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 */",
1062
+ "customElement": true,
1063
+ "attributes": [
1064
+ {
1065
+ "name": "src",
1066
+ "type": {
1067
+ "text": "string | undefined"
1068
+ },
1069
+ "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.",
1070
+ "fieldName": "src",
1071
+ "inheritedFrom": {
1072
+ "name": "AvatarComponentMixin",
1073
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1074
+ }
1075
+ },
1076
+ {
1077
+ "name": "initials",
1078
+ "type": {
1079
+ "text": "string | undefined"
1080
+ },
1081
+ "description": "The initials to be displayed for the avatar.",
1082
+ "fieldName": "initials",
1083
+ "inheritedFrom": {
1084
+ "name": "AvatarComponentMixin",
1085
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1086
+ }
1087
+ },
1088
+ {
1089
+ "name": "presence",
1090
+ "type": {
1091
+ "text": "PresenceType | undefined"
1092
+ },
1093
+ "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`",
1094
+ "fieldName": "presence",
1095
+ "inheritedFrom": {
1096
+ "name": "AvatarComponentMixin",
1097
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1098
+ }
1099
+ },
1100
+ {
1101
+ "name": "size",
1102
+ "type": {
1103
+ "text": "AvatarSize"
1104
+ },
1105
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
1106
+ "default": "32",
1107
+ "fieldName": "size",
1108
+ "inheritedFrom": {
1109
+ "name": "AvatarComponentMixin",
1110
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1111
+ }
1112
+ },
1113
+ {
1114
+ "name": "counter",
1115
+ "type": {
1116
+ "text": "number | undefined"
1117
+ },
1118
+ "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`.",
1119
+ "fieldName": "counter",
1120
+ "inheritedFrom": {
1121
+ "name": "AvatarComponentMixin",
1122
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1123
+ }
1124
+ },
1125
+ {
1126
+ "name": "is-typing",
1127
+ "type": {
1128
+ "text": "boolean"
1129
+ },
1130
+ "default": "false",
1131
+ "description": "Represents the typing indicator when the user is typing.",
1132
+ "fieldName": "isTyping",
1133
+ "inheritedFrom": {
1134
+ "name": "AvatarComponentMixin",
1135
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
1136
+ }
1137
+ },
1138
+ {
1139
+ "name": "icon-name",
1140
+ "type": {
1141
+ "text": "IconNames | undefined"
1142
+ },
1143
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1144
+ "fieldName": "iconName",
1145
+ "inheritedFrom": {
1146
+ "name": "IconNameMixin",
1147
+ "module": "src/utils/mixins/IconNameMixin.ts"
1148
+ }
1149
+ }
1150
+ ]
1151
+ }
1152
+ ],
1153
+ "exports": [
1154
+ {
1155
+ "kind": "js",
1156
+ "name": "default",
1157
+ "declaration": {
1158
+ "name": "Avatar",
1159
+ "module": "components/avatar/avatar.component.js"
1160
+ }
1161
+ }
1162
+ ]
1163
+ },
1164
+ {
1165
+ "kind": "javascript-module",
1166
+ "path": "components/bullet/bullet.component.js",
1167
+ "declarations": [
1168
+ {
1169
+ "kind": "class",
1170
+ "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
1171
+ "name": "Bullet",
1172
+ "cssProperties": [
1173
+ {
1174
+ "description": "background color of the bullet",
1175
+ "name": "--mdc-bullet-background-color"
1176
+ },
1177
+ {
1178
+ "description": "small size value of the bullet",
1179
+ "name": "--mdc-bullet-size-small"
1180
1180
  },
1181
1181
  {
1182
1182
  "description": "medium size value of the bullet",
@@ -2272,16 +2272,30 @@
2272
2272
  },
2273
2273
  {
2274
2274
  "kind": "field",
2275
- "name": "name",
2275
+ "name": "id",
2276
2276
  "type": {
2277
2277
  "text": "string"
2278
2278
  },
2279
- "default": "''",
2280
- "description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
2281
- "attribute": "name",
2282
- "reflects": true,
2279
+ "default": "`mdc-input-${uuidv4()}`",
2280
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
2281
+ "attribute": "id",
2283
2282
  "inheritedFrom": {
2284
- "name": "NameMixin",
2283
+ "name": "FormfieldWrapper",
2284
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2285
+ }
2286
+ },
2287
+ {
2288
+ "kind": "field",
2289
+ "name": "name",
2290
+ "type": {
2291
+ "text": "string"
2292
+ },
2293
+ "default": "''",
2294
+ "description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
2295
+ "attribute": "name",
2296
+ "reflects": true,
2297
+ "inheritedFrom": {
2298
+ "name": "NameMixin",
2285
2299
  "module": "utils/mixins/NameMixin.js"
2286
2300
  }
2287
2301
  },
@@ -2358,17 +2372,6 @@
2358
2372
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2359
2373
  }
2360
2374
  },
2361
- {
2362
- "kind": "field",
2363
- "name": "id",
2364
- "default": "`mdc-input-${uuidv4()}`",
2365
- "description": "The unique id of the input field. It is used to link the input field with the label.",
2366
- "attribute": "id",
2367
- "inheritedFrom": {
2368
- "name": "FormfieldWrapper",
2369
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2370
- }
2371
- },
2372
2375
  {
2373
2376
  "kind": "field",
2374
2377
  "name": "helpText",
@@ -2584,7 +2587,10 @@
2584
2587
  },
2585
2588
  {
2586
2589
  "name": "id",
2587
- "default": "`mdc-input-${uuidv4()}`",
2590
+ "type": {
2591
+ "text": "string"
2592
+ },
2593
+ "default": "''",
2588
2594
  "description": "The unique id of the input field. It is used to link the input field with the label.",
2589
2595
  "fieldName": "id",
2590
2596
  "inheritedFrom": {
@@ -2932,14 +2938,13 @@
2932
2938
  "members": [
2933
2939
  {
2934
2940
  "kind": "field",
2935
- "name": "helpTextType",
2941
+ "name": "id",
2936
2942
  "type": {
2937
- "text": "ValidationType"
2943
+ "text": "string"
2938
2944
  },
2939
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
2940
- "attribute": "help-text-type",
2941
- "reflects": true,
2942
- "default": "undefined as unknown",
2945
+ "default": "''",
2946
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
2947
+ "attribute": "id",
2943
2948
  "inheritedFrom": {
2944
2949
  "name": "FormfieldWrapper",
2945
2950
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
@@ -2947,17 +2952,17 @@
2947
2952
  },
2948
2953
  {
2949
2954
  "kind": "field",
2950
- "name": "dataAriaLabel",
2955
+ "name": "helpTextType",
2951
2956
  "type": {
2952
- "text": "string | null"
2957
+ "text": "ValidationType"
2953
2958
  },
2954
- "default": "null",
2955
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
2956
- "attribute": "data-aria-label",
2959
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
2960
+ "attribute": "help-text-type",
2957
2961
  "reflects": true,
2962
+ "default": "undefined as unknown",
2958
2963
  "inheritedFrom": {
2959
- "name": "DataAriaLabelMixin",
2960
- "module": "utils/mixins/DataAriaLabelMixin.js"
2964
+ "name": "FormfieldWrapper",
2965
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2961
2966
  }
2962
2967
  },
2963
2968
  {
@@ -2966,7 +2971,7 @@
2966
2971
  "type": {
2967
2972
  "text": "boolean"
2968
2973
  },
2969
- "default": "false",
2974
+ "default": "undefined as unknown",
2970
2975
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2971
2976
  "attribute": "disabled",
2972
2977
  "reflects": true,
@@ -2975,6 +2980,21 @@
2975
2980
  "module": "utils/mixins/DisabledMixin.js"
2976
2981
  }
2977
2982
  },
2983
+ {
2984
+ "kind": "field",
2985
+ "name": "dataAriaLabel",
2986
+ "type": {
2987
+ "text": "string | null"
2988
+ },
2989
+ "default": "null",
2990
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
2991
+ "attribute": "data-aria-label",
2992
+ "reflects": true,
2993
+ "inheritedFrom": {
2994
+ "name": "DataAriaLabelMixin",
2995
+ "module": "utils/mixins/DataAriaLabelMixin.js"
2996
+ }
2997
+ },
2978
2998
  {
2979
2999
  "kind": "field",
2980
3000
  "name": "label",
@@ -3003,17 +3023,6 @@
3003
3023
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3004
3024
  }
3005
3025
  },
3006
- {
3007
- "kind": "field",
3008
- "name": "id",
3009
- "default": "`mdc-input-${uuidv4()}`",
3010
- "description": "The unique id of the input field. It is used to link the input field with the label.",
3011
- "attribute": "id",
3012
- "inheritedFrom": {
3013
- "name": "FormfieldWrapper",
3014
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
3015
- }
3016
- },
3017
3026
  {
3018
3027
  "kind": "field",
3019
3028
  "name": "helpText",
@@ -3179,7 +3188,10 @@
3179
3188
  },
3180
3189
  {
3181
3190
  "name": "id",
3182
- "default": "`mdc-input-${uuidv4()}`",
3191
+ "type": {
3192
+ "text": "string"
3193
+ },
3194
+ "default": "''",
3183
3195
  "description": "The unique id of the input field. It is used to link the input field with the label.",
3184
3196
  "fieldName": "id",
3185
3197
  "inheritedFrom": {
@@ -3263,7 +3275,10 @@
3263
3275
  {
3264
3276
  "kind": "field",
3265
3277
  "name": "id",
3266
- "default": "`mdc-input-${uuidv4()}`",
3278
+ "type": {
3279
+ "text": "string"
3280
+ },
3281
+ "default": "''",
3267
3282
  "description": "The unique id of the input field. It is used to link the input field with the label.",
3268
3283
  "attribute": "id"
3269
3284
  },
@@ -3382,7 +3397,10 @@
3382
3397
  },
3383
3398
  {
3384
3399
  "name": "id",
3385
- "default": "`mdc-input-${uuidv4()}`",
3400
+ "type": {
3401
+ "text": "string"
3402
+ },
3403
+ "default": "''",
3386
3404
  "description": "The unique id of the input field. It is used to link the input field with the label.",
3387
3405
  "fieldName": "id"
3388
3406
  },
@@ -4199,6 +4217,20 @@
4199
4217
  }
4200
4218
  }
4201
4219
  },
4220
+ {
4221
+ "kind": "field",
4222
+ "name": "id",
4223
+ "type": {
4224
+ "text": "string"
4225
+ },
4226
+ "default": "`mdc-input-${uuidv4()}`",
4227
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
4228
+ "attribute": "id",
4229
+ "inheritedFrom": {
4230
+ "name": "FormfieldWrapper",
4231
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
4232
+ }
4233
+ },
4202
4234
  {
4203
4235
  "kind": "field",
4204
4236
  "name": "dataAriaLabel",
@@ -4287,17 +4319,6 @@
4287
4319
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
4288
4320
  }
4289
4321
  },
4290
- {
4291
- "kind": "field",
4292
- "name": "id",
4293
- "default": "`mdc-input-${uuidv4()}`",
4294
- "description": "The unique id of the input field. It is used to link the input field with the label.",
4295
- "attribute": "id",
4296
- "inheritedFrom": {
4297
- "name": "FormfieldWrapper",
4298
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
4299
- }
4300
- },
4301
4322
  {
4302
4323
  "kind": "field",
4303
4324
  "name": "helpTextType",
@@ -4649,7 +4670,10 @@
4649
4670
  },
4650
4671
  {
4651
4672
  "name": "id",
4652
- "default": "`mdc-input-${uuidv4()}`",
4673
+ "type": {
4674
+ "text": "string"
4675
+ },
4676
+ "default": "''",
4653
4677
  "description": "The unique id of the input field. It is used to link the input field with the label.",
4654
4678
  "fieldName": "id",
4655
4679
  "inheritedFrom": {
@@ -5512,16 +5536,442 @@
5512
5536
  "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
5513
5537
  },
5514
5538
  {
5515
- "kind": "method",
5516
- "name": "updateTabIndex",
5517
- "privacy": "private",
5518
- "return": {
5519
- "type": {
5520
- "text": "void"
5521
- }
5539
+ "kind": "method",
5540
+ "name": "updateTabIndex",
5541
+ "privacy": "private",
5542
+ "return": {
5543
+ "type": {
5544
+ "text": "void"
5545
+ }
5546
+ },
5547
+ "description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
5548
+ },
5549
+ {
5550
+ "kind": "field",
5551
+ "name": "id",
5552
+ "type": {
5553
+ "text": "string"
5554
+ },
5555
+ "default": "`mdc-input-${uuidv4()}`",
5556
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
5557
+ "attribute": "id",
5558
+ "inheritedFrom": {
5559
+ "name": "FormfieldWrapper",
5560
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5561
+ }
5562
+ },
5563
+ {
5564
+ "kind": "field",
5565
+ "name": "name",
5566
+ "type": {
5567
+ "text": "string"
5568
+ },
5569
+ "default": "''",
5570
+ "description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
5571
+ "attribute": "name",
5572
+ "reflects": true,
5573
+ "inheritedFrom": {
5574
+ "name": "NameMixin",
5575
+ "module": "utils/mixins/NameMixin.js"
5576
+ }
5577
+ },
5578
+ {
5579
+ "kind": "field",
5580
+ "name": "value",
5581
+ "type": {
5582
+ "text": "string"
5583
+ },
5584
+ "default": "''",
5585
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
5586
+ "attribute": "value",
5587
+ "reflects": true,
5588
+ "inheritedFrom": {
5589
+ "name": "ValueMixin",
5590
+ "module": "utils/mixins/ValueMixin.js"
5591
+ }
5592
+ },
5593
+ {
5594
+ "kind": "field",
5595
+ "name": "dataAriaLabel",
5596
+ "type": {
5597
+ "text": "string | null"
5598
+ },
5599
+ "default": "null",
5600
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
5601
+ "attribute": "data-aria-label",
5602
+ "reflects": true,
5603
+ "inheritedFrom": {
5604
+ "name": "DataAriaLabelMixin",
5605
+ "module": "utils/mixins/DataAriaLabelMixin.js"
5606
+ }
5607
+ },
5608
+ {
5609
+ "kind": "field",
5610
+ "name": "disabled",
5611
+ "type": {
5612
+ "text": "boolean"
5613
+ },
5614
+ "default": "false",
5615
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
5616
+ "attribute": "disabled",
5617
+ "reflects": true,
5618
+ "inheritedFrom": {
5619
+ "name": "FormfieldWrapper",
5620
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5621
+ }
5622
+ },
5623
+ {
5624
+ "kind": "field",
5625
+ "name": "label",
5626
+ "type": {
5627
+ "text": "string | undefined"
5628
+ },
5629
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
5630
+ "attribute": "label",
5631
+ "reflects": true,
5632
+ "inheritedFrom": {
5633
+ "name": "FormfieldWrapper",
5634
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5635
+ }
5636
+ },
5637
+ {
5638
+ "kind": "field",
5639
+ "name": "requiredLabel",
5640
+ "type": {
5641
+ "text": "string | undefined"
5642
+ },
5643
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
5644
+ "attribute": "required-label",
5645
+ "reflects": true,
5646
+ "inheritedFrom": {
5647
+ "name": "FormfieldWrapper",
5648
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5649
+ }
5650
+ },
5651
+ {
5652
+ "kind": "field",
5653
+ "name": "helpTextType",
5654
+ "type": {
5655
+ "text": "ValidationType"
5656
+ },
5657
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
5658
+ "attribute": "help-text-type",
5659
+ "reflects": true,
5660
+ "inheritedFrom": {
5661
+ "name": "FormfieldWrapper",
5662
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5663
+ }
5664
+ },
5665
+ {
5666
+ "kind": "field",
5667
+ "name": "helpText",
5668
+ "type": {
5669
+ "text": "string | undefined"
5670
+ },
5671
+ "description": "The help text that is displayed below the input field.",
5672
+ "attribute": "help-text",
5673
+ "reflects": true,
5674
+ "inheritedFrom": {
5675
+ "name": "FormfieldWrapper",
5676
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5677
+ }
5678
+ },
5679
+ {
5680
+ "kind": "method",
5681
+ "name": "renderLabelElement",
5682
+ "privacy": "protected",
5683
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
5684
+ "return": {
5685
+ "type": {
5686
+ "text": ""
5687
+ }
5688
+ },
5689
+ "inheritedFrom": {
5690
+ "name": "FormfieldWrapper",
5691
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5692
+ }
5693
+ },
5694
+ {
5695
+ "kind": "method",
5696
+ "name": "renderRequiredLabel",
5697
+ "privacy": "protected",
5698
+ "inheritedFrom": {
5699
+ "name": "FormfieldWrapper",
5700
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5701
+ }
5702
+ },
5703
+ {
5704
+ "kind": "method",
5705
+ "name": "renderHelpTextIcon",
5706
+ "privacy": "protected",
5707
+ "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.",
5708
+ "return": {
5709
+ "type": {
5710
+ "text": ""
5711
+ }
5712
+ },
5713
+ "inheritedFrom": {
5714
+ "name": "FormfieldWrapper",
5715
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5716
+ }
5717
+ },
5718
+ {
5719
+ "kind": "method",
5720
+ "name": "renderHelpText",
5721
+ "privacy": "protected",
5722
+ "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.",
5723
+ "return": {
5724
+ "type": {
5725
+ "text": ""
5726
+ }
5727
+ },
5728
+ "inheritedFrom": {
5729
+ "name": "FormfieldWrapper",
5730
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5731
+ }
5732
+ },
5733
+ {
5734
+ "kind": "method",
5735
+ "name": "renderLabel",
5736
+ "privacy": "protected",
5737
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
5738
+ "return": {
5739
+ "type": {
5740
+ "text": ""
5741
+ }
5742
+ },
5743
+ "inheritedFrom": {
5744
+ "name": "FormfieldWrapper",
5745
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5746
+ }
5747
+ },
5748
+ {
5749
+ "kind": "method",
5750
+ "name": "renderHelperText",
5751
+ "privacy": "protected",
5752
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
5753
+ "return": {
5754
+ "type": {
5755
+ "text": ""
5756
+ }
5757
+ },
5758
+ "inheritedFrom": {
5759
+ "name": "FormfieldWrapper",
5760
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
5761
+ }
5762
+ }
5763
+ ],
5764
+ "events": [
5765
+ {
5766
+ "type": {
5767
+ "text": "EventConstructor"
5768
+ }
5769
+ },
5770
+ {
5771
+ "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
5772
+ "name": "change",
5773
+ "reactName": "onChange",
5774
+ "eventName": "ChangeEvent"
5775
+ },
5776
+ {
5777
+ "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
5778
+ "name": "focus",
5779
+ "reactName": "onFocus",
5780
+ "eventName": "FocusEvent"
5781
+ }
5782
+ ],
5783
+ "attributes": [
5784
+ {
5785
+ "name": "checked",
5786
+ "type": {
5787
+ "text": "boolean"
5788
+ },
5789
+ "default": "false",
5790
+ "description": "Determines whether the radio is selected or unselected.",
5791
+ "fieldName": "checked"
5792
+ },
5793
+ {
5794
+ "name": "readonly",
5795
+ "type": {
5796
+ "text": "boolean"
5797
+ },
5798
+ "default": "false",
5799
+ "description": "Determines whether the radio is read-only.",
5800
+ "fieldName": "readonly"
5801
+ },
5802
+ {
5803
+ "name": "name",
5804
+ "type": {
5805
+ "text": "string"
5806
+ },
5807
+ "default": "''",
5808
+ "description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
5809
+ "fieldName": "name",
5810
+ "inheritedFrom": {
5811
+ "name": "NameMixin",
5812
+ "module": "src/utils/mixins/NameMixin.ts"
5813
+ }
5814
+ },
5815
+ {
5816
+ "name": "value",
5817
+ "type": {
5818
+ "text": "string"
5819
+ },
5820
+ "default": "''",
5821
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
5822
+ "fieldName": "value",
5823
+ "inheritedFrom": {
5824
+ "name": "ValueMixin",
5825
+ "module": "src/utils/mixins/ValueMixin.ts"
5826
+ }
5827
+ },
5828
+ {
5829
+ "name": "data-aria-label",
5830
+ "type": {
5831
+ "text": "string | null"
5832
+ },
5833
+ "default": "null",
5834
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
5835
+ "fieldName": "dataAriaLabel",
5836
+ "inheritedFrom": {
5837
+ "name": "DataAriaLabelMixin",
5838
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
5839
+ }
5840
+ },
5841
+ {
5842
+ "name": "disabled",
5843
+ "type": {
5844
+ "text": "boolean"
5845
+ },
5846
+ "default": "false",
5847
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
5848
+ "fieldName": "disabled",
5849
+ "inheritedFrom": {
5850
+ "name": "FormfieldWrapper",
5851
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5852
+ }
5853
+ },
5854
+ {
5855
+ "name": "label",
5856
+ "type": {
5857
+ "text": "string | undefined"
5858
+ },
5859
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
5860
+ "fieldName": "label",
5861
+ "inheritedFrom": {
5862
+ "name": "FormfieldWrapper",
5863
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5864
+ }
5865
+ },
5866
+ {
5867
+ "name": "required-label",
5868
+ "type": {
5869
+ "text": "string | undefined"
5870
+ },
5871
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
5872
+ "fieldName": "requiredLabel",
5873
+ "inheritedFrom": {
5874
+ "name": "FormfieldWrapper",
5875
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5876
+ }
5877
+ },
5878
+ {
5879
+ "name": "id",
5880
+ "type": {
5881
+ "text": "string"
5882
+ },
5883
+ "default": "''",
5884
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
5885
+ "fieldName": "id",
5886
+ "inheritedFrom": {
5887
+ "name": "FormfieldWrapper",
5888
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5889
+ }
5890
+ },
5891
+ {
5892
+ "name": "help-text-type",
5893
+ "type": {
5894
+ "text": "ValidationType"
5895
+ },
5896
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
5897
+ "fieldName": "helpTextType",
5898
+ "inheritedFrom": {
5899
+ "name": "FormfieldWrapper",
5900
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5901
+ }
5902
+ },
5903
+ {
5904
+ "name": "help-text",
5905
+ "type": {
5906
+ "text": "string | undefined"
5522
5907
  },
5523
- "description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
5908
+ "description": "The help text that is displayed below the input field.",
5909
+ "fieldName": "helpText",
5910
+ "inheritedFrom": {
5911
+ "name": "FormfieldWrapper",
5912
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5913
+ }
5914
+ }
5915
+ ],
5916
+ "mixins": [
5917
+ {
5918
+ "name": "NameMixin",
5919
+ "module": "/src/utils/mixins/NameMixin"
5920
+ },
5921
+ {
5922
+ "name": "ValueMixin",
5923
+ "module": "/src/utils/mixins/ValueMixin"
5524
5924
  },
5925
+ {
5926
+ "name": "DataAriaLabelMixin",
5927
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
5928
+ }
5929
+ ],
5930
+ "superclass": {
5931
+ "name": "FormfieldWrapper",
5932
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
5933
+ },
5934
+ "tagName": "mdc-radio",
5935
+ "jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-radio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-radio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-radio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-radio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-radio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n */",
5936
+ "customElement": true,
5937
+ "slots": [
5938
+ {
5939
+ "description": "slot to add the label info icon",
5940
+ "name": "label-info",
5941
+ "inheritedFrom": {
5942
+ "name": "FormfieldWrapper",
5943
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
5944
+ }
5945
+ }
5946
+ ]
5947
+ }
5948
+ ],
5949
+ "exports": [
5950
+ {
5951
+ "kind": "js",
5952
+ "name": "default",
5953
+ "declaration": {
5954
+ "name": "Radio",
5955
+ "module": "components/radio/radio.component.js"
5956
+ }
5957
+ }
5958
+ ]
5959
+ },
5960
+ {
5961
+ "kind": "javascript-module",
5962
+ "path": "components/radiogroup/radiogroup.component.js",
5963
+ "declarations": [
5964
+ {
5965
+ "kind": "class",
5966
+ "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
5967
+ "name": "RadioGroup",
5968
+ "cssProperties": [
5969
+ {
5970
+ "description": "color of the description text",
5971
+ "name": "--mdc-radiogroup-description-text-normal"
5972
+ }
5973
+ ],
5974
+ "members": [
5525
5975
  {
5526
5976
  "kind": "field",
5527
5977
  "name": "name",
@@ -5537,21 +5987,6 @@
5537
5987
  "module": "utils/mixins/NameMixin.js"
5538
5988
  }
5539
5989
  },
5540
- {
5541
- "kind": "field",
5542
- "name": "value",
5543
- "type": {
5544
- "text": "string"
5545
- },
5546
- "default": "''",
5547
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
5548
- "attribute": "value",
5549
- "reflects": true,
5550
- "inheritedFrom": {
5551
- "name": "ValueMixin",
5552
- "module": "utils/mixins/ValueMixin.js"
5553
- }
5554
- },
5555
5990
  {
5556
5991
  "kind": "field",
5557
5992
  "name": "dataAriaLabel",
@@ -5569,14 +6004,13 @@
5569
6004
  },
5570
6005
  {
5571
6006
  "kind": "field",
5572
- "name": "disabled",
6007
+ "name": "id",
5573
6008
  "type": {
5574
- "text": "boolean"
6009
+ "text": "string"
5575
6010
  },
5576
- "default": "false",
5577
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
5578
- "attribute": "disabled",
5579
- "reflects": true,
6011
+ "default": "''",
6012
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
6013
+ "attribute": "id",
5580
6014
  "inheritedFrom": {
5581
6015
  "name": "FormfieldWrapper",
5582
6016
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
@@ -5584,13 +6018,14 @@
5584
6018
  },
5585
6019
  {
5586
6020
  "kind": "field",
5587
- "name": "label",
6021
+ "name": "helpTextType",
5588
6022
  "type": {
5589
- "text": "string | undefined"
6023
+ "text": "ValidationType"
5590
6024
  },
5591
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
5592
- "attribute": "label",
6025
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6026
+ "attribute": "help-text-type",
5593
6027
  "reflects": true,
6028
+ "default": "undefined as unknown",
5594
6029
  "inheritedFrom": {
5595
6030
  "name": "FormfieldWrapper",
5596
6031
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
@@ -5598,12 +6033,13 @@
5598
6033
  },
5599
6034
  {
5600
6035
  "kind": "field",
5601
- "name": "requiredLabel",
6036
+ "name": "disabled",
5602
6037
  "type": {
5603
- "text": "string | undefined"
6038
+ "text": "boolean"
5604
6039
  },
5605
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
5606
- "attribute": "required-label",
6040
+ "default": "undefined as unknown",
6041
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6042
+ "attribute": "disabled",
5607
6043
  "reflects": true,
5608
6044
  "inheritedFrom": {
5609
6045
  "name": "FormfieldWrapper",
@@ -5612,10 +6048,13 @@
5612
6048
  },
5613
6049
  {
5614
6050
  "kind": "field",
5615
- "name": "id",
5616
- "default": "`mdc-input-${uuidv4()}`",
5617
- "description": "The unique id of the input field. It is used to link the input field with the label.",
5618
- "attribute": "id",
6051
+ "name": "label",
6052
+ "type": {
6053
+ "text": "string | undefined"
6054
+ },
6055
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6056
+ "attribute": "label",
6057
+ "reflects": true,
5619
6058
  "inheritedFrom": {
5620
6059
  "name": "FormfieldWrapper",
5621
6060
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
@@ -5623,12 +6062,12 @@
5623
6062
  },
5624
6063
  {
5625
6064
  "kind": "field",
5626
- "name": "helpTextType",
6065
+ "name": "requiredLabel",
5627
6066
  "type": {
5628
- "text": "ValidationType"
6067
+ "text": "string | undefined"
5629
6068
  },
5630
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
5631
- "attribute": "help-text-type",
6069
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6070
+ "attribute": "required-label",
5632
6071
  "reflects": true,
5633
6072
  "inheritedFrom": {
5634
6073
  "name": "FormfieldWrapper",
@@ -5734,44 +6173,20 @@
5734
6173
  }
5735
6174
  }
5736
6175
  ],
5737
- "events": [
5738
- {
5739
- "type": {
5740
- "text": "EventConstructor"
5741
- }
5742
- },
5743
- {
5744
- "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
5745
- "name": "change",
5746
- "reactName": "onChange",
5747
- "eventName": "ChangeEvent"
5748
- },
6176
+ "mixins": [
5749
6177
  {
5750
- "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
5751
- "name": "focus",
5752
- "reactName": "onFocus",
5753
- "eventName": "FocusEvent"
6178
+ "name": "NameMixin",
6179
+ "module": "/src/utils/mixins/NameMixin"
5754
6180
  }
5755
6181
  ],
6182
+ "superclass": {
6183
+ "name": "FormfieldGroup",
6184
+ "module": "/src/components/formfieldgroup"
6185
+ },
6186
+ "tagName": "mdc-radiogroup",
6187
+ "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
6188
+ "customElement": true,
5756
6189
  "attributes": [
5757
- {
5758
- "name": "checked",
5759
- "type": {
5760
- "text": "boolean"
5761
- },
5762
- "default": "false",
5763
- "description": "Determines whether the radio is selected or unselected.",
5764
- "fieldName": "checked"
5765
- },
5766
- {
5767
- "name": "readonly",
5768
- "type": {
5769
- "text": "boolean"
5770
- },
5771
- "default": "false",
5772
- "description": "Determines whether the radio is read-only.",
5773
- "fieldName": "readonly"
5774
- },
5775
6190
  {
5776
6191
  "name": "name",
5777
6192
  "type": {
@@ -5785,19 +6200,6 @@
5785
6200
  "module": "src/utils/mixins/NameMixin.ts"
5786
6201
  }
5787
6202
  },
5788
- {
5789
- "name": "value",
5790
- "type": {
5791
- "text": "string"
5792
- },
5793
- "default": "''",
5794
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
5795
- "fieldName": "value",
5796
- "inheritedFrom": {
5797
- "name": "ValueMixin",
5798
- "module": "src/utils/mixins/ValueMixin.ts"
5799
- }
5800
- },
5801
6203
  {
5802
6204
  "name": "data-aria-label",
5803
6205
  "type": {
@@ -5850,7 +6252,10 @@
5850
6252
  },
5851
6253
  {
5852
6254
  "name": "id",
5853
- "default": "`mdc-input-${uuidv4()}`",
6255
+ "type": {
6256
+ "text": "string"
6257
+ },
6258
+ "default": "''",
5854
6259
  "description": "The unique id of the input field. It is used to link the input field with the label.",
5855
6260
  "fieldName": "id",
5856
6261
  "inheritedFrom": {
@@ -5883,28 +6288,15 @@
5883
6288
  }
5884
6289
  }
5885
6290
  ],
5886
- "mixins": [
5887
- {
5888
- "name": "NameMixin",
5889
- "module": "/src/utils/mixins/NameMixin"
5890
- },
6291
+ "slots": [
5891
6292
  {
5892
- "name": "ValueMixin",
5893
- "module": "/src/utils/mixins/ValueMixin"
6293
+ "description": "This is a default slot for checkbox or toggle components.",
6294
+ "name": "default",
6295
+ "inheritedFrom": {
6296
+ "name": "FormfieldGroup",
6297
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
6298
+ }
5894
6299
  },
5895
- {
5896
- "name": "DataAriaLabelMixin",
5897
- "module": "/src/utils/mixins/DataAriaLabelMixin"
5898
- }
5899
- ],
5900
- "superclass": {
5901
- "name": "FormfieldWrapper",
5902
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
5903
- },
5904
- "tagName": "mdc-radio",
5905
- "jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-radio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-radio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-radio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-radio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-radio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n */",
5906
- "customElement": true,
5907
- "slots": [
5908
6300
  {
5909
6301
  "description": "slot to add the label info icon",
5910
6302
  "name": "label-info",
@@ -5921,8 +6313,8 @@
5921
6313
  "kind": "js",
5922
6314
  "name": "default",
5923
6315
  "declaration": {
5924
- "name": "Radio",
5925
- "module": "components/radio/radio.component.js"
6316
+ "name": "RadioGroup",
6317
+ "module": "components/radiogroup/radiogroup.component.js"
5926
6318
  }
5927
6319
  }
5928
6320
  ]
@@ -7115,6 +7507,20 @@
7115
7507
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7116
7508
  }
7117
7509
  },
7510
+ {
7511
+ "kind": "field",
7512
+ "name": "id",
7513
+ "type": {
7514
+ "text": "string"
7515
+ },
7516
+ "default": "`mdc-input-${uuidv4()}`",
7517
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
7518
+ "attribute": "id",
7519
+ "inheritedFrom": {
7520
+ "name": "FormfieldWrapper",
7521
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7522
+ }
7523
+ },
7118
7524
  {
7119
7525
  "kind": "field",
7120
7526
  "name": "name",
@@ -7203,17 +7609,6 @@
7203
7609
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7204
7610
  }
7205
7611
  },
7206
- {
7207
- "kind": "field",
7208
- "name": "id",
7209
- "default": "`mdc-input-${uuidv4()}`",
7210
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7211
- "attribute": "id",
7212
- "inheritedFrom": {
7213
- "name": "FormfieldWrapper",
7214
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7215
- }
7216
- },
7217
7612
  {
7218
7613
  "kind": "field",
7219
7614
  "name": "helpText",
@@ -7429,7 +7824,10 @@
7429
7824
  },
7430
7825
  {
7431
7826
  "name": "id",
7432
- "default": "`mdc-input-${uuidv4()}`",
7827
+ "type": {
7828
+ "text": "string"
7829
+ },
7830
+ "default": "''",
7433
7831
  "description": "The unique id of the input field. It is used to link the input field with the label.",
7434
7832
  "fieldName": "id",
7435
7833
  "inheritedFrom": {