@momentum-design/components 0.120.24 → 0.120.26

package/dist/custom-elements.json

@@ -37604,6 +37604,17 @@
               "attribute": "timeout",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "debounceTime",
+              "type": {
+                "text": "number"
+              },
+              "description": "The debounce time delay in milliseconds for announcements.",
+              "default": "500",
+              "attribute": "debounce-time",
+              "reflects": true
+            },
             {
               "kind": "method",
               "name": "announce",
@@ -37650,6 +37661,12 @@
               "name": "createAnnouncementAriaLiveRegion",
               "privacy": "private",
               "description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
+            },
+            {
+              "kind": "method",
+              "name": "setupDebouncedAnnounce",
+              "privacy": "private",
+              "description": "Creates a single debounced function that will read the latest this.announcement when executed.\n\nThis function is used to debounce the announcement so that it will only be made after\nthis.debounceTime milliseconds have passed since the last time this.announcement was updated."
             }
           ],
           "attributes": [
@@ -37697,6 +37714,15 @@
               "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
               "default": "20_000",
               "fieldName": "timeout"
+            },
+            {
+              "name": "debounce-time",
+              "type": {
+                "text": "number"
+              },
+              "description": "The debounce time delay in milliseconds for announcements.",
+              "default": "500",
+              "fieldName": "debounceTime"
             }
           ],
           "superclass": {
@@ -41861,6 +41887,139 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "components/staticchip/staticchip.component.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "mdc-staticchip is an static element that can be used to represent a chip. It supports a leading icon along with label.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>, including empty spaces to split words.",
+          "name": "StaticChip",
+          "cssProperties": [
+            {
+              "description": "The color of the static chip.",
+              "name": "--mdc-chip-color"
+            },
+            {
+              "description": "The border color of the static chip.",
+              "name": "--mdc-chip-border-color"
+            },
+            {
+              "description": "The background color of the static chip.",
+              "name": "--mdc-chip-background-color"
+            }
+          ],
+          "cssParts": [
+            {
+              "description": "The label of the static chip.",
+              "name": "label"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "color",
+              "type": {
+                "text": "ColorType"
+              },
+              "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
+              "default": "default",
+              "attribute": "color",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
+              "attribute": "label"
+            },
+            {
+              "kind": "method",
+              "name": "renderIcon",
+              "privacy": "private",
+              "description": "Renders the icon element if available.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "iconName",
+              "type": {
+                "text": "IconNames | undefined"
+              },
+              "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
+              "attribute": "icon-name",
+              "inheritedFrom": {
+                "name": "IconNameMixin",
+                "module": "utils/mixins/IconNameMixin.js"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "color",
+              "type": {
+                "text": "ColorType"
+              },
+              "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
+              "default": "default",
+              "fieldName": "color"
+            },
+            {
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
+              "fieldName": "label"
+            },
+            {
+              "name": "icon-name",
+              "type": {
+                "text": "IconNames | undefined"
+              },
+              "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
+              "fieldName": "iconName",
+              "inheritedFrom": {
+                "name": "IconNameMixin",
+                "module": "src/utils/mixins/IconNameMixin.ts"
+              }
+            }
+          ],
+          "mixins": [
+            {
+              "name": "IconNameMixin",
+              "module": "/src/utils/mixins/IconNameMixin"
+            }
+          ],
+          "superclass": {
+            "name": "Component",
+            "module": "/src/models"
+          },
+          "tagName": "mdc-staticchip",
+          "jsDoc": "/**\n * mdc-staticchip is an static element that can be used to represent a chip. It supports a leading icon along with label.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>, including empty spaces to split words.\n *\n *\n * @tagname mdc-staticchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the static chip.\n * @cssproperty --mdc-chip-border-color - The border color of the static chip.\n * @cssproperty --mdc-chip-background-color - The background color of the static chip.\n *\n * @csspart label - The label of the static chip.\n */",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "StaticChip",
+            "module": "components/staticchip/staticchip.component.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "components/staticradio/staticradio.component.js",
@@ -42007,159 +42166,26 @@
                 "text": "boolean | undefined"
               },
               "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
-              "default": "undefined",
-              "fieldName": "disabled",
-              "inheritedFrom": {
-                "name": "DisabledMixin",
-                "module": "src/utils/mixins/DisabledMixin.ts"
-              }
-            }
-          ],
-          "mixins": [
-            {
-              "name": "DisabledMixin",
-              "module": "/src/utils/mixins/DisabledMixin"
-            }
-          ],
-          "superclass": {
-            "name": "Component",
-            "module": "/src/models"
-          },
-          "tagName": "mdc-staticradio",
-          "jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 4 properties - checked, disabled, readonly and soft-disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n *  inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n *  when active and disabled\n *\n * @csspart radio-icon - The radio icon.\n *\n * @slot - Default slot for the label of the radio.\n */",
-          "customElement": true
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "default",
-          "declaration": {
-            "name": "StaticRadio",
-            "module": "components/staticradio/staticradio.component.js"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "components/staticchip/staticchip.component.js",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "mdc-staticchip is an static element that can be used to represent a chip. It supports a leading icon along with label.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>, including empty spaces to split words.",
-          "name": "StaticChip",
-          "cssProperties": [
-            {
-              "description": "The color of the static chip.",
-              "name": "--mdc-chip-color"
-            },
-            {
-              "description": "The border color of the static chip.",
-              "name": "--mdc-chip-border-color"
-            },
-            {
-              "description": "The background color of the static chip.",
-              "name": "--mdc-chip-background-color"
-            }
-          ],
-          "cssParts": [
-            {
-              "description": "The label of the static chip.",
-              "name": "label"
-            }
-          ],
-          "members": [
-            {
-              "kind": "field",
-              "name": "color",
-              "type": {
-                "text": "ColorType"
-              },
-              "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
-              "default": "default",
-              "attribute": "color",
-              "reflects": true
-            },
-            {
-              "kind": "field",
-              "name": "label",
-              "type": {
-                "text": "string"
-              },
-              "default": "''",
-              "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
-              "attribute": "label"
-            },
-            {
-              "kind": "method",
-              "name": "renderIcon",
-              "privacy": "private",
-              "description": "Renders the icon element if available.",
-              "return": {
-                "type": {
-                  "text": ""
-                }
-              }
-            },
-            {
-              "kind": "field",
-              "name": "iconName",
-              "type": {
-                "text": "IconNames | undefined"
-              },
-              "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
-              "attribute": "icon-name",
-              "inheritedFrom": {
-                "name": "IconNameMixin",
-                "module": "utils/mixins/IconNameMixin.js"
-              }
-            }
-          ],
-          "attributes": [
-            {
-              "name": "color",
-              "type": {
-                "text": "ColorType"
-              },
-              "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
-              "default": "default",
-              "fieldName": "color"
-            },
-            {
-              "name": "label",
-              "type": {
-                "text": "string"
-              },
-              "default": "''",
-              "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
-              "fieldName": "label"
-            },
-            {
-              "name": "icon-name",
-              "type": {
-                "text": "IconNames | undefined"
-              },
-              "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
-              "fieldName": "iconName",
+              "default": "undefined",
+              "fieldName": "disabled",
               "inheritedFrom": {
-                "name": "IconNameMixin",
-                "module": "src/utils/mixins/IconNameMixin.ts"
+                "name": "DisabledMixin",
+                "module": "src/utils/mixins/DisabledMixin.ts"
               }
             }
           ],
           "mixins": [
             {
-              "name": "IconNameMixin",
-              "module": "/src/utils/mixins/IconNameMixin"
+              "name": "DisabledMixin",
+              "module": "/src/utils/mixins/DisabledMixin"
             }
           ],
           "superclass": {
             "name": "Component",
             "module": "/src/models"
           },
-          "tagName": "mdc-staticchip",
-          "jsDoc": "/**\n * mdc-staticchip is an static element that can be used to represent a chip. It supports a leading icon along with label.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>, including empty spaces to split words.\n *\n *\n * @tagname mdc-staticchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the static chip.\n * @cssproperty --mdc-chip-border-color - The border color of the static chip.\n * @cssproperty --mdc-chip-background-color - The background color of the static chip.\n *\n * @csspart label - The label of the static chip.\n */",
+          "tagName": "mdc-staticradio",
+          "jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 4 properties - checked, disabled, readonly and soft-disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n *  inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n *  when active and disabled\n *\n * @csspart radio-icon - The radio icon.\n *\n * @slot - Default slot for the label of the radio.\n */",
           "customElement": true
         }
       ],
