@viasat/beam-web-components 2.10.0 → 2.10.2

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,6 +61,104 @@
61
61
  }
62
62
  ]
63
63
  },
64
+ {
65
+ "name": "bm-avatar",
66
+ "description": "`bm-avatar`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Avatar\n- **name** - Specify a name to display initials in the Avatar\n- **src** - Pass an image to the Avatar\n- **alt** - Specify alt for image\n- **size** - Specify the size of the Avatar\n- **disabled** - Specify if the Avatar is disabled\n- **shape** - Specify the shape of the Avatar\n- **isInteractive** - If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer\n- **isFocusable** - If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable\n- **withBorder** \n---\n\n\n### **Slots:**\n - **icon** - Customize the default icon",
67
+ "attributes": [
68
+ {
69
+ "name": "appearance",
70
+ "description": "Specify the appearance of the Avatar",
71
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
72
+ },
73
+ {
74
+ "name": "name",
75
+ "description": "Specify a name to display initials in the Avatar",
76
+ "values": []
77
+ },
78
+ {
79
+ "name": "src",
80
+ "description": "Pass an image to the Avatar",
81
+ "values": []
82
+ },
83
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
84
+ {
85
+ "name": "size",
86
+ "description": "Specify the size of the Avatar",
87
+ "values": [
88
+ { "name": "xs" },
89
+ { "name": "sm" },
90
+ { "name": "md" },
91
+ { "name": "lg" },
92
+ { "name": "xl" }
93
+ ]
94
+ },
95
+ {
96
+ "name": "disabled",
97
+ "description": "Specify if the Avatar is disabled",
98
+ "values": []
99
+ },
100
+ {
101
+ "name": "shape",
102
+ "description": "Specify the shape of the Avatar",
103
+ "values": [{ "name": "circle" }, { "name": "square" }]
104
+ },
105
+ {
106
+ "name": "isInteractive",
107
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
108
+ "values": []
109
+ },
110
+ {
111
+ "name": "isFocusable",
112
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
113
+ "values": []
114
+ },
115
+ { "name": "withBorder", "values": [] }
116
+ ],
117
+ "references": [
118
+ {
119
+ "name": "Storybook",
120
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
121
+ }
122
+ ]
123
+ },
124
+ {
125
+ "name": "bm-avatar-group",
126
+ "description": "`bm-avatar-group`\n\n### Attributes:\n- **wrapping** - Specify if the AvatarGroup wraps\n- **maxCount** - Specify the max number of avatars displayed in the group.\n- **size** - Specify the size of all Avatars\n- **layout** - Specify the kind of the group.\n---\n\n\n### **Slots:**\n - **default** - Add Avatars to create a group",
127
+ "attributes": [
128
+ {
129
+ "name": "wrapping",
130
+ "description": "Specify if the AvatarGroup wraps",
131
+ "values": []
132
+ },
133
+ {
134
+ "name": "maxCount",
135
+ "description": "Specify the max number of avatars displayed in the group.",
136
+ "values": []
137
+ },
138
+ {
139
+ "name": "size",
140
+ "description": "Specify the size of all Avatars",
141
+ "values": [
142
+ { "name": "xs" },
143
+ { "name": "sm" },
144
+ { "name": "md" },
145
+ { "name": "lg" },
146
+ { "name": "xl" }
147
+ ]
148
+ },
149
+ {
150
+ "name": "layout",
151
+ "description": "Specify the kind of the group.",
152
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
153
+ }
154
+ ],
155
+ "references": [
156
+ {
157
+ "name": "Storybook",
158
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
159
+ }
160
+ ]
161
+ },
64
162
  {
65
163
  "name": "bm-badge",
66
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",
@@ -105,44 +203,75 @@
105
203
  ]
106
204
  },
