@viasat/beam-web-components 2.11.0 → 2.12.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.
@@ -62,110 +62,37 @@
62
62
  ]
63
63
  },
64
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",
65
+ "name": "bm-alert",
66
+ "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",
67
67
  "attributes": [
68
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",
69
+ "name": "heading",
70
+ "description": "Specify the heading text for Alert",
76
71
  "values": []
77
72
  },
78
73
  {
79
- "name": "src",
80
- "description": "Pass an image to the Avatar",
74
+ "name": "body",
75
+ "description": "Specify the body text for Alert",
81
76
  "values": []
82
77
  },
83
- { "name": "alt", "description": "Specify alt for image", "values": [] },
84
78
  {
85
79
  "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": []
80
+ "description": "Specify the size of the Alert",
81
+ "values": [{ "name": "sm" }, { "name": "md" }]
132
82
  },
133
83
  {
134
- "name": "maxCount",
135
- "description": "Specify the max number of avatars displayed in the group.",
84
+ "name": "fullWidth",
85
+ "description": "Specify if the Alert has no border radius",
136
86
  "values": []
137
87
  },
138
88
  {
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
- ]
89
+ "name": "theme",
90
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
91
+ "values": [{ "name": "light" }, { "name": "dark" }]
148
92
  },
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
- {
163
- "name": "bm-badge",
164
- "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",
165
- "attributes": [
166
93
  {
167
94
  "name": "appearance",
168
- "description": "Specify the appearance of the Badge",
95
+ "description": "Specify the appearance of the Alert",
169
96
  "values": [
170
97
  { "name": "infoPrimary" },
171
98
  { "name": "infoSecondary" },
@@ -175,30 +102,35 @@
175
102
  ]
176
103
  },
177
104
  {
178
- "name": "theme",
179
- "description": "Theme of the Badge",
180
- "values": [{ "name": "light" }, { "name": "dark" }]
105
+ "name": "hidden",
106
+ "description": "Specify if the Alert is hidden",
107
+ "values": []
181
108
  },
182
109
  {
183
- "name": "size",
184
- "description": "Specify the size of the Badge",
185
- "values": [{ "name": "sm" }, { "name": "md" }]
110
+ "name": "hideIcon",
111
+ "description": "Specify if the icon displays on the Alert",
112
+ "values": []
186
113
  },
187
114
  {
188
- "name": "emphasis",
189
- "description": "Specify the emphasis of the Badge",
190
- "values": [
191
- { "name": "strong" },
192
- { "name": "medium" },
193
- { "name": "subtle" }
194
- ]
115
+ "name": "dismissible",
116
+ "description": "Specify if the Alert can be dismissed",
117
+ "values": []
195
118
  },
196
- { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
119
+ {
120
+ "name": "disableAutoFocus",
121
+ "description": "Prevent autofocus on show",
122
+ "values": []
123
+ },
124
+ {
125
+ "name": "disableCloseOnEscape",
126
+ "description": "Prevent Escape from closing",
127
+ "values": []
128
+ }
197
129
  ],
198
130
  "references": [
199
131
  {
200
132
  "name": "Storybook",
201
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
133
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
202
134
  }
203
135
  ]
204
136
  },
@@ -244,79 +176,6 @@
244
176
  }
245
177
  ]
246
178
  },
247
- {
248
- "name": "bm-alert",
249
- "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",
250
- "attributes": [
251
- {
252
- "name": "heading",
253
- "description": "Specify the heading text for Alert",
254
- "values": []
255
- },
256
- {
257
- "name": "body",
258
- "description": "Specify the body text for Alert",
259
- "values": []
260
- },
261
- {
262
- "name": "size",
263
- "description": "Specify the size of the Alert",
264
- "values": [{ "name": "sm" }, { "name": "md" }]
265
- },
266
- {
267
- "name": "fullWidth",
268
- "description": "Specify if the Alert has no border radius",
269
- "values": []
270
- },
271
- {
272
- "name": "theme",
273
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
274
- "values": [{ "name": "light" }, { "name": "dark" }]
275
- },
276
- {
277
- "name": "appearance",
278
- "description": "Specify the appearance of the Alert",
279
- "values": [
280
- { "name": "infoPrimary" },
281
- { "name": "infoSecondary" },
282
- { "name": "positive" },
283
- { "name": "warning" },
284
- { "name": "negative" }
285
- ]
286
- },
287
- {
288
- "name": "hidden",
289
- "description": "Specify if the Alert is hidden",
290
- "values": []
291
- },
292
- {
293
- "name": "hideIcon",
294
- "description": "Specify if the icon displays on the Alert",
295
- "values": []
296
- },
297
- {
298
- "name": "dismissible",
299
- "description": "Specify if the Alert can be dismissed",
300
- "values": []
301
- },
302
- {
303
- "name": "disableAutoFocus",
304
- "description": "Prevent autofocus on show",
305
- "values": []
306
- },
307
- {
308
- "name": "disableCloseOnEscape",
309
- "description": "Prevent Escape from closing",
310
- "values": []
311
- }
312
- ],
313
- "references": [
314
- {
315
- "name": "Storybook",
316
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
317
- }
318
- ]
319
- },
320
179
  {
321
180
  "name": "bm-box",
322
181
  "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",
@@ -781,6 +640,49 @@
781
640
  }
