@viasat/beam-web-components 2.27.0 → 2.28.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.27.0",
3
+ "version": "2.28.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.27.0",
68
- "@viasat/beam-shared": "2.27.0",
69
- "@viasat/beam-styles": "2.27.0",
70
- "@viasat/beam-tokens": "2.27.0",
71
- "@viasat/beam-icons": "2.27.0",
67
+ "@viasat/beam-fonts": "2.28.0",
68
+ "@viasat/beam-shared": "2.28.0",
69
+ "@viasat/beam-styles": "2.28.0",
70
+ "@viasat/beam-tokens": "2.28.0",
71
+ "@viasat/beam-icons": "2.28.0",
72
72
  "clsx": "^1.2.1",
73
73
  "lit": "^3.1.0",
74
74
  "@lit/context": "^1.1.1",
@@ -62,83 +62,100 @@
62
62
  ]
63
63
  },
64
64
  {
65
- "name": "bm-badge",
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",
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
69
  "name": "appearance",
70
- "description": "Specify the appearance of the Badge",
71
- "values": [
72
- { "name": "infoPrimary" },
73
- { "name": "infoSecondary" },
74
- { "name": "positive" },
75
- { "name": "warning" },
76
- { "name": "negative" }
77
- ]
70
+ "description": "Specify the appearance of the Avatar",
71
+ "values": [{ "name": "accent" }, { "name": "neutral" }]
78
72
  },
79
73
  {
80
- "name": "theme",
81
- "description": "Theme of the Badge",
82
- "values": [{ "name": "light" }, { "name": "dark" }]
74
+ "name": "name",
75
+ "description": "Specify a name to display initials in the Avatar",
76
+ "values": []
83
77
  },
84
78
  {
85
- "name": "size",
86
- "description": "Specify the size of the Badge",
87
- "values": [{ "name": "sm" }, { "name": "md" }]
79
+ "name": "src",
80
+ "description": "Pass an image to the Avatar",
81
+ "values": []
88
82
  },
83
+ { "name": "alt", "description": "Specify alt for image", "values": [] },
89
84
  {
90
- "name": "emphasis",
91
- "description": "Specify the emphasis of the Badge",
85
+ "name": "size",
86
+ "description": "Specify the size of the Avatar",
92
87
  "values": [
93
- { "name": "strong" },
94
- { "name": "medium" },
95
- { "name": "subtle" }
88
+ { "name": "xs" },
89
+ { "name": "sm" },
90
+ { "name": "md" },
91
+ { "name": "lg" },
92
+ { "name": "xl" }
96
93
  ]
97
94
  },
98
- { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
95
+ {
96
+ "name": "disabled",
97
+ "description": "Specify if the Avatar is disabled",
98
+ "values": []
99
+ },
100
+ {
101
+ "name": "shape",
102
+ "description": "Specify the shape of the Avatar",
103
+ "values": [{ "name": "circle" }, { "name": "square" }]
104
+ },
105
+ {
106
+ "name": "isInteractive",
107
+ "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
108
+ "values": []
109
+ },
110
+ {
111
+ "name": "isFocusable",
112
+ "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
113
+ "values": []
114
+ },
115
+ { "name": "withBorder", "values": [] }
99
116
  ],
100
117
  "references": [
101
118
  {
102
119
  "name": "Storybook",
103
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
120
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
104
121
  }
105
122
  ]
106
123
  },
107
124
  {
108
- "name": "bm-badge-dot",
109
- "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",
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",
110
127
  "attributes": [
111
128
  {
112
- "name": "theme",
113
- "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
114
- "values": [{ "name": "light" }, { "name": "dark" }]
129
+ "name": "wrapping",
130
+ "description": "Specify if the AvatarGroup wraps",
131
+ "values": []
115
132
  },
116
133
  {
117
- "name": "appearance",
118
- "description": "Specify the appearance of the BadgeDot",
119
- "values": [
120
- { "name": "infoPrimary" },
121
- { "name": "infoSecondary" },
122
- { "name": "positive" },
123
- { "name": "warning" },
124
- { "name": "negative" }
125
- ]
134
+ "name": "maxCount",
135
+ "description": "Specify the max number of avatars displayed in the group.",
136
+ "values": []
126
137
  },
127
138
  {
128
- "name": "emphasis",
129
- "description": "Specify the emphasis of the BadgeDot",
130
- "values": [{ "name": "strong" }, { "name": "subtle" }]
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
+ ]
131
148
  },
132
149
  {
133
- "name": "overrideDotColor",
134
- "description": "Overrides default dot color",
135
- "values": []
150
+ "name": "layout",
151
+ "description": "Specify the kind of the group.",
152
+ "values": [{ "name": "stacked" }, { "name": "spaced" }]
136
153
  }
137
154
  ],
138
155
  "references": [
139
156
  {
140
157
  "name": "Storybook",
141
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
158
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
142
159
  }
143
160
  ]
144
161
  },
@@ -215,6 +232,87 @@
215
232
  }
216
233
  ]
217
234
  },