107
205
  {
108
- "name": "bm-badge-dot",
109
- "description": "`bm-badge-dot`\n\n### Attributes:\n- **theme** - Specify the theme of the BadgeDot. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the BadgeDot\n- **emphasis** - Specify the emphasis of the BadgeDot\n- **overrideDotColor** - Overrides default dot color\n---\n\n\n### **Slots:**\n - **default** - Provide text for the BadgeDot",
206
+ "name": "bm-alert",
207
+ "description": "`bm-alert`\n\n### Attributes:\n- **heading** - Specify the heading text for Alert\n- **body** - Specify the body text for Alert\n- **size** - Specify the size of the Alert\n- **fullWidth** - Specify if the Alert has no border radius\n- **theme** - Specify the theme of the Alert. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the Alert\n- **hidden** - Specify if the Alert is hidden\n- **hideIcon** - Specify if the icon displays on the Alert\n- **dismissible** - Specify if the Alert can be dismissed\n- **disableAutoFocus** - Prevent autofocus on show\n- **disableCloseOnEscape** - Prevent Escape from closing\n---\n\n\n### **Events:**\n - **bm-dismiss** - Dispatched when the Alert has been dismissed\n\n### **Slots:**\n - **icon** - Specify a different icon for the Alert\n- **heading** - Specify the heading text for Alert or pass the `heading` attribute to set the heading\n- **body** - Specify the body text for Alert or pass the `body` attribute to set the body\n- **actions** - Specify if actions display on the Alert",
110
208
  "attributes": [
209
+ {
210
+ "name": "heading",
211
+ "description": "Specify the heading text for Alert",
212
+ "values": []
213
+ },
214
+ {
215
+ "name": "body",
216
+ "description": "Specify the body text for Alert",
217
+ "values": []
218
+ },
219
+ {
220
+ "name": "size",
221
+ "description": "Specify the size of the Alert",
222
+ "values": [{ "name": "sm" }, { "name": "md" }]
223
+ },
224
+ {
225
+ "name": "fullWidth",
226
+ "description": "Specify if the Alert has no border radius",
227
+ "values": []
228
+ },
111
229
  {
112
230
  "name": "theme",
113
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
231
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
114
232
  "values": [{ "name": "light" }, { "name": "dark" }]
115
233
  },
116
234
  {
117
235
  "name": "appearance",
118
- "description": "Specify the appearance of the BadgeDot",
236
+ "description": "Specify the appearance of the Alert",
119
237
  "values": [
120
- { "name": "primary" },
121
- { "name": "secondary" },
122
238
  { "name": "infoPrimary" },
123
239
  { "name": "infoSecondary" },
124
240
  { "name": "positive" },
125
241
  { "name": "warning" },
126
- { "name": "negative" },
127
- { "name": "inverse" },
128
- { "name": "secondaryInverse" }
242
+ { "name": "negative" }
129
243
  ]
130
244
  },
131
245
  {
132
- "name": "emphasis",
133
- "description": "Specify the emphasis of the BadgeDot",
134
- "values": [{ "name": "Emphasis" }]
246
+ "name": "hidden",
247
+ "description": "Specify if the Alert is hidden",
248
+ "values": []
135
249
  },
136
250
  {
137
- "name": "overrideDotColor",
138
- "description": "Overrides default dot color",
251
+ "name": "hideIcon",
252
+ "description": "Specify if the icon displays on the Alert",
253
+ "values": []
254
+ },
255
+ {
256
+ "name": "dismissible",
257
+ "description": "Specify if the Alert can be dismissed",
258
+ "values": []
259
+ },
260
+ {
261
+ "name": "disableAutoFocus",
262
+ "description": "Prevent autofocus on show",
263
+ "values": []
264
+ },
265
+ {
266
+ "name": "disableCloseOnEscape",
267
+ "description": "Prevent Escape from closing",
139
268
  "values": []
140
269
  }
141
270
  ],
142
271
  "references": [
143
272
  {
144
273
  "name": "Storybook",
145
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
274
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
146
275
  }
147
276
  ]
148
277
  },
@@ -550,161 +679,105 @@
550
679
  ]
551
680
  },
