@momentum-design/components 0.125.1 → 0.126.0

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.
@@ -5014,77 +5014,6 @@
5014
5014
  }
5015
5015
  ]
5016
5016
  },
5017
- {
5018
- "kind": "javascript-module",
5019
- "path": "components/bullet/bullet.component.js",
5020
- "declarations": [
5021
- {
5022
- "kind": "class",
5023
- "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
5024
- "name": "Bullet",
5025
- "cssProperties": [
5026
- {
5027
- "description": "background color of the bullet",
5028
- "name": "--mdc-bullet-background-color"
5029
- },
5030
- {
5031
- "description": "small size value of the bullet",
5032
- "name": "--mdc-bullet-size-small"
5033
- },
5034
- {
5035
- "description": "medium size value of the bullet",
5036
- "name": "--mdc-bullet-size-medium"
5037
- },
5038
- {
5039
- "description": "large size value of the bullet",
5040
- "name": "--mdc-bullet-size-large"
5041
- }
5042
- ],
5043
- "members": [
5044
- {
5045
- "kind": "field",
5046
- "name": "size",
5047
- "type": {
5048
- "text": "Size"
5049
- },
5050
- "privacy": "public",
5051
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
5052
- "default": "small",
5053
- "attribute": "size",
5054
- "reflects": true
5055
- }
5056
- ],
5057
- "attributes": [
5058
- {
5059
- "name": "size",
5060
- "type": {
5061
- "text": "Size"
5062
- },
5063
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
5064
- "default": "small",
5065
- "fieldName": "size"
5066
- }
5067
- ],
5068
- "superclass": {
5069
- "name": "Component",
5070
- "module": "/src/models"
5071
- },
5072
- "tagName": "mdc-bullet",
5073
- "jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
5074
- "customElement": true
5075
- }
5076
- ],
5077
- "exports": [
5078
- {
5079
- "kind": "js",
5080
- "name": "default",
5081
- "declaration": {
5082
- "name": "Bullet",
5083
- "module": "components/bullet/bullet.component.js"
5084
- }
5085
- }
5086
- ]
5087
- },
5088
5017
  {
5089
5018
  "kind": "javascript-module",
5090
5019
  "path": "components/button/button.component.js",
@@ -5900,6 +5829,77 @@
5900
5829
  }
5901
5830
  ]
5902
5831
  },
5832
+ {
5833
+ "kind": "javascript-module",
5834
+ "path": "components/bullet/bullet.component.js",
5835
+ "declarations": [
5836
+ {
5837
+ "kind": "class",
5838
+ "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
5839
+ "name": "Bullet",
5840
+ "cssProperties": [
5841
+ {
5842
+ "description": "background color of the bullet",
5843
+ "name": "--mdc-bullet-background-color"
5844
+ },
5845
+ {
5846
+ "description": "small size value of the bullet",
5847
+ "name": "--mdc-bullet-size-small"
5848
+ },
5849
+ {
5850
+ "description": "medium size value of the bullet",
5851
+ "name": "--mdc-bullet-size-medium"
5852
+ },
5853
+ {
5854
+ "description": "large size value of the bullet",
5855
+ "name": "--mdc-bullet-size-large"
5856
+ }
5857
+ ],
5858
+ "members": [
5859
+ {
5860
+ "kind": "field",
5861
+ "name": "size",
5862
+ "type": {
5863
+ "text": "Size"
5864
+ },
5865
+ "privacy": "public",
5866
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
5867
+ "default": "small",
5868
+ "attribute": "size",
5869
+ "reflects": true
5870
+ }
5871
+ ],
5872
+ "attributes": [
5873
+ {
5874
+ "name": "size",
5875
+ "type": {
5876
+ "text": "Size"
5877
+ },
5878
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
5879
+ "default": "small",
5880
+ "fieldName": "size"
5881
+ }
5882
+ ],
5883
+ "superclass": {
5884
+ "name": "Component",
5885
+ "module": "/src/models"
5886
+ },
5887
+ "tagName": "mdc-bullet",
5888
+ "jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
5889
+ "customElement": true
5890
+ }
5891
+ ],
5892
+ "exports": [
5893
+ {
5894
+ "kind": "js",
5895
+ "name": "default",
5896
+ "declaration": {
5897
+ "name": "Bullet",
5898
+ "module": "components/bullet/bullet.component.js"
5899
+ }
5900
+ }
5901
+ ]
5902
+ },
5903
5903
  {
5904
5904
  "kind": "javascript-module",
5905
5905
  "path": "components/buttongroup/buttongroup.component.js",
@@ -6040,12 +6040,12 @@
6040
6040
  },
