@govtechsg/sgds-web-component 3.23.0-rc.0 → 3.23.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. package/base/card.js +1 -1
  2. package/base/select-element.d.ts +4 -0
  3. package/base/select-element.js +6 -0
  4. package/base/select-element.js.map +1 -1
  5. package/components/Breadcrumb/index.umd.min.js +34 -33
  6. package/components/Breadcrumb/index.umd.min.js.map +1 -1
  7. package/components/Card/index.umd.min.js +1 -1
  8. package/components/Card/index.umd.min.js.map +1 -1
  9. package/components/Checkbox/index.umd.min.js +3 -3
  10. package/components/Checkbox/index.umd.min.js.map +1 -1
  11. package/components/Checkbox/sgds-checkbox-group.d.ts +5 -0
  12. package/components/Checkbox/sgds-checkbox-group.js +10 -0
  13. package/components/Checkbox/sgds-checkbox-group.js.map +1 -1
  14. package/components/Checkbox/sgds-checkbox.d.ts +5 -1
  15. package/components/Checkbox/sgds-checkbox.js +10 -1
  16. package/components/Checkbox/sgds-checkbox.js.map +1 -1
  17. package/components/ComboBox/index.umd.min.js +7 -6
  18. package/components/ComboBox/index.umd.min.js.map +1 -1
  19. package/components/ComboBox/sgds-combo-box.d.ts +11 -0
  20. package/components/ComboBox/sgds-combo-box.js +34 -0
  21. package/components/ComboBox/sgds-combo-box.js.map +1 -1
  22. package/components/Datepicker/index.umd.min.js +1 -1
  23. package/components/Datepicker/index.umd.min.js.map +1 -1
  24. package/components/Drawer/index.umd.min.js +10 -5
  25. package/components/Drawer/index.umd.min.js.map +1 -1
  26. package/components/Drawer/sgds-drawer.js +5 -4
  27. package/components/Drawer/sgds-drawer.js.map +1 -1
  28. package/components/Dropdown/index.umd.min.js +9 -3
  29. package/components/Dropdown/index.umd.min.js.map +1 -1
  30. package/components/Dropdown/sgds-dropdown-item.d.ts +2 -0
  31. package/components/Dropdown/sgds-dropdown-item.js +7 -0
  32. package/components/Dropdown/sgds-dropdown-item.js.map +1 -1
  33. package/components/FileUpload/index.umd.min.js +1 -1
  34. package/components/FileUpload/index.umd.min.js.map +1 -1
  35. package/components/IconCard/index.umd.min.js +1 -1
  36. package/components/IconCard/index.umd.min.js.map +1 -1
  37. package/components/ImageCard/index.umd.min.js +1 -1
  38. package/components/ImageCard/index.umd.min.js.map +1 -1
  39. package/components/Input/index.umd.min.js +1 -1
  40. package/components/Input/index.umd.min.js.map +1 -1
  41. package/components/Mainnav/index.umd.min.js +6 -3
  42. package/components/Mainnav/index.umd.min.js.map +1 -1
  43. package/components/Mainnav/sgds-mainnav-dropdown.d.ts +4 -0
  44. package/components/Mainnav/sgds-mainnav-dropdown.js +6 -0
  45. package/components/Mainnav/sgds-mainnav-dropdown.js.map +1 -1
  46. package/components/OverflowMenu/index.umd.min.js +9 -3
  47. package/components/OverflowMenu/index.umd.min.js.map +1 -1
  48. package/components/QuantityToggle/index.umd.min.js +1 -1
  49. package/components/QuantityToggle/index.umd.min.js.map +1 -1
  50. package/components/Radio/index.umd.min.js +2 -2
  51. package/components/Radio/index.umd.min.js.map +1 -1
  52. package/components/Radio/sgds-radio-group.d.ts +4 -0
  53. package/components/Radio/sgds-radio-group.js +9 -0
  54. package/components/Radio/sgds-radio-group.js.map +1 -1
  55. package/components/Select/index.umd.min.js +3 -3
  56. package/components/Select/index.umd.min.js.map +1 -1
  57. package/components/Select/sgds-select.d.ts +4 -0
  58. package/components/Select/sgds-select.js +10 -1
  59. package/components/Select/sgds-select.js.map +1 -1
  60. package/components/Textarea/index.umd.min.js +1 -1
  61. package/components/Textarea/index.umd.min.js.map +1 -1
  62. package/components/ThumbnailCard/index.umd.min.js +1 -1
  63. package/components/ThumbnailCard/index.umd.min.js.map +1 -1
  64. package/components/index.umd.min.js +81 -77
  65. package/components/index.umd.min.js.map +1 -1
  66. package/css/fouc.css +1 -1
  67. package/custom-elements.json +965 -665
  68. package/index.umd.min.js +84 -80
  69. package/index.umd.min.js.map +1 -1
  70. package/package.json +1 -1
  71. package/react/base/card.cjs.js +1 -1
  72. package/react/base/card.js +1 -1
  73. package/react/base/select-element.cjs.js +6 -0
  74. package/react/base/select-element.cjs.js.map +1 -1
  75. package/react/base/select-element.js +6 -0
  76. package/react/base/select-element.js.map +1 -1
  77. package/react/checkbox/index.cjs.js +3 -1
  78. package/react/checkbox/index.cjs.js.map +1 -1
  79. package/react/checkbox/index.js +3 -1
  80. package/react/checkbox/index.js.map +1 -1
  81. package/react/checkbox-group/index.cjs.js +3 -1
  82. package/react/checkbox-group/index.cjs.js.map +1 -1
  83. package/react/checkbox-group/index.js +3 -1
  84. package/react/checkbox-group/index.js.map +1 -1
  85. package/react/combo-box/index.cjs.js +1 -0
  86. package/react/combo-box/index.cjs.js.map +1 -1
  87. package/react/combo-box/index.js +1 -0
  88. package/react/combo-box/index.js.map +1 -1
  89. package/react/components/Checkbox/sgds-checkbox-group.cjs.js +10 -0
  90. package/react/components/Checkbox/sgds-checkbox-group.cjs.js.map +1 -1
  91. package/react/components/Checkbox/sgds-checkbox-group.js +10 -0
  92. package/react/components/Checkbox/sgds-checkbox-group.js.map +1 -1
  93. package/react/components/Checkbox/sgds-checkbox.cjs.js +10 -1
  94. package/react/components/Checkbox/sgds-checkbox.cjs.js.map +1 -1
  95. package/react/components/Checkbox/sgds-checkbox.js +10 -1
  96. package/react/components/Checkbox/sgds-checkbox.js.map +1 -1
  97. package/react/components/ComboBox/sgds-combo-box.cjs.js +34 -0
  98. package/react/components/ComboBox/sgds-combo-box.cjs.js.map +1 -1
  99. package/react/components/ComboBox/sgds-combo-box.js +34 -0
  100. package/react/components/ComboBox/sgds-combo-box.js.map +1 -1
  101. package/react/components/Drawer/sgds-drawer.cjs.js +4 -3
  102. package/react/components/Drawer/sgds-drawer.cjs.js.map +1 -1
  103. package/react/components/Drawer/sgds-drawer.js +5 -4
  104. package/react/components/Drawer/sgds-drawer.js.map +1 -1
  105. package/react/components/Dropdown/sgds-dropdown-item.cjs.js +7 -0
  106. package/react/components/Dropdown/sgds-dropdown-item.cjs.js.map +1 -1
  107. package/react/components/Dropdown/sgds-dropdown-item.js +7 -0
  108. package/react/components/Dropdown/sgds-dropdown-item.js.map +1 -1
  109. package/react/components/Mainnav/sgds-mainnav-dropdown.cjs.js +6 -0
  110. package/react/components/Mainnav/sgds-mainnav-dropdown.cjs.js.map +1 -1
  111. package/react/components/Mainnav/sgds-mainnav-dropdown.js +6 -0
  112. package/react/components/Mainnav/sgds-mainnav-dropdown.js.map +1 -1
  113. package/react/components/Radio/sgds-radio-group.cjs.js +9 -0
  114. package/react/components/Radio/sgds-radio-group.cjs.js.map +1 -1
  115. package/react/components/Radio/sgds-radio-group.js +9 -0
  116. package/react/components/Radio/sgds-radio-group.js.map +1 -1
  117. package/react/components/Select/sgds-select.cjs.js +9 -0
  118. package/react/components/Select/sgds-select.cjs.js.map +1 -1
  119. package/react/components/Select/sgds-select.js +10 -1
  120. package/react/components/Select/sgds-select.js.map +1 -1
  121. package/react/index.cjs.js +4 -4
  122. package/react/index.d.ts +1 -1
  123. package/react/index.js +1 -1
  124. package/react/radio-group/index.cjs.js +3 -1
  125. package/react/radio-group/index.cjs.js.map +1 -1
  126. package/react/radio-group/index.js +3 -1
  127. package/react/radio-group/index.js.map +1 -1
  128. package/react/select/index.cjs.js +2 -0
  129. package/react/select/index.cjs.js.map +1 -1
  130. package/react/select/index.js +2 -0
  131. package/react/select/index.js.map +1 -1
  132. package/react/utils/validatorMixin.cjs.js +9 -11
  133. package/react/utils/validatorMixin.cjs.js.map +1 -1
  134. package/react/utils/validatorMixin.js +9 -11
  135. package/react/utils/validatorMixin.js.map +1 -1
  136. package/types/react.d.ts +60 -31
  137. package/utils/validatorMixin.js +9 -11
  138. package/utils/validatorMixin.js.map +1 -1
@@ -939,106 +939,65 @@
939
939
  },
