@viasat/beam-web-components 2.21.1 → 2.23.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.
@@ -2,6 +2,65 @@
2
2
  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
3
3
  "version": 1.1,
4
4
  "tags": [
5
+ {
6
+ "name": "bm-accordion",
7
+ "description": "`bm-accordion`\n\n### Attributes:\n- **size** - Specify size of an Accordion\n- **heading** - Specify heading content for the Accordion\n- **open** - Specify if an Accordion is open.\nIf this is specified, the component becomes controlled\n- **defaultOpen** - Specify if an Accordion is open by default\n- **id** - Unique identifier of Accordion\n---\n\n\n### **Events:**\n - **bm-toggle** - Dispatched when the Accordion is toggled\n\n### **Slots:**\n - **default** - Specify body content for the Accordion\n- **icon** - Display an icon before the Accordion heading\n- **heading** - Specify heading content for the Accordion",
8
+ "attributes": [
9
+ {
10
+ "name": "size",
11
+ "description": "Specify size of an Accordion",
12
+ "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
13
+ },
14
+ {
15
+ "name": "heading",
16
+ "description": "Specify heading content for the Accordion",
17
+ "values": []
18
+ },
19
+ {
20
+ "name": "open",
21
+ "description": "Specify if an Accordion is open.\nIf this is specified, the component becomes controlled",
22
+ "values": []
23
+ },
24
+ {
25
+ "name": "defaultOpen",
26
+ "description": "Specify if an Accordion is open by default",
27
+ "values": []
28
+ },
29
+ {
30
+ "name": "id",
31
+ "description": "Unique identifier of Accordion",
32
+ "values": []
33
+ }
34
+ ],
35
+ "references": [
36
+ {
37
+ "name": "Storybook",
38
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-accordion"
39
+ }
40
+ ]
41
+ },
42
+ {
43
+ "name": "bm-accordion-group",
44
+ "description": "`bm-accordion-group`\n\n### Attributes:\n- **size** - Specify the size of the AccordionGroup\n- **singleExpand** - Specify if only one row item can be expanded at a time\n---\n\n\n### **Slots:**\n - **default** - Specify which Accordions are in the AccordionGroup",
45
+ "attributes": [
46
+ {
47
+ "name": "size",
48
+ "description": "Specify the size of the AccordionGroup",
49
+ "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
50
+ },
51
+ {
52
+ "name": "singleExpand",
53
+ "description": "Specify if only one row item can be expanded at a time",
54
+ "values": []
55
+ }
56
+ ],
57
+ "references": [
58
+ {
59
+ "name": "Storybook",
60
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-accordion"
61
+ }
62
+ ]
63
+ },
5
64
  {
6
65
  "name": "bm-badge",
7
66
  "description": "`bm-badge`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Badge\n- **theme** - Theme of the Badge\n- **size** - Specify the size of the Badge\n- **emphasis** - Specify the emphasis of the Badge\n- **hideIcon** - Hides Badge icon\n---\n\n\n### **Slots:**\n - **default** - Provide text for the Badge\n- **icon** - Specify a different icon for the Badge",
@@ -45,44 +104,6 @@
45
104
  }
46
105
  ]
47
106
  },
48
- {
49
- "name": "bm-badge-dot",
50
- "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",
51
- "attributes": [
52
- {
53
- "name": "theme",
54
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
55
- "values": [{ "name": "light" }, { "name": "dark" }]
56
- },
57
- {
58
- "name": "appearance",
59
- "description": "Specify the appearance of the BadgeDot",
60
- "values": [
61
- { "name": "infoPrimary" },
62
- { "name": "infoSecondary" },
63
- { "name": "positive" },
64
- { "name": "warning" },
65
- { "name": "negative" }
66
- ]
67
- },
68
- {
69
- "name": "emphasis",
70
- "description": "Specify the emphasis of the BadgeDot",
71
- "values": [{ "name": "strong" }, { "name": "subtle" }]
72
- },
73
- {
74
- "name": "overrideDotColor",
75
- "description": "Overrides default dot color",
76
- "values": []
77
- }
78
- ],
79
- "references": [
80
- {
81
- "name": "Storybook",
82
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
83
- }
84
- ]
85
- },
86
107
  {
87
108
  "name": "bm-box",
88
109
  "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",
@@ -486,6 +507,44 @@
486
507
  }
487
508
  ]
488
509
  },
