@viasat/beam-web-components 2.40.0 → 2.41.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.
@@ -215,6 +215,165 @@
215
215
  }
216
216
  ]
217
217
  },
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
+ },
218
377
  {
219
378
  "name": "bm-box",
220
379
  "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",
@@ -618,165 +777,6 @@
618
777
  }
619
778
  ]
620
779
  },
621
- {
622
- "name": "bm-avatar",
623
- "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",
624
- "attributes": [
625
- {
626
- "name": "appearance",
627
- "description": "Specify the appearance of the Avatar",
628
- "values": [{ "name": "accent" }, { "name": "neutral" }]
629
- },
630
- {
631
- "name": "name",
632
- "description": "Specify a name to display initials in the Avatar",
633
- "values": []
634
- },
635
- {
636
- "name": "src",
637
- "description": "Pass an image to the Avatar",
638
- "values": []
639
- },
640
- { "name": "alt", "description": "Specify alt for image", "values": [] },
641
- {
642
- "name": "size",
643
- "description": "Specify the size of the Avatar",
644
- "values": [
645
- { "name": "xs" },
646
- { "name": "sm" },
647
- { "name": "md" },
648
- { "name": "lg" },
649
- { "name": "xl" }
650
- ]
651
- },
652
- {
653
- "name": "disabled",
654
- "description": "Specify if the Avatar is disabled",
655
- "values": []
656
- },
657
- {
658
- "name": "shape",
659
- "description": "Specify the shape of the Avatar",
660
- "values": [{ "name": "circle" }, { "name": "square" }]
661
- },
662
- {
663
- "name": "isInteractive",
664
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
665
- "values": []
666
- },
667
- {
668
- "name": "isFocusable",
669
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
670
- "values": []
671
- },
672
- { "name": "withBorder", "values": [] }
673
- ],
674
- "references": [
675
- {
676
- "name": "Storybook",
677
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
678
- }
679
- ]
680
- },
681
- {
682
- "name": "bm-avatar-group",
683
- "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",
684
- "attributes": [
685
- {
686
- "name": "wrapping",
687
- "description": "Specify if the AvatarGroup wraps",
688
- "values": []
689
- },
690
- {
691
- "name": "maxCount",
692
- "description": "Specify the max number of avatars displayed in the group.",
693
- "values": []
694
- },
695
- {
696
- "name": "size",
697
- "description": "Specify the size of all Avatars",
698
- "values": [
699
- { "name": "xs" },
700
- { "name": "sm" },
701
- { "name": "md" },
702
- { "name": "lg" },
703
- { "name": "xl" }
704
- ]
705
- },
706
- {
707
- "name": "layout",
708
- "description": "Specify the kind of the group.",
709
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
710
- }
711
- ],
712
- "references": [
713
- {
714
- "name": "Storybook",
715
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
716
- }
717
- ]
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",
@@ -1868,202 +1868,44 @@
1868
1868
  },