940
940
  {
941
941
  "kind": "javascript-module",
942
- "path": "src/components/Button/sgds-button.ts",
942
+ "path": "src/components/Badge/sgds-badge.ts",
943
943
  "declarations": [
944
944
  {
945
945
  "kind": "class",
946
946
  "description": "",
947
- "name": "SgdsButton",
947
+ "name": "SgdsBadge",
948
948
  "slots": [
949
949
  {
950
- "description": "The button's label.",
950
+ "description": "slot for badge",
951
951
  "name": "default"
952
952
  },
953
953
  {
954
- "description": "The slot for icon to the left of the button text",
955
- "name": "leftIcon"
956
- },
957
- {
958
- "description": "The slot for icon to the right of the button text",
959
- "name": "rightIcon"
954
+ "description": "The slot for icon to the left of the badge text",
955
+ "name": "icon"
960
956
  }
961
957
  ],
962
958
  "members": [
963
959
  {
964
960
  "kind": "field",
965
- "name": "name",
966
- "type": {
967
- "text": "string"
968
- },
969
- "description": "The name of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
970
- "attribute": "name",
971
- "reflects": true
972
- },
973
- {
974
- "kind": "field",
975
- "name": "value",
976
- "type": {
977
- "text": "string"
978
- },
979
- "description": "The value of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
980
- "attribute": "value",
981
- "reflects": true
982
- },
983
- {
984
- "kind": "field",
985
- "name": "type",
986
- "type": {
987
- "text": "\"button\" | \"submit\" | \"reset\""
988
- },
989
- "default": "\"button\"",
990
- "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server",
991
- "attribute": "type",
992
- "reflects": true
993
- },
994
- {
995
- "kind": "field",
996
- "name": "form",
997
- "type": {
998
- "text": "string"
999
- },
1000
- "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1001
- "attribute": "form",
1002
- "reflects": true
1003
- },
1004
- {
1005
- "kind": "field",
1006
- "name": "formAction",
961
+ "name": "show",
1007
962
  "type": {
1008
- "text": "string"
963
+ "text": "boolean"
1009
964
  },
1010
- "description": "Used to override the form owner's `action` attribute.",
1011
- "attribute": "formaction",
965
+ "default": "false",
966
+ "description": "Controls the appearance of the dismissible badge. This prop only applies when dismissible is true",
967
+ "attribute": "show",
1012
968
  "reflects": true
1013
969
  },
1014
970
  {
1015
971
  "kind": "field",
1016
- "name": "formMethod",
972
+ "name": "variant",
1017
973
  "type": {
1018
- "text": "\"post\" | \"get\""
974
+ "text": "\"primary\" | \"accent\" | \"success\" | \"danger\" | \"warning\" | \"cyan\" | \"purple\" | \"neutral\" | \"white\" | \"info\""
1019
975
  },
1020
- "description": "Used to override the form owner's `method` attribute.",
1021
- "attribute": "formmethod",
976
+ "default": "\"primary\"",
977
+ "description": "One or more badge variant combinations.\nVariants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.\n\n(@deprecated) The `info` variant is deprecated. Use `primary` instead.",
978
+ "attribute": "variant",
1022
979
  "reflects": true
1023
980
  },
1024
981
  {
1025
982
  "kind": "field",
1026
- "name": "formNoValidate",
983
+ "name": "outlined",
1027
984
  "type": {
1028
985
  "text": "boolean"
1029
986
  },
1030
- "description": "Used to override the form owner's `novalidate` attribute.",
1031
- "attribute": "formnovalidate",
987
+ "default": "false",
988
+ "description": "Manually set the outlined state to false",
989
+ "attribute": "outlined",
1032
990
  "reflects": true
1033
991
  },
1034
992
  {
1035
993
  "kind": "field",
1036
- "name": "formTarget",
994
+ "name": "dismissible",
1037
995
  "type": {
1038
- "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
996
+ "text": "boolean"
1039
997
  },
1040
- "description": "Used to override the form owner's `target` attribute.",
1041
- "attribute": "formtarget",
998
+ "default": "false",
999
+ "description": "Manually set the dismissible state of the button to `false`",
1000
+ "attribute": "dismissible",
1042
1001
  "reflects": true
1043
1002
  },
1044
1003
  {
@@ -1048,769 +1007,647 @@
1048
1007
  "text": "boolean"
1049
1008
  },
1050
1009
  "default": "false",
1051
- "description": "When set, the button will be in full width.",
1010
+ "description": "Manually enable full width",
1052
1011
  "attribute": "fullWidth",
1053
1012
  "reflects": true
1054
1013
  },
1055
1014
  {
1056
1015
  "kind": "field",
1057
- "name": "hasLeftIconSlot",
1016
+ "name": "truncated",
1058
1017
  "type": {
1059
1018
  "text": "boolean"
1060
1019
  },
1061
- "default": "false",
1062
- "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
1063
- "attribute": "hasLeftIconSlot"
1020
+ "privacy": "private",
1021
+ "default": "false"
1064
1022
  },
1065
1023
  {
1066
1024
  "kind": "field",
1067
- "name": "hasRightIconSlot",
1025
+ "name": "text",
1068
1026
  "type": {
1069
- "text": "boolean"
1027
+ "text": "string"
1070
1028
  },
1071
- "default": "false",
1072
- "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
1073
- "attribute": "hasRightIconSlot"
1029
+ "privacy": "private",
1030
+ "default": "\"\""
1074
1031
  },
1075
1032
  {
1076
- "kind": "field",
1077
- "name": "hasSlotController",
1078
- "privacy": "private",
1079
- "default": "new HasSlotController(this, \"leftIcon\", \"rightIcon\")",
1033
+ "kind": "method",
1034
+ "name": "close",
1035
+ "privacy": "public",
1036
+ "description": "Closes the badge",
1080
1037
  "type": {}
1081
1038
  },
1082
1039
  {
1083
1040
  "kind": "method",
1084
- "name": "_handleClick",
1085
- "privacy": "protected",
1041
+ "name": "_handleLabelSlotChange",
1042
+ "privacy": "private",
1086
1043
  "parameters": [
1087
1044
  {
1088
- "name": "event",
1045
+ "name": "e",
1089
1046
  "type": {
1090
- "text": "MouseEvent"
1047
+ "text": "Event"
1091
1048
  }
1092
1049
  }
1093
1050
  ],
1094
- "type": {},
1095
- "inheritedFrom": {
1096
- "name": "ButtonElement",
1097
- "module": "src/base/button-element.ts"
1098
- }
1051
+ "type": {}
1099
1052
  },
1100
1053
  {
1101
- "kind": "field",
1102
- "name": "_clickHandler",
1054
+ "kind": "method",
1055
+ "name": "_renderBadge",
1103
1056
  "privacy": "private",
1104
1057
  "type": {}
1105
1058
  },
1106
1059
  {
1107
- "kind": "field",
1108
- "name": "variant",
1109
- "type": {
1110
- "text": "\"primary\" | \"outline\" | \"ghost\" | \"danger\""
1111
- },
1112
- "default": "\"primary\"",
1113
- "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant=\"primary\"` with `tone=\"danger\"` instead.",
1114
- "attribute": "variant",
1115
- "reflects": true,
1060
+ "kind": "method",
1061
+ "name": "emit",
1062
+ "parameters": [
1063
+ {
1064
+ "name": "name",
1065
+ "type": {
1066
+ "text": "string"
1067
+ }
1068
+ },
1069
+ {
1070
+ "name": "options",
1071
+ "optional": true,
1072
+ "type": {
1073
+ "text": "CustomEventInit<T>"
1074
+ }
1075
+ }
1076
+ ],
1077
+ "description": "Emits a custom event with more convenient defaults.",
1078
+ "type": {},
1116
1079
  "inheritedFrom": {
1117
- "name": "ButtonElement",
1118
- "module": "src/base/button-element.ts"
1080
+ "name": "SgdsElement",
1081
+ "module": "src/base/sgds-element.ts"
1119
1082
  }
1120
1083
  },
1121
1084
  {
1122
- "kind": "field",
1123
- "name": "tone",
1124
- "type": {
1125
- "text": "\"brand\" | \"danger\" | \"fixed-light\" | \"neutral\""
1126
- },
1127
- "default": "\"brand\"",
1128
- "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
1129
- "attribute": "tone",
1130
- "reflects": true,
1085
+ "kind": "method",
1086
+ "name": "define",
1087
+ "static": true,
1088
+ "parameters": [
1089
+ {
1090
+ "name": "name",
1091
+ "type": {
1092
+ "text": "string"
1093
+ }
1094
+ },
1095
+ {
1096
+ "name": "elementConstructor",
1097
+ "default": "this"
1098
+ },
1099
+ {
1100
+ "name": "options",
1101
+ "default": "{}",
1102
+ "type": {
1103
+ "text": "ElementDefinitionOptions"
1104
+ }
1105
+ }
1106
+ ],
1107
+ "type": {},
1131
1108
  "inheritedFrom": {
1132
- "name": "ButtonElement",
1133
- "module": "src/base/button-element.ts"
1109
+ "name": "SgdsElement",
1110
+ "module": "src/base/sgds-element.ts"
1134
1111
  }
1112
+ }
1113
+ ],
1114
+ "events": [
1115
+ {
1116
+ "description": "Emitted when the badge appears.",
1117
+ "name": "sgds-show",
1118
+ "reactName": "onSgdsShow"
1135
1119
  },
1136
1120
  {
1137
- "kind": "field",
1138
- "name": "size",
1139
- "type": {
1140
- "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1141
- },
1142
- "default": "\"md\"",
1143
- "description": "Specifies a small, medium or large button, the size is medium by default.",
1144
- "attribute": "size",
1145
- "reflects": true,
1146
- "inheritedFrom": {
1147
- "name": "ButtonElement",
1148
- "module": "src/base/button-element.ts"
1149
- }
1121
+ "description": "Emitted when the badge is starting to close but has not closed.",
1122
+ "name": "sgds-hide",
1123
+ "reactName": "onSgdsHide"
1150
1124
  },
1151
1125
  {
1152
- "kind": "field",
1153
- "name": "active",
1126
+ "description": "Emitted after the badge has appeared",
1127
+ "name": "sgds-after-show",
1128
+ "reactName": "onSgdsAfterShow"
1129
+ },
1130
+ {
1131
+ "description": "Emitted after the badge has closed",
1132
+ "name": "sgds-after-hide",
1133
+ "reactName": "onSgdsAfterHide"
1134
+ }
1135
+ ],
1136
+ "attributes": [
1137
+ {
1138
+ "name": "show",
1154
1139
  "type": {
1155
1140
  "text": "boolean"
1156
1141
  },
1157
1142
  "default": "false",
1158
- "description": "Manually set the visual state of the button to `:active`",
1159
- "attribute": "active",
1160
- "reflects": true,
1161
- "inheritedFrom": {
1162
- "name": "ButtonElement",
1163
- "module": "src/base/button-element.ts"
1164
- }
1143
+ "description": "Controls the appearance of the dismissible badge. This prop only applies when dismissible is true",
1144
+ "fieldName": "show"
1165
1145
  },
1166
1146
  {
1167
- "kind": "field",
1168
- "name": "disabled",
1147
+ "name": "variant",
1169
1148
  "type": {
1170
- "text": "boolean"
1149
+ "text": "BadgeVariant"
1171
1150
  },
1172
- "default": "false",
1173
- "description": "The disabled state of the button",
1174
- "attribute": "disabled",
1175
- "reflects": true,
1176
- "inheritedFrom": {
1177
- "name": "ButtonElement",
1178
- "module": "src/base/button-element.ts"
1179
- }
1180
- },
1181
- {
1182
- "kind": "field",
1183
- "name": "href",
1184
- "type": {
1185
- "text": "string"
1186
- },
1187
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1188
- "attribute": "href",
1189
- "reflects": true,
1190
- "inheritedFrom": {
1191
- "name": "ButtonElement",
1192
- "module": "src/base/button-element.ts"
1193
- }
1194
- },
1195
- {
1196
- "kind": "field",
1197
- "name": "target",
1198
- "type": {
1199
- "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1200
- },
1201
- "default": "\"_self\"",
1202
- "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1203
- "attribute": "target",
1204
- "reflects": true,
1205
- "inheritedFrom": {
1206
- "name": "ButtonElement",
1207
- "module": "src/base/button-element.ts"
1208
- }
1151
+ "default": "\"primary\"",
1152
+ "description": "One or more badge variant combinations.\nVariants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.\n\n(@deprecated) The `info` variant is deprecated. Use `primary` instead.",
1153
+ "fieldName": "variant"
1209
1154
  },
1210
1155
  {
1211
- "kind": "field",
1212
- "name": "download",
1156
+ "name": "outlined",
1213
1157
  "type": {
1214
- "text": "string"
1158
+ "text": "boolean"
1215
1159
  },
1216
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1217
- "attribute": "download",
1218
- "reflects": true,
1219
- "inheritedFrom": {
1220
- "name": "ButtonElement",
1221
- "module": "src/base/button-element.ts"
1222
- }
1160
+ "default": "false",
1161
+ "description": "Manually set the outlined state to false",
1162
+ "fieldName": "outlined"
1223
1163
  },
1224
1164
  {
1225
- "kind": "field",
1226
- "name": "ariaLabel",
1165
+ "name": "dismissible",
1227
1166
  "type": {
1228
- "text": "string"
1167
+ "text": "boolean"
1229
1168
  },
1230
- "description": "The aria-label attribute to passed to button element when necessary",
1231
- "attribute": "ariaLabel",
1232
- "inheritedFrom": {
1233
- "name": "ButtonElement",
1234
- "module": "src/base/button-element.ts"
1235
- }
1169
+ "default": "false",
1170
+ "description": "Manually set the dismissible state of the button to `false`",
1171
+ "fieldName": "dismissible"
1236
1172
  },
1237
1173
  {
1238
- "kind": "field",
1239
- "name": "loading",
1174
+ "name": "fullWidth",
1240
1175
  "type": {
1241
1176
  "text": "boolean"
1242
1177
  },
1243
- "description": "When true, shows a loading spinner",
1244
- "attribute": "loading",
1245
- "inheritedFrom": {
1246
- "name": "ButtonElement",
1247
- "module": "src/base/button-element.ts"
1248
- }
1249
- },
1250
- {
1251
- "kind": "method",
1252
- "name": "focus",
1253
- "privacy": "public",
1254
- "parameters": [
1255
- {
1256
- "name": "options",
1257
- "optional": true,
1258
- "type": {
1259
- "text": "FocusOptions"
1260
- }
1261
- }
1262
- ],
1263
- "description": "Sets focus on the button.",
1264
- "type": {},
1265
- "inheritedFrom": {
1266
- "name": "ButtonElement",
1267
- "module": "src/base/button-element.ts"
1268
- }
1269
- },
1270
- {
1271
- "kind": "method",
1272
- "name": "click",
1273
- "privacy": "public",
1274
- "description": "Simulates a click on the button.",
1275
- "type": {},
1276
- "inheritedFrom": {
1277
- "name": "ButtonElement",
1278
- "module": "src/base/button-element.ts"
1279
- }
1280
- },
1281
- {
1282
- "kind": "method",
1283
- "name": "blur",
1284
- "privacy": "public",
1285
- "description": "Removes focus from the button.",
1286
- "type": {},
1287
- "inheritedFrom": {
1288
- "name": "ButtonElement",
1289
- "module": "src/base/button-element.ts"
1290
- }
1291
- },
1292
- {
1293
- "kind": "method",
1294
- "name": "_handleBlur",
1295
- "privacy": "protected",
1296
- "type": {},
1297
- "inheritedFrom": {
1298
- "name": "ButtonElement",
1299
- "module": "src/base/button-element.ts"
1300
- }
1301
- },
1302
- {
1303
- "kind": "method",
1304
- "name": "_handleFocus",
1305
- "privacy": "protected",
1306
- "type": {},
1307
- "inheritedFrom": {
1308
- "name": "ButtonElement",
1309
- "module": "src/base/button-element.ts"
1310
- }
1311
- },
1312
- {
1313
- "kind": "method",
1314
- "name": "_handleKeydown",
1315
- "privacy": "protected",
1316
- "parameters": [
1317
- {
1318
- "name": "event",
1319
- "type": {
1320
- "text": "KeyboardEvent"
1321
- }
1322
- }
1323
- ],
1324
- "type": {},
1325
- "inheritedFrom": {
1326
- "name": "ButtonElement",
1327
- "module": "src/base/button-element.ts"
1328
- }
1329
- },
1330
- {
1331
- "kind": "method",
1332
- "name": "_assignSpinnerSize",
1333
- "privacy": "protected",
1334
- "parameters": [
1335
- {
1336
- "name": "buttonSize",
1337
- "type": {
1338
- "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1339
- }
1340
- }
1341
- ],
1342
- "type": {},
1343
- "inheritedFrom": {
1344
- "name": "ButtonElement",
1345
- "module": "src/base/button-element.ts"
1346
- }
1347
- },
1348
- {
1349
- "kind": "method",
1350
- "name": "_assignSpinnerTone",
1351
- "privacy": "protected",
1352
- "return": {
1353
- "type": {
1354
- "text": "SpinnerTone"
1355
- }
1356
- },
1357
- "parameters": [
1358
- {
1359
- "name": "buttonTone",
1360
- "type": {
1361
- "text": "ButtonTone"
1362
- }
1363
- },
1364
- {
1365
- "name": "buttonVariant",
1366
- "type": {
1367
- "text": "ButtonVariant"
1368
- }
1369
- }
1370
- ],
1371
- "type": {},
1372
- "inheritedFrom": {
1373
- "name": "ButtonElement",
1374
- "module": "src/base/button-element.ts"
1375
- }
1376
- },
1377
- {
1378
- "kind": "method",
1379
- "name": "emit",
1380
- "parameters": [
1381
- {
1382
- "name": "name",
1383
- "type": {
1384
- "text": "string"
1385
- }
1386
- },
1387
- {
1388
- "name": "options",
1389
- "optional": true,
1390
- "type": {
1391
- "text": "CustomEventInit<T>"
1392
- }
1393
- }
1394
- ],
1395
- "description": "Emits a custom event with more convenient defaults.",
1396
- "type": {},
1397
- "inheritedFrom": {
1398
- "name": "SgdsElement",
1399
- "module": "src/base/sgds-element.ts"
1400
- }
1401
- },
1402
- {
1403
- "kind": "method",
1404
- "name": "define",
1405
- "static": true,
1406
- "parameters": [
1407
- {
1408
- "name": "name",
1409
- "type": {
1410
- "text": "string"
1411
- }
1412
- },
1413
- {
1414
- "name": "elementConstructor",
1415
- "default": "this"
1416
- },
1417
- {
1418
- "name": "options",
1419
- "default": "{}",
1420
- "type": {
1421
- "text": "ElementDefinitionOptions"
1422
- }
1423
- }
1424
- ],
1425
- "type": {},
1426
- "inheritedFrom": {
1427
- "name": "SgdsElement",
1428
- "module": "src/base/sgds-element.ts"
1429
- }
1178
+ "default": "false",
1179
+ "description": "Manually enable full width",
1180
+ "fieldName": "fullWidth"
1430
1181
  }
1431
1182
  ],
1432
- "events": [
1183
+ "superclass": {
1184
+ "name": "SgdsElement",
1185
+ "module": "/src/base/sgds-element"
1186
+ },
1187
+ "summary": "Badges can be used to highlight important bits of information such as labels, notifications & status.\nWhen the text exceeds the width, it will be truncated with a tooltip that will be displayed on hover.",
1188
+ "tagName": "sgds-badge",
1189
+ "customElement": true,
1190
+ "modulePath": "src/components/Badge/sgds-badge.ts",
1191
+ "cssProperties": [],
1192
+ "cssParts": [],
1193
+ "cssStates": []
1194
+ }
1195
+ ],
1196
+ "exports": [
1197
+ {
1198
+ "kind": "js",
1199
+ "name": "SgdsBadge",
1200
+ "declaration": {
1201
+ "name": "SgdsBadge",
1202
+ "module": "src/components/Badge/sgds-badge.ts"
1203
+ }
1204
+ },
1205
+ {
1206
+ "kind": "js",
1207
+ "name": "default",
1208
+ "declaration": {
1209
+ "name": "SgdsBadge",
1210
+ "module": "src/components/Badge/sgds-badge.ts"
1211
+ }
1212
+ }
1213
+ ]
1214
+ },
1215
+ {
1216
+ "kind": "javascript-module",
1217
+ "path": "src/components/Button/sgds-button.ts",
1218
+ "declarations": [
1219
+ {
1220
+ "kind": "class",
1221
+ "description": "",
1222
+ "name": "SgdsButton",
1223
+ "slots": [
1433
1224
  {
1434
- "description": "Emitted when the button is blurred.",
1435
- "name": "sgds-blur",
1436
- "reactName": "onSgdsBlur"
1225
+ "description": "The button's label.",
1226
+ "name": "default"
1227
+ },
1228
+ {
1229
+ "description": "The slot for icon to the left of the button text",
1230
+ "name": "leftIcon"
1437
1231
  },
1438
1232
  {
1439
- "description": "Emitted when the button is focused.",
1440
- "name": "sgds-focus",
1441
- "reactName": "onSgdsFocus"
1233
+ "description": "The slot for icon to the right of the button text",
1234
+ "name": "rightIcon"
1442
1235
  }
1443
1236
  ],
1444
- "attributes": [
1237
+ "members": [
1445
1238
  {
1239
+ "kind": "field",
1446
1240
  "name": "name",
1447
1241
  "type": {
1448
1242
  "text": "string"
1449
1243
  },
1450
1244
  "description": "The name of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1451
- "fieldName": "name"
1245
+ "attribute": "name",
1246
+ "reflects": true
1452
1247
  },
1453
1248
  {
1249
+ "kind": "field",
1454
1250
  "name": "value",
1455
1251
  "type": {
1456
1252
  "text": "string"
1457
1253
  },
1458
1254
  "description": "The value of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1459
- "fieldName": "value"
1255
+ "attribute": "value",
1256
+ "reflects": true
1460
1257
  },
1461
1258
  {
1259
+ "kind": "field",
1462
1260
  "name": "type",
1463
1261
  "type": {
1464
1262
  "text": "\"button\" | \"submit\" | \"reset\""
1465
1263
  },
1466
1264
  "default": "\"button\"",
1467
1265
  "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server",
1468
- "fieldName": "type"
1266
+ "attribute": "type",
1267
+ "reflects": true
1469
1268
  },
1470
1269
  {
1270
+ "kind": "field",
1471
1271
  "name": "form",
1472
1272
  "type": {
1473
1273
  "text": "string"
1474
1274
  },
1475
1275
  "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1476
- "fieldName": "form"
1276
+ "attribute": "form",
1277
+ "reflects": true
1477
1278
  },
1478
1279
  {
1479
- "name": "formaction",
1280
+ "kind": "field",
1281
+ "name": "formAction",
1480
1282
  "type": {
1481
1283
  "text": "string"
1482
1284
  },
1483
1285
  "description": "Used to override the form owner's `action` attribute.",
1484
- "fieldName": "formAction"
1286
+ "attribute": "formaction",
1287
+ "reflects": true
1485
1288
  },
1486
1289
  {
1487
- "name": "formmethod",
1290
+ "kind": "field",
1291
+ "name": "formMethod",
1488
1292
  "type": {
1489
1293
  "text": "\"post\" | \"get\""
1490
1294
  },
1491
1295
  "description": "Used to override the form owner's `method` attribute.",
1492
- "fieldName": "formMethod"
1296
+ "attribute": "formmethod",
1297
+ "reflects": true
1493
1298
  },
1494
1299
  {
1495
- "name": "formnovalidate",
1300
+ "kind": "field",
1301
+ "name": "formNoValidate",
1496
1302
  "type": {
1497
1303
  "text": "boolean"
1498
1304
  },
1499
1305
  "description": "Used to override the form owner's `novalidate` attribute.",
1500
- "fieldName": "formNoValidate"
1306
+ "attribute": "formnovalidate",
1307
+ "reflects": true
1501
1308
  },
1502
1309
  {
1503
- "name": "formtarget",
1310
+ "kind": "field",
1311
+ "name": "formTarget",
1504
1312
  "type": {
1505
1313
  "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
1506
1314
  },
1507
1315
  "description": "Used to override the form owner's `target` attribute.",
1508
- "fieldName": "formTarget"
1316
+ "attribute": "formtarget",
1317
+ "reflects": true
1509
1318
  },
1510
1319
  {
1320
+ "kind": "field",
1511
1321
  "name": "fullWidth",
1512
1322
  "type": {
1513
1323
  "text": "boolean"
1514
1324
  },
1515
1325
  "default": "false",
1516
1326
  "description": "When set, the button will be in full width.",
1517
- "fieldName": "fullWidth"
1327
+ "attribute": "fullWidth",
1328
+ "reflects": true
1518
1329
  },
1519
1330
  {
1331
+ "kind": "field",
1520
1332
  "name": "hasLeftIconSlot",
1521
1333
  "type": {
1522
1334
  "text": "boolean"
1523
1335
  },
1524
1336
  "default": "false",
1525
1337
  "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
1526
- "fieldName": "hasLeftIconSlot"
1338
+ "attribute": "hasLeftIconSlot"
1527
1339
  },
1528
1340
  {
1341
+ "kind": "field",
1529
1342
  "name": "hasRightIconSlot",
1530
1343
  "type": {
1531
1344
  "text": "boolean"
1532
1345
  },
1533
1346
  "default": "false",
1534
1347
  "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
1535
- "fieldName": "hasRightIconSlot"
1348
+ "attribute": "hasRightIconSlot"
1349
+ },
1350
+ {
1351
+ "kind": "field",
1352
+ "name": "hasSlotController",
1353
+ "privacy": "private",
1354
+ "default": "new HasSlotController(this, \"leftIcon\", \"rightIcon\")",
1355
+ "type": {}
1536
1356
  },
1537
1357
  {
1358
+ "kind": "method",
1359
+ "name": "_handleClick",
1360
+ "privacy": "protected",
1361
+ "parameters": [
1362
+ {
1363
+ "name": "event",
1364
+ "type": {
1365
+ "text": "MouseEvent"
1366
+ }
1367
+ }
1368
+ ],
1369
+ "type": {},
1370
+ "inheritedFrom": {
1371
+ "name": "ButtonElement",
1372
+ "module": "src/base/button-element.ts"
1373
+ }
1374
+ },
1375
+ {
1376
+ "kind": "field",
1377
+ "name": "_clickHandler",
1378
+ "privacy": "private",
1379
+ "type": {}
1380
+ },
1381
+ {
1382
+ "kind": "field",
1538
1383
  "name": "variant",
1539
1384
  "type": {
1540
- "text": "ButtonVariant"
1385
+ "text": "\"primary\" | \"outline\" | \"ghost\" | \"danger\""
1541
1386
  },
1542
1387
  "default": "\"primary\"",
1543
1388
  "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant=\"primary\"` with `tone=\"danger\"` instead.",
1544
- "fieldName": "variant",
1389
+ "attribute": "variant",
1390
+ "reflects": true,
1545
1391
  "inheritedFrom": {
1546
1392
  "name": "ButtonElement",
1547
1393
  "module": "src/base/button-element.ts"
1548
1394
  }
1549
1395
  },
1550
1396
  {
1397
+ "kind": "field",
1551
1398
  "name": "tone",
1552
1399
  "type": {
1553
- "text": "ButtonTone"
1400
+ "text": "\"brand\" | \"danger\" | \"fixed-light\" | \"neutral\""
1554
1401
  },
1555
1402
  "default": "\"brand\"",
1556
1403
  "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
1557
- "fieldName": "tone",
1404
+ "attribute": "tone",
1405
+ "reflects": true,
1558
1406
  "inheritedFrom": {
1559
1407
  "name": "ButtonElement",
1560
1408
  "module": "src/base/button-element.ts"
1561
1409
  }
1562
1410
  },
1563
1411
  {
1412
+ "kind": "field",
1564
1413
  "name": "size",
1565
1414
  "type": {
1566
1415
  "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1567
1416
  },
1568
1417
  "default": "\"md\"",
1569
1418
  "description": "Specifies a small, medium or large button, the size is medium by default.",
1570
- "fieldName": "size",
1419
+ "attribute": "size",
1420
+ "reflects": true,
1571
1421
  "inheritedFrom": {
1572
1422
  "name": "ButtonElement",
1573
1423
  "module": "src/base/button-element.ts"
1574
1424
  }
1575
1425
  },
1576
1426
  {
1427
+ "kind": "field",
1577
1428
  "name": "active",
1578
1429
  "type": {
1579
1430
  "text": "boolean"
1580
1431
  },
1581
1432
  "default": "false",
1582
1433
  "description": "Manually set the visual state of the button to `:active`",
1583
- "fieldName": "active",
1584
- "inheritedFrom": {
1585
- "name": "ButtonElement",
1586
- "module": "src/base/button-element.ts"
1587
- }
1588
- },
1589
- {
1590
- "name": "disabled",
1591
- "type": {
1592
- "text": "boolean"
1593
- },
1594
- "default": "false",
1595
- "description": "The disabled state of the button",
1596
- "fieldName": "disabled",
1597
- "inheritedFrom": {
1598
- "name": "ButtonElement",
1599
- "module": "src/base/button-element.ts"
1600
- }
1601
- },
1602
- {
1603
- "name": "href",
1604
- "type": {
1605
- "text": "string"
1606
- },
1607
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1608
- "fieldName": "href",
1609
- "inheritedFrom": {
1610
- "name": "ButtonElement",
1611
- "module": "src/base/button-element.ts"
1612
- }
1613
- },
1614
- {
1615
- "name": "target",
1616
- "type": {
1617
- "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1618
- },
1619
- "default": "\"_self\"",
1620
- "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1621
- "fieldName": "target",
1622
- "inheritedFrom": {
1623
- "name": "ButtonElement",
1624
- "module": "src/base/button-element.ts"
1625
- }
1626
- },
1627
- {
1628
- "name": "download",
1629
- "type": {
1630
- "text": "string"
1631
- },
1632
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1633
- "fieldName": "download",
1634
- "inheritedFrom": {
1635
- "name": "ButtonElement",
1636
- "module": "src/base/button-element.ts"
1637
- }
1638
- },
1639
- {
1640
- "name": "ariaLabel",
1641
- "type": {
1642
- "text": "string"
1643
- },
1644
- "description": "The aria-label attribute to passed to button element when necessary",
1645
- "fieldName": "ariaLabel",
1646
- "inheritedFrom": {
1647
- "name": "ButtonElement",
1648
- "module": "src/base/button-element.ts"
1649
- }
1650
- },
1651
- {
1652
- "name": "loading",
1653
- "type": {
1654
- "text": "boolean"
1655
- },
1656
- "description": "When true, shows a loading spinner",
1657
- "fieldName": "loading",
1434
+ "attribute": "active",
1435
+ "reflects": true,
1658
1436
  "inheritedFrom": {
1659
1437
  "name": "ButtonElement",
1660
1438
  "module": "src/base/button-element.ts"
1661
1439
  }
1662
- }
1663
- ],
1664
- "superclass": {
1665
- "name": "ButtonElement",
1666
- "module": "/src/base/button-element"
1667
- },
1668
- "summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
1669
- "tagName": "sgds-button",
1670
- "customElement": true,
1671
- "modulePath": "src/components/Button/sgds-button.ts",
1672
- "cssProperties": [],
1673
- "cssParts": [],
1674
- "cssStates": []
1675
- }
1676
- ],
1677
- "exports": [
1678
- {
1679
- "kind": "js",
1680
- "name": "SgdsButton",
1681
- "declaration": {
1682
- "name": "SgdsButton",
1683
- "module": "src/components/Button/sgds-button.ts"
1684
- }
1685
- },
1686
- {
1687
- "kind": "js",
1688
- "name": "default",
1689
- "declaration": {
1690
- "name": "SgdsButton",
1691
- "module": "src/components/Button/sgds-button.ts"
1692
- }
1693
- }
1694
- ]
1695
- },
1696
- {
1697
- "kind": "javascript-module",
1698
- "path": "src/components/Badge/sgds-badge.ts",
1699
- "declarations": [
1700
- {
1701
- "kind": "class",
1702
- "description": "",
1703
- "name": "SgdsBadge",
1704
- "slots": [
1705
- {
1706
- "description": "slot for badge",
1707
- "name": "default"
1708
- },
1709
- {
1710
- "description": "The slot for icon to the left of the badge text",
1711
- "name": "icon"
1712
- }
1713
- ],
1714
- "members": [
1715
- {
1716
- "kind": "field",
1717
- "name": "show",
1718
- "type": {
1719
- "text": "boolean"
1720
- },
1721
- "default": "false",
1722
- "description": "Controls the appearance of the dismissible badge. This prop only applies when dismissible is true",
1723
- "attribute": "show",
1724
- "reflects": true
1725
- },
1726
- {
1727
- "kind": "field",
1728
- "name": "variant",
1729
- "type": {
1730
- "text": "\"primary\" | \"accent\" | \"success\" | \"danger\" | \"warning\" | \"cyan\" | \"purple\" | \"neutral\" | \"white\" | \"info\""
1731
- },
1732
- "default": "\"primary\"",
1733
- "description": "One or more badge variant combinations.\nVariants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.\n\n(@deprecated) The `info` variant is deprecated. Use `primary` instead.",
1734
- "attribute": "variant",
1735
- "reflects": true
1736
1440
  },
1737
1441
  {
1738
1442
  "kind": "field",
1739
- "name": "outlined",
1443
+ "name": "disabled",
1740
1444
  "type": {
1741
1445
  "text": "boolean"
1742
1446
  },
1743
1447
  "default": "false",
1744
- "description": "Manually set the outlined state to false",
1745
- "attribute": "outlined",
1746
- "reflects": true
1448
+ "description": "The disabled state of the button",
1449
+ "attribute": "disabled",
1450
+ "reflects": true,
1451
+ "inheritedFrom": {
1452
+ "name": "ButtonElement",
1453
+ "module": "src/base/button-element.ts"
1454
+ }
1747
1455
  },
1748
1456
  {
1749
1457
  "kind": "field",
1750
- "name": "dismissible",
1458
+ "name": "href",
1751
1459
  "type": {
1752
- "text": "boolean"
1460
+ "text": "string"
1753
1461
  },
1754
- "default": "false",
1755
- "description": "Manually set the dismissible state of the button to `false`",
1756
- "attribute": "dismissible",
1757
- "reflects": true
1462
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1463
+ "attribute": "href",
1464
+ "reflects": true,
1465
+ "inheritedFrom": {
1466
+ "name": "ButtonElement",
1467
+ "module": "src/base/button-element.ts"
1468
+ }
1758
1469
  },
1759
1470
  {
1760
1471
  "kind": "field",
1761
- "name": "fullWidth",
1472
+ "name": "target",
1762
1473
  "type": {
1763
- "text": "boolean"
1474
+ "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1764
1475
  },
1765
- "default": "false",
1766
- "description": "Manually enable full width",
1767
- "attribute": "fullWidth",
1768
- "reflects": true
1476
+ "default": "\"_self\"",
1477
+ "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1478
+ "attribute": "target",
1479
+ "reflects": true,
1480
+ "inheritedFrom": {
1481
+ "name": "ButtonElement",
1482
+ "module": "src/base/button-element.ts"
1483
+ }
1769
1484
  },
1770
1485
  {
1771
1486
  "kind": "field",
1772
- "name": "truncated",
1487
+ "name": "download",
1773
1488
  "type": {
1774
- "text": "boolean"
1489
+ "text": "string"
1775
1490
  },
1776
- "privacy": "private",
1777
- "default": "false"
1491
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1492
+ "attribute": "download",
1493
+ "reflects": true,
1494
+ "inheritedFrom": {
1495
+ "name": "ButtonElement",
1496
+ "module": "src/base/button-element.ts"
1497
+ }
1778
1498
  },
1779
1499
  {
1780
1500
  "kind": "field",
1781
- "name": "text",
1501
+ "name": "ariaLabel",
1782
1502
  "type": {
1783
1503
  "text": "string"
1784
1504
  },
1785
- "privacy": "private",
1786
- "default": "\"\""
1505
+ "description": "The aria-label attribute to passed to button element when necessary",
1506
+ "attribute": "ariaLabel",
1507
+ "inheritedFrom": {
1508
+ "name": "ButtonElement",
1509
+ "module": "src/base/button-element.ts"
1510
+ }
1511
+ },
1512
+ {
1513
+ "kind": "field",
1514
+ "name": "loading",
1515
+ "type": {
1516
+ "text": "boolean"
1517
+ },
1518
+ "description": "When true, shows a loading spinner",
1519
+ "attribute": "loading",
1520
+ "inheritedFrom": {
1521
+ "name": "ButtonElement",
1522
+ "module": "src/base/button-element.ts"
1523
+ }
1787
1524
  },
1788
1525
  {
1789
1526
  "kind": "method",
1790
- "name": "close",
1527
+ "name": "focus",
1791
1528
  "privacy": "public",
1792
- "description": "Closes the badge",
1793
- "type": {}
1529
+ "parameters": [
1530
+ {
1531
+ "name": "options",
1532
+ "optional": true,
1533
+ "type": {
1534
+ "text": "FocusOptions"
1535
+ }
1536
+ }
1537
+ ],
1538
+ "description": "Sets focus on the button.",
1539
+ "type": {},
1540
+ "inheritedFrom": {
1541
+ "name": "ButtonElement",
1542
+ "module": "src/base/button-element.ts"
1543
+ }
1794
1544
  },
1795
1545
  {
1796
1546
  "kind": "method",
1797
- "name": "_handleLabelSlotChange",
1798
- "privacy": "private",
1547
+ "name": "click",
1548
+ "privacy": "public",
1549
+ "description": "Simulates a click on the button.",
1550
+ "type": {},
1551
+ "inheritedFrom": {
1552
+ "name": "ButtonElement",
1553
+ "module": "src/base/button-element.ts"
1554
+ }
1555
+ },
1556
+ {
1557
+ "kind": "method",
1558
+ "name": "blur",
1559
+ "privacy": "public",
1560
+ "description": "Removes focus from the button.",
1561
+ "type": {},
1562
+ "inheritedFrom": {
1563
+ "name": "ButtonElement",
1564
+ "module": "src/base/button-element.ts"
1565
+ }
1566
+ },
1567
+ {
1568
+ "kind": "method",
1569
+ "name": "_handleBlur",
1570
+ "privacy": "protected",
1571
+ "type": {},
1572
+ "inheritedFrom": {
1573
+ "name": "ButtonElement",
1574
+ "module": "src/base/button-element.ts"
1575
+ }
1576
+ },
1577
+ {
1578
+ "kind": "method",
1579
+ "name": "_handleFocus",
1580
+ "privacy": "protected",
1581
+ "type": {},
1582
+ "inheritedFrom": {
1583
+ "name": "ButtonElement",
1584
+ "module": "src/base/button-element.ts"
1585
+ }
1586
+ },
1587
+ {
1588
+ "kind": "method",
1589
+ "name": "_handleKeydown",
1590
+ "privacy": "protected",
1799
1591
  "parameters": [
1800
1592
  {
1801
- "name": "e",
1593
+ "name": "event",
1802
1594
  "type": {
1803
- "text": "Event"
1595
+ "text": "KeyboardEvent"
1804
1596
  }
1805
1597
  }
1806
1598
  ],
1807
- "type": {}
1599
+ "type": {},
1600
+ "inheritedFrom": {
1601
+ "name": "ButtonElement",
1602
+ "module": "src/base/button-element.ts"
1603
+ }
1808
1604
  },
1809
1605
  {
1810
1606
  "kind": "method",
1811
- "name": "_renderBadge",
1812
- "privacy": "private",
1813
- "type": {}
1607
+ "name": "_assignSpinnerSize",
1608
+ "privacy": "protected",
1609
+ "parameters": [
1610
+ {
1611
+ "name": "buttonSize",
1612
+ "type": {
1613
+ "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1614
+ }
1615
+ }
1616
+ ],
1617
+ "type": {},
1618
+ "inheritedFrom": {
1619
+ "name": "ButtonElement",
1620
+ "module": "src/base/button-element.ts"
1621
+ }
1622
+ },
1623
+ {
1624
+ "kind": "method",
1625
+ "name": "_assignSpinnerTone",
1626
+ "privacy": "protected",
1627
+ "return": {
1628
+ "type": {
1629
+ "text": "SpinnerTone"
1630
+ }
1631
+ },
1632
+ "parameters": [
1633
+ {
1634
+ "name": "buttonTone",
1635
+ "type": {
1636
+ "text": "ButtonTone"
1637
+ }
1638
+ },
1639
+ {
1640
+ "name": "buttonVariant",
1641
+ "type": {
1642
+ "text": "ButtonVariant"
1643
+ }
1644
+ }
1645
+ ],
1646
+ "type": {},
1647
+ "inheritedFrom": {
1648
+ "name": "ButtonElement",
1649
+ "module": "src/base/button-element.ts"
1650
+ }
1814
1651
  },
1815
1652
  {
1816
1653
  "kind": "method",
@@ -1869,81 +1706,244 @@
1869
1706
  ],
1870
1707
  "events": [
1871
1708
  {
1872
- "description": "Emitted when the badge appears.",
1873
- "name": "sgds-show",
1874
- "reactName": "onSgdsShow"
1709
+ "description": "Emitted when the button is blurred.",
1710
+ "name": "sgds-blur",
1711
+ "reactName": "onSgdsBlur"
1712
+ },
1713
+ {
1714
+ "description": "Emitted when the button is focused.",
1715
+ "name": "sgds-focus",
1716
+ "reactName": "onSgdsFocus"
1717
+ }
1718
+ ],
1719
+ "attributes": [
1720
+ {
1721
+ "name": "name",
1722
+ "type": {
1723
+ "text": "string"
1724
+ },
1725
+ "description": "The name of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1726
+ "fieldName": "name"
1727
+ },
1728
+ {
1729
+ "name": "value",
1730
+ "type": {
1731
+ "text": "string"
1732
+ },
1733
+ "description": "The value of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1734
+ "fieldName": "value"
1735
+ },
1736
+ {
1737
+ "name": "type",
1738
+ "type": {
1739
+ "text": "\"button\" | \"submit\" | \"reset\""
1740
+ },
1741
+ "default": "\"button\"",
1742
+ "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server",
1743
+ "fieldName": "type"
1744
+ },
1745
+ {
1746
+ "name": "form",
1747
+ "type": {
1748
+ "text": "string"
1749
+ },
1750
+ "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1751
+ "fieldName": "form"
1752
+ },
1753
+ {
1754
+ "name": "formaction",
1755
+ "type": {
1756
+ "text": "string"
1757
+ },
1758
+ "description": "Used to override the form owner's `action` attribute.",
1759
+ "fieldName": "formAction"
1760
+ },
1761
+ {
1762
+ "name": "formmethod",
1763
+ "type": {
1764
+ "text": "\"post\" | \"get\""
1765
+ },
1766
+ "description": "Used to override the form owner's `method` attribute.",
1767
+ "fieldName": "formMethod"
1768
+ },
1769
+ {
1770
+ "name": "formnovalidate",
1771
+ "type": {
1772
+ "text": "boolean"
1773
+ },
1774
+ "description": "Used to override the form owner's `novalidate` attribute.",
1775
+ "fieldName": "formNoValidate"
1875
1776
  },
1876
1777
  {
1877
- "description": "Emitted when the badge is starting to close but has not closed.",
1878
- "name": "sgds-hide",
1879
- "reactName": "onSgdsHide"
1778
+ "name": "formtarget",
1779
+ "type": {
1780
+ "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
1781
+ },
1782
+ "description": "Used to override the form owner's `target` attribute.",
1783
+ "fieldName": "formTarget"
1880
1784
  },
1881
1785
  {
1882
- "description": "Emitted after the badge has appeared",
1883
- "name": "sgds-after-show",
1884
- "reactName": "onSgdsAfterShow"
1786
+ "name": "fullWidth",
1787
+ "type": {
1788
+ "text": "boolean"
1789
+ },
1790
+ "default": "false",
1791
+ "description": "When set, the button will be in full width.",
1792
+ "fieldName": "fullWidth"
1885
1793
  },
1886
1794
  {
1887
- "description": "Emitted after the badge has closed",
1888
- "name": "sgds-after-hide",
1889
- "reactName": "onSgdsAfterHide"
1890
- }
1891
- ],
1892
- "attributes": [
1795
+ "name": "hasLeftIconSlot",
1796
+ "type": {
1797
+ "text": "boolean"
1798
+ },
1799
+ "default": "false",
1800
+ "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
1801
+ "fieldName": "hasLeftIconSlot"
1802
+ },
1893
1803
  {
1894
- "name": "show",
1804
+ "name": "hasRightIconSlot",
1895
1805
  "type": {
1896
1806
  "text": "boolean"
1897
1807
  },
1898
1808
  "default": "false",
1899
- "description": "Controls the appearance of the dismissible badge. This prop only applies when dismissible is true",
1900
- "fieldName": "show"
1809
+ "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
1810
+ "fieldName": "hasRightIconSlot"
1901
1811
  },
1902
1812
  {
1903
1813
  "name": "variant",
1904
1814
  "type": {
1905
- "text": "BadgeVariant"
1815
+ "text": "ButtonVariant"
1906
1816
  },
1907
1817
  "default": "\"primary\"",
1908
- "description": "One or more badge variant combinations.\nVariants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.\n\n(@deprecated) The `info` variant is deprecated. Use `primary` instead.",
1909
- "fieldName": "variant"
1818
+ "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 use `variant=\"primary\"` with `tone=\"danger\"` instead.",
1819
+ "fieldName": "variant",
1820
+ "inheritedFrom": {
1821
+ "name": "ButtonElement",
1822
+ "module": "src/base/button-element.ts"
1823
+ }
1910
1824
  },
1911
1825
  {
1912
- "name": "outlined",
1826
+ "name": "tone",
1827
+ "type": {
1828
+ "text": "ButtonTone"
1829
+ },
1830
+ "default": "\"brand\"",
1831
+ "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
1832
+ "fieldName": "tone",
1833
+ "inheritedFrom": {
1834
+ "name": "ButtonElement",
1835
+ "module": "src/base/button-element.ts"
1836
+ }
1837
+ },
1838
+ {
1839
+ "name": "size",
1840
+ "type": {
1841
+ "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1842
+ },
1843
+ "default": "\"md\"",
1844
+ "description": "Specifies a small, medium or large button, the size is medium by default.",
1845
+ "fieldName": "size",
1846
+ "inheritedFrom": {
1847
+ "name": "ButtonElement",
1848
+ "module": "src/base/button-element.ts"
1849
+ }
1850
+ },
1851
+ {
1852
+ "name": "active",
1913
1853
  "type": {
1914
1854
  "text": "boolean"
1915
1855
  },
1916
1856
  "default": "false",
1917
- "description": "Manually set the outlined state to false",
1918
- "fieldName": "outlined"
1857
+ "description": "Manually set the visual state of the button to `:active`",
1858
+ "fieldName": "active",
1859
+ "inheritedFrom": {
1860
+ "name": "ButtonElement",
1861
+ "module": "src/base/button-element.ts"
1862
+ }
1919
1863
  },
1920
1864
  {
1921
- "name": "dismissible",
1865
+ "name": "disabled",
1922
1866
  "type": {
1923
1867
  "text": "boolean"
1924
1868
  },
1925
1869
  "default": "false",
1926
- "description": "Manually set the dismissible state of the button to `false`",
1927
- "fieldName": "dismissible"
1870
+ "description": "The disabled state of the button",
1871
+ "fieldName": "disabled",
1872
+ "inheritedFrom": {
1873
+ "name": "ButtonElement",
1874
+ "module": "src/base/button-element.ts"
1875
+ }
1928
1876
  },
1929
1877
  {
1930
- "name": "fullWidth",
1878
+ "name": "href",
1879
+ "type": {
1880
+ "text": "string"
1881
+ },
1882
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1883
+ "fieldName": "href",
1884
+ "inheritedFrom": {
1885
+ "name": "ButtonElement",
1886
+ "module": "src/base/button-element.ts"
1887
+ }
1888
+ },
1889
+ {
1890
+ "name": "target",
1891
+ "type": {
1892
+ "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1893
+ },
1894
+ "default": "\"_self\"",
1895
+ "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1896
+ "fieldName": "target",
1897
+ "inheritedFrom": {
1898
+ "name": "ButtonElement",
1899
+ "module": "src/base/button-element.ts"
1900
+ }
1901
+ },
1902
+ {
1903
+ "name": "download",
1904
+ "type": {
1905
+ "text": "string"
1906
+ },
1907
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1908
+ "fieldName": "download",
1909
+ "inheritedFrom": {
1910
+ "name": "ButtonElement",
1911
+ "module": "src/base/button-element.ts"
1912
+ }
1913
+ },
1914
+ {
1915
+ "name": "ariaLabel",
1916
+ "type": {
1917
+ "text": "string"
1918
+ },
1919
+ "description": "The aria-label attribute to passed to button element when necessary",
1920
+ "fieldName": "ariaLabel",
1921
+ "inheritedFrom": {
1922
+ "name": "ButtonElement",
1923
+ "module": "src/base/button-element.ts"
1924
+ }
1925
+ },
1926
+ {
1927
+ "name": "loading",
1931
1928
  "type": {
1932
1929
  "text": "boolean"
1933
1930
  },
1934
- "default": "false",
1935
- "description": "Manually enable full width",
1936
- "fieldName": "fullWidth"
1931
+ "description": "When true, shows a loading spinner",
1932
+ "fieldName": "loading",
1933
+ "inheritedFrom": {
1934
+ "name": "ButtonElement",
1935
+ "module": "src/base/button-element.ts"
1936
+ }
1937
1937
  }
1938
1938
  ],
1939
1939
  "superclass": {
1940
- "name": "SgdsElement",
1941
- "module": "/src/base/sgds-element"
1940
+ "name": "ButtonElement",
1941
+ "module": "/src/base/button-element"
1942
1942
  },
1943
- "summary": "Badges can be used to highlight important bits of information such as labels, notifications & status.\nWhen the text exceeds the width, it will be truncated with a tooltip that will be displayed on hover.",
1944
- "tagName": "sgds-badge",
1943
+ "summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
1944
+ "tagName": "sgds-button",
1945
1945
  "customElement": true,
1946
- "modulePath": "src/components/Badge/sgds-badge.ts",
1946
+ "modulePath": "src/components/Button/sgds-button.ts",
1947
1947
  "cssProperties": [],
1948
1948
  "cssParts": [],
1949
1949
  "cssStates": []
@@ -1952,18 +1952,18 @@
1952
1952
  "exports": [
1953
1953
  {
1954
1954
  "kind": "js",
1955
- "name": "SgdsBadge",
1955
+ "name": "SgdsButton",
1956
1956
  "declaration": {
1957
- "name": "SgdsBadge",
1958
- "module": "src/components/Badge/sgds-badge.ts"
1957
+ "name": "SgdsButton",
1958
+ "module": "src/components/Button/sgds-button.ts"
1959
1959
  }
1960
1960
  },
1961
1961
  {
1962
1962
  "kind": "js",
1963
1963
  "name": "default",
1964
1964
  "declaration": {
1965
- "name": "SgdsBadge",
1966
- "module": "src/components/Badge/sgds-badge.ts"
1965
+ "name": "SgdsButton",
1966
+ "module": "src/components/Button/sgds-button.ts"
1967
1967
  }
1968
1968
  }
1969
1969
  ]
@@ -2838,6 +2838,17 @@
2838
2838
  "attribute": "required",
2839
2839
  "reflects": true
2840
2840
  },
2841
+ {
2842
+ "kind": "field",
2843
+ "name": "noValidate",
2844
+ "type": {
2845
+ "text": "boolean"
2846
+ },
2847
+ "default": "false",
2848
+ "description": "Disables native and sgds validation for the checkbox group.",
2849
+ "attribute": "noValidate",
2850
+ "reflects": true
2851
+ },
2841
2852
  {
2842
2853
  "kind": "field",
2843
2854
  "name": "value",
@@ -2858,14 +2869,6 @@
2858
2869
  "privacy": "private",
2859
2870
  "default": "false"
2860
2871
  },
2861
- {
2862
- "kind": "field",
2863
- "name": "defaultValue",
2864
- "type": {
2865
- "text": "string"
2866
- },
2867
- "default": "\"\""
2868
- },
2869
2872
  {
2870
2873
  "kind": "field",
2871
2874
  "name": "_blurredCheckboxes",
@@ -3156,6 +3159,16 @@
3156
3159
  "description": "Emitted when the value of the CheckboxGroup changes. This happens when checkboxes are checked or unchecked.",
3157
3160
  "name": "sgds-change",
3158
3161
  "reactName": "onSgdsChange"
3162
+ },
3163
+ {
3164
+ "description": "Emitted when the checkbox group's invalid state is set to true.",
3165
+ "name": "sgds-invalid",
3166
+ "reactName": "onSgdsInvalid"
3167
+ },
3168
+ {
3169
+ "description": "Emitted when the checkbox group's invalid state is set to false.",
3170
+ "name": "sgds-valid",
3171
+ "reactName": "onSgdsValid"
3159
3172
  }
3160
3173
  ],
3161
3174
  "attributes": [
@@ -3212,6 +3225,15 @@
3212
3225
  "description": "Makes the checkbox group a required field. Only available for when multiselect is true",
3213
3226
  "fieldName": "required"
3214
3227
  },
3228
+ {
3229
+ "name": "noValidate",
3230
+ "type": {
3231
+ "text": "boolean"
3232
+ },
3233
+ "default": "false",
3234
+ "description": "Disables native and sgds validation for the checkbox group.",
3235
+ "fieldName": "noValidate"
3236
+ },
3215
3237
  {
3216
3238
  "name": "value",
3217
3239
  "type": {
@@ -3346,33 +3368,35 @@
3346
3368
  },
3347
3369
  {
3348
3370
  "kind": "field",
3349
- "name": "defaultChecked",
3371
+ "name": "indeterminate",
3350
3372
  "type": {
3351
3373
  "text": "boolean"
3352
3374
  },
3353
3375
  "default": "false",
3354
- "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."
3376
+ "description": "Marks the checkbox input as indeterminate , with indeterminate logo",
3377
+ "attribute": "indeterminate",
3378
+ "reflects": true
3355
3379
  },
3356
3380
  {
3357
3381
  "kind": "field",
3358
- "name": "indeterminate",
3382
+ "name": "required",
3359
3383
  "type": {
3360
3384
  "text": "boolean"
3361
3385
  },
3362
3386
  "default": "false",
3363
- "description": "Marks the checkbox input as indeterminate , with indeterminate logo",
3364
- "attribute": "indeterminate",
3387
+ "description": "Makes the checkbox a required field.",
3388
+ "attribute": "required",
3365
3389
  "reflects": true
3366
3390
  },
3367
3391
  {
3368
3392
  "kind": "field",
3369
- "name": "required",
3393
+ "name": "noValidate",
3370
3394
  "type": {
3371
3395
  "text": "boolean"
3372
3396
  },
3373
3397
  "default": "false",
3374
- "description": "Makes the checkbox a required field.",
3375
- "attribute": "required",
3398
+ "description": "Disables native and sgds validation for the checkbox.",
3399
+ "attribute": "noValidate",
3376
3400
  "reflects": true
3377
3401
  },
3378
3402
  {
@@ -3729,6 +3753,16 @@
3729
3753
  "description": "Emitted when checkbox is unchecked",
3730
3754
  "name": "sgds-uncheck",
3731
3755
  "reactName": "onSgdsUncheck"
3756
+ },
3757
+ {
3758
+ "description": "Emitted when the checkbox's invalid state is set to true.",
3759
+ "name": "sgds-invalid",
3760
+ "reactName": "onSgdsInvalid"
3761
+ },
3762
+ {
3763
+ "description": "Emitted when the checkbox's invalid state is set to false.",
3764
+ "name": "sgds-valid",
3765
+ "reactName": "onSgdsValid"
3732
3766
  }
3733
3767
  ],
3734
3768
  "attributes": [
@@ -3767,13 +3801,22 @@
3767
3801
  "fieldName": "indeterminate"
3768
3802
  },
3769
3803
  {
3770
- "name": "required",
3804
+ "name": "required",
3805
+ "type": {
3806
+ "text": "boolean"
3807
+ },
3808
+ "default": "false",
3809
+ "description": "Makes the checkbox a required field.",
3810
+ "fieldName": "required"
3811
+ },
3812
+ {
3813
+ "name": "noValidate",
3771
3814
  "type": {
3772
3815
  "text": "boolean"
3773
3816
  },
3774
3817
  "default": "false",
3775
- "description": "Makes the checkbox a required field.",
3776
- "fieldName": "required"
3818
+ "description": "Disables native and sgds validation for the checkbox.",
3819
+ "fieldName": "noValidate"
3777
3820
  },
3778
3821
  {
3779
3822
  "name": "invalidFeedback",
@@ -4332,6 +4375,17 @@
4332
4375
  "attribute": "emptyMenuAsync",
4333
4376
  "reflects": true
4334
4377
  },
4378
+ {
4379
+ "kind": "field",
4380
+ "name": "scrollBottomOffset",
4381
+ "type": {
4382
+ "text": "number"
4383
+ },
4384
+ "default": "0",
4385
+ "description": "Number of pixels from the bottom of the menu at which the sgds-scroll-end event fires.",
4386
+ "attribute": "scrollBottomOffset",
4387
+ "reflects": true
4388
+ },
4335
4389
  {
4336
4390
  "kind": "field",
4337
4391
  "name": "filterFunction",
@@ -4388,6 +4442,15 @@
4388
4442
  "privacy": "protected",
4389
4443
  "default": "false"
4390
4444
  },
4445
+ {
4446
+ "kind": "field",
4447
+ "name": "isScrollEnd",
4448
+ "type": {
4449
+ "text": "boolean"
4450
+ },
4451
+ "privacy": "protected",
4452
+ "default": "false"
4453
+ },
4391
4454
  {
4392
4455
  "kind": "method",
4393
4456
  "name": "_handleDefaultSlotChange",
@@ -4555,6 +4618,21 @@
4555
4618
  "description": "For form reset",
4556
4619
  "type": {}
4557
4620
  },
4621
+ {
4622
+ "kind": "method",
4623
+ "name": "_handleScroll",
4624
+ "privacy": "private",
4625
+ "parameters": [
4626
+ {
4627
+ "name": "e",
4628
+ "type": {
4629
+ "text": "MouseEvent"
4630
+ }
4631
+ }
4632
+ ],
4633
+ "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.",
4634
+ "type": {}
4635
+ },
4558
4636
  {
4559
4637
  "kind": "field",
4560
4638
  "name": "suffixIconTemplate",
@@ -4894,6 +4972,45 @@
4894
4972
  "module": "src/base/select-element.ts"
4895
4973
  }
4896
4974
  },
4975
+ {
4976
+ "kind": "method",
4977
+ "name": "setValidity",
4978
+ "privacy": "public",
4979
+ "return": {
4980
+ "type": {
4981
+ "text": "void"
4982
+ }
4983
+ },
4984
+ "parameters": [
4985
+ {
4986
+ "name": "flags",
4987
+ "optional": true,
4988
+ "type": {
4989
+ "text": "ValidityStateFlags"
4990
+ }
4991
+ },
4992
+ {
4993
+ "name": "message",
4994
+ "optional": true,
4995
+ "type": {
4996
+ "text": "string"
4997
+ }
4998
+ },
4999
+ {
5000
+ "name": "anchor",
5001
+ "optional": true,
5002
+ "type": {
5003
+ "text": "HTMLElement"
5004
+ }
5005
+ }
5006
+ ],
5007
+ "description": "Sets the validity state of the element",
5008
+ "type": {},
5009
+ "inheritedFrom": {
5010
+ "name": "SelectElement",
5011
+ "module": "src/base/select-element.ts"
5012
+ }
5013
+ },
4897
5014
  {
4898
5015
  "kind": "method",
4899
5016
  "name": "checkValidity",
@@ -5431,6 +5548,11 @@
5431
5548
  "name": "sgds-valid",
5432
5549
  "reactName": "onSgdsValid"
5433
5550
  },
5551
+ {
5552
+ "description": "Emitted once when the menu is scrolled to within `scrollBottomOffset` pixels of the bottom. Resets when the user scrolls back up.",
5553
+ "name": "sgds-scroll-end",
5554
+ "reactName": "onSgdsScrollEnd"
5555
+ },
5434
5556
  {
5435
5557
  "description": "Emitted event when show instance is called",
5436
5558
  "name": "sgds-show",
@@ -5523,6 +5645,15 @@
5523
5645
  "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.",
5524
5646
  "fieldName": "emptyMenuAsync"
5525
5647
  },
5648
+ {
5649
+ "name": "scrollBottomOffset",
5650
+ "type": {
5651
+ "text": "number"
5652
+ },
5653
+ "default": "0",
5654
+ "description": "Number of pixels from the bottom of the menu at which the sgds-scroll-end event fires.",
5655
+ "fieldName": "scrollBottomOffset"
5656
+ },
5526
5657
  {
5527
5658
  "name": "filterFunction",
5528
5659
  "type": {
@@ -7501,10 +7632,9 @@
7501
7632
  "type": {
7502
7633
  "text": "string"
7503
7634
  },
7504
- "default": "\"\"",
7635
+ "default": "\"Drawer\"",
7505
7636
  "description": "The accessible label for the drawer dialog. This is required for assistive technology.",
7506
- "attribute": "ariaLabel",
7507
- "reflects": true
7637
+ "attribute": "ariaLabel"
7508
7638
  },
7509
7639
  {
7510
7640
  "kind": "field",
@@ -7710,7 +7840,7 @@
7710
7840
  "type": {
7711
7841
  "text": "string"
7712
7842
  },
7713
- "default": "\"\"",
7843
+ "default": "\"Drawer\"",
7714
7844
  "description": "The accessible label for the drawer dialog. This is required for assistive technology.",
7715
7845
  "fieldName": "ariaLabel"
7716
7846
  },
@@ -7801,6 +7931,16 @@
7801
7931
  "attribute": "disabled",
7802
7932
  "reflects": true
7803
7933
  },
7934
+ {
7935
+ "kind": "field",
7936
+ "name": "ariaLabel",
7937
+ "type": {
7938
+ "text": "string"
7939
+ },
7940
+ "default": "\"\"",
7941
+ "description": "Forwards aria-label to the inner clickable element for accessibility",
7942
+ "attribute": "ariaLabel"
7943
+ },
7804
7944
  {
7805
7945
  "kind": "method",
7806
7946
  "name": "emit",
@@ -7874,6 +8014,15 @@
7874
8014
  "default": "false",
7875
8015
  "description": "Disables the SgdsMainnavItem",
7876
8016
  "fieldName": "disabled"
8017
+ },
8018
+ {
8019
+ "name": "ariaLabel",
8020
+ "type": {
8021
+ "text": "string"
8022
+ },
8023
+ "default": "\"\"",
8024
+ "description": "Forwards aria-label to the inner clickable element for accessibility",
8025
+ "fieldName": "ariaLabel"
7877
8026
  }
7878
8027
  ],
