@momentum-design/components 0.104.9 → 0.104.11

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.
@@ -7088,32 +7088,172 @@
7088
7088
  },
7089
7089
  {
7090
7090
  "kind": "javascript-module",
7091
- "path": "components/checkbox/checkbox.component.js",
7091
+ "path": "components/cardradio/cardradio.component.js",
7092
7092
  "declarations": [
7093
7093
  {
7094
7094
  "kind": "class",
7095
- "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
7096
- "name": "Checkbox",
7095
+ "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
7096
+ "name": "CardRadio",
7097
7097
  "cssProperties": [
7098
7098
  {
7099
- "description": "Allows customization of the background color on hover.",
7100
- "name": "--mdc-checkbox-background-color-hover"
7099
+ "description": "The width of the card",
7100
+ "name": "--mdc-card-width",
7101
+ "inheritedFrom": {
7102
+ "name": "Card",
7103
+ "module": "src/components/card/card.component.ts"
7104
+ }
7105
+ }
7106
+ ],
7107
+ "cssParts": [
7108
+ {
7109
+ "description": "The header part of the card",
7110
+ "name": "header",
7111
+ "inheritedFrom": {
7112
+ "name": "Card",
7113
+ "module": "src/components/card/card.component.ts"
7114
+ }
7101
7115
  },
7102
7116
  {
7103
- "description": "Background color for a selected checkbox when hovered.",
7104
- "name": "--mdc-checkbox-checked-background-color-hover"
7117
+ "description": "The icon part of the card header",
7118
+ "name": "icon",
7119
+ "inheritedFrom": {
7120
+ "name": "Card",
7121
+ "module": "src/components/card/card.component.ts"
7122
+ }
7105
7123
  },
7106
7124
  {
7107
- "description": "Background color for a selected checkbox when pressed.",
7108
- "name": "--mdc-checkbox-checked-pressed-icon-color"
7125
+ "description": "The body part of the card",
7126
+ "name": "body",
7127
+ "inheritedFrom": {
7128
+ "name": "Card",
7129
+ "module": "src/components/card/card.component.ts"
7130
+ }
7109
7131
  },
7110
7132
  {
7111
- "description": "Background color for a selected checkbox when pressed.",
7112
- "name": "--mdc-checkbox-pressed-icon-color"
7133
+ "description": "The image part of the card",
7134
+ "name": "image",
7135
+ "inheritedFrom": {
7136
+ "name": "Card",
7137
+ "module": "src/components/card/card.component.ts"
7138
+ }
7113
7139
  },
7114
7140
  {
7115
- "description": "Background color for a selected checkbox when disabled.",
7116
- "name": "--mdc-checkbox-disabled-checked-icon-color"
7141
+ "description": "The footer part of the card",
7142
+ "name": "footer",
7143
+ "inheritedFrom": {
7144
+ "name": "Card",
7145
+ "module": "src/components/card/card.component.ts"
7146
+ }
7147
+ },
7148
+ {
7149
+ "description": "The link part of the card footer",
7150
+ "name": "footer-link",
7151
+ "inheritedFrom": {
7152
+ "name": "Card",
7153
+ "module": "src/components/card/card.component.ts"
7154
+ }
7155
+ },
7156
+ {
7157
+ "description": "The primary button part of the card footer",
7158
+ "name": "footer-button-primary",
7159
+ "inheritedFrom": {
7160
+ "name": "Card",
7161
+ "module": "src/components/card/card.component.ts"
7162
+ }
7163
+ },
7164
+ {
7165
+ "description": "The secondary button part of the card footer",
7166
+ "name": "footer-button-secondary",
7167
+ "inheritedFrom": {
7168
+ "name": "Card",
7169
+ "module": "src/components/card/card.component.ts"
7170
+ }
7171
+ },
7172
+ {
7173
+ "description": "The icon button part of the card header",
7174
+ "name": "icon-button",
7175
+ "inheritedFrom": {
7176
+ "name": "Card",
7177
+ "module": "src/components/card/card.component.ts"
7178
+ }
7179
+ },
7180
+ {
7181
+ "description": "The text part of the card",
7182
+ "name": "text",
7183
+ "inheritedFrom": {
7184
+ "name": "Card",
7185
+ "module": "src/components/card/card.component.ts"
7186
+ }
7187
+ },
7188
+ {
7189
+ "description": "The check part of the card",
7190
+ "name": "check"
7191
+ },
7192
+ {
7193
+ "description": "The check icon part of the card",
7194
+ "name": "check-icon"
7195
+ },
7196
+ {
7197
+ "description": "The check icon button part of the card",
7198
+ "name": "check-icon-button"
7199
+ }
7200
+ ],
7201
+ "slots": [
7202
+ {
7203
+ "description": "This slot is for passing the content before the body",
7204
+ "name": "before-body",
7205
+ "inheritedFrom": {
7206
+ "name": "Card",
7207
+ "module": "src/components/card/card.component.ts"
7208
+ }
7209
+ },
7210
+ {
7211
+ "description": "This slot is for passing the text content for the card",
7212
+ "name": "body",
7213
+ "inheritedFrom": {
7214
+ "name": "Card",
7215
+ "module": "src/components/card/card.component.ts"
7216
+ }
7217
+ },
7218
+ {
7219
+ "description": "This slot is for passing the content after the body",
7220
+ "name": "after-body",
7221
+ "inheritedFrom": {
7222
+ "name": "Card",
7223
+ "module": "src/components/card/card.component.ts"
7224
+ }
7225
+ },
7226
+ {
7227
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
7228
+ "name": "footer-link",
7229
+ "inheritedFrom": {
7230
+ "name": "Card",
7231
+ "module": "src/components/card/card.component.ts"
7232
+ }
7233
+ },
7234
+ {
7235
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
7236
+ "name": "footer-button-primary",
7237
+ "inheritedFrom": {
7238
+ "name": "Card",
7239
+ "module": "src/components/card/card.component.ts"
7240
+ }
7241
+ },
7242
+ {
7243
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
7244
+ "name": "footer-button-secondary",
7245
+ "inheritedFrom": {
7246
+ "name": "Card",
7247
+ "module": "src/components/card/card.component.ts"
7248
+ }
7249
+ },
7250
+ {
7251
+ "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
7252
+ "name": "footer",
7253
+ "inheritedFrom": {
7254
+ "name": "Card",
7255
+ "module": "src/components/card/card.component.ts"
7256
+ }
7117
7257
  }
7118
7258
  ],
7119
7259
  "members": [
@@ -7124,59 +7264,45 @@
7124
7264
  "text": "boolean"
7125
7265
  },
7126
7266
  "default": "false",
7127
- "description": "Determines whether the checkbox is selected or unselected.",
7267
+ "description": "The checked state of the card",
7128
7268
  "attribute": "checked",
7129
7269
  "reflects": true
7130
7270
  },
7131
7271
  {
7132
7272
  "kind": "field",
7133
- "name": "indeterminate",
7134
- "type": {
7135
- "text": "boolean"
7136
- },
7137
- "default": "false",
7138
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
7139
- "attribute": "indeterminate",
7140
- "reflects": true
7141
- },
7142
- {
7143
- "kind": "field",
7144
- "name": "autofocus",
7273
+ "name": "name",
7145
7274
  "type": {
7146
- "text": "boolean"
7275
+ "text": "string"
7147
7276
  },
7148
- "default": "false",
7149
- "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
7150
- "attribute": "autofocus",
7151
- "reflects": true
7152
- },
7153
- {
7154
- "kind": "method",
7155
- "name": "setFormValue",
7156
- "privacy": "private",
7157
- "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
7277
+ "default": "''",
7278
+ "description": "The name of the radio.",
7279
+ "attribute": "name"
7158
7280
  },
7159
7281
  {
7160
7282
  "kind": "method",
7161
- "name": "manageRequired",
7283
+ "name": "getAllCardsWithinSameGroup",
7162
7284
  "privacy": "private",
7163
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
7285
+ "return": {
7286
+ "type": {
7287
+ "text": "CardRadio[]"
7288
+ }
7289
+ },
7290
+ "description": "Returns all cards within the same group (name)."
7164
7291
  },
7165
7292
  {
7166
7293
  "kind": "method",
7167
- "name": "toggleState",
7294
+ "name": "toggleChecked",
7168
7295
  "privacy": "private",
7169
7296
  "return": {
7170
7297
  "type": {
7171
7298
  "text": "void"
7172
7299
  }
7173
7300
  },
7174
- "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
7301
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
7175
7302
  },
7176
7303
  {
7177
7304
  "kind": "method",
7178
- "name": "handleKeyDown",
7179
- "privacy": "private",
7305
+ "name": "setDisabled",
7180
7306
  "return": {
7181
7307
  "type": {
7182
7308
  "text": "void"
@@ -7184,19 +7310,17 @@
7184
7310
  },
7185
7311
  "parameters": [
7186
7312
  {
7187
- "name": "event",
7313
+ "name": "disabled",
7188
7314
  "type": {
7189
- "text": "KeyboardEvent"
7190
- },
7191
- "description": "The keyboard event."
7315
+ "text": "boolean"
7316
+ }
7192
7317
  }
7193
- ],
7194
- "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
7318
+ ]
7195
7319
  },
7196
7320
  {
7197
7321
  "kind": "method",
7198
- "name": "handleChange",
7199
- "privacy": "public",
7322
+ "name": "updateCardRadio",
7323
+ "privacy": "private",
7200
7324
  "return": {
7201
7325
  "type": {
7202
7326
  "text": "void"
@@ -7204,352 +7328,307 @@
7204
7328
  },
7205
7329
  "parameters": [
7206
7330
  {
7207
- "name": "event",
7331
+ "name": "cards",
7208
7332
  "type": {
7209
- "text": "Event"
7333
+ "text": "CardRadio[]"
7334
+ }
7335
+ },
7336
+ {
7337
+ "name": "index",
7338
+ "type": {
7339
+ "text": "number"
7210
7340
  }
7211
7341
  }
7212
- ],
7213
- "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
7342
+ ]
7214
7343
  },
7215
7344
  {
7216
- "kind": "field",
7217
- "name": "renderLabelAndHelperText",
7218
- "privacy": "private"
7219
- },
7220
- {
7221
- "kind": "field",
7222
- "name": "name",
7223
- "type": {
7224
- "text": "string"
7225
- },
7226
- "default": "''",
7227
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7228
- "attribute": "name",
7229
- "reflects": true,
7230
- "inheritedFrom": {
7231
- "name": "FormInternalsMixin",
7232
- "module": "utils/mixins/FormInternalsMixin.js"
7233
- }
7234
- },
7235
- {
7236
- "kind": "field",
7237
- "name": "value",
7238
- "type": {
7239
- "text": "string"
7240
- },
7241
- "default": "''",
7242
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7243
- "attribute": "value",
7244
- "reflects": true,
7245
- "inheritedFrom": {
7246
- "name": "FormInternalsMixin",
7247
- "module": "utils/mixins/FormInternalsMixin.js"
7248
- }
7249
- },
7250
- {
7251
- "kind": "field",
7252
- "name": "validationMessage",
7253
- "type": {
7254
- "text": "string | undefined"
7255
- },
7256
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7257
- "attribute": "validation-message",
7258
- "reflects": true,
7259
- "inheritedFrom": {
7260
- "name": "FormInternalsMixin",
7261
- "module": "utils/mixins/FormInternalsMixin.js"
7262
- }
7263
- },
7264
- {
7265
- "kind": "field",
7266
- "name": "validity",
7267
- "type": {
7268
- "text": "ValidityState"
7269
- },
7270
- "readonly": true,
7271
- "inheritedFrom": {
7272
- "name": "FormInternalsMixin",
7273
- "module": "utils/mixins/FormInternalsMixin.js"
7274
- }
7275
- },
7276
- {
7277
- "kind": "field",
7278
- "name": "willValidate",
7279
- "readonly": true,
7280
- "inheritedFrom": {
7281
- "name": "FormInternalsMixin",
7282
- "module": "utils/mixins/FormInternalsMixin.js"
7283
- }
7345
+ "kind": "method",
7346
+ "name": "toggleOnEnter",
7347
+ "privacy": "private",
7348
+ "parameters": [
7349
+ {
7350
+ "name": "event",
7351
+ "type": {
7352
+ "text": "KeyboardEvent"
7353
+ },
7354
+ "description": "The keyboard event"
7355
+ }
7356
+ ],
7357
+ "description": "Toggles the checked state when enter key is used"
7284
7358
  },
7285
7359
  {
7286
7360
  "kind": "method",
7287
- "name": "setValidity",
7288
- "description": "Sets the validity of the input field based on the input field's validity.",
7289
- "return": {
7290
- "type": {
7291
- "text": ""
7361
+ "name": "toggleOnSpace",
7362
+ "privacy": "private",
7363
+ "parameters": [
7364
+ {
7365
+ "name": "event",
7366
+ "type": {
7367
+ "text": "KeyboardEvent"
7368
+ },
7369
+ "description": "The keyboard event"
7292
7370
  }
7293
- },
7294
- "inheritedFrom": {
7295
- "name": "FormInternalsMixin",
7296
- "module": "utils/mixins/FormInternalsMixin.js"
7297
- }
7371
+ ],
7372
+ "description": "Toggles the checked state when space key is used"
7298
7373
  },
7299
7374
  {
7300
7375
  "kind": "method",
7301
- "name": "checkValidity",
7376
+ "name": "renderHeader",
7377
+ "privacy": "protected",
7378
+ "description": "Renders the header of the card",
7302
7379
  "return": {
7303
7380
  "type": {
7304
- "text": "boolean"
7381
+ "text": ""
7305
7382
  }
7306
7383
  },
7307
7384
  "inheritedFrom": {
7308
- "name": "FormInternalsMixin",
7309
- "module": "utils/mixins/FormInternalsMixin.js"
7385
+ "name": "Card",
7386
+ "module": "components/card/card.component.js"
7310
7387
  }
7311
7388
  },
7312
7389
  {
7313
- "kind": "method",
7314
- "name": "reportValidity",
7390
+ "kind": "field",
7391
+ "name": "disabled",
7392
+ "type": {
7393
+ "text": "boolean | undefined"
7394
+ },
7395
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7396
+ "default": "undefined",
7397
+ "attribute": "disabled",
7398
+ "reflects": true,
7315
7399
  "inheritedFrom": {
7316
- "name": "FormInternalsMixin",
7317
- "module": "utils/mixins/FormInternalsMixin.js"
7400
+ "name": "DisabledMixin",
7401
+ "module": "utils/mixins/DisabledMixin.js"
7318
7402
  }
7319
7403
  },
7320
7404
  {
7321
7405
  "kind": "field",
7322
- "name": "dataAriaLabel",
7406
+ "name": "tabIndex",
7323
7407
  "type": {
7324
- "text": "string | null"
7408
+ "text": "number"
7325
7409
  },
7326
- "default": "null",
7327
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7328
- "attribute": "data-aria-label",
7410
+ "default": "0",
7411
+ "description": "This property specifies the tab order of the element.",
7412
+ "attribute": "tabIndex",
7329
7413
  "reflects": true,
7330
7414
  "inheritedFrom": {
7331
- "name": "DataAriaLabelMixin",
7332
- "module": "utils/mixins/DataAriaLabelMixin.js"
7415
+ "name": "TabIndexMixin",
7416
+ "module": "utils/mixins/TabIndexMixin.js"
7333
7417
  }
7334
7418
  },
7335
7419
  {
7336
7420
  "kind": "field",
7337
- "name": "disabled",
7421
+ "name": "cardTitle",
7338
7422
  "type": {
7339
- "text": "boolean | undefined"
7423
+ "text": "string"
7340
7424
  },
7341
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7342
- "default": "undefined",
7343
- "attribute": "disabled",
7425
+ "default": "''",
7426
+ "description": "The title of the card - part of header section",
7427
+ "attribute": "card-title",
7344
7428
  "reflects": true,
7345
7429
  "inheritedFrom": {
7346
- "name": "DisabledMixin",
7347
- "module": "utils/mixins/DisabledMixin.js"
7430
+ "name": "Card",
7431
+ "module": "components/card/card.component.js"
7348
7432
  }
7349
7433
  },
7350
7434
  {
7351
7435
  "kind": "field",
7352
- "name": "label",
7436
+ "name": "subtitle",
7353
7437
  "type": {
7354
- "text": "string | undefined"
7438
+ "text": "string"
7355
7439
  },
7356
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7357
- "attribute": "label",
7440
+ "default": "''",
7441
+ "description": "The subtitle of the card - part of header section",
7442
+ "attribute": "subtitle",
7358
7443
  "reflects": true,
7359
7444
  "inheritedFrom": {
7360
- "name": "FormfieldWrapper",
7361
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7445
+ "name": "Card",
7446
+ "module": "components/card/card.component.js"
7362
7447
  }
7363
7448
  },
7364
7449
  {
7365
7450
  "kind": "field",
7366
- "name": "required",
7451
+ "name": "imageSrc",
7367
7452
  "type": {
7368
- "text": "boolean"
7453
+ "text": "string"
7369
7454
  },
7370
- "default": "false",
7371
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7372
- "attribute": "required",
7455
+ "default": "''",
7456
+ "description": "The image source URL to render on the card",
7457
+ "attribute": "image-src",
7373
7458
  "reflects": true,
7374
7459
  "inheritedFrom": {
7375
- "name": "FormfieldWrapper",
7376
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7460
+ "name": "Card",
7461
+ "module": "components/card/card.component.js"
7377
7462
  }
7378
7463
  },
7379
7464
  {
7380
7465
  "kind": "field",
7381
- "name": "id",
7466
+ "name": "imageAlt",
7382
7467
  "type": {
7383
7468
  "text": "string"
7384
7469
  },
7385
7470
  "default": "''",
7386
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7387
- "attribute": "id",
7471
+ "description": "The image alt for accessibility support",
7472
+ "attribute": "image-alt",
7473
+ "reflects": true,
7388
7474
  "inheritedFrom": {
7389
- "name": "FormfieldWrapper",
7390
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7475
+ "name": "Card",
7476
+ "module": "components/card/card.component.js"
7391
7477
  }
7392
7478
  },
7393
7479
  {
7394
7480
  "kind": "field",
7395
- "name": "helpTextType",
7481
+ "name": "variant",
7396
7482
  "type": {
7397
- "text": "ValidationType"
7483
+ "text": "CardVariant"
7398
7484
  },
7399
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7400
- "attribute": "help-text-type",
7485
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7486
+ "default": "'border'",
7487
+ "attribute": "variant",
7401
7488
  "reflects": true,
7402
7489
  "inheritedFrom": {
7403
- "name": "FormfieldWrapper",
7404
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7490
+ "name": "Card",
7491
+ "module": "components/card/card.component.js"
7405
7492
  }
7406
7493
  },
7407
7494
  {
7408
7495
  "kind": "field",
7409
- "name": "helpText",
7496
+ "name": "orientation",
7410
7497
  "type": {
7411
- "text": "string | undefined"
7498
+ "text": "CardOrientation"
7412
7499
  },
7413
- "description": "The help text that is displayed below the input field.",
7414
- "attribute": "help-text",
7500
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7501
+ "default": "'vertical'",
7502
+ "attribute": "orientation",
7415
7503
  "reflects": true,
7416
7504
  "inheritedFrom": {
7417
- "name": "FormfieldWrapper",
7418
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7505
+ "name": "Card",
7506
+ "module": "components/card/card.component.js"
7419
7507
  }
7420
7508
  },
7421
7509
  {
7422
7510
  "kind": "field",
7423
- "name": "toggletipText",
7511
+ "name": "titleTagName",
7424
7512
  "type": {
7425
- "text": "string | undefined"
7513
+ "text": "TagNameType"
7426
7514
  },
7427
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7428
- "attribute": "toggletip-text",
7515
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
7516
+ "default": "'span'",
7517
+ "attribute": "title-tag-name",
7429
7518
  "reflects": true,
7430
7519
  "inheritedFrom": {
7431
- "name": "FormfieldWrapper",
7432
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7520
+ "name": "Card",
7521
+ "module": "components/card/card.component.js"
7433
7522
  }
7434
7523
  },
7435
7524
  {
7436
7525
  "kind": "field",
7437
- "name": "toggletipPlacement",
7526
+ "name": "subtitleTagName",
7438
7527
  "type": {
7439
- "text": "PopoverPlacement"
7528
+ "text": "TagNameType"
7440
7529
  },
7441
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7442
- "default": "'top'",
7443
- "attribute": "toggletip-placement",
7530
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
7531
+ "default": "'span'",
7532
+ "attribute": "subtitle-tag-name",
7444
7533
  "reflects": true,
7445
7534
  "inheritedFrom": {
7446
- "name": "FormfieldWrapper",
7447
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7535
+ "name": "Card",
7536
+ "module": "components/card/card.component.js"
7448
7537
  }
7449
7538
  },
7450
7539
  {
7451
7540
  "kind": "field",
7452
- "name": "infoIconAriaLabel",
7541
+ "name": "iconName",
7453
7542
  "type": {
7454
- "text": "string | undefined"
7543
+ "text": "IconNames | undefined"
7455
7544
  },
7456
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
7457
- "attribute": "info-icon-aria-label",
7545
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7546
+ "attribute": "icon-name",
7458
7547
  "reflects": true,
7459
7548
  "inheritedFrom": {
7460
- "name": "FormfieldWrapper",
7461
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7549
+ "name": "Card",
7550
+ "module": "components/card/card.component.js"
7462
7551
  }
7463
7552
  },
7464
7553
  {
7465
7554
  "kind": "method",
7466
- "name": "renderLabelElement",
7555
+ "name": "renderImage",
7467
7556
  "privacy": "protected",
7468
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
7557
+ "description": "Renders the image on the card if image source is provided",
7469
7558
  "return": {
7470
7559
  "type": {
7471
7560
  "text": ""
7472
7561
  }
7473
7562
  },
7474
7563
  "inheritedFrom": {
7475
- "name": "FormfieldWrapper",
7476
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7564
+ "name": "Card",
7565
+ "module": "components/card/card.component.js"
7477
7566
  }
7478
7567
  },
7479
7568
  {
7480
7569
  "kind": "method",
7481
- "name": "renderHelpTextIcon",
7570
+ "name": "renderIcon",
7482
7571
  "privacy": "protected",
7483
- "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
7572
+ "description": "Renders the icon on the card if icon name is provided",
7484
7573
  "return": {
7485
7574
  "type": {
7486
7575
  "text": ""
7487
7576
  }
7488
7577
  },
7489
7578
  "inheritedFrom": {
7490
- "name": "FormfieldWrapper",
7491
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7492
- }
7493
- },
7494
- {
7495
- "kind": "method",
7496
- "name": "renderHelpText",
7497
- "privacy": "protected",
7498
- "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
7499
- "return": {
7500
- "type": {
7501
- "text": ""
7502
- }
7503
- },
7504
- "inheritedFrom": {
7505
- "name": "FormfieldWrapper",
7506
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7579
+ "name": "Card",
7580
+ "module": "components/card/card.component.js"
7507
7581
  }
7508
7582
  },
7509
7583
  {
7510
7584
  "kind": "method",
7511
- "name": "renderLabel",
7585
+ "name": "renderTitle",
7512
7586
  "privacy": "protected",
7513
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
7587
+ "description": "Renders the title and subtitle on the card",
7514
7588
  "return": {
7515
7589
  "type": {
7516
7590
  "text": ""
7517
7591
  }
7518
7592
  },
7519
7593
  "inheritedFrom": {
7520
- "name": "FormfieldWrapper",
7521
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7594
+ "name": "Card",
7595
+ "module": "components/card/card.component.js"
7522
7596
  }
7523
7597
  },
7524
7598
  {
7525
7599
  "kind": "method",
7526
- "name": "renderHelperText",
7600
+ "name": "renderFooter",
7527
7601
  "privacy": "protected",
7528
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
7602
+ "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
7529
7603
  "return": {
7530
7604
  "type": {
7531
7605
  "text": ""
7532
7606
  }
7533
7607
  },
7534
7608
  "inheritedFrom": {
7535
- "name": "FormfieldWrapper",
7536
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7609
+ "name": "Card",
7610
+ "module": "components/card/card.component.js"
7537
7611
  }
7538
7612
  }
7539
7613
  ],
7540
7614
  "events": [
7541
7615
  {
7542
- "type": {
7543
- "text": "EventConstructor"
7544
- }
7616
+ "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
7617
+ "name": "click",
7618
+ "reactName": "onClick"
7545
7619
  },
7546
7620
  {
7547
- "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
7548
- "name": "change",
7549
- "reactName": "onChange"
7621
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
7622
+ "name": "keydown",
7623
+ "reactName": "onKeyDown"
7550
7624
  },
7551
7625
  {
7552
- "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
7626
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
7627
+ "name": "keyup",
7628
+ "reactName": "onKeyUp"
7629
+ },
7630
+ {
7631
+ "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
7553
7632
  "name": "focus",
7554
7633
  "reactName": "onFocus"
7555
7634
  }
@@ -7561,207 +7640,177 @@
7561
7640
  "text": "boolean"
7562
7641
  },
7563
7642
  "default": "false",
7564
- "description": "Determines whether the checkbox is selected or unselected.",
7643
+ "description": "The checked state of the card",
7565
7644
  "fieldName": "checked"
7566
7645
  },
