@viasat/beam-web-components 2.43.0 → 2.43.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.
@@ -62,17 +62,37 @@
62
62
  ]
63
63
  },
64
64
  {
65
- "name": "bm-badge-dot",
66
- "description": "`bm-badge-dot`\n\n### Attributes:\n- **theme** - Specify the theme of the BadgeDot. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the BadgeDot\n- **emphasis** - Specify the emphasis of the BadgeDot\n- **overrideDotColor** - Overrides default dot color\n---\n\n\n### **Slots:**\n - **default** - Provide text for the BadgeDot",
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
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
+ },
68
88
  {
69
89
  "name": "theme",
70
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
90
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
71
91
  "values": [{ "name": "light" }, { "name": "dark" }]
72
92
  },
73
93
  {
74
94
  "name": "appearance",
75
- "description": "Specify the appearance of the BadgeDot",
95
+ "description": "Specify the appearance of the Alert",
76
96
  "values": [
77
97
  { "name": "infoPrimary" },
78
98
  { "name": "infoSecondary" },
@@ -82,20 +102,35 @@
82
102
  ]
83
103
  },
84
104
  {
85
- "name": "emphasis",
86
- "description": "Specify the emphasis of the BadgeDot",
87
- "values": [{ "name": "strong" }, { "name": "subtle" }]
105
+ "name": "hidden",
106
+ "description": "Specify if the Alert is hidden",
107
+ "values": []
88
108
  },
89
109
  {
90
- "name": "overrideDotColor",
91
- "description": "Overrides default dot color",
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",
92
127
  "values": []
93
128
  }
94
129
  ],
95
130
  "references": [
96
131
  {
97
132
  "name": "Storybook",
98
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
133
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
99
134
  }
100
135
  ]
101
136
  },
@@ -142,6 +177,44 @@
142
177
  }
143
178
  ]
144
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
+ },
145
218
  {
146
219
  "name": "bm-box",
147
220
  "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",
@@ -545,6 +618,104 @@
545
618
  }
546
619
  ]
547
620
  },
621
+ {
622
+ "name": "bm-avatar",
623
+ "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",
624
+ "attributes": [
625
+ {
626
+ "name": "appearance",
627
+ "description": "Specify the appearance of the Avatar",
628
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
629
+ },
630
+ {
631
+ "name": "name",
632
+ "description": "Specify a name to display initials in the Avatar",
633
+ "values": []
634
+ },
635
+ {
636
+ "name": "src",
637
+ "description": "Pass an image to the Avatar",
638
+ "values": []
639
+ },
640
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
641
+ {
642
+ "name": "size",
643
+ "description": "Specify the size of the Avatar",
644
+ "values": [
645
+ { "name": "xs" },
646
+ { "name": "sm" },
647
+ { "name": "md" },
648
+ { "name": "lg" },
649
+ { "name": "xl" }
650
+ ]
651
+ },
652
+ {
653
+ "name": "disabled",
654
+ "description": "Specify if the Avatar is disabled",
655
+ "values": []
656
+ },
657
+ {
658
+ "name": "shape",
659
+ "description": "Specify the shape of the Avatar",
660
+ "values": [{ "name": "circle" }, { "name": "square" }]
661
+ },
662
+ {
663
+ "name": "isInteractive",
664
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
665
+ "values": []
666
+ },
667
+ {
668
+ "name": "isFocusable",
669
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
670
+ "values": []
671
+ },
672
+ { "name": "withBorder", "values": [] }
673
+ ],
674
+ "references": [
675
+ {
676
+ "name": "Storybook",
677
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
678
+ }
679
+ ]
680
+ },
681
+ {
682
+ "name": "bm-avatar-group",
683
+ "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",
684
+ "attributes": [
685
+ {
686
+ "name": "wrapping",
687
+ "description": "Specify if the AvatarGroup wraps",
688
+ "values": []
689
+ },
690
+ {
691
+ "name": "maxCount",
692
+ "description": "Specify the max number of avatars displayed in the group.",
693
+ "values": []
694
+ },
695
+ {
696
+ "name": "size",
697
+ "description": "Specify the size of all Avatars",
698
+ "values": [
699
+ { "name": "xs" },
700
+ { "name": "sm" },
701
+ { "name": "md" },
702
+ { "name": "lg" },
703
+ { "name": "xl" }
704
+ ]
705
+ },
706
+ {
707
+ "name": "layout",
708
+ "description": "Specify the kind of the group.",
709
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
710
+ }
711
+ ],
712
+ "references": [
713
+ {
714
+ "name": "Storybook",
715
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
716
+ }
717
+ ]
718
+ },
548
719
  {
549
720
  "name": "bm-breadcrumb",
550
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",
@@ -662,186 +833,15 @@
662
833
  },