1869
1869
  {
1870
1870
  "name": "name",
1871
- "description": "Specify the checkbox name",
1872
- "values": []
1873
- },
1874
- {
1875
- "name": "value",
1876
- "description": "Specify the checkbox value",
1877
- "values": []
1878
- },
1879
- {
1880
- "name": "error",
1881
- "description": "Specify error text and display error state of a Checkbox",
1882
- "values": []
1883
- },
1884
- {
1885
- "name": "readOnly",
1886
- "description": "Specify if Checkbox displays in a read-only state",
1887
- "values": []
1888
- },
1889
- {
1890
- "name": "indeterminate",
1891
- "description": "Specify if Checkbox displays in an indeterminate state",
1892
- "values": []
1893
- },
1894
- {
1895
- "name": "disabled",
1896
- "description": "Specify if Checkbox displays in disabled state",
1897
- "values": []
1898
- },
1899
- {
1900
- "name": "checked",
1901
- "description": "Specify if Checkbox is checked",
1902
- "values": []
1903
- }
1904
- ],
1905
- "references": [
1906
- {
1907
- "name": "Storybook",
1908
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-checkbox"
1909
- }
1910
- ]
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
- {
1958
- "name": "bm-switch",
1959
- "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.",
1960
- "attributes": [
1961
- {
1962
- "name": "onText",
1963
- "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
1964
- "values": []
1965
- },
1966
- {
1967
- "name": "offText",
1968
- "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
1969
- "values": []
1970
- },
1971
- {
1972
- "name": "textPosition",
1973
- "description": "Specify the position of the side label",
1974
- "values": [{ "name": "before" }, { "name": "after" }]
1975
- },
1976
- {
1977
- "name": "readOnly",
1978
- "description": "Specify if Switch displays in a read-only state",
1979
- "values": []
1980
- },
1981
- {
1982
- "name": "disabled",
1983
- "description": "Specify if Switch displays in a disabled state",
1984
- "values": []
1985
- },
1986
- { "name": "checked", "values": [] },
1987
- {
1988
- "name": "value",
1989
- "description": "The value attribute for the input element",
1990
- "values": []
1991
- }
1992
- ],
1993
- "references": [
1994
- {
1995
- "name": "Storybook",
1996
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
1997
- }
1998
- ]
1999
- },
2000
- {
2001
- "name": "bm-native-select",
2002
- "description": "`bm-native-select`\n---\n\n\n### **Slots:**\n - **slot** - Specify Options for NativeSelect\n- **label** - Specify Label for NativeSelect\n- **helper-text** - Specify HelperText for NativeSelect",
2003
- "attributes": [
2004
- {
2005
- "name": "required",
2006
- "description": "Specify if NativeSelect is a required input",
2007
- "values": []
2008
- },
2009
- {
2010
- "name": "readOnly",
2011
- "description": "Specify if NativeSelect displays in a read-only state",
2012
- "values": []
2013
- },
2014
- {
2015
- "name": "disabled",
2016
- "description": "Specify if NativeSelect displays in a disabled state",
2017
- "values": []
2018
- },
2019
- {
2020
- "name": "error",
2021
- "description": "Specify error text and display error state of a NativeSelect",
2022
- "values": []
2023
- },
2024
- {
2025
- "name": "fluid",
2026
- "description": "Specify if NativeSelect is fluid",
1871
+ "description": "Specify the checkbox name",
2027
1872
  "values": []
2028
1873
  },
2029
1874
  {
2030
- "name": "size",
2031
- "description": "Specify the size of NativeSelect",
2032
- "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
1875
+ "name": "value",
1876
+ "description": "Specify the checkbox value",
1877
+ "values": []
2033
1878
  },
2034
1879
  {
2035
- "name": "width",
2036
- "description": "Specify the width of NativeSelect",
1880
+ "name": "error",
1881
+ "description": "Specify error text and display error state of a Checkbox",
2037
1882
  "values": []
2038
1883
  },
2039
1884
  {
2040
- "name": "ellipse",
2041
- "description": "Specify if overflow displays ellipsis",
1885
+ "name": "readOnly",
1886
+ "description": "Specify if Checkbox displays in a read-only state",
2042
1887
  "values": []
2043
1888
  },
2044
1889
  {
2045
- "name": "hideRequiredMarker",
2046
- "description": "Specify if the NativeSelect displays with an asterisk",
1890
+ "name": "indeterminate",
1891
+ "description": "Specify if Checkbox displays in an indeterminate state",
2047
1892
  "values": []
2048
1893
  },
2049
1894
  {
2050
- "name": "theme",
2051
- "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2052
- "values": [{ "name": "light" }, { "name": "dark" }]
1895
+ "name": "disabled",
1896
+ "description": "Specify if Checkbox displays in disabled state",
1897
+ "values": []
2053
1898
  },
2054
- { "name": "id", "values": [] },
2055
- { "name": "name", "values": [] },
2056
- { "name": "value", "values": [] },
2057
1899
  {
2058
- "name": "validationRules",
2059
- "values": [{ "name": "Array<FormValidator>" }]
2060
- },
2061
- { "name": "input-aria-label", "values": [] }
1900
+ "name": "checked",
1901
+ "description": "Specify if Checkbox is checked",
1902
+ "values": []
1903
+ }
2062
1904
  ],