510
+ {
511
+ "name": "bm-badge-dot",
512
+ "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",
513
+ "attributes": [
514
+ {
515
+ "name": "theme",
516
+ "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
517
+ "values": [{ "name": "light" }, { "name": "dark" }]
518
+ },
519
+ {
520
+ "name": "appearance",
521
+ "description": "Specify the appearance of the BadgeDot",
522
+ "values": [
523
+ { "name": "infoPrimary" },
524
+ { "name": "infoSecondary" },
525
+ { "name": "positive" },
526
+ { "name": "warning" },
527
+ { "name": "negative" }
528
+ ]
529
+ },
530
+ {
531
+ "name": "emphasis",
532
+ "description": "Specify the emphasis of the BadgeDot",
533
+ "values": [{ "name": "strong" }, { "name": "subtle" }]
534
+ },
535
+ {
536
+ "name": "overrideDotColor",
537
+ "description": "Overrides default dot color",
538
+ "values": []
539
+ }
540
+ ],
541
+ "references": [
542
+ {
543
+ "name": "Storybook",
544
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
545
+ }
546
+ ]
547
+ },
489
548
  {
490
549
  "name": "bm-breadcrumb",
491
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",
@@ -616,81 +675,252 @@
616
675
  ]
617
676
  },
618
677
  {
619
- "name": "bm-close-button",
620
- "description": "`bm-close-button`\n\n### Attributes:\n- **size** - Specify the size of the CloseButton\n- **disabled** - Specify if the CloseButton is disabled\n---\n",
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",
621
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
+ },
622
691
  {
623
692
  "name": "size",
624
- "description": "Specify the size of the CloseButton",
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",
625
709
  "values": [
626
- { "name": "xs" },
627
- { "name": "sm" },
628
- { "name": "md" },
629
- { "name": "lg" },
630
- { "name": "xl" }
710
+ { "name": "infoPrimary" },
711
+ { "name": "infoSecondary" },
712
+ { "name": "positive" },
713
+ { "name": "warning" },
714
+ { "name": "negative" }
631
715
  ]
632
716
  },
633
717
  {
634
- "name": "disabled",
635
- "description": "Specify if the CloseButton is disabled",
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",
636
740
  "values": []
637
741
  }
638
742
  ],
639
743
  "references": [
640
744
  {
641
745
  "name": "Storybook",
642
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-closebutton"
746
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
643
747
  }
644
748
  ]
645
749
  },
