@viasat/beam-web-components 2.17.0 → 2.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viasat/beam-web-components",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Framework-agnostic web components for the Beam Design System built with Lit, compatible with Angular, Vue, Svelte, and vanilla JavaScript",
   "license": "MIT",
   "author": "Viasat",
@@ -64,11 +64,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@viasat/beam-fonts": "2.17.0",
-    "@viasat/beam-shared": "2.17.0",
-    "@viasat/beam-styles": "2.17.0",
-    "@viasat/beam-tokens": "2.17.0",
-    "@viasat/beam-icons": "2.17.0",
+    "@viasat/beam-fonts": "2.18.0",
+    "@viasat/beam-shared": "2.18.0",
+    "@viasat/beam-styles": "2.18.0",
+    "@viasat/beam-tokens": "2.18.0",
+    "@viasat/beam-icons": "2.18.0",
     "clsx": "^1.2.1",
     "lit": "^3.1.0",
     "@lit/context": "^1.1.1",

package/vscode.html-custom-data.json

@@ -61,6 +61,79 @@
         }
       ]
     },
+    {
+      "name": "bm-alert",
+      "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",
+      "attributes": [
+        {
+          "name": "heading",
+          "description": "Specify the heading text for Alert",
+          "values": []
+        },
+        {
+          "name": "body",
+          "description": "Specify the body text for Alert",
+          "values": []
+        },
+        {
+          "name": "size",
+          "description": "Specify the size of the Alert",
+          "values": [{ "name": "sm" }, { "name": "md" }]
+        },
+        {
+          "name": "fullWidth",
+          "description": "Specify if the Alert has no border radius",
+          "values": []
+        },
+        {
+          "name": "theme",
+          "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
+          "values": [{ "name": "light" }, { "name": "dark" }]
+        },
+        {
+          "name": "appearance",
+          "description": "Specify the appearance of the Alert",
+          "values": [
+            { "name": "infoPrimary" },
+            { "name": "infoSecondary" },
+            { "name": "positive" },
+            { "name": "warning" },
+            { "name": "negative" }
+          ]
+        },
+        {
+          "name": "hidden",
+          "description": "Specify if the Alert is hidden",
+          "values": []
+        },
+        {
+          "name": "hideIcon",
+          "description": "Specify if the icon displays on the Alert",
+          "values": []
+        },
+        {
+          "name": "dismissible",
+          "description": "Specify if the Alert can be dismissed",
+          "values": []
+        },
+        {
+          "name": "disableAutoFocus",
+          "description": "Prevent autofocus on show",
+          "values": []
+        },
+        {
+          "name": "disableCloseOnEscape",
+          "description": "Prevent Escape from closing",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
+        }
+      ]
+    },
     {
       "name": "bm-avatar",
       "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,37 +233,12 @@
       ]
     },
     {
-      "name": "bm-alert",
-      "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",
+      "name": "bm-badge",
+      "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",
       "attributes": [
-        {
-          "name": "heading",
-          "description": "Specify the heading text for Alert",
-          "values": []
-        },
-        {
-          "name": "body",
-          "description": "Specify the body text for Alert",
-          "values": []
-        },
-        {
-          "name": "size",
-          "description": "Specify the size of the Alert",
-          "values": [{ "name": "sm" }, { "name": "md" }]
-        },
-        {
-          "name": "fullWidth",
-          "description": "Specify if the Alert has no border radius",
-          "values": []
-        },
-        {
-          "name": "theme",
-          "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        },
         {
           "name": "appearance",
-          "description": "Specify the appearance of the Alert",
+          "description": "Specify the appearance of the Badge",
           "values": [
             { "name": "infoPrimary" },
             { "name": "infoSecondary" },
@@ -200,45 +248,45 @@
           ]
         },
         {
-          "name": "hidden",
-          "description": "Specify if the Alert is hidden",
-          "values": []
-        },
-        {
-          "name": "hideIcon",
-          "description": "Specify if the icon displays on the Alert",
-          "values": []
+          "name": "theme",
+          "description": "Theme of the Badge",
+          "values": [{ "name": "light" }, { "name": "dark" }]
         },
         {
-          "name": "dismissible",
-          "description": "Specify if the Alert can be dismissed",
-          "values": []
+          "name": "size",
+          "description": "Specify the size of the Badge",
+          "values": [{ "name": "sm" }, { "name": "md" }]
         },
         {
-          "name": "disableAutoFocus",
-          "description": "Prevent autofocus on show",
-          "values": []
+          "name": "emphasis",
+          "description": "Specify the emphasis of the Badge",
+          "values": [
+            { "name": "strong" },
+            { "name": "medium" },
+            { "name": "subtle" }
+          ]
         },
-        {
-          "name": "disableCloseOnEscape",
-          "description": "Prevent Escape from closing",
-          "values": []
-        }
+        { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
         }
       ]
     },
     {
-      "name": "bm-badge",
-      "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",
+      "name": "bm-badge-dot",
+      "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",
       "attributes": [
+        {
+          "name": "theme",
+          "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
+          "values": [{ "name": "light" }, { "name": "dark" }]
+        },
         {
           "name": "appearance",
-          "description": "Specify the appearance of the Badge",
+          "description": "Specify the appearance of the BadgeDot",
           "values": [
             { "name": "infoPrimary" },
             { "name": "infoSecondary" },
@@ -247,31 +295,21 @@
             { "name": "negative" }
           ]
         },
-        {
-          "name": "theme",
-          "description": "Theme of the Badge",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        },
-        {
-          "name": "size",
-          "description": "Specify the size of the Badge",
-          "values": [{ "name": "sm" }, { "name": "md" }]
-        },
         {
           "name": "emphasis",
-          "description": "Specify the emphasis of the Badge",
-          "values": [
-            { "name": "strong" },
-            { "name": "medium" },
-            { "name": "subtle" }
-          ]
+          "description": "Specify the emphasis of the BadgeDot",
+          "values": [{ "name": "strong" }, { "name": "subtle" }]
         },
-        { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
+        {
+          "name": "overrideDotColor",
+          "description": "Overrides default dot color",
+          "values": []
+        }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
         }
       ]
     },
@@ -678,44 +716,6 @@
         }
       ]
     },
