@viasat/beam-web-components 2.48.1 → 2.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@viasat/beam-web-components",
3
- "version": "2.48.1",
3
+ "version": "2.49.0",
4
4
  "description": "Framework-agnostic web components for the Beam Design System built with Lit, compatible with Angular, Vue, Svelte, and vanilla JavaScript",
5
5
  "license": "MIT",
6
6
  "author": "Viasat",
@@ -64,11 +64,11 @@
64
64
  "access": "public"
65
65
  },
66
66
  "dependencies": {
67
- "@viasat/beam-fonts": "2.48.1",
68
- "@viasat/beam-shared": "2.48.1",
69
- "@viasat/beam-styles": "2.48.1",
70
- "@viasat/beam-tokens": "2.48.1",
71
- "@viasat/beam-icons": "2.48.1",
67
+ "@viasat/beam-fonts": "2.49.0",
68
+ "@viasat/beam-shared": "2.49.0",
69
+ "@viasat/beam-styles": "2.49.0",
70
+ "@viasat/beam-tokens": "2.49.0",
71
+ "@viasat/beam-icons": "2.49.0",
72
72
  "clsx": "^1.2.1",
73
73
  "lit": "^3.1.0",
74
74
  "@lit/context": "^1.1.1",
@@ -61,6 +61,104 @@
61
61
  }
62
62
  ]
63
63
  },
64
+ {
65
+ "name": "bm-avatar",
66
+ "description": "`bm-avatar`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Avatar\n- **name** - Specify a name to display initials in the Avatar\n- **src** - Pass an image to the Avatar\n- **alt** - Specify alt for image\n- **size** - Specify the size of the Avatar\n- **disabled** - Specify if the Avatar is disabled\n- **shape** - Specify the shape of the Avatar\n- **isInteractive** - If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer\n- **isFocusable** - If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable\n- **withBorder** \n---\n\n\n### **Slots:**\n - **icon** - Customize the default icon",
67
+ "attributes": [
68
+ {
69
+ "name": "appearance",
70
+ "description": "Specify the appearance of the Avatar",
71
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
72
+ },
73
+ {
74
+ "name": "name",
75
+ "description": "Specify a name to display initials in the Avatar",
76
+ "values": []
77
+ },
78
+ {
79
+ "name": "src",
80
+ "description": "Pass an image to the Avatar",
81
+ "values": []
82
+ },
83
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
84
+ {
85
+ "name": "size",
86
+ "description": "Specify the size of the Avatar",
87
+ "values": [
88
+ { "name": "xs" },
89
+ { "name": "sm" },
90
+ { "name": "md" },
91
+ { "name": "lg" },
92
+ { "name": "xl" }
93
+ ]
94
+ },
95
+ {
96
+ "name": "disabled",
97
+ "description": "Specify if the Avatar is disabled",
98
+ "values": []
99
+ },
100
+ {
101
+ "name": "shape",
102
+ "description": "Specify the shape of the Avatar",
103
+ "values": [{ "name": "circle" }, { "name": "square" }]
104
+ },
105
+ {
106
+ "name": "isInteractive",
107
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
108
+ "values": []
109
+ },
110
+ {
111
+ "name": "isFocusable",
112
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
113
+ "values": []
114
+ },
115
+ { "name": "withBorder", "values": [] }
116
+ ],
117
+ "references": [
118
+ {
119
+ "name": "Storybook",
120
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
121
+ }
122
+ ]
123
+ },
124
+ {
125
+ "name": "bm-avatar-group",
126
+ "description": "`bm-avatar-group`\n\n### Attributes:\n- **wrapping** - Specify if the AvatarGroup wraps\n- **maxCount** - Specify the max number of avatars displayed in the group.\n- **size** - Specify the size of all Avatars\n- **layout** - Specify the kind of the group.\n---\n\n\n### **Slots:**\n - **default** - Add Avatars to create a group",
127
+ "attributes": [
128
+ {
129
+ "name": "wrapping",
130
+ "description": "Specify if the AvatarGroup wraps",
131
+ "values": []
132
+ },
133
+ {
134
+ "name": "maxCount",
135
+ "description": "Specify the max number of avatars displayed in the group.",
136
+ "values": []
137
+ },
138
+ {
139
+ "name": "size",
140
+ "description": "Specify the size of all Avatars",
141
+ "values": [
142
+ { "name": "xs" },
143
+ { "name": "sm" },
144
+ { "name": "md" },
145
+ { "name": "lg" },
146
+ { "name": "xl" }
147
+ ]
148
+ },
149
+ {
150
+ "name": "layout",
151
+ "description": "Specify the kind of the group.",
152
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
153
+ }
154
+ ],
155
+ "references": [
156
+ {
157
+ "name": "Storybook",
158
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
159
+ }
160
+ ]
161
+ },
64
162
  {
65
163
  "name": "bm-alert",
66
164
  "description": "`bm-alert`\n\n### Attributes:\n- **heading** - Specify the heading text for Alert\n- **body** - Specify the body text for Alert\n- **size** - Specify the size of the Alert\n- **fullWidth** - Specify if the Alert has no border radius\n- **theme** - Specify the theme of the Alert. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the Alert\n- **hidden** - Specify if the Alert is hidden\n- **hideIcon** - Specify if the icon displays on the Alert\n- **dismissible** - Specify if the Alert can be dismissed\n- **disableAutoFocus** - Prevent autofocus on show\n- **disableCloseOnEscape** - Prevent Escape from closing\n---\n\n\n### **Events:**\n - **bm-dismiss** - Dispatched when the Alert has been dismissed\n\n### **Slots:**\n - **icon** - Specify a different icon for the Alert\n- **heading** - Specify the heading text for Alert or pass the `heading` attribute to set the heading\n- **body** - Specify the body text for Alert or pass the `body` attribute to set the body\n- **actions** - Specify if actions display on the Alert",
@@ -215,165 +313,6 @@
215
313
  }
