@viasat/beam-web-components 2.8.0 → 2.10.0

package/vscode.html-custom-data.json

@@ -611,75 +611,100 @@
       ]
     },
     {
-      "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-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": "heading",
-          "description": "Specify the heading text for Alert",
+          "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": "body",
-          "description": "Specify the body text for Alert",
+          "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 Alert",
-          "values": [{ "name": "sm" }, { "name": "md" }]
+          "description": "Specify the size of the Avatar",
+          "values": [
+            { "name": "xs" },
+            { "name": "sm" },
+            { "name": "md" },
+            { "name": "lg" },
+            { "name": "xl" }
+          ]
         },
         {
-          "name": "fullWidth",
-          "description": "Specify if the Alert has no border radius",
+          "name": "disabled",
+          "description": "Specify if the Avatar is disabled",
           "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": "shape",
+          "description": "Specify the shape of the Avatar",
+          "values": [{ "name": "circle" }, { "name": "square" }]
         },
         {
-          "name": "appearance",
-          "description": "Specify the appearance of the Alert",
-          "values": [
-            { "name": "infoPrimary" },
-            { "name": "infoSecondary" },
-            { "name": "positive" },
-            { "name": "warning" },
-            { "name": "negative" }
-          ]
+          "name": "isInteractive",
+          "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
+          "values": []
         },
         {
-          "name": "hidden",
-          "description": "Specify if the Alert is hidden",
+          "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": "hideIcon",
-          "description": "Specify if the icon displays on the Alert",
+          "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": "dismissible",
-          "description": "Specify if the Alert can be dismissed",
+          "name": "maxCount",
+          "description": "Specify the max number of avatars displayed in the group.",
           "values": []
         },
         {
-          "name": "disableAutoFocus",
-          "description": "Prevent autofocus on show",
-          "values": []
+          "name": "size",
+          "description": "Specify the size of all Avatars",
+          "values": [
+            { "name": "xs" },
+            { "name": "sm" },
+            { "name": "md" },
+            { "name": "lg" },
+            { "name": "xl" }
+          ]
         },
         {
-          "name": "disableCloseOnEscape",
-          "description": "Prevent Escape from closing",
-          "values": []
+          "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-alert"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
         }
       ]
     },
@@ -752,100 +777,75 @@
       ]
     },
     {
-      "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",
+      "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": "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",
+          "name": "heading",
+          "description": "Specify the heading text for Alert",
           "values": []
         },
         {
-          "name": "src",
-          "description": "Pass an image to the Avatar",
+          "name": "body",
+          "description": "Specify the body text for Alert",
           "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" }
-          ]
+          "description": "Specify the size of the Alert",
+          "values": [{ "name": "sm" }, { "name": "md" }]
         },
         {
-          "name": "disabled",
-          "description": "Specify if the Avatar is disabled",
+          "name": "fullWidth",
+          "description": "Specify if the Alert has no border radius",
           "values": []
         },
         {
-          "name": "shape",
-          "description": "Specify the shape of the Avatar",
-          "values": [{ "name": "circle" }, { "name": "square" }]
+          "name": "theme",
+          "description": "Specify the theme of the Alert. By default it inherits the theme from the parent",
+          "values": [{ "name": "light" }, { "name": "dark" }]
         },
         {
-          "name": "isInteractive",
-          "description": "If Avatar is interactive, use `isInteractive` to make the Avatar focusable and show state layer",
-          "values": []
+          "name": "appearance",
+          "description": "Specify the appearance of the Alert",
+          "values": [
+            { "name": "infoPrimary" },
+            { "name": "infoSecondary" },
+            { "name": "positive" },
+            { "name": "warning" },
+            { "name": "negative" }
+          ]
         },
         {
-          "name": "isFocusable",
-          "description": "If Avatar is not interactive and Tooltip is provided, use `isFocusable` to make the Avatar focusable",
+          "name": "hidden",
+          "description": "Specify if the Alert is hidden",
           "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",
+          "name": "hideIcon",
+          "description": "Specify if the icon displays on the Alert",
           "values": []
         },
         {
-          "name": "maxCount",
-          "description": "Specify the max number of avatars displayed in the group.",
+          "name": "dismissible",
+          "description": "Specify if the Alert can be dismissed",
           "values": []
         },
         {
-          "name": "size",
-          "description": "Specify the size of all Avatars",
-          "values": [
-            { "name": "xs" },
-            { "name": "sm" },
-            { "name": "md" },
-            { "name": "lg" },
-            { "name": "xl" }
-          ]
+          "name": "disableAutoFocus",
+          "description": "Prevent autofocus on show",
+          "values": []
         },
         {
-          "name": "layout",
-          "description": "Specify the kind of the group.",
-          "values": [{ "name": "stacked" }, { "name": "spaced" }]
+          "name": "disableCloseOnEscape",
+          "description": "Prevent Escape from closing",
+          "values": []
         }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/components-avatar"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/components-alert"
         }
       ]
     },