6041
6041
  {
6042
6042
  "kind": "javascript-module",
6043
- "path": "components/buttonlink/buttonlink.component.js",
6043
+ "path": "components/buttonsimple/buttonsimple.component.js",
6044
6044
  "declarations": [
6045
6045
  {
6046
6046
  "kind": "class",
6047
- "description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
6048
- "name": "ButtonLink",
6047
+ "description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
6048
+ "name": "Buttonsimple",
6049
6049
  "cssProperties": [
6050
6050
  {
6051
6051
  "description": "Height for button size",
@@ -6062,124 +6062,18 @@
6062
6062
  {
6063
6063
  "description": "Text color of the button",
6064
6064
  "name": "--mdc-button-text-color"
6065
- },
6066
- {
6067
- "description": "Line height of the button text",
6068
- "name": "--mdc-button-line-height"
6069
- },
6070
- {
6071
- "description": "Size of the prefix icon",
6072
- "name": "--mdc-button-prefix-icon-size"
6073
- },
6074
- {
6075
- "description": "Size of the postfix icon",
6076
- "name": "--mdc-button-postfix-icon-size"
6077
- },
6078
- {
6079
- "description": "Border radius of the link.",
6080
- "name": "--mdc-link-border-radius",
6081
- "inheritedFrom": {
6082
- "name": "Linksimple",
6083
- "module": "src/components/linksimple/linksimple.component.ts"
6084
- }
6085
- },
6086
- {
6087
- "description": "Color of the link’s child content in the active state.",
6088
- "name": "--mdc-link-color-active",
6089
- "inheritedFrom": {
6090
- "name": "Linksimple",
6091
- "module": "src/components/linksimple/linksimple.component.ts"
6092
- }
6093
- },
6094
- {
6095
- "description": "Color of the link’s child content in the disabled state.",
6096
- "name": "--mdc-link-color-disabled",
6097
- "inheritedFrom": {
6098
- "name": "Linksimple",
6099
- "module": "src/components/linksimple/linksimple.component.ts"
6100
- }
6101
- },
6102
- {
6103
- "description": "Color of the link’s child content in the hover state.",
6104
- "name": "--mdc-link-color-hover",
6105
- "inheritedFrom": {
6106
- "name": "Linksimple",
6107
- "module": "src/components/linksimple/linksimple.component.ts"
6108
- }
6109
- },
6110
- {
6111
- "description": "Color of the link’s child content in the normal state.",
6112
- "name": "--mdc-link-color-normal",
6113
- "inheritedFrom": {
6114
- "name": "Linksimple",
6115
- "module": "src/components/linksimple/linksimple.component.ts"
6116
- }
6117
- },
6118
- {
6119
- "description": "Color of the inverted link’s child content in the active state.",
6120
- "name": "--mdc-link-inverted-color-active",
6121
- "inheritedFrom": {
6122
- "name": "Linksimple",
6123
- "module": "src/components/linksimple/linksimple.component.ts"
6124
- }
6125
- },
6126
- {
6127
- "description": "Color of the inverted link’s child content in the disabled state.",
6128
- "name": "--mdc-link-inverted-color-disabled",
6129
- "inheritedFrom": {
6130
- "name": "Linksimple",
6131
- "module": "src/components/linksimple/linksimple.component.ts"
6132
- }
6133
- },
6134
- {
6135
- "description": "Color of the inverted link’s child content in the hover state.",
6136
- "name": "--mdc-link-inverted-color-hover",
6137
- "inheritedFrom": {
6138
- "name": "Linksimple",
6139
- "module": "src/components/linksimple/linksimple.component.ts"
6140
- }
6141
- },
6142
- {
6143
- "description": "Color of the inverted link’s child content in the normal state.",
6144
- "name": "--mdc-link-inverted-color-normal",
6145
- "inheritedFrom": {
6146
- "name": "Linksimple",
6147
- "module": "src/components/linksimple/linksimple.component.ts"
6148
- }
6149
- }
6150
- ],
6151
- "cssParts": [
6152
- {
6153
- "description": "The anchor element that wraps the buttonlink content.",
6154
- "name": "anchor",
6155
- "inheritedFrom": {
6156
- "name": "Linksimple",
6157
- "module": "src/components/linksimple/linksimple.component.ts"
6158
- }
6159
- },
6160
- {
6161
- "description": "The prefix icon element.",
6162
- "name": "prefix-icon"
6163
- },
6164
- {
6165
- "description": "The slot containing the buttonlink text.",
6166
- "name": "button-text"
6167
- },
6168
- {
6169
- "description": "The postfix icon element.",
6170
- "name": "postfix-icon"
6171
6065
  }
6172
6066
  ],
6173
6067
  "members": [
6174
6068
  {
6175
6069
  "kind": "field",
6176
- "name": "size",
6070
+ "name": "active",
6177
6071
  "type": {
6178
- "text": "PillButtonSize | IconButtonSize"
6072
+ "text": "boolean | undefined"
6179
6073
  },
6180
- "description": "ButtonLink sizing is based on the buttonlink type.\n- **Pill buttonlink**: 40, 32, 28, 24.\n- **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon buttonlink can also be 20.",
6181
- "default": "32",
6182
- "attribute": "size",
6074
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
6075
+ "default": "undefined",
6076
+ "attribute": "active",
6183
6077
  "reflects": true
6184
6078
  },
6185
6079
  {
@@ -6188,181 +6082,217 @@
6188
6082
  "type": {
6189
6083
  "text": "boolean | undefined"
6190
6084
  },
6191
- "description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
6085
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
6192
6086
  "default": "undefined",
6193
6087
  "attribute": "soft-disabled",
6194
6088
  "reflects": true
6195
6089
  },
6196
6090
  {
6197
- "kind": "method",
6198
- "name": "setSoftDisabled",
6199
- "privacy": "private",
6200
- "parameters": [
6201
- {
6202
- "name": "element",
6203
- "type": {
6204
- "text": "HTMLElement"
6205
- },
6206
- "description": "The buttonlink element."
6207
- },
6208
- {
6209
- "name": "softDisabled",
6210
- "optional": true,
6211
- "type": {
6212
- "text": "boolean"
6213
- },
6214
- "description": "The soft-disabled state."
6215
- }
6216
- ],
6217
- "description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
6091
+ "kind": "field",
6092
+ "name": "size",
6093
+ "type": {
6094
+ "text": "ButtonSize"
6095
+ },
6096
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
6097
+ "default": "32",
6098
+ "attribute": "size",
6099
+ "reflects": true
6218
6100
  },
6219
6101
  {
6220
- "kind": "method",
6221
- "name": "renderAnchorContent",
6222
- "privacy": "protected"
6102
+ "kind": "field",
6103
+ "name": "role",
6104
+ "type": {
6105
+ "text": "RoleType"
6106
+ },
6107
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
6108
+ "default": "button",
6109
+ "attribute": "role",
6110
+ "reflects": true
6223
6111
  },
6224
6112
  {
6225
6113
  "kind": "field",
6226
- "name": "prefixIcon",
6114
+ "name": "ariaStateKey",
6227
6115
  "type": {
6228
- "text": "IconNames | undefined"
6116
+ "text": "string | undefined"
6229
6117
  },
6230
- "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
6231
- "attribute": "prefix-icon",
6232
- "reflects": true,
6233
- "inheritedFrom": {
6234
- "name": "ButtonComponentMixin",
6235
- "module": "utils/mixins/ButtonComponentMixin.js"
6236
- }
6118
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
6119
+ "default": "'aria-pressed' (when)",
6120
+ "attribute": "ariaStateKey",
6121
+ "reflects": true
6237
6122
  },
6238
6123
  {
6239
6124
  "kind": "field",
6240
- "name": "postfixIcon",
6125
+ "name": "type",
6241
6126
  "type": {
6242
- "text": "IconNames | undefined"
6127
+ "text": "ButtonType"
6243
6128
  },
6244
- "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
6245
- "attribute": "postfix-icon",
6246
- "reflects": true,
6247
- "inheritedFrom": {
6248
- "name": "ButtonComponentMixin",
6249
- "module": "utils/mixins/ButtonComponentMixin.js"
6250
- }
6129
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
6130
+ "default": "button",
6131
+ "attribute": "type",
6132
+ "reflects": true
6251
6133
  },
6252
6134
  {
6253
6135
  "kind": "field",
6254
- "name": "variant",
6136
+ "name": "name",
6255
6137
  "type": {
6256
- "text": "ButtonVariant"
6138
+ "text": "string | undefined"
6257
6139
  },
6258
- "description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
6259
- "default": "primary",
6260
- "attribute": "variant",
6261
- "inheritedFrom": {
6262
- "name": "ButtonComponentMixin",
6263
- "module": "utils/mixins/ButtonComponentMixin.js"
6264
- }
6140
+ "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
6141
+ "attribute": "name",
6142
+ "reflects": true
6265
6143
  },
6266
6144
  {
6267
6145
  "kind": "field",
6268
- "name": "color",
6146
+ "name": "value",
6269
6147
  "type": {
6270
- "text": "ButtonColor"
6148
+ "text": "string | undefined"
6271
6149
  },
6272
- "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
6273
- "default": "default",
6274
- "attribute": "color",
6275
- "inheritedFrom": {
6276
- "name": "ButtonComponentMixin",
6277
- "module": "utils/mixins/ButtonComponentMixin.js"
6278
- }
6150
+ "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
6151
+ "attribute": "value",
6152
+ "reflects": true
6279
6153
  },
6280
6154
  {
6281
6155
  "kind": "method",
6282
- "name": "setVariant",
6156
+ "name": "executeAction",
6157
+ "privacy": "protected"
6158
+ },
6159
+ {
6160
+ "kind": "method",
6161
+ "name": "setActive",
6283
6162
  "privacy": "protected",
6284
6163
  "parameters": [
6285
6164
  {
6286
- "name": "variant",
6165
+ "name": "element",
6287
6166
  "type": {
6288
- "text": "ButtonVariant"
6167
+ "text": "HTMLElement"
6289
6168
  },
6290
- "description": "The variant to set."
6169
+ "description": "The button element"
6170
+ },
6171
+ {
6172
+ "name": "active",
6173
+ "optional": true,
6174
+ "type": {
6175
+ "text": "boolean"
6176
+ },
6177
+ "description": "The active state of the element"
6291
6178
  }
6292
6179
  ],
6293
- "description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
6294
- "inheritedFrom": {
6295
- "name": "ButtonComponentMixin",
6296
- "module": "utils/mixins/ButtonComponentMixin.js"
6297
- }
6180
+ "description": "Sets the ariaStateKey attributes based on the active state of the button."
6298
6181
  },
6299
6182
  {
6300
6183
  "kind": "method",
6301
- "name": "setColor",
6302
- "privacy": "protected",
6184
+ "name": "setSoftDisabled",
6185
+ "privacy": "private",
6303
6186
  "parameters": [
6304
6187
  {
6305
- "name": "color",
6188
+ "name": "element",
6306
6189
  "type": {
6307
- "text": "ButtonColor"
6190
+ "text": "HTMLElement"
6308
6191
  },
6309
- "description": "The color to set."
6192
+ "description": "The button element."
6193
+ },
6194
+ {
6195
+ "name": "softDisabled",
6196
+ "optional": true,
6197
+ "type": {
6198
+ "text": "boolean"
6199
+ },
6200
+ "description": "The soft-disabled state."
6310
6201
  }
6311
6202
  ],
6312
- "description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
6313
- "inheritedFrom": {
6314
- "name": "ButtonComponentMixin",
6315
- "module": "utils/mixins/ButtonComponentMixin.js"
6316
- }
6203
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
6317
6204
  },
6318
6205
  {
6319
6206
  "kind": "method",
6320
- "name": "setSize",
6321
- "privacy": "protected",
6207
+ "name": "setDisabled",
6208
+ "privacy": "private",
6322
6209
  "parameters": [
6323
6210
  {
6324
- "name": "size",
6211
+ "name": "element",
6325
6212
  "type": {
6326
- "text": "PillButtonSize | IconButtonSize"
6213
+ "text": "HTMLElement"
6327
6214
  },
6328
- "description": "The size to set."
6215
+ "description": "The button element."
6216
+ },
6217
+ {
6218
+ "name": "disabled",
6219
+ "type": {
6220
+ "text": "boolean"
6221
+ },
6222
+ "description": "The disabled state."
6329
6223
  }
6330
6224
  ],
6331
- "description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
6332
- "inheritedFrom": {
6333
- "name": "ButtonComponentMixin",
6334
- "module": "utils/mixins/ButtonComponentMixin.js"
6335
- }
6225
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute."
6336
6226
  },
6337
6227
  {
6338
6228
  "kind": "method",
6339
- "name": "inferButtonType",
6340
- "privacy": "protected",
6341
- "description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
6229
+ "name": "triggerClickEvent",
6230
+ "privacy": "private"
6231
+ },
6232
+ {
6233
+ "kind": "method",
6234
+ "name": "handleBlur",
6235
+ "privacy": "private",
6236
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
6237
+ },
6238
+ {
6239
+ "kind": "method",
6240
+ "name": "handleKeyDown",
6241
+ "privacy": "private",
6342
6242
  "parameters": [
6343
6243
  {
6344
- "description": "default slot of button",
6345
- "name": "slot"
6244
+ "name": "event",
6245
+ "type": {
6246
+ "text": "KeyboardEvent"
6247
+ },
6248
+ "description": "The keyboard event."
6249
+ }
6250
+ ],
6251
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application."
6252
+ },
6253
+ {
6254
+ "kind": "method",
6255
+ "name": "handleKeyUp",
6256
+ "privacy": "private",
6257
+ "parameters": [
6258
+ {
6259
+ "name": "event",
6260
+ "type": {
6261
+ "text": "KeyboardEvent"
6262
+ },
6263
+ "description": "The keyboard event."
6346
6264
  }
6347
6265
  ],
6266
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
6267
+ },
6268
+ {
6269
+ "kind": "field",
6270
+ "name": "autoFocusOnMount",
6271
+ "type": {
6272
+ "text": "boolean"
6273
+ },
6274
+ "default": "false",
6275
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
6276
+ "attribute": "auto-focus-on-mount",
6277
+ "reflects": true,
6348
6278
  "inheritedFrom": {
6349
- "name": "ButtonComponentMixin",
6350
- "module": "utils/mixins/ButtonComponentMixin.js"
6279
+ "name": "AutoFocusOnMountMixin",
6280
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
6351
6281
  }
6352
6282
  },
6353
6283
  {
6354
6284
  "kind": "field",
6355
- "name": "dataAriaLabel",
6285
+ "name": "tabIndex",
6356
6286
  "type": {
6357
- "text": "string | null"
6287
+ "text": "number"
6358
6288
  },
6359
- "default": "null",
6360
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6361
- "attribute": "data-aria-label",
6289
+ "default": "0",
6290
+ "description": "This property specifies the tab order of the element.",
6291
+ "attribute": "tabIndex",
6362
6292
  "reflects": true,
6363
6293
  "inheritedFrom": {
6364
- "name": "DataAriaLabelMixin",
6365
- "module": "utils/mixins/DataAriaLabelMixin.js"
6294
+ "name": "TabIndexMixin",
6295
+ "module": "utils/mixins/TabIndexMixin.js"
6366
6296
  }
6367
6297
  },
6368
6298
  {
@@ -6379,7 +6309,517 @@
6379
6309
  "name": "DisabledMixin",
6380
6310
  "module": "utils/mixins/DisabledMixin.js"
6381
6311
  }
6382
- },
6312
+ }
6313
+ ],
6314
+ "events": [
6315
+ {
6316
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
6317
+ "name": "click",
6318
+ "reactName": "onClick"
6319
+ },
6320
+ {
6321
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
6322
+ "name": "keydown",
6323
+ "reactName": "onKeyDown"
6324
+ },
6325
+ {
6326
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
6327
+ "name": "keyup",
6328
+ "reactName": "onKeyUp"
6329
+ },
6330
+ {
6331
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
6332
+ "name": "focus",
6333
+ "reactName": "onFocus"
6334
+ }
6335
+ ],
6336
+ "attributes": [
6337
+ {
6338
+ "name": "active",
6339
+ "type": {
6340
+ "text": "boolean | undefined"
6341
+ },
6342
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
6343
+ "default": "undefined",
6344
+ "fieldName": "active"
6345
+ },
6346
+ {
6347
+ "name": "soft-disabled",
6348
+ "type": {
6349
+ "text": "boolean | undefined"
6350
+ },
6351
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
6352
+ "default": "undefined",
6353
+ "fieldName": "softDisabled"
6354
+ },
6355
+ {
6356
+ "name": "size",
6357
+ "type": {
6358
+ "text": "ButtonSize"
6359
+ },
6360
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
6361
+ "default": "32",
6362
+ "fieldName": "size"
6363
+ },
6364
+ {
6365
+ "name": "role",
6366
+ "type": {
6367
+ "text": "RoleType"
6368
+ },
6369
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
6370
+ "default": "button",
6371
+ "fieldName": "role"
6372
+ },
6373
+ {
6374
+ "name": "ariaStateKey",
6375
+ "type": {
6376
+ "text": "string | undefined"
6377
+ },
6378
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
6379
+ "default": "'aria-pressed' (when)",
6380
+ "fieldName": "ariaStateKey"
6381
+ },
6382
+ {
6383
+ "name": "type",
6384
+ "type": {
6385
+ "text": "ButtonType"
6386
+ },
6387
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
6388
+ "default": "button",
6389
+ "fieldName": "type"
6390
+ },
6391
+ {
6392
+ "name": "name",
6393
+ "type": {
6394
+ "text": "string | undefined"
6395
+ },
6396
+ "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
6397
+ "fieldName": "name"
6398
+ },
6399
+ {
6400
+ "name": "value",
6401
+ "type": {
6402
+ "text": "string | undefined"
6403
+ },
6404
+ "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
6405
+ "fieldName": "value"
6406
+ },
6407
+ {
6408
+ "name": "auto-focus-on-mount",
6409
+ "type": {
6410
+ "text": "boolean"
6411
+ },
6412
+ "default": "false",
6413
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
6414
+ "fieldName": "autoFocusOnMount",
6415
+ "inheritedFrom": {
6416
+ "name": "AutoFocusOnMountMixin",
6417
+ "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
6418
+ }
6419
+ },
6420
+ {
6421
+ "name": "tabIndex",
6422
+ "type": {
6423
+ "text": "number"
6424
+ },
6425
+ "default": "0",
6426
+ "description": "This property specifies the tab order of the element.",
6427
+ "fieldName": "tabIndex",
6428
+ "inheritedFrom": {
6429
+ "name": "TabIndexMixin",
6430
+ "module": "src/utils/mixins/TabIndexMixin.ts"
6431
+ }
6432
+ },
6433
+ {
6434
+ "name": "disabled",
6435
+ "type": {
6436
+ "text": "boolean | undefined"
6437
+ },
6438
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6439
+ "default": "undefined",
6440
+ "fieldName": "disabled",
6441
+ "inheritedFrom": {
6442
+ "name": "DisabledMixin",
6443
+ "module": "src/utils/mixins/DisabledMixin.ts"
6444
+ }
6445
+ }
6446
+ ],
6447
+ "mixins": [
6448
+ {
6449
+ "name": "AutoFocusOnMountMixin",
6450
+ "module": "/src/utils/mixins/AutoFocusOnMountMixin"
6451
+ },
6452
+ {
6453
+ "name": "TabIndexMixin",
6454
+ "module": "/src/utils/mixins/TabIndexMixin"
6455
+ },
6456
+ {
6457
+ "name": "DisabledMixin",
6458
+ "module": "/src/utils/mixins/DisabledMixin"
6459
+ }
6460
+ ],
6461
+ "superclass": {
6462
+ "name": "Component",
6463
+ "module": "/src/models"
6464
+ },
6465
+ "tagName": "mdc-buttonsimple",
6466
+ "jsDoc": "/**\n * `mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\n * It is used as an internal component and is not intended to be used directly by consumers.\n * Consumers should use the `mdc-button` component instead.\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-buttonsimple\n *\n * @cssproperty --mdc-button-height - Height for button size\n * @cssproperty --mdc-button-background - Background color of the button\n * @cssproperty --mdc-button-border-color - Borer color of the button\n * @cssproperty --mdc-button-text-color - Text color of the button\n */",
6467
+ "customElement": true
6468
+ }
6469
+ ],
6470
+ "exports": [
6471
+ {
6472
+ "kind": "js",
6473
+ "name": "default",
6474
+ "declaration": {
6475
+ "name": "Buttonsimple",
6476
+ "module": "components/buttonsimple/buttonsimple.component.js"
6477
+ }
6478
+ }
6479
+ ]
6480
+ },
6481
+ {
6482
+ "kind": "javascript-module",
6483
+ "path": "components/buttonlink/buttonlink.component.js",
6484
+ "declarations": [
6485
+ {
6486
+ "kind": "class",
6487
+ "description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
6488
+ "name": "ButtonLink",
6489
+ "cssProperties": [
6490
+ {
6491
+ "description": "Height for button size",
6492
+ "name": "--mdc-button-height"
6493
+ },
6494
+ {
6495
+ "description": "Background color of the button",
6496
+ "name": "--mdc-button-background"
6497
+ },
6498
+ {
6499
+ "description": "Borer color of the button",
6500
+ "name": "--mdc-button-border-color"
6501
+ },
6502
+ {
6503
+ "description": "Text color of the button",
6504
+ "name": "--mdc-button-text-color"
6505
+ },
6506
+ {
6507
+ "description": "Line height of the button text",
6508
+ "name": "--mdc-button-line-height"
6509
+ },
6510
+ {
6511
+ "description": "Size of the prefix icon",
6512
+ "name": "--mdc-button-prefix-icon-size"
6513
+ },
6514
+ {
6515
+ "description": "Size of the postfix icon",
6516
+ "name": "--mdc-button-postfix-icon-size"
6517
+ },
6518
+ {
6519
+ "description": "Border radius of the link.",
6520
+ "name": "--mdc-link-border-radius",
6521
+ "inheritedFrom": {
6522
+ "name": "Linksimple",
6523
+ "module": "src/components/linksimple/linksimple.component.ts"
6524
+ }
6525
+ },
6526
+ {
6527
+ "description": "Color of the link’s child content in the active state.",
6528
+ "name": "--mdc-link-color-active",
6529
+ "inheritedFrom": {
6530
+ "name": "Linksimple",
6531
+ "module": "src/components/linksimple/linksimple.component.ts"
6532
+ }
6533
+ },
6534
+ {
6535
+ "description": "Color of the link’s child content in the disabled state.",
6536
+ "name": "--mdc-link-color-disabled",
6537
+ "inheritedFrom": {
6538
+ "name": "Linksimple",
6539
+ "module": "src/components/linksimple/linksimple.component.ts"
6540
+ }
6541
+ },
6542
+ {
6543
+ "description": "Color of the link’s child content in the hover state.",
6544
+ "name": "--mdc-link-color-hover",
6545
+ "inheritedFrom": {
6546
+ "name": "Linksimple",
6547
+ "module": "src/components/linksimple/linksimple.component.ts"
6548
+ }
6549
+ },
6550
+ {
6551
+ "description": "Color of the link’s child content in the normal state.",
6552
+ "name": "--mdc-link-color-normal",
6553
+ "inheritedFrom": {
6554
+ "name": "Linksimple",
6555
+ "module": "src/components/linksimple/linksimple.component.ts"
6556
+ }
6557
+ },
6558
+ {
6559
+ "description": "Color of the inverted link’s child content in the active state.",
6560
+ "name": "--mdc-link-inverted-color-active",
6561
+ "inheritedFrom": {
6562
+ "name": "Linksimple",
6563
+ "module": "src/components/linksimple/linksimple.component.ts"
6564
+ }
6565
+ },
6566
+ {
6567
+ "description": "Color of the inverted link’s child content in the disabled state.",
6568
+ "name": "--mdc-link-inverted-color-disabled",
6569
+ "inheritedFrom": {
6570
+ "name": "Linksimple",
6571
+ "module": "src/components/linksimple/linksimple.component.ts"
6572
+ }
6573
+ },
6574
+ {
6575
+ "description": "Color of the inverted link’s child content in the hover state.",
6576
+ "name": "--mdc-link-inverted-color-hover",
6577
+ "inheritedFrom": {
6578
+ "name": "Linksimple",
6579
+ "module": "src/components/linksimple/linksimple.component.ts"
6580
+ }
6581
+ },
6582
+ {
6583
+ "description": "Color of the inverted link’s child content in the normal state.",
6584
+ "name": "--mdc-link-inverted-color-normal",
6585
+ "inheritedFrom": {
6586
+ "name": "Linksimple",
6587
+ "module": "src/components/linksimple/linksimple.component.ts"
6588
+ }
6589
+ }
6590
+ ],
6591
+ "cssParts": [
6592
+ {
6593
+ "description": "The anchor element that wraps the buttonlink content.",
6594
+ "name": "anchor",
6595
+ "inheritedFrom": {
6596
+ "name": "Linksimple",
6597
+ "module": "src/components/linksimple/linksimple.component.ts"
6598
+ }
6599
+ },
6600
+ {
6601
+ "description": "The prefix icon element.",
6602
+ "name": "prefix-icon"
6603
+ },
6604
+ {
6605
+ "description": "The slot containing the buttonlink text.",
6606
+ "name": "button-text"
6607
+ },
6608
+ {
6609
+ "description": "The postfix icon element.",
6610
+ "name": "postfix-icon"
6611
+ }
6612
+ ],
6613
+ "members": [
6614
+ {
6615
+ "kind": "field",
6616
+ "name": "size",
6617
+ "type": {
6618
+ "text": "PillButtonSize | IconButtonSize"
6619
+ },
6620
+ "description": "ButtonLink sizing is based on the buttonlink type.\n- **Pill buttonlink**: 40, 32, 28, 24.\n- **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon buttonlink can also be 20.",
6621
+ "default": "32",
6622
+ "attribute": "size",
6623
+ "reflects": true
6624
+ },
6625
+ {
6626
+ "kind": "field",
6627
+ "name": "softDisabled",
6628
+ "type": {
6629
+ "text": "boolean | undefined"
6630
+ },
6631
+ "description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
6632
+ "default": "undefined",
6633
+ "attribute": "soft-disabled",
6634
+ "reflects": true
6635
+ },
6636
+ {
6637
+ "kind": "method",
6638
+ "name": "setSoftDisabled",
6639
+ "privacy": "private",
6640
+ "parameters": [
6641
+ {
6642
+ "name": "element",
6643
+ "type": {
6644
+ "text": "HTMLElement"
6645
+ },
6646
+ "description": "The buttonlink element."
6647
+ },
6648
+ {
6649
+ "name": "softDisabled",
6650
+ "optional": true,
6651
+ "type": {
6652
+ "text": "boolean"
6653
+ },
6654
+ "description": "The soft-disabled state."
6655
+ }
6656
+ ],
6657
+ "description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
6658
+ },
6659
+ {
6660
+ "kind": "method",
6661
+ "name": "renderAnchorContent",
6662
+ "privacy": "protected"
6663
+ },
6664
+ {
6665
+ "kind": "field",
6666
+ "name": "prefixIcon",
6667
+ "type": {
6668
+ "text": "IconNames | undefined"
6669
+ },
6670
+ "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
6671
+ "attribute": "prefix-icon",
6672
+ "reflects": true,
6673
+ "inheritedFrom": {
6674
+ "name": "ButtonComponentMixin",
6675
+ "module": "utils/mixins/ButtonComponentMixin.js"
6676
+ }
6677
+ },
6678
+ {
6679
+ "kind": "field",
6680
+ "name": "postfixIcon",
6681
+ "type": {
6682
+ "text": "IconNames | undefined"
6683
+ },
6684
+ "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
6685
+ "attribute": "postfix-icon",
6686
+ "reflects": true,
6687
+ "inheritedFrom": {
6688
+ "name": "ButtonComponentMixin",
6689
+ "module": "utils/mixins/ButtonComponentMixin.js"
6690
+ }
6691
+ },
6692
+ {
6693
+ "kind": "field",
6694
+ "name": "variant",
6695
+ "type": {
6696
+ "text": "ButtonVariant"
6697
+ },
6698
+ "description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
6699
+ "default": "primary",
6700
+ "attribute": "variant",
6701
+ "inheritedFrom": {
6702
+ "name": "ButtonComponentMixin",
6703
+ "module": "utils/mixins/ButtonComponentMixin.js"
6704
+ }
6705
+ },
6706
+ {
6707
+ "kind": "field",
6708
+ "name": "color",
6709
+ "type": {
6710
+ "text": "ButtonColor"
6711
+ },
6712
+ "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
6713
+ "default": "default",
6714
+ "attribute": "color",
6715
+ "inheritedFrom": {
6716
+ "name": "ButtonComponentMixin",
6717
+ "module": "utils/mixins/ButtonComponentMixin.js"
6718
+ }
6719
+ },
6720
+ {
6721
+ "kind": "method",
6722
+ "name": "setVariant",
6723
+ "privacy": "protected",
6724
+ "parameters": [
6725
+ {
6726
+ "name": "variant",
6727
+ "type": {
6728
+ "text": "ButtonVariant"
6729
+ },
6730
+ "description": "The variant to set."
6731
+ }
6732
+ ],
6733
+ "description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
6734
+ "inheritedFrom": {
6735
+ "name": "ButtonComponentMixin",
6736
+ "module": "utils/mixins/ButtonComponentMixin.js"
6737
+ }
6738
+ },
6739
+ {
6740
+ "kind": "method",
6741
+ "name": "setColor",
6742
+ "privacy": "protected",
6743
+ "parameters": [
6744
+ {
6745
+ "name": "color",
6746
+ "type": {
6747
+ "text": "ButtonColor"
6748
+ },
6749
+ "description": "The color to set."
6750
+ }
6751
+ ],
6752
+ "description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
6753
+ "inheritedFrom": {
6754
+ "name": "ButtonComponentMixin",
6755
+ "module": "utils/mixins/ButtonComponentMixin.js"
6756
+ }
6757
+ },
6758
+ {
6759
+ "kind": "method",
6760
+ "name": "setSize",
6761
+ "privacy": "protected",
6762
+ "parameters": [
6763
+ {
6764
+ "name": "size",
6765
+ "type": {
6766
+ "text": "PillButtonSize | IconButtonSize"
6767
+ },
6768
+ "description": "The size to set."
6769
+ }
6770
+ ],
6771
+ "description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
6772
+ "inheritedFrom": {
6773
+ "name": "ButtonComponentMixin",
6774
+ "module": "utils/mixins/ButtonComponentMixin.js"
6775
+ }
6776
+ },
6777
+ {
6778
+ "kind": "method",
6779
+ "name": "inferButtonType",
6780
+ "privacy": "protected",
6781
+ "description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
6782
+ "parameters": [
6783
+ {
6784
+ "description": "default slot of button",
6785
+ "name": "slot"
6786
+ }
6787
+ ],
6788
+ "inheritedFrom": {
6789
+ "name": "ButtonComponentMixin",
6790
+ "module": "utils/mixins/ButtonComponentMixin.js"
6791
+ }
6792
+ },
6793
+ {
6794
+ "kind": "field",
6795
+ "name": "dataAriaLabel",
6796
+ "type": {
6797
+ "text": "string | null"
6798
+ },
6799
+ "default": "null",
6800
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6801
+ "attribute": "data-aria-label",
6802
+ "reflects": true,
6803
+ "inheritedFrom": {
6804
+ "name": "DataAriaLabelMixin",
6805
+ "module": "utils/mixins/DataAriaLabelMixin.js"
6806
+ }
6807
+ },
6808
+ {
6809
+ "kind": "field",
6810
+ "name": "disabled",
6811
+ "type": {
6812
+ "text": "boolean | undefined"
6813
+ },
6814
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6815
+ "default": "undefined",
6816
+ "attribute": "disabled",
6817
+ "reflects": true,
6818
+ "inheritedFrom": {
6819
+ "name": "DisabledMixin",
6820
+ "module": "utils/mixins/DisabledMixin.js"
6821
+ }
6822
+ },
6383
6823
  {
6384
6824
  "kind": "field",
6385
6825
  "name": "inline",
@@ -6850,447 +7290,7 @@
6850
7290
  },
6851
7291
  {
6852
7292
  "kind": "javascript-module",
6853
- "path": "components/buttonsimple/buttonsimple.component.js",
6854
- "declarations": [
6855
- {
6856
- "kind": "class",
6857
- "description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
6858
- "name": "Buttonsimple",
6859
- "cssProperties": [
6860
- {
6861
- "description": "Height for button size",
6862
- "name": "--mdc-button-height"
6863
- },
6864
- {
6865
- "description": "Background color of the button",
6866
- "name": "--mdc-button-background"
6867
- },
6868
- {
6869
- "description": "Borer color of the button",
6870
- "name": "--mdc-button-border-color"
6871
- },
6872
- {
6873
- "description": "Text color of the button",
6874
- "name": "--mdc-button-text-color"
6875
- }
6876
- ],
6877
- "members": [
6878
- {
6879
- "kind": "field",
6880
- "name": "active",
6881
- "type": {
6882
- "text": "boolean | undefined"
6883
- },
6884
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
6885
- "default": "undefined",
6886
- "attribute": "active",
6887
- "reflects": true
6888
- },
6889
- {
6890
- "kind": "field",
6891
- "name": "softDisabled",
6892
- "type": {
6893
- "text": "boolean | undefined"
6894
- },
6895
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
6896
- "default": "undefined",
6897
- "attribute": "soft-disabled",
6898
- "reflects": true
6899
- },
6900
- {
6901
- "kind": "field",
6902
- "name": "size",
6903
- "type": {
6904
- "text": "ButtonSize"
6905
- },
6906
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
6907
- "default": "32",
6908
- "attribute": "size",
6909
- "reflects": true
6910
- },
6911
- {
6912
- "kind": "field",
6913
- "name": "role",
6914
- "type": {
6915
- "text": "RoleType"
6916
- },
6917
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
6918
- "default": "button",
6919
- "attribute": "role",
6920
- "reflects": true
6921
- },
6922
- {
6923
- "kind": "field",
6924
- "name": "ariaStateKey",
6925
- "type": {
6926
- "text": "string | undefined"
6927
- },
6928
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
6929
- "default": "'aria-pressed' (when)",
6930
- "attribute": "ariaStateKey",
6931
- "reflects": true
6932
- },
6933
- {
6934
- "kind": "field",
6935
- "name": "type",
6936
- "type": {
6937
- "text": "ButtonType"
6938
- },
6939
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
6940
- "default": "button",
6941
- "attribute": "type",
6942
- "reflects": true
6943
- },
6944
- {
6945
- "kind": "field",
6946
- "name": "name",
6947
- "type": {
6948
- "text": "string | undefined"
6949
- },
6950
- "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
6951
- "attribute": "name",
6952
- "reflects": true
6953
- },
6954
- {
6955
- "kind": "field",
6956
- "name": "value",
6957
- "type": {
6958
- "text": "string | undefined"
6959
- },
6960
- "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
6961
- "attribute": "value",
6962
- "reflects": true
6963
- },
6964
- {
6965
- "kind": "method",
6966
- "name": "executeAction",
6967
- "privacy": "protected"
6968
- },
6969
- {
6970
- "kind": "method",
6971
- "name": "setActive",
6972
- "privacy": "protected",
6973
- "parameters": [
6974
- {
6975
- "name": "element",
6976
- "type": {
6977
- "text": "HTMLElement"
6978
- },
6979
- "description": "The button element"
6980
- },
6981
- {
6982
- "name": "active",
6983
- "optional": true,
6984
- "type": {
6985
- "text": "boolean"
6986
- },
6987
- "description": "The active state of the element"
6988
- }
6989
- ],
6990
- "description": "Sets the ariaStateKey attributes based on the active state of the button."
6991
- },
6992
- {
6993
- "kind": "method",
6994
- "name": "setSoftDisabled",
6995
- "privacy": "private",
6996
- "parameters": [
6997
- {
6998
- "name": "element",
6999
- "type": {
7000
- "text": "HTMLElement"
7001
- },
7002
- "description": "The button element."
7003
- },
7004
- {
7005
- "name": "softDisabled",
7006
- "optional": true,
7007
- "type": {
7008
- "text": "boolean"
7009
- },
7010
- "description": "The soft-disabled state."
7011
- }
7012
- ],
7013
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
7014
- },
7015
- {
7016
- "kind": "method",
7017
- "name": "setDisabled",
7018
- "privacy": "private",
7019
- "parameters": [
7020
- {
7021
- "name": "element",
7022
- "type": {
7023
- "text": "HTMLElement"
7024
- },
7025
- "description": "The button element."
7026
- },
7027
- {
7028
- "name": "disabled",
7029
- "type": {
7030
- "text": "boolean"
7031
- },
7032
- "description": "The disabled state."
7033
- }
7034
- ],
7035
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute."
7036
- },
7037
- {
7038
- "kind": "method",
7039
- "name": "triggerClickEvent",
7040
- "privacy": "private"
7041
- },
7042
- {
7043
- "kind": "method",
7044
- "name": "handleBlur",
7045
- "privacy": "private",
7046
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
7047
- },
7048
- {
7049
- "kind": "method",
7050
- "name": "handleKeyDown",
7051
- "privacy": "private",
7052
- "parameters": [
7053
- {
7054
- "name": "event",
7055
- "type": {
7056
- "text": "KeyboardEvent"
7057
- },
7058
- "description": "The keyboard event."
7059
- }
7060
- ],
7061
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application."
7062
- },
7063
- {
7064
- "kind": "method",
7065
- "name": "handleKeyUp",
7066
- "privacy": "private",
7067
- "parameters": [
7068
- {
7069
- "name": "event",
7070
- "type": {
7071
- "text": "KeyboardEvent"
7072
- },
7073
- "description": "The keyboard event."
7074
- }
7075
- ],
7076
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
7077
- },
7078
- {
7079
- "kind": "field",
7080
- "name": "autoFocusOnMount",
7081
- "type": {
7082
- "text": "boolean"
7083
- },
7084
- "default": "false",
7085
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
7086
- "attribute": "auto-focus-on-mount",
7087
- "reflects": true,
7088
- "inheritedFrom": {
7089
- "name": "AutoFocusOnMountMixin",
7090
- "module": "utils/mixins/AutoFocusOnMountMixin.js"
7091
- }
7092
- },
7093
- {
7094
- "kind": "field",
7095
- "name": "tabIndex",
7096
- "type": {
7097
- "text": "number"
7098
- },
7099
- "default": "0",
7100
- "description": "This property specifies the tab order of the element.",
7101
- "attribute": "tabIndex",
7102
- "reflects": true,
7103
- "inheritedFrom": {
7104
- "name": "TabIndexMixin",
7105
- "module": "utils/mixins/TabIndexMixin.js"
7106
- }
7107
- },
7108
- {
7109
- "kind": "field",
7110
- "name": "disabled",
7111
- "type": {
7112
- "text": "boolean | undefined"
7113
- },
7114
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7115
- "default": "undefined",
7116
- "attribute": "disabled",
7117
- "reflects": true,
7118
- "inheritedFrom": {
7119
- "name": "DisabledMixin",
7120
- "module": "utils/mixins/DisabledMixin.js"
7121
- }
7122
- }
7123
- ],
7124
- "events": [
7125
- {
7126
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
7127
- "name": "click",
7128
- "reactName": "onClick"
7129
- },
7130
- {
7131
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
7132
- "name": "keydown",
7133
- "reactName": "onKeyDown"
7134
- },
7135
- {
7136
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
7137
- "name": "keyup",
7138
- "reactName": "onKeyUp"
7139
- },
7140
- {
7141
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
7142
- "name": "focus",
7143
- "reactName": "onFocus"
7144
- }
7145
- ],
7146
- "attributes": [
7147
- {
7148
- "name": "active",
7149
- "type": {
7150
- "text": "boolean | undefined"
7151
- },
7152
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
7153
- "default": "undefined",
7154
- "fieldName": "active"
7155
- },
7156
- {
7157
- "name": "soft-disabled",
7158
- "type": {
7159
- "text": "boolean | undefined"
7160
- },
7161
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
7162
- "default": "undefined",
7163
- "fieldName": "softDisabled"
7164
- },
7165
- {
7166
- "name": "size",
7167
- "type": {
7168
- "text": "ButtonSize"
7169
- },
7170
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
7171
- "default": "32",
7172
- "fieldName": "size"
7173
- },
7174
- {
7175
- "name": "role",
7176
- "type": {
7177
- "text": "RoleType"
7178
- },
7179
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
7180
- "default": "button",
7181
- "fieldName": "role"
7182
- },
7183
- {
7184
- "name": "ariaStateKey",
7185
- "type": {
7186
- "text": "string | undefined"
7187
- },
7188
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
7189
- "default": "'aria-pressed' (when)",
7190
- "fieldName": "ariaStateKey"
7191
- },
7192
- {
7193
- "name": "type",
7194
- "type": {
7195
- "text": "ButtonType"
7196
- },
7197
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
7198
- "default": "button",
7199
- "fieldName": "type"
7200
- },
7201
- {
7202
- "name": "name",
7203
- "type": {
7204
- "text": "string | undefined"
7205
- },
7206
- "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
7207
- "fieldName": "name"
7208
- },
7209
- {
7210
- "name": "value",
7211
- "type": {
7212
- "text": "string | undefined"
7213
- },
7214
- "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
7215
- "fieldName": "value"
7216
- },
7217
- {
7218
- "name": "auto-focus-on-mount",
7219
- "type": {
7220
- "text": "boolean"
7221
- },
7222
- "default": "false",
7223
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
7224
- "fieldName": "autoFocusOnMount",
7225
- "inheritedFrom": {
7226
- "name": "AutoFocusOnMountMixin",
7227
- "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
7228
- }
7229
- },
7230
- {
7231
- "name": "tabIndex",
7232
- "type": {
7233
- "text": "number"
7234
- },
7235
- "default": "0",
7236
- "description": "This property specifies the tab order of the element.",
7237
- "fieldName": "tabIndex",
7238
- "inheritedFrom": {
7239
- "name": "TabIndexMixin",
7240
- "module": "src/utils/mixins/TabIndexMixin.ts"
7241
- }
7242
- },
7243
- {
7244
- "name": "disabled",
7245
- "type": {
7246
- "text": "boolean | undefined"
7247
- },
7248
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7249
- "default": "undefined",
7250
- "fieldName": "disabled",
7251
- "inheritedFrom": {
7252
- "name": "DisabledMixin",
7253
- "module": "src/utils/mixins/DisabledMixin.ts"
7254
- }
7255
- }
7256
- ],
7257
- "mixins": [
7258
- {
7259
- "name": "AutoFocusOnMountMixin",
7260
- "module": "/src/utils/mixins/AutoFocusOnMountMixin"
7261
- },
7262
- {
7263
- "name": "TabIndexMixin",
7264
- "module": "/src/utils/mixins/TabIndexMixin"
7265
- },
7266
- {
7267
- "name": "DisabledMixin",
7268
- "module": "/src/utils/mixins/DisabledMixin"
7269
- }
7270
- ],
7271
- "superclass": {
7272
- "name": "Component",
7273
- "module": "/src/models"
7274
- },
7275
- "tagName": "mdc-buttonsimple",
7276
- "jsDoc": "/**\n * `mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\n * It is used as an internal component and is not intended to be used directly by consumers.\n * Consumers should use the `mdc-button` component instead.\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-buttonsimple\n *\n * @cssproperty --mdc-button-height - Height for button size\n * @cssproperty --mdc-button-background - Background color of the button\n * @cssproperty --mdc-button-border-color - Borer color of the button\n * @cssproperty --mdc-button-text-color - Text color of the button\n */",
7277
- "customElement": true
7278
- }
7279
- ],
7280
- "exports": [
7281
- {
7282
- "kind": "js",
7283
- "name": "default",
7284
- "declaration": {
7285
- "name": "Buttonsimple",
7286
- "module": "components/buttonsimple/buttonsimple.component.js"
7287
- }
7288
- }
7289
- ]
7290
- },
7291
- {
7292
- "kind": "javascript-module",
7293
- "path": "components/card/card.component.js",
7293
+ "path": "components/card/card.component.js",
7294
7294
  "declarations": [
7295
7295
  {
7296
7296
  "kind": "class",
@@ -23856,13 +23856,119 @@
23856
23856
  },
23857
23857
  {
23858
23858
  "kind": "javascript-module",
23859
- "path": "components/menuitem/menuitem.component.js",
23859
+ "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
23860
23860
  "declarations": [
23861
23861
  {
23862
23862
  "kind": "class",
23863
- "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\n**Note**: If a menuitem contains a long text, it is recommended to create a tooltip for the menuitem that displays the full text on hover.\nConsumers need to add a unique ID to this menuitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the menuitem using the `triggerID` attribute.",
23864
- "name": "MenuItem",
23863
+ "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
23864
+ "name": "MenuItemCheckbox",
23865
+ "cssProperties": [
23866
+ {
23867
+ "description": "Controls the padding on the left and right of the menuitemcheckbox.",
23868
+ "name": "--mdc-listitem-padding-left-and-right"
23869
+ },
23870
+ {
23871
+ "description": "Allows customization of the default background color.",
23872
+ "name": "--mdc-listitem-default-background-color",
23873
+ "inheritedFrom": {
23874
+ "name": "ListItem",
23875
+ "module": "src/components/listitem/listitem.component.ts"
23876
+ }
23877
+ },
23878
+ {
23879
+ "description": "Allows customization of the background color on hover.",
23880
+ "name": "--mdc-listitem-background-color-hover",
23881
+ "inheritedFrom": {
23882
+ "name": "ListItem",
23883
+ "module": "src/components/listitem/listitem.component.ts"
23884
+ }
23885
+ },
23886
+ {
23887
+ "description": "Allows customization of the background color when pressed.",
23888
+ "name": "--mdc-listitem-background-color-active",
23889
+ "inheritedFrom": {
23890
+ "name": "ListItem",
23891
+ "module": "src/components/listitem/listitem.component.ts"
23892
+ }
23893
+ },
23894
+ {
23895
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
23896
+ "name": "--mdc-listitem-primary-label-color",
23897
+ "inheritedFrom": {
23898
+ "name": "ListItem",
23899
+ "module": "src/components/listitem/listitem.component.ts"
23900
+ }
23901
+ },
23902
+ {
23903
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
23904
+ "name": "--mdc-listitem-secondary-label-color",
23905
+ "inheritedFrom": {
23906
+ "name": "ListItem",
23907
+ "module": "src/components/listitem/listitem.component.ts"
23908
+ }
23909
+ },
23910
+ {
23911
+ "description": "Allows customization of the disabled color.",
23912
+ "name": "--mdc-listitem-disabled-color",
23913
+ "inheritedFrom": {
23914
+ "name": "ListItem",
23915
+ "module": "src/components/listitem/listitem.component.ts"
23916
+ }
23917
+ },
23918
+ {
23919
+ "description": "Allows customization of column gap.",
23920
+ "name": "--mdc-listitem-column-gap",
23921
+ "inheritedFrom": {
23922
+ "name": "ListItem",
23923
+ "module": "src/components/listitem/listitem.component.ts"
23924
+ }
23925
+ },
23926
+ {
23927
+ "description": "Allows customization of padding left and right.",
23928
+ "name": "--mdc-listitem-padding-left-right",
23929
+ "inheritedFrom": {
23930
+ "name": "ListItem",
23931
+ "module": "src/components/listitem/listitem.component.ts"
23932
+ }
23933
+ },
23934
+ {
23935
+ "description": "Allows customization of padding top and bottom.",
23936
+ "name": "--mdc-listitem-padding-top-bottom",
23937
+ "inheritedFrom": {
23938
+ "name": "ListItem",
23939
+ "module": "src/components/listitem/listitem.component.ts"
23940
+ }
23941
+ },
23942
+ {
23943
+ "description": "Allows customization of the cursor.",
23944
+ "name": "--mdc-listitem-cursor",
23945
+ "inheritedFrom": {
23946
+ "name": "ListItem",
23947
+ "module": "src/components/listitem/listitem.component.ts"
23948
+ }
23949
+ },
23950
+ {
23951
+ "description": "Allows customization of the width of the list item.",
23952
+ "name": "--mdc-listitem-width",
23953
+ "inheritedFrom": {
23954
+ "name": "ListItem",
23955
+ "module": "src/components/listitem/listitem.component.ts"
23956
+ }
23957
+ },
23958
+ {
23959
+ "description": "Allows customization of the height of the list item.",
23960
+ "name": "--mdc-listitem-height",
23961
+ "inheritedFrom": {
23962
+ "name": "ListItem",
23963
+ "module": "src/components/listitem/listitem.component.ts"
23964
+ }
23965
+ }
23966
+ ],
23865
23967
  "cssParts": [
23968
+ {
23969
+ "description": "Allows customization of the checkmark icon.",
23970
+ "name": "checkmark-icon"
23971
+ },
23866
23972
  {
23867
23973
  "description": "Allows customization of the leading part.",
23868
23974
  "name": "leading",
@@ -23873,7 +23979,11 @@
23873
23979
  },
23874
23980
  {
23875
23981
  "description": "Allows customization of leading arrow icon.",
23876
- "name": "leading-arrow"
23982
+ "name": "leading-arrow",
23983
+ "inheritedFrom": {
23984
+ "name": "MenuItem",
23985
+ "module": "src/components/menuitem/menuitem.component.ts"
23986
+ }
23877
23987
  },
23878
23988
  {
23879
23989
  "description": "Allows customization of the leading text part.",
@@ -23893,7 +24003,11 @@
23893
24003
  },
23894
24004
  {
23895
24005
  "description": "Allows customization of trailing arrow icon.",
23896
- "name": "trailing-arrow"
24006
+ "name": "trailing-arrow",
24007
+ "inheritedFrom": {
24008
+ "name": "MenuItem",
24009
+ "module": "src/components/menuitem/menuitem.component.ts"
24010
+ }
23897
24011
  },
23898
24012
  {
23899
24013
  "description": "Allows customization of the trailing text part.",
@@ -23906,7 +24020,7 @@
23906
24020
  ],
23907
24021
  "slots": [
23908
24022
  {
23909
- "description": "slot for menu item controls to appear of leading end.",
24023
+ "description": "slot for menu item checkbox controls to appear of leading end.",
23910
24024
  "name": "leading-controls",
23911
24025
  "inheritedFrom": {
23912
24026
  "name": "ListItem",
@@ -23914,7 +24028,7 @@
23914
24028
  }
23915
24029
  },
23916
24030
  {
23917
- "description": "slot for menu item primary label.",
24031
+ "description": "slot for menu item checkbox primary label.",
23918
24032
  "name": "leading-text-primary-label",
23919
24033
  "inheritedFrom": {
23920
24034
  "name": "ListItem",
@@ -23922,7 +24036,7 @@
23922
24036
  }
23923
24037
  },
23924
24038
  {
23925
- "description": "slot for menu item secondary label.",
24039
+ "description": "slot for menu item checkbox secondary label.",
23926
24040
  "name": "leading-text-secondary-label",
23927
24041
  "inheritedFrom": {
23928
24042
  "name": "ListItem",
@@ -23930,7 +24044,7 @@
23930
24044
  }
23931
24045
  },
23932
24046
  {
23933
- "description": "slot for menu item tertiary label.",
24047
+ "description": "slot for menu item checkbox tertiary label.",
23934
24048
  "name": "leading-text-tertiary-label",
23935
24049
  "inheritedFrom": {
23936
24050
  "name": "ListItem",
@@ -23938,7 +24052,7 @@
23938
24052
  }
23939
24053
  },
23940
24054
  {
23941
- "description": "slot for menu item side header text.",
24055
+ "description": "slot for menu item checkbox side header text.",
23942
24056
  "name": "trailing-text-side-header",
23943
24057
  "inheritedFrom": {
23944
24058
  "name": "ListItem",
@@ -23946,7 +24060,7 @@
23946
24060
  }
23947
24061
  },
23948
24062
  {
23949
- "description": "slot for menu item subline text.",
24063
+ "description": "slot for menu item checkbox subline text.",
23950
24064
  "name": "trailing-text-subline",
23951
24065
  "inheritedFrom": {
23952
24066
  "name": "ListItem",
@@ -23954,7 +24068,7 @@
23954
24068
  }
23955
24069
  },
23956
24070
  {
23957
- "description": "slot for menu item controls to appear of trailing end.",
24071
+ "description": "slot for menu item checkbox controls to appear of trailing end.",
23958
24072
  "name": "trailing-controls",
23959
24073
  "inheritedFrom": {
23960
24074
  "name": "ListItem",
@@ -23971,6 +24085,93 @@
23971
24085
  }
23972
24086
  ],
23973
24087
  "members": [
24088
+ {
24089
+ "kind": "field",
24090
+ "name": "checked",
24091
+ "type": {
24092
+ "text": "boolean"
24093
+ },
24094
+ "default": "false",
24095
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
24096
+ "attribute": "checked",
24097
+ "reflects": true
24098
+ },
24099
+ {
24100
+ "kind": "field",
24101
+ "name": "indicator",
24102
+ "type": {
24103
+ "text": "Indicator"
24104
+ },
24105
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
24106
+ "default": "'checkbox'",
24107
+ "attribute": "indicator",
24108
+ "reflects": true
24109
+ },
24110
+ {
24111
+ "kind": "method",
24112
+ "name": "handleMouseClick",
24113
+ "privacy": "private",
24114
+ "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled or soft-disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles checked if uncontrolled, and dispatches the 'change' event."
24115
+ },
24116
+ {
24117
+ "kind": "method",
24118
+ "name": "staticCheckbox",
24119
+ "privacy": "private",
24120
+ "return": {
24121
+ "type": {
24122
+ "text": ""
24123
+ }
24124
+ },
24125
+ "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
24126
+ },
24127
+ {
24128
+ "kind": "method",
24129
+ "name": "staticToggle",
24130
+ "privacy": "private",
24131
+ "return": {
24132
+ "type": {
24133
+ "text": ""
24134
+ }
24135
+ },
24136
+ "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
24137
+ },
24138
+ {
24139
+ "kind": "method",
24140
+ "name": "getCheckmarkIcon",
24141
+ "privacy": "private",
24142
+ "return": {
24143
+ "type": {
24144
+ "text": ""
24145
+ }
24146
+ },
24147
+ "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
24148
+ },
24149
+ {
24150
+ "kind": "field",
24151
+ "name": "controlTypeProviderContext",
24152
+ "privacy": "private",
24153
+ "readonly": true,
24154
+ "inheritedFrom": {
24155
+ "name": "ControlTypeMixin",
24156
+ "module": "utils/mixins/ControlTypeMixin.js"
24157
+ }
24158
+ },
24159
+ {
24160
+ "kind": "field",
24161
+ "name": "controlType",
24162
+ "type": {
24163
+ "text": "ControlType | undefined"
24164
+ },
24165
+ "privacy": "public",
24166
+ "description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
24167
+ "default": "undefined",
24168
+ "attribute": "control-type",
24169
+ "reflects": true,
24170
+ "inheritedFrom": {
24171
+ "name": "ControlTypeMixin",
24172
+ "module": "utils/mixins/ControlTypeMixin.js"
24173
+ }
24174
+ },
23974
24175
  {
23975
24176
  "kind": "field",
23976
24177
  "name": "arrowPosition",
@@ -23979,7 +24180,11 @@
23979
24180
  },
23980
24181
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
23981
24182
  "attribute": "arrow-position",
23982
- "reflects": true
24183
+ "reflects": true,
24184
+ "inheritedFrom": {
24185
+ "name": "MenuItem",
24186
+ "module": "components/menuitem/menuitem.component.js"
24187
+ }
23983
24188
  },
23984
24189
  {
23985
24190
  "kind": "field",
@@ -23989,7 +24194,11 @@
23989
24194
  },
23990
24195
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
23991
24196
  "attribute": "arrow-direction",
23992
- "reflects": true
24197
+ "reflects": true,
24198
+ "inheritedFrom": {
24199
+ "name": "MenuItem",
24200
+ "module": "components/menuitem/menuitem.component.js"
24201
+ }
23993
24202
  },
23994
24203
  {
23995
24204
  "kind": "field",
@@ -23999,7 +24208,11 @@
23999
24208
  },
24000
24209
  "description": "The name attribute is used to identify the menu item when it is selected.",
24001
24210
  "attribute": "name",
24002
- "reflects": true
24211
+ "reflects": true,
24212
+ "inheritedFrom": {
24213
+ "name": "MenuItem",
24214
+ "module": "components/menuitem/menuitem.component.js"
24215
+ }
24003
24216
  },
24004
24217
  {
24005
24218
  "kind": "field",
@@ -24009,7 +24222,11 @@
24009
24222
  },
24010
24223
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
24011
24224
  "attribute": "value",
24012
- "reflects": true
24225
+ "reflects": true,
24226
+ "inheritedFrom": {
24227
+ "name": "MenuItem",
24228
+ "module": "components/menuitem/menuitem.component.js"
24229
+ }
24013
24230
  },
24014
24231
  {
24015
24232
  "kind": "method",
@@ -24053,7 +24270,11 @@
24053
24270
  "description": "The keyboard event that triggered the action."
24054
24271
  }
24055
24272
  ],
24056
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
24273
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
24274
+ "inheritedFrom": {
24275
+ "name": "MenuItem",
24276
+ "module": "components/menuitem/menuitem.component.js"
24277
+ }
24057
24278
  },
24058
24279
  {
24059
24280
  "kind": "method",
@@ -24384,7 +24605,15 @@
24384
24605
  ],
24385
24606
  "events": [
24386
24607
  {
24387
- "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
24608
+ "name": "change",
24609
+ "type": {
24610
+ "text": "Event"
24611
+ },
24612
+ "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
24613
+ "reactName": "onChange"
24614
+ },
24615
+ {
24616
+ "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
24388
24617
  "name": "click",
24389
24618
  "reactName": "onClick",
24390
24619
  "inheritedFrom": {
@@ -24393,27 +24622,27 @@
24393
24622
  }
24394
24623
  },
24395
24624
  {
24396
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
24397
- "name": "keydown",
24398
- "reactName": "onKeyDown",
24625
+ "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
24626
+ "name": "focus",
24627
+ "reactName": "onFocus",
24399
24628
  "inheritedFrom": {
24400
24629
  "name": "ListItem",
24401
24630
  "module": "src/components/listitem/listitem.component.ts"
24402
24631
  }
24403
24632
  },
24404
24633
  {
24405
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
24406
- "name": "keyup",
24407
- "reactName": "onKeyUp",
24634
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
24635
+ "name": "keydown",
24636
+ "reactName": "onKeyDown",
24408
24637
  "inheritedFrom": {
24409
24638
  "name": "ListItem",
24410
24639
  "module": "src/components/listitem/listitem.component.ts"
24411
24640
  }
24412
24641
  },
24413
24642
  {
24414
- "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
24415
- "name": "focus",
24416
- "reactName": "onFocus",
24643
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
24644
+ "name": "keyup",
24645
+ "reactName": "onKeyUp",
24417
24646
  "inheritedFrom": {
24418
24647
  "name": "ListItem",
24419
24648
  "module": "src/components/listitem/listitem.component.ts"
@@ -24457,13 +24686,48 @@
24457
24686
  }
24458
24687
  ],
24459
24688
  "attributes": [
24689
+ {
24690
+ "name": "checked",
24691
+ "type": {
24692
+ "text": "boolean"
24693
+ },
24694
+ "default": "false",
24695
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
24696
+ "fieldName": "checked"
24697
+ },
24698
+ {
24699
+ "name": "indicator",
24700
+ "type": {
24701
+ "text": "Indicator"
24702
+ },
24703
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
24704
+ "default": "'checkbox'",
24705
+ "fieldName": "indicator"
24706
+ },
24707
+ {
24708
+ "name": "control-type",
24709
+ "type": {
24710
+ "text": "ControlType | undefined"
24711
+ },
24712
+ "description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
24713
+ "default": "undefined",
24714
+ "fieldName": "controlType",
24715
+ "inheritedFrom": {
24716
+ "name": "ControlTypeMixin",
24717
+ "module": "src/utils/mixins/ControlTypeMixin.ts"
24718
+ }
24719
+ },
24460
24720
  {
24461
24721
  "name": "arrow-position",
24462
24722
  "type": {
24463
24723
  "text": "ArrowPositions | undefined"
24464
24724
  },
24465
24725
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
24466
- "fieldName": "arrowPosition"
24726
+ "fieldName": "arrowPosition",
24727
+ "inheritedFrom": {
24728
+ "name": "MenuItem",
24729
+ "module": "src/components/menuitem/menuitem.component.ts"
24730
+ }
24467
24731
  },
24468
24732
  {
24469
24733
  "name": "arrow-direction",
@@ -24471,7 +24735,11 @@
24471
24735
  "text": "ArrowDirections | undefined"
24472
24736
  },
24473
24737
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
24474
- "fieldName": "arrowDirection"
24738
+ "fieldName": "arrowDirection",
24739
+ "inheritedFrom": {
24740
+ "name": "MenuItem",
24741
+ "module": "src/components/menuitem/menuitem.component.ts"
24742
+ }
24475
24743
  },
24476
24744
  {
24477
24745
  "name": "name",
@@ -24479,7 +24747,11 @@
24479
24747
  "text": "string | undefined"
24480
24748
  },
24481
24749
  "description": "The name attribute is used to identify the menu item when it is selected.",
24482
- "fieldName": "name"
24750
+ "fieldName": "name",
24751
+ "inheritedFrom": {
24752
+ "name": "MenuItem",
24753
+ "module": "src/components/menuitem/menuitem.component.ts"
24754
+ }
24483
24755
  },
24484
24756
  {
24485
24757
  "name": "value",
@@ -24487,7 +24759,11 @@
24487
24759
  "text": "string | undefined"
24488
24760
  },
24489
24761
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
24490
- "fieldName": "value"
24762
+ "fieldName": "value",
24763
+ "inheritedFrom": {
24764
+ "name": "MenuItem",
24765
+ "module": "src/components/menuitem/menuitem.component.ts"
24766
+ }
24491
24767
  },
24492
24768
  {
24493
24769
  "name": "disabled",
@@ -24628,111 +24904,19 @@
24628
24904
  }
24629
24905
  }
24630
24906
  ],
24631
- "superclass": {
24632
- "name": "ListItem",
24633
- "module": "/src/components/listitem/listitem.component"
24634
- },
24635
- "tagName": "mdc-menuitem",
24636
- "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * **Note**: If a menuitem contains a long text, it is recommended to create a tooltip for the menuitem that displays the full text on hover.\n * Consumers need to add a unique ID to this menuitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the menuitem using the `triggerID` attribute.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n * @event enabled - (React: onEnabled) This event is dispatched after the menuitem is enabled\n * @event disabled - (React: onDisabled) This event is dispatched after the menuitem is disabled\n * @event created - (React: onCreated) This event is dispatched after the menuitem is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched after the menuitem is destroyed (removed from the DOM)\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-arrow - Allows customization of leading arrow icon.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-arrow - Allows customization of trailing arrow icon.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
24637
- "customElement": true,
24638
- "cssProperties": [
24639
- {
24640
- "description": "Allows customization of the default background color.",
24641
- "name": "--mdc-listitem-default-background-color",
24642
- "inheritedFrom": {
24643
- "name": "ListItem",
24644
- "module": "src/components/listitem/listitem.component.ts"
24645
- }
24646
- },
24647
- {
24648
- "description": "Allows customization of the background color on hover.",
24649
- "name": "--mdc-listitem-background-color-hover",
24650
- "inheritedFrom": {
24651
- "name": "ListItem",
24652
- "module": "src/components/listitem/listitem.component.ts"
24653
- }
24654
- },
24655
- {
24656
- "description": "Allows customization of the background color when pressed.",
24657
- "name": "--mdc-listitem-background-color-active",
24658
- "inheritedFrom": {
24659
- "name": "ListItem",
24660
- "module": "src/components/listitem/listitem.component.ts"
24661
- }
24662
- },
24663
- {
24664
- "description": "Allows customization of the primary label, side header and subline text slot color.",
24665
- "name": "--mdc-listitem-primary-label-color",
24666
- "inheritedFrom": {
24667
- "name": "ListItem",
24668
- "module": "src/components/listitem/listitem.component.ts"
24669
- }
24670
- },
24671
- {
24672
- "description": "Allows customization of the secondary and tertiary label text slot color.",
24673
- "name": "--mdc-listitem-secondary-label-color",
24674
- "inheritedFrom": {
24675
- "name": "ListItem",
24676
- "module": "src/components/listitem/listitem.component.ts"
24677
- }
24678
- },
24679
- {
24680
- "description": "Allows customization of the disabled color.",
24681
- "name": "--mdc-listitem-disabled-color",
24682
- "inheritedFrom": {
24683
- "name": "ListItem",
24684
- "module": "src/components/listitem/listitem.component.ts"
24685
- }
24686
- },
24687
- {
24688
- "description": "Allows customization of column gap.",
24689
- "name": "--mdc-listitem-column-gap",
24690
- "inheritedFrom": {
24691
- "name": "ListItem",
24692
- "module": "src/components/listitem/listitem.component.ts"
24693
- }
24694
- },
24695
- {
24696
- "description": "Allows customization of padding left and right.",
24697
- "name": "--mdc-listitem-padding-left-right",
24698
- "inheritedFrom": {
24699
- "name": "ListItem",
24700
- "module": "src/components/listitem/listitem.component.ts"
24701
- }
24702
- },
24703
- {
24704
- "description": "Allows customization of padding top and bottom.",
24705
- "name": "--mdc-listitem-padding-top-bottom",
24706
- "inheritedFrom": {
24707
- "name": "ListItem",
24708
- "module": "src/components/listitem/listitem.component.ts"
24709
- }
24710
- },
24711
- {
24712
- "description": "Allows customization of the cursor.",
24713
- "name": "--mdc-listitem-cursor",
24714
- "inheritedFrom": {
24715
- "name": "ListItem",
24716
- "module": "src/components/listitem/listitem.component.ts"
24717
- }
24718
- },
24719
- {
24720
- "description": "Allows customization of the width of the list item.",
24721
- "name": "--mdc-listitem-width",
24722
- "inheritedFrom": {
24723
- "name": "ListItem",
24724
- "module": "src/components/listitem/listitem.component.ts"
24725
- }
24726
- },
24907
+ "mixins": [
24727
24908
  {
24728
- "description": "Allows customization of the height of the list item.",
24729
- "name": "--mdc-listitem-height",
24730
- "inheritedFrom": {
24731
- "name": "ListItem",
24732
- "module": "src/components/listitem/listitem.component.ts"
24733
- }
24909
+ "name": "ControlTypeMixin",
24910
+ "module": "/src/utils/mixins/ControlTypeMixin"
24734
24911
  }
24735
- ]
24912
+ ],
24913
+ "superclass": {
24914
+ "name": "MenuItem",
24915
+ "module": "/src/components/menuitem/menuitem.component"
24916
+ },
24917
+ "tagName": "mdc-menuitemcheckbox",
24918
+ "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n *\n * @cssproperty --mdc-listitem-padding-left-and-right - Controls the padding on the left and right of the menuitemcheckbox.\n *\n * @csspart checkmark-icon - Allows customization of the checkmark icon.\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-arrow - Allows customization of leading arrow icon.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-arrow - Allows customization of trailing arrow icon.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
24919
+ "customElement": true
24736
24920
  }
24737
24921
  ],
24738
24922
  "exports": [
@@ -24740,127 +24924,21 @@
24740
24924
  "kind": "js",
24741
24925
  "name": "default",
24742
24926
  "declaration": {
24743
- "name": "MenuItem",
24744
- "module": "components/menuitem/menuitem.component.js"
24927
+ "name": "MenuItemCheckbox",
24928
+ "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
24745
24929
  }
24746
24930
  }
24747
24931
  ]