646
750
  {
647
- "name": "bm-divider",
648
- "description": "`bm-divider`\n\n### Attributes:\n- **orientation** - Specify the direction of the Divider\n- **borderColor** - Specify the border color of the divider line\n- **borderWidth** - Specify the width of the divider line\n- **borderStyle** - Specify the style of the divider line\n- **alignContent** - Align content to the divider line\n- **length** \n- **inset** - Add equal padding to each side of the Divider\n---\n\n\n### **Slots:**\n - **default** - Add text to the Divider\n- **icon** - Add an icon to the Divider",
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",
649
753
  "attributes": [
650
754
  {
651
- "name": "orientation",
652
- "description": "Specify the direction of the Divider",
653
- "values": [{ "name": "horizontal" }, { "name": "vertical" }]
755
+ "name": "appearance",
756
+ "description": "Specify the appearance of the Avatar",
757
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
654
758
  },
655
759
  {
656
- "name": "borderColor",
657
- "description": "Specify the border color of the divider line",
658
- "values": [
659
- { "name": "positive" },
660
- { "name": "warning" },
661
- { "name": "negative" },
662
- { "name": "inverse" },
663
- { "name": "strong" },
664
- { "name": "00" },
665
- { "name": "00-alt" },
666
- { "name": "01" },
667
- { "name": "02" },
668
- { "name": "03" },
669
- { "name": "info-primary" },
670
- { "name": "info-secondary" },
671
- { "name": "positive-strong" },
672
- { "name": "warning-strong" },
673
- { "name": "negative-strong" },
674
- { "name": "info-primary-strong" },
675
- { "name": "info-secondary-strong" }
676
- ]
760
+ "name": "name",
761
+ "description": "Specify a name to display initials in the Avatar",
762
+ "values": []
677
763
  },
678
764
  {
679
- "name": "borderWidth",
680
- "description": "Specify the width of the divider line",
681
- "values": [{ "name": "md" }, { "name": "lg" }, { "name": "xl" }]
765
+ "name": "src",
766
+ "description": "Pass an image to the Avatar",
767
+ "values": []
682
768
  },
769
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
683
770
  {
684
- "name": "borderStyle",
685
- "description": "Specify the style of the divider line",
771
+ "name": "size",
772
+ "description": "Specify the size of the Avatar",
686
773
  "values": [
687
- { "name": "solid" },
688
- { "name": "dashed" },
689
- { "name": "dotted" }
774
+ { "name": "xs" },
775
+ { "name": "sm" },
776
+ { "name": "md" },
777
+ { "name": "lg" },
778
+ { "name": "xl" }
690
779
  ]
691
780
  },
692
781
  {
693
- "name": "alignContent",
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
+ ]
834
+ },
835
+ {
836
+ "name": "layout",
837
+ "description": "Specify the kind of the group.",
838
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
839
+ }
840
+ ],
841
+ "references": [
842
+ {
843
+ "name": "Storybook",
844
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
845
+ }
846
+ ]
847
+ },
848
+ {
849
+ "name": "bm-close-button",
850
+ "description": "`bm-close-button`\n\n### Attributes:\n- **size** - Specify the size of the CloseButton\n- **disabled** - Specify if the CloseButton is disabled\n---\n",
851
+ "attributes": [
852
+ {
853
+ "name": "size",
854
+ "description": "Specify the size of the CloseButton",
855
+ "values": [
856
+ { "name": "xs" },
857
+ { "name": "sm" },
858
+ { "name": "md" },
859
+ { "name": "lg" },
860
+ { "name": "xl" }
861
+ ]
862
+ },
863
+ {
864
+ "name": "disabled",
865
+ "description": "Specify if the CloseButton is disabled",
866
+ "values": []
867
+ }
868
+ ],
869
+ "references": [
870
+ {
871
+ "name": "Storybook",
872
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-closebutton"
873
+ }
874
+ ]
875
+ },
876
+ {
877
+ "name": "bm-divider",
878
+ "description": "`bm-divider`\n\n### Attributes:\n- **orientation** - Specify the direction of the Divider\n- **borderColor** - Specify the border color of the divider line\n- **borderWidth** - Specify the width of the divider line\n- **borderStyle** - Specify the style of the divider line\n- **alignContent** - Align content to the divider line\n- **length** \n- **inset** - Add equal padding to each side of the Divider\n---\n\n\n### **Slots:**\n - **default** - Add text to the Divider\n- **icon** - Add an icon to the Divider",
879
+ "attributes": [
880
+ {
881
+ "name": "orientation",
882
+ "description": "Specify the direction of the Divider",
883
+ "values": [{ "name": "horizontal" }, { "name": "vertical" }]
884
+ },
885
+ {
886
+ "name": "borderColor",
887
+ "description": "Specify the border color of the divider line",
888
+ "values": [
889
+ { "name": "positive" },
890
+ { "name": "warning" },
891
+ { "name": "negative" },
892
+ { "name": "inverse" },
893
+ { "name": "strong" },
894
+ { "name": "00" },
895
+ { "name": "00-alt" },
896
+ { "name": "01" },
897
+ { "name": "02" },
898
+ { "name": "03" },
899
+ { "name": "info-primary" },
900
+ { "name": "info-secondary" },
901
+ { "name": "positive-strong" },
902
+ { "name": "warning-strong" },
903
+ { "name": "negative-strong" },
904
+ { "name": "info-primary-strong" },
905
+ { "name": "info-secondary-strong" }
906
+ ]
907
+ },
908
+ {
909
+ "name": "borderWidth",
910
+ "description": "Specify the width of the divider line",
911
+ "values": [{ "name": "md" }, { "name": "lg" }, { "name": "xl" }]
912
+ },
913
+ {
914
+ "name": "borderStyle",
915
+ "description": "Specify the style of the divider line",
916
+ "values": [
917
+ { "name": "solid" },
918
+ { "name": "dashed" },
919
+ { "name": "dotted" }
920
+ ]
921
+ },
922
+ {
923
+ "name": "alignContent",
694
924
  "description": "Align content to the divider line",
695
925
  "values": [
696
926
  { "name": "start" },
@@ -928,6 +1158,48 @@
928
1158
  }
929
1159
  ]
930
1160
  },
1161
+ {
1162
+ "name": "bm-label",
1163
+ "description": "`bm-label`\n---\n\n\n### **Slots:**\n - **text** - Specify the text for Label\n- **optional** - Specify if the Label displays as optional\n- **tooltip** - Specify if the icon displays to add a Tooltip",
1164
+ "attributes": [
1165
+ {
1166
+ "name": "disabled",
1167
+ "description": "Specify if the Label displays disabled",
1168
+ "values": []
1169
+ },
1170
+ {
1171
+ "name": "required",
1172
+ "description": "Specify if the Label displays as required",
1173
+ "values": []
1174
+ },
1175
+ {
1176
+ "name": "text",
1177
+ "description": "Specify the text for Label",
1178
+ "values": []
1179
+ },
1180
+ {
1181
+ "name": "optional",
1182
+ "description": "Specify the optional text for Label",
1183
+ "values": []
1184
+ },
1185
+ {
1186
+ "name": "for",
1187
+ "description": "Specify the id of the form element the Label is associated with.\nHandles click-to-focus across shadow DOM. See class-level remarks\nfor accessibility guidance with non-Beam inputs.",
1188
+ "values": []
1189
+ },
1190
+ {
1191
+ "name": "theme",
1192
+ "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
1193
+ "values": [{ "name": "light" }, { "name": "dark" }]
1194
+ }
1195
+ ],
1196
+ "references": [
1197
+ {
1198
+ "name": "Storybook",
1199
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
1200
+ }
1201
+ ]
1202
+ },
931
1203
  {
932
1204
  "name": "bm-link",
933
1205
  "description": "`bm-link`\n\n### Attributes:\n- **appearance** - Specify the appearance of a Link\n- **bold** - Specify if the Link displays as bold\n- **size** - Specify the size of a Link\n- **disabled** - Specify if the Link is disabled\n- **href** - Specify the target link for the href attribute\n- **text** - Provide text for the Link\n- **hideUnderline** - Specify if Link displays with an underline\n---\n\n\n### **Slots:**\n - **default** - Provide text for the Link or use the `text` attribute\n- **iconBefore** - Specify if the Link displays icon before the text\n- **iconAfter** - Specify if the Link displays icon after the text",
@@ -1905,39 +2177,54 @@
1905
2177
  ]
1906
2178
  },
