@govtechsg/sgds-web-component 3.26.1-rc.0 → 3.26.1-rc.1

package/custom-elements.json

@@ -1212,308 +1212,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "",
-          "name": "SgdsBreadcrumbItem",
-          "slots": [
-            {
-              "description": "The link of the item. Pass in anchor tags into this slot",
-              "name": "default"
-            }
-          ],
-          "members": [
-            {
-              "kind": "field",
-              "name": "dependencies",
-              "type": {
-                "text": "Record<string, typeof SgdsElement>"
-              },
-              "static": true,
-              "default": "{\n    \"sgds-link\": SgdsLink,\n    \"sgds-icon\": SgdsIcon\n  }"
-            },
-            {
-              "kind": "field",
-              "name": "active",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
-              "attribute": "active",
-              "reflects": true
-            },
-            {
-              "kind": "field",
-              "name": "_preventNavigation",
-              "privacy": "private",
-              "type": {}
-            },
-            {
-              "kind": "method",
-              "name": "emit",
-              "parameters": [
-                {
-                  "name": "name",
-                  "type": {
-                    "text": "string"
-                  }
-                },
-                {
-                  "name": "options",
-                  "optional": true,
-                  "type": {
-                    "text": "CustomEventInit<T>"
-                  }
-                }
-              ],
-              "description": "Emits a custom event with more convenient defaults.",
-              "type": {},
-              "inheritedFrom": {
-                "name": "SgdsElement",
-                "module": "src/base/sgds-element.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "define",
-              "static": true,
-              "parameters": [
-                {
-                  "name": "name",
-                  "type": {
-                    "text": "string"
-                  }
-                },
-                {
-                  "name": "elementConstructor",
-                  "default": "this"
-                },
-                {
-                  "name": "options",
-                  "default": "{}",
-                  "type": {
-                    "text": "ElementDefinitionOptions"
-                  }
-                }
-              ],
-              "type": {},
-              "inheritedFrom": {
-                "name": "SgdsElement",
-                "module": "src/base/sgds-element.ts"
-              }
-            }
-          ],
-          "attributes": [
-            {
-              "name": "active",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
-              "fieldName": "active"
-            }
-          ],
-          "superclass": {
-            "name": "SgdsElement",
-            "module": "/src/base/sgds-element"
-          },
-          "summary": "Breadcrumb Item are navigational links used in Breadcrumb component",
-          "tagName": "sgds-breadcrumb-item",
-          "customElement": true,
-          "modulePath": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
-          "cssProperties": [],
-          "cssParts": [],
-          "cssStates": [],
-          "events": []
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "SgdsBreadcrumbItem",
-          "declaration": {
-            "name": "SgdsBreadcrumbItem",
-            "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "default",
-          "declaration": {
-            "name": "SgdsBreadcrumbItem",
-            "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/Breadcrumb/sgds-breadcrumb.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "",
-          "name": "SgdsBreadcrumb",
-          "slots": [
-            {
-              "description": "The slot to pass in custom elements of `SgdsBreadcrumbItems`.",
-              "name": "default"
-            }
-          ],
-          "members": [
-            {
-              "kind": "field",
-              "name": "dependencies",
-              "type": {
-                "text": "object"
-              },
-              "static": true,
-              "default": "{\n    \"sgds-overflow-menu\": SgdsOverflowMenu\n  }"
-            },
-            {
-              "kind": "field",
-              "name": "ariaLabel",
-              "type": {
-                "text": "string"
-              },
-              "default": "\"breadcrumb\"",
-              "description": "The aria-label of nav element within breadcrumb component.",
-              "attribute": "ariaLabel"
-            },
-            {
-              "kind": "method",
-              "name": "_replaceExcessItemsWithDropdown",
-              "privacy": "private",
-              "parameters": [
-                {
-                  "name": "items",
-                  "type": {
-                    "text": "SgdsBreadcrumbItem[]"
-                  }
-                }
-              ],
-              "description": "creates `<sgds-breadcrumb-item>\n           <sgds-overflow-menu>\n             <sgds-dropdown-item></sgds-dropdown-item>\n              ...\n           </sgds-overflow-menu>\n         <sgds-breadcrumb-item>`",
-              "type": {}
-            },
-            {
-              "kind": "method",
-              "name": "_handleSlotChange",
-              "privacy": "private",
-              "parameters": [
-                {
-                  "name": "e",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ],
-              "type": {}
-            },
-            {
-              "kind": "method",
-              "name": "emit",
-              "parameters": [
-                {
-                  "name": "name",
-                  "type": {
-                    "text": "string"
-                  }
-                },
-                {
-                  "name": "options",
-                  "optional": true,
-                  "type": {
-                    "text": "CustomEventInit<T>"
-                  }
-                }
-              ],
-              "description": "Emits a custom event with more convenient defaults.",
-              "type": {},
-              "inheritedFrom": {
-                "name": "SgdsElement",
-                "module": "src/base/sgds-element.ts"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "define",
-              "static": true,
-              "parameters": [
-                {
-                  "name": "name",
-                  "type": {
-                    "text": "string"
-                  }
-                },
-                {
-                  "name": "elementConstructor",
-                  "default": "this"
-                },
-                {
-                  "name": "options",
-                  "default": "{}",
-                  "type": {
-                    "text": "ElementDefinitionOptions"
-                  }
-                }
-              ],
-              "type": {},
-              "inheritedFrom": {
-                "name": "SgdsElement",
-                "module": "src/base/sgds-element.ts"
-              }
-            }
-          ],
-          "attributes": [
-            {
-              "name": "ariaLabel",
-              "type": {
-                "text": "string"
-              },
-              "default": "\"breadcrumb\"",
-              "description": "The aria-label of nav element within breadcrumb component.",
-              "fieldName": "ariaLabel"
-            }
-          ],
-          "superclass": {
-            "name": "SgdsElement",
-            "module": "/src/base/sgds-element"
-          },
-          "summary": "Breadcrumbs help users to navigate and understand where they are on the current website or service.",
-          "tagName": "sgds-breadcrumb",
-          "customElement": true,
-          "modulePath": "src/components/Breadcrumb/sgds-breadcrumb.ts",
-          "cssProperties": [],
-          "cssParts": [],
-          "cssStates": [],
-          "events": []
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "SgdsBreadcrumb",
-          "declaration": {
-            "name": "SgdsBreadcrumb",
-            "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "default",
-          "declaration": {
-            "name": "SgdsBreadcrumb",
-            "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/components/Button/sgds-button.ts",
@@ -2146,126 +1844,428 @@
               "description": "Specifies a small, medium or large button, the size is medium by default.",
               "fieldName": "size",
               "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "active",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Manually set the visual state of the button to `:active`",
+              "fieldName": "active",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "The disabled state of the button",
+              "fieldName": "disabled",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "href",
+              "type": {
+                "text": "string"
+              },
+              "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
+              "fieldName": "href",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "target",
+              "type": {
+                "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
+              },
+              "default": "\"_self\"",
+              "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
+              "fieldName": "target",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "download",
+              "type": {
+                "text": "string"
+              },
+              "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
+              "fieldName": "download",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "ariaLabel",
+              "type": {
+                "text": "string"
+              },
+              "description": "The aria-label attribute to passed to button element when necessary",
+              "fieldName": "ariaLabel",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            },
+            {
+              "name": "loading",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When true, shows a loading spinner",
+              "fieldName": "loading",
+              "inheritedFrom": {
+                "name": "ButtonElement",
+                "module": "src/base/button-element.ts"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "ButtonElement",
+            "module": "/src/base/button-element"
+          },
+          "summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
+          "tagName": "sgds-button",
+          "customElement": true,
+          "modulePath": "src/components/Button/sgds-button.ts",
+          "cssProperties": [],
+          "cssParts": [],
+          "cssStates": []
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SgdsButton",
+          "declaration": {
+            "name": "SgdsButton",
+            "module": "src/components/Button/sgds-button.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "SgdsButton",
+            "module": "src/components/Button/sgds-button.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "SgdsBreadcrumbItem",
+          "slots": [
+            {
+              "description": "The link of the item. Pass in anchor tags into this slot",
+              "name": "default"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "dependencies",
+              "type": {
+                "text": "Record<string, typeof SgdsElement>"
+              },
+              "static": true,
+              "default": "{\n    \"sgds-link\": SgdsLink,\n    \"sgds-icon\": SgdsIcon\n  }"
+            },
+            {
+              "kind": "field",
+              "name": "active",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
+              "attribute": "active",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "_preventNavigation",
+              "privacy": "private",
+              "type": {}
+            },
+            {
+              "kind": "method",
+              "name": "emit",
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "options",
+                  "optional": true,
+                  "type": {
+                    "text": "CustomEventInit<T>"
+                  }
+                }
+              ],
+              "description": "Emits a custom event with more convenient defaults.",
+              "type": {},
+              "inheritedFrom": {
+                "name": "SgdsElement",
+                "module": "src/base/sgds-element.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "define",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "elementConstructor",
+                  "default": "this"
+                },
+                {
+                  "name": "options",
+                  "default": "{}",
+                  "type": {
+                    "text": "ElementDefinitionOptions"
+                  }
+                }
+              ],
+              "type": {},
+              "inheritedFrom": {
+                "name": "SgdsElement",
+                "module": "src/base/sgds-element.ts"
               }
-            },
+            }
+          ],
+          "attributes": [
             {
               "name": "active",
               "type": {
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Manually set the visual state of the button to `:active`",
-              "fieldName": "active",
-              "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
-              }
-            },
+              "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
+              "fieldName": "active"
+            }
+          ],
+          "superclass": {
+            "name": "SgdsElement",
+            "module": "/src/base/sgds-element"
+          },
+          "summary": "Breadcrumb Item are navigational links used in Breadcrumb component",
+          "tagName": "sgds-breadcrumb-item",
+          "customElement": true,
+          "modulePath": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
+          "cssProperties": [],
+          "cssParts": [],
+          "cssStates": [],
+          "events": []
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SgdsBreadcrumbItem",
+          "declaration": {
+            "name": "SgdsBreadcrumbItem",
+            "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "SgdsBreadcrumbItem",
+            "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/Breadcrumb/sgds-breadcrumb.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "SgdsBreadcrumb",
+          "slots": [
             {
-              "name": "disabled",
+              "description": "The slot to pass in custom elements of `SgdsBreadcrumbItems`.",
+              "name": "default"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "dependencies",
               "type": {
-                "text": "boolean"
+                "text": "object"
               },
-              "default": "false",
-              "description": "The disabled state of the button",
-              "fieldName": "disabled",
-              "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
-              }
+              "static": true,
+              "default": "{\n    \"sgds-overflow-menu\": SgdsOverflowMenu\n  }"
             },
             {
-              "name": "href",
+              "kind": "field",
+              "name": "ariaLabel",
               "type": {
                 "text": "string"
               },
-              "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
-              "fieldName": "href",
-              "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
-              }
+              "default": "\"breadcrumb\"",
+              "description": "The aria-label of nav element within breadcrumb component.",
+              "attribute": "ariaLabel"
             },
             {
-              "name": "target",
-              "type": {
-                "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
-              },
-              "default": "\"_self\"",
-              "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
-              "fieldName": "target",
-              "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
-              }
+              "kind": "method",
+              "name": "_replaceExcessItemsWithDropdown",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "items",
+                  "type": {
+                    "text": "SgdsBreadcrumbItem[]"
+                  }
+                }
+              ],
+              "description": "creates `<sgds-breadcrumb-item>\n           <sgds-overflow-menu>\n             <sgds-dropdown-item></sgds-dropdown-item>\n              ...\n           </sgds-overflow-menu>\n         <sgds-breadcrumb-item>`",
+              "type": {}
             },
             {
-              "name": "download",
-              "type": {
-                "text": "string"
-              },
-              "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
-              "fieldName": "download",
+              "kind": "method",
+              "name": "_handleSlotChange",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ],
+              "type": {}
+            },
+            {
+              "kind": "method",
+              "name": "emit",
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "options",
+                  "optional": true,
+                  "type": {
+                    "text": "CustomEventInit<T>"
+                  }
+                }
+              ],
+              "description": "Emits a custom event with more convenient defaults.",
+              "type": {},
               "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
