@viasat/beam-web-components 2.65.0 → 2.66.0

package/vscode.html-custom-data.json

@@ -177,142 +177,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-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",
-      "attributes": [
-        {
-          "name": "appearance",
-          "description": "Specify the appearance of the Avatar",
-          "values": [{ "name": "accent" }, { "name": "neutral" }]
-        },
-        {
-          "name": "name",
-          "description": "Specify a name to display initials in the Avatar",
-          "values": []
-        },
-        {
-          "name": "src",
-          "description": "Pass an image to the Avatar",
-          "values": []
-        },
-        { "name": "alt", "description": "Specify alt for image", "values": [] },
-        {
-          "name": "size",
-          "description": "Specify the size of the Avatar",
-          "values": [
-            { "name": "xs" },
-            { "name": "sm" },
-            { "name": "md" },
-            { "name": "lg" },
-            { "name": "xl" }
-          ]
-        },
-        {
-          "name": "disabled",
-          "description": "Specify if the Avatar is disabled",
-          "values": []
-        },
-        {
-          "name": "shape",
-          "description": "Specify the shape of the Avatar",
-          "values": [{ "name": "circle" }, { "name": "square" }]
-        },
-        {
-          "name": "isInteractive",
-          "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
-          "values": []
-        },
-        {
-          "name": "isFocusable",
-          "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
-          "values": []
-        },
-        { "name": "withBorder", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
-        }
-      ]
-    },
-    {
-      "name": "bm-avatar-group",
-      "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",
-      "attributes": [
-        {
-          "name": "wrapping",
-          "description": "Specify if the AvatarGroup wraps",
-          "values": []
-        },
-        {
-          "name": "maxCount",
-          "description": "Specify the max number of avatars displayed in the group.",
-          "values": []
-        },
-        {
-          "name": "size",
-          "description": "Specify the size of all Avatars",
-          "values": [
-            { "name": "xs" },
-            { "name": "sm" },
-            { "name": "md" },
-            { "name": "lg" },
-            { "name": "xl" }
-          ]
-        },
-        {
-          "name": "layout",
-          "description": "Specify the kind of the group.",
-          "values": [{ "name": "stacked" }, { "name": "spaced" }]
-        }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
-        }
-      ]
-    },
     {
       "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",
@@ -841,7 +705,143 @@
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-button"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-button"
+        }
+      ]
+    },
+    {
+      "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",
+      "attributes": [
+        {
+          "name": "appearance",
+          "description": "Specify the appearance of the Avatar",
+          "values": [{ "name": "accent" }, { "name": "neutral" }]
+        },
+        {
+          "name": "name",
+          "description": "Specify a name to display initials in the Avatar",
+          "values": []
+        },
+        {
+          "name": "src",
+          "description": "Pass an image to the Avatar",
+          "values": []
+        },
+        { "name": "alt", "description": "Specify alt for image", "values": [] },
+        {
+          "name": "size",
+          "description": "Specify the size of the Avatar",
+          "values": [
+            { "name": "xs" },
+            { "name": "sm" },
+            { "name": "md" },
+            { "name": "lg" },
+            { "name": "xl" }
+          ]
+        },
+        {
+          "name": "disabled",
+          "description": "Specify if the Avatar is disabled",
+          "values": []
+        },
+        {
+          "name": "shape",
+          "description": "Specify the shape of the Avatar",
+          "values": [{ "name": "circle" }, { "name": "square" }]
+        },
+        {
+          "name": "isInteractive",
+          "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
+          "values": []
+        },
+        {
+          "name": "isFocusable",
+          "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
+          "values": []
+        },
+        { "name": "withBorder", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
+        }
+      ]
+    },
+    {
+      "name": "bm-avatar-group",
+      "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",
+      "attributes": [
+        {
+          "name": "wrapping",
+          "description": "Specify if the AvatarGroup wraps",
+          "values": []
+        },
+        {
+          "name": "maxCount",
+          "description": "Specify the max number of avatars displayed in the group.",
+          "values": []
+        },
+        {
+          "name": "size",
+          "description": "Specify the size of all Avatars",
+          "values": [
+            { "name": "xs" },
+            { "name": "sm" },
+            { "name": "md" },
+            { "name": "lg" },
+            { "name": "xl" }
+          ]
+        },
+        {
+          "name": "layout",
+          "description": "Specify the kind of the group.",
+          "values": [{ "name": "stacked" }, { "name": "spaced" }]
+        }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
+        }
+      ]
+    },
+    {
+      "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"
         }
       ]
     },
@@ -1909,51 +1909,6 @@
         }
       ]
     },
-    {
-      "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",
-      "attributes": [
-        {
-          "name": "validationMode",
-          "description": "Specify if validation runs on change or when loosing focus",
-          "values": [
-            { "name": "onChange" },
-            { "name": "onBlur" },
-            { "name": "onSubmit" }
-          ]
-        },
-        {
-          "name": "initialValues",
-          "description": "Specify initial values on Form controls based on their names",
-          "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
-        },
-        {
-          "name": "required",
-          "description": "Specify if input is a required",
-          "values": []
-        },
-        {
-          "name": "disabled",
-          "description": "Specify if input is a disabled",
-          "values": []
-        },
-        {
-          "name": "readOnly",
-          "description": "Specify if input is a read only",
-          "values": []
-        },
-        { "name": "action", "values": [] },
-        { "name": "method", "values": [] },
-        { "name": "target", "values": [] },
-        { "name": "enctype", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
-        }
-      ]
-    },
     {
       "name": "bm-file-upload-button",
       "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 @@
         }
       ]
     },