7567
- {
7568
- "name": "indeterminate",
7569
- "type": {
7570
- "text": "boolean"
7571
- },
7572
- "default": "false",
7573
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
7574
- "fieldName": "indeterminate"
7575
- },
7576
- {
7577
- "name": "autofocus",
7578
- "type": {
7579
- "text": "boolean"
7580
- },
7581
- "default": "false",
7582
- "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
7583
- "fieldName": "autofocus"
7584
- },
7585
7646
  {
7586
7647
  "name": "name",
7587
7648
  "type": {
7588
7649
  "text": "string"
7589
7650
  },
7590
7651
  "default": "''",
7591
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7592
- "fieldName": "name",
7593
- "inheritedFrom": {
7594
- "name": "FormInternalsMixin",
7595
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7596
- }
7597
- },
7598
- {
7599
- "name": "value",
7600
- "type": {
7601
- "text": "string"
7602
- },
7603
- "default": "''",
7604
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7605
- "fieldName": "value",
7606
- "inheritedFrom": {
7607
- "name": "FormInternalsMixin",
7608
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7609
- }
7652
+ "description": "The name of the radio.",
7653
+ "fieldName": "name"
7610
7654
  },
7611
7655
  {
7612
- "name": "validation-message",
7656
+ "name": "disabled",
7613
7657
  "type": {
7614
- "text": "string | undefined"
7658
+ "text": "boolean | undefined"
7615
7659
  },
7616
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7617
- "fieldName": "validationMessage",
7660
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7661
+ "default": "undefined",
7662
+ "fieldName": "disabled",
7618
7663
  "inheritedFrom": {
7619
- "name": "FormInternalsMixin",
7620
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7664
+ "name": "DisabledMixin",
7665
+ "module": "src/utils/mixins/DisabledMixin.ts"
7621
7666
  }
7622
7667
  },