663
834
  {
664
835
  "name": "iconOnly",
665
- "description": "Specify if the icon displays without text",
666
- "values": []
667
- },
668
- { "name": "type", "values": [] }
669
- ],
670
- "references": [
671
- {
672
- "name": "Storybook",
673
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-button"
674
- }
675
- ]
676
- },
677
- {
678
- "name": "bm-alert",
679
- "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",
680
- "attributes": [
681
- {
682
- "name": "heading",
683
- "description": "Specify the heading text for Alert",
684
- "values": []
685
- },
686
- {
687
- "name": "body",
688
- "description": "Specify the body text for Alert",
689
- "values": []
690
- },
691
- {
692
- "name": "size",
693
- "description": "Specify the size of the Alert",
694
- "values": [{ "name": "sm" }, { "name": "md" }]
695
- },
696
- {
697
- "name": "fullWidth",
698
- "description": "Specify if the Alert has no border radius",
699
- "values": []
700
- },
701
- {
702
- "name": "theme",
703
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
704
- "values": [{ "name": "light" }, { "name": "dark" }]
705
- },
706
- {
707
- "name": "appearance",
708
- "description": "Specify the appearance of the Alert",
709
- "values": [
710
- { "name": "infoPrimary" },
711
- { "name": "infoSecondary" },
712
- { "name": "positive" },
713
- { "name": "warning" },
714
- { "name": "negative" }
715
- ]
716
- },
717
- {
718
- "name": "hidden",
719
- "description": "Specify if the Alert is hidden",
720
- "values": []
721
- },
722
- {
723
- "name": "hideIcon",
724
- "description": "Specify if the icon displays on the Alert",
725
- "values": []
726
- },
727
- {
728
- "name": "dismissible",
729
- "description": "Specify if the Alert can be dismissed",
730
- "values": []
731
- },
732
- {
733
- "name": "disableAutoFocus",
734
- "description": "Prevent autofocus on show",
735
- "values": []
736
- },
737
- {
738
- "name": "disableCloseOnEscape",
739
- "description": "Prevent Escape from closing",
740
- "values": []
741
- }
742
- ],
743
- "references": [
744
- {
745
- "name": "Storybook",
746
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
747
- }
748
- ]
749
- },
750
- {
751
- "name": "bm-avatar",
752
- "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",
753
- "attributes": [
754
- {
755
- "name": "appearance",
756
- "description": "Specify the appearance of the Avatar",
757
- "values": [{ "name": "accent" }, { "name": "neutral" }]
758
- },
759
- {
760
- "name": "name",
761
- "description": "Specify a name to display initials in the Avatar",
762
- "values": []
763
- },
764
- {
765
- "name": "src",
766
- "description": "Pass an image to the Avatar",
767
- "values": []
768
- },
769
- { "name": "alt", "description": "Specify alt for image", "values": [] },
770
- {
771
- "name": "size",
772
- "description": "Specify the size of the Avatar",
773
- "values": [
774
- { "name": "xs" },
775
- { "name": "sm" },
776
- { "name": "md" },
777
- { "name": "lg" },
778
- { "name": "xl" }
779
- ]
780
- },
781
- {
782
- "name": "disabled",
783
- "description": "Specify if the Avatar is disabled",
784
- "values": []
785
- },
786
- {
787
- "name": "shape",
788
- "description": "Specify the shape of the Avatar",
789
- "values": [{ "name": "circle" }, { "name": "square" }]
790
- },
791
- {
792
- "name": "isInteractive",
793
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
794
- "values": []
795
- },
796
- {
797
- "name": "isFocusable",
798
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
799
- "values": []
800
- },
801
- { "name": "withBorder", "values": [] }
802
- ],
803
- "references": [
804
- {
805
- "name": "Storybook",
806
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
807
- }
808
- ]
809
- },
810
- {
811
- "name": "bm-avatar-group",
812
- "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",
813
- "attributes": [
814
- {
815
- "name": "wrapping",
816
- "description": "Specify if the AvatarGroup wraps",
817
- "values": []
818
- },
819
- {
820
- "name": "maxCount",
821
- "description": "Specify the max number of avatars displayed in the group.",
822
- "values": []
823
- },
824
- {
825
- "name": "size",
826
- "description": "Specify the size of all Avatars",
827
- "values": [
828
- { "name": "xs" },
829
- { "name": "sm" },
830
- { "name": "md" },
831
- { "name": "lg" },
832
- { "name": "xl" }
833
- ]
836
+ "description": "Specify if the icon displays without text",
837
+ "values": []
834
838
  },
835
- {
836
- "name": "layout",
837
- "description": "Specify the kind of the group.",
838
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
839
- }
839
+ { "name": "type", "values": [] }
840
840
  ],
841
841
  "references": [
842
842
  {
843
843
  "name": "Storybook",
844
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
844
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-button"
845
845
  }
846
846
  ]
847
847
  },
