@viasat/beam-web-components 2.15.0 → 2.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viasat/beam-web-components",
-  "version": "2.15.0",
+  "version": "2.17.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.15.0",
-    "@viasat/beam-shared": "2.15.0",
-    "@viasat/beam-styles": "2.15.0",
-    "@viasat/beam-tokens": "2.15.0",
-    "@viasat/beam-icons": "2.15.0",
+    "@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",
     "clsx": "^1.2.1",
     "lit": "^3.1.0",
     "@lit/context": "^1.1.1",

package/vscode.html-custom-data.json

@@ -159,87 +159,6 @@
         }
       ]
     },
-    {
-      "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": "appearance",
-          "description": "Specify the appearance of the Badge",
-          "values": [
-            { "name": "infoPrimary" },
-            { "name": "infoSecondary" },
-            { "name": "positive" },
-            { "name": "warning" },
-            { "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" }
-          ]
-        },
-        { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-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 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-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",
@@ -313,6 +232,49 @@
         }
       ]
     },
+    {
+      "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": "appearance",
+          "description": "Specify the appearance of the Badge",
+          "values": [
+            { "name": "infoPrimary" },
+            { "name": "infoSecondary" },
+            { "name": "positive" },
+            { "name": "warning" },
+            { "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" }
+          ]
+        },
+        { "name": "hideIcon", "description": "Hides Badge icon", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-badge"
+        }
+      ]
+    },
     {
       "name": "bm-box",
       "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",
@@ -716,6 +678,44 @@
         }
       ]
     },
+    {
+      "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",
@@ -2236,6 +2236,58 @@
         }
       ]
     },
+    {
+      "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": "label",
+          "description": "Specify the text for the label",
+          "values": []
+        },
+        {
+          "name": "error",
+          "description": "Specify error text and display error state of a RadioButton",
+          "values": []
+        },
+        {
+          "name": "readOnly",
+          "description": "Specify if RadioButton displays in a read-only state",
+          "values": []
+        },
+        {
+          "name": "disabled",
+          "description": "Specify if RadioButton 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": "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"
+        }
+      ]
+    },
     {
       "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.",
@@ -2280,203 +2332,151 @@
       ]
     },
     {
-      "name": "bm-text-field",
-      "description": "`bm-text-field`\n---\n\n\n### **Slots:**\n - **label** - Specify the label for TextField\n- **helper-text** - Specify the helper text for TextField\n- **content-after** - Specify content to display after input\n- **content-before** - Specify content to display before input",
+      "name": "bm-text-area",
+      "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",
       "attributes": [
+        {
+          "name": "rows",
+          "description": "Specify the height of TextArea",
+          "values": []
+        },
+        {
+          "name": "cols",
+          "description": "Specify the width of TextArea",
+          "values": []
+        },
         {
           "name": "placeholder",
-          "description": "Specify placeholder text for TextField",
+          "description": "Specify placeholder text for TextArea",
           "values": []
         },
         {
           "name": "required",
-          "description": "Specify if TextField is a required input",
+          "description": "Specify if TextArea is a required input",
           "values": []
         },
         {
           "name": "hideRequiredMarker",
-          "description": "Specify if the TextField displays with an asterisk",
+          "description": "Specify if the TextArea displays with an asterisk",
           "values": []
         },
         {
           "name": "error",
-          "description": "Specify error text and display error state of a TextField",
+          "description": "Specify error text and display error state of a TextArea",
           "values": []
         },
         {
           "name": "readOnly",
-          "description": "Specify if TextField displays in a read-only state",
+          "description": "Specify if TextArea displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if TextField displays in a disabled state",
+          "description": "Specify if TextArea displays in a disabled state",
           "values": []
         },
         {
           "name": "fluid",
-          "description": "Specify if TextField is fluid",
+          "description": "Specify if TextArea is fluid",
           "values": []
         },
         {
           "name": "width",
-          "description": "Specify the width of TextField",
-          "values": []
-        },
-        {
-          "name": "ellipse",
-          "description": "Specify if overflow displays ellipsis",
-          "values": []
-        },
-        {
-          "name": "theme",
-          "description": "Specify the theme of the TextField. By default it inherits the theme from the parent",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        },
-        { "name": "type", "values": [] },
-        { "name": "inputMode", "values": [] },
-        { "name": "id", "values": [] },
-        { "name": "name", "values": [] },
-        { "name": "value", "values": [] },
-        {
-          "name": "validationRules",
-          "values": [{ "name": "Array<FormValidator>" }]
-        },
-        { "name": "input-aria-label", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-textfield"
-        }
-      ]
-    },
-    {
-      "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": "label",
-          "description": "Specify the text for the label",
+          "description": "Specify the width of TextArea",
           "values": []
         },
         {
-          "name": "error",
-          "description": "Specify error text and display error state of a RadioButton",
+          "name": "hideResize",
+          "description": "Specify if TextArea can be manually resized",
           "values": []
         },
         {
-          "name": "readOnly",
-          "description": "Specify if RadioButton displays in a read-only state",
+          "name": "maxCount",
+          "description": "Specify the maximum character count for the TextArea",
           "values": []
         },
         {
-          "name": "disabled",
-          "description": "Specify if RadioButton displays in a disabled state",
+          "name": "autoResize",
+          "description": "Specify if the TextArea automatically resizes to fit the text",
           "values": []
         },
         {
           "name": "theme",
-          "description": "Specify the theme of the RadioButton. By default it inherits the theme from the parent",
+          "description": "Specify the theme of the TextArea. By default it inherits the theme from the parent",
           "values": [{ "name": "light" }, { "name": "dark" }]
         },
