@viasat/beam-web-components 2.37.0 → 2.38.1

package/vscode.html-custom-data.json

@@ -104,6 +104,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-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",
@@ -545,67 +618,6 @@
         }
       ]
     },
-    {
-      "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",
-      "attributes": [
-        {
-          "name": "wrap",
-          "description": "Specify if items wrap or collapse to an ellipsis",
-          "values": []
-        },
-        {
-          "name": "itemsBeforeCollapse",
-          "description": "Specify how many items show before ellipsis",
-          "values": []
-        },
-        {
-          "name": "itemsAfterCollapse",
-          "description": "Specify how many items show after ellipsis",
-          "values": []
-        },
-        {
-          "name": "theme",
-          "description": "Specify the theme of the Breadcrumbs. 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/components-breadcrumb"
-        }
-      ]
-    },
-    {
-      "name": "bm-breadcrumb-item",
-      "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",
-      "attributes": [
-        { "name": "href", "description": "Pass href to an item", "values": [] },
-        {
-          "name": "clickable",
-          "description": "Specify if the item is interactive without an href",
-          "values": []
-        },
-        {
-          "name": "truncationWidth",
-          "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
-          "values": []
-        },
-        {
-          "name": "isCurrent",
-          "description": "Specify explicitly if the item is the last one",
-          "values": []
-        },
-        { "name": "isCollapsed", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
-        }
-      ]
-    },
     {
       "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",
@@ -705,75 +717,63 @@
       ]
     },
     {
-      "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-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",
       "attributes": [
         {
-          "name": "heading",
-          "description": "Specify the heading text for Alert",
+          "name": "wrap",
+          "description": "Specify if items wrap or collapse to an ellipsis",
           "values": []
         },
         {
-          "name": "body",
-          "description": "Specify the body text for Alert",
+          "name": "itemsBeforeCollapse",
+          "description": "Specify how many items show before ellipsis",
           "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",
+          "name": "itemsAfterCollapse",
+          "description": "Specify how many items show after ellipsis",
           "values": []
         },
         {
           "name": "theme",
-          "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
+          "description": "Specify the theme of the Breadcrumbs. 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" }
-          ]
-        },
+        }
+      ],
+      "references": [
         {
-          "name": "hidden",
-          "description": "Specify if the Alert is hidden",
-          "values": []
-        },
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-breadcrumb"
+        }
+      ]
+    },
+    {
+      "name": "bm-breadcrumb-item",
+      "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",
+      "attributes": [
+        { "name": "href", "description": "Pass href to an item", "values": [] },
         {
-          "name": "hideIcon",
-          "description": "Specify if the icon displays on the Alert",
+          "name": "clickable",
+          "description": "Specify if the item is interactive without an href",
           "values": []
         },
         {
-          "name": "dismissible",
-          "description": "Specify if the Alert can be dismissed",
+          "name": "truncationWidth",
+          "description": "Specify truncation width of the items. Sets max-width for all items but the last.",
           "values": []
         },
         {
-          "name": "disableAutoFocus",
-          "description": "Prevent autofocus on show",
+          "name": "isCurrent",
+          "description": "Specify explicitly if the item is the last one",
           "values": []
         },
-        {
-          "name": "disableCloseOnEscape",
-          "description": "Prevent Escape from closing",
-          "values": []
-        }
+        { "name": "isCollapsed", "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-breadcrumb"
         }
       ]
     },
@@ -1665,6 +1665,11 @@
           "description": "Specify if TextField is fluid",
           "values": []
         },
+        {
+          "name": "size",
+          "description": "Specify the size of TextField",
+          "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
+        },
         {
           "name": "width",
           "description": "Specify the width of TextField",
@@ -1904,116 +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-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",
-      "attributes": [
-        {
-          "name": "required",
-          "description": "Specify if NativeSelect is a required input",
-          "values": []
-        },
-        {
-          "name": "readOnly",
-          "description": "Specify if NativeSelect displays in a read-only state",
-          "values": []
-        },
-        {
-          "name": "disabled",
-          "description": "Specify if NativeSelect displays in a disabled state",
-          "values": []
-        },
-        {
-          "name": "error",
-          "description": "Specify error text and display error state of a NativeSelect",
-          "values": []
-        },
-        {
-          "name": "fluid",
-          "description": "Specify if NativeSelect is fluid",
-          "values": []
-        },
-        {
-          "name": "width",
-          "description": "Specify the width of NativeSelect",
-          "values": []
-        },
-        {
-          "name": "ellipse",
-          "description": "Specify if overflow displays ellipsis",
-          "values": []
-        },
-        {
-          "name": "hideRequiredMarker",
-          "description": "Specify if the NativeSelect displays with an asterisk",
-          "values": []
-        },
-        {
-          "name": "theme",
-          "description": "Specify the theme of the NativeSelect. 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-nativeselect"
-        }
-      ]
-    },
     {
       "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",
@@ -2322,45 +2217,117 @@
       ]
     },
     {
-      "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-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": "onText",
-          "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
+          "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": "offText",
-          "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
+          "name": "disabled",
+          "description": "Specify if input is a disabled",
           "values": []
         },
         {
-          "name": "textPosition",
-          "description": "Specify the position of the side label",
-          "values": [{ "name": "before" }, { "name": "after" }]
+          "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",
+      "attributes": [
+        {
+          "name": "required",
+          "description": "Specify if NativeSelect is a required input",
+          "values": []
         },
         {
           "name": "readOnly",
-          "description": "Specify if Switch displays in a read-only state",
+          "description": "Specify if NativeSelect displays in a read-only state",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Specify if Switch displays in a disabled state",
+          "description": "Specify if NativeSelect displays in a disabled state",
           "values": []
         },
-        { "name": "checked", "values": [] },
         {
-          "name": "value",
-          "description": "The value attribute for the input element",
+          "name": "error",
+          "description": "Specify error text and display error state of a NativeSelect",
           "values": []
-        }
+        },
+        {
+          "name": "fluid",
+          "description": "Specify if NativeSelect is fluid",
+          "values": []
+        },
+        {
+          "name": "size",
+          "description": "Specify the size of NativeSelect",
+          "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
+        },
+        {
+          "name": "width",
+          "description": "Specify the width of NativeSelect",
+          "values": []
+        },
+        {
+          "name": "ellipse",
+          "description": "Specify if overflow displays ellipsis",
+          "values": []
+        },
+        {
+          "name": "hideRequiredMarker",
+          "description": "Specify if the NativeSelect displays with an asterisk",
+          "values": []
+        },
+        {
+          "name": "theme",
+          "description": "Specify the theme of the NativeSelect. 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-switch"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-nativeselect"
         }
       ]
     },
@@ -2416,6 +2383,49 @@
         }
       ]
     },
+    {
+      "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": "onText",
+          "description": "Specify a side label for the “on” position. If onText is not specified, side label defaults to offText value.",
+          "values": []
+        },
+        {
+          "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 Switch displays in a read-only state",
+          "values": []
+        },
+        {
+          "name": "disabled",
+          "description": "Specify if Switch displays in a disabled state",
+          "values": []
+        },
+        { "name": "checked", "values": [] },
+        {
+          "name": "value",
+          "description": "The value attribute for the input element",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
+        }
+      ]
+    },
     {
       "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",
@@ -2576,8 +2586,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",
@@ -2640,13 +2650,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",
@@ -2709,7 +2719,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"
         }
       ]
     }