216
314
  ]
217
315
  },
218
- {
219
- "name": "bm-avatar",
220
- "description": "`bm-avatar`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Avatar\n- **name** - Specify a name to display initials in the Avatar\n- **src** - Pass an image to the Avatar\n- **alt** - Specify alt for image\n- **size** - Specify the size of the Avatar\n- **disabled** - Specify if the Avatar is disabled\n- **shape** - Specify the shape of the Avatar\n- **isInteractive** - If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer\n- **isFocusable** - If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable\n- **withBorder** \n---\n\n\n### **Slots:**\n - **icon** - Customize the default icon",
221
- "attributes": [
222
- {
223
- "name": "appearance",
224
- "description": "Specify the appearance of the Avatar",
225
- "values": [{ "name": "accent" }, { "name": "neutral" }]
226
- },
227
- {
228
- "name": "name",
229
- "description": "Specify a name to display initials in the Avatar",
230
- "values": []
231
- },
232
- {
233
- "name": "src",
234
- "description": "Pass an image to the Avatar",
235
- "values": []
236
- },
237
- { "name": "alt", "description": "Specify alt for image", "values": [] },
238
- {
239
- "name": "size",
240
- "description": "Specify the size of the Avatar",
241
- "values": [
242
- { "name": "xs" },
243
- { "name": "sm" },
244
- { "name": "md" },
245
- { "name": "lg" },
246
- { "name": "xl" }
247
- ]
248
- },
249
- {
250
- "name": "disabled",
251
- "description": "Specify if the Avatar is disabled",
252
- "values": []
253
- },
254
- {
255
- "name": "shape",
256
- "description": "Specify the shape of the Avatar",
257
- "values": [{ "name": "circle" }, { "name": "square" }]
258
- },
259
- {
260
- "name": "isInteractive",
261
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
262
- "values": []
263
- },
264
- {
265
- "name": "isFocusable",
266
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
267
- "values": []
268
- },
269
- { "name": "withBorder", "values": [] }
270
- ],
271
- "references": [
272
- {
273
- "name": "Storybook",
274
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
275
- }
276
- ]
277
- },
278
- {
279
- "name": "bm-avatar-group",
280
- "description": "`bm-avatar-group`\n\n### Attributes:\n- **wrapping** - Specify if the AvatarGroup wraps\n- **maxCount** - Specify the max number of avatars displayed in the group.\n- **size** - Specify the size of all Avatars\n- **layout** - Specify the kind of the group.\n---\n\n\n### **Slots:**\n - **default** - Add Avatars to create a group",
281
- "attributes": [
282
- {
283
- "name": "wrapping",
284
- "description": "Specify if the AvatarGroup wraps",
285
- "values": []
286
- },
287
- {
288
- "name": "maxCount",
289
- "description": "Specify the max number of avatars displayed in the group.",
290
- "values": []
291
- },
292
- {
293
- "name": "size",
294
- "description": "Specify the size of all Avatars",
295
- "values": [
296
- { "name": "xs" },
297
- { "name": "sm" },
298
- { "name": "md" },
299
- { "name": "lg" },
300
- { "name": "xl" }
301
- ]
302
- },
303
- {
304
- "name": "layout",
305
- "description": "Specify the kind of the group.",
306
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
307
- }
308
- ],
309
- "references": [
310
- {
311
- "name": "Storybook",
312
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
313
- }
314
- ]
315
- },
316
- {
317
- "name": "bm-breadcrumb",
318
- "description": "`bm-breadcrumb`\n\n### Attributes:\n- **wrap** - Specify if items wrap or collapse to an ellipsis\n- **itemsBeforeCollapse** - Specify how many items show before ellipsis\n- **itemsAfterCollapse** - Specify how many items show after ellipsis\n- **theme** - Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent\n---\n\n\n### **Slots:**\n - **default** - Pass items to the Breadcrumb",
319
- "attributes": [
320
- {
321
- "name": "wrap",
322
- "description": "Specify if items wrap or collapse to an ellipsis",
323
- "values": []
324
- },
325
- {
326
- "name": "itemsBeforeCollapse",
327
- "description": "Specify how many items show before ellipsis",
328
- "values": []
329
- },
330
- {
331
- "name": "itemsAfterCollapse",
332
- "description": "Specify how many items show after ellipsis",
333
- "values": []
334
- },
335
- {
336
- "name": "theme",
337
- "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
338
- "values": [{ "name": "light" }, { "name": "dark" }]
339
- }
340
- ],
341
- "references": [
342
- {
343
- "name": "Storybook",
344
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
345
- }
346
- ]
347
- },
348
- {
349
- "name": "bm-breadcrumb-item",
350
- "description": "`bm-breadcrumb-item`\n\n### Attributes:\n- **href** - Pass href to an item\n- **clickable** - Specify if the item is interactive without an href\n- **truncationWidth** - Specify truncation width of the items. Sets max-width for all items but the last.\n- **isCurrent** - Specify explicitly if the item is the last one\n- **isCollapsed** \n---\n\n\n### **Slots:**\n - **default** - Pass text to an item\n- **icon** - Pass icon to an item",
351
- "attributes": [
352
- { "name": "href", "description": "Pass href to an item", "values": [] },
353
- {
354
- "name": "clickable",
355
- "description": "Specify if the item is interactive without an href",
356
- "values": []
357
- },
358
- {
359
- "name": "truncationWidth",
360
- "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
361
- "values": []
362
- },
363
- {
364
- "name": "isCurrent",
365
- "description": "Specify explicitly if the item is the last one",
366
- "values": []
367
- },
368
- { "name": "isCollapsed", "values": [] }
369
- ],
370
- "references": [
371
- {
372
- "name": "Storybook",
373
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
374
- }
375
- ]
376
- },
377
316
  {
378
317
  "name": "bm-box",
379
318
  "description": "`bm-box`\n\n### Attributes:\n- **backgroundColor** - Specify the background color of a Box\n- **borderColor** - Specify the border color of a Box\n- **borderWidth** - Specify the border width of a Box\n- **borderRadius** - Specify the border radius of a Box\n- **px** - Specify before and after padding of a Box\n- **py** - Specify top and bottom padding of a Box\n- **pTop** - Specify top padding of a Box\n- **pBottom** - Specify bottom padding of a Box\n- **pBefore** - Specify before padding of a Box\n- **pAfter** - Specify after padding of a Box\n- **mx** - Specify before and after margin of a Box\n- **my** - Specify top and bottom margin of a Box\n- **mTop** - Specify top margin of a Box\n- **mBottom** - Specify bottom margin of a Box\n- **mBefore** - Specify before margin of a Box\n- **mAfter** - Specify after margin of a Box\n- **m** - Specify all margin\n- **p** - Specify all padding\n- **gap** - Specify gap between child elements\n- **shadow** - Specify if a Box has a shadow\n---\n\n\n### **Slots:**\n - **default** - Provide content for the Box",
@@ -777,6 +716,67 @@
777
716
  }
