@viasat/beam-web-components 2.72.1 → 2.73.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,160 @@
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
+ {
138
+ "name": "bm-badge",
139
+ "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",
140
+ "attributes": [
141
+ {
142
+ "name": "appearance",
143
+ "description": "Specify the appearance of the Badge",
144
+ "values": [
145
+ { "name": "infoPrimary" },
146
+ { "name": "infoSecondary" },
147
+ { "name": "positive" },
148
+ { "name": "warning" },
149
+ { "name": "negative" }
150
+ ]
151
+ },
152
+ {
153
+ "name": "theme",
154
+ "description": "Theme of the Badge",
155
+ "values": [{ "name": "light" }, { "name": "dark" }]
156
+ },
157
+ {
158
+ "name": "size",
159
+ "description": "Specify the size of the Badge",
160
+ "values": [{ "name": "sm" }, { "name": "md" }]
161
+ },
162
+ {
163
+ "name": "emphasis",
164
+ "description": "Specify the emphasis of the Badge",
165
+ "values": [
166
+ { "name": "strong" },
167
+ { "name": "medium" },
168
+ { "name": "subtle" }
169
+ ]
170
+ },
171
+ { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
172
+ ],
173
+ "references": [
174
+ {
175
+ "name": "Storybook",
176
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
177
+ }
178
+ ]
179
+ },
180
+ {
181
+ "name": "bm-badge-dot",
182
+ "description": "`bm-badge-dot`\n\n### Attributes:\n- **theme** - Specify the theme of the BadgeDot. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the BadgeDot\n- **emphasis** - Specify the emphasis of the BadgeDot\n- **overrideDotColor** - Overrides default dot color\n---\n\n\n### **Slots:**\n - **default** - Provide text for the BadgeDot",
183
+ "attributes": [
184
+ {
185
+ "name": "theme",
186
+ "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
187
+ "values": [{ "name": "light" }, { "name": "dark" }]
188
+ },
189
+ {
190
+ "name": "appearance",
191
+ "description": "Specify the appearance of the BadgeDot",
192
+ "values": [
193
+ { "name": "infoPrimary" },
194
+ { "name": "infoSecondary" },
195
+ { "name": "positive" },
196
+ { "name": "warning" },
197
+ { "name": "negative" }
198
+ ]
199
+ },
200
+ {
201
+ "name": "emphasis",
202
+ "description": "Specify the emphasis of the BadgeDot",
203
+ "values": [{ "name": "strong" }, { "name": "subtle" }]
204
+ },
205
+ {
206
+ "name": "overrideDotColor",
207
+ "description": "Overrides default dot color",
208
+ "values": []
209
+ }
210
+ ],
211
+ "references": [
212
+ {
213
+ "name": "Storybook",
214
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
215
+ }
216
+ ]
217
+ },
64
218
  {
65
219
  "name": "bm-avatar",
66
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",
@@ -159,44 +313,6 @@
159
313
  }
160
314
  ]
161
315
  },
162
- {
163
- "name": "bm-badge-dot",
164
- "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",
165
- "attributes": [
166
- {
167
- "name": "theme",
168
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
169
- "values": [{ "name": "light" }, { "name": "dark" }]
170
- },
171
- {
172
- "name": "appearance",
173
- "description": "Specify the appearance of the BadgeDot",
174
- "values": [
175
- { "name": "infoPrimary" },
176
- { "name": "infoSecondary" },
177
- { "name": "positive" },
178
- { "name": "warning" },
179
- { "name": "negative" }
180
- ]
181
- },
182
- {
183
- "name": "emphasis",
184
- "description": "Specify the emphasis of the BadgeDot",
185
- "values": [{ "name": "strong" }, { "name": "subtle" }]
186
- },
187
- {
188
- "name": "overrideDotColor",
189
- "description": "Overrides default dot color",
190
- "values": []
191
- }
192
- ],
193
- "references": [
194
- {
195
- "name": "Storybook",
196
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
197
- }
198
- ]
199
- },
200
316
  {
201
317
  "name": "bm-box",
202
318
  "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",
@@ -600,67 +716,6 @@
600
716
  }
601
717
  ]