+    {
+      "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",
+      "attributes": [
+        {
+          "name": "validationMode",
+          "description": "Specify if validation runs on change or when loosing focus",
+          "values": [
+            { "name": "onChange" },
+            { "name": "onBlur" },
+            { "name": "onSubmit" }
+          ]
+        },
+        {
+          "name": "initialValues",
+          "description": "Specify initial values on Form controls based on their names",
+          "values": [{ "name": "Record<string" }, { "name": "FormValue>" }]
+        },
+        {
+          "name": "required",
+          "description": "Specify if input is a required",
+          "values": []
+        },
+        {
+          "name": "disabled",
+          "description": "Specify if input is a disabled",
+          "values": []
+        },
+        {
+          "name": "readOnly",
+          "description": "Specify if input is a read only",
+          "values": []
+        },
+        { "name": "action", "values": [] },
+        { "name": "method", "values": [] },
+        { "name": "target", "values": [] },
+        { "name": "enctype", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
+        }
+      ]
+    },
     {
       "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",
@@ -2332,54 +2332,92 @@
       ]
     },
     {
-      "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-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": "label",
-          "description": "Specify the text for the label",
+          "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",
+          "values": []
+        },
+        {
+          "name": "required",
+          "description": "Specify if TextArea is a required input",
+          "values": []
+        },
+        {
+          "name": "hideRequiredMarker",
+          "description": "Specify if the TextArea displays with an asterisk",
           "values": []
         },
         {
           "name": "error",
-          "description": "Specify error text and display error state of a RadioButton",
+          "description": "Specify error text and display error state of a TextArea",
           "values": []
         },
         {
           "name": "readOnly",
-          "description": "Specify if RadioButton displays in a read-only state",
+          "description": "Specify if TextArea displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if RadioButton displays in a disabled state",
+          "description": "Specify if TextArea 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": "fluid",
+          "description": "Specify if TextArea is fluid",
+          "values": []
         },
         {
-          "name": "value",
-          "description": "The value attribute for the input element",
+          "name": "width",
+          "description": "Specify the width of TextArea",
           "values": []
         },
         {
-          "name": "checked",
-          "description": "The checked attribute for the input element",
+          "name": "hideResize",
+          "description": "Specify if TextArea can be manually resized",
           "values": []
         },
         {
-          "name": "onKeyDown",
-          "description": "A user-defined function to handle keydown events",
-          "values": [{ "name": "(event: KeyboardEvent) => void" }]
-        }
+          "name": "maxCount",
+          "description": "Specify the maximum character count for the TextArea",
+          "values": []
+        },
+        {
+          "name": "autoResize",
+          "description": "Specify if the TextArea automatically resizes to fit the text",
+          "values": []
+        },
+        {
+          "name": "theme",
+          "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": "validationRules",
+          "values": [{ "name": "Array<FormValidator>" }]
+        },
+        { "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"
         }
       ]
     },
@@ -2427,92 +2465,54 @@
       ]
     },
     {
-      "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-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": "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",
-          "values": []
-        },
-        {
-          "name": "required",
-          "description": "Specify if TextArea is a required input",
-          "values": []
-        },
-        {
-          "name": "hideRequiredMarker",
-          "description": "Specify if the TextArea displays with an asterisk",
+          "name": "label",
+          "description": "Specify the text for the label",
           "values": []
         },
         {
           "name": "error",
-          "description": "Specify error text and display error state of a TextArea",
+          "description": "Specify error text and display error state of a RadioButton",
           "values": []
         },
         {
           "name": "readOnly",
-          "description": "Specify if TextArea displays in a read-only state",
+          "description": "Specify if RadioButton displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if TextArea displays in a disabled state",
-          "values": []
-        },
-        {
-          "name": "fluid",
-          "description": "Specify if TextArea is fluid",
-          "values": []
-        },
-        {
-          "name": "width",
-          "description": "Specify the width of TextArea",
+          "description": "Specify if RadioButton displays in a disabled state",
           "values": []
         },
         {
-          "name": "hideResize",
-          "description": "Specify if TextArea can be manually resized",
-          "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": "maxCount",
-          "description": "Specify the maximum character count for the TextArea",
+          "name": "value",
+          "description": "The value attribute for the input element",
           "values": []
         },
         {
-          "name": "autoResize",
-          "description": "Specify if the TextArea automatically resizes to fit the text",
+          "name": "checked",
+          "description": "The checked attribute for the input element",
           "values": []
         },
         {
-          "name": "theme",
-          "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": "validationRules",
-          "values": [{ "name": "Array<FormValidator>" }]
-        },
-        { "name": "input-aria-label", "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-textarea"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-radiobutton"
         }
       ]
     },
@@ -2586,8 +2586,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",
@@ -2650,13 +2650,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",
@@ -2719,7 +2719,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"
         }
       ]
     }