778
717
  ]
779
718
  },
719
+ {
720
+ "name": "bm-breadcrumb",
721
+ "description": "`bm-breadcrumb`\n\n### Attributes:\n- **wrap** - Specify if items wrap or collapse to an ellipsis\n- **itemsBeforeCollapse** - Specify how many items show before ellipsis\n- **itemsAfterCollapse** - Specify how many items show after ellipsis\n- **theme** - Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent\n---\n\n\n### **Slots:**\n - **default** - Pass items to the Breadcrumb",
722
+ "attributes": [
723
+ {
724
+ "name": "wrap",
725
+ "description": "Specify if items wrap or collapse to an ellipsis",
726
+ "values": []
727
+ },
728
+ {
729
+ "name": "itemsBeforeCollapse",
730
+ "description": "Specify how many items show before ellipsis",
731
+ "values": []
732
+ },
733
+ {
734
+ "name": "itemsAfterCollapse",
735
+ "description": "Specify how many items show after ellipsis",
736
+ "values": []
737
+ },
738
+ {
739
+ "name": "theme",
740
+ "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
741
+ "values": [{ "name": "light" }, { "name": "dark" }]
742
+ }
743
+ ],
744
+ "references": [
745
+ {
746
+ "name": "Storybook",
747
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
748
+ }
749
+ ]
750
+ },
751
+ {
752
+ "name": "bm-breadcrumb-item",
753
+ "description": "`bm-breadcrumb-item`\n\n### Attributes:\n- **href** - Pass href to an item\n- **clickable** - Specify if the item is interactive without an href\n- **truncationWidth** - Specify truncation width of the items. Sets max-width for all items but the last.\n- **isCurrent** - Specify explicitly if the item is the last one\n- **isCollapsed** \n---\n\n\n### **Slots:**\n - **default** - Pass text to an item\n- **icon** - Pass icon to an item",
754
+ "attributes": [
755
+ { "name": "href", "description": "Pass href to an item", "values": [] },
756
+ {
757
+ "name": "clickable",
758
+ "description": "Specify if the item is interactive without an href",
759
+ "values": []
760
+ },
761
+ {
762
+ "name": "truncationWidth",
763
+ "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
764
+ "values": []
765
+ },
766
+ {
767
+ "name": "isCurrent",
768
+ "description": "Specify explicitly if the item is the last one",
769
+ "values": []
770
+ },
771
+ { "name": "isCollapsed", "values": [] }
772
+ ],
773
+ "references": [
774
+ {
775
+ "name": "Storybook",
776
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
777
+ }
778
+ ]
779
+ },
780
780
  {
781
781
  "name": "bm-button",
782
782
  "description": "`bm-button`\n\n### Attributes:\n- **appearance** - Specify the appearance of a Button\n- **kind** - Specify the kind of Button\n- **size** - Specify the size of a Button\n- **disabled** - Specify if the Button is disabled\n- **fluid** - Specify if Button is fluid\n- **width** - Specify the width of a Button\n- **height** - Specify the height of a Button\n- **theme** - Specify the theme of the Button\n- **iconOnly** - Specify if the icon displays without text\n- **type** \n---\n\n\n### **Slots:**\n - **default** - Provide content for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
@@ -1909,51 +1909,6 @@
1909
1909
  }
