@viasat/beam-web-components 2.51.0 → 2.52.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,37 +62,17 @@
62
62
  ]
63
63
  },
64
64
  {
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",
65
+ "name": "bm-badge-dot",
66
+ "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",
67
67
  "attributes": [
68
- {
69
- "name": "heading",
70
- "description": "Specify the heading text for Alert",
71
- "values": []
72
- },
73
- {
74
- "name": "body",
75
- "description": "Specify the body text for Alert",
76
- "values": []
77
- },
78
- {
79
- "name": "size",
80
- "description": "Specify the size of the Alert",
81
- "values": [{ "name": "sm" }, { "name": "md" }]
82
- },
83
- {
84
- "name": "fullWidth",
85
- "description": "Specify if the Alert has no border radius",
86
- "values": []
87
- },
88
68
  {
89
69
  "name": "theme",
90
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
70
+ "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
91
71
  "values": [{ "name": "light" }, { "name": "dark" }]
92
72
  },
93
73
  {
94
74
  "name": "appearance",
95
- "description": "Specify the appearance of the Alert",
75
+ "description": "Specify the appearance of the BadgeDot",
96
76
  "values": [
97
77
  { "name": "infoPrimary" },
98
78
  { "name": "infoSecondary" },
@@ -102,35 +82,20 @@
102
82
  ]
103
83
  },
104
84
  {
105
- "name": "hidden",
106
- "description": "Specify if the Alert is hidden",
107
- "values": []
108
- },
109
- {
110
- "name": "hideIcon",
111
- "description": "Specify if the icon displays on the Alert",
112
- "values": []
113
- },
114
- {
115
- "name": "dismissible",
116
- "description": "Specify if the Alert can be dismissed",
117
- "values": []
118
- },
119
- {
120
- "name": "disableAutoFocus",
121
- "description": "Prevent autofocus on show",
122
- "values": []
85
+ "name": "emphasis",
86
+ "description": "Specify the emphasis of the BadgeDot",
87
+ "values": [{ "name": "strong" }, { "name": "subtle" }]
123
88
  },
124
89
  {
125
- "name": "disableCloseOnEscape",
126
- "description": "Prevent Escape from closing",
90
+ "name": "overrideDotColor",
91
+ "description": "Overrides default dot color",
127
92
  "values": []
128
93
  }
129
94
  ],
130
95
  "references": [
131
96
  {
132
97
  "name": "Storybook",
133
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
98
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
134
99
  }
135
100
  ]
136
101
  },
@@ -177,142 +142,6 @@
177
142
  }
178
143
  ]
179
144
  },
