@viasat/beam-web-components 2.41.0 → 2.42.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,79 +61,6 @@
61
61
  }
62
62
  ]
63
63
  },
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",
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
- {
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" }]
92
- },
93
- {
94
- "name": "appearance",
95
- "description": "Specify the appearance of the Alert",
96
- "values": [
97
- { "name": "infoPrimary" },
98
- { "name": "infoSecondary" },
99
- { "name": "positive" },
100
- { "name": "warning" },
101
- { "name": "negative" }
102
- ]
103
- },
104
- {
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": []
123
- },
124
- {
125
- "name": "disableCloseOnEscape",
126
- "description": "Prevent Escape from closing",
127
- "values": []
128
- }
129
- ],
130
- "references": [
131
- {
132
- "name": "Storybook",
133
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
134
- }
135
- ]
136
- },
137
64
  {
138
65
  "name": "bm-badge",
139
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",
@@ -215,165 +142,6 @@
215
142
  }
216
143
  ]
217
144
  },
218
- {
219
- "name": "bm-avatar",
220
- "description": "`bm-avatar`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Avatar\n- **name** - Specify a name to display initials in the Avatar\n- **src** - Pass an image to the Avatar\n- **alt** - Specify alt for image\n- **size** - Specify the size of the Avatar\n- **disabled** - Specify if the Avatar is disabled\n- **shape** - Specify the shape of the Avatar\n- **isInteractive** - If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer\n- **isFocusable** - If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable\n- **withBorder** \n---\n\n\n### **Slots:**\n - **icon** - Customize the default icon",
221
- "attributes": [
222
- {
223
- "name": "appearance",
224
- "description": "Specify the appearance of the Avatar",
225
- "values": [{ "name": "accent" }, { "name": "neutral" }]
226
- },
227
- {
228
- "name": "name",
229
- "description": "Specify a name to display initials in the Avatar",
230
- "values": []
231
- },
232
- {
233
- "name": "src",
234
- "description": "Pass an image to the Avatar",
235
- "values": []
236
- },
237
- { "name": "alt", "description": "Specify alt for image", "values": [] },
238
- {
239
- "name": "size",
240
- "description": "Specify the size of the Avatar",
241
- "values": [
242
- { "name": "xs" },
243
- { "name": "sm" },
244
- { "name": "md" },
245
- { "name": "lg" },
246
- { "name": "xl" }
247
- ]
248
- },
249
- {
250
- "name": "disabled",
251
- "description": "Specify if the Avatar is disabled",
252
- "values": []
253
- },
254
- {
255
- "name": "shape",
256
- "description": "Specify the shape of the Avatar",
257
- "values": [{ "name": "circle" }, { "name": "square" }]
258
- },
259
- {
260
- "name": "isInteractive",
261
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
262
- "values": []
263
- },
264
- {
265
- "name": "isFocusable",
266
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
267
- "values": []
268
- },
269
- { "name": "withBorder", "values": [] }
270
- ],
271
- "references": [
272
- {
273
- "name": "Storybook",
274
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
275
- }
276
- ]
277
- },
278
- {
279
- "name": "bm-avatar-group",
280
- "description": "`bm-avatar-group`\n\n### Attributes:\n- **wrapping** - Specify if the AvatarGroup wraps\n- **maxCount** - Specify the max number of avatars displayed in the group.\n- **size** - Specify the size of all Avatars\n- **layout** - Specify the kind of the group.\n---\n\n\n### **Slots:**\n - **default** - Add Avatars to create a group",
281
- "attributes": [
282
- {
283
- "name": "wrapping",
284
- "description": "Specify if the AvatarGroup wraps",
285
- "values": []
286
- },
287
- {
288
- "name": "maxCount",
289
- "description": "Specify the max number of avatars displayed in the group.",
290
- "values": []
291
- },
292
- {
293
- "name": "size",
294
- "description": "Specify the size of all Avatars",
295
- "values": [
296
- { "name": "xs" },
297
- { "name": "sm" },
298
- { "name": "md" },
299
- { "name": "lg" },
300
- { "name": "xl" }
301
- ]
302
- },
303
- {
304
- "name": "layout",
305
- "description": "Specify the kind of the group.",
306
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
307
- }
308
- ],
309
- "references": [
310
- {
311
- "name": "Storybook",
312
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
313
- }
314
- ]
315
- },
316
- {
317
- "name": "bm-breadcrumb",
318
- "description": "`bm-breadcrumb`\n\n### Attributes:\n- **wrap** - Specify if items wrap or collapse to an ellipsis\n- **itemsBeforeCollapse** - Specify how many items show before ellipsis\n- **itemsAfterCollapse** - Specify how many items show after ellipsis\n- **theme** - Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent\n---\n\n\n### **Slots:**\n - **default** - Pass items to the Breadcrumb",
319
- "attributes": [
320
- {
321
- "name": "wrap",
322
- "description": "Specify if items wrap or collapse to an ellipsis",
323
- "values": []
324
- },
325
- {
326
- "name": "itemsBeforeCollapse",
327
- "description": "Specify how many items show before ellipsis",
328
- "values": []
329
- },
330
- {
331
- "name": "itemsAfterCollapse",
332
- "description": "Specify how many items show after ellipsis",
333
- "values": []
334
- },
335
- {
336
- "name": "theme",
337
- "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
338
- "values": [{ "name": "light" }, { "name": "dark" }]
339
- }
340
- ],
341
- "references": [
342
- {
343
- "name": "Storybook",
344
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
345
- }
346
- ]
347
- },
348
- {
349
- "name": "bm-breadcrumb-item",
350
- "description": "`bm-breadcrumb-item`\n\n### Attributes:\n- **href** - Pass href to an item\n- **clickable** - Specify if the item is interactive without an href\n- **truncationWidth** - Specify truncation width of the items. Sets max-width for all items but the last.\n- **isCurrent** - Specify explicitly if the item is the last one\n- **isCollapsed** \n---\n\n\n### **Slots:**\n - **default** - Pass text to an item\n- **icon** - Pass icon to an item",
351
- "attributes": [
352
- { "name": "href", "description": "Pass href to an item", "values": [] },
353
- {
354
- "name": "clickable",
355
- "description": "Specify if the item is interactive without an href",
356
- "values": []
357
- },
358
- {
359
- "name": "truncationWidth",
360
- "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
361
- "values": []
362
- },
363
- {
364
- "name": "isCurrent",
365
- "description": "Specify explicitly if the item is the last one",
366
- "values": []
367
- },
368
- { "name": "isCollapsed", "values": [] }
369
- ],
370
- "references": [
371
- {
372
- "name": "Storybook",
373
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
374
- }
375
- ]
376
- },
377
145
  {
378
146
  "name": "bm-box",
379
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",
@@ -778,29 +546,261 @@
778
546
  ]