602
718
  },
603
- {
604
- "name": "bm-breadcrumb",
605
- "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",
606
- "attributes": [
607
- {
608
- "name": "wrap",
609
- "description": "Specify if items wrap or collapse to an ellipsis",
610
- "values": []
611
- },
612
- {
613
- "name": "itemsBeforeCollapse",
614
- "description": "Specify how many items show before ellipsis",
615
- "values": []
616
- },
617
- {
618
- "name": "itemsAfterCollapse",
619
- "description": "Specify how many items show after ellipsis",
620
- "values": []
621
- },
622
- {
623
- "name": "theme",
624
- "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
625
- "values": [{ "name": "light" }, { "name": "dark" }]
626
- }
627
- ],
628
- "references": [
629
- {
630
- "name": "Storybook",
631
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
632
- }
633
- ]
634
- },
635
- {
636
- "name": "bm-breadcrumb-item",
637
- "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",
638
- "attributes": [
639
- { "name": "href", "description": "Pass href to an item", "values": [] },
640
- {
641
- "name": "clickable",
642
- "description": "Specify if the item is interactive without an href",
643
- "values": []
644
- },
645
- {
646
- "name": "truncationWidth",
647
- "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
648
- "values": []
649
- },
650
- {
651
- "name": "isCurrent",
652
- "description": "Specify explicitly if the item is the last one",
653
- "values": []
654
- },
655
- { "name": "isCollapsed", "values": [] }
656
- ],
657
- "references": [
658
- {
659
- "name": "Storybook",
660
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
661
- }
662
- ]
663
- },
664
719
  {
665
720
  "name": "bm-button",
666
721
  "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",
@@ -730,118 +785,63 @@
730
785
  ]
731
786
  },
732
787
  {
733
- "name": "bm-alert",
734
- "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",
735
- "attributes": [
788
+ "name": "bm-breadcrumb",
789
+ "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",
790
+ "attributes": [
736
791
  {
737
- "name": "heading",
738
- "description": "Specify the heading text for Alert",
792
+ "name": "wrap",
793
+ "description": "Specify if items wrap or collapse to an ellipsis",
739
794
  "values": []
740
795
  },
741
796
  {
742
- "name": "body",
743
- "description": "Specify the body text for Alert",
797
+ "name": "itemsBeforeCollapse",
798
+ "description": "Specify how many items show before ellipsis",
744
799
  "values": []
745
800
  },
746
801
  {
747
- "name": "size",
748
- "description": "Specify the size of the Alert",
749
- "values": [{ "name": "sm" }, { "name": "md" }]
750
- },
751
- {
752
- "name": "fullWidth",
753
- "description": "Specify if the Alert has no border radius",
802
+ "name": "itemsAfterCollapse",
803
+ "description": "Specify how many items show after ellipsis",
754
804
  "values": []
755
805
  },
756
806
  {
757
807
  "name": "theme",
758
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
808
+ "description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
759
809
  "values": [{ "name": "light" }, { "name": "dark" }]
760
- },
761
- {
762
- "name": "appearance",
763
- "description": "Specify the appearance of the Alert",
764
- "values": [
765
- { "name": "infoPrimary" },
766
- { "name": "infoSecondary" },
767
- { "name": "positive" },
768
- { "name": "warning" },
769
- { "name": "negative" }
770
- ]
771
- },
772
- {
773
- "name": "hidden",
774
- "description": "Specify if the Alert is hidden",
775
- "values": []
776
- },
777
- {
778
- "name": "hideIcon",
779
- "description": "Specify if the icon displays on the Alert",
780
- "values": []
781
- },
782
- {
783
- "name": "dismissible",
784
- "description": "Specify if the Alert can be dismissed",
785
- "values": []
786
- },
787
- {
788
- "name": "disableAutoFocus",
789
- "description": "Prevent autofocus on show",
790
- "values": []
791
- },
792
- {
793
- "name": "disableCloseOnEscape",
794
- "description": "Prevent Escape from closing",
795
- "values": []
796
810
  }
797
811
  ],
798
812
  "references": [
799
813
  {
800
814
  "name": "Storybook",
801
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
815
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
802
816
  }
803
817
  ]
804
818
  },
805
819
  {
806
- "name": "bm-badge",
807
- "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",
820
+ "name": "bm-breadcrumb-item",
821
+ "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",
808
822
  "attributes": [
823
+ { "name": "href", "description": "Pass href to an item", "values": [] },
809
824
  {
810
- "name": "appearance",
811
- "description": "Specify the appearance of the Badge",
812
- "values": [
813
- { "name": "infoPrimary" },
814
- { "name": "infoSecondary" },
815
- { "name": "positive" },
816
- { "name": "warning" },
817
- { "name": "negative" }
818
- ]
819
- },
820
- {
821
- "name": "theme",
822
- "description": "Theme of the Badge",
823
- "values": [{ "name": "light" }, { "name": "dark" }]
825
+ "name": "clickable",
826
+ "description": "Specify if the item is interactive without an href",
827
+ "values": []
824
828
  },
825
829
  {
826
- "name": "size",
827
- "description": "Specify the size of the Badge",
828
- "values": [{ "name": "sm" }, { "name": "md" }]
830
+ "name": "truncationWidth",
831
+ "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
832
+ "values": []
829
833
  },
830
834
  {
831
- "name": "emphasis",
832
- "description": "Specify the emphasis of the Badge",
833
- "values": [
834
- { "name": "strong" },
835
- { "name": "medium" },
836
- { "name": "subtle" }
837
- ]
835
+ "name": "isCurrent",
836
+ "description": "Specify explicitly if the item is the last one",
837
+ "values": []
838
838
  },
839
- { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
839
+ { "name": "isCollapsed", "values": [] }
840
840
  ],
841
841
  "references": [
842
842
  {
843
843
  "name": "Storybook",
844
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
844
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
845
845
  }
846
846
  ]
847
847
  },
@@ -2044,173 +2044,6 @@
2044
2044
  }
2045
2045
  ]