@@ -2072,47 +2072,39 @@
       ]
     },
     {
-      "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",
+      "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": "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": "disabled",
+          "description": "Specify if the Label displays disabled",
+          "values": []
         },
         {
           "name": "required",
-          "description": "Specify if input is a required",
+          "description": "Specify if the Label displays as required",
           "values": []
         },
         {
-          "name": "disabled",
-          "description": "Specify if input is a disabled",
-          "values": []
+          "name": "text",
+          "description": "Specify the text for Label",
+          "values": [{ "name": "Optional<string>" }]
         },
         {
-          "name": "readOnly",
-          "description": "Specify if input is a read only",
-          "values": []
+          "name": "optional",
+          "description": "Specify the text for Label",
+          "values": [{ "name": "Optional<string>" }]
         },
-        { "name": "action", "values": [{ "name": "Optional<string>" }] },
-        { "name": "method", "values": [{ "name": "Optional<string>" }] },
-        { "name": "target", "values": [{ "name": "Optional<string>" }] },
-        { "name": "enctype", "values": [{ "name": "Optional<string>" }] }
+        {
+          "name": "theme",
+          "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
+          "values": [{ "name": "Optional<ThemeTypes>" }]
+        }
       ],
       "references": [
         {
           "name": "Storybook",
-          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-label"
         }
       ]
     },
@@ -2184,49 +2176,6 @@
         }
       ]
     },
-    {
-      "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-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",
@@ -2280,39 +2229,90 @@
       ]
     },
     {
-      "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",
+      "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 the Label displays disabled",
+          "description": "Specify if input is a disabled",
           "values": []
         },
         {
-          "name": "required",
-          "description": "Specify if the Label displays as required",
+          "name": "readOnly",
+          "description": "Specify if input is a read only",
           "values": []
         },
+        { "name": "action", "values": [{ "name": "Optional<string>" }] },
+        { "name": "method", "values": [{ "name": "Optional<string>" }] },
+        { "name": "target", "values": [{ "name": "Optional<string>" }] },
+        { "name": "enctype", "values": [{ "name": "Optional<string>" }] }
+      ],
+      "references": [
         {
-          "name": "text",
-          "description": "Specify the text for Label",
-          "values": [{ "name": "Optional<string>" }]
+          "name": "Storybook",
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-form"
+        }
+      ]
+    },
+    {
+      "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": "optional",
-          "description": "Specify the text for Label",
-          "values": [{ "name": "Optional<string>" }]
+          "name": "offText",
+          "description": "Specify a side label for the “off” position. If offText is not specified, side label defaults to onText value.",
+          "values": []
         },
         {
-          "name": "theme",
-          "description": "Specify the theme of the Label. By default it inherits the theme from the parent",
-          "values": [{ "name": "Optional<ThemeTypes>" }]
+          "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-label"
+          "url": "https://web-components.beam.viasat.com/?path=/docs/forms-switch"
         }
       ]
     },
@@ -2557,8 +2557,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",
@@ -2624,13 +2624,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"
         }
       ]
     }