1910
1910
  ]
1911
1911
  },
1912
- {
1913
- "name": "bm-form",
1914
- "description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
1915
- "attributes": [
1916
- {
1917
- "name": "validationMode",
1918
- "description": "Specify if validation runs on change or when loosing focus",
1919
- "values": [
1920
- { "name": "onChange" },
1921
- { "name": "onBlur" },
1922
- { "name": "onSubmit" }
1923
- ]
1924
- },
1925
- {
1926
- "name": "initialValues",
1927
- "description": "Specify initial values on Form controls based on their names",
1928
- "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
1929
- },
1930
- {
1931
- "name": "required",
1932
- "description": "Specify if input is a required",
1933
- "values": []
1934
- },
1935
- {
1936
- "name": "disabled",
1937
- "description": "Specify if input is a disabled",
1938
- "values": []
1939
- },
1940
- {
1941
- "name": "readOnly",
1942
- "description": "Specify if input is a read only",
1943
- "values": []
1944
- },
1945
- { "name": "action", "values": [] },
1946
- { "name": "method", "values": [] },
1947
- { "name": "target", "values": [] },
1948
- { "name": "enctype", "values": [] }
1949
- ],
1950
- "references": [
1951
- {
1952
- "name": "Storybook",
1953
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
1954
- }
1955
- ]
1956
- },
1957
1912
  {
1958
1913
  "name": "bm-file-upload-button",
1959
1914
  "description": "`bm-file-upload-button`\n\n### Attributes:\n- **error** - Specify if FileUpload is in error state\n- **accept** - Specify the accepted file types\n- **multiple** - Specify if multiple files can be uploaded\n---\n\n\n### **Slots:**\n - **default** - Specify text for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
@@ -2262,54 +2217,47 @@
2262
2217
  ]
