@govtechsg/sgds-web-component 3.23.0-rc.1 → 3.23.0-rc.3

package/custom-elements.json

@@ -2838,6 +2838,17 @@
               "attribute": "required",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the checkbox group.",
+              "attribute": "noValidate",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "value",
@@ -2858,14 +2869,6 @@
               "privacy": "private",
               "default": "false"
             },
-            {
-              "kind": "field",
-              "name": "defaultValue",
-              "type": {
-                "text": "string"
-              },
-              "default": "\"\""
-            },
             {
               "kind": "field",
               "name": "_blurredCheckboxes",
@@ -3156,6 +3159,16 @@
               "description": "Emitted when the value of the CheckboxGroup changes. This happens when checkboxes are checked or unchecked.",
               "name": "sgds-change",
               "reactName": "onSgdsChange"
+            },
+            {
+              "description": "Emitted when the checkbox group's invalid state is set to true.",
+              "name": "sgds-invalid",
+              "reactName": "onSgdsInvalid"
+            },
+            {
+              "description": "Emitted when the checkbox group's invalid state is set to false.",
+              "name": "sgds-valid",
+              "reactName": "onSgdsValid"
             }
           ],
           "attributes": [
@@ -3212,6 +3225,15 @@
               "description": "Makes the checkbox group a required field. Only available for when multiselect is true",
               "fieldName": "required"
             },
+            {
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the checkbox group.",
+              "fieldName": "noValidate"
+            },
             {
               "name": "value",
               "type": {
@@ -3346,33 +3368,35 @@
             },
             {
               "kind": "field",
-              "name": "defaultChecked",
+              "name": "indeterminate",
               "type": {
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Gets or sets the default value used to reset this element. The initial value corresponds to the one originally specified in the HTML that created this element."
+              "description": "Marks the checkbox input as indeterminate , with indeterminate logo",
+              "attribute": "indeterminate",
+              "reflects": true
             },
             {
               "kind": "field",
-              "name": "indeterminate",
+              "name": "required",
               "type": {
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Marks the checkbox input as indeterminate , with indeterminate logo",
-              "attribute": "indeterminate",
+              "description": "Makes the checkbox a required field.",
+              "attribute": "required",
               "reflects": true
             },
             {
               "kind": "field",
-              "name": "required",
+              "name": "noValidate",
               "type": {
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Makes the checkbox a required field.",
-              "attribute": "required",
+              "description": "Disables native and sgds validation for the checkbox.",
+              "attribute": "noValidate",
               "reflects": true
             },
             {
@@ -3729,6 +3753,16 @@
               "description": "Emitted when checkbox is unchecked",
               "name": "sgds-uncheck",
               "reactName": "onSgdsUncheck"
+            },
+            {
+              "description": "Emitted when the checkbox's invalid state is set to true.",
+              "name": "sgds-invalid",
+              "reactName": "onSgdsInvalid"
+            },
+            {
+              "description": "Emitted when the checkbox's invalid state is set to false.",
+              "name": "sgds-valid",
+              "reactName": "onSgdsValid"
             }
           ],
           "attributes": [
@@ -3775,6 +3809,15 @@
               "description": "Makes the checkbox a required field.",
               "fieldName": "required"
             },
+            {
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the checkbox.",
+              "fieldName": "noValidate"
+            },
             {
               "name": "invalidFeedback",
               "type": {
@@ -4332,6 +4375,17 @@
               "attribute": "emptyMenuAsync",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "scrollBottomOffset",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Number of pixels from the bottom of the menu at which the sgds-scroll-end event fires.",
+              "attribute": "scrollBottomOffset",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "filterFunction",
@@ -4388,6 +4442,15 @@
               "privacy": "protected",
               "default": "false"
             },
+            {
+              "kind": "field",
+              "name": "isScrollEnd",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "false"
+            },
             {
               "kind": "method",
               "name": "_handleDefaultSlotChange",
@@ -4555,6 +4618,21 @@
               "description": "For form reset",
               "type": {}
             },
+            {
+              "kind": "method",
+              "name": "_handleScroll",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "MouseEvent"
+                  }
+                }
+              ],
+              "description": "Handles scroll events on the menu. Emits `sgds-scroll-end` once when the\nscroll position reaches within `scrollBottomOffset` pixels of the bottom.\nThe event is suppressed until the user scrolls back up, preventing repeated\nemissions while the menu stays at the bottom.",
+              "type": {}
+            },
             {
               "kind": "field",
               "name": "suffixIconTemplate",
@@ -4894,6 +4972,45 @@
                 "module": "src/base/select-element.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "setValidity",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "flags",
+                  "optional": true,
+                  "type": {
+                    "text": "ValidityStateFlags"
+                  }
+                },
+                {
+                  "name": "message",
+                  "optional": true,
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "anchor",
+                  "optional": true,
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ],
+              "description": "Sets the validity state of the element",
+              "type": {},
+              "inheritedFrom": {
+                "name": "SelectElement",
+                "module": "src/base/select-element.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "checkValidity",
@@ -5431,6 +5548,11 @@
               "name": "sgds-valid",
               "reactName": "onSgdsValid"
             },
+            {
+              "description": "Emitted once when the menu is scrolled to within `scrollBottomOffset` pixels of the bottom. Resets when the user scrolls back up.",
+              "name": "sgds-scroll-end",
+              "reactName": "onSgdsScrollEnd"
+            },
             {
               "description": "Emitted event when show instance is called",
               "name": "sgds-show",
@@ -5523,6 +5645,15 @@
               "description": "When filtering remotely and there are no results, set this to true to enable no options feedback on the menu. Applicable for async combo box only.",
               "fieldName": "emptyMenuAsync"
             },
+            {
+              "name": "scrollBottomOffset",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Number of pixels from the bottom of the menu at which the sgds-scroll-end event fires.",
+              "fieldName": "scrollBottomOffset"
+            },
             {
               "name": "filterFunction",
               "type": {
@@ -7501,10 +7632,9 @@
               "type": {
                 "text": "string"
               },
-              "default": "\"\"",
+              "default": "\"Drawer\"",
               "description": "The accessible label for the drawer dialog. This is required for assistive technology.",
-              "attribute": "ariaLabel",
-              "reflects": true
+              "attribute": "ariaLabel"
             },
             {
               "kind": "field",
@@ -7710,7 +7840,7 @@
               "type": {
                 "text": "string"
               },
-              "default": "\"\"",
+              "default": "\"Drawer\"",
               "description": "The accessible label for the drawer dialog. This is required for assistive technology.",
               "fieldName": "ariaLabel"
             },
@@ -12911,6 +13041,15 @@
               "attribute": "disabled",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "ariaLabel",
+              "type": {
+                "text": "string"
+              },
+              "description": "Accessible label for the dropdown's toggle button. Forwarded to the button's aria-label attribute.",
+              "attribute": "ariaLabel"
+            },
             {
               "kind": "method",
               "name": "_handleSlotChange",
@@ -13095,6 +13234,14 @@
               "default": "false",
               "description": "When true,  applies active styles on the dropdown button",
               "fieldName": "disabled"
+            },
+            {
+              "name": "ariaLabel",
+              "type": {
+                "text": "string"
+              },
+              "description": "Accessible label for the dropdown's toggle button. Forwarded to the button's aria-label attribute.",
+              "fieldName": "ariaLabel"
             }
           ],
           "superclass": {
@@ -15611,6 +15758,17 @@
               "attribute": "required",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the radio group.",
+              "attribute": "noValidate",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "autofocus",
@@ -15945,6 +16103,16 @@
               "name": "sgds-change",
               "detailType": "ISgdsRadioGroupChangeEventDetail",
               "reactName": "onSgdsChange"
+            },
+            {
+              "description": "Emitted when the radio group's invalid state is set to true.",
+              "name": "sgds-invalid",
+              "reactName": "onSgdsInvalid"
+            },
+            {
+              "description": "Emitted when the radio group's invalid state is set to false.",
+              "name": "sgds-valid",
+              "reactName": "onSgdsValid"
             }
           ],
           "attributes": [
@@ -15984,6 +16152,15 @@
               "description": "Makes the input as a required field.",
               "fieldName": "required"
             },