7623
7668
  {
7624
- "name": "data-aria-label",
7669
+ "name": "tabIndex",
7625
7670
  "type": {
7626
- "text": "string | null"
7671
+ "text": "number"
7627
7672
  },
7628
- "default": "null",
7629
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7630
- "fieldName": "dataAriaLabel",
7673
+ "default": "0",
7674
+ "description": "This property specifies the tab order of the element.",
7675
+ "fieldName": "tabIndex",
7631
7676
  "inheritedFrom": {
7632
- "name": "DataAriaLabelMixin",
7633
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7677
+ "name": "TabIndexMixin",
7678
+ "module": "src/utils/mixins/TabIndexMixin.ts"
7634
7679
  }
7635
7680
  },
7636
7681
  {
7637
- "name": "disabled",
7682
+ "name": "card-title",
7638
7683
  "type": {
7639
- "text": "boolean | undefined"
7684
+ "text": "string"
7640
7685
  },
7641
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7642
- "default": "undefined",
7643
- "fieldName": "disabled",
7686
+ "default": "''",
7687
+ "description": "The title of the card - part of header section",
7688
+ "fieldName": "cardTitle",
7644
7689
  "inheritedFrom": {
7645
- "name": "DisabledMixin",
7646
- "module": "src/utils/mixins/DisabledMixin.ts"
7690
+ "name": "Card",
7691
+ "module": "src/components/card/card.component.ts"
7647
7692
  }
7648
7693
  },
7649
7694
  {
7650
- "name": "label",
7695
+ "name": "subtitle",
7651
7696
  "type": {
7652
- "text": "string | undefined"
7697
+ "text": "string"
7653
7698
  },
7654
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7655
- "fieldName": "label",
7699
+ "default": "''",
7700
+ "description": "The subtitle of the card - part of header section",
7701
+ "fieldName": "subtitle",
7656
7702
  "inheritedFrom": {
7657
- "name": "FormfieldWrapper",
7658
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7703
+ "name": "Card",
7704
+ "module": "src/components/card/card.component.ts"
7659
7705
  }
7660
7706
  },
7661
7707
  {
7662
- "name": "required",
7708
+ "name": "image-src",
7663
7709
  "type": {
7664
- "text": "boolean"
7710
+ "text": "string"
7665
7711
  },
7666
- "default": "false",
7667
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7668
- "fieldName": "required",
7712
+ "default": "''",
7713
+ "description": "The image source URL to render on the card",
7714
+ "fieldName": "imageSrc",
7669
7715
  "inheritedFrom": {
7670
- "name": "FormfieldWrapper",
7671
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7716
+ "name": "Card",
7717
+ "module": "src/components/card/card.component.ts"
7672
7718
  }
7673
7719
  },
7674
7720
  {
7675
- "name": "id",
7721
+ "name": "image-alt",
7676
7722
  "type": {
7677
7723
  "text": "string"
7678
7724
  },
7679
7725
  "default": "''",
7680
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7681
- "fieldName": "id",
7726
+ "description": "The image alt for accessibility support",
7727
+ "fieldName": "imageAlt",
7682
7728
  "inheritedFrom": {
7683
- "name": "FormfieldWrapper",
7684
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7729
+ "name": "Card",
7730
+ "module": "src/components/card/card.component.ts"
7685
7731
  }
7686
7732
  },
7687
7733
  {
7688
- "name": "help-text-type",
7734
+ "name": "variant",
7689
7735
  "type": {
7690
- "text": "ValidationType"
7736
+ "text": "CardVariant"
7691
7737
  },
7692
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7693
- "fieldName": "helpTextType",
7738
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7739
+ "default": "'border'",
7740
+ "fieldName": "variant",
7694
7741
  "inheritedFrom": {
7695
- "name": "FormfieldWrapper",
7696
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7742
+ "name": "Card",
7743
+ "module": "src/components/card/card.component.ts"
7697
7744
  }
7698
7745
  },
7699
7746
  {
7700
- "name": "help-text",
7747
+ "name": "orientation",
7701
7748
  "type": {
7702
- "text": "string | undefined"
7749
+ "text": "CardOrientation"
7703
7750
  },
7704
- "description": "The help text that is displayed below the input field.",
7705
- "fieldName": "helpText",
7751
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7752
+ "default": "'vertical'",
7753
+ "fieldName": "orientation",
7706
7754
  "inheritedFrom": {
7707
- "name": "FormfieldWrapper",
7708
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7755
+ "name": "Card",
7756
+ "module": "src/components/card/card.component.ts"
7709
7757
  }
7710
7758
  },
7711
7759
  {
7712
- "name": "toggletip-text",
7760
+ "name": "title-tag-name",
7713
7761
  "type": {
7714
- "text": "string | undefined"
7762
+ "text": "TagNameType"
7715
7763
  },
7716
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7717
- "fieldName": "toggletipText",
7764
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
7765
+ "default": "'span'",
7766
+ "fieldName": "titleTagName",
7718
7767
  "inheritedFrom": {
7719
- "name": "FormfieldWrapper",
7720
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7768
+ "name": "Card",
7769
+ "module": "src/components/card/card.component.ts"
7721
7770
  }
7722
7771
  },
7723
7772
  {
7724
- "name": "toggletip-placement",
7773
+ "name": "subtitle-tag-name",
7725
7774
  "type": {
7726
- "text": "PopoverPlacement"
7775
+ "text": "TagNameType"
7727
7776
  },
7728
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7729
- "default": "'top'",
7730
- "fieldName": "toggletipPlacement",
7777
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
7778
+ "default": "'span'",
7779
+ "fieldName": "subtitleTagName",
7731
7780
  "inheritedFrom": {
7732
- "name": "FormfieldWrapper",
7733
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7781
+ "name": "Card",
7782
+ "module": "src/components/card/card.component.ts"
7734
7783
  }
7735
7784
  },
7736
7785
  {
7737
- "name": "info-icon-aria-label",
7786
+ "name": "icon-name",
7738
7787
  "type": {
7739
- "text": "string | undefined"
7788
+ "text": "IconNames | undefined"
7740
7789
  },
7741
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
7742
- "fieldName": "infoIconAriaLabel",
7790
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7791
+ "fieldName": "iconName",
7743
7792
  "inheritedFrom": {
7744
- "name": "FormfieldWrapper",
7745
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7793
+ "name": "Card",
7794
+ "module": "src/components/card/card.component.ts"
7746
7795
  }
7747
7796
  }
7748
7797
  ],
7749
7798
  "mixins": [
7750
7799
  {
7751
- "name": "FormInternalsMixin",
7752
- "module": "/src/utils/mixins/FormInternalsMixin"
7800
+ "name": "DisabledMixin",
7801
+ "module": "/src/utils/mixins/DisabledMixin"
7753
7802
  },
7754
7803
  {
7755
- "name": "DataAriaLabelMixin",
7756
- "module": "/src/utils/mixins/DataAriaLabelMixin"
7804
+ "name": "TabIndexMixin",
7805
+ "module": "/src/utils/mixins/TabIndexMixin"
7757
7806
  }
7758
7807
  ],
7759
7808
  "superclass": {
7760
- "name": "FormfieldWrapper",
7761
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
7809
+ "name": "Card",
7810
+ "module": "/src/components/card/card.component"
7762
7811
  },
7763
- "tagName": "mdc-checkbox",
7764
- "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
7812
+ "tagName": "mdc-cardradio",
7813
+ "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of `mdc-button` component within the footer section.\n *\n * @csspart header - The header part of the card\n * @csspart icon - The icon part of the card header\n * @csspart body - The body part of the card\n * @csspart image - The image part of the card\n * @csspart footer - The footer part of the card\n * @csspart footer-link - The link part of the card footer\n * @csspart footer-button-primary - The primary button part of the card footer\n * @csspart footer-button-secondary - The secondary button part of the card footer\n * @csspart icon-button - The icon button part of the card header\n * @csspart text - The text part of the card\n * @csspart check - The check part of the card\n * @csspart check-icon - The check icon part of the card\n * @csspart check-icon-button - The check icon button part of the card\n *\n * @cssproperty --mdc-card-width - The width of the card\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
7765
7814
  "customElement": true
7766
7815
  }
7767
7816
  ],
@@ -7770,888 +7819,783 @@
7770
7819
  "kind": "js",
7771
7820
  "name": "default",
7772
7821
  "declaration": {
7773
- "name": "Checkbox",
7774
- "module": "components/checkbox/checkbox.component.js"
7822
+ "name": "CardRadio",
7823
+ "module": "components/cardradio/cardradio.component.js"
7775
7824
  }
7776
7825
  }
7777
7826
  ]
7778
7827
  },