2063
1905
  "references": [
2064
1906
  {
2065
1907
  "name": "Storybook",
2066
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
1908
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-checkbox"
2067
1909
  }
2068
1910
  ]
2069
1911
  },
@@ -2374,6 +2216,173 @@
2374
2216
  }
2375
2217
  ]
2376
2218
  },
2219
+ {
2220
+ "name": "bm-native-select",
2221
+ "description": "`bm-native-select`\n---\n\n\n### **Slots:**\n - **slot** - Specify Options for NativeSelect\n- **label** - Specify Label for NativeSelect\n- **helper-text** - Specify HelperText for NativeSelect",
2222
+ "attributes": [
2223
+ {
2224
+ "name": "required",
2225
+ "description": "Specify if NativeSelect is a required input",
2226
+ "values": []
2227
+ },
2228
+ {
2229
+ "name": "readOnly",
2230
+ "description": "Specify if NativeSelect displays in a read-only state",
2231
+ "values": []
2232
+ },
2233
+ {
2234
+ "name": "disabled",
2235
+ "description": "Specify if NativeSelect displays in a disabled state",
2236
+ "values": []
2237
+ },
2238
+ {
2239
+ "name": "error",
2240
+ "description": "Specify error text and display error state of a NativeSelect",
2241
+ "values": []
2242
+ },
2243
+ {
2244
+ "name": "fluid",
2245
+ "description": "Specify if NativeSelect is fluid",
2246
+ "values": []
2247
+ },
2248
+ {
2249
+ "name": "size",
2250
+ "description": "Specify the size of NativeSelect",
2251
+ "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2252
+ },
2253
+ {
2254
+ "name": "width",
2255
+ "description": "Specify the width of NativeSelect",
2256
+ "values": []
2257
+ },
2258
+ {
2259
+ "name": "ellipse",
2260
+ "description": "Specify if overflow displays ellipsis",
2261
+ "values": []
2262
+ },
2263
+ {
2264
+ "name": "hideRequiredMarker",
2265
+ "description": "Specify if the NativeSelect displays with an asterisk",
2266
+ "values": []
2267
+ },
2268
+ {
2269
+ "name": "theme",
2270
+ "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2271
+ "values": [{ "name": "light" }, { "name": "dark" }]
2272
+ },
2273
+ { "name": "id", "values": [] },
2274
+ { "name": "name", "values": [] },
2275
+ { "name": "value", "values": [] },
2276
+ {
2277
+ "name": "validationRules",
2278
+ "values": [{ "name": "Array<FormValidator>" }]
2279
+ },
2280
+ { "name": "input-aria-label", "values": [] }
2281
+ ],
2282
+ "references": [
2283
+ {
2284
+ "name": "Storybook",
2285
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
2286
+ }
2287
+ ]
2288
+ },
2289
+ {
2290
+ "name": "bm-form",
2291
+ "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",
2292
+ "attributes": [
2293
+ {
2294
+ "name": "validationMode",
2295
+ "description": "Specify if validation runs on change or when loosing focus",
2296
+ "values": [
2297
+ { "name": "onChange" },
2298
+ { "name": "onBlur" },
2299
+ { "name": "onSubmit" }
2300
+ ]
2301
+ },
2302
+ {
2303
+ "name": "initialValues",
2304
+ "description": "Specify initial values on Form controls based on their names",
2305
+ "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2306
+ },
2307
+ {
2308
+ "name": "required",
2309
+ "description": "Specify if input is a required",
2310
+ "values": []
2311
+ },
2312
+ {
2313
+ "name": "disabled",
2314
+ "description": "Specify if input is a disabled",
2315
+ "values": []
2316
+ },
2317
+ {
2318
+ "name": "readOnly",
2319
+ "description": "Specify if input is a read only",
2320
+ "values": []
2321
+ },
2322
+ { "name": "action", "values": [] },
2323
+ { "name": "method", "values": [] },
2324
+ { "name": "target", "values": [] },
2325
+ { "name": "enctype", "values": [] }
2326
+ ],
2327
+ "references": [
2328
+ {
2329
+ "name": "Storybook",
2330
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2331
+ }
2332
+ ]
2333
+ },
2334
+ {
2335
+ "name": "bm-radio-button",
2336
+ "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",
2337
+ "attributes": [
2338
+ {
2339
+ "name": "label",
2340
+ "description": "Specify the text for the label",
2341
+ "values": []
2342
+ },
2343
+ {
2344
+ "name": "error",
2345
+ "description": "Specify error text and display error state of a RadioButton",
2346
+ "values": []
2347
+ },
2348
+ {
2349
+ "name": "readOnly",
2350
+ "description": "Specify if RadioButton displays in a read-only state",
2351
+ "values": []
2352
+ },
2353
+ {
2354
+ "name": "disabled",
2355
+ "description": "Specify if RadioButton displays in a disabled state",
2356
+ "values": []
2357
+ },
2358
+ {
2359
+ "name": "theme",
2360
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2361
+ "values": [{ "name": "light" }, { "name": "dark" }]
2362
+ },
2363
+ {
2364
+ "name": "value",
2365
+ "description": "The value attribute for the input element",
2366
+ "values": []
2367
+ },
2368
+ {
2369
+ "name": "checked",
2370
+ "description": "The checked attribute for the input element",
2371
+ "values": []
2372
+ },
2373
+ {
2374
+ "name": "onKeyDown",
2375
+ "description": "A user-defined function to handle keydown events",
2376
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2377
+ }
2378
+ ],
2379
+ "references": [
2380
+ {
2381
+ "name": "Storybook",
2382
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2383
+ }
2384
+ ]
2385
+ },
2377
2386
  {
2378
2387
  "name": "bm-text-area",
2379
2388
  "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",
@@ -2465,54 +2474,45 @@
2465
2474
  ]