@@ -42168,8 +42194,8 @@
           "kind": "js",
           "name": "default",
           "declaration": {
-            "name": "StaticChip",
-            "module": "components/staticchip/staticchip.component.js"
+            "name": "StaticRadio",
+            "module": "components/staticradio/staticradio.component.js"
           }
         }
       ]
@@ -44280,17 +44306,17 @@
               "type": {
                 "text": "number | undefined"
               },
-              "description": "maximum character limit for the textarea field for character counter.",
+              "description": "The maximum character limit for the textarea field for character counter.",
               "attribute": "max-character-limit"
             },
             {
               "kind": "field",
-              "name": "characterLimitExceedingFired",
+              "name": "characterLimitAnnouncement",
               "type": {
-                "text": "boolean"
+                "text": "string | undefined"
               },
-              "privacy": "private",
-              "default": "false"
+              "description": "Template string for the announcement that will be read by screen readers when the max character limit is set.\nConsumers must use the placeholders `%{number-of-characters}` and `%{max-character-limit}` in the string,\nwhich will be dynamically replaced with the actual values at runtime.\nFor example: `%{number-of-characters} out of %{max-character-limit} characters are typed.`\nExample output: \"93 out of 140 characters are typed.\"",
+              "attribute": "character-limit-announcement"
             },
             {
               "kind": "field",
@@ -44349,6 +44375,12 @@
                 }
               }
             },