@@ -1852,108 +1852,6 @@
1852
1852
  }
1853
1853
  ]
1854
1854
  },
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",
1858
- "attributes": [
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",
1866
- "description": "Specify the text for the label",
1867
- "values": []
1868
- },
1869
- {
1870
- "name": "name",
1871
- "description": "Specify the checkbox name",
1872
- "values": []
1873
- },
1874
- {
1875
- "name": "value",
1876
- "description": "Specify the checkbox value",
1877
- "values": []
1878
- },
1879
- {
1880
- "name": "error",
1881
- "description": "Specify error text and display error state of a Checkbox",
1882
- "values": []
1883
- },
1884
- {
1885
- "name": "readOnly",
1886
- "description": "Specify if Checkbox displays in a read-only state",
1887
- "values": []
1888
- },
1889
- {
1890
- "name": "indeterminate",
1891
- "description": "Specify if Checkbox displays in an indeterminate state",
1892
- "values": []
1893
- },
1894
- {
1895
- "name": "disabled",
1896
- "description": "Specify if Checkbox displays in disabled state",
1897
- "values": []
1898
- },
1899
- {
1900
- "name": "checked",
1901
- "description": "Specify if Checkbox is checked",
1902
- "values": []
1903
- }
1904
- ],
1905
- "references": [
1906
- {
1907
- "name": "Storybook",
1908
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-checkbox"
1909
- }
1910
- ]
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
1855
  {
1958
1856
  "name": "bm-file-upload-button",
1959
1857
  "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",
@@ -2262,45 +2160,104 @@
2262
2160
  ]
2263
2161
  },
2264
2162
  {
2265
- "name": "bm-switch",
2266
- "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.",
2163
+ "name": "bm-checkbox",
2164
+ "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",
2267
2165
  "attributes": [
2268
2166
  {
2269
- "name": "onText",
2270
- "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2167
+ "name": "theme",
2168
+ "description": "Specify the theme of the CloseButton. By default it inherits the theme from the parent",
2169
+ "values": [{ "name": "light" }, { "name": "dark" }]
2170
+ },
2171
+ {
2172
+ "name": "label",
2173
+ "description": "Specify the text for the label",
2271
2174
  "values": []
2272
2175
  },
2273
2176
  {
2274
- "name": "offText",
2275
- "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2177
+ "name": "name",
2178
+ "description": "Specify the checkbox name",
2276
2179
  "values": []
2277
2180
  },
2278
2181
  {
2279
- "name": "textPosition",
2280
- "description": "Specify the position of the side label",
2281
- "values": [{ "name": "before" }, { "name": "after" }]
2182
+ "name": "value",
2183
+ "description": "Specify the checkbox value",
2184
+ "values": []
2185
+ },
2186
+ {
2187
+ "name": "error",
2188
+ "description": "Specify error text and display error state of a Checkbox",
2189
+ "values": []
2282
2190
  },
2283
2191
  {
2284
2192
  "name": "readOnly",
2285
- "description": "Specify if Switch displays in a read-only state",
2193
+ "description": "Specify if Checkbox displays in a read-only state",
2194
+ "values": []
2195
+ },
2196
+ {
2197
+ "name": "indeterminate",
2198
+ "description": "Specify if Checkbox displays in an indeterminate state",
2286
2199
  "values": []
2287
2200
  },
2288
2201
  {
2289
2202
  "name": "disabled",
2290
- "description": "Specify if Switch displays in a disabled state",
2203
+ "description": "Specify if Checkbox displays in disabled state",
2291
2204
  "values": []
2292
2205
  },
2293
- { "name": "checked", "values": [] },
2294
2206
  {
2295
- "name": "value",
2296
- "description": "The value attribute for the input element",
2207
+ "name": "checked",
2208
+ "description": "Specify if Checkbox is checked",
2297
2209
  "values": []
2298
2210
  }
2299
2211
  ],
2300
2212
  "references": [
2301
2213
  {
2302
2214
  "name": "Storybook",
2303
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2215
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-checkbox"
2216
+ }
2217
+ ]
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"
2304
2261
  }