180
- {
181
- "name": "bm-badge-dot",
182
- "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",
183
- "attributes": [
184
- {
185
- "name": "theme",
186
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
187
- "values": [{ "name": "light" }, { "name": "dark" }]
188
- },
189
- {
190
- "name": "appearance",
191
- "description": "Specify the appearance of the BadgeDot",
192
- "values": [
193
- { "name": "infoPrimary" },
194
- { "name": "infoSecondary" },
195
- { "name": "positive" },
196
- { "name": "warning" },
197
- { "name": "negative" }
198
- ]
199
- },
200
- {
201
- "name": "emphasis",
202
- "description": "Specify the emphasis of the BadgeDot",
203
- "values": [{ "name": "strong" }, { "name": "subtle" }]
204
- },
205
- {
206
- "name": "overrideDotColor",
207
- "description": "Overrides default dot color",
208
- "values": []
209
- }
210
- ],
211
- "references": [
212
- {
213
- "name": "Storybook",
214
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
215
- }
216
- ]
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
145
  {
317
146
  "name": "bm-box",
318
147
  "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",
@@ -712,68 +541,239 @@
712
541
  "references": [
713
542
  {
714
543
  "name": "Storybook",
715
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-box"
544
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-box"
545
+ }
546
+ ]
547
+ },
548
+ {
549
+ "name": "bm-breadcrumb",
550
+ "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",
551
+ "attributes": [
552
+ {
553
+ "name": "wrap",
554
+ "description": "Specify if items wrap or collapse to an ellipsis",
555
+ "values": []
556
+ },
557
+ {
558
+ "name": "itemsBeforeCollapse",
559
+ "description": "Specify how many items show before ellipsis",
560
+ "values": []
561
+ },
562
+ {
563
+ "name": "itemsAfterCollapse",
564
+ "description": "Specify how many items show after ellipsis",
565
+ "values": []
566
+ },
567
+ {
568
+ "name": "theme",
569
+ "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
570
+ "values": [{ "name": "light" }, { "name": "dark" }]
571
+ }
572
+ ],
573
+ "references": [
574
+ {
575
+ "name": "Storybook",
576
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
577
+ }
578
+ ]
579
+ },
580
+ {
581
+ "name": "bm-breadcrumb-item",
582
+ "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",
583
+ "attributes": [
584
+ { "name": "href", "description": "Pass href to an item", "values": [] },
585
+ {
586
+ "name": "clickable",
587
+ "description": "Specify if the item is interactive without an href",
588
+ "values": []
589
+ },
590
+ {
591
+ "name": "truncationWidth",
592
+ "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
593
+ "values": []
594
+ },
595
+ {
596
+ "name": "isCurrent",
597
+ "description": "Specify explicitly if the item is the last one",
598
+ "values": []
599
+ },
600
+ { "name": "isCollapsed", "values": [] }
601
+ ],
602
+ "references": [
603
+ {
604
+ "name": "Storybook",
605
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
606
+ }
607
+ ]
608
+ },
609
+ {
610
+ "name": "bm-avatar",
611
+ "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",
612
+ "attributes": [
613
+ {
614
+ "name": "appearance",
615
+ "description": "Specify the appearance of the Avatar",
616
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
617
+ },
618
+ {
619
+ "name": "name",
620
+ "description": "Specify a name to display initials in the Avatar",
621
+ "values": []
622
+ },
623
+ {
624
+ "name": "src",
625
+ "description": "Pass an image to the Avatar",
626
+ "values": []
627
+ },
628
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
629
+ {
630
+ "name": "size",
631
+ "description": "Specify the size of the Avatar",
632
+ "values": [
633
+ { "name": "xs" },
634
+ { "name": "sm" },
635
+ { "name": "md" },
636
+ { "name": "lg" },
637
+ { "name": "xl" }
638
+ ]
639
+ },
640
+ {
641
+ "name": "disabled",
642
+ "description": "Specify if the Avatar is disabled",
643
+ "values": []
644
+ },
645
+ {
646
+ "name": "shape",
647
+ "description": "Specify the shape of the Avatar",
648
+ "values": [{ "name": "circle" }, { "name": "square" }]
649
+ },
650
+ {
651
+ "name": "isInteractive",
652
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
653
+ "values": []
654
+ },
655
+ {
656
+ "name": "isFocusable",
657
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
658
+ "values": []
659
+ },
660
+ { "name": "withBorder", "values": [] }
661
+ ],
662
+ "references": [
663
+ {
664
+ "name": "Storybook",
665
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
666
+ }
667
+ ]
668
+ },
669
+ {
670
+ "name": "bm-avatar-group",
671
+ "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",
672
+ "attributes": [
673
+ {
674
+ "name": "wrapping",
675
+ "description": "Specify if the AvatarGroup wraps",
676
+ "values": []
677
+ },
678
+ {
679
+ "name": "maxCount",
680
+ "description": "Specify the max number of avatars displayed in the group.",
681
+ "values": []
682
+ },
683
+ {
684
+ "name": "size",
685
+ "description": "Specify the size of all Avatars",
686
+ "values": [
687
+ { "name": "xs" },
688
+ { "name": "sm" },
689
+ { "name": "md" },
690
+ { "name": "lg" },
691
+ { "name": "xl" }
692
+ ]
693
+ },
694
+ {
695
+ "name": "layout",
696
+ "description": "Specify the kind of the group.",
697
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
698
+ }
699
+ ],
700
+ "references": [
701
+ {
702
+ "name": "Storybook",
703
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
716
704
  }
717
705
  ]
718
706
  },
719
707
  {
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",
708
+ "name": "bm-alert",
709
+ "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",
722
710
  "attributes": [
723
711
  {
724
- "name": "wrap",
725
- "description": "Specify if items wrap or collapse to an ellipsis",
712
+ "name": "heading",
713
+ "description": "Specify the heading text for Alert",
726
714
  "values": []
727
715
  },
728
716
  {
729
- "name": "itemsBeforeCollapse",
730
- "description": "Specify how many items show before ellipsis",
717
+ "name": "body",
718
+ "description": "Specify the body text for Alert",
731
719
  "values": []
732
720
  },
733
721
  {
734
- "name": "itemsAfterCollapse",
735
- "description": "Specify how many items show after ellipsis",
722
+ "name": "size",
723
+ "description": "Specify the size of the Alert",
724
+ "values": [{ "name": "sm" }, { "name": "md" }]
725
+ },
726
+ {
727
+ "name": "fullWidth",
728
+ "description": "Specify if the Alert has no border radius",
736
729
  "values": []
737
730
  },
738
731
  {
739
732
  "name": "theme",
740
- "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
733
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
741
734
  "values": [{ "name": "light" }, { "name": "dark" }]
742
- }
743
- ],
744
- "references": [
735
+ },
745
736
  {
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": [] },
737
+ "name": "appearance",
738
+ "description": "Specify the appearance of the Alert",
739
+ "values": [
740
+ { "name": "infoPrimary" },
741
+ { "name": "infoSecondary" },
742
+ { "name": "positive" },
743
+ { "name": "warning" },
744
+ { "name": "negative" }
745
+ ]
746
+ },
756
747
  {
757
- "name": "clickable",
758
- "description": "Specify if the item is interactive without an href",
748
+ "name": "hidden",
749
+ "description": "Specify if the Alert is hidden",
759
750
  "values": []
760
751
  },
761
752
  {
762
- "name": "truncationWidth",
763
- "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
753
+ "name": "hideIcon",
754
+ "description": "Specify if the icon displays on the Alert",
764
755
  "values": []
765
756
  },
766
757
  {
767
- "name": "isCurrent",
768
- "description": "Specify explicitly if the item is the last one",
758
+ "name": "dismissible",
759
+ "description": "Specify if the Alert can be dismissed",
769
760
  "values": []
770
761
  },
771
- { "name": "isCollapsed", "values": [] }
762
+ {
763
+ "name": "disableAutoFocus",
764
+ "description": "Prevent autofocus on show",
765
+ "values": []
766
+ },
767
+ {
768
+ "name": "disableCloseOnEscape",
769
+ "description": "Prevent Escape from closing",
770
+ "values": []
771
+ }
772
772
  ],
773
773
  "references": [
774
774
  {
775
775
  "name": "Storybook",
776
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
776
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
777
777
  }
778
778
  ]
779
779
  },