+            {
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the radio group.",
+              "fieldName": "noValidate"
+            },
             {
               "name": "autofocus",
               "type": {
@@ -16571,6 +16748,17 @@
                 "module": "src/base/select-element.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the select.",
+              "attribute": "noValidate",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "options",
@@ -16968,6 +17156,45 @@
                 "module": "src/base/select-element.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "setValidity",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "flags",
+                  "optional": true,
+                  "type": {
+                    "text": "ValidityStateFlags"
+                  }
+                },
+                {
+                  "name": "message",
+                  "optional": true,
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "anchor",
+                  "optional": true,
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ],
+              "description": "Sets the validity state of the element",
+              "type": {},
+              "inheritedFrom": {
+                "name": "SelectElement",
+                "module": "src/base/select-element.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "checkValidity",
@@ -17489,6 +17716,16 @@
               "name": "sgds-blur",
               "reactName": "onSgdsBlur"
             },
+            {
+              "description": "Emitted when the select's invalid state is set to true.",
+              "name": "sgds-invalid",
+              "reactName": "onSgdsInvalid"
+            },
+            {
+              "description": "Emitted when the select's invalid state is set to false.",
+              "name": "sgds-valid",
+              "reactName": "onSgdsValid"
+            },
             {
               "description": "Emitted event when show instance is called",
               "name": "sgds-show",
@@ -17526,14 +17763,16 @@
               }
             }
           ],
-          "superclass": {
-            "name": "SelectElement",
-            "module": "/src/base/select-element"
-          },
-          "summary": "Select is used to make one selection from a list through keyboard or mouse actions",
-          "tagName": "sgds-select",
-          "customElement": true,
           "attributes": [
+            {
+              "name": "noValidate",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables native and sgds validation for the select.",
+              "fieldName": "noValidate"
+            },
             {
               "name": "label",
               "type": {
@@ -17767,6 +18006,13 @@
               }
             }
           ],
+          "superclass": {
+            "name": "SelectElement",
+            "module": "/src/base/select-element"
+          },
+          "summary": "Select is used to make one selection from a list through keyboard or mouse actions",
+          "tagName": "sgds-select",
+          "customElement": true,
           "modulePath": "src/components/Select/sgds-select.ts",
           "cssProperties": [],
           "cssParts": [],
@@ -26937,6 +27183,41 @@
               "description": "Checks for validity. Under the hood, HTMLFormElement's reportValidity method calls this method to check for component's validity state\nNote that the native error popup is prevented for SGDS form components by default. Instead the validation message shows up in the feedback container of SgdsInput",
               "type": {}
             },
+            {
+              "kind": "method",
+              "name": "setValidity",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "flags",
+                  "optional": true,
+                  "type": {
+                    "text": "ValidityStateFlags"
+                  }
+                },
+                {
+                  "name": "message",
+                  "optional": true,
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "anchor",
+                  "optional": true,
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ],
+              "description": "Sets the validity state of the element",
+              "type": {}
+            },
             {
               "kind": "method",
               "name": "checkValidity",
@@ -27670,7 +27951,7 @@
   "package": {
     "name": "@govtechsg/sgds-web-component",
     "description": "",
-    "version": "3.23.0-rc.1",
+    "version": "3.23.0-rc.3",
     "author": "GovTechSG",
     "license": "MIT"
   }