552
681
  {
553
- "name": "bm-breadcrumb",
554
- "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",
682
+ "name": "bm-badge-dot",
683
+ "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",
555
684
  "attributes": [
556
- {
557
- "name": "wrap",
558
- "description": "Specify if items wrap or collapse to an ellipsis",
559
- "values": []
560
- },
561
- {
562
- "name": "itemsBeforeCollapse",
563
- "description": "Specify how many items show before ellipsis",
564
- "values": []
565
- },
566
- {
567
- "name": "itemsAfterCollapse",
568
- "description": "Specify how many items show after ellipsis",
569
- "values": []
570
- },
571
685
  {
572
686
  "name": "theme",
573
- "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
687
+ "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
574
688
  "values": [{ "name": "light" }, { "name": "dark" }]
575
- }
576
- ],
577
- "references": [
578
- {
579
- "name": "Storybook",
580
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
581
- }
582
- ]
583
- },
584
- {
585
- "name": "bm-breadcrumb-item",
586
- "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",
587
- "attributes": [
588
- { "name": "href", "description": "Pass href to an item", "values": [] },
689
+ },
589
690
  {
590
- "name": "clickable",
591
- "description": "Specify if the item is interactive without an href",
592
- "values": []
691
+ "name": "appearance",
692
+ "description": "Specify the appearance of the BadgeDot",
693
+ "values": [
694
+ { "name": "primary" },
695
+ { "name": "secondary" },
696
+ { "name": "infoPrimary" },
697
+ { "name": "infoSecondary" },
698
+ { "name": "positive" },
699
+ { "name": "warning" },
700
+ { "name": "negative" },
701
+ { "name": "inverse" },
702
+ { "name": "secondaryInverse" }
703
+ ]
593
704
  },
594
705
  {
595
- "name": "truncationWidth",
596
- "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
597
- "values": []
706
+ "name": "emphasis",
707
+ "description": "Specify the emphasis of the BadgeDot",
708
+ "values": [{ "name": "Emphasis" }]
598
709
  },
599
710
  {
600
- "name": "isCurrent",
601
- "description": "Specify explicitly if the item is the last one",
711
+ "name": "overrideDotColor",
712
+ "description": "Overrides default dot color",
602
713
  "values": []
603
- },
604
- { "name": "isCollapsed", "values": [] }
714
+ }
605
715
  ],
606
716
  "references": [
607
717
  {
608
718
  "name": "Storybook",
609
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
719
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
610
720
  }
611
721
  ]
612
722
  },
613
723
  {
614
- "name": "bm-avatar",
615
- "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",
724
+ "name": "bm-breadcrumb",
725
+ "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",
616
726
  "attributes": [
617
727
  {
618
- "name": "appearance",
619
- "description": "Specify the appearance of the Avatar",
620
- "values": [{ "name": "accent" }, { "name": "neutral" }]
621
- },
622
- {
623
- "name": "name",
624
- "description": "Specify a name to display initials in the Avatar",
625
- "values": []
626
- },
627
- {
628
- "name": "src",
629
- "description": "Pass an image to the Avatar",
728
+ "name": "wrap",
729
+ "description": "Specify if items wrap or collapse to an ellipsis",
630
730
  "values": []
631
731
  },
632
- { "name": "alt", "description": "Specify alt for image", "values": [] },
633
- {
634
- "name": "size",
635
- "description": "Specify the size of the Avatar",
636
- "values": [
637
- { "name": "xs" },
638
- { "name": "sm" },
639
- { "name": "md" },
640
- { "name": "lg" },
641
- { "name": "xl" }
642
- ]
643
- },
644
732
  {
645
- "name": "disabled",
646
- "description": "Specify if the Avatar is disabled",
733
+ "name": "itemsBeforeCollapse",
734
+ "description": "Specify how many items show before ellipsis",
647
735
  "values": []
648
736
  },
649
737
  {
650
- "name": "shape",
651
- "description": "Specify the shape of the Avatar",
652
- "values": [{ "name": "circle" }, { "name": "square" }]
653
- },
654
- {
655
- "name": "isInteractive",
656
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
738
+ "name": "itemsAfterCollapse",
739
+ "description": "Specify how many items show after ellipsis",
657
740
  "values": []
658
741
  },
659
742
  {
660
- "name": "isFocusable",
661
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
662
- "values": []
663
- },
664
- { "name": "withBorder", "values": [] }
743
+ "name": "theme",
744
+ "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
745
+ "values": [{ "name": "light" }, { "name": "dark" }]
746
+ }
665
747
  ],