782
641
  ]
783
642
  },
643
+ {
644
+ "name": "bm-badge",
645
+ "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",
646
+ "attributes": [
647
+ {
648
+ "name": "appearance",
649
+ "description": "Specify the appearance of the Badge",
650
+ "values": [
651
+ { "name": "infoPrimary" },
652
+ { "name": "infoSecondary" },
653
+ { "name": "positive" },
654
+ { "name": "warning" },
655
+ { "name": "negative" }
656
+ ]
657
+ },
658
+ {
659
+ "name": "theme",
660
+ "description": "Theme of the Badge",
661
+ "values": [{ "name": "light" }, { "name": "dark" }]
662
+ },
663
+ {
664
+ "name": "size",
665
+ "description": "Specify the size of the Badge",
666
+ "values": [{ "name": "sm" }, { "name": "md" }]
667
+ },
668
+ {
669
+ "name": "emphasis",
670
+ "description": "Specify the emphasis of the Badge",
671
+ "values": [
672
+ { "name": "strong" },
673
+ { "name": "medium" },
674
+ { "name": "subtle" }
675
+ ]
676
+ },
677
+ { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
678
+ ],
679
+ "references": [
680
+ {
681
+ "name": "Storybook",
682
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
683
+ }
684
+ ]
685
+ },
784
686
  {
785
687
  "name": "bm-button",
786
688
  "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",
@@ -811,41 +713,167 @@
811
713
  "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
812
714
  },
813
715
  {
814
- "name": "disabled",
815
- "description": "Specify if the Button is disabled",
716
+ "name": "disabled",
717
+ "description": "Specify if the Button is disabled",
718
+ "values": []
719
+ },
720
+ {
721
+ "name": "fluid",
722
+ "description": "Specify if Button is fluid",
723
+ "values": []
724
+ },
725
+ {
726
+ "name": "width",
727
+ "description": "Specify the width of a Button",
728
+ "values": []
729
+ },
730
+ {
731
+ "name": "height",
732
+ "description": "Specify the height of a Button",
733
+ "values": []
734
+ },
735
+ {
736
+ "name": "theme",
737
+ "description": "Specify the theme of the Button",
738
+ "values": [{ "name": "light" }, { "name": "dark" }]
739
+ },
740
+ {
741
+ "name": "iconOnly",
742
+ "description": "Specify if the icon displays without text",
743
+ "values": []
744
+ },
745
+ { "name": "type", "values": [] }
746
+ ],
747
+ "references": [
748
+ {
749
+ "name": "Storybook",
750
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-button"
751
+ }
752
+ ]
753
+ },
754
+ {
755
+ "name": "bm-avatar",
756
+ "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",
757
+ "attributes": [
758
+ {
759
+ "name": "appearance",
760
+ "description": "Specify the appearance of the Avatar",
761
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
762
+ },
763
+ {
764
+ "name": "name",
765
+ "description": "Specify a name to display initials in the Avatar",
766
+ "values": []
767
+ },
768
+ {
769
+ "name": "src",
770
+ "description": "Pass an image to the Avatar",
771
+ "values": []
772
+ },
773
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
774
+ {
775
+ "name": "size",
776
+ "description": "Specify the size of the Avatar",
777
+ "values": [
778
+ { "name": "xs" },
779
+ { "name": "sm" },
780
+ { "name": "md" },
781
+ { "name": "lg" },
782
+ { "name": "xl" }
783
+ ]
784
+ },
785
+ {
786
+ "name": "disabled",
787
+ "description": "Specify if the Avatar is disabled",
788
+ "values": []
789
+ },
790
+ {
791
+ "name": "shape",
792
+ "description": "Specify the shape of the Avatar",
793
+ "values": [{ "name": "circle" }, { "name": "square" }]
794
+ },
795
+ {
796
+ "name": "isInteractive",
797
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
798
+ "values": []
799
+ },
800
+ {
801
+ "name": "isFocusable",
802
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
803
+ "values": []
804
+ },
805
+ { "name": "withBorder", "values": [] }
806
+ ],
807
+ "references": [
808
+ {
809
+ "name": "Storybook",
810
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
811
+ }
812
+ ]
813
+ },
814
+ {
815
+ "name": "bm-avatar-group",
816
+ "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",
817
+ "attributes": [
818
+ {
819
+ "name": "wrapping",
820
+ "description": "Specify if the AvatarGroup wraps",
816
821
  "values": []
817
822
  },
818
823
  {
819
- "name": "fluid",
820
- "description": "Specify if Button is fluid",
824
+ "name": "maxCount",
825
+ "description": "Specify the max number of avatars displayed in the group.",
821
826
  "values": []
822
827
  },
823
828
  {
824
- "name": "width",
825
- "description": "Specify the width of a Button",
826
- "values": []
829
+ "name": "size",
830
+ "description": "Specify the size of all Avatars",
831
+ "values": [
832
+ { "name": "xs" },
833
+ { "name": "sm" },
834
+ { "name": "md" },
835
+ { "name": "lg" },
836
+ { "name": "xl" }
837
+ ]
827
838
  },
828
839
  {
829
- "name": "height",
830
- "description": "Specify the height of a Button",
831
- "values": []
832
- },
840
+ "name": "layout",
841
+ "description": "Specify the kind of the group.",
842
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
843
+ }
844
+ ],
845
+ "references": [
833
846
  {
834
- "name": "theme",
835
- "description": "Specify the theme of the Button",
836
- "values": [{ "name": "light" }, { "name": "dark" }]
847
+ "name": "Storybook",
848
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
849
+ }
850
+ ]
851
+ },
852
+ {
853
+ "name": "bm-close-button",
854
+ "description": "`bm-close-button`\n\n### Attributes:\n- **size** - Specify the size of the CloseButton\n- **disabled** - Specify if the CloseButton is disabled\n---\n",
855
+ "attributes": [
856
+ {
857
+ "name": "size",
858
+ "description": "Specify the size of the CloseButton",
859
+ "values": [
860
+ { "name": "xs" },
861
+ { "name": "sm" },
862
+ { "name": "md" },
863
+ { "name": "lg" },
864
+ { "name": "xl" }
865
+ ]
837
866
  },
838
867
  {
839
- "name": "iconOnly",
840
- "description": "Specify if the icon displays without text",
868
+ "name": "disabled",
869
+ "description": "Specify if the CloseButton is disabled",
841
870
  "values": []
842
- },
843
- { "name": "type", "values": [] }
871
+ }
844
872
  ],