7879
8028
  "superclass": {
@@ -12892,6 +13041,15 @@
12892
13041
  "attribute": "disabled",
12893
13042
  "reflects": true
12894
13043
  },
13044
+ {
13045
+ "kind": "field",
13046
+ "name": "ariaLabel",
13047
+ "type": {
13048
+ "text": "string"
13049
+ },
13050
+ "description": "Accessible label for the dropdown's toggle button. Forwarded to the button's aria-label attribute.",
13051
+ "attribute": "ariaLabel"
13052
+ },
12895
13053
  {
12896
13054
  "kind": "method",
12897
13055
  "name": "_handleSlotChange",
@@ -13076,6 +13234,14 @@
13076
13234
  "default": "false",
13077
13235
  "description": "When true, applies active styles on the dropdown button",
13078
13236
  "fieldName": "disabled"
13237
+ },
13238
+ {
13239
+ "name": "ariaLabel",
13240
+ "type": {
13241
+ "text": "string"
13242
+ },
13243
+ "description": "Accessible label for the dropdown's toggle button. Forwarded to the button's aria-label attribute.",
13244
+ "fieldName": "ariaLabel"
13079
13245
  }
13080
13246
  ],
13081
13247
  "superclass": {
@@ -15592,6 +15758,17 @@
15592
15758
  "attribute": "required",
15593
15759
  "reflects": true
15594
15760
  },