+                "name": "SgdsElement",
+                "module": "src/base/sgds-element.ts"
               }
             },
             {
-              "name": "ariaLabel",
-              "type": {
-                "text": "string"
-              },
-              "description": "The aria-label attribute to passed to button element when necessary",
-              "fieldName": "ariaLabel",
+              "kind": "method",
+              "name": "define",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "elementConstructor",
+                  "default": "this"
+                },
+                {
+                  "name": "options",
+                  "default": "{}",
+                  "type": {
+                    "text": "ElementDefinitionOptions"
+                  }
+                }
+              ],
+              "type": {},
               "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
+                "name": "SgdsElement",
+                "module": "src/base/sgds-element.ts"
               }
-            },
+            }
+          ],
+          "attributes": [
             {
-              "name": "loading",
+              "name": "ariaLabel",
               "type": {
-                "text": "boolean"
+                "text": "string"
               },
-              "description": "When true, shows a loading spinner",
-              "fieldName": "loading",
-              "inheritedFrom": {
-                "name": "ButtonElement",
-                "module": "src/base/button-element.ts"
-              }
+              "default": "\"breadcrumb\"",
+              "description": "The aria-label of nav element within breadcrumb component.",
+              "fieldName": "ariaLabel"
             }
           ],
           "superclass": {
-            "name": "ButtonElement",
-            "module": "/src/base/button-element"
+            "name": "SgdsElement",
+            "module": "/src/base/sgds-element"
           },