24748
24932
  },
24749
24933
  {
24750
24934
  "kind": "javascript-module",
24751
- "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
24935
+ "path": "components/menuitem/menuitem.component.js",
24752
24936
  "declarations": [
24753
24937
  {
24754
24938
  "kind": "class",
24755
- "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
24756
- "name": "MenuItemCheckbox",
24757
- "cssProperties": [
24758
- {
24759
- "description": "Controls the padding on the left and right of the menuitemcheckbox.",
24760
- "name": "--mdc-listitem-padding-left-and-right"
24761
- },
24762
- {
24763
- "description": "Allows customization of the default background color.",
24764
- "name": "--mdc-listitem-default-background-color",
24765
- "inheritedFrom": {
24766
- "name": "ListItem",
24767
- "module": "src/components/listitem/listitem.component.ts"
24768
- }
24769
- },
24770
- {
24771
- "description": "Allows customization of the background color on hover.",
24772
- "name": "--mdc-listitem-background-color-hover",
24773
- "inheritedFrom": {
24774
- "name": "ListItem",
24775
- "module": "src/components/listitem/listitem.component.ts"
24776
- }
24777
- },
24778
- {
24779
- "description": "Allows customization of the background color when pressed.",
24780
- "name": "--mdc-listitem-background-color-active",
24781
- "inheritedFrom": {
24782
- "name": "ListItem",
24783
- "module": "src/components/listitem/listitem.component.ts"
24784
- }
24785
- },
24786
- {
24787
- "description": "Allows customization of the primary label, side header and subline text slot color.",
24788
- "name": "--mdc-listitem-primary-label-color",
24789
- "inheritedFrom": {
24790
- "name": "ListItem",
24791
- "module": "src/components/listitem/listitem.component.ts"
24792
- }
24793
- },
24794
- {
24795
- "description": "Allows customization of the secondary and tertiary label text slot color.",
24796
- "name": "--mdc-listitem-secondary-label-color",
24797
- "inheritedFrom": {
24798
- "name": "ListItem",
24799
- "module": "src/components/listitem/listitem.component.ts"
24800
- }
24801
- },
24802
- {
24803
- "description": "Allows customization of the disabled color.",
24804
- "name": "--mdc-listitem-disabled-color",
24805
- "inheritedFrom": {
24806
- "name": "ListItem",
24807
- "module": "src/components/listitem/listitem.component.ts"
24808
- }
24809
- },
24810
- {
24811
- "description": "Allows customization of column gap.",
24812
- "name": "--mdc-listitem-column-gap",
24813
- "inheritedFrom": {
24814
- "name": "ListItem",
24815
- "module": "src/components/listitem/listitem.component.ts"
24816
- }
24817
- },
24818
- {
24819
- "description": "Allows customization of padding left and right.",
24820
- "name": "--mdc-listitem-padding-left-right",
24821
- "inheritedFrom": {
24822
- "name": "ListItem",
24823
- "module": "src/components/listitem/listitem.component.ts"
24824
- }
24825
- },
24826
- {
24827
- "description": "Allows customization of padding top and bottom.",
24828
- "name": "--mdc-listitem-padding-top-bottom",
24829
- "inheritedFrom": {
24830
- "name": "ListItem",
24831
- "module": "src/components/listitem/listitem.component.ts"
24832
- }
24833
- },
24834
- {
24835
- "description": "Allows customization of the cursor.",
24836
- "name": "--mdc-listitem-cursor",
24837
- "inheritedFrom": {
24838
- "name": "ListItem",
24839
- "module": "src/components/listitem/listitem.component.ts"
24840
- }
24841
- },
24842
- {
24843
- "description": "Allows customization of the width of the list item.",
24844
- "name": "--mdc-listitem-width",
24845
- "inheritedFrom": {
24846
- "name": "ListItem",
24847
- "module": "src/components/listitem/listitem.component.ts"
24848
- }
24849
- },
24850
- {
24851
- "description": "Allows customization of the height of the list item.",
24852
- "name": "--mdc-listitem-height",
24853
- "inheritedFrom": {
24854
- "name": "ListItem",
24855
- "module": "src/components/listitem/listitem.component.ts"
24856
- }
24857
- }
24858
- ],
24939
+ "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\n**Note**: If a menuitem contains a long text, it is recommended to create a tooltip for the menuitem that displays the full text on hover.\nConsumers need to add a unique ID to this menuitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the menuitem using the `triggerID` attribute.",
24940
+ "name": "MenuItem",
24859
24941
  "cssParts": [
24860
- {
24861
- "description": "Allows customization of the checkmark icon.",
24862
- "name": "checkmark-icon"
24863
- },
24864
24942
  {
24865
24943
  "description": "Allows customization of the leading part.",
24866
24944
  "name": "leading",
@@ -24871,11 +24949,7 @@
24871
24949
  },
24872
24950
  {
24873
24951
  "description": "Allows customization of leading arrow icon.",
24874
- "name": "leading-arrow",
24875
- "inheritedFrom": {
24876
- "name": "MenuItem",
24877
- "module": "src/components/menuitem/menuitem.component.ts"
24878
- }
24952
+ "name": "leading-arrow"
24879
24953
  },
24880
24954
  {
24881
24955
  "description": "Allows customization of the leading text part.",
@@ -24895,11 +24969,7 @@
24895
24969
  },
24896
24970
  {
24897
24971
  "description": "Allows customization of trailing arrow icon.",
24898
- "name": "trailing-arrow",
24899
- "inheritedFrom": {
24900
- "name": "MenuItem",
24901
- "module": "src/components/menuitem/menuitem.component.ts"
24902
- }
24972
+ "name": "trailing-arrow"
24903
24973
  },
24904
24974
  {
24905
24975
  "description": "Allows customization of the trailing text part.",
@@ -24912,7 +24982,7 @@
24912
24982
  ],
24913
24983
  "slots": [
24914
24984
  {
24915
- "description": "slot for menu item checkbox controls to appear of leading end.",
24985
+ "description": "slot for menu item controls to appear of leading end.",
24916
24986
  "name": "leading-controls",
24917
24987
  "inheritedFrom": {
24918
24988
  "name": "ListItem",
@@ -24920,7 +24990,7 @@
24920
24990
  }
24921
24991
  },
24922
24992
  {
24923
- "description": "slot for menu item checkbox primary label.",
24993
+ "description": "slot for menu item primary label.",
24924
24994
  "name": "leading-text-primary-label",
24925
24995
  "inheritedFrom": {
24926
24996
  "name": "ListItem",
@@ -24928,7 +24998,7 @@
24928
24998
  }
24929
24999
  },
24930
25000
  {
24931
- "description": "slot for menu item checkbox secondary label.",
25001
+ "description": "slot for menu item secondary label.",
24932
25002
  "name": "leading-text-secondary-label",
24933
25003
  "inheritedFrom": {
24934
25004
  "name": "ListItem",
@@ -24936,7 +25006,7 @@
24936
25006
  }
24937
25007
  },
24938
25008
  {
24939
- "description": "slot for menu item checkbox tertiary label.",
25009
+ "description": "slot for menu item tertiary label.",
24940
25010
  "name": "leading-text-tertiary-label",
24941
25011
  "inheritedFrom": {
24942
25012
  "name": "ListItem",
@@ -24944,7 +25014,7 @@
24944
25014
  }
24945
25015
  },
24946
25016
  {
24947
- "description": "slot for menu item checkbox side header text.",
25017
+ "description": "slot for menu item side header text.",
24948
25018
  "name": "trailing-text-side-header",
24949
25019
  "inheritedFrom": {
24950
25020
  "name": "ListItem",
@@ -24952,7 +25022,7 @@
24952
25022
  }
24953
25023
  },
24954
25024
  {
24955
- "description": "slot for menu item checkbox subline text.",
25025
+ "description": "slot for menu item subline text.",
24956
25026
  "name": "trailing-text-subline",
24957
25027
  "inheritedFrom": {
24958
25028
  "name": "ListItem",
@@ -24960,7 +25030,7 @@
24960
25030
  }
24961
25031
  },
24962
25032
  {
24963
- "description": "slot for menu item checkbox controls to appear of trailing end.",
25033
+ "description": "slot for menu item controls to appear of trailing end.",
24964
25034
  "name": "trailing-controls",
24965
25035
  "inheritedFrom": {
24966
25036
  "name": "ListItem",
@@ -24977,93 +25047,6 @@
24977
25047
  }
24978
25048
  ],
24979
25049
  "members": [
24980
- {
24981
- "kind": "field",
24982
- "name": "checked",
24983
- "type": {
24984
- "text": "boolean"
24985
- },
24986
- "default": "false",
24987
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
24988
- "attribute": "checked",
24989
- "reflects": true
24990
- },
24991
- {
24992
- "kind": "field",
24993
- "name": "indicator",
24994
- "type": {
24995
- "text": "Indicator"
24996
- },
24997
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
24998
- "default": "'checkbox'",
24999
- "attribute": "indicator",
25000
- "reflects": true
25001
- },
25002
- {
25003
- "kind": "method",
25004
- "name": "handleMouseClick",
25005
- "privacy": "private",
25006
- "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled or soft-disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles checked if uncontrolled, and dispatches the 'change' event."
25007
- },
25008
- {
25009
- "kind": "method",
25010
- "name": "staticCheckbox",
25011
- "privacy": "private",
25012
- "return": {
25013
- "type": {
25014
- "text": ""
25015
- }
25016
- },
25017
- "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
25018
- },
25019
- {
25020
- "kind": "method",
25021
- "name": "staticToggle",
25022
- "privacy": "private",
25023
- "return": {
25024
- "type": {
25025
- "text": ""
25026
- }
25027
- },
25028
- "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
25029
- },
25030
- {
25031
- "kind": "method",
25032
- "name": "getCheckmarkIcon",
25033
- "privacy": "private",
25034
- "return": {
25035
- "type": {
25036
- "text": ""
25037
- }
25038
- },
25039
- "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
25040
- },
25041
- {
25042
- "kind": "field",
25043
- "name": "controlTypeProviderContext",
25044
- "privacy": "private",
25045
- "readonly": true,
25046
- "inheritedFrom": {
25047
- "name": "ControlTypeMixin",
25048
- "module": "utils/mixins/ControlTypeMixin.js"
25049
- }
25050
- },
25051
- {
25052
- "kind": "field",
25053
- "name": "controlType",
25054
- "type": {
25055
- "text": "ControlType | undefined"
25056
- },
25057
- "privacy": "public",
25058
- "description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
25059
- "default": "undefined",
25060
- "attribute": "control-type",
25061
- "reflects": true,
25062
- "inheritedFrom": {
25063
- "name": "ControlTypeMixin",
25064
- "module": "utils/mixins/ControlTypeMixin.js"
25065
- }
25066
- },
25067
25050
  {
25068
25051
  "kind": "field",
25069
25052
  "name": "arrowPosition",
@@ -25072,11 +25055,7 @@
25072
25055
  },
25073
25056
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
25074
25057
  "attribute": "arrow-position",
25075
- "reflects": true,
25076
- "inheritedFrom": {
25077
- "name": "MenuItem",
25078
- "module": "components/menuitem/menuitem.component.js"
25079
- }
25058
+ "reflects": true
25080
25059
  },
25081
25060
  {
25082
25061
  "kind": "field",
@@ -25086,11 +25065,7 @@
25086
25065
  },
25087
25066
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
25088
25067
  "attribute": "arrow-direction",
25089
- "reflects": true,
25090
- "inheritedFrom": {
25091
- "name": "MenuItem",
25092
- "module": "components/menuitem/menuitem.component.js"
25093
- }
25068
+ "reflects": true
25094
25069
  },
25095
25070
  {
25096
25071
  "kind": "field",
@@ -25100,11 +25075,7 @@
25100
25075
  },
25101
25076
  "description": "The name attribute is used to identify the menu item when it is selected.",
25102
25077
  "attribute": "name",
25103
- "reflects": true,
25104
- "inheritedFrom": {
25105
- "name": "MenuItem",
25106
- "module": "components/menuitem/menuitem.component.js"
25107
- }
25078
+ "reflects": true
25108
25079
  },
25109
25080
  {
25110
25081
  "kind": "field",
@@ -25114,11 +25085,7 @@
25114
25085
  },
25115
25086
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
25116
25087
  "attribute": "value",
25117
- "reflects": true,
25118
- "inheritedFrom": {
25119
- "name": "MenuItem",
25120
- "module": "components/menuitem/menuitem.component.js"
25121
- }
25088
+ "reflects": true
25122
25089
  },
25123
25090
  {
25124
25091
  "kind": "method",
@@ -25162,11 +25129,7 @@
25162
25129
  "description": "The keyboard event that triggered the action."
25163
25130
  }
25164
25131
  ],
25165
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
25166
- "inheritedFrom": {
25167
- "name": "MenuItem",
25168
- "module": "components/menuitem/menuitem.component.js"
25169
- }
25132
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
25170
25133
  },
