@viasat/beam-web-components 2.59.0 → 2.60.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,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,17 +203,37 @@
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
238
  { "name": "infoPrimary" },
121
239
  { "name": "infoSecondary" },
@@ -125,20 +243,35 @@
125
243
  ]
126
244
  },
127
245
  {
128
- "name": "emphasis",
129
- "description": "Specify the emphasis of the BadgeDot",
130
- "values": [{ "name": "strong" }, { "name": "subtle" }]
246
+ "name": "hidden",
247
+ "description": "Specify if the Alert is hidden",
248
+ "values": []
131
249
  },
132
250
  {
133
- "name": "overrideDotColor",
134
- "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",
135
268
  "values": []
136
269
  }
137
270
  ],
138
271
  "references": [
139
272
  {
140
273
  "name": "Storybook",
141
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
274
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
142
275
  }
143
276
  ]
144
277
  },
@@ -546,98 +679,17 @@
546
679
  ]
547
680
  },
548
681
  {
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-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",
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",
612
684
  "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
685
  {
634
686
  "name": "theme",
635
- "description": "Specify the theme of the Alert. 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",
636
688
  "values": [{ "name": "light" }, { "name": "dark" }]
637
689
  },
638
690
  {
639
691
  "name": "appearance",
640
- "description": "Specify the appearance of the Alert",
692
+ "description": "Specify the appearance of the BadgeDot",
641
693
  "values": [
642
694
  { "name": "infoPrimary" },
643
695
  { "name": "infoSecondary" },
@@ -647,133 +699,81 @@
647
699
  ]
648
700
  },
649
701
  {
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": []
702
+ "name": "emphasis",
703
+ "description": "Specify the emphasis of the BadgeDot",
704
+ "values": [{ "name": "strong" }, { "name": "subtle" }]
668
705
  },
669
706
  {
670
- "name": "disableCloseOnEscape",
671
- "description": "Prevent Escape from closing",
707
+ "name": "overrideDotColor",
708
+ "description": "Overrides default dot color",
672
709
  "values": []
673
710
  }
674
711
  ],
675
712
  "references": [
676
713
  {
677
714
  "name": "Storybook",
678
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
715
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
679
716
  }
680
717
  ]
681
718
  },
682
719
  {
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",
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",
685
722
  "attributes": [
686
723
  {
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",
724
+ "name": "wrap",
725
+ "description": "Specify if items wrap or collapse to an ellipsis",
699
726
  "values": []
700
727
  },
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
728
  {
714
- "name": "disabled",
715
- "description": "Specify if the Avatar is disabled",
729
+ "name": "itemsBeforeCollapse",
730
+ "description": "Specify how many items show before ellipsis",
716
731
  "values": []
717
732
  },
718
733
  {
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",
734
+ "name": "itemsAfterCollapse",
735
+ "description": "Specify how many items show after ellipsis",
726
736
  "values": []
727
737
  },
728
738
  {
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": [] }
739
+ "name": "theme",
740
+ "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
741
+ "values": [{ "name": "light" }, { "name": "dark" }]
742
+ }
734
743
  ],
735
744
  "references": [
736
745
  {
737
746
  "name": "Storybook",
738
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
747
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
739
748
  }
740
749
  ]
741
750
  },
742
751
  {
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",
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",
745
754
  "attributes": [
755
+ { "name": "href", "description": "Pass href to an item", "values": [] },
746
756
  {
747
- "name": "wrapping",
748
- "description": "Specify if the AvatarGroup wraps",
757
+ "name": "clickable",
758
+ "description": "Specify if the item is interactive without an href",
749
759
  "values": []
750
760
  },
751
761
  {
752
- "name": "maxCount",
753
- "description": "Specify the max number of avatars displayed in the group.",
762
+ "name": "truncationWidth",
763
+ "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
754
764
  "values": []
755
765
  },
756
766
  {
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
- ]
767
+ "name": "isCurrent",
768
+ "description": "Specify explicitly if the item is the last one",
769
+ "values": []
766
770
  },
767
- {
768
- "name": "layout",
769
- "description": "Specify the kind of the group.",
770
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
771
- }
771
+ { "name": "isCollapsed", "values": [] }
772
772
  ],
773
773
  "references": [
774
774
  {
775
775
  "name": "Storybook",
776
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
776
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
777
777
  }
778
778
  ]