2466
2475
  },
2467
2476
  {
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",
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.",
2470
2479
  "attributes": [
2471
2480
  {
2472
- "name": "label",
2473
- "description": "Specify the text for the label",
2481
+ "name": "onText",
2482
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2474
2483
  "values": []
2475
2484
  },
2476
2485
  {
2477
- "name": "error",
2478
- "description": "Specify error text and display error state of a RadioButton",
2486
+ "name": "offText",
2487
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2479
2488
  "values": []
2480
2489
  },
2490
+ {
2491
+ "name": "textPosition",
2492
+ "description": "Specify the position of the side label",
2493
+ "values": [{ "name": "before" }, { "name": "after" }]
2494
+ },
2481
2495
  {
2482
2496
  "name": "readOnly",
2483
- "description": "Specify if RadioButton displays in a read-only state",
2497
+ "description": "Specify if Switch displays in a read-only state",
2484
2498
  "values": []
2485
2499
  },
2486
2500
  {
2487
2501
  "name": "disabled",
2488
- "description": "Specify if RadioButton displays in a disabled state",
2502
+ "description": "Specify if Switch displays in a disabled state",
2489
2503
  "values": []
2490
2504
  },
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
- },
2505
+ { "name": "checked", "values": [] },
2496
2506
  {
2497
2507
  "name": "value",
2498
2508
  "description": "The value attribute for the input element",
2499
2509
  "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-radiobutton"
2515
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2516
2516
  }
2517
2517
  ]
2518
2518
  },
@@ -2586,8 +2586,8 @@
2586
2586
  ]
2587
2587
  },
2588
2588
  {
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",
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",
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-switch"
2653
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2654
2654
  }
2655
2655
  ]
2656
2656
  },
2657
2657
  {
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",
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",
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-radiobutton"
2722
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2723
2723
  }
2724
2724
  ]
2725
2725
  }