1907
2179
  {
1908
- "name": "bm-label",
1909
- "description": "`bm-label`\n---\n\n\n### **Slots:**\n - **text** - Specify the text for Label\n- **optional** - Specify if the Label displays as optional\n- **tooltip** - Specify if the icon displays to add a Tooltip",
2180
+ "name": "bm-radio-button",
2181
+ "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",
1910
2182
  "attributes": [
1911
2183
  {
1912
- "name": "disabled",
1913
- "description": "Specify if the Label displays disabled",
2184
+ "name": "label",
2185
+ "description": "Specify the text for the label",
1914
2186
  "values": []
1915
2187
  },
1916
2188
  {
1917
- "name": "required",
1918
- "description": "Specify if the Label displays as required",
2189
+ "name": "error",
2190
+ "description": "Specify error text and display error state of a RadioButton",
1919
2191
  "values": []
1920
2192
  },
1921
2193
  {
1922
- "name": "text",
1923
- "description": "Specify the text for Label",
2194
+ "name": "readOnly",
2195
+ "description": "Specify if RadioButton displays in a read-only state",
1924
2196
  "values": []
1925
2197
  },
1926
2198
  {
1927
- "name": "optional",
1928
- "description": "Specify the text for Label",
2199
+ "name": "disabled",
2200
+ "description": "Specify if RadioButton displays in a disabled state",
1929
2201
  "values": []
1930
2202
  },
1931
2203
  {
1932
2204
  "name": "theme",
1933
- "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
2205
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
1934
2206
  "values": [{ "name": "light" }, { "name": "dark" }]
2207
+ },
2208
+ {
2209
+ "name": "value",
2210
+ "description": "The value attribute for the input element",
2211
+ "values": []
2212
+ },
2213
+ {
2214
+ "name": "checked",
2215
+ "description": "The checked attribute for the input element",
2216
+ "values": []
2217
+ },
2218
+ {
2219
+ "name": "onKeyDown",
2220
+ "description": "A user-defined function to handle keydown events",
2221
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
1935
2222
  }
1936
2223
  ],
1937
2224
  "references": [
1938
2225
  {
1939
2226
  "name": "Storybook",
1940
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
2227
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
1941
2228
  }
1942
2229
  ]
1943
2230
  },
@@ -2006,58 +2293,6 @@
2006
2293
  }
2007
2294
  ]
2008
2295
  },