25171
25134
  {
25172
25135
  "kind": "method",
@@ -25497,15 +25460,7 @@
25497
25460
  ],
25498
25461
  "events": [
25499
25462
  {
25500
- "name": "change",
25501
- "type": {
25502
- "text": "Event"
25503
- },
25504
- "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
25505
- "reactName": "onChange"
25506
- },
25507
- {
25508
- "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
25463
+ "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
25509
25464
  "name": "click",
25510
25465
  "reactName": "onClick",
25511
25466
  "inheritedFrom": {
@@ -25513,15 +25468,6 @@
25513
25468
  "module": "src/components/listitem/listitem.component.ts"
25514
25469
  }
25515
25470
  },
25516
- {
25517
- "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
25518
- "name": "focus",
25519
- "reactName": "onFocus",
25520
- "inheritedFrom": {
25521
- "name": "ListItem",
25522
- "module": "src/components/listitem/listitem.component.ts"
25523
- }
25524
- },
25525
25471
  {
25526
25472
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
25527
25473
  "name": "keydown",
@@ -25540,6 +25486,15 @@
25540
25486
  "module": "src/components/listitem/listitem.component.ts"
25541
25487
  }
25542
25488
  },
25489
+ {
25490
+ "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
25491
+ "name": "focus",
25492
+ "reactName": "onFocus",
25493
+ "inheritedFrom": {
25494
+ "name": "ListItem",
25495
+ "module": "src/components/listitem/listitem.component.ts"
25496
+ }
25497
+ },
25543
25498
  {
25544
25499
  "description": "(React: onEnabled) This event is dispatched after the menuitem is enabled",
25545
25500
  "name": "enabled",
@@ -25578,48 +25533,13 @@
25578
25533
  }