235
+ {
236
+ "name": "bm-badge",
237
+ "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",
238
+ "attributes": [
239
+ {
240
+ "name": "appearance",
241
+ "description": "Specify the appearance of the Badge",
242
+ "values": [
243
+ { "name": "infoPrimary" },
244
+ { "name": "infoSecondary" },
245
+ { "name": "positive" },
246
+ { "name": "warning" },
247
+ { "name": "negative" }
248
+ ]
249
+ },
250
+ {
251
+ "name": "theme",
252
+ "description": "Theme of the Badge",
253
+ "values": [{ "name": "light" }, { "name": "dark" }]
254
+ },
255
+ {
256
+ "name": "size",
257
+ "description": "Specify the size of the Badge",
258
+ "values": [{ "name": "sm" }, { "name": "md" }]
259
+ },
260
+ {
261
+ "name": "emphasis",
262
+ "description": "Specify the emphasis of the Badge",
263
+ "values": [
264
+ { "name": "strong" },
265
+ { "name": "medium" },
266
+ { "name": "subtle" }
267
+ ]
268
+ },
269
+ { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
270
+ ],
271
+ "references": [
272
+ {
273
+ "name": "Storybook",
274
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
275
+ }
276
+ ]
277
+ },
278
+ {
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",
281
+ "attributes": [
282
+ {
283
+ "name": "theme",
284
+ "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
285
+ "values": [{ "name": "light" }, { "name": "dark" }]
286
+ },
287
+ {
288
+ "name": "appearance",
289
+ "description": "Specify the appearance of the BadgeDot",
290
+ "values": [
291
+ { "name": "infoPrimary" },
292
+ { "name": "infoSecondary" },
293
+ { "name": "positive" },
294
+ { "name": "warning" },
295
+ { "name": "negative" }
296
+ ]
297
+ },
298
+ {
299
+ "name": "emphasis",
300
+ "description": "Specify the emphasis of the BadgeDot",
301
+ "values": [{ "name": "strong" }, { "name": "subtle" }]
302
+ },
303
+ {
304
+ "name": "overrideDotColor",
305
+ "description": "Overrides default dot color",
306
+ "values": []
307
+ }
308
+ ],
309
+ "references": [
310
+ {
311
+ "name": "Storybook",
312
+ "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
313
+ }
314
+ ]
315
+ },
218
316
  {
219
317
  "name": "bm-box",
220
318
  "description": "`bm-box`\n\n### Attributes:\n- **backgroundColor** - Specify the background color of a Box\n- **borderColor** - Specify the border color of a Box\n- **borderWidth** - Specify the border width of a Box\n- **borderRadius** - Specify the border radius of a Box\n- **px** - Specify before and after padding of a Box\n- **py** - Specify top and bottom padding of a Box\n- **pTop** - Specify top padding of a Box\n- **pBottom** - Specify bottom padding of a Box\n- **pBefore** - Specify before padding of a Box\n- **pAfter** - Specify after padding of a Box\n- **mx** - Specify before and after margin of a Box\n- **my** - Specify top and bottom margin of a Box\n- **mTop** - Specify top margin of a Box\n- **mBottom** - Specify bottom margin of a Box\n- **mBefore** - Specify before margin of a Box\n- **mAfter** - Specify after margin of a Box\n- **m** - Specify all margin\n- **p** - Specify all padding\n- **gap** - Specify gap between child elements\n- **shadow** - Specify if a Box has a shadow\n---\n\n\n### **Slots:**\n - **default** - Provide content for the Box",
@@ -679,104 +777,6 @@
679
777
  }
680
778
  ]
681
779
  },
