@viasat/beam-web-components 2.54.1 → 2.55.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.
@@ -61,104 +61,6 @@
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
- },
162
64
  {
163
65
  "name": "bm-badge",
164
66
  "description": "`bm-badge`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Badge\n- **theme** - Theme of the Badge\n- **size** - Specify the size of the Badge\n- **emphasis** - Specify the emphasis of the Badge\n- **hideIcon** - Hides Badge icon\n---\n\n\n### **Slots:**\n - **default** - Provide text for the Badge\n- **icon** - Specify a different icon for the Badge",
@@ -202,79 +104,6 @@
202
104
  }
203
105
  ]
204
106
  },
205
- {
206
- "name": "bm-alert",
207
- "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",
208
- "attributes": [
209
- {
210
- "name": "heading",
211
- "description": "Specify the heading text for Alert",
212
- "values": []
213
- },
214
- {
215
- "name": "body",
216
- "description": "Specify the body text for Alert",
217
- "values": []
218
- },
219
- {
220
- "name": "size",
221
- "description": "Specify the size of the Alert",
222
- "values": [{ "name": "sm" }, { "name": "md" }]
223
- },
224
- {
225
- "name": "fullWidth",
226
- "description": "Specify if the Alert has no border radius",
227
- "values": []
228
- },
229
- {
230
- "name": "theme",
231
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
232
- "values": [{ "name": "light" }, { "name": "dark" }]
233
- },
234
- {
235
- "name": "appearance",
236
- "description": "Specify the appearance of the Alert",
237
- "values": [
238
- { "name": "infoPrimary" },
239
- { "name": "infoSecondary" },
240
- { "name": "positive" },
241
- { "name": "warning" },
242
- { "name": "negative" }
243
- ]
244
- },
245
- {
246
- "name": "hidden",
247
- "description": "Specify if the Alert is hidden",
248
- "values": []
249
- },
250
- {
251
- "name": "hideIcon",
252
- "description": "Specify if the icon displays on the Alert",
253
- "values": []
254
- },
255
- {
256
- "name": "dismissible",
257
- "description": "Specify if the Alert can be dismissed",
258
- "values": []
259
- },
260
- {
261
- "name": "disableAutoFocus",
262
- "description": "Prevent autofocus on show",
263
- "values": []
264
- },
265
- {
266
- "name": "disableCloseOnEscape",
267
- "description": "Prevent Escape from closing",
268
- "values": []
269
- }
270
- ],
271
- "references": [
272
- {
273
- "name": "Storybook",
274
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
275
- }
276
- ]
277
- },
278
107
  {
279
108
  "name": "bm-badge-dot",
280
109
  "description": "`bm-badge-dot`\n\n### Attributes:\n- **theme** - Specify the theme of the BadgeDot. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the BadgeDot\n- **emphasis** - Specify the emphasis of the BadgeDot\n- **overrideDotColor** - Overrides default dot color\n---\n\n\n### **Slots:**\n - **default** - Provide text for the BadgeDot",
@@ -717,58 +546,229 @@
717
546
  ]
718
547
  },