779
779
  },
@@ -1909,121 +1909,6 @@
1909
1909
  }
1910
1910
  ]
1911
1911
  },
1912
- {
1913
- "name": "bm-form",
1914
- "description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
1915
- "attributes": [
1916
- {
1917
- "name": "validationMode",
1918
- "description": "Specify if validation runs on change or when loosing focus",
1919
- "values": [
1920
- { "name": "onChange" },
1921
- { "name": "onBlur" },
1922
- { "name": "onSubmit" }
1923
- ]
1924
- },
1925
- {
1926
- "name": "initialValues",
1927
- "description": "Specify initial values on Form controls based on their names",
1928
- "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
1929
- },
1930
- {
1931
- "name": "required",
1932
- "description": "Specify if input is a required",
1933
- "values": []
1934
- },
1935
- {
1936
- "name": "disabled",
1937
- "description": "Specify if input is a disabled",
1938
- "values": []
1939
- },
1940
- {
1941
- "name": "readOnly",
1942
- "description": "Specify if input is a read only",
1943
- "values": []
1944
- },
1945
- { "name": "action", "values": [] },
1946
- { "name": "method", "values": [] },
1947
- { "name": "target", "values": [] },
1948
- { "name": "enctype", "values": [] }
1949
- ],
1950
- "references": [
1951
- {
1952
- "name": "Storybook",
1953
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
1954
- }
1955
- ]
1956
- },
1957
- {
1958
- "name": "bm-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
1912
  {
2028
1913
  "name": "bm-file-upload-button",
2029
1914
  "description": "`bm-file-upload-button`\n\n### Attributes:\n- **error** - Specify if FileUpload is in error state\n- **accept** - Specify the accepted file types\n- **multiple** - Specify if multiple files can be uploaded\n---\n\n\n### **Slots:**\n - **default** - Specify text for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
@@ -2331,6 +2216,121 @@
2331
2216
  }
2332
2217
  ]
2333
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
+ {
2265
+ "name": "bm-native-select",
2266
+ "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",
2267
+ "attributes": [
2268
+ {
2269
+ "name": "required",
2270
+ "description": "Specify if NativeSelect is a required input",
2271
+ "values": []
2272
+ },
2273
+ {
2274
+ "name": "readOnly",
2275
+ "description": "Specify if NativeSelect displays in a read-only state",
2276
+ "values": []
2277
+ },
2278
+ {
2279
+ "name": "disabled",
2280
+ "description": "Specify if NativeSelect displays in a disabled state",
2281
+ "values": []
2282
+ },
2283
+ {
2284
+ "name": "error",
2285
+ "description": "Specify error text and display error state of a NativeSelect",
2286
+ "values": []
2287
+ },
2288
+ {
2289
+ "name": "fluid",
2290
+ "description": "Specify if NativeSelect is fluid",
2291
+ "values": []
2292
+ },
2293
+ {
2294
+ "name": "size",
2295
+ "description": "Specify the size of NativeSelect",
2296
+ "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2297
+ },
2298
+ {
2299
+ "name": "width",
2300
+ "description": "Specify the width of NativeSelect",
2301
+ "values": []
2302
+ },
2303
+ {
2304
+ "name": "ellipse",
2305
+ "description": "Specify if overflow displays ellipsis",
2306
+ "values": []
2307
+ },
2308
+ {
2309
+ "name": "hideRequiredMarker",
2310
+ "description": "Specify if the NativeSelect displays with an asterisk",
2311
+ "values": []
2312
+ },
2313
+ {
2314
+ "name": "theme",
2315
+ "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2316
+ "values": [{ "name": "light" }, { "name": "dark" }]
2317
+ },
2318
+ { "name": "id", "values": [] },
2319
+ { "name": "name", "values": [] },
2320
+ { "name": "value", "values": [] },
2321
+ {
2322
+ "name": "validationRules",
2323
+ "values": [{ "name": "Array<FormValidator>" }]
2324
+ },
2325
+ { "name": "input-aria-label", "values": [] }
2326
+ ],
2327
+ "references": [
2328
+ {
2329
+ "name": "Storybook",
2330
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
2331
+ }
2332
+ ]
2333
+ },
2334
2334
  {
2335
2335
  "name": "bm-radio-button",
2336
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",