25579
25534
  ],
25580
25535
  "attributes": [
25581
- {
25582
- "name": "checked",
25583
- "type": {
25584
- "text": "boolean"
25585
- },
25586
- "default": "false",
25587
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
25588
- "fieldName": "checked"
25589
- },
25590
- {
25591
- "name": "indicator",
25592
- "type": {
25593
- "text": "Indicator"
25594
- },
25595
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
25596
- "default": "'checkbox'",
25597
- "fieldName": "indicator"
25598
- },
25599
- {
25600
- "name": "control-type",
25601
- "type": {
25602
- "text": "ControlType | undefined"
25603
- },
25604
- "description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
25605
- "default": "undefined",
25606
- "fieldName": "controlType",
25607
- "inheritedFrom": {
25608
- "name": "ControlTypeMixin",
25609
- "module": "src/utils/mixins/ControlTypeMixin.ts"
25610
- }
25611
- },
25612
25536
  {
25613
25537
  "name": "arrow-position",
25614
25538
  "type": {
25615
25539
  "text": "ArrowPositions | undefined"
25616
25540
  },
25617
25541
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
25618
- "fieldName": "arrowPosition",
25619
- "inheritedFrom": {
25620
- "name": "MenuItem",
25621
- "module": "src/components/menuitem/menuitem.component.ts"
25622
- }
25542
+ "fieldName": "arrowPosition"
25623
25543
  },
25624
25544
  {
25625
25545
  "name": "arrow-direction",
@@ -25627,11 +25547,7 @@
25627
25547
  "text": "ArrowDirections | undefined"
25628
25548
  },
25629
25549
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
25630
- "fieldName": "arrowDirection",
25631
- "inheritedFrom": {
25632
- "name": "MenuItem",
25633
- "module": "src/components/menuitem/menuitem.component.ts"
25634
- }
25550
+ "fieldName": "arrowDirection"
25635
25551
  },
