@viasat/beam-web-components 2.44.0 → 2.45.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/custom-elements.json +3275 -3275
- package/package.json +6 -6
- package/vscode.html-custom-data.json +334 -334
|
@@ -61,6 +61,104 @@
|
|
|
61
61
|
}
|
|
62
62
|
]
|
|
63
63
|
},
|
|
64
|
+
{
|
|
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
|
+
"attributes": [
|
|
68
|
+
{
|
|
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",
|
|
76
|
+
"values": []
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "src",
|
|
80
|
+
"description": "Pass an image to the Avatar",
|
|
81
|
+
"values": []
|
|
82
|
+
},
|
|
83
|
+
{ "name": "alt", "description": "Specify alt for image", "values": [] },
|
|
84
|
+
{
|
|
85
|
+
"name": "size",
|
|
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
|
+
]
|
|
94
|
+
},
|
|
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": [] }
|
|
116
|
+
],
|
|
117
|
+
"references": [
|
|
118
|
+
{
|
|
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",
|
|
131
|
+
"values": []
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "maxCount",
|
|
135
|
+
"description": "Specify the max number of avatars displayed in the group.",
|
|
136
|
+
"values": []
|
|
137
|
+
},
|
|
138
|
+
{
|
|
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
|
+
]
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "layout",
|
|
151
|
+
"description": "Specify the kind of the group.",
|
|
152
|
+
"values": [{ "name": "stacked" }, { "name": "spaced" }]
|
|
153
|
+
}
|
|
154
|
+
],
|
|
155
|
+
"references": [
|
|
156
|
+
{
|
|
157
|
+
"name": "Storybook",
|
|
158
|
+
"url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
|
|
159
|
+
}
|
|
160
|
+
]
|
|
161
|
+
},
|
|
64
162
|
{
|
|
65
163
|
"name": "bm-badge",
|
|
66
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",
|
|
@@ -104,6 +202,117 @@
|
|
|
104
202
|
}
|
|
105
203
|
]
|
|
106
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
|
+
},
|
|
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
|
+
},
|
|
107
316
|
{
|
|
108
317
|
"name": "bm-box",
|
|
109
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",
|
|
@@ -507,273 +716,64 @@
|
|
|
507
716
|
}
|
|
508
717
|
]
|
|
509
718
|
},
|
|
510
|
-
{
|
|
511
|
-
"name": "bm-
|
|
512
|
-
"description": "`bm-
|
|
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
|
-
},
|
|
548
|
-
{
|
|
549
|
-
"name": "bm-breadcrumb",
|
|
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",
|
|
551
|
-
"attributes": [
|
|
552
|
-
{
|
|
553
|
-
"name": "wrap",
|
|
554
|
-
"description": "Specify if items wrap or collapse to an ellipsis",
|
|
555
|
-
"values": []
|
|
556
|
-
},
|
|
557
|
-
{
|
|
558
|
-
"name": "itemsBeforeCollapse",
|
|
559
|
-
"description": "Specify how many items show before ellipsis",
|
|
560
|
-
"values": []
|
|
561
|
-
},
|
|
562
|
-
{
|
|
563
|
-
"name": "itemsAfterCollapse",
|
|
564
|
-
"description": "Specify how many items show after ellipsis",
|
|
565
|
-
"values": []
|
|
566
|
-
},
|
|
567
|
-
{
|
|
568
|
-
"name": "theme",
|
|
569
|
-
"description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
|
|
570
|
-
"values": [{ "name": "light" }, { "name": "dark" }]
|
|
571
|
-
}
|
|
572
|
-
],
|
|
573
|
-
"references": [
|
|
574
|
-
{
|
|
575
|
-
"name": "Storybook",
|
|
576
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
|
|
577
|
-
}
|
|
578
|
-
]
|
|
579
|
-
},
|
|
580
|
-
{
|
|
581
|
-
"name": "bm-breadcrumb-item",
|
|
582
|
-
"description": "`bm-breadcrumb-item`\n\n### Attributes:\n- **href** - Pass href to an item\n- **clickable** - Specify if the item is interactive without an href\n- **truncationWidth** - Specify truncation width of the items. Sets max-width for all items but the last.\n- **isCurrent** - Specify explicitly if the item is the last one\n- **isCollapsed** \n---\n\n\n### **Slots:**\n - **default** - Pass text to an item\n- **icon** - Pass icon to an item",
|
|
583
|
-
"attributes": [
|
|
584
|
-
{ "name": "href", "description": "Pass href to an item", "values": [] },
|
|
585
|
-
{
|
|
586
|
-
"name": "clickable",
|
|
587
|
-
"description": "Specify if the item is interactive without an href",
|
|
588
|
-
"values": []
|
|
589
|
-
},
|
|
590
|
-
{
|
|
591
|
-
"name": "truncationWidth",
|
|
592
|
-
"description": "Specify truncation width of the items. Sets max-width for all items but the last.",
|
|
593
|
-
"values": []
|
|
594
|
-
},
|
|
595
|
-
{
|
|
596
|
-
"name": "isCurrent",
|
|
597
|
-
"description": "Specify explicitly if the item is the last one",
|
|
598
|
-
"values": []
|
|
599
|
-
},
|
|
600
|
-
{ "name": "isCollapsed", "values": [] }
|
|
601
|
-
],
|
|
602
|
-
"references": [
|
|
603
|
-
{
|
|
604
|
-
"name": "Storybook",
|
|
605
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
|
|
606
|
-
}
|
|
607
|
-
]
|
|
608
|
-
},
|
|
609
|
-
{
|
|
610
|
-
"name": "bm-alert",
|
|
611
|
-
"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",
|
|
612
|
-
"attributes": [
|
|
613
|
-
{
|
|
614
|
-
"name": "heading",
|
|
615
|
-
"description": "Specify the heading text for Alert",
|
|
616
|
-
"values": []
|
|
617
|
-
},
|
|
618
|
-
{
|
|
619
|
-
"name": "body",
|
|
620
|
-
"description": "Specify the body text for Alert",
|
|
621
|
-
"values": []
|
|
622
|
-
},
|
|
623
|
-
{
|
|
624
|
-
"name": "size",
|
|
625
|
-
"description": "Specify the size of the Alert",
|
|
626
|
-
"values": [{ "name": "sm" }, { "name": "md" }]
|
|
627
|
-
},
|
|
628
|
-
{
|
|
629
|
-
"name": "fullWidth",
|
|
630
|
-
"description": "Specify if the Alert has no border radius",
|
|
631
|
-
"values": []
|
|
632
|
-
},
|
|
633
|
-
{
|
|
634
|
-
"name": "theme",
|
|
635
|
-
"description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
|
|
636
|
-
"values": [{ "name": "light" }, { "name": "dark" }]
|
|
637
|
-
},
|
|
638
|
-
{
|
|
639
|
-
"name": "appearance",
|
|
640
|
-
"description": "Specify the appearance of the Alert",
|
|
641
|
-
"values": [
|
|
642
|
-
{ "name": "infoPrimary" },
|
|
643
|
-
{ "name": "infoSecondary" },
|
|
644
|
-
{ "name": "positive" },
|
|
645
|
-
{ "name": "warning" },
|
|
646
|
-
{ "name": "negative" }
|
|
647
|
-
]
|
|
648
|
-
},
|
|
649
|
-
{
|
|
650
|
-
"name": "hidden",
|
|
651
|
-
"description": "Specify if the Alert is hidden",
|
|
652
|
-
"values": []
|
|
653
|
-
},
|
|
654
|
-
{
|
|
655
|
-
"name": "hideIcon",
|
|
656
|
-
"description": "Specify if the icon displays on the Alert",
|
|
657
|
-
"values": []
|
|
658
|
-
},
|
|
659
|
-
{
|
|
660
|
-
"name": "dismissible",
|
|
661
|
-
"description": "Specify if the Alert can be dismissed",
|
|
662
|
-
"values": []
|
|
663
|
-
},
|
|
664
|
-
{
|
|
665
|
-
"name": "disableAutoFocus",
|
|
666
|
-
"description": "Prevent autofocus on show",
|
|
667
|
-
"values": []
|
|
668
|
-
},
|
|
669
|
-
{
|
|
670
|
-
"name": "disableCloseOnEscape",
|
|
671
|
-
"description": "Prevent Escape from closing",
|
|
672
|
-
"values": []
|
|
673
|
-
}
|
|
674
|
-
],
|
|
675
|
-
"references": [
|
|
676
|
-
{
|
|
677
|
-
"name": "Storybook",
|
|
678
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
|
|
679
|
-
}
|
|
680
|
-
]
|
|
681
|
-
},
|
|
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
|
-
},
|
|
719
|
+
{
|
|
720
|
+
"name": "bm-breadcrumb",
|
|
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",
|
|
722
|
+
"attributes": [
|
|
713
723
|
{
|
|
714
|
-
"name": "
|
|
715
|
-
"description": "Specify if
|
|
724
|
+
"name": "wrap",
|
|
725
|
+
"description": "Specify if items wrap or collapse to an ellipsis",
|
|
716
726
|
"values": []
|
|
717
727
|
},
|
|
718
728
|
{
|
|
719
|
-
"name": "
|
|
720
|
-
"description": "Specify
|
|
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",
|
|
729
|
+
"name": "itemsBeforeCollapse",
|
|
730
|
+
"description": "Specify how many items show before ellipsis",
|
|
726
731
|
"values": []
|
|
727
732
|
},
|
|
728
733
|
{
|
|
729
|
-
"name": "
|
|
730
|
-
"description": "
|
|
734
|
+
"name": "itemsAfterCollapse",
|
|
735
|
+
"description": "Specify how many items show after ellipsis",
|
|
731
736
|
"values": []
|
|
732
737
|
},
|
|
733
|
-
{
|
|
738
|
+
{
|
|
739
|
+
"name": "theme",
|
|
740
|
+
"description": "Specify the theme of the Breadcrumbs. By default, it inherits the theme from the parent",
|
|
741
|
+
"values": [{ "name": "light" }, { "name": "dark" }]
|
|
742
|
+
}
|
|
734
743
|
],
|
|
735
744
|
"references": [
|
|
736
745
|
{
|
|
737
746
|
"name": "Storybook",
|
|
738
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/components-
|
|
747
|
+
"url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
|
|
739
748
|
}
|
|
740
749
|
]
|
|
741
750
|
},
|
|
742
751
|
{
|
|
743
|
-
"name": "bm-
|
|
744
|
-
"description": "`bm-
|
|
752
|
+
"name": "bm-breadcrumb-item",
|
|
753
|
+
"description": "`bm-breadcrumb-item`\n\n### Attributes:\n- **href** - Pass href to an item\n- **clickable** - Specify if the item is interactive without an href\n- **truncationWidth** - Specify truncation width of the items. Sets max-width for all items but the last.\n- **isCurrent** - Specify explicitly if the item is the last one\n- **isCollapsed** \n---\n\n\n### **Slots:**\n - **default** - Pass text to an item\n- **icon** - Pass icon to an item",
|
|
745
754
|
"attributes": [
|
|
755
|
+
{ "name": "href", "description": "Pass href to an item", "values": [] },
|
|
746
756
|
{
|
|
747
|
-
"name": "
|
|
748
|
-
"description": "Specify if the
|
|
757
|
+
"name": "clickable",
|
|
758
|
+
"description": "Specify if the item is interactive without an href",
|
|
749
759
|
"values": []
|
|
750
760
|
},
|
|
751
761
|
{
|
|
752
|
-
"name": "
|
|
753
|
-
"description": "Specify the max
|
|
762
|
+
"name": "truncationWidth",
|
|
763
|
+
"description": "Specify truncation width of the items. Sets max-width for all items but the last.",
|
|
754
764
|
"values": []
|
|
755
765
|
},
|
|
756
766
|
{
|
|
757
|
-
"name": "
|
|
758
|
-
"description": "Specify the
|
|
759
|
-
"values": [
|
|
760
|
-
{ "name": "xs" },
|
|
761
|
-
{ "name": "sm" },
|
|
762
|
-
{ "name": "md" },
|
|
763
|
-
{ "name": "lg" },
|
|
764
|
-
{ "name": "xl" }
|
|
765
|
-
]
|
|
767
|
+
"name": "isCurrent",
|
|
768
|
+
"description": "Specify explicitly if the item is the last one",
|
|
769
|
+
"values": []
|
|
766
770
|
},
|
|
767
|
-
{
|
|
768
|
-
"name": "layout",
|
|
769
|
-
"description": "Specify the kind of the group.",
|
|
770
|
-
"values": [{ "name": "stacked" }, { "name": "spaced" }]
|
|
771
|
-
}
|
|
771
|
+
{ "name": "isCollapsed", "values": [] }
|
|
772
772
|
],
|
|
773
773
|
"references": [
|
|
774
774
|
{
|
|
775
775
|
"name": "Storybook",
|
|
776
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/components-
|
|
776
|
+
"url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
|
|
777
777
|
}
|
|
778
778
|
]
|
|
779
779
|
},
|
|
@@ -1909,51 +1909,6 @@
|
|
|
1909
1909
|
}
|
|
1910
1910
|
]
|
|
1911
1911
|
},
|
|
1912
|
-
{
|
|
1913
|
-
"name": "bm-form",
|
|
1914
|
-
"description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
|
|
1915
|
-
"attributes": [
|
|
1916
|
-
{
|
|
1917
|
-
"name": "validationMode",
|
|
1918
|
-
"description": "Specify if validation runs on change or when loosing focus",
|
|
1919
|
-
"values": [
|
|
1920
|
-
{ "name": "onChange" },
|
|
1921
|
-
{ "name": "onBlur" },
|
|
1922
|
-
{ "name": "onSubmit" }
|
|
1923
|
-
]
|
|
1924
|
-
},
|
|
1925
|
-
{
|
|
1926
|
-
"name": "initialValues",
|
|
1927
|
-
"description": "Specify initial values on Form controls based on their names",
|
|
1928
|
-
"values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
|
|
1929
|
-
},
|
|
1930
|
-
{
|
|
1931
|
-
"name": "required",
|
|
1932
|
-
"description": "Specify if input is a required",
|
|
1933
|
-
"values": []
|
|
1934
|
-
},
|
|
1935
|
-
{
|
|
1936
|
-
"name": "disabled",
|
|
1937
|
-
"description": "Specify if input is a disabled",
|
|
1938
|
-
"values": []
|
|
1939
|
-
},
|
|
1940
|
-
{
|
|
1941
|
-
"name": "readOnly",
|
|
1942
|
-
"description": "Specify if input is a read only",
|
|
1943
|
-
"values": []
|
|
1944
|
-
},
|
|
1945
|
-
{ "name": "action", "values": [] },
|
|
1946
|
-
{ "name": "method", "values": [] },
|
|
1947
|
-
{ "name": "target", "values": [] },
|
|
1948
|
-
{ "name": "enctype", "values": [] }
|
|
1949
|
-
],
|
|
1950
|
-
"references": [
|
|
1951
|
-
{
|
|
1952
|
-
"name": "Storybook",
|
|
1953
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
|
|
1954
|
-
}
|
|
1955
|
-
]
|
|
1956
|
-
},
|
|
1957
1912
|
{
|
|
1958
1913
|
"name": "bm-file-upload-button",
|
|
1959
1914
|
"description": "`bm-file-upload-button`\n\n### Attributes:\n- **error** - Specify if FileUpload is in error state\n- **accept** - Specify the accepted file types\n- **multiple** - Specify if multiple files can be uploaded\n---\n\n\n### **Slots:**\n - **default** - Specify text for the Button\n- **iconBefore** - Specify if the Button displays icon before the text\n- **iconAfter** - Specify if the Button displays icon after the text",
|
|
@@ -2261,6 +2216,51 @@
|
|
|
2261
2216
|
}
|
|
2262
2217
|
]
|
|
2263
2218
|
},
|
|
2219
|
+
{
|
|
2220
|
+
"name": "bm-form",
|
|
2221
|
+
"description": "`bm-form`\n---\n\n\n### **Events:**\n - **submit** - Validates the inputs and submits the form\n\n### **Slots:**\n - **slot** - Add controls to the Form",
|
|
2222
|
+
"attributes": [
|
|
2223
|
+
{
|
|
2224
|
+
"name": "validationMode",
|
|
2225
|
+
"description": "Specify if validation runs on change or when loosing focus",
|
|
2226
|
+
"values": [
|
|
2227
|
+
{ "name": "onChange" },
|
|
2228
|
+
{ "name": "onBlur" },
|
|
2229
|
+
{ "name": "onSubmit" }
|
|
2230
|
+
]
|
|
2231
|
+
},
|
|
2232
|
+
{
|
|
2233
|
+
"name": "initialValues",
|
|
2234
|
+
"description": "Specify initial values on Form controls based on their names",
|
|
2235
|
+
"values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"name": "required",
|
|
2239
|
+
"description": "Specify if input is a required",
|
|
2240
|
+
"values": []
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
"name": "disabled",
|
|
2244
|
+
"description": "Specify if input is a disabled",
|
|
2245
|
+
"values": []
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"name": "readOnly",
|
|
2249
|
+
"description": "Specify if input is a read only",
|
|
2250
|
+
"values": []
|
|
2251
|
+
},
|
|
2252
|
+
{ "name": "action", "values": [] },
|
|
2253
|
+
{ "name": "method", "values": [] },
|
|
2254
|
+
{ "name": "target", "values": [] },
|
|
2255
|
+
{ "name": "enctype", "values": [] }
|
|
2256
|
+
],
|
|
2257
|
+
"references": [
|
|
2258
|
+
{
|
|
2259
|
+
"name": "Storybook",
|
|
2260
|
+
"url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
|
|
2261
|
+
}
|
|
2262
|
+
]
|
|
2263
|
+
},
|
|
2264
2264
|
{
|
|
2265
2265
|
"name": "bm-native-select",
|
|
2266
2266
|
"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",
|
|
@@ -2374,58 +2374,6 @@
|
|
|
2374
2374
|
}
|
|
2375
2375
|
]
|
|
2376
2376
|
},
|
|
2377
|
-
{
|
|
2378
|
-
"name": "bm-radio-button",
|
|
2379
|
-
"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",
|
|
2380
|
-
"attributes": [
|
|
2381
|
-
{
|
|
2382
|
-
"name": "label",
|
|
2383
|
-
"description": "Specify the text for the label",
|
|
2384
|
-
"values": []
|
|
2385
|
-
},
|
|
2386
|
-
{
|
|
2387
|
-
"name": "error",
|
|
2388
|
-
"description": "Specify error text and display error state of a RadioButton",
|
|
2389
|
-
"values": []
|
|
2390
|
-
},
|
|
2391
|
-
{
|
|
2392
|
-
"name": "readOnly",
|
|
2393
|
-
"description": "Specify if RadioButton displays in a read-only state",
|
|
2394
|
-
"values": []
|
|
2395
|
-
},
|
|
2396
|
-
{
|
|
2397
|
-
"name": "disabled",
|
|
2398
|
-
"description": "Specify if RadioButton displays in a disabled state",
|
|
2399
|
-
"values": []
|
|
2400
|
-
},
|
|
2401
|
-
{
|
|
2402
|
-
"name": "theme",
|
|
2403
|
-
"description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
|
|
2404
|
-
"values": [{ "name": "light" }, { "name": "dark" }]
|
|
2405
|
-
},
|
|
2406
|
-
{
|
|
2407
|
-
"name": "value",
|
|
2408
|
-
"description": "The value attribute for the input element",
|
|
2409
|
-
"values": []
|
|
2410
|
-
},
|
|
2411
|
-
{
|
|
2412
|
-
"name": "checked",
|
|
2413
|
-
"description": "The checked attribute for the input element",
|
|
2414
|
-
"values": []
|
|
2415
|
-
},
|
|
2416
|
-
{
|
|
2417
|
-
"name": "onKeyDown",
|
|
2418
|
-
"description": "A user-defined function to handle keydown events",
|
|
2419
|
-
"values": [{ "name": "(event: KeyboardEvent) => void" }]
|
|
2420
|
-
}
|
|
2421
|
-
],
|
|
2422
|
-
"references": [
|
|
2423
|
-
{
|
|
2424
|
-
"name": "Storybook",
|
|
2425
|
-
"url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
|
|
2426
|
-
}
|
|
2427
|
-
]
|
|
2428
|
-
},
|
|
2429
2377
|
{
|
|
2430
2378
|
"name": "bm-text-area",
|
|
2431
2379
|
"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 +2464,58 @@
|
|
|
2516
2464
|
}
|
|
2517
2465
|
]
|
|
2518
2466
|
},
|
|
2467
|
+
{
|
|
2468
|
+
"name": "bm-radio-button",
|
|
2469
|
+
"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",
|
|
2470
|
+
"attributes": [
|
|
2471
|
+
{
|
|
2472
|
+
"name": "label",
|
|
2473
|
+
"description": "Specify the text for the label",
|
|
2474
|
+
"values": []
|
|
2475
|
+
},
|
|
2476
|
+
{
|
|
2477
|
+
"name": "error",
|
|
2478
|
+
"description": "Specify error text and display error state of a RadioButton",
|
|
2479
|
+
"values": []
|
|
2480
|
+
},
|
|
2481
|
+
{
|
|
2482
|
+
"name": "readOnly",
|
|
2483
|
+
"description": "Specify if RadioButton displays in a read-only state",
|
|
2484
|
+
"values": []
|
|
2485
|
+
},
|
|
2486
|
+
{
|
|
2487
|
+
"name": "disabled",
|
|
2488
|
+
"description": "Specify if RadioButton displays in a disabled state",
|
|
2489
|
+
"values": []
|
|
2490
|
+
},
|
|
2491
|
+
{
|
|
2492
|
+
"name": "theme",
|
|
2493
|
+
"description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
|
|
2494
|
+
"values": [{ "name": "light" }, { "name": "dark" }]
|
|
2495
|
+
},
|
|
2496
|
+
{
|
|
2497
|
+
"name": "value",
|
|
2498
|
+
"description": "The value attribute for the input element",
|
|
2499
|
+
"values": []
|
|
2500
|
+
},
|
|
2501
|
+
{
|
|
2502
|
+
"name": "checked",
|
|
2503
|
+
"description": "The checked attribute for the input element",
|
|
2504
|
+
"values": []
|
|
2505
|
+
},
|
|
2506
|
+
{
|
|
2507
|
+
"name": "onKeyDown",
|
|
2508
|
+
"description": "A user-defined function to handle keydown events",
|
|
2509
|
+
"values": [{ "name": "(event: KeyboardEvent) => void" }]
|
|
2510
|
+
}
|
|
2511
|
+
],
|
|
2512
|
+
"references": [
|
|
2513
|
+
{
|
|
2514
|
+
"name": "Storybook",
|
|
2515
|
+
"url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
|
|
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",
|