15761
+ {
15762
+ "kind": "field",
15763
+ "name": "noValidate",
15764
+ "type": {
15765
+ "text": "boolean"
15766
+ },
15767
+ "default": "false",
15768
+ "description": "Disables native and sgds validation for the radio group.",
15769
+ "attribute": "noValidate",
15770
+ "reflects": true
15771
+ },
15595
15772
  {
15596
15773
  "kind": "field",
15597
15774
  "name": "autofocus",
@@ -15926,6 +16103,16 @@
15926
16103
  "name": "sgds-change",
15927
16104
  "detailType": "ISgdsRadioGroupChangeEventDetail",
15928
16105
  "reactName": "onSgdsChange"
16106
+ },
16107
+ {
16108
+ "description": "Emitted when the radio group's invalid state is set to true.",
16109
+ "name": "sgds-invalid",
16110
+ "reactName": "onSgdsInvalid"
16111
+ },
16112
+ {
16113
+ "description": "Emitted when the radio group's invalid state is set to false.",
16114
+ "name": "sgds-valid",
16115
+ "reactName": "onSgdsValid"
15929
16116
  }
15930
16117
  ],
15931
16118
  "attributes": [
@@ -15965,6 +16152,15 @@
15965
16152
  "description": "Makes the input as a required field.",
15966
16153
  "fieldName": "required"
15967
16154
  },