25636
25552
  {
25637
25553
  "name": "name",
@@ -25639,11 +25555,7 @@
25639
25555
  "text": "string | undefined"
25640
25556
  },
25641
25557
  "description": "The name attribute is used to identify the menu item when it is selected.",
25642
- "fieldName": "name",
25643
- "inheritedFrom": {
25644
- "name": "MenuItem",
25645
- "module": "src/components/menuitem/menuitem.component.ts"
25646
- }
25558
+ "fieldName": "name"
25647
25559
  },
25648
25560
  {
25649
25561
  "name": "value",
@@ -25651,11 +25563,7 @@
25651
25563
  "text": "string | undefined"
25652
25564
  },
25653
25565
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
25654
- "fieldName": "value",
25655
- "inheritedFrom": {
25656
- "name": "MenuItem",
25657
- "module": "src/components/menuitem/menuitem.component.ts"
25658
- }
25566
+ "fieldName": "value"
25659
25567
  },
25660
25568
  {
25661
25569
  "name": "disabled",
@@ -25796,19 +25704,111 @@
25796
25704
  }
25797
25705
  }
25798
25706
  ],
25799
- "mixins": [
25800
- {
25801
- "name": "ControlTypeMixin",
25802
- "module": "/src/utils/mixins/ControlTypeMixin"
25803
- }
25804
- ],
25805
25707
  "superclass": {
25806
- "name": "MenuItem",
25807
- "module": "/src/components/menuitem/menuitem.component"
25708
+ "name": "ListItem",
25709
+ "module": "/src/components/listitem/listitem.component"
25808
25710
  },
25809
- "tagName": "mdc-menuitemcheckbox",
25810
- "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n *\n * @cssproperty --mdc-listitem-padding-left-and-right - Controls the padding on the left and right of the menuitemcheckbox.\n *\n * @csspart checkmark-icon - Allows customization of the checkmark icon.\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-arrow - Allows customization of leading arrow icon.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-arrow - Allows customization of trailing arrow icon.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
25811
- "customElement": true
25711
+ "tagName": "mdc-menuitem",
25712
+ "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * **Note**: If a menuitem contains a long text, it is recommended to create a tooltip for the menuitem that displays the full text on hover.\n * Consumers need to add a unique ID to this menuitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the menuitem using the `triggerID` attribute.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n * @event enabled - (React: onEnabled) This event is dispatched after the menuitem is enabled\n * @event disabled - (React: onDisabled) This event is dispatched after the menuitem is disabled\n * @event created - (React: onCreated) This event is dispatched after the menuitem is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched after the menuitem is destroyed (removed from the DOM)\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-arrow - Allows customization of leading arrow icon.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-arrow - Allows customization of trailing arrow icon.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
25713
+ "customElement": true,
25714
+ "cssProperties": [
25715
+ {
25716
+ "description": "Allows customization of the default background color.",
25717
+ "name": "--mdc-listitem-default-background-color",
25718
+ "inheritedFrom": {
25719
+ "name": "ListItem",
25720
+ "module": "src/components/listitem/listitem.component.ts"
25721
+ }
25722
+ },
25723
+ {
25724
+ "description": "Allows customization of the background color on hover.",
25725
+ "name": "--mdc-listitem-background-color-hover",
25726
+ "inheritedFrom": {
25727
+ "name": "ListItem",
25728
+ "module": "src/components/listitem/listitem.component.ts"
25729
+ }
25730
+ },
25731
+ {
25732
+ "description": "Allows customization of the background color when pressed.",
25733
+ "name": "--mdc-listitem-background-color-active",
25734
+ "inheritedFrom": {
25735
+ "name": "ListItem",
25736
+ "module": "src/components/listitem/listitem.component.ts"
25737
+ }
25738
+ },
25739
+ {
25740
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
25741
+ "name": "--mdc-listitem-primary-label-color",
25742
+ "inheritedFrom": {
25743
+ "name": "ListItem",
25744
+ "module": "src/components/listitem/listitem.component.ts"
25745
+ }
25746
+ },
25747
+ {
25748
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
25749
+ "name": "--mdc-listitem-secondary-label-color",
25750
+ "inheritedFrom": {
25751
+ "name": "ListItem",
25752
+ "module": "src/components/listitem/listitem.component.ts"
25753
+ }
25754
+ },
25755
+ {
25756
+ "description": "Allows customization of the disabled color.",
25757
+ "name": "--mdc-listitem-disabled-color",
25758
+ "inheritedFrom": {
25759
+ "name": "ListItem",
25760
+ "module": "src/components/listitem/listitem.component.ts"
25761
+ }
25762
+ },
25763
+ {
25764
+ "description": "Allows customization of column gap.",
25765
+ "name": "--mdc-listitem-column-gap",
25766
+ "inheritedFrom": {
25767
+ "name": "ListItem",
25768
+ "module": "src/components/listitem/listitem.component.ts"
25769
+ }
25770
+ },
25771
+ {
25772
+ "description": "Allows customization of padding left and right.",
25773
+ "name": "--mdc-listitem-padding-left-right",
25774
+ "inheritedFrom": {
25775
+ "name": "ListItem",
25776
+ "module": "src/components/listitem/listitem.component.ts"
25777
+ }
25778
+ },
25779
+ {
25780
+ "description": "Allows customization of padding top and bottom.",
25781
+ "name": "--mdc-listitem-padding-top-bottom",
25782
+ "inheritedFrom": {
25783
+ "name": "ListItem",
25784
+ "module": "src/components/listitem/listitem.component.ts"
25785
+ }
25786
+ },
25787
+ {
25788
+ "description": "Allows customization of the cursor.",
25789
+ "name": "--mdc-listitem-cursor",
25790
+ "inheritedFrom": {
25791
+ "name": "ListItem",
25792
+ "module": "src/components/listitem/listitem.component.ts"
25793
+ }
25794
+ },
25795
+ {
25796
+ "description": "Allows customization of the width of the list item.",
25797
+ "name": "--mdc-listitem-width",
25798
+ "inheritedFrom": {
25799
+ "name": "ListItem",
25800
+ "module": "src/components/listitem/listitem.component.ts"
25801
+ }
25802
+ },
25803
+ {
25804
+ "description": "Allows customization of the height of the list item.",
25805
+ "name": "--mdc-listitem-height",
25806
+ "inheritedFrom": {
25807
+ "name": "ListItem",
25808
+ "module": "src/components/listitem/listitem.component.ts"
25809
+ }
25810
+ }
25811
+ ]
25812
25812
  }
25813
25813
  ],
25814
25814
  "exports": [
@@ -25816,8 +25816,8 @@
25816
25816
  "kind": "js",
25817
25817
  "name": "default",
25818
25818
  "declaration": {
25819
- "name": "MenuItemCheckbox",
25820
- "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
25819
+ "name": "MenuItem",
25820
+ "module": "components/menuitem/menuitem.component.js"
25821
25821
  }
25822
25822
  }
25823
25823
  ]
@@ -38311,6 +38311,102 @@
38311
38311
  }
38312
38312
  ]
38313
38313
  },
38314
+ {
38315
+ "kind": "javascript-module",
38316
+ "path": "components/responsivesettingsprovider/responsivesettingsprovider.component.js",
38317
+ "declarations": [
38318
+ {
38319
+ "kind": "class",
38320
+ "description": "`mdc-responsivesettingsprovider` is a provider component that supplies responsive settings\ncontext to its child components.\n\nThis component does not make any assumptions about how the values are determined. Values can be set\nbased on media queries or other device detection mechanisms.This way consumer can mix and match\ndifferent settings depending on their target devices and use cases.\n\nFor example, when the device has table screen size/resolution, but because it is fixed dialog like\npopovers provide better user experience.\n\n## Responsive settings\n\n### Media\n\nGeneric media type to enforce responsive behavior in child components.\nConsumer component can use the media type from the context or\njust use CSS selector like [media=\"mobile\"] to apply responsive styles.\n\nIt is \"unknown\" by default so components can fall back to there default behavior.\n\n### Popover Positioning\n\nBy default, popovers are positioned close to the trigger element. But on small screens (e.g.: mobile devices),\nit is often better to show popovers/menus at the center of the screen like dialogs.\n\n### Force Fullscreen Dialog\n\nSome components like dialogs can be shown in fullscreen mode on small screens for better user experience.",
38321
+ "name": "ResponsiveSettingsProvider",
38322
+ "members": [
38323
+ {
38324
+ "kind": "field",
38325
+ "name": "Context",
38326
+ "privacy": "public",
38327
+ "static": true,
38328
+ "description": "Context object of the ResponsiveSettingsProvider, to be consumed by child components",
38329
+ "readonly": true
38330
+ },
38331
+ {
38332
+ "kind": "field",
38333
+ "name": "forceFullscreenDialog",
38334
+ "type": {
38335
+ "text": "boolean"
38336
+ },
38337
+ "description": "Determines whether dialogs should be forced to fullscreen mode.",
38338
+ "attribute": "force-fullscreen-dialog",
38339
+ "reflects": true
38340
+ },
38341
+ {
38342
+ "kind": "field",
38343
+ "name": "popoverPositioning",
38344
+ "description": "The popover positioning for responsive settings.",
38345
+ "default": "'float'",
38346
+ "attribute": "popover-positioning",
38347
+ "reflects": true
38348
+ },
38349
+ {
38350
+ "kind": "field",
38351
+ "name": "media",
38352
+ "description": "The media type for responsive settings.",
38353
+ "default": "'unknown'",
38354
+ "attribute": "media",
38355
+ "reflects": true
38356
+ },
38357
+ {
38358
+ "kind": "method",
38359
+ "name": "updateContext",
38360
+ "privacy": "protected",
38361
+ "return": {
38362
+ "type": {
38363
+ "text": "void"
38364
+ }
38365
+ }
38366
+ }
38367
+ ],
38368
+ "attributes": [
38369
+ {
38370
+ "name": "force-fullscreen-dialog",
38371
+ "type": {
38372
+ "text": "boolean"
38373
+ },
38374
+ "description": "Determines whether dialogs should be forced to fullscreen mode.",
38375
+ "fieldName": "forceFullscreenDialog"
38376
+ },
38377
+ {
38378
+ "name": "popover-positioning",
38379
+ "description": "The popover positioning for responsive settings.",
38380
+ "default": "'float'",
38381
+ "fieldName": "popoverPositioning"
38382
+ },
38383
+ {
38384
+ "name": "media",
38385
+ "description": "The media type for responsive settings.",
38386
+ "default": "'unknown'",
38387
+ "fieldName": "media"
38388
+ }
38389
+ ],
38390
+ "superclass": {
38391
+ "name": "Provider",
38392
+ "module": "/src/models"
38393
+ },
38394
+ "tagName": "mdc-responsivesettingsprovider",
38395
+ "jsDoc": "/**\n * `mdc-responsivesettingsprovider` is a provider component that supplies responsive settings\n * context to its child components.\n *\n * This component does not make any assumptions about how the values are determined. Values can be set\n * based on media queries or other device detection mechanisms.This way consumer can mix and match\n * different settings depending on their target devices and use cases.\n *\n * For example, when the device has table screen size/resolution, but because it is fixed dialog like\n * popovers provide better user experience.\n *\n * ## Responsive settings\n *\n * ### Media\n *\n * Generic media type to enforce responsive behavior in child components.\n * Consumer component can use the media type from the context or\n * just use CSS selector like [media=\"mobile\"] to apply responsive styles.\n *\n * It is \"unknown\" by default so components can fall back to there default behavior.\n *\n * ### Popover Positioning\n *\n * By default, popovers are positioned close to the trigger element. But on small screens (e.g.: mobile devices),\n * it is often better to show popovers/menus at the center of the screen like dialogs.\n *\n * ### Force Fullscreen Dialog\n *\n * Some components like dialogs can be shown in fullscreen mode on small screens for better user experience.\n *\n * @tagname mdc-responsivesettingsprovider\n */",
38396
+ "customElement": true
38397
+ }
38398
+ ],
38399
+ "exports": [
38400
+ {
38401
+ "kind": "js",
38402
+ "name": "default",
38403
+ "declaration": {
38404
+ "name": "ResponsiveSettingsProvider",
38405
+ "module": "components/responsivesettingsprovider/responsivesettingsprovider.component.js"
38406
+ }
38407
+ }
38408
+ ]
38409
+ },
38314
38410
  {
38315
38411
  "kind": "javascript-module",
38316
38412
  "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
@@ -44779,6 +44875,191 @@
44779
44875
  }