@@ -2216,51 +2216,6 @@
2216
2216
  }
2217
2217
  ]
2218
2218
  },
2219
- {
2220
- "name": "bm-form",
2221
- "description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
2222
- "attributes": [
2223
- {
2224
- "name": "validationMode",
2225
- "description": "Specify if validation runs on change or when loosing focus",
2226
- "values": [
2227
- { "name": "onChange" },
2228
- { "name": "onBlur" },
2229
- { "name": "onSubmit" }
2230
- ]
2231
- },
2232
- {
2233
- "name": "initialValues",
2234
- "description": "Specify initial values on Form controls based on their names",
2235
- "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2236
- },
2237
- {
2238
- "name": "required",
2239
- "description": "Specify if input is a required",
2240
- "values": []
2241
- },
2242
- {
2243
- "name": "disabled",
2244
- "description": "Specify if input is a disabled",
2245
- "values": []
2246
- },
2247
- {
2248
- "name": "readOnly",
2249
- "description": "Specify if input is a read only",
2250
- "values": []
2251
- },
2252
- { "name": "action", "values": [] },
2253
- { "name": "method", "values": [] },
2254
- { "name": "target", "values": [] },
2255
- { "name": "enctype", "values": [] }
2256
- ],
2257
- "references": [
2258
- {
2259
- "name": "Storybook",
2260
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2261
- }
2262
- ]
2263
- },
2264
2219
  {
2265
2220
  "name": "bm-native-select",
2266
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",
@@ -2383,6 +2338,94 @@
2383
2338
  }
2384
2339
  ]
2385
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",