16155
+ {
16156
+ "name": "noValidate",
16157
+ "type": {
16158
+ "text": "boolean"
16159
+ },
16160
+ "default": "false",
16161
+ "description": "Disables native and sgds validation for the radio group.",
16162
+ "fieldName": "noValidate"
16163
+ },
15968
16164
  {
15969
16165
  "name": "autofocus",
15970
16166
  "type": {
@@ -16552,6 +16748,17 @@
16552
16748
  "module": "src/base/select-element.ts"
16553
16749
  }
16554
16750
  },
16751
+ {
16752
+ "kind": "field",
16753
+ "name": "noValidate",
16754
+ "type": {
16755
+ "text": "boolean"
16756
+ },
16757
+ "default": "false",
16758
+ "description": "Disables native and sgds validation for the select.",
16759
+ "attribute": "noValidate",
16760
+ "reflects": true
16761
+ },
16555
16762
  {
16556
16763
  "kind": "field",
16557
16764
  "name": "options",
@@ -16949,6 +17156,45 @@
16949
17156
  "module": "src/base/select-element.ts"
16950
17157
  }
16951
17158
  },
17159
+ {
17160
+ "kind": "method",
17161
+ "name": "setValidity",
17162
+ "privacy": "public",
17163
+ "return": {
17164
+ "type": {
17165
+ "text": "void"
17166
+ }
17167
+ },
17168
+ "parameters": [
17169
+ {
17170
+ "name": "flags",
17171
+ "optional": true,
17172
+ "type": {
17173
+ "text": "ValidityStateFlags"
17174
+ }
17175
+ },
17176
+ {
17177
+ "name": "message",
17178
+ "optional": true,
17179
+ "type": {
17180
+ "text": "string"
17181
+ }
17182
+ },
17183
+ {
17184
+ "name": "anchor",
17185
+ "optional": true,
17186
+ "type": {
17187
+ "text": "HTMLElement"
17188
+ }
17189
+ }
17190
+ ],
17191
+ "description": "Sets the validity state of the element",
17192
+ "type": {},
17193
+ "inheritedFrom": {
17194
+ "name": "SelectElement",
17195
+ "module": "src/base/select-element.ts"
17196
+ }
17197
+ },
16952
17198
  {
16953
17199
  "kind": "method",
16954
17200
  "name": "checkValidity",
@@ -17470,6 +17716,16 @@
17470
17716
  "name": "sgds-blur",
17471
17717
  "reactName": "onSgdsBlur"
17472
17718
  },
