@viasat/beam-web-components 2.57.0 → 2.58.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.57.0",
3
+ "version": "2.58.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.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",
67
+ "@viasat/beam-fonts": "2.58.0",
68
+ "@viasat/beam-shared": "2.58.0",
69
+ "@viasat/beam-styles": "2.58.0",
70
+ "@viasat/beam-tokens": "2.58.0",
71
+ "@viasat/beam-icons": "2.58.0",
72
72
  "clsx": "^1.2.1",
73
73
  "lit": "^3.1.0",
74
74
  "@lit/context": "^1.1.1",
@@ -61,6 +61,122 @@
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
+ },
64
180
  {
65
181
  "name": "bm-avatar",
66
182
  "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",
@@ -160,80 +276,17 @@
160
276
  ]
161
277
  },
162
278
  {
163
- "name": "bm-badge",
164
- "description": "`bm-badge`\n\n### Attributes:\n- **appearance** - Specify the appearance of the Badge\n- **theme** - Theme of the Badge\n- **size** - Specify the size of the Badge\n- **emphasis** - Specify the emphasis of the Badge\n- **hideIcon** - Hides Badge icon\n---\n\n\n### **Slots:**\n - **default** - Provide text for the Badge\n- **icon** - Specify a different icon for the Badge",
165
- "attributes": [
166
- {
167
- "name": "appearance",
168
- "description": "Specify the appearance of the Badge",
169
- "values": [
170
- { "name": "infoPrimary" },
171
- { "name": "infoSecondary" },
172
- { "name": "positive" },
173
- { "name": "warning" },
174
- { "name": "negative" }
175
- ]
176
- },
177
- {
178
- "name": "theme",
179
- "description": "Theme of the Badge",
180
- "values": [{ "name": "light" }, { "name": "dark" }]
181
- },
182
- {
183
- "name": "size",
184
- "description": "Specify the size of the Badge",
185
- "values": [{ "name": "sm" }, { "name": "md" }]
186
- },
187
- {
188
- "name": "emphasis",
189
- "description": "Specify the emphasis of the Badge",
190
- "values": [
191
- { "name": "strong" },
192
- { "name": "medium" },
193
- { "name": "subtle" }
194
- ]
195
- },
196
- { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
197
- ],
198
- "references": [
199
- {
200
- "name": "Storybook",
201
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
202
- }
203
- ]
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",
279
+ "name": "bm-badge-dot",
280
+ "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",
208
281
  "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
282
  {
230
283
  "name": "theme",
231
- "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
284
+ "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
232
285
  "values": [{ "name": "light" }, { "name": "dark" }]
233
286
  },
234
287
  {
235
288
  "name": "appearance",
236
- "description": "Specify the appearance of the Alert",
289
+ "description": "Specify the appearance of the BadgeDot",
237
290
  "values": [
238
291
  { "name": "infoPrimary" },
239
292
  { "name": "infoSecondary" },
@@ -243,35 +296,20 @@
243
296
  ]
244
297
  },
245
298
  {
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": []
299
+ "name": "emphasis",
300
+ "description": "Specify the emphasis of the BadgeDot",
301
+ "values": [{ "name": "strong" }, { "name": "subtle" }]
264
302
  },
265
303
  {
266
- "name": "disableCloseOnEscape",
267
- "description": "Prevent Escape from closing",
304
+ "name": "overrideDotColor",
305
+ "description": "Overrides default dot color",
268
306
  "values": []
269
307
  }
270
308
  ],
271
309
  "references": [
272
310
  {
273
311
  "name": "Storybook",
274
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
312
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
275
313
  }
276
314
  ]
277
315
  },
@@ -678,44 +716,6 @@
678
716
  }
679
717
  ]
680
718
  },
681
- {
682
- "name": "bm-badge-dot",
683
- "description": "`bm-badge-dot`\n\n### Attributes:\n- **theme** - Specify the theme of the BadgeDot. By default it inherits the theme from the parent\n- **appearance** - Specify the appearance of the BadgeDot\n- **emphasis** - Specify the emphasis of the BadgeDot\n- **overrideDotColor** - Overrides default dot color\n---\n\n\n### **Slots:**\n - **default** - Provide text for the BadgeDot",
684
- "attributes": [
685
- {
686
- "name": "theme",
687
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
688
- "values": [{ "name": "light" }, { "name": "dark" }]
689
- },
690
- {
691
- "name": "appearance",
692
- "description": "Specify the appearance of the BadgeDot",
693
- "values": [
694
- { "name": "infoPrimary" },
695
- { "name": "infoSecondary" },
696
- { "name": "positive" },
697
- { "name": "warning" },
698
- { "name": "negative" }
699
- ]
700
- },
701
- {
702
- "name": "emphasis",
703
- "description": "Specify the emphasis of the BadgeDot",
704
- "values": [{ "name": "strong" }, { "name": "subtle" }]
705
- },
706
- {
707
- "name": "overrideDotColor",
708
- "description": "Overrides default dot color",
709
- "values": []
710
- }
711
- ],
712
- "references": [
713
- {
714
- "name": "Storybook",
715
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
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",
@@ -2261,6 +2261,101 @@
2261
2261
  }
2262
2262
  ]
2263
2263
  },