2305
2262
  ]
2306
2263
  },
@@ -2426,6 +2383,49 @@
2426
2383
  }
2427
2384
  ]
2428
2385
  },
2386
+ {
2387
+ "name": "bm-switch",
2388
+ "description": "`bm-switch`\n\n### Attributes:\n- **onText** - Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.\n- **offText** - Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.\n- **textPosition** - Specify the position of the side label\n- **readOnly** - Specify if Switch displays in a read-only state\n- **disabled** - Specify if Switch displays in a disabled state\n- **checked** \n- **value** - The value attribute for the input element\n---\n\n\n### **Slots:**\n - **onText** - Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.\n- **offText** - Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2389
+ "attributes": [
2390
+ {
2391
+ "name": "onText",
2392
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2393
+ "values": []
2394
+ },
2395
+ {
2396
+ "name": "offText",
2397
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2398
+ "values": []
2399
+ },
2400
+ {
2401
+ "name": "textPosition",
2402
+ "description": "Specify the position of the side label",
2403
+ "values": [{ "name": "before" }, { "name": "after" }]
2404
+ },
2405
+ {
2406
+ "name": "readOnly",
2407
+ "description": "Specify if Switch displays in a read-only state",
2408
+ "values": []
2409
+ },
2410
+ {
2411
+ "name": "disabled",
2412
+ "description": "Specify if Switch displays in a disabled state",
2413
+ "values": []
2414
+ },
2415
+ { "name": "checked", "values": [] },
2416
+ {
2417
+ "name": "value",
2418
+ "description": "The value attribute for the input element",
2419
+ "values": []
2420
+ }
2421
+ ],
2422
+ "references": [
2423
+ {
2424
+ "name": "Storybook",
2425
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2426
+ }
2427
+ ]
2428
+ },
2429
2429
  {
2430
2430
  "name": "bm-text-area",
2431
2431
  "description": "`bm-text-area`\n---\n\n\n### **Slots:**\n - **label** - Specify the label for TextArea\n- **helper-text** - Specify the helper text for TextArea",
@@ -2586,8 +2586,8 @@
2586
2586
  ]
2587
2587
  },
2588
2588
  {
2589
- "name": "bm-switch-group",
2590
- "description": "`bm-switch-group`\n---\n\n\n### **Slots:**\n - **label** - Slot for the label of the SwitchGroup\n- **helperText** - Slot for the helper text of the SwitchGroup",
2589
+ "name": "bm-radio-button-group",
2590
+ "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
2591
2591
  "attributes": [
2592
2592
  {
2593
2593
  "name": "theme",
@@ -2650,13 +2650,13 @@
2650
2650
  "references": [
2651
2651
  {
2652
2652
  "name": "Storybook",
2653
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2653
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2654
2654
  }
2655
2655
  ]
2656
2656
  },
2657
2657
  {
2658
- "name": "bm-radio-button-group",
2659
- "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
2658
+ "name": "bm-switch-group",
2659
+ "description": "`bm-switch-group`\n---\n\n\n### **Slots:**\n - **label** - Slot for the label of the SwitchGroup\n- **helperText** - Slot for the helper text of the SwitchGroup",
2660
2660
  "attributes": [
2661
2661
  {
2662
2662
  "name": "theme",
@@ -2719,7 +2719,7 @@
2719
2719
  "references": [
2720
2720
  {
2721
2721
  "name": "Storybook",
2722
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2722
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2723
2723
  }
2724
2724
  ]
2725
2725
  }