17719
+ {
17720
+ "description": "Emitted when the select's invalid state is set to true.",
17721
+ "name": "sgds-invalid",
17722
+ "reactName": "onSgdsInvalid"
17723
+ },
17724
+ {
17725
+ "description": "Emitted when the select's invalid state is set to false.",
17726
+ "name": "sgds-valid",
17727
+ "reactName": "onSgdsValid"
17728
+ },
17473
17729
  {
17474
17730
  "description": "Emitted event when show instance is called",
17475
17731
  "name": "sgds-show",
@@ -17507,14 +17763,16 @@
17507
17763
  }
17508
17764
  }
17509
17765
  ],
17510
- "superclass": {
17511
- "name": "SelectElement",
17512
- "module": "/src/base/select-element"
17513
- },
17514
- "summary": "Select is used to make one selection from a list through keyboard or mouse actions",
17515
- "tagName": "sgds-select",
17516
- "customElement": true,
17517
17766
  "attributes": [
17767
+ {
17768
+ "name": "noValidate",
17769
+ "type": {
17770
+ "text": "boolean"
17771
+ },
17772
+ "default": "false",
17773
+ "description": "Disables native and sgds validation for the select.",
17774
+ "fieldName": "noValidate"
17775
+ },
17518
17776
  {
17519
17777
  "name": "label",
17520
17778
  "type": {
@@ -17748,6 +18006,13 @@
17748
18006
  }
17749
18007
  }
17750
18008
  ],