666
748
  "references": [
667
749
  {
668
750
  "name": "Storybook",
669
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
751
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
670
752
  }
671
753
  ]
672
754
  },
673
755
  {
674
- "name": "bm-avatar-group",
675
- "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",
756
+ "name": "bm-breadcrumb-item",
757
+ "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",
676
758
  "attributes": [
759
+ { "name": "href", "description": "Pass href to an item", "values": [] },
677
760
  {
678
- "name": "wrapping",
679
- "description": "Specify if the AvatarGroup wraps",
680
- "values": []
681
- },
682
- {
683
- "name": "maxCount",
684
- "description": "Specify the max number of avatars displayed in the group.",
685
- "values": []
686
- },
687
- {
688
- "name": "size",
689
- "description": "Specify the size of all Avatars",
690
- "values": [
691
- { "name": "xs" },
692
- { "name": "sm" },
693
- { "name": "md" },
694
- { "name": "lg" },
695
- { "name": "xl" }
696
- ]
761
+ "name": "clickable",
762
+ "description": "Specify if the item is interactive without an href",
763
+ "values": []
697
764
  },
698
765
  {
699
- "name": "layout",
700
- "description": "Specify the kind of the group.",
701
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
702
- }
766
+ "name": "truncationWidth",
767
+ "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
768
+ "values": []
769
+ },
770
+ {
771
+ "name": "isCurrent",
772
+ "description": "Specify explicitly if the item is the last one",
773
+ "values": []
774
+ },
775
+ { "name": "isCollapsed", "values": [] }
703
776
  ],
704
777
  "references": [
705
778
  {
706
779
  "name": "Storybook",
707
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
780
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
708
781
  }
709
782
  ]
710
783
  },
@@ -776,79 +849,6 @@
776
849
  }
777
850
  ]
778
851
  },
779
- {
780
- "name": "bm-alert",
781
- "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",
782
- "attributes": [
783
- {
784
- "name": "heading",
785
- "description": "Specify the heading text for Alert",
786
- "values": []
787
- },
788
- {
789
- "name": "body",
790
- "description": "Specify the body text for Alert",
791
- "values": []
792
- },
793
- {
794
- "name": "size",
795
- "description": "Specify the size of the Alert",
796
- "values": [{ "name": "sm" }, { "name": "md" }]
797
- },
798
- {
799
- "name": "fullWidth",
800
- "description": "Specify if the Alert has no border radius",
801
- "values": []
802
- },
803
- {
804
- "name": "theme",
805
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
806
- "values": [{ "name": "light" }, { "name": "dark" }]
807
- },
808
- {
809
- "name": "appearance",
810
- "description": "Specify the appearance of the Alert",
811
- "values": [
812
- { "name": "infoPrimary" },
813
- { "name": "infoSecondary" },
814
- { "name": "positive" },
815
- { "name": "warning" },
816
- { "name": "negative" }
817
- ]
818
- },
819
- {
820
- "name": "hidden",
821
- "description": "Specify if the Alert is hidden",
822
- "values": []
823
- },
824
- {
825
- "name": "hideIcon",
826
- "description": "Specify if the icon displays on the Alert",
827
- "values": []
828
- },
829
- {
830
- "name": "dismissible",
831
- "description": "Specify if the Alert can be dismissed",
832
- "values": []
833
- },
834
- {
835
- "name": "disableAutoFocus",
836
- "description": "Prevent autofocus on show",
837
- "values": []
838
- },
839
- {
840
- "name": "disableCloseOnEscape",
841
- "description": "Prevent Escape from closing",
842
- "values": []
843
- }
844
- ],
845
- "references": [
846
- {
847
- "name": "Storybook",
848
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
849
- }
850
- ]
851
- },
852
852
  {
853
853
  "name": "bm-close-button",
854
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",
@@ -1761,6 +1761,88 @@
1761
1761
  }
1762
1762
  ]
1763
1763
  },
