@viasat/beam-web-components 2.56.0 → 2.57.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@viasat/beam-web-components",
3
- "version": "2.56.0",
3
+ "version": "2.57.0",
4
4
  "description": "Framework-agnostic web components for the Beam Design System built with Lit, compatible with Angular, Vue, Svelte, and vanilla JavaScript",
5
5
  "license": "MIT",
6
6
  "author": "Viasat",
@@ -64,11 +64,11 @@
64
64
  "access": "public"
65
65
  },
66
66
  "dependencies": {
67
- "@viasat/beam-fonts": "2.56.0",
68
- "@viasat/beam-shared": "2.56.0",
69
- "@viasat/beam-styles": "2.56.0",
70
- "@viasat/beam-tokens": "2.56.0",
71
- "@viasat/beam-icons": "2.56.0",
67
+ "@viasat/beam-fonts": "2.57.0",
68
+ "@viasat/beam-shared": "2.57.0",
69
+ "@viasat/beam-styles": "2.57.0",
70
+ "@viasat/beam-tokens": "2.57.0",
71
+ "@viasat/beam-icons": "2.57.0",
72
72
  "clsx": "^1.2.1",
73
73
  "lit": "^3.1.0",
74
74
  "@lit/context": "^1.1.1",
@@ -62,75 +62,100 @@
62
62
  ]
63
63
  },
64
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",
65
+ "name": "bm-avatar",
66
+ "description": "`bm-avatar`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Avatar\n- **name** - Specify a name to display initials in the Avatar\n- **src** - Pass an image to the Avatar\n- **alt** - Specify alt for image\n- **size** - Specify the size of the Avatar\n- **disabled** - Specify if the Avatar is disabled\n- **shape** - Specify the shape of the Avatar\n- **isInteractive** - If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer\n- **isFocusable** - If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable\n- **withBorder** \n---\n\n\n### **Slots:**\n - **icon** - Customize the default icon",
67
67
  "attributes": [
68
68
  {
69
- "name": "heading",
70
- "description": "Specify the heading text for Alert",
69
+ "name": "appearance",
70
+ "description": "Specify the appearance of the Avatar",
71
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
72
+ },
73
+ {
74
+ "name": "name",
75
+ "description": "Specify a name to display initials in the Avatar",
71
76
  "values": []
72
77
  },
73
78
  {
74
- "name": "body",
75
- "description": "Specify the body text for Alert",
79
+ "name": "src",
80
+ "description": "Pass an image to the Avatar",
76
81
  "values": []
77
82
  },
83
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
78
84
  {
79
85
  "name": "size",
80
- "description": "Specify the size of the Alert",
81
- "values": [{ "name": "sm" }, { "name": "md" }]
86
+ "description": "Specify the size of the Avatar",
87
+ "values": [
88
+ { "name": "xs" },
89
+ { "name": "sm" },
90
+ { "name": "md" },
91
+ { "name": "lg" },
92
+ { "name": "xl" }
93
+ ]
82
94
  },
83
95
  {
84
- "name": "fullWidth",
85
- "description": "Specify if the Alert has no border radius",
96
+ "name": "disabled",
97
+ "description": "Specify if the Avatar is disabled",
86
98
  "values": []
87
99
  },
88
100
  {
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" }]
101
+ "name": "shape",
102
+ "description": "Specify the shape of the Avatar",
103
+ "values": [{ "name": "circle" }, { "name": "square" }]
92
104
  },
93
105
  {
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
- ]
106
+ "name": "isInteractive",
107
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
108
+ "values": []
103
109
  },
104
110
  {
105
- "name": "hidden",
106
- "description": "Specify if the Alert is hidden",
111
+ "name": "isFocusable",
112
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
107
113
  "values": []
108
114
  },
115
+ { "name": "withBorder", "values": [] }
116
+ ],
117
+ "references": [
109
118
  {
110
- "name": "hideIcon",
111
- "description": "Specify if the icon displays on the Alert",
119
+ "name": "Storybook",
120
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
121
+ }
122
+ ]
123
+ },
124
+ {
125
+ "name": "bm-avatar-group",
126
+ "description": "`bm-avatar-group`\n\n### Attributes:\n- **wrapping** - Specify if the AvatarGroup wraps\n- **maxCount** - Specify the max number of avatars displayed in the group.\n- **size** - Specify the size of all Avatars\n- **layout** - Specify the kind of the group.\n---\n\n\n### **Slots:**\n - **default** - Add Avatars to create a group",
127
+ "attributes": [
128
+ {
129
+ "name": "wrapping",
130
+ "description": "Specify if the AvatarGroup wraps",
112
131
  "values": []
113
132
  },
114
133
  {
115
- "name": "dismissible",
116
- "description": "Specify if the Alert can be dismissed",
134
+ "name": "maxCount",
135
+ "description": "Specify the max number of avatars displayed in the group.",
117
136
  "values": []
118
137
  },
119
138
  {
120
- "name": "disableAutoFocus",
121
- "description": "Prevent autofocus on show",
122
- "values": []
139
+ "name": "size",
140
+ "description": "Specify the size of all Avatars",
141
+ "values": [
142
+ { "name": "xs" },
143
+ { "name": "sm" },
144
+ { "name": "md" },
145
+ { "name": "lg" },
146
+ { "name": "xl" }
147
+ ]
123
148
  },
124
149
  {
125
- "name": "disableCloseOnEscape",
126
- "description": "Prevent Escape from closing",
127
- "values": []
150
+ "name": "layout",
151
+ "description": "Specify the kind of the group.",
152
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
128
153
  }
129
154
  ],
130
155
  "references": [
131
156
  {
132
157
  "name": "Storybook",
133
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
158
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
134
159
  }
135
160
  ]
136
161
  },