845
873
  "references": [
846
874
  {
847
875
  "name": "Storybook",
848
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-button"
876
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-closebutton"
849
877
  }
850
878
  ]
851
879
  },
@@ -918,34 +946,6 @@
918
946
  }
919
947
  ]
920
948
  },
921
- {
922
- "name": "bm-close-button",
923
- "description": "`bm-close-button`\n\n### Attributes:\n- **size** - Specify the size of the CloseButton\n- **disabled** - Specify if the CloseButton is disabled\n---\n",
924
- "attributes": [
925
- {
926
- "name": "size",
927
- "description": "Specify the size of the CloseButton",
928
- "values": [
929
- { "name": "xs" },
930
- { "name": "sm" },
931
- { "name": "md" },
932
- { "name": "lg" },
933
- { "name": "xl" }
934
- ]
935
- },
936
- {
937
- "name": "disabled",
938
- "description": "Specify if the CloseButton is disabled",
939
- "values": []
940
- }
941
- ],
942
- "references": [
943
- {
944
- "name": "Storybook",
945
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-closebutton"
946
- }
947
- ]
948
- },
949
949
  {
950
950
  "name": "bm-empty-state",
951
951
  "description": "`bm-empty-state`\n\n### Attributes:\n- **heading** - Specify heading text for EmptyState\n- **body** - Specify body text for EmptyState\n- **actions** - Specify action for EmptyState\n- **theme** - Specify the theme of EmptyState. By default it inherits the theme from the parent\n---\n\n\n### **Slots:**\n - **icon** - Specify an icon for EmptyState\n- **heading** - Specify heading text for EmptyState\n- **body** - Specify body text for EmptyState\n- **actions** - Add actions to EmptyState",
@@ -1806,6 +1806,43 @@
1806
1806
  }