-    {
-      "name": "bm-badge-dot",
-      "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",
-      "attributes": [
-        {
-          "name": "theme",
-          "description": "Specify the theme of the BadgeDot. By default it inherits the theme from the parent",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        },
-        {
-          "name": "appearance",
-          "description": "Specify the appearance of the BadgeDot",
-          "values": [
-            { "name": "infoPrimary" },
-            { "name": "infoSecondary" },
-            { "name": "positive" },
-            { "name": "warning" },
-            { "name": "negative" }
-          ]
-        },
-        {
-          "name": "emphasis",
-          "description": "Specify the emphasis of the BadgeDot",
-          "values": [{ "name": "strong" }, { "name": "subtle" }]
-        },
-        {
-          "name": "overrideDotColor",
-          "description": "Overrides default dot color",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-badgedot"
-        }
-      ]
-    },
     {
       "name": "bm-breadcrumb",
       "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",
@@ -2089,6 +2089,43 @@
         }
       ]
     },
+    {
+      "name": "bm-label",
+      "description": "`bm-label`\n---\n\n\n### **Slots:**\n - **text** - Specify the text for Label\n- **optional** - Specify if the Label displays as optional\n- **tooltip** - Specify if the icon displays to add a Tooltip",
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Specify if the Label displays disabled",
+          "values": []
+        },
+        {
+          "name": "required",
+          "description": "Specify if the Label displays as required",
+          "values": []
+        },
+        {
+          "name": "text",
+          "description": "Specify the text for Label",
+          "values": []
+        },
+        {
+          "name": "optional",
+          "description": "Specify the text for Label",
+          "values": []
+        },
+        {
+          "name": "theme",
+          "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
+          "values": [{ "name": "light" }, { "name": "dark" }]
+        }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
+        }
+      ]
+    },
     {
       "name": "bm-form",
       "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",
@@ -2134,43 +2171,6 @@
         }
       ]
     },