+        { "name": "id", "values": [] },
+        { "name": "name", "values": [] },
+        { "name": "value", "values": [] },
         {
-          "name": "value",
-          "description": "The value attribute for the input element",
-          "values": []
-        },
-        {
-          "name": "checked",
-          "description": "The checked attribute for the input element",
-          "values": []
+          "name": "validationRules",
+          "values": [{ "name": "Array<FormValidator>" }]
         },
-        {
-          "name": "onKeyDown",
-          "description": "A user-defined function to handle keydown events",
-          "values": [{ "name": "(event: KeyboardEvent) => void" }]
-        }
+        { "name": "input-aria-label", "values": [] }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-textarea"
         }
       ]
     },
     {
-      "name": "bm-text-area",
-      "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",
+      "name": "bm-text-field",
+      "description": "`bm-text-field`\n---\n\n\n### **Slots:**\n - **label** - Specify the label for TextField\n- **helper-text** - Specify the helper text for TextField\n- **content-after** - Specify content to display after input\n- **content-before** - Specify content to display before input",
       "attributes": [
-        {
-          "name": "rows",
-          "description": "Specify the height of TextArea",
-          "values": []
-        },
-        {
-          "name": "cols",
-          "description": "Specify the width of TextArea",
-          "values": []
-        },
         {
           "name": "placeholder",
-          "description": "Specify placeholder text for TextArea",
+          "description": "Specify placeholder text for TextField",
           "values": []
         },
         {
           "name": "required",
-          "description": "Specify if TextArea is a required input",
+          "description": "Specify if TextField is a required input",
           "values": []
         },
         {
           "name": "hideRequiredMarker",
-          "description": "Specify if the TextArea displays with an asterisk",
+          "description": "Specify if the TextField displays with an asterisk",
           "values": []
         },
         {
           "name": "error",
-          "description": "Specify error text and display error state of a TextArea",
+          "description": "Specify error text and display error state of a TextField",
           "values": []
         },
         {
           "name": "readOnly",
-          "description": "Specify if TextArea displays in a read-only state",
+          "description": "Specify if TextField displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if TextArea displays in a disabled state",
+          "description": "Specify if TextField displays in a disabled state",
           "values": []
         },
         {
           "name": "fluid",
-          "description": "Specify if TextArea is fluid",
+          "description": "Specify if TextField is fluid",
           "values": []
         },
         {
           "name": "width",
-          "description": "Specify the width of TextArea",
-          "values": []
-        },
-        {
-          "name": "hideResize",
-          "description": "Specify if TextArea can be manually resized",
-          "values": []
-        },
-        {
-          "name": "maxCount",
-          "description": "Specify the maximum character count for the TextArea",
+          "description": "Specify the width of TextField",
           "values": []
         },
         {
-          "name": "autoResize",
-          "description": "Specify if the TextArea automatically resizes to fit the text",
+          "name": "ellipse",
+          "description": "Specify if overflow displays ellipsis",
           "values": []
         },
         {
           "name": "theme",
-          "description": "Specify the theme of the TextArea. By default it inherits the theme from the parent",
+          "description": "Specify the theme of the TextField. By default it inherits the theme from the parent",
           "values": [{ "name": "light" }, { "name": "dark" }]
         },
+        { "name": "type", "values": [] },
+        { "name": "inputMode", "values": [] },
         { "name": "id", "values": [] },
         { "name": "name", "values": [] },
         { "name": "value", "values": [] },
@@ -2489,7 +2489,7 @@
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-textarea"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-textfield"
         }
       ]
     },
@@ -2563,8 +2563,8 @@
       ]
     },
     {
-      "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",
@@ -2627,13 +2627,13 @@
       "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"
         }
       ]
     },
     {
-      "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",
@@ -2696,7 +2696,7 @@
       "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"
         }
       ]
     }