7779
7828
  {
7780
7829
  "kind": "javascript-module",
7781
- "path": "components/chip/chip.component.js",
7830
+ "path": "components/checkbox/checkbox.component.js",
7782
7831
  "declarations": [
7783
7832
  {
7784
7833
  "kind": "class",
7785
- "description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
7786
- "name": "Chip",
7834
+ "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
7835
+ "name": "Checkbox",
7787
7836
  "cssProperties": [
7788
7837
  {
7789
- "description": "The color of the chip.",
7790
- "name": "--mdc-chip-color"
7838
+ "description": "Allows customization of the background color on hover.",
7839
+ "name": "--mdc-checkbox-background-color-hover"
7791
7840
  },
7792
7841
  {
7793
- "description": "The border color of the chip.",
7794
- "name": "--mdc-chip-border-color"
7842
+ "description": "Background color for a selected checkbox when hovered.",
7843
+ "name": "--mdc-checkbox-checked-background-color-hover"
7795
7844
  },
7796
7845
  {
7797
- "description": "The background color of the chip.",
7798
- "name": "--mdc-chip-background-color"
7846
+ "description": "Background color for a selected checkbox when pressed.",
7847
+ "name": "--mdc-checkbox-checked-pressed-icon-color"
7848
+ },
7849
+ {
7850
+ "description": "Background color for a selected checkbox when pressed.",
7851
+ "name": "--mdc-checkbox-pressed-icon-color"
7852
+ },
7853
+ {
7854
+ "description": "Background color for a selected checkbox when disabled.",
7855
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
7799
7856
  }
7800
7857
  ],
7801
7858
  "members": [
7802
7859
  {
7803
7860
  "kind": "field",
7804
- "name": "color",
7861
+ "name": "checked",
7805
7862
  "type": {
7806
- "text": "ColorType"
7863
+ "text": "boolean"
7807
7864
  },
7808
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
7809
- "default": "default",
7810
- "attribute": "color",
7865
+ "default": "false",
7866
+ "description": "Determines whether the checkbox is selected or unselected.",
7867
+ "attribute": "checked",
7811
7868
  "reflects": true
7812
7869
  },
7813
7870
  {
7814
7871
  "kind": "field",
7815
- "name": "label",
7872
+ "name": "indeterminate",
7816
7873
  "type": {
7817
- "text": "string"
7874
+ "text": "boolean"
7818
7875
  },
7819
- "default": "''",
7820
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
7821
- "attribute": "label"
7876
+ "default": "false",
7877
+ "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
7878
+ "attribute": "indeterminate",
7879
+ "reflects": true
7880
+ },
7881
+ {
7882
+ "kind": "field",
7883
+ "name": "autofocus",
7884
+ "type": {
7885
+ "text": "boolean"
7886
+ },
7887
+ "default": "false",
7888
+ "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
7889
+ "attribute": "autofocus",
7890
+ "reflects": true
7822
7891
  },
7823
7892
  {
7824
7893
  "kind": "method",
7825
- "name": "renderIcon",
7894
+ "name": "setFormValue",
7895
+ "privacy": "private",
7896
+ "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
7897
+ },
7898
+ {
7899
+ "kind": "method",
7900
+ "name": "manageRequired",
7901
+ "privacy": "private",
7902
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
7903
+ },
7904
+ {
7905
+ "kind": "method",
7906
+ "name": "toggleState",
7826
7907
  "privacy": "private",
7827
- "description": "Renders the icon element if available.",
7828
7908
  "return": {
7829
7909
  "type": {
7830
- "text": ""
7910
+ "text": "void"
7831
7911
  }
7832
- }
7912
+ },
7913
+ "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
7833
7914
  },
7834
7915
  {
7835
- "kind": "field",
7836
- "name": "iconName",
7837
- "type": {
7838
- "text": "IconNames | undefined"
7916
+ "kind": "method",
7917
+ "name": "handleKeyDown",
7918
+ "privacy": "private",
7919
+ "return": {
7920
+ "type": {
7921
+ "text": "void"
7922
+ }
7839
7923
  },
7840
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7841
- "attribute": "icon-name",
7842
- "inheritedFrom": {
7843
- "name": "IconNameMixin",
7844
- "module": "utils/mixins/IconNameMixin.js"
7845
- }
7924
+ "parameters": [
7925
+ {
7926
+ "name": "event",
7927
+ "type": {
7928
+ "text": "KeyboardEvent"
7929
+ },
7930
+ "description": "The keyboard event."
7931
+ }
7932
+ ],
7933
+ "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
7934
+ },
7935
+ {
7936
+ "kind": "method",
7937
+ "name": "handleChange",
7938
+ "privacy": "public",
7939
+ "return": {
7940
+ "type": {
7941
+ "text": "void"
7942
+ }
7943
+ },
7944
+ "parameters": [
7945
+ {
7946
+ "name": "event",
7947
+ "type": {
7948
+ "text": "Event"
7949
+ }
7950
+ }
7951
+ ],
7952
+ "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
7846
7953
  },
7847
7954
  {
7848
7955
  "kind": "field",
7849
- "name": "autofocus",
7956
+ "name": "renderLabelAndHelperText",
7957
+ "privacy": "private"
7958
+ },
7959
+ {
7960
+ "kind": "field",
7961
+ "name": "name",
7850
7962
  "type": {
7851
- "text": "boolean"
7963
+ "text": "string"
7852
7964
  },
7853
- "default": "false",
7854
- "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
7855
- "attribute": "autofocus",
7965
+ "default": "''",
7966
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7967
+ "attribute": "name",
7856
7968
  "reflects": true,
7857
7969
  "inheritedFrom": {
7858
- "name": "Buttonsimple",
7859
- "module": "components/buttonsimple/buttonsimple.component.js"
7970
+ "name": "FormInternalsMixin",
7971
+ "module": "utils/mixins/FormInternalsMixin.js"
7860
7972
  }
7861
7973
  },
7862
7974
  {
7863
7975
  "kind": "field",
7864
- "name": "tabIndex",
7976
+ "name": "value",
7865
7977
  "type": {
7866
- "text": "number"
7978
+ "text": "string"
7867
7979
  },
7868
- "default": "0",
7869
- "description": "This property specifies the tab order of the element.",
7870
- "attribute": "tabIndex",
7980
+ "default": "''",
7981
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7982
+ "attribute": "value",
7871
7983
  "reflects": true,
7872
7984
  "inheritedFrom": {
7873
- "name": "Buttonsimple",
7874
- "module": "components/buttonsimple/buttonsimple.component.js"
7985
+ "name": "FormInternalsMixin",
7986
+ "module": "utils/mixins/FormInternalsMixin.js"
7875
7987
  }
7876
7988
  },
7877
7989
  {
7878
7990
  "kind": "field",
7879
- "name": "disabled",
7991
+ "name": "validationMessage",
7880
7992
  "type": {
7881
- "text": "boolean | undefined"
7993
+ "text": "string | undefined"
7882
7994
  },
7883
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7884
- "default": "undefined",
7885
- "attribute": "disabled",
7995
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7996
+ "attribute": "validation-message",
7886
7997
  "reflects": true,
7887
7998
  "inheritedFrom": {
7888
- "name": "Buttonsimple",
7889
- "module": "components/buttonsimple/buttonsimple.component.js"
7999
+ "name": "FormInternalsMixin",
8000
+ "module": "utils/mixins/FormInternalsMixin.js"
7890
8001
  }
7891
8002
  },
7892
8003
  {
7893
8004
  "kind": "field",
7894
- "name": "active",
8005
+ "name": "validity",
7895
8006
  "type": {
7896
- "text": "boolean | undefined"
8007
+ "text": "ValidityState"
7897
8008
  },
7898
- "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.",
7899
- "default": "undefined",
7900
- "attribute": "active",
7901
- "reflects": true,
8009
+ "readonly": true,
7902
8010
  "inheritedFrom": {
7903
- "name": "Buttonsimple",
7904
- "module": "components/buttonsimple/buttonsimple.component.js"
8011
+ "name": "FormInternalsMixin",
8012
+ "module": "utils/mixins/FormInternalsMixin.js"
7905
8013
  }
7906
8014
  },
7907
8015
  {
7908
8016
  "kind": "field",
7909
- "name": "softDisabled",
7910
- "type": {
7911
- "text": "boolean | undefined"
7912
- },
7913
- "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.",
7914
- "default": "undefined",
7915
- "attribute": "soft-disabled",
7916
- "reflects": true,
8017
+ "name": "willValidate",
8018
+ "readonly": true,
7917
8019
  "inheritedFrom": {
7918
- "name": "Buttonsimple",
7919
- "module": "components/buttonsimple/buttonsimple.component.js"
8020
+ "name": "FormInternalsMixin",
8021
+ "module": "utils/mixins/FormInternalsMixin.js"
7920
8022
  }
7921
8023
  },
7922
8024
  {
7923
- "kind": "field",
7924
- "name": "size",
7925
- "type": {
7926
- "text": "ButtonSize"
8025
+ "kind": "method",
8026
+ "name": "setValidity",
8027
+ "description": "Sets the validity of the input field based on the input field's validity.",
8028
+ "return": {
8029
+ "type": {
8030
+ "text": ""
8031
+ }
7927
8032
  },
7928
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
7929
- "default": "32",
7930
- "attribute": "size",
7931
- "reflects": true,
7932
8033
  "inheritedFrom": {
7933
- "name": "Buttonsimple",
7934
- "module": "components/buttonsimple/buttonsimple.component.js"
8034
+ "name": "FormInternalsMixin",
8035
+ "module": "utils/mixins/FormInternalsMixin.js"
7935
8036
  }
7936
8037
  },
7937
8038
  {
7938
- "kind": "field",
7939
- "name": "role",
7940
- "type": {
7941
- "text": "RoleType"
8039
+ "kind": "method",
8040
+ "name": "checkValidity",
8041
+ "return": {
8042
+ "type": {
8043
+ "text": "boolean"
8044
+ }
7942
8045
  },
7943
- "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.",
7944
- "default": "button",
7945
- "attribute": "role",
7946
- "reflects": true,
7947
8046
  "inheritedFrom": {
7948
- "name": "Buttonsimple",
7949
- "module": "components/buttonsimple/buttonsimple.component.js"
8047
+ "name": "FormInternalsMixin",
8048
+ "module": "utils/mixins/FormInternalsMixin.js"
8049
+ }
8050
+ },
8051
+ {
8052
+ "kind": "method",
8053
+ "name": "reportValidity",
8054
+ "inheritedFrom": {
8055
+ "name": "FormInternalsMixin",
8056
+ "module": "utils/mixins/FormInternalsMixin.js"
7950
8057
  }
7951
8058
  },
7952
8059
  {
7953
8060
  "kind": "field",
7954
- "name": "ariaStateKey",
8061
+ "name": "dataAriaLabel",
7955
8062
  "type": {
7956
- "text": "string | undefined"
8063
+ "text": "string | null"
7957
8064
  },
7958
- "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`",
7959
- "default": "'aria-pressed' (when)",
7960
- "attribute": "ariaStateKey",
8065
+ "default": "null",
8066
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8067
+ "attribute": "data-aria-label",
7961
8068
  "reflects": true,
7962
8069
  "inheritedFrom": {
7963
- "name": "Buttonsimple",
7964
- "module": "components/buttonsimple/buttonsimple.component.js"
8070
+ "name": "DataAriaLabelMixin",
8071
+ "module": "utils/mixins/DataAriaLabelMixin.js"
7965
8072
  }
7966
8073
  },
7967
8074
  {
7968
8075
  "kind": "field",
7969
- "name": "type",
8076
+ "name": "disabled",
7970
8077
  "type": {
7971
- "text": "ButtonType"
8078
+ "text": "boolean | undefined"
7972
8079
  },
7973
- "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.",
7974
- "default": "button",
7975
- "attribute": "type",
8080
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8081
+ "default": "undefined",
8082
+ "attribute": "disabled",
7976
8083
  "reflects": true,
7977
8084
  "inheritedFrom": {
7978
- "name": "Buttonsimple",
7979
- "module": "components/buttonsimple/buttonsimple.component.js"
7980
- }
7981
- },
7982
- {
7983
- "kind": "method",
7984
- "name": "executeAction",
7985
- "privacy": "protected",
7986
- "inheritedFrom": {
7987
- "name": "Buttonsimple",
7988
- "module": "components/buttonsimple/buttonsimple.component.js"
7989
- }
7990
- },
7991
- {
7992
- "kind": "method",
7993
- "name": "setActive",
7994
- "privacy": "protected",
7995
- "parameters": [
7996
- {
7997
- "name": "element",
7998
- "type": {
7999
- "text": "HTMLElement"
8000
- },
8001
- "description": "The button element"
8002
- },
8003
- {
8004
- "name": "active",
8005
- "optional": true,
8006
- "type": {
8007
- "text": "boolean"
8008
- },
8009
- "description": "The active state of the element"
8010
- }
8011
- ],
8012
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
8013
- "inheritedFrom": {
8014
- "name": "Buttonsimple",
8015
- "module": "components/buttonsimple/buttonsimple.component.js"
8016
- }
8017
- },
8018
- {
8019
- "kind": "method",
8020
- "name": "setSoftDisabled",
8021
- "privacy": "private",
8022
- "parameters": [
8023
- {
8024
- "name": "element",
8025
- "type": {
8026
- "text": "HTMLElement"
8027
- },
8028
- "description": "The button element."
8029
- },
8030
- {
8031
- "name": "softDisabled",
8032
- "optional": true,
8033
- "type": {
8034
- "text": "boolean"
8035
- },
8036
- "description": "The soft-disabled state."
8037
- }
8038
- ],
8039
- "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.",
8040
- "inheritedFrom": {
8041
- "name": "Buttonsimple",
8042
- "module": "components/buttonsimple/buttonsimple.component.js"
8043
- }
8044
- },
8045
- {
8046
- "kind": "method",
8047
- "name": "setDisabled",
8048
- "privacy": "private",
8049
- "parameters": [
8050
- {
8051
- "name": "element",
8052
- "type": {
8053
- "text": "HTMLElement"
8054
- },
8055
- "description": "The button element."
8056
- },
8057
- {
8058
- "name": "disabled",
8059
- "type": {
8060
- "text": "boolean"
8061
- },
8062
- "description": "The disabled state."
8063
- }
8064
- ],
8065
- "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.",
8066
- "inheritedFrom": {
8067
- "name": "Buttonsimple",
8068
- "module": "components/buttonsimple/buttonsimple.component.js"
8069
- }
8070
- },
8071
- {
8072
- "kind": "method",
8073
- "name": "triggerClickEvent",
8074
- "privacy": "private",
8075
- "inheritedFrom": {
8076
- "name": "Buttonsimple",
8077
- "module": "components/buttonsimple/buttonsimple.component.js"
8078
- }
8079
- },
8080
- {
8081
- "kind": "method",
8082
- "name": "handleBlur",
8083
- "privacy": "private",
8084
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
8085
- "inheritedFrom": {
8086
- "name": "Buttonsimple",
8087
- "module": "components/buttonsimple/buttonsimple.component.js"
8088
- }
8089
- },
8090
- {
8091
- "kind": "method",
8092
- "name": "handleKeyDown",
8093
- "privacy": "private",
8094
- "parameters": [
8095
- {
8096
- "name": "event",
8097
- "type": {
8098
- "text": "KeyboardEvent"
8099
- },
8100
- "description": "The keyboard event."
8101
- }
8102
- ],
8103
- "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.",
8104
- "inheritedFrom": {
8105
- "name": "Buttonsimple",
8106
- "module": "components/buttonsimple/buttonsimple.component.js"
8107
- }
8108
- },
8109
- {
8110
- "kind": "method",
8111
- "name": "handleKeyUp",
8112
- "privacy": "private",
8113
- "parameters": [
8114
- {
8115
- "name": "event",
8116
- "type": {
8117
- "text": "KeyboardEvent"
8118
- },
8119
- "description": "The keyboard event."
8120
- }
8121
- ],
8122
- "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.",
8123
- "inheritedFrom": {
8124
- "name": "Buttonsimple",
8125
- "module": "components/buttonsimple/buttonsimple.component.js"
8085
+ "name": "DisabledMixin",
8086
+ "module": "utils/mixins/DisabledMixin.js"
8126
8087
  }
8127
- }
8128
- ],
8129
- "attributes": [
8130
- {
8131
- "name": "color",
8132
- "type": {
8133
- "text": "ColorType"
8134
- },
8135
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
8136
- "default": "default",
8137
- "fieldName": "color"
8138
8088
  },
8139
8089
  {
8090
+ "kind": "field",
8140
8091
  "name": "label",
8141
8092
  "type": {
8142
- "text": "string"
8143
- },
8144
- "default": "''",
8145
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
8146
- "fieldName": "label"
8147
- },
8148
- {
8149
- "name": "icon-name",
8150
- "type": {
8151
- "text": "IconNames | undefined"
8093
+ "text": "string | undefined"
8152
8094
  },
8153
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8154
- "fieldName": "iconName",
8095
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8096
+ "attribute": "label",
8097
+ "reflects": true,
8155
8098
  "inheritedFrom": {
8156
- "name": "IconNameMixin",
8157
- "module": "src/utils/mixins/IconNameMixin.ts"
8099
+ "name": "FormfieldWrapper",
8100
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8158
8101
  }
8159
8102
  },
8160
8103
  {
8161
- "name": "autofocus",
8104
+ "kind": "field",
8105
+ "name": "required",
8162
8106
  "type": {
8163
8107
  "text": "boolean"
8164
8108
  },
8165
8109
  "default": "false",
8166
- "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
8167
- "fieldName": "autofocus",
8110
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
8111
+ "attribute": "required",
8112
+ "reflects": true,
8168
8113
  "inheritedFrom": {
8169
- "name": "Buttonsimple",
8170
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8114
+ "name": "FormfieldWrapper",
8115
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8171
8116
  }
8172
8117
  },
8173
8118
  {
8174
- "name": "tabIndex",
8119
+ "kind": "field",
8120
+ "name": "id",
8175
8121
  "type": {
8176
- "text": "number"
8122
+ "text": "string"
8177
8123
  },
8178
- "default": "0",
8179
- "description": "This property specifies the tab order of the element.",
8180
- "fieldName": "tabIndex",
8124
+ "default": "''",
8125
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
8126
+ "attribute": "id",
8181
8127
  "inheritedFrom": {
8182
- "name": "Buttonsimple",
8183
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8128
+ "name": "FormfieldWrapper",
8129
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8184
8130
  }
8185
8131
  },
8186
8132
  {
8187
- "name": "disabled",
8133
+ "kind": "field",
8134
+ "name": "helpTextType",
8188
8135
  "type": {
8189
- "text": "boolean | undefined"
8136
+ "text": "ValidationType"
8190
8137
  },
8191
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8192
- "default": "undefined",
8193
- "fieldName": "disabled",
8138
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8139
+ "attribute": "help-text-type",
8140
+ "reflects": true,
8194
8141
  "inheritedFrom": {
8195
- "name": "Buttonsimple",
8196
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8142
+ "name": "FormfieldWrapper",
8143
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8197
8144
  }
8198
8145
  },
8199
8146
  {
8200
- "name": "active",
8147
+ "kind": "field",
8148
+ "name": "helpText",
8201
8149
  "type": {
8202
- "text": "boolean | undefined"
8150
+ "text": "string | undefined"
8203
8151
  },
8204
- "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.",
8205
- "default": "undefined",
8206
- "fieldName": "active",
8152
+ "description": "The help text that is displayed below the input field.",
8153
+ "attribute": "help-text",
8154
+ "reflects": true,
8207
8155
  "inheritedFrom": {
8208
- "name": "Buttonsimple",
8209
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8156
+ "name": "FormfieldWrapper",
8157
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8210
8158
  }
8211
8159
  },
8212
8160
  {
8213
- "name": "soft-disabled",
8161
+ "kind": "field",
8162
+ "name": "toggletipText",
8214
8163
  "type": {
8215
- "text": "boolean | undefined"
8164
+ "text": "string | undefined"
8216
8165
  },
8217
- "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.",
8218
- "default": "undefined",
8219
- "fieldName": "softDisabled",
8166
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
8167
+ "attribute": "toggletip-text",
8168
+ "reflects": true,
8220
8169
  "inheritedFrom": {
8221
- "name": "Buttonsimple",
8222
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8170
+ "name": "FormfieldWrapper",
8171
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8223
8172
  }
8224
8173
  },
8225
8174
  {
8226
- "name": "size",
8175
+ "kind": "field",
8176
+ "name": "toggletipPlacement",
8227
8177
  "type": {
8228
- "text": "ButtonSize"
8178
+ "text": "PopoverPlacement"
8229
8179
  },
8230
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
8231
- "default": "32",
8232
- "fieldName": "size",
8180
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
8181
+ "default": "'top'",
8182
+ "attribute": "toggletip-placement",
8183
+ "reflects": true,
8233
8184
  "inheritedFrom": {
8234
- "name": "Buttonsimple",
8235
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8185
+ "name": "FormfieldWrapper",
8186
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8236
8187
  }
8237
8188
  },
8238
8189
  {
8239
- "name": "role",
8190
+ "kind": "field",
8191
+ "name": "infoIconAriaLabel",
8240
8192
  "type": {
8241
- "text": "RoleType"
8193
+ "text": "string | undefined"
8242
8194
  },
8243
- "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.",
8244
- "default": "button",
8245
- "fieldName": "role",
8195
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
8196
+ "attribute": "info-icon-aria-label",
8197
+ "reflects": true,
8246
8198
  "inheritedFrom": {
8247
- "name": "Buttonsimple",
8248
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8199
+ "name": "FormfieldWrapper",
8200
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8249
8201
  }
8250
8202
  },
8251
8203
  {
8252
- "name": "ariaStateKey",
8253
- "type": {
8254
- "text": "string | undefined"
8204
+ "kind": "method",
8205
+ "name": "renderLabelElement",
8206
+ "privacy": "protected",
8207
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
8208
+ "return": {
8209
+ "type": {
8210
+ "text": ""
8211
+ }
8255
8212
  },
8256
- "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`",
8257
- "default": "'aria-pressed' (when)",
8258
- "fieldName": "ariaStateKey",
8259
8213
  "inheritedFrom": {
8260
- "name": "Buttonsimple",
8261
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8214
+ "name": "FormfieldWrapper",
8215
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8262
8216
  }
8263
8217
  },
8264
8218
  {
8265
- "name": "type",
8266
- "type": {
8267
- "text": "ButtonType"
8219
+ "kind": "method",
8220
+ "name": "renderHelpTextIcon",
8221
+ "privacy": "protected",
8222
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
8223
+ "return": {
8224
+ "type": {
8225
+ "text": ""
8226
+ }
8268
8227
  },
8269
- "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.",
8270
- "default": "button",
8271
- "fieldName": "type",
8272
- "inheritedFrom": {
8273
- "name": "Buttonsimple",
8274
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8275
- }
8276
- }
8277
- ],
8278
- "mixins": [
8279
- {
8280
- "name": "IconNameMixin",
8281
- "module": "/src/utils/mixins/IconNameMixin"
8282
- }
8283
- ],
8284
- "superclass": {
8285
- "name": "Buttonsimple",
8286
- "module": "/src/components/buttonsimple/buttonsimple.component"
8287
- },
8288
- "tagName": "mdc-chip",
8289
- "jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
8290
- "customElement": true,
8291
- "events": [
8292
- {
8293
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
8294
- "name": "click",
8295
- "reactName": "onClick",
8296
8228
  "inheritedFrom": {
8297
- "name": "Buttonsimple",
8298
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8229
+ "name": "FormfieldWrapper",
8230
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8299
8231
  }
8300
8232
  },
8301
8233
  {
8302
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
8303
- "name": "keydown",
8304
- "reactName": "onKeyDown",
8234
+ "kind": "method",
8235
+ "name": "renderHelpText",
8236
+ "privacy": "protected",
8237
+ "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
8238
+ "return": {
8239
+ "type": {
8240
+ "text": ""
8241
+ }
8242
+ },
8305
8243
  "inheritedFrom": {
8306
- "name": "Buttonsimple",
8307
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8244
+ "name": "FormfieldWrapper",
8245
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8308
8246
  }
8309
8247
  },
8310
8248
  {
8311
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
8312
- "name": "keyup",
8313
- "reactName": "onKeyUp",
8249
+ "kind": "method",
8250
+ "name": "renderLabel",
8251
+ "privacy": "protected",
8252
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
8253
+ "return": {
8254
+ "type": {
8255
+ "text": ""
8256
+ }
8257
+ },
8314
8258
  "inheritedFrom": {
8315
- "name": "Buttonsimple",
8316
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8259
+ "name": "FormfieldWrapper",
8260
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8317
8261
  }
8318
8262
  },
8319
8263
  {
8320
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
8321
- "name": "focus",
8322
- "reactName": "onFocus",
8264
+ "kind": "method",
8265
+ "name": "renderHelperText",
8266
+ "privacy": "protected",
8267
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
8268
+ "return": {
8269
+ "type": {
8270
+ "text": ""
8271
+ }
8272
+ },
8323
8273
  "inheritedFrom": {
8324
- "name": "Buttonsimple",
8325
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8274
+ "name": "FormfieldWrapper",
8275
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8326
8276
  }
8327
8277
  }
8328
- ]
8329
- }
8330
- ],
8331
- "exports": [
8332
- {
8333
- "kind": "js",
8334
- "name": "default",
8335
- "declaration": {
8336
- "name": "Chip",
8337
- "module": "components/chip/chip.component.js"
8338
- }
8339
- }
8340
- ]
8341
- },
8342
- {
8343
- "kind": "javascript-module",
8344
- "path": "components/cardradio/cardradio.component.js",
8345
- "declarations": [
8346
- {
8347
- "kind": "class",
8348
- "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
8349
- "name": "CardRadio",
8350
- "cssProperties": [
8278
+ ],
8279
+ "events": [
8351
8280
  {
8352
- "description": "The width of the card",
8353
- "name": "--mdc-card-width",
8354
- "inheritedFrom": {
8355
- "name": "Card",
8356
- "module": "src/components/card/card.component.ts"
8281
+ "type": {
8282
+ "text": "EventConstructor"
8357
8283
  }
8284
+ },
8285
+ {
8286
+ "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
8287
+ "name": "change",
8288
+ "reactName": "onChange"
8289
+ },
8290
+ {
8291
+ "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
8292
+ "name": "focus",
8293
+ "reactName": "onFocus"
8358
8294
  }
8359
8295
  ],
8360
- "cssParts": [
8296
+ "attributes": [
8361
8297
  {
8362
- "description": "The header part of the card",
8363
- "name": "header",
8364
- "inheritedFrom": {
8365
- "name": "Card",
8366
- "module": "src/components/card/card.component.ts"
8367
- }
8298
+ "name": "checked",
8299
+ "type": {
8300
+ "text": "boolean"
8301
+ },
8302
+ "default": "false",
8303
+ "description": "Determines whether the checkbox is selected or unselected.",
8304
+ "fieldName": "checked"
8368
8305
  },
8369
8306
  {
8370
- "description": "The icon part of the card header",
8371
- "name": "icon",
8372
- "inheritedFrom": {
8373
- "name": "Card",
8374
- "module": "src/components/card/card.component.ts"
8375
- }
8307
+ "name": "indeterminate",
8308
+ "type": {
8309
+ "text": "boolean"
8310
+ },
8311
+ "default": "false",
8312
+ "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
8313
+ "fieldName": "indeterminate"
8376
8314
  },
8377
8315
  {
8378
- "description": "The body part of the card",
8379
- "name": "body",
8380
- "inheritedFrom": {
8381
- "name": "Card",
8382
- "module": "src/components/card/card.component.ts"
8383
- }
8316
+ "name": "autofocus",
8317
+ "type": {
8318
+ "text": "boolean"
8319
+ },
8320
+ "default": "false",
8321
+ "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
8322
+ "fieldName": "autofocus"
8384
8323
  },
8385
8324
  {
8386
- "description": "The image part of the card",
8387
- "name": "image",
8325
+ "name": "name",
8326
+ "type": {
8327
+ "text": "string"
8328
+ },
8329
+ "default": "''",
8330
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
8331
+ "fieldName": "name",
8388
8332
  "inheritedFrom": {
8389
- "name": "Card",
8390
- "module": "src/components/card/card.component.ts"
8333
+ "name": "FormInternalsMixin",
8334
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
8391
8335
  }
8392
8336
  },
8393
8337
  {
8394
- "description": "The footer part of the card",
8395
- "name": "footer",
8338
+ "name": "value",
8339
+ "type": {
8340
+ "text": "string"
8341
+ },
8342
+ "default": "''",
8343
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
8344
+ "fieldName": "value",
8396
8345
  "inheritedFrom": {
8397
- "name": "Card",
8398
- "module": "src/components/card/card.component.ts"
8346
+ "name": "FormInternalsMixin",
8347
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
8399
8348
  }
8400
8349
  },
8401
8350
  {
8402
- "description": "The link part of the card footer",
8403
- "name": "footer-link",
8351
+ "name": "validation-message",
8352
+ "type": {
8353
+ "text": "string | undefined"
8354
+ },
8355
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
8356
+ "fieldName": "validationMessage",
8404
8357
  "inheritedFrom": {
8405
- "name": "Card",
8406
- "module": "src/components/card/card.component.ts"
8358
+ "name": "FormInternalsMixin",
8359
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
8407
8360
  }
8408
8361
  },
8409
8362
  {
8410
- "description": "The primary button part of the card footer",
8411
- "name": "footer-button-primary",
8363
+ "name": "data-aria-label",
8364
+ "type": {
8365
+ "text": "string | null"
8366
+ },
8367
+ "default": "null",
8368
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8369
+ "fieldName": "dataAriaLabel",
8412
8370
  "inheritedFrom": {
8413
- "name": "Card",
8414
- "module": "src/components/card/card.component.ts"
8371
+ "name": "DataAriaLabelMixin",
8372
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
8415
8373
  }
8416
8374
  },
8417
8375
  {
8418
- "description": "The secondary button part of the card footer",
8419
- "name": "footer-button-secondary",
8376
+ "name": "disabled",
8377
+ "type": {
8378
+ "text": "boolean | undefined"
8379
+ },
8380
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8381
+ "default": "undefined",
8382
+ "fieldName": "disabled",
8420
8383
  "inheritedFrom": {
8421
- "name": "Card",
8422
- "module": "src/components/card/card.component.ts"
8384
+ "name": "DisabledMixin",
8385
+ "module": "src/utils/mixins/DisabledMixin.ts"
8423
8386
  }
8424
8387
  },
8425
8388
  {
8426
- "description": "The icon button part of the card header",
8427
- "name": "icon-button",
8389
+ "name": "label",
8390
+ "type": {
8391
+ "text": "string | undefined"
8392
+ },
8393
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8394
+ "fieldName": "label",
8428
8395
  "inheritedFrom": {
8429
- "name": "Card",
8430
- "module": "src/components/card/card.component.ts"
8396
+ "name": "FormfieldWrapper",
8397
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8431
8398
  }
8432
8399
  },
8433
8400
  {
8434
- "description": "The text part of the card",
8435
- "name": "text",
8401
+ "name": "required",
8402
+ "type": {
8403
+ "text": "boolean"
8404
+ },
8405
+ "default": "false",
8406
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
8407
+ "fieldName": "required",
8436
8408
  "inheritedFrom": {
8437
- "name": "Card",
8438
- "module": "src/components/card/card.component.ts"
8409
+ "name": "FormfieldWrapper",
8410
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8439
8411
  }
8440
8412
  },
8441
8413
  {
8442
- "description": "The check part of the card",
8443
- "name": "check"
8444
- },
8445
- {
8446
- "description": "The check icon part of the card",
8447
- "name": "check-icon"
8414
+ "name": "id",
8415
+ "type": {
8416
+ "text": "string"
8417
+ },
8418
+ "default": "''",
8419
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
8420
+ "fieldName": "id",
8421
+ "inheritedFrom": {
8422
+ "name": "FormfieldWrapper",
8423
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8424
+ }
8448
8425
  },
8449
8426
  {
8450
- "description": "The check icon button part of the card",
8451
- "name": "check-icon-button"
8452
- }
8453
- ],
8454
- "slots": [
8455
- {
8456
- "description": "This slot is for passing the content before the body",
8457
- "name": "before-body",
8427
+ "name": "help-text-type",
8428
+ "type": {
8429
+ "text": "ValidationType"
8430
+ },
8431
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8432
+ "fieldName": "helpTextType",
8458
8433
  "inheritedFrom": {
8459
- "name": "Card",
8460
- "module": "src/components/card/card.component.ts"
8434
+ "name": "FormfieldWrapper",
8435
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8461
8436
  }
8462
8437
  },
8463
8438
  {
8464
- "description": "This slot is for passing the text content for the card",
8465
- "name": "body",
8439
+ "name": "help-text",
8440
+ "type": {
8441
+ "text": "string | undefined"
8442
+ },
8443
+ "description": "The help text that is displayed below the input field.",
8444
+ "fieldName": "helpText",
8466
8445
  "inheritedFrom": {
8467
- "name": "Card",
8468
- "module": "src/components/card/card.component.ts"
8446
+ "name": "FormfieldWrapper",
8447
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8469
8448
  }
8470
8449
  },
8471
8450
  {
8472
- "description": "This slot is for passing the content after the body",
8473
- "name": "after-body",
8451
+ "name": "toggletip-text",
8452
+ "type": {
8453
+ "text": "string | undefined"
8454
+ },
8455
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
8456
+ "fieldName": "toggletipText",
8474
8457
  "inheritedFrom": {
8475
- "name": "Card",
8476
- "module": "src/components/card/card.component.ts"
8458
+ "name": "FormfieldWrapper",
8459
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8477
8460
  }
8478
8461
  },
8479
8462
  {
8480
- "description": "This slot is for passing `mdc-link` component within the footer section.",
8481
- "name": "footer-link",
8463
+ "name": "toggletip-placement",
8464
+ "type": {
8465
+ "text": "PopoverPlacement"
8466
+ },
8467
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
8468
+ "default": "'top'",
8469
+ "fieldName": "toggletipPlacement",
8482
8470
  "inheritedFrom": {
8483
- "name": "Card",
8484
- "module": "src/components/card/card.component.ts"
8471
+ "name": "FormfieldWrapper",
8472
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8485
8473
  }
8486
8474
  },
8487
8475
  {
8488
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
8489
- "name": "footer-button-primary",
8476
+ "name": "info-icon-aria-label",
8477
+ "type": {
8478
+ "text": "string | undefined"
8479
+ },
8480
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
8481
+ "fieldName": "infoIconAriaLabel",
8490
8482
  "inheritedFrom": {
8491
- "name": "Card",
8492
- "module": "src/components/card/card.component.ts"
8483
+ "name": "FormfieldWrapper",
8484
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8493
8485
  }
8486
+ }
8487
+ ],
8488
+ "mixins": [
8489
+ {
8490
+ "name": "FormInternalsMixin",
8491
+ "module": "/src/utils/mixins/FormInternalsMixin"
8494
8492
  },
8495
8493
  {
8496
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
8497
- "name": "footer-button-secondary",
8498
- "inheritedFrom": {
8499
- "name": "Card",
8500
- "module": "src/components/card/card.component.ts"
8501
- }
8494
+ "name": "DataAriaLabelMixin",
8495
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
8496
+ }
8497
+ ],
8498
+ "superclass": {
8499
+ "name": "FormfieldWrapper",
8500
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
8501
+ },
8502
+ "tagName": "mdc-checkbox",
8503
+ "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
8504
+ "customElement": true
8505
+ }
8506
+ ],
8507
+ "exports": [
8508
+ {
8509
+ "kind": "js",
8510
+ "name": "default",
8511
+ "declaration": {
8512
+ "name": "Checkbox",
8513
+ "module": "components/checkbox/checkbox.component.js"
8514
+ }
8515
+ }
8516
+ ]
8517
+ },
8518
+ {
8519
+ "kind": "javascript-module",
8520
+ "path": "components/chip/chip.component.js",
8521
+ "declarations": [
8522
+ {
8523
+ "kind": "class",
8524
+ "description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
8525
+ "name": "Chip",
8526
+ "cssProperties": [
8527
+ {
8528
+ "description": "The color of the chip.",
8529
+ "name": "--mdc-chip-color"
8502
8530
  },
8503
8531
  {
8504
- "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
8505
- "name": "footer",
8506
- "inheritedFrom": {
8507
- "name": "Card",
8508
- "module": "src/components/card/card.component.ts"
8509
- }
8532
+ "description": "The border color of the chip.",
8533
+ "name": "--mdc-chip-border-color"
8534
+ },
8535
+ {
8536
+ "description": "The background color of the chip.",
8537
+ "name": "--mdc-chip-background-color"
8510
8538
  }
8511
8539
  ],
8512
8540
  "members": [
8513
8541
  {
8514
8542
  "kind": "field",
8515
- "name": "checked",
8543
+ "name": "color",
8516
8544
  "type": {
8517
- "text": "boolean"
8545
+ "text": "ColorType"
8518
8546
  },
8519
- "default": "false",
8520
- "description": "The checked state of the card",
8521
- "attribute": "checked",
8547
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
8548
+ "default": "default",
8549
+ "attribute": "color",
8522
8550
  "reflects": true
8523
8551
  },
8524
8552
  {
8525
8553
  "kind": "field",
8526
- "name": "name",
8554
+ "name": "label",
8527
8555
  "type": {
8528
8556
  "text": "string"
8529
8557
  },
8530
8558
  "default": "''",
8531
- "description": "The name of the radio.",
8532
- "attribute": "name"
8533
- },
8534
- {
8535
- "kind": "method",
8536
- "name": "getAllCardsWithinSameGroup",
8537
- "privacy": "private",
8538
- "return": {
8539
- "type": {
8540
- "text": "CardRadio[]"
8541
- }
8542
- },
8543
- "description": "Returns all cards within the same group (name)."
8544
- },
8545
- {
8546
- "kind": "method",
8547
- "name": "toggleChecked",
8548
- "privacy": "private",
8549
- "return": {
8550
- "type": {
8551
- "text": "void"
8552
- }
8553
- },
8554
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
8555
- },
8556
- {
8557
- "kind": "method",
8558
- "name": "setDisabled",
8559
- "return": {
8560
- "type": {
8561
- "text": "void"
8562
- }
8563
- },
8564
- "parameters": [
8565
- {
8566
- "name": "disabled",
8567
- "type": {
8568
- "text": "boolean"
8569
- }
8570
- }
8571
- ]
8559
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
8560
+ "attribute": "label"
8572
8561
  },
8573
8562
  {
8574
8563
  "kind": "method",
8575
- "name": "updateCardRadio",
8564
+ "name": "renderIcon",
8576
8565
  "privacy": "private",
8566
+ "description": "Renders the icon element if available.",
8577
8567
  "return": {
8578
8568
  "type": {
8579
- "text": "void"
8580
- }
8581
- },
8582
- "parameters": [
8583
- {
8584
- "name": "cards",
8585
- "type": {
8586
- "text": "CardRadio[]"
8587
- }
8588
- },
8589
- {
8590
- "name": "index",
8591
- "type": {
8592
- "text": "number"
8593
- }
8594
- }
8595
- ]
8596
- },
8597
- {
8598
- "kind": "method",
8599
- "name": "toggleOnEnter",
8600
- "privacy": "private",
8601
- "parameters": [
8602
- {
8603
- "name": "event",
8604
- "type": {
8605
- "text": "KeyboardEvent"
8606
- },
8607
- "description": "The keyboard event"
8608
- }
8609
- ],
8610
- "description": "Toggles the checked state when enter key is used"
8611
- },
8612
- {
8613
- "kind": "method",
8614
- "name": "toggleOnSpace",
8615
- "privacy": "private",
8616
- "parameters": [
8617
- {
8618
- "name": "event",
8619
- "type": {
8620
- "text": "KeyboardEvent"
8621
- },
8622
- "description": "The keyboard event"
8569
+ "text": ""
8623
8570
  }
8624
- ],
8625
- "description": "Toggles the checked state when space key is used"
8571
+ }
8626
8572
  },
8627
8573
  {
8628
- "kind": "method",
8629
- "name": "renderHeader",
8630
- "privacy": "protected",
8631
- "description": "Renders the header of the card",
8632
- "return": {
8633
- "type": {
8634
- "text": ""
8635
- }
8574
+ "kind": "field",
8575
+ "name": "iconName",
8576
+ "type": {
8577
+ "text": "IconNames | undefined"
8636
8578
  },
8579
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8580
+ "attribute": "icon-name",
8637
8581
  "inheritedFrom": {
8638
- "name": "Card",
8639
- "module": "components/card/card.component.js"
8582
+ "name": "IconNameMixin",
8583
+ "module": "utils/mixins/IconNameMixin.js"
8640
8584
  }
8641
8585
  },
8642
8586
  {
8643
8587
  "kind": "field",
8644
- "name": "disabled",
8588
+ "name": "autofocus",
8645
8589
  "type": {
8646
- "text": "boolean | undefined"
8590
+ "text": "boolean"
8647
8591
  },
8648
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8649
- "default": "undefined",
8650
- "attribute": "disabled",
8592
+ "default": "false",
8593
+ "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
8594
+ "attribute": "autofocus",
8651
8595
  "reflects": true,
8652
8596
  "inheritedFrom": {
8653
- "name": "DisabledMixin",
8654
- "module": "utils/mixins/DisabledMixin.js"
8597
+ "name": "Buttonsimple",
8598
+ "module": "components/buttonsimple/buttonsimple.component.js"
8655
8599
  }
8656
8600
  },
8657
8601
  {
@@ -8665,257 +8609,304 @@
8665
8609
  "attribute": "tabIndex",
8666
8610
  "reflects": true,
8667
8611
  "inheritedFrom": {
8668
- "name": "TabIndexMixin",
8669
- "module": "utils/mixins/TabIndexMixin.js"
8670
- }
8671
- },
8672
- {
8673
- "kind": "field",
8674
- "name": "cardTitle",
8675
- "type": {
8676
- "text": "string"
8677
- },
8678
- "default": "''",
8679
- "description": "The title of the card - part of header section",
8680
- "attribute": "card-title",
8681
- "reflects": true,
8682
- "inheritedFrom": {
8683
- "name": "Card",
8684
- "module": "components/card/card.component.js"
8685
- }
8686
- },
8687
- {
8688
- "kind": "field",
8689
- "name": "subtitle",
8690
- "type": {
8691
- "text": "string"
8692
- },
8693
- "default": "''",
8694
- "description": "The subtitle of the card - part of header section",
8695
- "attribute": "subtitle",
8696
- "reflects": true,
8697
- "inheritedFrom": {
8698
- "name": "Card",
8699
- "module": "components/card/card.component.js"
8612
+ "name": "Buttonsimple",
8613
+ "module": "components/buttonsimple/buttonsimple.component.js"
8700
8614
  }
8701
8615
  },
8702
8616
  {
8703
8617
  "kind": "field",
8704
- "name": "imageSrc",
8618
+ "name": "disabled",
8705
8619
  "type": {
8706
- "text": "string"
8620
+ "text": "boolean | undefined"
8707
8621
  },
8708
- "default": "''",
8709
- "description": "The image source URL to render on the card",
8710
- "attribute": "image-src",
8622
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8623
+ "default": "undefined",
8624
+ "attribute": "disabled",
8711
8625
  "reflects": true,
8712
8626
  "inheritedFrom": {
8713
- "name": "Card",
8714
- "module": "components/card/card.component.js"
8627
+ "name": "Buttonsimple",
8628
+ "module": "components/buttonsimple/buttonsimple.component.js"
8715
8629
  }
8716
8630
  },
8717
8631
  {
8718
8632
  "kind": "field",
8719
- "name": "imageAlt",
8633
+ "name": "active",
8720
8634
  "type": {
8721
- "text": "string"
8635
+ "text": "boolean | undefined"
8722
8636
  },
8723
- "default": "''",
8724
- "description": "The image alt for accessibility support",
8725
- "attribute": "image-alt",
8637
+ "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.",
8638
+ "default": "undefined",
8639
+ "attribute": "active",
8726
8640
  "reflects": true,
8727
8641
  "inheritedFrom": {
8728
- "name": "Card",
8729
- "module": "components/card/card.component.js"
8642
+ "name": "Buttonsimple",
8643
+ "module": "components/buttonsimple/buttonsimple.component.js"
8730
8644
  }
8731
8645
  },
8732
8646
  {
8733
8647
  "kind": "field",
8734
- "name": "variant",
8648
+ "name": "softDisabled",
8735
8649
  "type": {
8736
- "text": "CardVariant"
8650
+ "text": "boolean | undefined"
8737
8651
  },
8738
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
8739
- "default": "'border'",
8740
- "attribute": "variant",
8652
+ "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.",
8653
+ "default": "undefined",
8654
+ "attribute": "soft-disabled",
8741
8655
  "reflects": true,
8742
8656
  "inheritedFrom": {
8743
- "name": "Card",
8744
- "module": "components/card/card.component.js"
8657
+ "name": "Buttonsimple",
8658
+ "module": "components/buttonsimple/buttonsimple.component.js"
8745
8659
  }
8746
8660
  },
8747
8661
  {
8748
8662
  "kind": "field",
8749
- "name": "orientation",
8663
+ "name": "size",
8750
8664
  "type": {
8751
- "text": "CardOrientation"
8665
+ "text": "ButtonSize"
8752
8666
  },
8753
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
8754
- "default": "'vertical'",
8755
- "attribute": "orientation",
8667
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
8668
+ "default": "32",
8669
+ "attribute": "size",
8756
8670
  "reflects": true,
8757
8671
  "inheritedFrom": {
8758
- "name": "Card",
8759
- "module": "components/card/card.component.js"
8672
+ "name": "Buttonsimple",
8673
+ "module": "components/buttonsimple/buttonsimple.component.js"
8760
8674
  }
8761
8675
  },
8762
8676
  {
8763
8677
  "kind": "field",
8764
- "name": "titleTagName",
8678
+ "name": "role",
8765
8679
  "type": {
8766
- "text": "TagNameType"
8680
+ "text": "RoleType"
8767
8681
  },
8768
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
8769
- "default": "'span'",
8770
- "attribute": "title-tag-name",
8682
+ "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.",
8683
+ "default": "button",
8684
+ "attribute": "role",
8771
8685
  "reflects": true,
8772
8686
  "inheritedFrom": {
8773
- "name": "Card",
8774
- "module": "components/card/card.component.js"
8687
+ "name": "Buttonsimple",
8688
+ "module": "components/buttonsimple/buttonsimple.component.js"
8775
8689
  }
8776
8690
  },
8777
8691
  {
8778
8692
  "kind": "field",
8779
- "name": "subtitleTagName",
8693
+ "name": "ariaStateKey",
8780
8694
  "type": {
8781
- "text": "TagNameType"
8695
+ "text": "string | undefined"
8782
8696
  },
8783
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
8784
- "default": "'span'",
8785
- "attribute": "subtitle-tag-name",
8697
+ "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`",
8698
+ "default": "'aria-pressed' (when)",
8699
+ "attribute": "ariaStateKey",
8786
8700
  "reflects": true,
8787
8701
  "inheritedFrom": {
8788
- "name": "Card",
8789
- "module": "components/card/card.component.js"
8702
+ "name": "Buttonsimple",
8703
+ "module": "components/buttonsimple/buttonsimple.component.js"
8790
8704
  }
8791
8705
  },
8792
8706
  {
8793
8707
  "kind": "field",
8794
- "name": "iconName",
8708
+ "name": "type",
8795
8709
  "type": {
8796
- "text": "IconNames | undefined"
8710
+ "text": "ButtonType"
8797
8711
  },
8798
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8799
- "attribute": "icon-name",
8712
+ "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.",
8713
+ "default": "button",
8714
+ "attribute": "type",
8800
8715
  "reflects": true,
8801
8716
  "inheritedFrom": {
8802
- "name": "Card",
8803
- "module": "components/card/card.component.js"
8717
+ "name": "Buttonsimple",
8718
+ "module": "components/buttonsimple/buttonsimple.component.js"
8804
8719
  }
8805
8720
  },
8806
8721
  {
8807
8722
  "kind": "method",
8808
- "name": "renderImage",
8723
+ "name": "executeAction",
8809
8724
  "privacy": "protected",
8810
- "description": "Renders the image on the card if image source is provided",
8811
- "return": {
8812
- "type": {
8813
- "text": ""
8814
- }
8815
- },
8816
8725
  "inheritedFrom": {
8817
- "name": "Card",
8818
- "module": "components/card/card.component.js"
8726
+ "name": "Buttonsimple",
8727
+ "module": "components/buttonsimple/buttonsimple.component.js"
8819
8728
  }
8820
8729
  },
8821
8730
  {
8822
8731
  "kind": "method",
8823
- "name": "renderIcon",
8732
+ "name": "setActive",
8824
8733
  "privacy": "protected",
8825
- "description": "Renders the icon on the card if icon name is provided",
8826
- "return": {
8827
- "type": {
8828
- "text": ""
8734
+ "parameters": [
8735
+ {
8736
+ "name": "element",
8737
+ "type": {
8738
+ "text": "HTMLElement"
8739
+ },
8740
+ "description": "The button element"
8741
+ },
8742
+ {
8743
+ "name": "active",
8744
+ "optional": true,
8745
+ "type": {
8746
+ "text": "boolean"
8747
+ },
8748
+ "description": "The active state of the element"
8829
8749
  }
8830
- },
8750
+ ],
8751
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
8831
8752
  "inheritedFrom": {
8832
- "name": "Card",
8833
- "module": "components/card/card.component.js"
8753
+ "name": "Buttonsimple",
8754
+ "module": "components/buttonsimple/buttonsimple.component.js"
8834
8755
  }
8835
8756
  },
8836
8757
  {
8837
8758
  "kind": "method",
8838
- "name": "renderTitle",
8839
- "privacy": "protected",
8840
- "description": "Renders the title and subtitle on the card",
8841
- "return": {
8842
- "type": {
8843
- "text": ""
8759
+ "name": "setSoftDisabled",
8760
+ "privacy": "private",
8761
+ "parameters": [
8762
+ {
8763
+ "name": "element",
8764
+ "type": {
8765
+ "text": "HTMLElement"
8766
+ },
8767
+ "description": "The button element."
8768
+ },
8769
+ {
8770
+ "name": "softDisabled",
8771
+ "optional": true,
8772
+ "type": {
8773
+ "text": "boolean"
8774
+ },
8775
+ "description": "The soft-disabled state."
8844
8776
  }
8845
- },
8777
+ ],
8778
+ "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.",
8846
8779
  "inheritedFrom": {
8847
- "name": "Card",
8848
- "module": "components/card/card.component.js"
8780
+ "name": "Buttonsimple",
8781
+ "module": "components/buttonsimple/buttonsimple.component.js"
8849
8782
  }
8850
8783
  },
8851
8784
  {
8852
8785
  "kind": "method",
8853
- "name": "renderFooter",
8854
- "privacy": "protected",
8855
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
8856
- "return": {
8857
- "type": {
8858
- "text": ""
8786
+ "name": "setDisabled",
8787
+ "privacy": "private",
8788
+ "parameters": [
8789
+ {
8790
+ "name": "element",
8791
+ "type": {
8792
+ "text": "HTMLElement"
8793
+ },
8794
+ "description": "The button element."
8795
+ },
8796
+ {
8797
+ "name": "disabled",
8798
+ "type": {
8799
+ "text": "boolean"
8800
+ },
8801
+ "description": "The disabled state."
8859
8802
  }
8860
- },
8803
+ ],
8804
+ "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.",
8861
8805
  "inheritedFrom": {
8862
- "name": "Card",
8863
- "module": "components/card/card.component.js"
8806
+ "name": "Buttonsimple",
8807
+ "module": "components/buttonsimple/buttonsimple.component.js"
8864
8808
  }
8865
- }
8866
- ],
8867
- "events": [
8809
+ },
8868
8810
  {
8869
- "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
8870
- "name": "click",
8871
- "reactName": "onClick"
8811
+ "kind": "method",
8812
+ "name": "triggerClickEvent",
8813
+ "privacy": "private",
8814
+ "inheritedFrom": {
8815
+ "name": "Buttonsimple",
8816
+ "module": "components/buttonsimple/buttonsimple.component.js"
8817
+ }
8872
8818
  },
8873
8819
  {
8874
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
8875
- "name": "keydown",
8876
- "reactName": "onKeyDown"
8820
+ "kind": "method",
8821
+ "name": "handleBlur",
8822
+ "privacy": "private",
8823
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
8824
+ "inheritedFrom": {
8825
+ "name": "Buttonsimple",
8826
+ "module": "components/buttonsimple/buttonsimple.component.js"
8827
+ }
8877
8828
  },
8878
8829
  {
8879
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
8880
- "name": "keyup",
8881
- "reactName": "onKeyUp"
8830
+ "kind": "method",
8831
+ "name": "handleKeyDown",
8832
+ "privacy": "private",
8833
+ "parameters": [
8834
+ {
8835
+ "name": "event",
8836
+ "type": {
8837
+ "text": "KeyboardEvent"
8838
+ },
8839
+ "description": "The keyboard event."
8840
+ }
8841
+ ],
8842
+ "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.",
8843
+ "inheritedFrom": {
8844
+ "name": "Buttonsimple",
8845
+ "module": "components/buttonsimple/buttonsimple.component.js"
8846
+ }
8882
8847
  },
8883
8848
  {
8884
- "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
8885
- "name": "focus",
8886
- "reactName": "onFocus"
8849
+ "kind": "method",
8850
+ "name": "handleKeyUp",
8851
+ "privacy": "private",
8852
+ "parameters": [
8853
+ {
8854
+ "name": "event",
8855
+ "type": {
8856
+ "text": "KeyboardEvent"
8857
+ },
8858
+ "description": "The keyboard event."
8859
+ }
8860
+ ],
8861
+ "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.",
8862
+ "inheritedFrom": {
8863
+ "name": "Buttonsimple",
8864
+ "module": "components/buttonsimple/buttonsimple.component.js"
8865
+ }
8887
8866
  }
8888
8867
  ],
8889
8868
  "attributes": [
8890
8869
  {
8891
- "name": "checked",
8870
+ "name": "color",
8892
8871
  "type": {
8893
- "text": "boolean"
8872
+ "text": "ColorType"
8894
8873
  },
8895
- "default": "false",
8896
- "description": "The checked state of the card",
8897
- "fieldName": "checked"
8874
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
8875
+ "default": "default",
8876
+ "fieldName": "color"
8898
8877
  },
8899
8878
  {
8900
- "name": "name",
8879
+ "name": "label",
8901
8880
  "type": {
8902
8881
  "text": "string"
8903
8882
  },
8904
8883
  "default": "''",
8905
- "description": "The name of the radio.",
8906
- "fieldName": "name"
8884
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
8885
+ "fieldName": "label"
8907
8886
  },
8908
8887
  {
8909
- "name": "disabled",
8888
+ "name": "icon-name",
8910
8889
  "type": {
8911
- "text": "boolean | undefined"
8890
+ "text": "IconNames | undefined"
8912
8891
  },
8913
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8914
- "default": "undefined",
8915
- "fieldName": "disabled",
8892
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8893
+ "fieldName": "iconName",
8916
8894
  "inheritedFrom": {
8917
- "name": "DisabledMixin",
8918
- "module": "src/utils/mixins/DisabledMixin.ts"
8895
+ "name": "IconNameMixin",
8896
+ "module": "src/utils/mixins/IconNameMixin.ts"
8897
+ }
8898
+ },
8899
+ {
8900
+ "name": "autofocus",
8901
+ "type": {
8902
+ "text": "boolean"
8903
+ },
8904
+ "default": "false",
8905
+ "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
8906
+ "fieldName": "autofocus",
8907
+ "inheritedFrom": {
8908
+ "name": "Buttonsimple",
8909
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8919
8910
  }
8920
8911
  },
8921
8912
  {
@@ -8927,144 +8918,153 @@
8927
8918
  "description": "This property specifies the tab order of the element.",
8928
8919
  "fieldName": "tabIndex",
8929
8920
  "inheritedFrom": {
8930
- "name": "TabIndexMixin",
8931
- "module": "src/utils/mixins/TabIndexMixin.ts"
8921
+ "name": "Buttonsimple",
8922
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8932
8923
  }
8933
8924
  },
8934
8925
  {
8935
- "name": "card-title",
8926
+ "name": "disabled",
8936
8927
  "type": {
8937
- "text": "string"
8928
+ "text": "boolean | undefined"
8938
8929
  },
8939
- "default": "''",
8940
- "description": "The title of the card - part of header section",
8941
- "fieldName": "cardTitle",
8930
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8931
+ "default": "undefined",
8932
+ "fieldName": "disabled",
8942
8933
  "inheritedFrom": {
8943
- "name": "Card",
8944
- "module": "src/components/card/card.component.ts"
8934
+ "name": "Buttonsimple",
8935
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8945
8936
  }
8946
8937
  },
8947
8938
  {
8948
- "name": "subtitle",
8939
+ "name": "active",
8949
8940
  "type": {
8950
- "text": "string"
8941
+ "text": "boolean | undefined"
8951
8942
  },
8952
- "default": "''",
8953
- "description": "The subtitle of the card - part of header section",
8954
- "fieldName": "subtitle",
8943
+ "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.",
8944
+ "default": "undefined",
8945
+ "fieldName": "active",
8955
8946
  "inheritedFrom": {
8956
- "name": "Card",
8957
- "module": "src/components/card/card.component.ts"
8947
+ "name": "Buttonsimple",
8948
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8958
8949
  }
8959
8950
  },
8960
8951
  {
8961
- "name": "image-src",
8952
+ "name": "soft-disabled",
8962
8953
  "type": {
8963
- "text": "string"
8954
+ "text": "boolean | undefined"
8964
8955
  },
8965
- "default": "''",
8966
- "description": "The image source URL to render on the card",
8967
- "fieldName": "imageSrc",
8956
+ "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.",
8957
+ "default": "undefined",
8958
+ "fieldName": "softDisabled",
8968
8959
  "inheritedFrom": {
8969
- "name": "Card",
8970
- "module": "src/components/card/card.component.ts"
8960
+ "name": "Buttonsimple",
8961
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8971
8962
  }
8972
8963
  },
8973
8964
  {
8974
- "name": "image-alt",
8965
+ "name": "size",
8975
8966
  "type": {
8976
- "text": "string"
8967
+ "text": "ButtonSize"
8977
8968
  },
8978
- "default": "''",
8979
- "description": "The image alt for accessibility support",
8980
- "fieldName": "imageAlt",
8969
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
8970
+ "default": "32",
8971
+ "fieldName": "size",
8981
8972
  "inheritedFrom": {
8982
- "name": "Card",
8983
- "module": "src/components/card/card.component.ts"
8973
+ "name": "Buttonsimple",
8974
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8984
8975
  }
8985
8976
  },
8986
8977
  {
8987
- "name": "variant",
8978
+ "name": "role",
8988
8979
  "type": {
8989
- "text": "CardVariant"
8980
+ "text": "RoleType"
8990
8981
  },
8991
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
8992
- "default": "'border'",
8993
- "fieldName": "variant",
8982
+ "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.",
8983
+ "default": "button",
8984
+ "fieldName": "role",
8994
8985
  "inheritedFrom": {
8995
- "name": "Card",
8996
- "module": "src/components/card/card.component.ts"
8986
+ "name": "Buttonsimple",
8987
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
8997
8988
  }
8998
8989
  },
8999
8990
  {
9000
- "name": "orientation",
8991
+ "name": "ariaStateKey",
9001
8992
  "type": {
9002
- "text": "CardOrientation"
8993
+ "text": "string | undefined"
9003
8994
  },
9004
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
9005
- "default": "'vertical'",
9006
- "fieldName": "orientation",
8995
+ "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`",
8996
+ "default": "'aria-pressed' (when)",
8997
+ "fieldName": "ariaStateKey",
9007
8998
  "inheritedFrom": {
9008
- "name": "Card",
9009
- "module": "src/components/card/card.component.ts"
8999
+ "name": "Buttonsimple",
9000
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
9010
9001
  }
9011
9002
  },
9012
9003
  {
9013
- "name": "title-tag-name",
9004
+ "name": "type",
9014
9005
  "type": {
9015
- "text": "TagNameType"
9006
+ "text": "ButtonType"
9016
9007
  },
9017
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
9018
- "default": "'span'",
9019
- "fieldName": "titleTagName",
9008
+ "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.",
9009
+ "default": "button",
9010
+ "fieldName": "type",
9020
9011
  "inheritedFrom": {
9021
- "name": "Card",
9022
- "module": "src/components/card/card.component.ts"
9012
+ "name": "Buttonsimple",
9013
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
9023
9014
  }
9024
- },
9015
+ }
9016
+ ],
9017
+ "mixins": [
9025
9018
  {
9026
- "name": "subtitle-tag-name",
9027
- "type": {
9028
- "text": "TagNameType"
9029
- },
9030
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
9031
- "default": "'span'",
9032
- "fieldName": "subtitleTagName",
9019
+ "name": "IconNameMixin",
9020
+ "module": "/src/utils/mixins/IconNameMixin"
9021
+ }
9022
+ ],
9023
+ "superclass": {
9024
+ "name": "Buttonsimple",
9025
+ "module": "/src/components/buttonsimple/buttonsimple.component"
9026
+ },
9027
+ "tagName": "mdc-chip",
9028
+ "jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
9029
+ "customElement": true,
9030
+ "events": [
9031
+ {
9032
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
9033
+ "name": "click",
9034
+ "reactName": "onClick",
9033
9035
  "inheritedFrom": {
9034
- "name": "Card",
9035
- "module": "src/components/card/card.component.ts"
9036
+ "name": "Buttonsimple",
9037
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
9036
9038
  }
9037
9039
  },
9038
9040
  {
9039
- "name": "icon-name",
9040
- "type": {
9041
- "text": "IconNames | undefined"
9042
- },
9043
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
9044
- "fieldName": "iconName",
9041
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
9042
+ "name": "keydown",
9043
+ "reactName": "onKeyDown",
9045
9044
  "inheritedFrom": {
9046
- "name": "Card",
9047
- "module": "src/components/card/card.component.ts"
9045
+ "name": "Buttonsimple",
9046
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
9048
9047
  }
9049
- }
9050
- ],
9051
- "mixins": [
9048
+ },
9052
9049
  {
9053
- "name": "DisabledMixin",
9054
- "module": "/src/utils/mixins/DisabledMixin"
9050
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
9051
+ "name": "keyup",
9052
+ "reactName": "onKeyUp",
9053
+ "inheritedFrom": {
9054
+ "name": "Buttonsimple",
9055
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
9056
+ }
9055
9057
  },
9056
9058
  {
9057
- "name": "TabIndexMixin",
9058
- "module": "/src/utils/mixins/TabIndexMixin"
9059
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
9060
+ "name": "focus",
9061
+ "reactName": "onFocus",
9062
+ "inheritedFrom": {
9063
+ "name": "Buttonsimple",
9064
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
9065
+ }
9059
9066
  }
9060
- ],
9061
- "superclass": {
9062
- "name": "Card",
9063
- "module": "/src/components/card/card.component"
9064
- },
9065
- "tagName": "mdc-cardradio",
9066
- "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of `mdc-button` component within the footer section.\n *\n * @csspart header - The header part of the card\n * @csspart icon - The icon part of the card header\n * @csspart body - The body part of the card\n * @csspart image - The image part of the card\n * @csspart footer - The footer part of the card\n * @csspart footer-link - The link part of the card footer\n * @csspart footer-button-primary - The primary button part of the card footer\n * @csspart footer-button-secondary - The secondary button part of the card footer\n * @csspart icon-button - The icon button part of the card header\n * @csspart text - The text part of the card\n * @csspart check - The check part of the card\n * @csspart check-icon - The check icon part of the card\n * @csspart check-icon-button - The check icon button part of the card\n *\n * @cssproperty --mdc-card-width - The width of the card\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
9067
- "customElement": true
9067
+ ]
9068
9068
  }
9069
9069
  ],
9070
9070
  "exports": [
@@ -9072,8 +9072,8 @@
9072
9072
  "kind": "js",
9073
9073
  "name": "default",
9074
9074
  "declaration": {
9075
- "name": "CardRadio",
9076
- "module": "components/cardradio/cardradio.component.js"
9075
+ "name": "Chip",
9076
+ "module": "components/chip/chip.component.js"
9077
9077
  }
9078
9078
  }
9079
9079
  ]
@@ -28413,17 +28413,28 @@
28413
28413
  "type": {
28414
28414
  "text": "PresenceSize"
28415
28415
  },
28416
- "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
28417
- "default": "small",
28416
+ "description": "Acceptable numeric values include:\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124\n\nPresence icons are minimum 14px in size, meaning 24, 32, and 48 presence\nicons will be no smaller than 14px (for sizes 24, 32, 48).",
28417
+ "default": "32",
28418
28418
  "attribute": "size",
28419
28419
  "reflects": true
28420
28420
  },
28421
28421
  {
28422
- "kind": "field",
28423
- "name": "iconSize",
28422
+ "kind": "method",
28423
+ "name": "setSize",
28424
28424
  "privacy": "private",
28425
- "description": "Get the size of the presence icon based on the given size type",
28426
- "readonly": true
28425
+ "return": {
28426
+ "type": {
28427
+ "text": "void"
28428
+ }
28429
+ },
28430
+ "parameters": [
28431
+ {
28432
+ "name": "size",
28433
+ "type": {
28434
+ "text": "PresenceSize"
28435
+ }
28436
+ }
28437
+ ]
28427
28438
  },
28428
28439
  {
28429
28440
  "kind": "field",
@@ -28470,8 +28481,8 @@
28470
28481
  "type": {
28471
28482
  "text": "PresenceSize"
28472
28483
  },
28473
- "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
28474
- "default": "small",
28484
+ "description": "Acceptable numeric values include:\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124\n\nPresence icons are minimum 14px in size, meaning 24, 32, and 48 presence\nicons will be no smaller than 14px (for sizes 24, 32, 48).",
28485
+ "default": "32",
28475
28486
  "fieldName": "size"
28476
28487
  }
28477
28488
  ],
@@ -33237,12 +33248,7 @@
33237
33248
  "name": "default"
33238
33249
  }
33239
33250
  ],
33240
- "members": [
33241
- {
33242
- "kind": "field",
33243
- "name": "role"
33244
- }
33245
- ],
33251
+ "members": [],
33246
33252
  "superclass": {
33247
33253
  "name": "Component",
33248
33254
  "module": "/src/models"