2263
2218
  },
2264
2219
  {
2265
- "name": "bm-radio-button",
2266
- "description": "`bm-radio-button`\n\n### Attributes:\n- **label** - Specify the text for the label\n- **error** - Specify error text and display error state of a RadioButton\n- **readOnly** - Specify if RadioButton displays in a read-only state\n- **disabled** - Specify if RadioButton displays in a disabled state\n- **theme** - Specify the theme of the RadioButton. By default it inherits the theme from the parent\n- **value** - The value attribute for the input element\n- **checked** - The checked attribute for the input element\n- **onKeyDown** - A user-defined function to handle keydown events\n---\n",
2220
+ "name": "bm-form",
2221
+ "description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
2267
2222
  "attributes": [
2268
2223
  {
2269
- "name": "label",
2270
- "description": "Specify the text for the label",
2271
- "values": []
2224
+ "name": "validationMode",
2225
+ "description": "Specify if validation runs on change or when loosing focus",
2226
+ "values": [
2227
+ { "name": "onChange" },
2228
+ { "name": "onBlur" },
2229
+ { "name": "onSubmit" }
2230
+ ]
2272
2231
  },
2273
2232
  {
2274
- "name": "error",
2275
- "description": "Specify error text and display error state of a RadioButton",
2276
- "values": []
2233
+ "name": "initialValues",
2234
+ "description": "Specify initial values on Form controls based on their names",
2235
+ "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2277
2236
  },
2278
2237
  {
2279
- "name": "readOnly",
2280
- "description": "Specify if RadioButton displays in a read-only state",
2238
+ "name": "required",
2239
+ "description": "Specify if input is a required",
2281
2240
  "values": []
2282
2241
  },
2283
2242
  {
2284
2243
  "name": "disabled",
2285
- "description": "Specify if RadioButton displays in a disabled state",
2286
- "values": []
2287
- },
2288
- {
2289
- "name": "theme",
2290
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2291
- "values": [{ "name": "light" }, { "name": "dark" }]
2292
- },
2293
- {
2294
- "name": "value",
2295
- "description": "The value attribute for the input element",
2244
+ "description": "Specify if input is a disabled",
2296
2245
  "values": []
2297
2246
  },
2298
2247
  {
2299
- "name": "checked",
2300
- "description": "The checked attribute for the input element",
2248
+ "name": "readOnly",
2249
+ "description": "Specify if input is a read only",
2301
2250
  "values": []
2302
2251
  },
2303
- {
2304
- "name": "onKeyDown",
2305
- "description": "A user-defined function to handle keydown events",
2306
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2307
- }
2252
+ { "name": "action", "values": [] },
2253
+ { "name": "method", "values": [] },
2254
+ { "name": "target", "values": [] },
2255
+ { "name": "enctype", "values": [] }
2308
2256
  ],
2309
2257
  "references": [
2310
2258
  {
2311
2259
  "name": "Storybook",
2312
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2260
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2313
2261
  }
2314
2262
  ]
2315
2263
  },