@@ -177,6 +202,79 @@
177
202
  }
178
203
  ]
179
204
  },
205
+ {
206
+ "name": "bm-alert",
207
+ "description": "`bm-alert`\n\n### Attributes:\n- **heading** - Specify the heading text for Alert\n- **body** - Specify the body text for Alert\n- **size** - Specify the size of the Alert\n- **fullWidth** - Specify if the Alert has no border radius\n- **theme** - Specify the theme of the Alert. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the Alert\n- **hidden** - Specify if the Alert is hidden\n- **hideIcon** - Specify if the icon displays on the Alert\n- **dismissible** - Specify if the Alert can be dismissed\n- **disableAutoFocus** - Prevent autofocus on show\n- **disableCloseOnEscape** - Prevent Escape from closing\n---\n\n\n### **Events:**\n - **bm-dismiss** - Dispatched when the Alert has been dismissed\n\n### **Slots:**\n - **icon** - Specify a different icon for the Alert\n- **heading** - Specify the heading text for Alert or pass the `heading` attribute to set the heading\n- **body** - Specify the body text for Alert or pass the `body` attribute to set the body\n- **actions** - Specify if actions display on the Alert",
208
+ "attributes": [
209
+ {
210
+ "name": "heading",
211
+ "description": "Specify the heading text for Alert",
212
+ "values": []
213
+ },
214
+ {
215
+ "name": "body",
216
+ "description": "Specify the body text for Alert",
217
+ "values": []
218
+ },
219
+ {
220
+ "name": "size",
221
+ "description": "Specify the size of the Alert",
222
+ "values": [{ "name": "sm" }, { "name": "md" }]
223
+ },
224
+ {
225
+ "name": "fullWidth",
226
+ "description": "Specify if the Alert has no border radius",
227
+ "values": []
228
+ },
229
+ {
230
+ "name": "theme",
231
+ "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
232
+ "values": [{ "name": "light" }, { "name": "dark" }]
233
+ },
234
+ {
235
+ "name": "appearance",
236
+ "description": "Specify the appearance of the Alert",
237
+ "values": [
238
+ { "name": "infoPrimary" },
239
+ { "name": "infoSecondary" },
240
+ { "name": "positive" },
241
+ { "name": "warning" },
242
+ { "name": "negative" }
243
+ ]
244
+ },
245
+ {
246
+ "name": "hidden",
247
+ "description": "Specify if the Alert is hidden",
248
+ "values": []
249
+ },
250
+ {
251
+ "name": "hideIcon",
252
+ "description": "Specify if the icon displays on the Alert",
253
+ "values": []
254
+ },
255
+ {
256
+ "name": "dismissible",
257
+ "description": "Specify if the Alert can be dismissed",
258
+ "values": []
259
+ },
260
+ {
261
+ "name": "disableAutoFocus",
262
+ "description": "Prevent autofocus on show",
263
+ "values": []
264
+ },
265
+ {
266
+ "name": "disableCloseOnEscape",
267
+ "description": "Prevent Escape from closing",
268
+ "values": []
269
+ }
270
+ ],
271
+ "references": [
272
+ {
273
+ "name": "Storybook",
274
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
275
+ }
276
+ ]
277
+ },
180
278
  {
181
279
  "name": "bm-box",
182
280
  "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",
@@ -618,104 +716,6 @@
618
716
  }
619
717
  ]
620
718
  },
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
- },
719
719
  {
720
720
  "name": "bm-breadcrumb",
721
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",
@@ -2383,49 +2383,6 @@
2383
2383
  }
2384
2384
  ]
2385
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
2386
  {
2430
2387
  "name": "bm-text-area",
2431
2388
  "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",
@@ -2516,6 +2473,49 @@
2516
2473
  }
2517
2474
  ]
2518
2475
  },
2476
+ {
2477
+ "name": "bm-switch",
2478
+ "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.",
2479
+ "attributes": [
2480
+ {
2481
+ "name": "onText",
2482
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2483
+ "values": []
2484
+ },
2485
+ {
2486
+ "name": "offText",
2487
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2488
+ "values": []
2489
+ },
2490
+ {
2491
+ "name": "textPosition",
2492
+ "description": "Specify the position of the side label",
2493
+ "values": [{ "name": "before" }, { "name": "after" }]
2494
+ },
2495
+ {
2496
+ "name": "readOnly",
2497
+ "description": "Specify if Switch displays in a read-only state",
2498
+ "values": []
2499
+ },
2500
+ {
2501
+ "name": "disabled",
2502
+ "description": "Specify if Switch displays in a disabled state",
2503
+ "values": []
2504
+ },
2505
+ { "name": "checked", "values": [] },
2506
+ {
2507
+ "name": "value",
2508
+ "description": "The value attribute for the input element",
2509
+ "values": []
2510
+ }
2511
+ ],
2512
+ "references": [
2513
+ {
2514
+ "name": "Storybook",
2515
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2516
+ }
2517
+ ]
2518
+ },
2519
2519
  {
2520
2520
  "name": "bm-checkbox-group",
2521
2521
  "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",