-          "summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
-          "tagName": "sgds-button",
+          "summary": "Breadcrumbs help users to navigate and understand where they are on the current website or service.",
+          "tagName": "sgds-breadcrumb",
           "customElement": true,
-          "modulePath": "src/components/Button/sgds-button.ts",
+          "modulePath": "src/components/Breadcrumb/sgds-breadcrumb.ts",
           "cssProperties": [],
           "cssParts": [],
-          "cssStates": []
+          "cssStates": [],
+          "events": []
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "SgdsButton",
+          "name": "SgdsBreadcrumb",
           "declaration": {
-            "name": "SgdsButton",
-            "module": "src/components/Button/sgds-button.ts"
+            "name": "SgdsBreadcrumb",
+            "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
           }
         },
         {
           "kind": "js",
           "name": "default",
           "declaration": {
-            "name": "SgdsButton",
-            "module": "src/components/Button/sgds-button.ts"
+            "name": "SgdsBreadcrumb",
+            "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
           }
         }
       ]
@@ -16636,12 +16636,28 @@
               "kind": "method",
               "name": "_handleChange",
               "privacy": "private",
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ],
               "type": {}
             },
             {
               "kind": "method",
               "name": "_handleInputChange",
               "privacy": "private",
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ],
               "type": {}
             },
             {
@@ -29497,7 +29513,7 @@
   "package": {
     "name": "@govtechsg/sgds-web-component",
     "description": "",
-    "version": "3.26.1-rc.0",
+    "version": "3.26.1-rc.1",
     "author": "GovTechSG",
     "license": "MIT"
   }