1807
1807
  ]
1808
1808
  },
1809
+ {
1810
+ "name": "bm-label",
1811
+ "description": "`bm-label`\n---\n\n\n### **Slots:**\n - **text** - Specify the text for Label\n- **optional** - Specify if the Label displays as optional\n- **tooltip** - Specify if the icon displays to add a Tooltip",
1812
+ "attributes": [
1813
+ {
1814
+ "name": "disabled",
1815
+ "description": "Specify if the Label displays disabled",
1816
+ "values": []
1817
+ },
1818
+ {
1819
+ "name": "required",
1820
+ "description": "Specify if the Label displays as required",
1821
+ "values": []
1822
+ },
1823
+ {
1824
+ "name": "text",
1825
+ "description": "Specify the text for Label",
1826
+ "values": [{ "name": "Optional<string>" }]
1827
+ },
1828
+ {
1829
+ "name": "optional",
1830
+ "description": "Specify the text for Label",
1831
+ "values": [{ "name": "Optional<string>" }]
1832
+ },
1833
+ {
1834
+ "name": "theme",
1835
+ "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
1836
+ "values": [{ "name": "Optional<ThemeTypes>" }]
1837
+ }
1838
+ ],
1839
+ "references": [
1840
+ {
1841
+ "name": "Storybook",
1842
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
1843
+ }
1844
+ ]
1845
+ },
1809
1846
  {
1810
1847
  "name": "bm-file-upload-button",
1811
1848
  "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",
@@ -2185,97 +2222,97 @@
2185
2222
  ]
2186
2223
  },
2187
2224
  {
2188
- "name": "bm-radio-button",
2189
- "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",
2225
+ "name": "bm-switch",
2226
+ "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.",
2190
2227
  "attributes": [
2191
2228
  {
2192
- "name": "label",
2193
- "description": "Specify the text for the label",
2229
+ "name": "onText",
2230
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2194
2231
  "values": []
2195
2232
  },
2196
2233
  {
2197
- "name": "error",
2198
- "description": "Specify error text and display error state of a RadioButton",
2234
+ "name": "offText",
2235
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2199
2236
  "values": []
2200
2237
  },
2238
+ {
2239
+ "name": "textPosition",
2240
+ "description": "Specify the position of the side label",
2241
+ "values": [{ "name": "before" }, { "name": "after" }]
2242
+ },
2201
2243
  {
2202
2244
  "name": "readOnly",
2203
- "description": "Specify if RadioButton displays in a read-only state",
2245
+ "description": "Specify if Switch displays in a read-only state",
2204
2246
  "values": []
2205
2247
  },
2206
2248
  {
2207
2249
  "name": "disabled",
2208
- "description": "Specify if RadioButton displays in a disabled state",
2250
+ "description": "Specify if Switch displays in a disabled state",
2209
2251
  "values": []
2210
2252
  },
2211
- {
2212
- "name": "theme",
2213
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2214
- "values": [{ "name": "light" }, { "name": "dark" }]
2215
- },
2253
+ { "name": "checked", "values": [] },
2216
2254
  {
2217
2255
  "name": "value",
2218
2256
  "description": "The value attribute for the input element",
2219
2257
  "values": []
2220
- },
2221
- {
2222
- "name": "checked",
2223
- "description": "The checked attribute for the input element",
2224
- "values": []
2225
- },
2226
- {
2227
- "name": "onKeyDown",
2228
- "description": "A user-defined function to handle keydown events",
2229
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2230
2258
  }
2231
2259
  ],
2232
2260
  "references": [
2233
2261
  {
2234
2262
  "name": "Storybook",
2235
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2263
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2236
2264
  }
2237
2265
  ]
2238
2266
  },