@@ -2383,6 +2331,49 @@
2383
2331
  }
2384
2332
  ]
2385
2333
  },
2334
+ {
2335
+ "name": "bm-switch",
2336
+ "description": "`bm-switch`\n\n### Attributes:\n- **onText** - Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.\n- **offText** - Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.\n- **textPosition** - Specify the position of the side label\n- **readOnly** - Specify if Switch displays in a read-only state\n- **disabled** - Specify if Switch displays in a disabled state\n- **checked** \n- **value** - The value attribute for the input element\n---\n\n\n### **Slots:**\n - **onText** - Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.\n- **offText** - Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2337
+ "attributes": [
2338
+ {
2339
+ "name": "onText",
2340
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2341
+ "values": []
2342
+ },
2343
+ {
2344
+ "name": "offText",
2345
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2346
+ "values": []
2347
+ },
2348
+ {
2349
+ "name": "textPosition",
2350
+ "description": "Specify the position of the side label",
2351
+ "values": [{ "name": "before" }, { "name": "after" }]
2352
+ },
2353
+ {
2354
+ "name": "readOnly",
2355
+ "description": "Specify if Switch displays in a read-only state",
2356
+ "values": []
2357
+ },
2358
+ {
2359
+ "name": "disabled",
2360
+ "description": "Specify if Switch displays in a disabled state",
2361
+ "values": []
2362
+ },
2363
+ { "name": "checked", "values": [] },
2364
+ {
2365
+ "name": "value",
2366
+ "description": "The value attribute for the input element",
2367
+ "values": []
2368
+ }
2369
+ ],
2370
+ "references": [
2371
+ {
2372
+ "name": "Storybook",
2373
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2374
+ }
2375
+ ]
2376
+ },
2386
2377
  {
2387
2378
  "name": "bm-text-area",
2388
2379
  "description": "`bm-text-area`\n---\n\n\n### **Slots:**\n - **label** - Specify the label for TextArea\n- **helper-text** - Specify the helper text for TextArea",
@@ -2474,45 +2465,54 @@
2474
2465
  ]
2475
2466
  },