+            {
+              "kind": "method",
+              "name": "announceMaxLengthWarning",
+              "privacy": "private",
+              "description": "Announces the character limit warning based on the current value length.\nIf the value length exceeds the max character limit, the help text is announced (if help text is present).\nIf the value length does not exceed the max character limit, then the character limit announcement is announced."
+            },
             {
               "kind": "method",
               "name": "onChange",
@@ -44856,9 +44888,17 @@
               "type": {
                 "text": "number | undefined"
               },
-              "description": "maximum character limit for the textarea field for character counter.",
+              "description": "The maximum character limit for the textarea field for character counter.",
               "fieldName": "maxCharacterLimit"
             },
+            {
+              "name": "character-limit-announcement",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Template string for the announcement that will be read by screen readers when the max character limit is set.\nConsumers must use the placeholders `%{number-of-characters}` and `%{max-character-limit}` in the string,\nwhich will be dynamically replaced with the actual values at runtime.\nFor example: `%{number-of-characters} out of %{max-character-limit} characters are typed.`\nExample output: \"93 out of 140 characters are typed.\"",
+              "fieldName": "characterLimitAnnouncement"
+            },
             {
               "name": "auto-focus-on-mount",
               "type": {
@@ -53258,274 +53298,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "utils/mixins/ItemCollectionMixin.js",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "",
-          "name": "ItemCollectionMixinInterface",
-          "members": [
-            {
-              "kind": "field",
-              "name": "items",
-              "type": {
-                "text": "TItem[]"
-              },
-              "privacy": "public",
-              "description": "List of items (cached)",
-              "readonly": true
-            },
-            {
-              "kind": "method",
-              "name": "isValidItem",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": ""
-                }
-              },
-              "parameters": [
-                {
-                  "name": "item",
-                  "type": {
-                    "text": "Element"
-                  },
-                  "description": "The item to validate."
-                }
-              ],
-              "description": "Checks if the item is valid.\nInvalid items will not be collected or processed.\nThis method can be overridden by subclasses to define custom validation logic."
-            },
-            {
-              "kind": "method",
-              "name": "addItemToCacheAt",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "item",
-                  "type": {
-                    "text": "Element"
-                  },
-                  "description": "The item to add to the cache."
-                },
-                {
-                  "name": "index",
-                  "optional": true,
-                  "type": {
-                    "text": "number"
-                  },
-                  "description": "The index at which to add the item. If -1, adds to the end."
-                }
-              ],
-              "description": "Adds an item to the cache at the specified index.\nWhen the index\n is `undefined`, the item is added automatically keeping the DOM order.\n is `-1`, the item is added to the end of the cache.\n is `>= 0`, the item is added at that index.\n otherwise, do nothing."
-            },
-            {
-              "kind": "method",
-              "name": "removeItemFromCache",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "item",
-                  "type": {
-                    "text": "Element"
-                  },
-                  "description": "The item to remove from the cache."
-                }
-              ],
-              "description": "Removes an item from the cache."
-            },
-            {
-              "kind": "method",
-              "name": "setItemCache",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "items",
-                  "optional": true,
-                  "type": {
-                    "text": "TItem[]"
-                  },
-                  "description": "The items to set in the cache."
-                }
-              ],
-              "description": "Sets the item cache to the provided items.\nIf no items are provided, it clears the cache."
-            }
-          ]
-        },
-        {
-          "kind": "mixin",
-          "description": "This mixin collects and cache items based on the `created` and `destroyed` lifecycle events.\nAlso provides methods to manage the item cache.",
-          "name": "ItemCollectionMixin",
-          "members": [
-            {
-              "kind": "field",
-              "name": "itemCache",
-              "type": {
-                "text": "TItem[]"
-              },
-              "privacy": "private",
-              "default": "[]"
-            },
-            {
-              "kind": "field",
-              "name": "items",
-              "type": {
-                "text": "TItem[]"
-              },
-              "privacy": "protected",
-              "readonly": true
-            },
-            {
-              "kind": "method",
-              "name": "itemCreationHandler",
-              "privacy": "protected",
-              "parameters": [
-                {
-                  "name": "event",
-                  "type": {
-                    "text": "Event"
-                  },
-                  "description": "The event triggered when an item is created."
-                }
-              ],
-              "description": "Handles the item creation event."
-            },
-            {
-              "kind": "method",
-              "name": "itemDestroyHandler",
-              "privacy": "protected",
-              "parameters": [
-                {
-                  "name": "event",
-                  "type": {
-                    "text": "Event"
-                  },
-                  "description": "The event triggered when an item is destroyed."
-                }
-              ],
-              "description": "Handles the item destroy event."
-            },
-            {
-              "kind": "method",
-              "name": "isValidItem",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "item",
-                  "type": {
-                    "text": "Element"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "addItemToCacheAt",
-              "privacy": "protected",
-              "parameters": [
-                {
-                  "name": "newItem",
-                  "type": {
-                    "text": "Element"
-                  }
-                },
-                {
-                  "name": "index",
-                  "optional": true,
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "removeItemFromCache",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "item",
-                  "type": {
-                    "text": "Element"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "setItemCache",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "items",
-                  "type": {
-                    "text": "TItem[]"
-                  }
-                }
-              ]
-            }
-          ],
-          "parameters": [
-            {
-              "name": "superClass",
-              "type": {
-                "text": "T"
-              },
-              "description": "The class to extend with the mixin."
-            }
-          ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "ItemCollectionMixinInterface",
-          "declaration": {
-            "name": "ItemCollectionMixinInterface",
-            "module": "utils/mixins/ItemCollectionMixin.js"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "ItemCollectionMixin",
-          "declaration": {
-            "name": "ItemCollectionMixin",
-            "module": "utils/mixins/ItemCollectionMixin.js"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "utils/mixins/ListNavigationMixin.js",