2046
2046
  },
2047
- {
2048
- "name": "bm-native-select",
2049
- "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",
2050
- "attributes": [
2051
- {
2052
- "name": "required",
2053
- "description": "Specify if NativeSelect is a required input",
2054
- "values": []
2055
- },
2056
- {
2057
- "name": "readOnly",
2058
- "description": "Specify if NativeSelect displays in a read-only state",
2059
- "values": []
2060
- },
2061
- {
2062
- "name": "disabled",
2063
- "description": "Specify if NativeSelect displays in a disabled state",
2064
- "values": []
2065
- },
2066
- {
2067
- "name": "fluid",
2068
- "description": "Specify if NativeSelect is fluid",
2069
- "values": []
2070
- },
2071
- {
2072
- "name": "size",
2073
- "description": "Specify the size of NativeSelect",
2074
- "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2075
- },
2076
- {
2077
- "name": "width",
2078
- "description": "Specify the width of NativeSelect",
2079
- "values": []
2080
- },
2081
- {
2082
- "name": "ellipse",
2083
- "description": "Specify if overflow displays ellipsis",
2084
- "values": []
2085
- },
2086
- {
2087
- "name": "hideRequiredMarker",
2088
- "description": "Specify if the NativeSelect displays with an asterisk",
2089
- "values": []
2090
- },
2091
- {
2092
- "name": "theme",
2093
- "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2094
- "values": [{ "name": "light" }, { "name": "dark" }]
2095
- },
2096
- { "name": "id", "values": [] },
2097
- { "name": "name", "values": [] },
2098
- { "name": "value", "values": [] },
2099
- {
2100
- "name": "validationRules",
2101
- "values": [{ "name": "Array<FormValidator>" }]
2102
- },
2103
- { "name": "input-aria-label", "values": [] },
2104
- {
2105
- "name": "error",
2106
- "description": "Specify error text and display error state.\nPass a string to show an error message, or `true` to show the error\nstate without a message.",
2107
- "values": [{ "name": "Optional<boolean" }, { "name": "string>" }]
2108
- }
2109
- ],
2110
- "references": [
2111
- {
2112
- "name": "Storybook",
2113
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
2114
- }
2115
- ]
2116
- },
2117
- {
2118
- "name": "bm-form",
2119
- "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",
2120
- "attributes": [
2121
- {
2122
- "name": "validationMode",
2123
- "description": "Specify if validation runs on change or when loosing focus",
2124
- "values": [
2125
- { "name": "onChange" },
2126
- { "name": "onBlur" },
2127
- { "name": "onSubmit" }
2128
- ]
2129
- },
2130
- {
2131
- "name": "initialValues",
2132
- "description": "Specify initial values on Form controls based on their names",
2133
- "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2134
- },
2135
- {
2136
- "name": "required",
2137
- "description": "Specify if input is a required",
2138
- "values": []
2139
- },
2140
- {
2141
- "name": "disabled",
2142
- "description": "Specify if input is a disabled",
2143
- "values": []
2144
- },
2145
- {
2146
- "name": "readOnly",
2147
- "description": "Specify if input is a read only",
2148
- "values": []
2149
- },
2150
- { "name": "action", "values": [] },
2151
- { "name": "method", "values": [] },
2152
- { "name": "target", "values": [] },
2153
- { "name": "enctype", "values": [] }
2154
- ],
2155
- "references": [
2156
- {
2157
- "name": "Storybook",
2158
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2159
- }
2160
- ]
2161
- },
2162
- {
2163
- "name": "bm-radio-button",
2164
- "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",
2165
- "attributes": [
2166
- {
2167
- "name": "label",
2168
- "description": "Specify the text for the label",
2169
- "values": []
2170
- },
2171
- {
2172
- "name": "error",
2173
- "description": "Specify error text and display error state of a RadioButton",
2174
- "values": []
2175
- },
2176
- {
2177
- "name": "readOnly",
2178
- "description": "Specify if RadioButton displays in a read-only state",
2179
- "values": []
2180
- },
2181
- {
2182
- "name": "disabled",
2183
- "description": "Specify if RadioButton displays in a disabled state",
2184
- "values": []
2185
- },
2186
- {
2187
- "name": "theme",
2188
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2189
- "values": [{ "name": "light" }, { "name": "dark" }]
2190
- },
2191
- {
2192
- "name": "value",
2193
- "description": "The value attribute for the input element",
2194
- "values": []
2195
- },
2196
- {
2197
- "name": "checked",
2198
- "description": "The checked attribute for the input element",
2199
- "values": []
2200
- },
2201
- {
2202
- "name": "onKeyDown",
2203
- "description": "A user-defined function to handle keydown events",
2204
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2205
- }
2206
- ],
2207
- "references": [
2208
- {
2209
- "name": "Storybook",
2210
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2211
- }
2212
- ]
2213
- },
2214
2047
  {
2215
2048
  "name": "bm-file-upload-button",
2216
2049
  "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",
@@ -2518,6 +2351,173 @@
2518
2351
  }