-    {
-      "name": "bm-label",
-      "description": "`bm-label`\n---\n\n\n### **Slots:**\n - **text** - Specify the text for Label\n- **optional** - Specify if the Label displays as optional\n- **tooltip** - Specify if the icon displays to add a Tooltip",
-      "attributes": [
-        {
-          "name": "disabled",
-          "description": "Specify if the Label displays disabled",
-          "values": []
-        },
-        {
-          "name": "required",
-          "description": "Specify if the Label displays as required",
-          "values": []
-        },
-        {
-          "name": "text",
-          "description": "Specify the text for Label",
-          "values": []
-        },
-        {
-          "name": "optional",
-          "description": "Specify the text for Label",
-          "values": []
-        },
-        {
-          "name": "theme",
-          "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
-        }
-      ]
-    },
     {
       "name": "bm-native-select",
       "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",
@@ -2237,97 +2237,97 @@
       ]
     },
     {
-      "name": "bm-radio-button",
-      "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",
+      "name": "bm-switch",
+      "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.",
       "attributes": [
         {
-          "name": "label",
-          "description": "Specify the text for the label",
+          "name": "onText",
+          "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
           "values": []
         },
         {
-          "name": "error",
-          "description": "Specify error text and display error state of a RadioButton",
+          "name": "offText",
+          "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
           "values": []
         },
+        {
+          "name": "textPosition",
+          "description": "Specify the position of the side label",
+          "values": [{ "name": "before" }, { "name": "after" }]
+        },
         {
           "name": "readOnly",
-          "description": "Specify if RadioButton displays in a read-only state",
+          "description": "Specify if Switch displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if RadioButton displays in a disabled state",
+          "description": "Specify if Switch displays in a disabled state",
           "values": []
         },
-        {
-          "name": "theme",
-          "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        },
+        { "name": "checked", "values": [] },
         {
           "name": "value",
           "description": "The value attribute for the input element",
           "values": []
-        },
-        {
-          "name": "checked",
-          "description": "The checked attribute for the input element",
-          "values": []
-        },
-        {
-          "name": "onKeyDown",
-          "description": "A user-defined function to handle keydown events",
-          "values": [{ "name": "(event: KeyboardEvent) => void" }]
         }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
         }
       ]
     },
     {
-      "name": "bm-switch",
-      "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.",
+      "name": "bm-radio-button",
+      "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",
       "attributes": [
         {
-          "name": "onText",
-          "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
+          "name": "label",
+          "description": "Specify the text for the label",
           "values": []
         },
         {
-          "name": "offText",
-          "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
+          "name": "error",
+          "description": "Specify error text and display error state of a RadioButton",
           "values": []
         },
-        {
-          "name": "textPosition",
-          "description": "Specify the position of the side label",
-          "values": [{ "name": "before" }, { "name": "after" }]
-        },
         {
           "name": "readOnly",
-          "description": "Specify if Switch displays in a read-only state",
+          "description": "Specify if RadioButton displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if Switch displays in a disabled state",
+          "description": "Specify if RadioButton displays in a disabled state",
           "values": []
         },
-        { "name": "checked", "values": [] },
+        {
+          "name": "theme",
+          "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
+          "values": [{ "name": "light" }, { "name": "dark" }]
+        },
         {
           "name": "value",
           "description": "The value attribute for the input element",
           "values": []
+        },
+        {
+          "name": "checked",
+          "description": "The checked attribute for the input element",
+          "values": []
+        },
+        {
+          "name": "onKeyDown",
+          "description": "A user-defined function to handle keydown events",
+          "values": [{ "name": "(event: KeyboardEvent) => void" }]
         }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
         }
       ]
     },
@@ -2563,8 +2563,8 @@
       ]
     },
     {
-      "name": "bm-radio-button-group",
-      "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
+      "name": "bm-switch-group",
+      "description": "`bm-switch-group`\n---\n\n\n### **Slots:**\n - **label** - Slot for the label of the SwitchGroup\n- **helperText** - Slot for the helper text of the SwitchGroup",
       "attributes": [
         {
           "name": "theme",
@@ -2627,13 +2627,13 @@
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
         }
       ]
     },
     {
-      "name": "bm-switch-group",
-      "description": "`bm-switch-group`\n---\n\n\n### **Slots:**\n - **label** - Slot for the label of the SwitchGroup\n- **helperText** - Slot for the helper text of the SwitchGroup",
+      "name": "bm-radio-button-group",
+      "description": "\n---\n\n\n### **Slots:**\n - **label** - Add label text to the InputChoiceGroup\n- **helperText** - Add helper text to the InputChoiceGroup",
       "attributes": [
         {
           "name": "theme",
@@ -2696,7 +2696,7 @@
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
         }
       ]
     }