1764
+ {
1765
+ "name": "bm-form",
1766
+ "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",
1767
+ "attributes": [
1768
+ {
1769
+ "name": "validationMode",
1770
+ "description": "Specify if validation runs on change or when loosing focus",
1771
+ "values": [
1772
+ { "name": "onChange" },
1773
+ { "name": "onBlur" },
1774
+ { "name": "onSubmit" }
1775
+ ]
1776
+ },
1777
+ {
1778
+ "name": "initialValues",
1779
+ "description": "Specify initial values on Form controls based on their names",
1780
+ "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
1781
+ },
1782
+ {
1783
+ "name": "required",
1784
+ "description": "Specify if input is a required",
1785
+ "values": []
1786
+ },
1787
+ {
1788
+ "name": "disabled",
1789
+ "description": "Specify if input is a disabled",
1790
+ "values": []
1791
+ },
1792
+ {
1793
+ "name": "readOnly",
1794
+ "description": "Specify if input is a read only",
1795
+ "values": []
1796
+ },
1797
+ { "name": "action", "values": [{ "name": "Optional<string>" }] },
1798
+ { "name": "method", "values": [{ "name": "Optional<string>" }] },
1799
+ { "name": "target", "values": [{ "name": "Optional<string>" }] },
1800
+ { "name": "enctype", "values": [{ "name": "Optional<string>" }] }
1801
+ ],
1802
+ "references": [
1803
+ {
1804
+ "name": "Storybook",
1805
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
1806
+ }
1807
+ ]
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
+ },
1764
1846
  {
1765
1847
  "name": "bm-file-upload-button",
1766
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",
@@ -2071,43 +2153,6 @@
2071
2153
  }
2072
2154
  ]
2073
2155
  },
2074
- {
2075
- "name": "bm-label",
2076
- "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",
2077
- "attributes": [
2078
- {
2079
- "name": "disabled",
2080
- "description": "Specify if the Label displays disabled",
2081
- "values": []
2082
- },
2083
- {
2084
- "name": "required",
2085
- "description": "Specify if the Label displays as required",
2086
- "values": []
2087
- },
2088
- {
2089
- "name": "text",
2090
- "description": "Specify the text for Label",
2091
- "values": [{ "name": "Optional<string>" }]
2092
- },
2093
- {
2094
- "name": "optional",
2095
- "description": "Specify the text for Label",
2096
- "values": [{ "name": "Optional<string>" }]
2097
- },
2098
- {
2099
- "name": "theme",
2100
- "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
2101
- "values": [{ "name": "Optional<ThemeTypes>" }]
2102
- }
2103
- ],
2104
- "references": [
2105
- {
2106
- "name": "Storybook",
2107
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
2108
- }
2109
- ]
2110
- },
2111
2156
  {
2112
2157
  "name": "bm-native-select",
2113
2158
  "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",
@@ -2228,51 +2273,6 @@
2228
2273
  }
2229
2274
  ]
2230
2275
  },
2231
- {
2232
- "name": "bm-form",
2233
- "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",
2234
- "attributes": [
2235
- {
2236
- "name": "validationMode",
2237
- "description": "Specify if validation runs on change or when loosing focus",
2238
- "values": [
2239
- { "name": "onChange" },
2240
- { "name": "onBlur" },
2241
- { "name": "onSubmit" }
2242
- ]
2243
- },
2244
- {
2245
- "name": "initialValues",
2246
- "description": "Specify initial values on Form controls based on their names",
2247
- "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2248
- },
2249
- {
2250
- "name": "required",
2251
- "description": "Specify if input is a required",
2252
- "values": []
2253
- },
2254
- {
2255
- "name": "disabled",
2256
- "description": "Specify if input is a disabled",
2257
- "values": []
2258
- },
2259
- {
2260
- "name": "readOnly",
2261
- "description": "Specify if input is a read only",
2262
- "values": []
2263
- },
2264
- { "name": "action", "values": [{ "name": "Optional<string>" }] },
2265
- { "name": "method", "values": [{ "name": "Optional<string>" }] },
2266
- { "name": "target", "values": [{ "name": "Optional<string>" }] },
2267
- { "name": "enctype", "values": [{ "name": "Optional<string>" }] }
2268
- ],
2269
- "references": [
2270
- {
2271
- "name": "Storybook",
2272
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2273
- }
2274
- ]
2275
- },
2276
2276
  {
2277
2277
  "name": "bm-switch",
2278
2278
  "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.",