18009
+ "superclass": {
18010
+ "name": "SelectElement",
18011
+ "module": "/src/base/select-element"
18012
+ },
18013
+ "summary": "Select is used to make one selection from a list through keyboard or mouse actions",
18014
+ "tagName": "sgds-select",
18015
+ "customElement": true,
17751
18016
  "modulePath": "src/components/Select/sgds-select.ts",
17752
18017
  "cssProperties": [],
17753
18018
  "cssParts": [],
@@ -26918,6 +27183,41 @@
26918
27183
  "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",
26919
27184
  "type": {}
26920
27185
  },
27186
+ {
27187
+ "kind": "method",
27188
+ "name": "setValidity",
27189
+ "privacy": "public",
27190
+ "return": {
27191
+ "type": {
27192
+ "text": "void"
27193
+ }
27194
+ },
27195
+ "parameters": [
27196
+ {
27197
+ "name": "flags",
27198
+ "optional": true,
27199
+ "type": {
27200
+ "text": "ValidityStateFlags"
27201
+ }
27202
+ },
27203
+ {
27204
+ "name": "message",
27205
+ "optional": true,
27206
+ "type": {
27207
+ "text": "string"
27208
+ }
27209
+ },
27210
+ {
27211
+ "name": "anchor",
27212
+ "optional": true,
27213
+ "type": {
27214
+ "text": "HTMLElement"
27215
+ }
27216
+ }
27217
+ ],
27218
+ "description": "Sets the validity state of the element",
27219
+ "type": {}
27220
+ },
26921
27221
  {
26922
27222
  "kind": "method",
26923
27223
  "name": "checkValidity",
@@ -27651,7 +27951,7 @@
27651
27951
  "package": {
27652
27952
  "name": "@govtechsg/sgds-web-component",
27653
27953
  "description": "",
27654
- "version": "3.23.0-rc.0",
27954
+ "version": "3.23.0-rc.2",
27655
27955
  "author": "GovTechSG",
27656
27956
  "license": "MIT"
27657
27957
  }