779
547
  },
780
548
  {
781
- "name": "bm-button",
782
- "description": "`bm-button`\n\n### Attributes:\n- **appearance** - Specify the appearance of a Button\n- **kind** - Specify the kind of Button\n- **size** - Specify the size of a Button\n- **disabled** - Specify if the Button is disabled\n- **fluid** - Specify if Button is fluid\n- **width** - Specify the width of a Button\n- **height** - Specify the height of a Button\n- **theme** - Specify the theme of the Button\n- **iconOnly** - Specify if the icon displays without text\n- **type** \n---\n\n\n### **Slots:**\n - **default** - Provide content for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
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",
783
551
  "attributes": [
784
552
  {
785
- "name": "appearance",
786
- "description": "Specify the appearance of a Button",
787
- "values": [
788
- { "name": "accent" },
789
- { "name": "neutral" },
790
- { "name": "neutral-subtle" },
791
- { "name": "destructive" }
792
- ]
553
+ "name": "wrap",
554
+ "description": "Specify if items wrap or collapse to an ellipsis",
555
+ "values": []
793
556
  },
794
557
  {
795
- "name": "kind",
796
- "description": "Specify the kind of Button",
797
- "values": [
798
- { "name": "filled" },
799
- { "name": "outline" },
800
- { "name": "ghost" },
801
- { "name": "bare" }
802
- ]
803
- },
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-alert",
611
+ "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",
612
+ "attributes": [
613
+ {
614
+ "name": "heading",
615
+ "description": "Specify the heading text for Alert",
616
+ "values": []
617
+ },
618
+ {
619
+ "name": "body",
620
+ "description": "Specify the body text for Alert",
621
+ "values": []
622
+ },
623
+ {
624
+ "name": "size",
625
+ "description": "Specify the size of the Alert",
626
+ "values": [{ "name": "sm" }, { "name": "md" }]
627
+ },
628
+ {
629
+ "name": "fullWidth",
630
+ "description": "Specify if the Alert has no border radius",
631
+ "values": []
632
+ },
633
+ {
634
+ "name": "theme",
635
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
636
+ "values": [{ "name": "light" }, { "name": "dark" }]
637
+ },
638
+ {
639
+ "name": "appearance",
640
+ "description": "Specify the appearance of the Alert",
641
+ "values": [
642
+ { "name": "infoPrimary" },
643
+ { "name": "infoSecondary" },
644
+ { "name": "positive" },
645
+ { "name": "warning" },
646
+ { "name": "negative" }
647
+ ]
648
+ },
649
+ {
650
+ "name": "hidden",
651
+ "description": "Specify if the Alert is hidden",
652
+ "values": []
653
+ },
654
+ {
655
+ "name": "hideIcon",
656
+ "description": "Specify if the icon displays on the Alert",
657
+ "values": []
658
+ },
659
+ {
660
+ "name": "dismissible",
661
+ "description": "Specify if the Alert can be dismissed",
662
+ "values": []
663
+ },
664
+ {
665
+ "name": "disableAutoFocus",
666
+ "description": "Prevent autofocus on show",
667
+ "values": []
668
+ },
669
+ {
670
+ "name": "disableCloseOnEscape",
671
+ "description": "Prevent Escape from closing",
672
+ "values": []
673
+ }
674
+ ],
675
+ "references": [
676
+ {
677
+ "name": "Storybook",
678
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
679
+ }
680
+ ]
681
+ },
682
+ {
683
+ "name": "bm-avatar",
684
+ "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",
685
+ "attributes": [
686
+ {
687
+ "name": "appearance",
688
+ "description": "Specify the appearance of the Avatar",
689
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
690
+ },
691
+ {
692
+ "name": "name",
693
+ "description": "Specify a name to display initials in the Avatar",
694
+ "values": []
695
+ },
696
+ {
697
+ "name": "src",
698
+ "description": "Pass an image to the Avatar",
699
+ "values": []
700
+ },
701
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
702
+ {
703
+ "name": "size",
704
+ "description": "Specify the size of the Avatar",
705
+ "values": [
706
+ { "name": "xs" },
707
+ { "name": "sm" },
708
+ { "name": "md" },
709
+ { "name": "lg" },
710
+ { "name": "xl" }
711
+ ]
712
+ },
713
+ {
714
+ "name": "disabled",
715
+ "description": "Specify if the Avatar is disabled",
716
+ "values": []
717
+ },
718
+ {
719
+ "name": "shape",
720
+ "description": "Specify the shape of the Avatar",
721
+ "values": [{ "name": "circle" }, { "name": "square" }]
722
+ },
723
+ {
724
+ "name": "isInteractive",
725
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
726
+ "values": []
727
+ },
728
+ {
729
+ "name": "isFocusable",
730
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
731
+ "values": []
732
+ },
733
+ { "name": "withBorder", "values": [] }
734
+ ],
735
+ "references": [
736
+ {
737
+ "name": "Storybook",
738
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
739
+ }
740
+ ]
741
+ },
742
+ {
743
+ "name": "bm-avatar-group",
744
+ "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",
745
+ "attributes": [
746
+ {
747
+ "name": "wrapping",
748
+ "description": "Specify if the AvatarGroup wraps",
749
+ "values": []
750
+ },
751
+ {
752
+ "name": "maxCount",
753
+ "description": "Specify the max number of avatars displayed in the group.",
754
+ "values": []
755
+ },
756
+ {
757
+ "name": "size",
758
+ "description": "Specify the size of all Avatars",
759
+ "values": [
760
+ { "name": "xs" },
761
+ { "name": "sm" },
762
+ { "name": "md" },
763
+ { "name": "lg" },
764
+ { "name": "xl" }
765
+ ]
766
+ },
767
+ {
768
+ "name": "layout",
769
+ "description": "Specify the kind of the group.",
770
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
771
+ }
772
+ ],
773
+ "references": [
774
+ {
775
+ "name": "Storybook",
776
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
777
+ }
778
+ ]
779
+ },
780
+ {
781
+ "name": "bm-button",
782
+ "description": "`bm-button`\n\n### Attributes:\n- **appearance** - Specify the appearance of a Button\n- **kind** - Specify the kind of Button\n- **size** - Specify the size of a Button\n- **disabled** - Specify if the Button is disabled\n- **fluid** - Specify if Button is fluid\n- **width** - Specify the width of a Button\n- **height** - Specify the height of a Button\n- **theme** - Specify the theme of the Button\n- **iconOnly** - Specify if the icon displays without text\n- **type** \n---\n\n\n### **Slots:**\n - **default** - Provide content for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
783
+ "attributes": [
784
+ {
785
+ "name": "appearance",
786
+ "description": "Specify the appearance of a Button",
787
+ "values": [
788
+ { "name": "accent" },
789
+ { "name": "neutral" },
790
+ { "name": "neutral-subtle" },
791
+ { "name": "destructive" }
792
+ ]
793
+ },
794
+ {
795
+ "name": "kind",
796
+ "description": "Specify the kind of Button",
797
+ "values": [
798
+ { "name": "filled" },
799
+ { "name": "outline" },
800
+ { "name": "ghost" },
801
+ { "name": "bare" }
802
+ ]
803
+ },
804
804
  {
805
805
  "name": "size",
806
806
  "description": "Specify the size of a Button",
@@ -1853,16 +1853,61 @@
1853
1853
  ]
1854
1854
  },
1855
1855
  {
1856
- "name": "bm-checkbox",
1857
- "description": "`bm-checkbox`\n\n### Attributes:\n- **theme** - Specify the theme of the CloseButton. By default it inherits the theme from the parent\n- **label** - Specify the text for the label\n- **name** - Specify the checkbox name\n- **value** - Specify the checkbox value\n- **error** - Specify error text and display error state of a Checkbox\n- **readOnly** - Specify if Checkbox displays in a read-only state\n- **indeterminate** - Specify if Checkbox displays in an indeterminate state\n- **disabled** - Specify if Checkbox displays in disabled state\n- **checked** - Specify if Checkbox is checked\n---\n",
1856
+ "name": "bm-form",
1857
+ "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",
1858
1858
  "attributes": [
1859
1859
  {
1860
- "name": "theme",
1861
- "description": "Specify the theme of the CloseButton. By default it inherits the theme from the parent",
1862
- "values": [{ "name": "light" }, { "name": "dark" }]
1863
- },
1864
- {
1865
- "name": "label",
1860
+ "name": "validationMode",
1861
+ "description": "Specify if validation runs on change or when loosing focus",
1862
+ "values": [
1863
+ { "name": "onChange" },
1864
+ { "name": "onBlur" },
1865
+ { "name": "onSubmit" }
1866
+ ]
1867
+ },
1868
+ {
1869
+ "name": "initialValues",
1870
+ "description": "Specify initial values on Form controls based on their names",
1871
+ "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
1872
+ },
1873
+ {
1874
+ "name": "required",
1875
+ "description": "Specify if input is a required",
1876
+ "values": []
1877
+ },
1878
+ {
1879
+ "name": "disabled",
1880
+ "description": "Specify if input is a disabled",
1881
+ "values": []
1882
+ },
1883
+ {
1884
+ "name": "readOnly",
1885
+ "description": "Specify if input is a read only",
1886
+ "values": []
1887
+ },
1888
+ { "name": "action", "values": [] },
1889
+ { "name": "method", "values": [] },
1890
+ { "name": "target", "values": [] },
1891
+ { "name": "enctype", "values": [] }
1892
+ ],
1893
+ "references": [
1894
+ {
1895
+ "name": "Storybook",
1896
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
1897
+ }
1898
+ ]
1899
+ },
1900
+ {
1901
+ "name": "bm-checkbox",
1902
+ "description": "`bm-checkbox`\n\n### Attributes:\n- **theme** - Specify the theme of the CloseButton. By default it inherits the theme from the parent\n- **label** - Specify the text for the label\n- **name** - Specify the checkbox name\n- **value** - Specify the checkbox value\n- **error** - Specify error text and display error state of a Checkbox\n- **readOnly** - Specify if Checkbox displays in a read-only state\n- **indeterminate** - Specify if Checkbox displays in an indeterminate state\n- **disabled** - Specify if Checkbox displays in disabled state\n- **checked** - Specify if Checkbox is checked\n---\n",
1903
+ "attributes": [
1904
+ {
1905
+ "name": "theme",
1906
+ "description": "Specify the theme of the CloseButton. By default it inherits the theme from the parent",
1907
+ "values": [{ "name": "light" }, { "name": "dark" }]
1908
+ },
1909
+ {
1910
+ "name": "label",
1866
1911
  "description": "Specify the text for the label",
1867
1912
  "values": []
1868
1913
  },
@@ -1909,6 +1954,128 @@
1909
1954
  }
1910
1955
  ]
1911
1956
  },
1957
+ {
1958
+ "name": "bm-native-select",
1959
+ "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",
1960
+ "attributes": [
1961
+ {
1962
+ "name": "required",
1963
+ "description": "Specify if NativeSelect is a required input",
1964
+ "values": []
1965
+ },
1966
+ {
1967
+ "name": "readOnly",
1968
+ "description": "Specify if NativeSelect displays in a read-only state",
1969
+ "values": []
1970
+ },
1971
+ {
1972
+ "name": "disabled",
1973
+ "description": "Specify if NativeSelect displays in a disabled state",
1974
+ "values": []
1975
+ },
1976
+ {
1977
+ "name": "error",
1978
+ "description": "Specify error text and display error state of a NativeSelect",
1979
+ "values": []
1980
+ },
1981
+ {
1982
+ "name": "fluid",
1983
+ "description": "Specify if NativeSelect is fluid",
1984
+ "values": []
1985
+ },
1986
+ {
1987
+ "name": "size",
1988
+ "description": "Specify the size of NativeSelect",
1989
+ "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
1990
+ },
1991
+ {
1992
+ "name": "width",
1993
+ "description": "Specify the width of NativeSelect",
1994
+ "values": []
1995
+ },
1996
+ {
1997
+ "name": "ellipse",
1998
+ "description": "Specify if overflow displays ellipsis",
1999
+ "values": []
2000
+ },
2001
+ {
2002
+ "name": "hideRequiredMarker",
2003
+ "description": "Specify if the NativeSelect displays with an asterisk",
2004
+ "values": []
2005
+ },
2006
+ {
2007
+ "name": "theme",
2008
+ "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2009
+ "values": [{ "name": "light" }, { "name": "dark" }]
2010
+ },
2011
+ { "name": "id", "values": [] },
2012
+ { "name": "name", "values": [] },
2013
+ { "name": "value", "values": [] },
2014
+ {
2015
+ "name": "validationRules",
2016
+ "values": [{ "name": "Array<FormValidator>" }]
2017
+ },
2018
+ { "name": "input-aria-label", "values": [] }
2019
+ ],
2020
+ "references": [
2021
+ {
2022
+ "name": "Storybook",
2023
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
2024
+ }
2025
+ ]
2026
+ },
2027
+ {
2028
+ "name": "bm-radio-button",
2029
+ "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",
2030
+ "attributes": [
2031
+ {
2032
+ "name": "label",
2033
+ "description": "Specify the text for the label",
2034
+ "values": []
2035
+ },
2036
+ {
2037
+ "name": "error",
2038
+ "description": "Specify error text and display error state of a RadioButton",
2039
+ "values": []
2040
+ },
2041
+ {
2042
+ "name": "readOnly",
2043
+ "description": "Specify if RadioButton displays in a read-only state",
2044
+ "values": []
2045
+ },
2046
+ {
2047
+ "name": "disabled",
2048
+ "description": "Specify if RadioButton displays in a disabled state",
2049
+ "values": []
2050
+ },
2051
+ {
2052
+ "name": "theme",
2053
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2054
+ "values": [{ "name": "light" }, { "name": "dark" }]
2055
+ },
2056
+ {
2057
+ "name": "value",
2058
+ "description": "The value attribute for the input element",
2059
+ "values": []
2060
+ },
2061
+ {
2062
+ "name": "checked",
2063
+ "description": "The checked attribute for the input element",
2064
+ "values": []
2065
+ },
2066
+ {
2067
+ "name": "onKeyDown",
2068
+ "description": "A user-defined function to handle keydown events",
2069
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2070
+ }
2071
+ ],
2072
+ "references": [
2073
+ {
2074
+ "name": "Storybook",
2075
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2076
+ }
2077
+ ]
2078
+ },
1912
2079
  {
1913
2080
  "name": "bm-file-upload-button",
1914
2081
  "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",
@@ -2216,173 +2383,6 @@
2216
2383
  }
2217
2384
  ]