719
548
  {
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",
549
+ "name": "bm-avatar",
550
+ "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",
722
551
  "attributes": [
723
552
  {
724
- "name": "wrap",
725
- "description": "Specify if items wrap or collapse to an ellipsis",
553
+ "name": "appearance",
554
+ "description": "Specify the appearance of the Avatar",
555
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
556
+ },
557
+ {
558
+ "name": "name",
559
+ "description": "Specify a name to display initials in the Avatar",
726
560
  "values": []
727
561
  },
728
562
  {
729
- "name": "itemsBeforeCollapse",
730
- "description": "Specify how many items show before ellipsis",
563
+ "name": "src",
564
+ "description": "Pass an image to the Avatar",
731
565
  "values": []
732
566
  },
567
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
733
568
  {
734
- "name": "itemsAfterCollapse",
735
- "description": "Specify how many items show after ellipsis",
569
+ "name": "size",
570
+ "description": "Specify the size of the Avatar",
571
+ "values": [
572
+ { "name": "xs" },
573
+ { "name": "sm" },
574
+ { "name": "md" },
575
+ { "name": "lg" },
576
+ { "name": "xl" }
577
+ ]
578
+ },
579
+ {
580
+ "name": "disabled",
581
+ "description": "Specify if the Avatar is disabled",
736
582
  "values": []
737
583
  },
738
584
  {
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
- }
585
+ "name": "shape",
586
+ "description": "Specify the shape of the Avatar",
587
+ "values": [{ "name": "circle" }, { "name": "square" }]
588
+ },
589
+ {
590
+ "name": "isInteractive",
591
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
592
+ "values": []
593
+ },
594
+ {
595
+ "name": "isFocusable",
596
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
597
+ "values": []
598
+ },
599
+ { "name": "withBorder", "values": [] }
743
600
  ],
744
601
  "references": [
745
602
  {
746
603
  "name": "Storybook",
747
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
604
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
748
605
  }
749
606
  ]
750
607
  },