44780
44876
  ]
44781
44877
  },
44878
+ {
44879
+ "kind": "javascript-module",
44880
+ "path": "components/stepper/stepper.component.js",
44881
+ "declarations": [
44882
+ {
44883
+ "kind": "class",
44884
+ "description": "Stepper component, which orchestrates stepperitem and stepperconnector components, is a wrapper for the stepper functionality.\nIt provides the context for the stepper items and connectors, allowing them to adapt to the stepper's orientation and variant.",
44885
+ "name": "Stepper",
44886
+ "slots": [
44887
+ {
44888
+ "description": "Pass the list of `mdc-stepperitem` and `mdc-stepperconnector` elements to be rendered inside the stepper.",
44889
+ "name": "default"
44890
+ }
44891
+ ],
44892
+ "members": [
44893
+ {
44894
+ "kind": "field",
44895
+ "name": "orientation",
44896
+ "type": {
44897
+ "text": "OrientationType"
44898
+ },
44899
+ "description": "The orientation of the stepperconnector (vertical or horizontal)",
44900
+ "default": "\"horizontal\"",
44901
+ "attribute": "orientation",
44902
+ "reflects": true
44903
+ },
44904
+ {
44905
+ "kind": "field",
44906
+ "name": "variant",
44907
+ "type": {
44908
+ "text": "VariantType"
44909
+ },
44910
+ "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
44911
+ "default": "'inline'",
44912
+ "attribute": "variant",
44913
+ "reflects": true
44914
+ },
44915
+ {
44916
+ "kind": "field",
44917
+ "name": "Context",
44918
+ "privacy": "public",
44919
+ "static": true,
44920
+ "description": "Get the context for the stepper component.\nThis context provides the orientation and variant for the stepper items and connectors.",
44921
+ "readonly": true
44922
+ },
44923
+ {
44924
+ "kind": "method",
44925
+ "name": "updateContext",
44926
+ "privacy": "protected",
44927
+ "return": {
44928
+ "type": {
44929
+ "text": "void"
44930
+ }
44931
+ },
44932
+ "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
44933
+ }
44934
+ ],
44935
+ "attributes": [
44936
+ {
44937
+ "name": "orientation",
44938
+ "type": {
44939
+ "text": "OrientationType"
44940
+ },
44941
+ "description": "The orientation of the stepperconnector (vertical or horizontal)",
44942
+ "default": "\"horizontal\"",
44943
+ "fieldName": "orientation"
44944
+ },
44945
+ {
44946
+ "name": "variant",
44947
+ "type": {
44948
+ "text": "VariantType"
44949
+ },
44950
+ "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
44951
+ "default": "'inline'",
44952
+ "fieldName": "variant"
44953
+ }
44954
+ ],
44955
+ "superclass": {
44956
+ "name": "Provider",
44957
+ "module": "/src/models"
44958
+ },
44959
+ "tagName": "mdc-stepper",
44960
+ "jsDoc": "/**\n * Stepper component, which orchestrates stepperitem and stepperconnector components, is a wrapper for the stepper functionality.\n * It provides the context for the stepper items and connectors, allowing them to adapt to the stepper's orientation and variant.\n *\n * @tagname mdc-stepper\n *\n * @slot default - Pass the list of `mdc-stepperitem` and `mdc-stepperconnector` elements to be rendered inside the stepper.\n *\n */",
44961
+ "customElement": true
44962
+ }
44963
+ ],
44964
+ "exports": [
44965
+ {
44966
+ "kind": "js",
44967
+ "name": "default",
44968
+ "declaration": {
44969
+ "name": "Stepper",
44970
+ "module": "components/stepper/stepper.component.js"
44971
+ }
44972
+ }
44973
+ ]
44974
+ },
44975
+ {
44976
+ "kind": "javascript-module",
44977
+ "path": "components/stepperconnector/stepperconnector.component.js",
44978
+ "declarations": [
44979
+ {
44980
+ "kind": "class",
44981
+ "description": "StepperConnector component visually represents the connection between two stepper items.\nIndicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\nThey are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.",
44982
+ "name": "StepperConnector",
44983
+ "cssProperties": [
44984
+ {
44985
+ "description": "Background color for the complete connector",
44986
+ "name": "--mdc-stepperconnector-complete-background"
44987
+ },
44988
+ {
44989
+ "description": "Background color for the incomplete connector",
44990
+ "name": "--mdc-stepperconnector-incomplete-background"
44991
+ }
44992
+ ],
44993
+ "cssParts": [
44994
+ {
44995
+ "description": "The main connector line between steps",
44996
+ "name": "connector"
44997
+ }
44998
+ ],
44999
+ "members": [
45000
+ {
45001
+ "kind": "field",
45002
+ "name": "status",
45003
+ "type": {
45004
+ "text": "StatusType"
45005
+ },
45006
+ "description": "The status of the connector (complete or incomplete)",
45007
+ "default": "\"incomplete\"",
45008
+ "attribute": "status",
45009
+ "reflects": true
45010
+ },
45011
+ {
45012
+ "kind": "field",
45013
+ "name": "orientation",
45014
+ "type": {
45015
+ "text": "OrientationType"
45016
+ },
45017
+ "description": "The orientation of the connector (vertical or horizontal)",
45018
+ "default": "\"horizontal\"",
45019
+ "attribute": "orientation",
45020
+ "reflects": true
45021
+ }
45022
+ ],
45023
+ "attributes": [
45024
+ {
45025
+ "name": "status",
45026
+ "type": {
45027
+ "text": "StatusType"
45028
+ },
45029
+ "description": "The status of the connector (complete or incomplete)",
45030
+ "default": "\"incomplete\"",
45031
+ "fieldName": "status"
45032
+ },
45033
+ {
45034
+ "name": "orientation",
45035
+ "type": {
45036
+ "text": "OrientationType"
45037
+ },
45038
+ "description": "The orientation of the connector (vertical or horizontal)",
45039
+ "default": "\"horizontal\"",
45040
+ "fieldName": "orientation"
45041
+ }
45042
+ ],
45043
+ "superclass": {
45044
+ "name": "Component",
45045
+ "module": "/src/models"
45046
+ },
45047
+ "tagName": "mdc-stepperconnector",
45048
+ "jsDoc": "/**\n * StepperConnector component visually represents the connection between two stepper items.\n * Indicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\n * They are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.\n *\n * @tagname mdc-stepperconnector\n *\n * @csspart connector - The main connector line between steps\n *\n * @cssproperty --mdc-stepperconnector-complete-background - Background color for the complete connector\n * @cssproperty --mdc-stepperconnector-incomplete-background - Background color for the incomplete connector\n */",
45049
+ "customElement": true
45050
+ }
45051
+ ],
45052
+ "exports": [
45053
+ {
45054
+ "kind": "js",
45055
+ "name": "default",
45056
+ "declaration": {
45057
+ "name": "StepperConnector",
45058
+ "module": "components/stepperconnector/stepperconnector.component.js"
45059
+ }
45060
+ }
45061
+ ]
45062
+ },
44782
45063
  {
44783
45064
  "kind": "javascript-module",
44784
45065
  "path": "components/statictoggle/statictoggle.component.js",
@@ -44977,30 +45258,69 @@
44977
45258
  },
44978
45259
  {
44979
45260
  "kind": "javascript-module",
44980
- "path": "components/stepper/stepper.component.js",
45261
+ "path": "components/stepperitem/stepperitem.component.js",
44981
45262
  "declarations": [
44982
45263
  {
44983
45264
  "kind": "class",
44984
- "description": "Stepper component, which orchestrates stepperitem and stepperconnector components, is a wrapper for the stepper functionality.\nIt provides the context for the stepper items and connectors, allowing them to adapt to the stepper's orientation and variant.",
44985
- "name": "Stepper",
44986
- "slots": [
45265
+ "description": "stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\nIt can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\nThe component supports various visual styles and can be customized with labels, help text, and step numbers.\n\nThis is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\nMake sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n\nAdditionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.",
45266
+ "name": "StepperItem",
45267
+ "cssProperties": [
44987
45268
  {
44988
- "description": "Pass the list of `mdc-stepperitem` and `mdc-stepperconnector` elements to be rendered inside the stepper.",
44989
- "name": "default"
45269
+ "description": "The background color of the status container.",
45270
+ "name": "--mdc-stepperitem-status-container-background"
45271
+ },
45272
+ {
45273
+ "description": "The border color of the status container.",
45274
+ "name": "--mdc-stepperitem-status-container-border-color"
45275
+ },
45276
+ {
45277
+ "description": "The color of the label text.",
45278
+ "name": "--mdc-stepperitem-label-color"
45279
+ },
45280
+ {
45281
+ "description": "The color of the optional label text.",
45282
+ "name": "--mdc-stepperitem-help-text-color"
45283
+ },
45284
+ {
45285
+ "description": "The background color of the label container.",
45286
+ "name": "--mdc-stepperitem-label-container-background"
44990
45287
  }
44991
45288
  ],
44992
- "members": [
45289
+ "cssParts": [
44993
45290
  {
44994
- "kind": "field",
44995
- "name": "orientation",
44996
- "type": {
44997
- "text": "OrientationType"
44998
- },
44999
- "description": "The orientation of the stepperconnector (vertical or horizontal)",
45000
- "default": "\"horizontal\"",
45001
- "attribute": "orientation",
45002
- "reflects": true
45291
+ "description": "The container for the status icon or step number.",
45292
+ "name": "status-container"
45003
45293
  },
45294
+ {
45295
+ "description": "The container for the label and help text.",
45296
+ "name": "label-container"
45297
+ },
45298
+ {
45299
+ "description": "The container for the help text and error icon when applicable.",
45300
+ "name": "help-text-container"
45301
+ },
45302
+ {
45303
+ "description": "The icon representing the status of the stepper item.",
45304
+ "name": "status-icon"
45305
+ },
45306
+ {
45307
+ "description": "The text representing the step number.",
45308
+ "name": "step-number"
45309
+ },
45310
+ {
45311
+ "description": "The text representing the label of the stepper item.",
45312
+ "name": "label"
45313
+ },
45314
+ {
45315
+ "description": "The text providing additional information about the stepper item.",
45316
+ "name": "help-text"
45317
+ },
45318
+ {
45319
+ "description": "The icon representing an error in the stepper item.",
45320
+ "name": "help-icon"
45321
+ }
45322
+ ],
45323
+ "members": [
45004
45324
  {
45005
45325
  "kind": "field",
45006
45326
  "name": "variant",
@@ -45014,34 +45334,140 @@
45014
45334
  },
45015
45335
  {
45016
45336
  "kind": "field",
45017
- "name": "Context",
45018
- "privacy": "public",
45019
- "static": true,
45020
- "description": "Get the context for the stepper component.\nThis context provides the orientation and variant for the stepper items and connectors.",
45021
- "readonly": true
45337
+ "name": "status",
45338
+ "type": {
45339
+ "text": "StatusType"
45340
+ },
45341
+ "description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
45342
+ "default": "'not-started'",
45343
+ "attribute": "status",
45344
+ "reflects": true
45345
+ },
45346
+ {
45347
+ "kind": "field",
45348
+ "name": "label",
45349
+ "type": {
45350
+ "text": "string"
45351
+ },
45352
+ "default": "''",
45353
+ "description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
45354
+ "attribute": "label",
45355
+ "reflects": true
45356
+ },
45357
+ {
45358
+ "kind": "field",
45359
+ "name": "helpText",
45360
+ "type": {
45361
+ "text": "string | undefined"
45362
+ },
45363
+ "description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
45364
+ "default": "''",
45365
+ "attribute": "help-text",
45366
+ "reflects": true
45367
+ },
45368
+ {
45369
+ "kind": "field",
45370
+ "name": "stepNumber",
45371
+ "type": {
45372
+ "text": "number | undefined"
45373
+ },
45374
+ "description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
45375
+ "default": "''",
45376
+ "attribute": "step-number",
45377
+ "reflects": true
45022
45378
  },
45023
45379
  {
45024
45380
  "kind": "method",
45025
- "name": "updateContext",
45026
- "privacy": "protected",
45381
+ "name": "handleKeyDown",
45382
+ "privacy": "private",
45383
+ "parameters": [
45384
+ {
45385
+ "name": "event",
45386
+ "type": {
45387
+ "text": "KeyboardEvent"
45388
+ },
45389
+ "description": "The keyboard event."
45390
+ }
45391
+ ],
45392
+ "description": "Handles the keydown event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is pressed.\nIf the key is 'Enter', the stepperitem is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the stepperitem's default is prevent to avoid scrolling etc in the host application."
45393
+ },
45394
+ {
45395
+ "kind": "method",
45396
+ "name": "triggerClickEvent",
45397
+ "privacy": "private",
45398
+ "description": "Triggers a click event on the stepper item."
45399
+ },
45400
+ {
45401
+ "kind": "method",
45402
+ "name": "handleKeyUp",
45403
+ "privacy": "private",
45404
+ "parameters": [
45405
+ {
45406
+ "name": "event",
45407
+ "type": {
45408
+ "text": "KeyboardEvent"
45409
+ },
45410
+ "description": "The keyboard event."
45411
+ }
45412
+ ],
45413
+ "description": "Handles the keyup event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is clicked.\nIf the key is 'Space', the stepperitem is pressed. The native HTML button works in the same way."
45414
+ },
45415
+ {
45416
+ "kind": "method",
45417
+ "name": "renderStatusIcon",
45418
+ "privacy": "private",
45419
+ "description": "Renders the status icon based on the current status of the stepper item.\n- If the status is `completed`, it renders a check icon.\n- If the status is `current` or `error-current`, it renders a pencil icon.\n- If the status is `not-started` or `error-incomplete`, it renders the step number.\n- If the status is anything else, it renders nothing.",
45027
45420
  "return": {
45028
45421
  "type": {
45029
- "text": "void"
45422
+ "text": ""
45423
+ }
45424
+ }
45425
+ },
45426
+ {
45427
+ "kind": "method",
45428
+ "name": "renderHelpText",
45429
+ "privacy": "private",
45430
+ "description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
45431
+ "return": {
45432
+ "type": {
45433
+ "text": ""
45030
45434
  }
45435
+ }
45436
+ },
45437
+ {
45438
+ "kind": "field",
45439
+ "name": "tabIndex",
45440
+ "type": {
45441
+ "text": "number"
45031
45442
  },
45032
- "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
45443
+ "default": "0",
45444
+ "description": "This property specifies the tab order of the element.",
45445
+ "attribute": "tabIndex",
45446
+ "reflects": true,
45447
+ "inheritedFrom": {
45448
+ "name": "TabIndexMixin",
45449
+ "module": "utils/mixins/TabIndexMixin.js"
45450
+ }
45033
45451
  }
45034
45452
  ],
45035
- "attributes": [
45453
+ "events": [
45036
45454
  {
45037
- "name": "orientation",
45038
- "type": {
45039
- "text": "OrientationType"
45040
- },
45041
- "description": "The orientation of the stepperconnector (vertical or horizontal)",
45042
- "default": "\"horizontal\"",
45043
- "fieldName": "orientation"
45455
+ "description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
45456
+ "name": "click",
45457
+ "reactName": "onClick"
45458
+ },
45459
+ {
45460
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
45461
+ "name": "keydown",
45462
+ "reactName": "onKeyDown"
45044
45463
  },
45464
+ {
45465
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
45466
+ "name": "keyup",
45467
+ "reactName": "onKeyUp"
45468
+ }
45469
+ ],
45470
+ "attributes": [
45045
45471
  {
45046
45472
  "name": "variant",
45047
45473
  "type": {
@@ -45050,102 +45476,69 @@
45050
45476
  "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
45051
45477
  "default": "'inline'",
45052
45478
  "fieldName": "variant"
45053
- }
45054
- ],
45055
- "superclass": {
45056
- "name": "Provider",
45057
- "module": "/src/models"
45058
- },
45059
- "tagName": "mdc-stepper",
45060
- "jsDoc": "/**\n * Stepper component, which orchestrates stepperitem and stepperconnector components, is a wrapper for the stepper functionality.\n * It provides the context for the stepper items and connectors, allowing them to adapt to the stepper's orientation and variant.\n *\n * @tagname mdc-stepper\n *\n * @slot default - Pass the list of `mdc-stepperitem` and `mdc-stepperconnector` elements to be rendered inside the stepper.\n *\n */",
45061
- "customElement": true
45062
- }
45063
- ],
45064
- "exports": [
45065
- {
45066
- "kind": "js",
45067
- "name": "default",
45068
- "declaration": {
45069
- "name": "Stepper",
45070
- "module": "components/stepper/stepper.component.js"
45071
- }
45072
- }
45073
- ]
45074
- },
45075
- {
45076
- "kind": "javascript-module",
45077
- "path": "components/stepperconnector/stepperconnector.component.js",
45078
- "declarations": [
45079
- {
45080
- "kind": "class",
45081
- "description": "StepperConnector component visually represents the connection between two stepper items.\nIndicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\nThey are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.",
45082
- "name": "StepperConnector",
45083
- "cssProperties": [
45084
- {
45085
- "description": "Background color for the complete connector",
45086
- "name": "--mdc-stepperconnector-complete-background"
45087
45479
  },
45088
45480
  {
45089
- "description": "Background color for the incomplete connector",
45090
- "name": "--mdc-stepperconnector-incomplete-background"
45091
- }
45092
- ],
45093
- "cssParts": [
45094
- {
45095
- "description": "The main connector line between steps",
45096
- "name": "connector"
45097
- }
45098
- ],
45099
- "members": [
45100
- {
45101
- "kind": "field",
45102
45481
  "name": "status",
45103
45482
  "type": {
45104
45483
  "text": "StatusType"
45105
45484
  },
45106
- "description": "The status of the connector (complete or incomplete)",
45107
- "default": "\"incomplete\"",
45108
- "attribute": "status",
45109
- "reflects": true
45485
+ "description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
45486
+ "default": "'not-started'",
45487
+ "fieldName": "status"
45110
45488
  },
45111
45489
  {
45112
- "kind": "field",
45113
- "name": "orientation",
45490
+ "name": "label",
45114
45491
  "type": {
45115
- "text": "OrientationType"
45492
+ "text": "string"
45116
45493
  },
45117
- "description": "The orientation of the connector (vertical or horizontal)",
45118
- "default": "\"horizontal\"",
45119
- "attribute": "orientation",
45120
- "reflects": true
45121
- }
45122
- ],
45123
- "attributes": [
45494
+ "default": "''",
45495
+ "description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
45496
+ "fieldName": "label"
45497
+ },
45124
45498
  {
45125
- "name": "status",
45499
+ "name": "help-text",
45126
45500
  "type": {
45127
- "text": "StatusType"
45501
+ "text": "string | undefined"
45128
45502
  },
45129
- "description": "The status of the connector (complete or incomplete)",
45130
- "default": "\"incomplete\"",
45131
- "fieldName": "status"
45503
+ "description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
45504
+ "default": "''",
45505
+ "fieldName": "helpText"
45132
45506
  },
45133
45507
  {
45134
- "name": "orientation",
45508
+ "name": "step-number",
45135
45509
  "type": {
45136
- "text": "OrientationType"
45510
+ "text": "number | undefined"
45137
45511
  },
45138
- "description": "The orientation of the connector (vertical or horizontal)",
45139
- "default": "\"horizontal\"",
45140
- "fieldName": "orientation"
45512
+ "description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
45513
+ "default": "''",
45514
+ "fieldName": "stepNumber"
45515
+ },
45516
+ {
45517
+ "name": "tabIndex",
45518
+ "type": {
45519
+ "text": "number"
45520
+ },
45521
+ "default": "0",
45522
+ "description": "This property specifies the tab order of the element.",
45523
+ "fieldName": "tabIndex",
45524
+ "inheritedFrom": {
45525
+ "name": "TabIndexMixin",
45526
+ "module": "src/utils/mixins/TabIndexMixin.ts"
45527
+ }
45528
+ }
45529
+ ],
45530
+ "mixins": [
45531
+ {
45532
+ "name": "TabIndexMixin",
45533
+ "module": "/src/utils/mixins/TabIndexMixin"
45141
45534
  }
45142
45535
  ],
45143
45536
  "superclass": {
45144
45537
  "name": "Component",
45145
45538
  "module": "/src/models"
45146
45539
  },
45147
- "tagName": "mdc-stepperconnector",
45148
- "jsDoc": "/**\n * StepperConnector component visually represents the connection between two stepper items.\n * Indicates whether the connection is complete or incomplete, and supports vertical or horizontal orientation.\n * They are used between 2 `mdc-stepperitem` components to visually connect them and wrapped in a `mdc-stepper` component.\n *\n * @tagname mdc-stepperconnector\n *\n * @csspart connector - The main connector line between steps\n *\n * @cssproperty --mdc-stepperconnector-complete-background - Background color for the complete connector\n * @cssproperty --mdc-stepperconnector-incomplete-background - Background color for the incomplete connector\n */",
45540
+ "tagName": "mdc-stepperitem",
45541
+ "jsDoc": "/**\n * stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\n * It can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\n * The component supports various visual styles and can be customized with labels, help text, and step numbers.\n *\n * This is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\n * Make sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n *\n * Additionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-stepperitem\n *\n * @event click - (React: onClick) This event is dispatched when the stepperitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the stepperitem.\n *\n * @csspart status-container - The container for the status icon or step number.\n * @csspart label-container - The container for the label and help text.\n * @csspart help-text-container - The container for the help text and error icon when applicable.\n * @csspart status-icon - The icon representing the status of the stepper item.\n * @csspart step-number - The text representing the step number.\n * @csspart label - The text representing the label of the stepper item.\n * @csspart help-text - The text providing additional information about the stepper item.\n * @csspart help-icon - The icon representing an error in the stepper item.\n *\n * @cssproperty --mdc-stepperitem-status-container-background - The background color of the status container.\n * @cssproperty --mdc-stepperitem-status-container-border-color - The border color of the status container.\n * @cssproperty --mdc-stepperitem-label-color - The color of the label text.\n * @cssproperty --mdc-stepperitem-help-text-color - The color of the optional label text.\n * @cssproperty --mdc-stepperitem-label-container-background - The background color of the label container.\n */",
45149
45542
  "customElement": true
45150
45543
  }
45151
45544
  ],
@@ -45154,8 +45547,8 @@
45154
45547
  "kind": "js",
45155
45548
  "name": "default",
45156
45549
  "declaration": {
45157
- "name": "StepperConnector",
45158
- "module": "components/stepperconnector/stepperconnector.component.js"
45550
+ "name": "StepperItem",
45551
+ "module": "components/stepperitem/stepperitem.component.js"
45159
45552
  }
45160
45553
  }
45161
45554
  ]
@@ -46177,303 +46570,6 @@
46177
46570
  }
46178
46571
  ]