2009
- {
2010
- "name": "bm-radio-button",
2011
- "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",
2012
- "attributes": [
2013
- {
2014
- "name": "label",
2015
- "description": "Specify the text for the label",
2016
- "values": []
2017
- },
2018
- {
2019
- "name": "error",
2020
- "description": "Specify error text and display error state of a RadioButton",
2021
- "values": []
2022
- },
2023
- {
2024
- "name": "readOnly",
2025
- "description": "Specify if RadioButton displays in a read-only state",
2026
- "values": []
2027
- },
2028
- {
2029
- "name": "disabled",
2030
- "description": "Specify if RadioButton displays in a disabled state",
2031
- "values": []
2032
- },
2033
- {
2034
- "name": "theme",
2035
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2036
- "values": [{ "name": "light" }, { "name": "dark" }]
2037
- },
2038
- {
2039
- "name": "value",
2040
- "description": "The value attribute for the input element",
2041
- "values": []
2042
- },
2043
- {
2044
- "name": "checked",
2045
- "description": "The checked attribute for the input element",
2046
- "values": []
2047
- },
2048
- {
2049
- "name": "onKeyDown",
2050
- "description": "A user-defined function to handle keydown events",
2051
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2052
- }
2053
- ],
2054
- "references": [
2055
- {
2056
- "name": "Storybook",
2057
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2058
- }
2059
- ]
2060
- },
2061
2296
  {
2062
2297
  "name": "bm-switch",
2063
2298
  "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.",
@@ -2469,236 +2704,6 @@
2469
2704
  "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2470
2705
  }
2471
2706
  ]