2519
2352
  ]
2520
2353
  },
2354
+ {
2355
+ "name": "bm-native-select",
2356
+ "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",
2357
+ "attributes": [
2358
+ {
2359
+ "name": "required",
2360
+ "description": "Specify if NativeSelect is a required input",
2361
+ "values": []
2362
+ },
2363
+ {
2364
+ "name": "readOnly",
2365
+ "description": "Specify if NativeSelect displays in a read-only state",
2366
+ "values": []
2367
+ },
2368
+ {
2369
+ "name": "disabled",
2370
+ "description": "Specify if NativeSelect displays in a disabled state",
2371
+ "values": []
2372
+ },
2373
+ {
2374
+ "name": "fluid",
2375
+ "description": "Specify if NativeSelect is fluid",
2376
+ "values": []
2377
+ },
2378
+ {
2379
+ "name": "size",
2380
+ "description": "Specify the size of NativeSelect",
2381
+ "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2382
+ },
2383
+ {
2384
+ "name": "width",
2385
+ "description": "Specify the width of NativeSelect",
2386
+ "values": []
2387
+ },
2388
+ {
2389
+ "name": "ellipse",
2390
+ "description": "Specify if overflow displays ellipsis",
2391
+ "values": []
2392
+ },
2393
+ {
2394
+ "name": "hideRequiredMarker",
2395
+ "description": "Specify if the NativeSelect displays with an asterisk",
2396
+ "values": []
2397
+ },
2398
+ {
2399
+ "name": "theme",
2400
+ "description": "Specify the theme of the NativeSelect. By default it inherits the theme from the parent",
2401
+ "values": [{ "name": "light" }, { "name": "dark" }]
2402
+ },
2403
+ { "name": "id", "values": [] },
2404
+ { "name": "name", "values": [] },
2405
+ { "name": "value", "values": [] },
2406
+ {
2407
+ "name": "validationRules",
2408
+ "values": [{ "name": "Array<FormValidator>" }]
2409
+ },
2410
+ { "name": "input-aria-label", "values": [] },
2411
+ {
2412
+ "name": "error",
2413
+ "description": "Specify error text and display error state.\nPass a string to show an error message, or `true` to show the error\nstate without a message.",
2414
+ "values": [{ "name": "Optional<boolean" }, { "name": "string>" }]
2415
+ }
2416
+ ],
2417
+ "references": [
2418
+ {
2419
+ "name": "Storybook",
2420
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
2421
+ }
2422
+ ]
2423
+ },
2424
+ {
2425
+ "name": "bm-form",
2426
+ "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",
2427
+ "attributes": [
2428
+ {
2429
+ "name": "validationMode",
2430
+ "description": "Specify if validation runs on change or when loosing focus",
2431
+ "values": [
2432
+ { "name": "onChange" },
2433
+ { "name": "onBlur" },
2434
+ { "name": "onSubmit" }
2435
+ ]
2436
+ },
2437
+ {
2438
+ "name": "initialValues",
2439
+ "description": "Specify initial values on Form controls based on their names",
2440
+ "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
2441
+ },
2442
+ {
2443
+ "name": "required",
2444
+ "description": "Specify if input is a required",
2445
+ "values": []
2446
+ },
2447
+ {
2448
+ "name": "disabled",
2449
+ "description": "Specify if input is a disabled",
2450
+ "values": []
2451
+ },
2452
+ {
2453
+ "name": "readOnly",
2454
+ "description": "Specify if input is a read only",
2455
+ "values": []
2456
+ },
2457
+ { "name": "action", "values": [] },
2458
+ { "name": "method", "values": [] },
2459
+ { "name": "target", "values": [] },
2460
+ { "name": "enctype", "values": [] }
2461
+ ],
2462
+ "references": [
2463
+ {
2464
+ "name": "Storybook",
2465
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
2466
+ }
2467
+ ]
2468
+ },
2469
+ {
2470
+ "name": "bm-radio-button",
2471
+ "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",
2472
+ "attributes": [
2473
+ {
2474
+ "name": "label",
2475
+ "description": "Specify the text for the label",
2476
+ "values": []
2477
+ },
2478
+ {
2479
+ "name": "error",
2480
+ "description": "Specify error text and display error state of a RadioButton",
2481
+ "values": []
2482
+ },
2483
+ {
2484
+ "name": "readOnly",
2485
+ "description": "Specify if RadioButton displays in a read-only state",
2486
+ "values": []
2487
+ },
2488
+ {
2489
+ "name": "disabled",
2490
+ "description": "Specify if RadioButton displays in a disabled state",
2491
+ "values": []
2492
+ },
2493
+ {
2494
+ "name": "theme",
2495
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2496
+ "values": [{ "name": "light" }, { "name": "dark" }]
2497
+ },
2498
+ {
2499
+ "name": "value",
2500
+ "description": "The value attribute for the input element",
2501
+ "values": []
2502
+ },
2503
+ {
2504
+ "name": "checked",
2505
+ "description": "The checked attribute for the input element",
2506
+ "values": []
2507
+ },
2508
+ {
2509
+ "name": "onKeyDown",
2510
+ "description": "A user-defined function to handle keydown events",
2511
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2512
+ }
2513
+ ],
2514
+ "references": [
2515
+ {
2516
+ "name": "Storybook",
2517
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2518
+ }
2519
+ ]
2520
+ },
2521
2521
  {
2522
2522
  "name": "bm-switch",
2523
2523
  "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.",