46179
46572
  },
46180
- {
46181
- "kind": "javascript-module",
46182
- "path": "components/stepperitem/stepperitem.component.js",
46183
- "declarations": [
46184
- {
46185
- "kind": "class",
46186
- "description": "stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\nIt can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\nThe component supports various visual styles and can be customized with labels, help text, and step numbers.\n\nThis is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\nMake sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n\nAdditionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.",
46187
- "name": "StepperItem",
46188
- "cssProperties": [
46189
- {
46190
- "description": "The background color of the status container.",
46191
- "name": "--mdc-stepperitem-status-container-background"
46192
- },
46193
- {
46194
- "description": "The border color of the status container.",
46195
- "name": "--mdc-stepperitem-status-container-border-color"
46196
- },
46197
- {
46198
- "description": "The color of the label text.",
46199
- "name": "--mdc-stepperitem-label-color"
46200
- },
46201
- {
46202
- "description": "The color of the optional label text.",
46203
- "name": "--mdc-stepperitem-help-text-color"
46204
- },
46205
- {
46206
- "description": "The background color of the label container.",
46207
- "name": "--mdc-stepperitem-label-container-background"
46208
- }
46209
- ],
46210
- "cssParts": [
46211
- {
46212
- "description": "The container for the status icon or step number.",
46213
- "name": "status-container"
46214
- },
46215
- {
46216
- "description": "The container for the label and help text.",
46217
- "name": "label-container"
46218
- },
46219
- {
46220
- "description": "The container for the help text and error icon when applicable.",
46221
- "name": "help-text-container"
46222
- },
46223
- {
46224
- "description": "The icon representing the status of the stepper item.",
46225
- "name": "status-icon"
46226
- },
46227
- {
46228
- "description": "The text representing the step number.",
46229
- "name": "step-number"
46230
- },
46231
- {
46232
- "description": "The text representing the label of the stepper item.",
46233
- "name": "label"
46234
- },
46235
- {
46236
- "description": "The text providing additional information about the stepper item.",
46237
- "name": "help-text"
46238
- },
46239
- {
46240
- "description": "The icon representing an error in the stepper item.",
46241
- "name": "help-icon"
46242
- }
46243
- ],
46244
- "members": [
46245
- {
46246
- "kind": "field",
46247
- "name": "variant",
46248
- "type": {
46249
- "text": "VariantType"
46250
- },
46251
- "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
46252
- "default": "'inline'",
46253
- "attribute": "variant",
46254
- "reflects": true
46255
- },
46256
- {
46257
- "kind": "field",
46258
- "name": "status",
46259
- "type": {
46260
- "text": "StatusType"
46261
- },
46262
- "description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
46263
- "default": "'not-started'",
46264
- "attribute": "status",
46265
- "reflects": true
46266
- },
46267
- {
46268
- "kind": "field",
46269
- "name": "label",
46270
- "type": {
46271
- "text": "string"
46272
- },
46273
- "default": "''",
46274
- "description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
46275
- "attribute": "label",
46276
- "reflects": true
46277
- },
46278
- {
46279
- "kind": "field",
46280
- "name": "helpText",
46281
- "type": {
46282
- "text": "string | undefined"
46283
- },
46284
- "description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
46285
- "default": "''",
46286
- "attribute": "help-text",
46287
- "reflects": true
46288
- },
46289
- {
46290
- "kind": "field",
46291
- "name": "stepNumber",
46292
- "type": {
46293
- "text": "number | undefined"
46294
- },
46295
- "description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
46296
- "default": "''",
46297
- "attribute": "step-number",
46298
- "reflects": true
46299
- },
46300
- {
46301
- "kind": "method",
46302
- "name": "handleKeyDown",
46303
- "privacy": "private",
46304
- "parameters": [
46305
- {
46306
- "name": "event",
46307
- "type": {
46308
- "text": "KeyboardEvent"
46309
- },
46310
- "description": "The keyboard event."
46311
- }
46312
- ],
46313
- "description": "Handles the keydown event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is pressed.\nIf the key is 'Enter', the stepperitem is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the stepperitem's default is prevent to avoid scrolling etc in the host application."
46314
- },
46315
- {
46316
- "kind": "method",
46317
- "name": "triggerClickEvent",
46318
- "privacy": "private",
46319
- "description": "Triggers a click event on the stepper item."
46320
- },
46321
- {
46322
- "kind": "method",
46323
- "name": "handleKeyUp",
46324
- "privacy": "private",
46325
- "parameters": [
46326
- {
46327
- "name": "event",
46328
- "type": {
46329
- "text": "KeyboardEvent"
46330
- },
46331
- "description": "The keyboard event."
46332
- }
46333
- ],
46334
- "description": "Handles the keyup event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is clicked.\nIf the key is 'Space', the stepperitem is pressed. The native HTML button works in the same way."
46335
- },
46336
- {
46337
- "kind": "method",
46338
- "name": "renderStatusIcon",
46339
- "privacy": "private",
46340
- "description": "Renders the status icon based on the current status of the stepper item.\n- If the status is `completed`, it renders a check icon.\n- If the status is `current` or `error-current`, it renders a pencil icon.\n- If the status is `not-started` or `error-incomplete`, it renders the step number.\n- If the status is anything else, it renders nothing.",
46341
- "return": {
46342
- "type": {
46343
- "text": ""
46344
- }
46345
- }
46346
- },
46347
- {
46348
- "kind": "method",
46349
- "name": "renderHelpText",
46350
- "privacy": "private",
46351
- "description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
46352
- "return": {
46353
- "type": {
46354
- "text": ""
46355
- }
46356
- }
46357
- },
46358
- {
46359
- "kind": "field",
46360
- "name": "tabIndex",
46361
- "type": {
46362
- "text": "number"
46363
- },
46364
- "default": "0",
46365
- "description": "This property specifies the tab order of the element.",
46366
- "attribute": "tabIndex",
46367
- "reflects": true,
46368
- "inheritedFrom": {
46369
- "name": "TabIndexMixin",
46370
- "module": "utils/mixins/TabIndexMixin.js"
46371
- }
46372
- }
46373
- ],
46374
- "events": [
46375
- {
46376
- "description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
46377
- "name": "click",
46378
- "reactName": "onClick"
46379
- },
46380
- {
46381
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
46382
- "name": "keydown",
46383
- "reactName": "onKeyDown"
46384
- },
46385
- {
46386
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
46387
- "name": "keyup",
46388
- "reactName": "onKeyUp"
46389
- }
46390
- ],
46391
- "attributes": [
46392
- {
46393
- "name": "variant",
46394
- "type": {
46395
- "text": "VariantType"
46396
- },
46397
- "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
46398
- "default": "'inline'",
46399
- "fieldName": "variant"
46400
- },
46401
- {
46402
- "name": "status",
46403
- "type": {
46404
- "text": "StatusType"
46405
- },
46406
- "description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
46407
- "default": "'not-started'",
46408
- "fieldName": "status"
46409
- },
46410
- {
46411
- "name": "label",
46412
- "type": {
46413
- "text": "string"
46414
- },
46415
- "default": "''",
46416
- "description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
46417
- "fieldName": "label"
46418
- },
46419
- {
46420
- "name": "help-text",
46421
- "type": {
46422
- "text": "string | undefined"
46423
- },
46424
- "description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
46425
- "default": "''",
46426
- "fieldName": "helpText"
46427
- },
46428
- {
46429
- "name": "step-number",
46430
- "type": {
46431
- "text": "number | undefined"
46432
- },
46433
- "description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
46434
- "default": "''",
46435
- "fieldName": "stepNumber"
46436
- },
46437
- {
46438
- "name": "tabIndex",
46439
- "type": {
46440
- "text": "number"
46441
- },
46442
- "default": "0",
46443
- "description": "This property specifies the tab order of the element.",
46444
- "fieldName": "tabIndex",
46445
- "inheritedFrom": {
46446
- "name": "TabIndexMixin",
46447
- "module": "src/utils/mixins/TabIndexMixin.ts"
46448
- }
46449
- }
46450
- ],
46451
- "mixins": [
46452
- {
46453
- "name": "TabIndexMixin",
46454
- "module": "/src/utils/mixins/TabIndexMixin"
46455
- }
46456
- ],
46457
- "superclass": {
46458
- "name": "Component",
46459
- "module": "/src/models"
46460
- },
46461
- "tagName": "mdc-stepperitem",
46462
- "jsDoc": "/**\n * stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\n * It can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\n * The component supports various visual styles and can be customized with labels, help text, and step numbers.\n *\n * This is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\n * Make sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n *\n * Additionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-stepperitem\n *\n * @event click - (React: onClick) This event is dispatched when the stepperitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the stepperitem.\n *\n * @csspart status-container - The container for the status icon or step number.\n * @csspart label-container - The container for the label and help text.\n * @csspart help-text-container - The container for the help text and error icon when applicable.\n * @csspart status-icon - The icon representing the status of the stepper item.\n * @csspart step-number - The text representing the step number.\n * @csspart label - The text representing the label of the stepper item.\n * @csspart help-text - The text providing additional information about the stepper item.\n * @csspart help-icon - The icon representing an error in the stepper item.\n *\n * @cssproperty --mdc-stepperitem-status-container-background - The background color of the status container.\n * @cssproperty --mdc-stepperitem-status-container-border-color - The border color of the status container.\n * @cssproperty --mdc-stepperitem-label-color - The color of the label text.\n * @cssproperty --mdc-stepperitem-help-text-color - The color of the optional label text.\n * @cssproperty --mdc-stepperitem-label-container-background - The background color of the label container.\n */",
46463
- "customElement": true
46464
- }
46465
- ],
46466
- "exports": [
46467
- {
46468
- "kind": "js",
46469
- "name": "default",
46470
- "declaration": {
46471
- "name": "StepperItem",
46472
- "module": "components/stepperitem/stepperitem.component.js"
46473
- }
46474
- }
46475
- ]
46476
- },
46477
46573
  {
46478
46574
  "kind": "javascript-module",
46479
46575
  "path": "components/text/text.component.js",