751
608
  {
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",
609
+ "name": "bm-avatar-group",
610
+ "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",
754
611
  "attributes": [
755
- { "name": "href", "description": "Pass href to an item", "values": [] },
756
612
  {
757
- "name": "clickable",
758
- "description": "Specify if the item is interactive without an href",
613
+ "name": "wrapping",
614
+ "description": "Specify if the AvatarGroup wraps",
759
615
  "values": []
760
616
  },
761
617
  {
762
- "name": "truncationWidth",
763
- "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
618
+ "name": "maxCount",
619
+ "description": "Specify the max number of avatars displayed in the group.",
764
620
  "values": []
765
621
  },
766
622
  {
767
- "name": "isCurrent",
768
- "description": "Specify explicitly if the item is the last one",
769
- "values": []
623
+ "name": "size",
624
+ "description": "Specify the size of all Avatars",
625
+ "values": [
626
+ { "name": "xs" },
627
+ { "name": "sm" },
628
+ { "name": "md" },
629
+ { "name": "lg" },
630
+ { "name": "xl" }
631
+ ]
770
632
  },
771
- { "name": "isCollapsed", "values": [] }
633
+ {
634
+ "name": "layout",
635
+ "description": "Specify the kind of the group.",
636
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
637
+ }
638
+ ],
639
+ "references": [
640
+ {
641
+ "name": "Storybook",
642
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
643
+ }
644
+ ]
645
+ },
646
+ {
647
+ "name": "bm-alert",
648
+ "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",
649
+ "attributes": [
650
+ {
651
+ "name": "heading",
652
+ "description": "Specify the heading text for Alert",
653
+ "values": []
654
+ },
655
+ {
656
+ "name": "body",
657
+ "description": "Specify the body text for Alert",
658
+ "values": []
659
+ },
660
+ {
661
+ "name": "size",
662
+ "description": "Specify the size of the Alert",
663
+ "values": [{ "name": "sm" }, { "name": "md" }]
664
+ },
665
+ {
666
+ "name": "fullWidth",
667
+ "description": "Specify if the Alert has no border radius",
668
+ "values": []
669
+ },
670
+ {
671
+ "name": "theme",
672
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
673
+ "values": [{ "name": "light" }, { "name": "dark" }]
674
+ },
675
+ {
676
+ "name": "appearance",
677
+ "description": "Specify the appearance of the Alert",
678
+ "values": [
679
+ { "name": "infoPrimary" },
680
+ { "name": "infoSecondary" },
681
+ { "name": "positive" },
682
+ { "name": "warning" },
683
+ { "name": "negative" }
684
+ ]
685
+ },
686
+ {
687
+ "name": "hidden",
688
+ "description": "Specify if the Alert is hidden",
689
+ "values": []
690
+ },
691
+ {
692
+ "name": "hideIcon",
693
+ "description": "Specify if the icon displays on the Alert",
694
+ "values": []
695
+ },
696
+ {
697
+ "name": "dismissible",
698
+ "description": "Specify if the Alert can be dismissed",
699
+ "values": []
700
+ },
701
+ {
702
+ "name": "disableAutoFocus",
703
+ "description": "Prevent autofocus on show",
704
+ "values": []
705
+ },
706
+ {
707
+ "name": "disableCloseOnEscape",
708
+ "description": "Prevent Escape from closing",
709
+ "values": []
710
+ }
711
+ ],
712
+ "references": [
713
+ {
714
+ "name": "Storybook",
715
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
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
772
  ],
773
773
  "references": [
774
774
  {
@@ -1909,103 +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
- {
1958
- "name": "bm-radio-button",
1959
- "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",
1960
- "attributes": [
1961
- {
1962
- "name": "label",
1963
- "description": "Specify the text for the label",
1964
- "values": []
1965
- },
1966
- {
1967
- "name": "error",
1968
- "description": "Specify error text and display error state of a RadioButton",
1969
- "values": []
1970
- },
1971
- {
1972
- "name": "readOnly",
1973
- "description": "Specify if RadioButton displays in a read-only state",
1974
- "values": []
1975
- },
1976
- {
1977
- "name": "disabled",
1978
- "description": "Specify if RadioButton displays in a disabled state",
1979
- "values": []
1980
- },
1981
- {
1982
- "name": "theme",
1983
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
1984
- "values": [{ "name": "light" }, { "name": "dark" }]
1985
- },
1986
- {
1987
- "name": "value",
1988
- "description": "The value attribute for the input element",
1989
- "values": []
1990
- },
1991
- {
1992
- "name": "checked",
1993
- "description": "The checked attribute for the input element",
1994
- "values": []
1995
- },
1996
- {
1997
- "name": "onKeyDown",
1998
- "description": "A user-defined function to handle keydown events",
1999
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2000
- }
2001
- ],
2002
- "references": [
2003
- {
2004
- "name": "Storybook",
2005
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2006
- }
2007
- ]
2008
- },
2009
1912
  {
2010
1913
  "name": "bm-file-upload-button",
2011
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",
@@ -2383,6 +2286,146 @@
2383
2286
  }
2384
2287
  ]
2385
2288
  },
2289
+ {
2290
+ "name": "bm-radio-button",
2291
+ "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",
2292
+ "attributes": [
2293
+ {
2294
+ "name": "label",
2295
+ "description": "Specify the text for the label",
2296
+ "values": []
2297
+ },
2298
+ {
2299
+ "name": "error",
2300
+ "description": "Specify error text and display error state of a RadioButton",
2301
+ "values": []
2302
+ },
2303
+ {
2304
+ "name": "readOnly",
2305
+ "description": "Specify if RadioButton displays in a read-only state",
2306
+ "values": []
2307
+ },
2308
+ {
2309
+ "name": "disabled",
2310
+ "description": "Specify if RadioButton displays in a disabled state",
2311
+ "values": []
2312
+ },
2313
+ {
2314
+ "name": "theme",
2315
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2316
+ "values": [{ "name": "light" }, { "name": "dark" }]
2317
+ },
2318
+ {
2319
+ "name": "value",
2320
+ "description": "The value attribute for the input element",
2321
+ "values": []
2322
+ },
2323
+ {
2324
+ "name": "checked",
2325
+ "description": "The checked attribute for the input element",
2326
+ "values": []
2327
+ },
2328
+ {
2329
+ "name": "onKeyDown",
2330
+ "description": "A user-defined function to handle keydown events",
2331
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2332
+ }
2333
+ ],
2334
+ "references": [
2335
+ {
2336
+ "name": "Storybook",
2337
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2338
+ }
2339
+ ]
2340
+ },
2341
+ {
2342
+ "name": "bm-form",
2343
+ "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",
2344
+ "attributes": [
2345
+ {
2346
+ "name": "validationMode",
2347
+ "description": "Specify if validation runs on change or when loosing focus",
2348
+ "values": [
2349
+ { "name": "onChange" },
2350
+ { "name": "onBlur" },
2351
+ { "name": "onSubmit" }
2352
+ ]
2353
+ },
2354
+ {
2355
+ "name": "initialValues",
2356
+ "description": "Specify initial values on Form controls based on their names",
2357
+ "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2358
+ },
2359
+ {
2360
+ "name": "required",
2361
+ "description": "Specify if input is a required",
2362
+ "values": []
2363
+ },
2364
+ {
2365
+ "name": "disabled",
2366
+ "description": "Specify if input is a disabled",
2367
+ "values": []
2368
+ },
2369
+ {
2370
+ "name": "readOnly",
2371
+ "description": "Specify if input is a read only",
2372
+ "values": []
2373
+ },
2374
+ { "name": "action", "values": [] },
2375
+ { "name": "method", "values": [] },
2376
+ { "name": "target", "values": [] },
2377
+ { "name": "enctype", "values": [] }
2378
+ ],
2379
+ "references": [
2380
+ {
2381
+ "name": "Storybook",
2382
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2383
+ }
2384
+ ]
2385
+ },
2386
+ {
2387
+ "name": "bm-switch",
2388
+ "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.",
2389
+ "attributes": [
2390
+ {
2391
+ "name": "onText",
2392
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2393
+ "values": []
2394
+ },
2395
+ {
2396
+ "name": "offText",
2397
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2398
+ "values": []
2399
+ },
2400
+ {
2401
+ "name": "textPosition",
2402
+ "description": "Specify the position of the side label",
2403
+ "values": [{ "name": "before" }, { "name": "after" }]
2404
+ },
2405
+ {
2406
+ "name": "readOnly",
2407
+ "description": "Specify if Switch displays in a read-only state",
2408
+ "values": []
2409
+ },
2410
+ {
2411
+ "name": "disabled",
2412
+ "description": "Specify if Switch displays in a disabled state",
2413
+ "values": []
2414
+ },
2415
+ { "name": "checked", "values": [] },
2416
+ {
2417
+ "name": "value",
2418
+ "description": "The value attribute for the input element",
2419
+ "values": []
2420
+ }
2421
+ ],
2422
+ "references": [
2423
+ {
2424
+ "name": "Storybook",
2425
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2426
+ }
2427
+ ]
2428
+ },
2386
2429
  {
2387
2430
  "name": "bm-text-area",
2388
2431
  "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",
@@ -2473,49 +2516,6 @@
2473
2516
  }
2474
2517
  ]
2475
2518
  },
2476
- {
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.",
2479
- "attributes": [
2480
- {
2481
- "name": "onText",
2482
- "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2483
- "values": []
2484
- },
2485
- {
2486
- "name": "offText",
2487
- "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2488
- "values": []
2489
- },
2490
- {
2491
- "name": "textPosition",
2492
- "description": "Specify the position of the side label",
2493
- "values": [{ "name": "before" }, { "name": "after" }]
2494
- },
2495
- {
2496
- "name": "readOnly",
2497
- "description": "Specify if Switch displays in a read-only state",
2498
- "values": []
2499
- },
2500
- {
2501
- "name": "disabled",
2502
- "description": "Specify if Switch displays in a disabled state",
2503
- "values": []
2504
- },
2505
- { "name": "checked", "values": [] },
2506
- {
2507
- "name": "value",
2508
- "description": "The value attribute for the input element",
2509
- "values": []
2510
- }
2511
- ],
2512
- "references": [
2513
- {
2514
- "name": "Storybook",
2515
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2516
- }
2517
- ]
2518
- },
2519
2519
  {
2520
2520
  "name": "bm-checkbox-group",
2521
2521
  "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",