2472
- },
2473
- {
2474
- "name": "bm-accordion",
2475
- "description": "`bm-accordion`\n\n### Attributes:\n- **size** - Specify size of an Accordion\n- **heading** - Specify heading content for the Accordion\n- **open** - Specify if an Accordion is open.\nIf this is specified, the component becomes controlled\n- **defaultOpen** - Specify if an Accordion is open by default\n- **id** - Unique identifier of Accordion\n---\n\n\n### **Events:**\n - **bm-toggle** - Dispatched when the Accordion is toggled\n\n### **Slots:**\n - **default** - Specify body content for the Accordion\n- **icon** - Display an icon before the Accordion heading\n- **heading** - Specify heading content for the Accordion",
2476
- "attributes": [
2477
- {
2478
- "name": "size",
2479
- "description": "Specify size of an Accordion",
2480
- "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2481
- },
2482
- {
2483
- "name": "heading",
2484
- "description": "Specify heading content for the Accordion",
2485
- "values": []
2486
- },
2487
- {
2488
- "name": "open",
2489
- "description": "Specify if an Accordion is open.\nIf this is specified, the component becomes controlled",
2490
- "values": []
2491
- },
2492
- {
2493
- "name": "defaultOpen",
2494
- "description": "Specify if an Accordion is open by default",
2495
- "values": []
2496
- },
2497
- {
2498
- "name": "id",
2499
- "description": "Unique identifier of Accordion",
2500
- "values": []
2501
- }
2502
- ],
2503
- "references": [
2504
- {
2505
- "name": "Storybook",
2506
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-accordion"
2507
- }
2508
- ]
2509
- },
2510
- {
2511
- "name": "bm-accordion-group",
2512
- "description": "`bm-accordion-group`\n\n### Attributes:\n- **size** - Specify the size of the AccordionGroup\n- **singleExpand** - Specify if only one row item can be expanded at a time\n---\n\n\n### **Slots:**\n - **default** - Specify which Accordions are in the AccordionGroup",
2513
- "attributes": [
2514
- {
2515
- "name": "size",
2516
- "description": "Specify the size of the AccordionGroup",
2517
- "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
2518
- },
2519
- {
2520
- "name": "singleExpand",
2521
- "description": "Specify if only one row item can be expanded at a time",
2522
- "values": []
2523
- }
2524
- ],
2525
- "references": [
2526
- {
2527
- "name": "Storybook",
2528
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-accordion"
2529
- }
2530
- ]
2531
- },
2532
- {
2533
- "name": "bm-avatar",
2534
- "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",
2535
- "attributes": [
2536
- {
2537
- "name": "appearance",
2538
- "description": "Specify the appearance of the Avatar",
2539
- "values": [{ "name": "accent" }, { "name": "neutral" }]
2540
- },
2541
- {
2542
- "name": "name",
2543
- "description": "Specify a name to display initials in the Avatar",
2544
- "values": []
2545
- },
2546
- {
2547
- "name": "src",
2548
- "description": "Pass an image to the Avatar",
2549
- "values": []
2550
- },
2551
- { "name": "alt", "description": "Specify alt for image", "values": [] },
2552
- {
2553
- "name": "size",
2554
- "description": "Specify the size of the Avatar",
2555
- "values": [
2556
- { "name": "xs" },
2557
- { "name": "sm" },
2558
- { "name": "md" },
2559
- { "name": "lg" },
2560
- { "name": "xl" }
2561
- ]
2562
- },
2563
- {
2564
- "name": "disabled",
2565
- "description": "Specify if the Avatar is disabled",
2566
- "values": []
2567
- },
2568
- {
2569
- "name": "shape",
2570
- "description": "Specify the shape of the Avatar",
2571
- "values": [{ "name": "circle" }, { "name": "square" }]
2572
- },
2573
- {
2574
- "name": "isInteractive",
2575
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
2576
- "values": []
2577
- },
2578
- {
2579
- "name": "isFocusable",
2580
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
2581
- "values": []
2582
- },
2583
- { "name": "withBorder", "values": [] }
2584
- ],
2585
- "references": [
2586
- {
2587
- "name": "Storybook",
2588
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
2589
- }
2590
- ]
2591
- },
2592
- {
2593
- "name": "bm-avatar-group",
2594
- "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",
2595
- "attributes": [
2596
- {
2597
- "name": "wrapping",
2598
- "description": "Specify if the AvatarGroup wraps",
2599
- "values": []
2600
- },
2601
- {
2602
- "name": "maxCount",
2603
- "description": "Specify the max number of avatars displayed in the group.",
2604
- "values": []
2605
- },
2606
- {
2607
- "name": "size",
2608
- "description": "Specify the size of all Avatars",
2609
- "values": [
2610
- { "name": "xs" },
2611
- { "name": "sm" },
2612
- { "name": "md" },
2613
- { "name": "lg" },
2614
- { "name": "xl" }
2615
- ]
2616
- },
2617
- {
2618
- "name": "layout",
2619
- "description": "Specify the kind of the group.",
2620
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
2621
- }
2622
- ],
2623
- "references": [
2624
- {
2625
- "name": "Storybook",
2626
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
2627
- }
2628
- ]
2629
- },
2630
- {
2631
- "name": "bm-alert",
2632
- "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",
2633
- "attributes": [
2634
- {
2635
- "name": "heading",
2636
- "description": "Specify the heading text for Alert",
2637
- "values": []
2638
- },
2639
- {
2640
- "name": "body",
2641
- "description": "Specify the body text for Alert",
2642
- "values": []
2643
- },
2644
- {
2645
- "name": "size",
2646
- "description": "Specify the size of the Alert",
2647
- "values": [{ "name": "sm" }, { "name": "md" }]
2648
- },
2649
- {
2650
- "name": "fullWidth",
2651
- "description": "Specify if the Alert has no border radius",
2652
- "values": []
2653
- },
2654
- {
2655
- "name": "theme",
2656
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
2657
- "values": [{ "name": "light" }, { "name": "dark" }]
2658
- },
2659
- {
2660
- "name": "appearance",
2661
- "description": "Specify the appearance of the Alert",
2662
- "values": [
2663
- { "name": "infoPrimary" },
2664
- { "name": "infoSecondary" },
2665
- { "name": "positive" },
2666
- { "name": "warning" },
2667
- { "name": "negative" }
2668
- ]
2669
- },
2670
- {
2671
- "name": "hidden",
2672
- "description": "Specify if the Alert is hidden",
2673
- "values": []
2674
- },
2675
- {
2676
- "name": "hideIcon",
2677
- "description": "Specify if the icon displays on the Alert",
2678
- "values": []
2679
- },
2680
- {
2681
- "name": "dismissible",
2682
- "description": "Specify if the Alert can be dismissed",
2683
- "values": []
2684
- },
2685
- {
2686
- "name": "disableAutoFocus",
2687
- "description": "Prevent autofocus on show",
2688
- "values": []
2689
- },
2690
- {
2691
- "name": "disableCloseOnEscape",
2692
- "description": "Prevent Escape from closing",
2693
- "values": []
2694
- }
2695
- ],
2696
- "references": [
2697
- {
2698
- "name": "Storybook",
2699
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
2700
- }
2701
- ]
2702
2707
  }
2703
2708
  ]
2704
2709
  }