2218
2385
  },
2219
- {
2220
- "name": "bm-native-select",
2221
- "description": "`bm-native-select`\n---\n\n\n### **Slots:**\n - **slot** - Specify Options for NativeSelect\n- **label** - Specify Label for NativeSelect\n- **helper-text** - Specify HelperText for NativeSelect",
2222
- "attributes": [
2223
- {
2224
- "name": "required",
2225
- "description": "Specify if NativeSelect is a required input",
2226
- "values": []
2227
- },
2228
- {
2229
- "name": "readOnly",
2230
- "description": "Specify if NativeSelect displays in a read-only state",
2231
- "values": []
2232
- },
2233
- {
2234
- "name": "disabled",
2235
- "description": "Specify if NativeSelect displays in a disabled state",
2236
- "values": []
2237
- },
2238
- {
2239
- "name": "error",
2240
- "description": "Specify error text and display error state of a NativeSelect",
2241
- "values": []
2242
- },
2243
- {
2244
- "name": "fluid",
2245
- "description": "Specify if NativeSelect is fluid",
2246
- "values": []
2247
- },
2248
- {
2249
- "name": "size",
2250
- "description": "Specify the size of NativeSelect",
2251
- "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2252
- },
2253
- {
2254
- "name": "width",
2255
- "description": "Specify the width of NativeSelect",
2256
- "values": []
2257
- },
2258
- {
2259
- "name": "ellipse",
2260
- "description": "Specify if overflow displays ellipsis",
2261
- "values": []
2262
- },
2263
- {
2264
- "name": "hideRequiredMarker",
2265
- "description": "Specify if the NativeSelect displays with an asterisk",
2266
- "values": []
2267
- },
2268
- {
2269
- "name": "theme",
2270
- "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2271
- "values": [{ "name": "light" }, { "name": "dark" }]
2272
- },
2273
- { "name": "id", "values": [] },
2274
- { "name": "name", "values": [] },
2275
- { "name": "value", "values": [] },
2276
- {
2277
- "name": "validationRules",
2278
- "values": [{ "name": "Array<FormValidator>" }]
2279
- },
2280
- { "name": "input-aria-label", "values": [] }
2281
- ],
2282
- "references": [
2283
- {
2284
- "name": "Storybook",
2285
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
2286
- }
2287
- ]
2288
- },
2289
- {
2290
- "name": "bm-form",
2291
- "description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
2292
- "attributes": [
2293
- {
2294
- "name": "validationMode",
2295
- "description": "Specify if validation runs on change or when loosing focus",
2296
- "values": [
2297
- { "name": "onChange" },
2298
- { "name": "onBlur" },
2299
- { "name": "onSubmit" }
2300
- ]
2301
- },
2302
- {
2303
- "name": "initialValues",
2304
- "description": "Specify initial values on Form controls based on their names",
2305
- "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2306
- },
2307
- {
2308
- "name": "required",
2309
- "description": "Specify if input is a required",
2310
- "values": []
2311
- },
2312
- {
2313
- "name": "disabled",
2314
- "description": "Specify if input is a disabled",
2315
- "values": []
2316
- },
2317
- {
2318
- "name": "readOnly",
2319
- "description": "Specify if input is a read only",
2320
- "values": []
2321
- },
2322
- { "name": "action", "values": [] },
2323
- { "name": "method", "values": [] },
2324
- { "name": "target", "values": [] },
2325
- { "name": "enctype", "values": [] }
2326
- ],
2327
- "references": [
2328
- {
2329
- "name": "Storybook",
2330
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2331
- }
2332
- ]
2333
- },
2334
- {
2335
- "name": "bm-radio-button",
2336
- "description": "`bm-radio-button`\n\n### Attributes:\n- **label** - Specify the text for the label\n- **error** - Specify error text and display error state of a RadioButton\n- **readOnly** - Specify if RadioButton displays in a read-only state\n- **disabled** - Specify if RadioButton displays in a disabled state\n- **theme** - Specify the theme of the RadioButton. By default it inherits the theme from the parent\n- **value** - The value attribute for the input element\n- **checked** - The checked attribute for the input element\n- **onKeyDown** - A user-defined function to handle keydown events\n---\n",
2337
- "attributes": [
2338
- {
2339
- "name": "label",
2340
- "description": "Specify the text for the label",
2341
- "values": []
2342
- },
2343
- {
2344
- "name": "error",
2345
- "description": "Specify error text and display error state of a RadioButton",
2346
- "values": []
2347
- },
2348
- {
2349
- "name": "readOnly",
2350
- "description": "Specify if RadioButton displays in a read-only state",
2351
- "values": []
2352
- },
2353
- {
2354
- "name": "disabled",
2355
- "description": "Specify if RadioButton displays in a disabled state",
2356
- "values": []
2357
- },
2358
- {
2359
- "name": "theme",
2360
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2361
- "values": [{ "name": "light" }, { "name": "dark" }]
2362
- },
2363
- {
2364
- "name": "value",
2365
- "description": "The value attribute for the input element",
2366
- "values": []
2367
- },
2368
- {
2369
- "name": "checked",
2370
- "description": "The checked attribute for the input element",
2371
- "values": []
2372
- },
2373
- {
2374
- "name": "onKeyDown",
2375
- "description": "A user-defined function to handle keydown events",
2376
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2377
- }
2378
- ],
2379
- "references": [
2380
- {
2381
- "name": "Storybook",
2382
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2383
- }
2384
- ]
2385
- },
2386
2386
  {
2387
2387
  "name": "bm-text-area",
2388
2388
  "description": "`bm-text-area`\n---\n\n\n### **Slots:**\n - **label** - Specify the label for TextArea\n- **helper-text** - Specify the helper text for TextArea",