2264
+ {
2265
+ "name": "bm-radio-button",
2266
+ "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",
2267
+ "attributes": [
2268
+ {
2269
+ "name": "label",
2270
+ "description": "Specify the text for the label",
2271
+ "values": []
2272
+ },
2273
+ {
2274
+ "name": "error",
2275
+ "description": "Specify error text and display error state of a RadioButton",
2276
+ "values": []
2277
+ },
2278
+ {
2279
+ "name": "readOnly",
2280
+ "description": "Specify if RadioButton displays in a read-only state",
2281
+ "values": []
2282
+ },
2283
+ {
2284
+ "name": "disabled",
2285
+ "description": "Specify if RadioButton displays in a disabled state",
2286
+ "values": []
2287
+ },
2288
+ {
2289
+ "name": "theme",
2290
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2291
+ "values": [{ "name": "light" }, { "name": "dark" }]
2292
+ },
2293
+ {
2294
+ "name": "value",
2295
+ "description": "The value attribute for the input element",
2296
+ "values": []
2297
+ },
2298
+ {
2299
+ "name": "checked",
2300
+ "description": "The checked attribute for the input element",
2301
+ "values": []
2302
+ },
2303
+ {
2304
+ "name": "onKeyDown",
2305
+ "description": "A user-defined function to handle keydown events",
2306
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2307
+ }
2308
+ ],
2309
+ "references": [
2310
+ {
2311
+ "name": "Storybook",
2312
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2313
+ }
2314
+ ]
2315
+ },
2316
+ {
2317
+ "name": "bm-switch",
2318
+ "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.",
2319
+ "attributes": [
2320
+ {
2321
+ "name": "onText",
2322
+ "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
2323
+ "values": []
2324
+ },
2325
+ {
2326
+ "name": "offText",
2327
+ "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
2328
+ "values": []
2329
+ },
2330
+ {
2331
+ "name": "textPosition",
2332
+ "description": "Specify the position of the side label",
2333
+ "values": [{ "name": "before" }, { "name": "after" }]
2334
+ },
2335
+ {
2336
+ "name": "readOnly",
2337
+ "description": "Specify if Switch displays in a read-only state",
2338
+ "values": []
2339
+ },
2340
+ {
2341
+ "name": "disabled",
2342
+ "description": "Specify if Switch displays in a disabled state",
2343
+ "values": []
2344
+ },
2345
+ { "name": "checked", "values": [] },
2346
+ {
2347
+ "name": "value",
2348
+ "description": "The value attribute for the input element",
2349
+ "values": []
2350
+ }
2351
+ ],
2352
+ "references": [
2353
+ {
2354
+ "name": "Storybook",
2355
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
2356
+ }
2357
+ ]
2358
+ },
2264
2359
  {
2265
2360
  "name": "bm-native-select",
2266
2361
  "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",
@@ -2331,58 +2426,6 @@
2331
2426
  }
2332
2427
  ]
2333
2428
  },
2334
- {
2335
- "name": "bm-radio-button",
2336
- "description": "`bm-radio-button`\n\n### Attributes:\n- **label** - Specify the text for the label\n- **error** - Specify error text and display error state of a RadioButton\n- **readOnly** - Specify if RadioButton displays in a read-only state\n- **disabled** - Specify if RadioButton displays in a disabled state\n- **theme** - Specify the theme of the RadioButton. By default it inherits the theme from the parent\n- **value** - The value attribute for the input element\n- **checked** - The checked attribute for the input element\n- **onKeyDown** - A user-defined function to handle keydown events\n---\n",
2337
- "attributes": [
2338
- {
2339
- "name": "label",
2340
- "description": "Specify the text for the label",
2341
- "values": []
2342
- },
2343
- {
2344
- "name": "error",
2345
- "description": "Specify error text and display error state of a RadioButton",
2346
- "values": []
2347
- },
2348
- {
2349
- "name": "readOnly",
2350
- "description": "Specify if RadioButton displays in a read-only state",
2351
- "values": []
2352
- },
2353
- {
2354
- "name": "disabled",
2355
- "description": "Specify if RadioButton displays in a disabled state",
2356
- "values": []
2357
- },
2358
- {
2359
- "name": "theme",
2360
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2361
- "values": [{ "name": "light" }, { "name": "dark" }]
2362
- },
2363
- {
2364
- "name": "value",
2365
- "description": "The value attribute for the input element",
2366
- "values": []
2367
- },
2368
- {
2369
- "name": "checked",
2370
- "description": "The checked attribute for the input element",
2371
- "values": []
2372
- },
2373
- {
2374
- "name": "onKeyDown",
2375
- "description": "A user-defined function to handle keydown events",
2376
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2377
- }
2378
- ],
2379
- "references": [
2380
- {
2381
- "name": "Storybook",
2382
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2383
- }
2384
- ]
2385
- },
2386
2429
  {
2387
2430
  "name": "bm-text-area",
2388
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",
@@ -2473,49 +2516,6 @@
2473
2516
  }
2474
2517
  ]
2475
2518
  },
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",