2239
2267
  {
2240
- "name": "bm-switch",
2241
- "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.",
2268
+ "name": "bm-radio-button",
2269
+ "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",
2242
2270
  "attributes": [
2243
2271
  {
2244
- "name": "onText",
2245
- "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2272
+ "name": "label",
2273
+ "description": "Specify the text for the label",
2246
2274
  "values": []
2247
2275
  },
2248
2276
  {
2249
- "name": "offText",
2250
- "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2277
+ "name": "error",
2278
+ "description": "Specify error text and display error state of a RadioButton",
2251
2279
  "values": []
2252
2280
  },
2253
- {
2254
- "name": "textPosition",
2255
- "description": "Specify the position of the side label",
2256
- "values": [{ "name": "before" }, { "name": "after" }]
2257
- },
2258
2281
  {
2259
2282
  "name": "readOnly",
2260
- "description": "Specify if Switch displays in a read-only state",
2283
+ "description": "Specify if RadioButton displays in a read-only state",
2261
2284
  "values": []
2262
2285
  },
2263
2286
  {
2264
2287
  "name": "disabled",
2265
- "description": "Specify if Switch displays in a disabled state",
2288
+ "description": "Specify if RadioButton displays in a disabled state",
2266
2289
  "values": []
2267
2290
  },
2268
- { "name": "checked", "values": [] },
2291
+ {
2292
+ "name": "theme",
2293
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2294
+ "values": [{ "name": "light" }, { "name": "dark" }]
2295
+ },
2269
2296
  {
2270
2297
  "name": "value",
2271
2298
  "description": "The value attribute for the input element",
2272
2299
  "values": []
2300
+ },
2301
+ {
2302
+ "name": "checked",
2303
+ "description": "The checked attribute for the input element",
2304
+ "values": []
2305
+ },
2306
+ {
2307
+ "name": "onKeyDown",
2308
+ "description": "A user-defined function to handle keydown events",
2309
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2273
2310
  }
2274
2311
  ],
2275
2312
  "references": [
2276
2313
  {
2277
2314
  "name": "Storybook",
2278
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2315
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2279
2316
  }
2280
2317
  ]
2281
2318
  },
@@ -2372,43 +2409,6 @@
2372
2409
  }
2373
2410
  ]
2374
2411
  },
2375
- {
2376
- "name": "bm-label",
2377
- "description": "`bm-label`\n---\n\n\n### **Slots:**\n - **text** - Specify the text for Label\n- **optional** - Specify if the Label displays as optional\n- **tooltip** - Specify if the icon displays to add a Tooltip",
2378
- "attributes": [
2379
- {
2380
- "name": "disabled",
2381
- "description": "Specify if the Label displays disabled",
2382
- "values": []
2383
- },
2384
- {
2385
- "name": "required",
2386
- "description": "Specify if the Label displays as required",
2387
- "values": []
2388
- },
2389
- {
2390
- "name": "text",
2391
- "description": "Specify the text for Label",
2392
- "values": [{ "name": "Optional<string>" }]
2393
- },
2394
- {
2395
- "name": "optional",
2396
- "description": "Specify the text for Label",
2397
- "values": [{ "name": "Optional<string>" }]
2398
- },
2399
- {
2400
- "name": "theme",
2401
- "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
2402
- "values": [{ "name": "Optional<ThemeTypes>" }]
2403
- }
2404
- ],
2405
- "references": [
2406
- {
2407
- "name": "Storybook",
2408
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
2409
- }
2410
- ]
2411
- },
2412
2412
  {
2413
2413
  "name": "bm-text-field",
2414
2414
  "description": "`bm-text-field`\n---\n\n\n### **Slots:**\n - **label** - Specify the label for TextField\n- **helper-text** - Specify the helper text for TextField\n- **content-after** - Specify content to display after input\n- **content-before** - Specify content to display before input",
@@ -2557,8 +2557,8 @@
2557
2557
  ]
2558
2558
  },
2559
2559
  {
2560
- "name": "bm-radio-button-group",
2561
- "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
2560
+ "name": "bm-switch-group",
2561
+ "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",
2562
2562
  "attributes": [
2563
2563
  {
2564
2564
  "name": "theme",
@@ -2624,13 +2624,13 @@
2624
2624
  "references": [
2625
2625
  {
2626
2626
  "name": "Storybook",
2627
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2627
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2628
2628
  }
2629
2629
  ]
2630
2630
  },
2631
2631
  {
2632
- "name": "bm-switch-group",
2633
- "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",
2632
+ "name": "bm-radio-button-group",
2633
+ "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
2634
2634
  "attributes": [
2635
2635
  {
2636
2636
  "name": "theme",
@@ -2696,7 +2696,7 @@
2696
2696
  "references": [
2697
2697
  {
2698
2698
  "name": "Storybook",
2699
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2699
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2700
2700
  }
2701
2701
  ]
2702
2702
  }