682
- {
683
- "name": "bm-avatar",
684
- "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",
685
- "attributes": [
686
- {
687
- "name": "appearance",
688
- "description": "Specify the appearance of the Avatar",
689
- "values": [{ "name": "accent" }, { "name": "neutral" }]
690
- },
691
- {
692
- "name": "name",
693
- "description": "Specify a name to display initials in the Avatar",
694
- "values": []
695
- },
696
- {
697
- "name": "src",
698
- "description": "Pass an image to the Avatar",
699
- "values": []
700
- },
701
- { "name": "alt", "description": "Specify alt for image", "values": [] },
702
- {
703
- "name": "size",
704
- "description": "Specify the size of the Avatar",
705
- "values": [
706
- { "name": "xs" },
707
- { "name": "sm" },
708
- { "name": "md" },
709
- { "name": "lg" },
710
- { "name": "xl" }
711
- ]
712
- },
713
- {
714
- "name": "disabled",
715
- "description": "Specify if the Avatar is disabled",
716
- "values": []
717
- },
718
- {
719
- "name": "shape",
720
- "description": "Specify the shape of the Avatar",
721
- "values": [{ "name": "circle" }, { "name": "square" }]
722
- },
723
- {
724
- "name": "isInteractive",
725
- "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
726
- "values": []
727
- },
728
- {
729
- "name": "isFocusable",
730
- "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
731
- "values": []
732
- },
733
- { "name": "withBorder", "values": [] }
734
- ],
735
- "references": [
736
- {
737
- "name": "Storybook",
738
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
739
- }
740
- ]
741
- },
742
- {
743
- "name": "bm-avatar-group",
744
- "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",
745
- "attributes": [
746
- {
747
- "name": "wrapping",
748
- "description": "Specify if the AvatarGroup wraps",
749
- "values": []
750
- },
751
- {
752
- "name": "maxCount",
753
- "description": "Specify the max number of avatars displayed in the group.",
754
- "values": []
755
- },
756
- {
757
- "name": "size",
758
- "description": "Specify the size of all Avatars",
759
- "values": [
760
- { "name": "xs" },
761
- { "name": "sm" },
762
- { "name": "md" },
763
- { "name": "lg" },
764
- { "name": "xl" }
765
- ]
766
- },
767
- {
768
- "name": "layout",
769
- "description": "Specify the kind of the group.",
770
- "values": [{ "name": "stacked" }, { "name": "spaced" }]
771
- }
772
- ],
773
- "references": [
774
- {
775
- "name": "Storybook",
776
- "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
777
- }
778
- ]
779
- },
780
780
  {
781
781
  "name": "bm-button",
782
782
  "description": "`bm-button`\n\n### Attributes:\n- **appearance** - Specify the appearance of a Button\n- **kind** - Specify the kind of Button\n- **size** - Specify the size of a Button\n- **disabled** - Specify if the Button is disabled\n- **fluid** - Specify if Button is fluid\n- **width** - Specify the width of a Button\n- **height** - Specify the height of a Button\n- **theme** - Specify the theme of the Button\n- **iconOnly** - Specify if the icon displays without text\n- **type** \n---\n\n\n### **Slots:**\n - **default** - Provide content for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
@@ -2256,58 +2256,6 @@
2256
2256
  }
2257
2257
  ]
2258
2258
  },
2259
- {
2260
- "name": "bm-radio-button",
2261
- "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",
2262
- "attributes": [
2263
- {
2264
- "name": "label",
2265
- "description": "Specify the text for the label",
2266
- "values": []
2267
- },
2268
- {
2269
- "name": "error",
2270
- "description": "Specify error text and display error state of a RadioButton",
2271
- "values": []
2272
- },
2273
- {
2274
- "name": "readOnly",
2275
- "description": "Specify if RadioButton displays in a read-only state",
2276
- "values": []
2277
- },
2278
- {
2279
- "name": "disabled",
2280
- "description": "Specify if RadioButton displays in a disabled state",
2281
- "values": []
2282
- },
2283
- {
2284
- "name": "theme",
2285
- "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2286
- "values": [{ "name": "light" }, { "name": "dark" }]
2287
- },
2288
- {
2289
- "name": "value",
2290
- "description": "The value attribute for the input element",
2291
- "values": []
2292
- },
2293
- {
2294
- "name": "checked",
2295
- "description": "The checked attribute for the input element",
2296
- "values": []
2297
- },
2298
- {
2299
- "name": "onKeyDown",
2300
- "description": "A user-defined function to handle keydown events",
2301
- "values": [{ "name": "(event: KeyboardEvent) => void" }]
2302
- }
2303
- ],
2304
- "references": [
2305
- {
2306
- "name": "Storybook",
2307
- "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2308
- }
2309
- ]
2310
- },
2311
2259
  {
2312
2260
  "name": "bm-native-select",
2313
2261
  "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",
@@ -2373,6 +2321,58 @@
2373
2321
  }
2374
2322
  ]
2375
2323
  },
2324
+ {
2325
+ "name": "bm-radio-button",
2326
+ "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",
2327
+ "attributes": [
2328
+ {
2329
+ "name": "label",
2330
+ "description": "Specify the text for the label",
2331
+ "values": []
2332
+ },
2333
+ {
2334
+ "name": "error",
2335
+ "description": "Specify error text and display error state of a RadioButton",
2336
+ "values": []
2337
+ },
2338
+ {
2339
+ "name": "readOnly",
2340
+ "description": "Specify if RadioButton displays in a read-only state",
2341
+ "values": []
2342
+ },
2343
+ {
2344
+ "name": "disabled",
2345
+ "description": "Specify if RadioButton displays in a disabled state",
2346
+ "values": []
2347
+ },
2348
+ {
2349
+ "name": "theme",
2350
+ "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
2351
+ "values": [{ "name": "light" }, { "name": "dark" }]
2352
+ },
2353
+ {
2354
+ "name": "value",
2355
+ "description": "The value attribute for the input element",
2356
+ "values": []
2357
+ },
2358
+ {
2359
+ "name": "checked",
2360
+ "description": "The checked attribute for the input element",
2361
+ "values": []
2362
+ },
2363
+ {
2364
+ "name": "onKeyDown",
2365
+ "description": "A user-defined function to handle keydown events",
2366
+ "values": [{ "name": "(event: KeyboardEvent) => void" }]
2367
+ }
2368
+ ],
2369
+ "references": [
2370
+ {
2371
+ "name": "Storybook",
2372
+ "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
2373
+ }
2374
+ ]
2375
+ },
2376
2376
  {
2377
2377
  "name": "bm-switch",
2378
2378
  "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.",