2476
2467
  {
2477
- "name": "bm-switch",
2478
- "description": "`bm-switch`\n\n### Attributes:\n- **onText** - Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.\n- **offText** - Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.\n- **textPosition** - Specify the position of the side label\n- **readOnly** - Specify if Switch displays in a read-only state\n- **disabled** - Specify if Switch displays in a disabled state\n- **checked** \n- **value** - The value attribute for the input element\n---\n\n\n### **Slots:**\n - **onText** - Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.\n- **offText** - Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2468
+ "name": "bm-radio-button",
2469
+ "description": "`bm-radio-button`\n\n### Attributes:\n- **label** - Specify the text for the label\n- **error** - Specify error text and display error state of a RadioButton\n- **readOnly** - Specify if RadioButton displays in a read-only state\n- **disabled** - Specify if RadioButton displays in a disabled state\n- **theme** - Specify the theme of the RadioButton. By default it inherits the theme from the parent\n- **value** - The value attribute for the input element\n- **checked** - The checked attribute for the input element\n- **onKeyDown** - A user-defined function to handle keydown events\n---\n",
2479
2470
  "attributes": [
2480
2471
  {
2481
- "name": "onText",
2482
- "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2472
+ "name": "label",
2473
+ "description": "Specify the text for the label",
2483
2474
  "values": []
2484
2475
  },
2485
2476
  {
2486
- "name": "offText",
2487
- "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2477
+ "name": "error",
2478
+ "description": "Specify error text and display error state of a RadioButton",
2488
2479
  "values": []
2489
2480
  },
2490
- {
2491
- "name": "textPosition",
2492
- "description": "Specify the position of the side label",
2493
- "values": [{ "name": "before" }, { "name": "after" }]
2494
- },
2495
2481
  {
2496
2482
  "name": "readOnly",
2497
- "description": "Specify if Switch displays in a read-only state",
2483
+ "description": "Specify if RadioButton displays in a read-only state",
2498
2484
  "values": []
2499
2485
  },
2500
2486
  {
2501
2487
  "name": "disabled",
2502
- "description": "Specify if Switch displays in a disabled state",
2488
+ "description": "Specify if RadioButton displays in a disabled state",
2503
2489
  "values": []
2504
2490
  },
2505
- { "name": "checked", "values": [] },
2491
+ {
2492
+ "name": "theme",
2493
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2494
+ "values": [{ "name": "light" }, { "name": "dark" }]
2495
+ },
2506
2496
  {
2507
2497
  "name": "value",
2508
2498
  "description": "The value attribute for the input element",
2509
2499
  "values": []
2500
+ },
2501
+ {
2502
+ "name": "checked",
2503
+ "description": "The checked attribute for the input element",
2504
+ "values": []
2505
+ },
2506
+ {
2507
+ "name": "onKeyDown",
2508
+ "description": "A user-defined function to handle keydown events",
2509
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2510
2510
  }
2511
2511
  ],
2512
2512
  "references": [
2513
2513
  {
2514
2514
  "name": "Storybook",
2515
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2515
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2516
2516
  }
2517
2517
  ]
2518
2518
  },
@@ -2586,8 +2586,8 @@
2586
2586
  ]
2587
2587
  },
2588
2588
  {
2589
- "name": "bm-radio-button-group",
2590
- "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
2589
+ "name": "bm-switch-group",
2590
+ "description": "`bm-switch-group`\n---\n\n\n### **Slots:**\n - **label** - Slot for the label of the SwitchGroup\n- **helperText** - Slot for the helper text of the SwitchGroup",
2591
2591
  "attributes": [
2592
2592
  {
2593
2593
  "name": "theme",
@@ -2650,13 +2650,13 @@
2650
2650
  "references": [
2651
2651
  {
2652
2652
  "name": "Storybook",
2653
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2653
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2654
2654
  }
2655
2655
  ]
2656
2656
  },
2657
2657
  {
2658
- "name": "bm-switch-group",
2659
- "description": "`bm-switch-group`\n---\n\n\n### **Slots:**\n - **label** - Slot for the label of the SwitchGroup\n- **helperText** - Slot for the helper text of the SwitchGroup",
2658
+ "name": "bm-radio-button-group",
2659
+ "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
2660
2660
  "attributes": [
2661
2661
  {
2662
2662
  "name": "theme",
@@ -2719,7 +2719,7 @@
2719
2719
  "references": [
2720
2720
  {
2721
2721
  "name": "Storybook",
2722
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2722
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2723
2723
  }
2724
2724
  ]
2725
2725
  }