@momentum-design/components 0.104.3 → 0.104.5

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.
@@ -6394,12 +6394,12 @@
6394
6394
  },
6395
6395
  {
6396
6396
  "kind": "javascript-module",
6397
- "path": "components/cardradio/cardradio.component.js",
6397
+ "path": "components/cardcheckbox/cardcheckbox.component.js",
6398
6398
  "declarations": [
6399
6399
  {
6400
6400
  "kind": "class",
6401
- "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.",
6402
- "name": "CardRadio",
6401
+ "description": "cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\nThis card would have events for selected and unselected (similar to checkbox)\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.",
6402
+ "name": "CardCheckbox",
6403
6403
  "cssProperties": [
6404
6404
  {
6405
6405
  "description": "The width of the card",
@@ -6576,76 +6576,20 @@
6576
6576
  },
6577
6577
  {
6578
6578
  "kind": "field",
6579
- "name": "name",
6579
+ "name": "selectionType",
6580
6580
  "type": {
6581
- "text": "string"
6582
- },
6583
- "default": "''",
6584
- "description": "The name of the radio.",
6585
- "attribute": "name"
6586
- },
6587
- {
6588
- "kind": "method",
6589
- "name": "getAllCardsWithinSameGroup",
6590
- "privacy": "private",
6591
- "return": {
6592
- "type": {
6593
- "text": "CardRadio[]"
6594
- }
6581
+ "text": "SelectionType"
6595
6582
  },
6596
- "description": "Returns all cards within the same group (name)."
6583
+ "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
6584
+ "default": "'check'",
6585
+ "attribute": "selection-type",
6586
+ "reflects": true
6597
6587
  },
6598
6588
  {
6599
6589
  "kind": "method",
6600
6590
  "name": "toggleChecked",
6601
6591
  "privacy": "private",
6602
- "return": {
6603
- "type": {
6604
- "text": "void"
6605
- }
6606
- },
6607
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
6608
- },
6609
- {
6610
- "kind": "method",
6611
- "name": "setDisabled",
6612
- "return": {
6613
- "type": {
6614
- "text": "void"
6615
- }
6616
- },
6617
- "parameters": [
6618
- {
6619
- "name": "disabled",
6620
- "type": {
6621
- "text": "boolean"
6622
- }
6623
- }
6624
- ]
6625
- },
6626
- {
6627
- "kind": "method",
6628
- "name": "updateCardRadio",
6629
- "privacy": "private",
6630
- "return": {
6631
- "type": {
6632
- "text": "void"
6633
- }
6634
- },
6635
- "parameters": [
6636
- {
6637
- "name": "cards",
6638
- "type": {
6639
- "text": "CardRadio[]"
6640
- }
6641
- },
6642
- {
6643
- "name": "index",
6644
- "type": {
6645
- "text": "number"
6646
- }
6647
- }
6648
- ]
6592
+ "description": "Toggles the checked state"
6649
6593
  },
6650
6594
  {
6651
6595
  "kind": "method",
@@ -6677,6 +6621,17 @@
6677
6621
  ],
6678
6622
  "description": "Toggles the checked state when space key is used"
6679
6623
  },
6624
+ {
6625
+ "kind": "method",
6626
+ "name": "renderSelection",
6627
+ "privacy": "private",
6628
+ "description": "Renders the selection icon or checkbox based on the selection type",
6629
+ "return": {
6630
+ "type": {
6631
+ "text": ""
6632
+ }
6633
+ }
6634
+ },
6680
6635
  {
6681
6636
  "kind": "method",
6682
6637
  "name": "renderHeader",
@@ -6950,13 +6905,13 @@
6950
6905
  "fieldName": "checked"
6951
6906
  },
6952
6907
  {
6953
- "name": "name",
6908
+ "name": "selection-type",
6954
6909
  "type": {
6955
- "text": "string"
6910
+ "text": "SelectionType"
6956
6911
  },
6957
- "default": "''",
6958
- "description": "The name of the radio.",
6959
- "fieldName": "name"
6912
+ "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
6913
+ "default": "'check'",
6914
+ "fieldName": "selectionType"
6960
6915
  },
6961
6916
  {
6962
6917
  "name": "disabled",
@@ -7115,8 +7070,8 @@
7115
7070
  "name": "Card",
7116
7071
  "module": "/src/components/card/card.component"
7117
7072
  },
7118
- "tagName": "mdc-cardradio",
7119
- "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 */",
7073
+ "tagName": "mdc-cardcheckbox",
7074
+ "jsDoc": "/**\n * cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\n * This card would have events for selected and unselected (similar to checkbox)\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-cardcheckbox\n *\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\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 */",
7120
7075
  "customElement": true
7121
7076
  }
7122
7077
  ],
@@ -7125,20 +7080,20 @@
7125
7080
  "kind": "js",
7126
7081
  "name": "default",
7127
7082
  "declaration": {
7128
- "name": "CardRadio",
7129
- "module": "components/cardradio/cardradio.component.js"
7083
+ "name": "CardCheckbox",
7084
+ "module": "components/cardcheckbox/cardcheckbox.component.js"
7130
7085
  }
7131
7086
  }
7132
7087
  ]
7133
7088
  },
7134
7089
  {
7135
7090
  "kind": "javascript-module",
7136
- "path": "components/cardcheckbox/cardcheckbox.component.js",
7091
+ "path": "components/cardradio/cardradio.component.js",
7137
7092
  "declarations": [
7138
7093
  {
7139
7094
  "kind": "class",
7140
- "description": "cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\nThis card would have events for selected and unselected (similar to checkbox)\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.",
7141
- "name": "CardCheckbox",
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",
7142
7097
  "cssProperties": [
7143
7098
  {
7144
7099
  "description": "The width of the card",
@@ -7315,20 +7270,76 @@
7315
7270
  },
7316
7271
  {
7317
7272
  "kind": "field",
7318
- "name": "selectionType",
7273
+ "name": "name",
7319
7274
  "type": {
7320
- "text": "SelectionType"
7275
+ "text": "string"
7321
7276
  },
7322
- "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
7323
- "default": "'check'",
7324
- "attribute": "selection-type",
7325
- "reflects": true
7277
+ "default": "''",
7278
+ "description": "The name of the radio.",
7279
+ "attribute": "name"
7280
+ },
7281
+ {
7282
+ "kind": "method",
7283
+ "name": "getAllCardsWithinSameGroup",
7284
+ "privacy": "private",
7285
+ "return": {
7286
+ "type": {
7287
+ "text": "CardRadio[]"
7288
+ }
7289
+ },
7290
+ "description": "Returns all cards within the same group (name)."
7326
7291
  },
7327
7292
  {
7328
7293
  "kind": "method",
7329
7294
  "name": "toggleChecked",
7330
7295
  "privacy": "private",
7331
- "description": "Toggles the checked state"
7296
+ "return": {
7297
+ "type": {
7298
+ "text": "void"
7299
+ }
7300
+ },
7301
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
7302
+ },
7303
+ {
7304
+ "kind": "method",
7305
+ "name": "setDisabled",
7306
+ "return": {
7307
+ "type": {
7308
+ "text": "void"
7309
+ }
7310
+ },
7311
+ "parameters": [
7312
+ {
7313
+ "name": "disabled",
7314
+ "type": {
7315
+ "text": "boolean"
7316
+ }
7317
+ }
7318
+ ]
7319
+ },
7320
+ {
7321
+ "kind": "method",
7322
+ "name": "updateCardRadio",
7323
+ "privacy": "private",
7324
+ "return": {
7325
+ "type": {
7326
+ "text": "void"
7327
+ }
7328
+ },
7329
+ "parameters": [
7330
+ {
7331
+ "name": "cards",
7332
+ "type": {
7333
+ "text": "CardRadio[]"
7334
+ }
7335
+ },
7336
+ {
7337
+ "name": "index",
7338
+ "type": {
7339
+ "text": "number"
7340
+ }
7341
+ }
7342
+ ]
7332
7343
  },
7333
7344
  {
7334
7345
  "kind": "method",
@@ -7360,17 +7371,6 @@
7360
7371
  ],
7361
7372
  "description": "Toggles the checked state when space key is used"
7362
7373
  },
7363
- {
7364
- "kind": "method",
7365
- "name": "renderSelection",
7366
- "privacy": "private",
7367
- "description": "Renders the selection icon or checkbox based on the selection type",
7368
- "return": {
7369
- "type": {
7370
- "text": ""
7371
- }
7372
- }
7373
- },
7374
7374
  {
7375
7375
  "kind": "method",
7376
7376
  "name": "renderHeader",
@@ -7644,13 +7644,13 @@
7644
7644
  "fieldName": "checked"
7645
7645
  },
7646
7646
  {
7647
- "name": "selection-type",
7647
+ "name": "name",
7648
7648
  "type": {
7649
- "text": "SelectionType"
7649
+ "text": "string"
7650
7650
  },
7651
- "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
7652
- "default": "'check'",
7653
- "fieldName": "selectionType"
7651
+ "default": "''",
7652
+ "description": "The name of the radio.",
7653
+ "fieldName": "name"
7654
7654
  },
7655
7655
  {
7656
7656
  "name": "disabled",
@@ -7809,8 +7809,8 @@
7809
7809
  "name": "Card",
7810
7810
  "module": "/src/components/card/card.component"
7811
7811
  },
7812
- "tagName": "mdc-cardcheckbox",
7813
- "jsDoc": "/**\n * cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\n * This card would have events for selected and unselected (similar to checkbox)\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-cardcheckbox\n *\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\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 */",
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 */",
7814
7814
  "customElement": true
7815
7815
  }
7816
7816
  ],
@@ -7819,8 +7819,8 @@
7819
7819
  "kind": "js",
7820
7820
  "name": "default",
7821
7821
  "declaration": {
7822
- "name": "CardCheckbox",
7823
- "module": "components/cardcheckbox/cardcheckbox.component.js"
7822
+ "name": "CardRadio",
7823
+ "module": "components/cardradio/cardradio.component.js"
7824
7824
  }
7825
7825
  }
7826
7826
  ]
@@ -9239,6 +9239,21 @@
9239
9239
  "module": "components/popover/popover.component.js"
9240
9240
  }
9241
9241
  },
9242
+ {
9243
+ "kind": "field",
9244
+ "name": "zIndex",
9245
+ "type": {
9246
+ "text": "number"
9247
+ },
9248
+ "description": "IMPLEMENT THIS IN YOUR COMPONENT.\n\nThe z-index of the component where the backdrop will be attached to.\nThe backdrop itself will have a z-index of `zIndex - 1`.",
9249
+ "default": "1000",
9250
+ "attribute": "z-index",
9251
+ "reflects": true,
9252
+ "inheritedFrom": {
9253
+ "name": "Popover",
9254
+ "module": "components/popover/popover.component.js"
9255
+ }
9256
+ },
9242
9257
  {
9243
9258
  "kind": "field",
9244
9259
  "name": "preventScroll",
@@ -10042,13 +10057,13 @@
10042
10057
  },
10043
10058
  {
10044
10059
  "kind": "field",
10045
- "name": "flip",
10060
+ "name": "backdropAppendTo",
10046
10061
  "type": {
10047
- "text": "boolean"
10062
+ "text": "string | undefined"
10048
10063
  },
10049
- "description": "Changes the placement of popover to keep it in view when scrolling.",
10050
- "default": "true",
10051
- "attribute": "flip",
10064
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
10065
+ "default": "''",
10066
+ "attribute": "backdrop-append-to",
10052
10067
  "reflects": true,
10053
10068
  "inheritedFrom": {
10054
10069
  "name": "Popover",
@@ -10057,13 +10072,13 @@
10057
10072
  },
10058
10073
  {
10059
10074
  "kind": "field",
10060
- "name": "size",
10075
+ "name": "isBackdropInvisible",
10061
10076
  "type": {
10062
- "text": "boolean"
10077
+ "text": "boolean | undefined"
10063
10078
  },
10064
- "description": "Changes the size of popover to keep it in view when scrolling.",
10079
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
10065
10080
  "default": "false",
10066
- "attribute": "size",
10081
+ "attribute": "is-backdrop-invisible",
10067
10082
  "reflects": true,
10068
10083
  "inheritedFrom": {
10069
10084
  "name": "Popover",
@@ -10072,13 +10087,28 @@
10072
10087
  },
10073
10088
  {
10074
10089
  "kind": "field",
10075
- "name": "zIndex",
10090
+ "name": "flip",
10076
10091
  "type": {
10077
- "text": "number"
10092
+ "text": "boolean"
10078
10093
  },
10079
- "description": "The z-index of the popover.",
10080
- "default": "1000",
10081
- "attribute": "z-index",
10094
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
10095
+ "default": "true",
10096
+ "attribute": "flip",
10097
+ "reflects": true,
10098
+ "inheritedFrom": {
10099
+ "name": "Popover",
10100
+ "module": "components/popover/popover.component.js"
10101
+ }
10102
+ },
10103
+ {
10104
+ "kind": "field",
10105
+ "name": "size",
10106
+ "type": {
10107
+ "text": "boolean"
10108
+ },
10109
+ "description": "Changes the size of popover to keep it in view when scrolling.",
10110
+ "default": "false",
10111
+ "attribute": "size",
10082
10112
  "reflects": true,
10083
10113
  "inheritedFrom": {
10084
10114
  "name": "Popover",
@@ -10838,6 +10868,32 @@
10838
10868
  "module": "src/components/popover/popover.component.ts"
10839
10869
  }
10840
10870
  },
10871
+ {
10872
+ "name": "backdrop-append-to",
10873
+ "type": {
10874
+ "text": "string | undefined"
10875
+ },
10876
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
10877
+ "default": "''",
10878
+ "fieldName": "backdropAppendTo",
10879
+ "inheritedFrom": {
10880
+ "name": "Popover",
10881
+ "module": "src/components/popover/popover.component.ts"
10882
+ }
10883
+ },
10884
+ {
10885
+ "name": "is-backdrop-invisible",
10886
+ "type": {
10887
+ "text": "boolean | undefined"
10888
+ },
10889
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
10890
+ "default": "false",
10891
+ "fieldName": "isBackdropInvisible",
10892
+ "inheritedFrom": {
10893
+ "name": "Popover",
10894
+ "module": "src/components/popover/popover.component.ts"
10895
+ }
10896
+ },
10841
10897
  {
10842
10898
  "name": "flip",
10843
10899
  "type": {
@@ -11104,7 +11160,11 @@
11104
11160
  "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
11105
11161
  "default": "1000",
11106
11162
  "attribute": "z-index",
11107
- "reflects": true
11163
+ "reflects": true,
11164
+ "inheritedFrom": {
11165
+ "name": "BackdropMixin",
11166
+ "module": "utils/mixins/BackdropMixin.js"
11167
+ }
11108
11168
  },
11109
11169
  {
11110
11170
  "kind": "field",
@@ -12032,6 +12092,10 @@
12032
12092
  }
12033
12093
  ],
12034
12094
  "mixins": [
12095
+ {
12096
+ "name": "BackdropMixin",
12097
+ "module": "/src/utils/mixins/BackdropMixin"
12098
+ },
12035
12099
  {
12036
12100
  "name": "PreventScrollMixin",
12037
12101
  "module": "/src/utils/mixins/PreventScrollMixin"
@@ -21036,6 +21100,21 @@
21036
21100
  }
21037
21101
  }
21038
21102
  },
21103
+ {
21104
+ "kind": "field",
21105
+ "name": "zIndex",
21106
+ "type": {
21107
+ "text": "number"
21108
+ },
21109
+ "description": "IMPLEMENT THIS IN YOUR COMPONENT.\n\nThe z-index of the component where the backdrop will be attached to.\nThe backdrop itself will have a z-index of `zIndex - 1`.",
21110
+ "default": "1000",
21111
+ "attribute": "z-index",
21112
+ "reflects": true,
21113
+ "inheritedFrom": {
21114
+ "name": "Popover",
21115
+ "module": "components/popover/popover.component.js"
21116
+ }
21117
+ },
21039
21118
  {
21040
21119
  "kind": "field",
21041
21120
  "name": "preventScroll",
@@ -21869,13 +21948,13 @@
21869
21948
  },
21870
21949
  {
21871
21950
  "kind": "field",
21872
- "name": "flip",
21951
+ "name": "backdropAppendTo",
21873
21952
  "type": {
21874
- "text": "boolean"
21953
+ "text": "string | undefined"
21875
21954
  },
21876
- "description": "Changes the placement of popover to keep it in view when scrolling.",
21877
- "default": "true",
21878
- "attribute": "flip",
21955
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
21956
+ "default": "''",
21957
+ "attribute": "backdrop-append-to",
21879
21958
  "reflects": true,
21880
21959
  "inheritedFrom": {
21881
21960
  "name": "Popover",
@@ -21884,13 +21963,13 @@
21884
21963
  },
21885
21964
  {
21886
21965
  "kind": "field",
21887
- "name": "size",
21966
+ "name": "isBackdropInvisible",
21888
21967
  "type": {
21889
- "text": "boolean"
21968
+ "text": "boolean | undefined"
21890
21969
  },
21891
- "description": "Changes the size of popover to keep it in view when scrolling.",
21970
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
21892
21971
  "default": "false",
21893
- "attribute": "size",
21972
+ "attribute": "is-backdrop-invisible",
21894
21973
  "reflects": true,
21895
21974
  "inheritedFrom": {
21896
21975
  "name": "Popover",
@@ -21899,13 +21978,28 @@
21899
21978
  },
21900
21979
  {
21901
21980
  "kind": "field",
21902
- "name": "zIndex",
21981
+ "name": "flip",
21903
21982
  "type": {
21904
- "text": "number"
21983
+ "text": "boolean"
21905
21984
  },
21906
- "description": "The z-index of the popover.",
21907
- "default": "1000",
21908
- "attribute": "z-index",
21985
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
21986
+ "default": "true",
21987
+ "attribute": "flip",
21988
+ "reflects": true,
21989
+ "inheritedFrom": {
21990
+ "name": "Popover",
21991
+ "module": "components/popover/popover.component.js"
21992
+ }
21993
+ },
21994
+ {
21995
+ "kind": "field",
21996
+ "name": "size",
21997
+ "type": {
21998
+ "text": "boolean"
21999
+ },
22000
+ "description": "Changes the size of popover to keep it in view when scrolling.",
22001
+ "default": "false",
22002
+ "attribute": "size",
21909
22003
  "reflects": true,
21910
22004
  "inheritedFrom": {
21911
22005
  "name": "Popover",
@@ -22625,6 +22719,32 @@
22625
22719
  "module": "src/components/popover/popover.component.ts"
22626
22720
  }
22627
22721
  },
22722
+ {
22723
+ "name": "backdrop-append-to",
22724
+ "type": {
22725
+ "text": "string | undefined"
22726
+ },
22727
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
22728
+ "default": "''",
22729
+ "fieldName": "backdropAppendTo",
22730
+ "inheritedFrom": {
22731
+ "name": "Popover",
22732
+ "module": "src/components/popover/popover.component.ts"
22733
+ }
22734
+ },
22735
+ {
22736
+ "name": "is-backdrop-invisible",
22737
+ "type": {
22738
+ "text": "boolean | undefined"
22739
+ },
22740
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
22741
+ "default": "false",
22742
+ "fieldName": "isBackdropInvisible",
22743
+ "inheritedFrom": {
22744
+ "name": "Popover",
22745
+ "module": "src/components/popover/popover.component.ts"
22746
+ }
22747
+ },
22628
22748
  {
22629
22749
  "name": "flip",
22630
22750
  "type": {
@@ -26907,6 +27027,28 @@
26907
27027
  "attribute": "backdrop",
26908
27028
  "reflects": true
26909
27029
  },
27030
+ {
27031
+ "kind": "field",
27032
+ "name": "backdropAppendTo",
27033
+ "type": {
27034
+ "text": "string | undefined"
27035
+ },
27036
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
27037
+ "default": "''",
27038
+ "attribute": "backdrop-append-to",
27039
+ "reflects": true
27040
+ },
27041
+ {
27042
+ "kind": "field",
27043
+ "name": "isBackdropInvisible",
27044
+ "type": {
27045
+ "text": "boolean | undefined"
27046
+ },
27047
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
27048
+ "default": "false",
27049
+ "attribute": "is-backdrop-invisible",
27050
+ "reflects": true
27051
+ },
26910
27052
  {
26911
27053
  "kind": "field",
26912
27054
  "name": "flip",
@@ -26938,7 +27080,11 @@
26938
27080
  "description": "The z-index of the popover.",
26939
27081
  "default": "1000",
26940
27082
  "attribute": "z-index",
26941
- "reflects": true
27083
+ "reflects": true,
27084
+ "inheritedFrom": {
27085
+ "name": "BackdropMixin",
27086
+ "module": "utils/mixins/BackdropMixin.js"
27087
+ }
26942
27088
  },
26943
27089
  {
26944
27090
  "kind": "field",
@@ -27960,6 +28106,24 @@
27960
28106
  "default": "false",
27961
28107
  "fieldName": "backdrop"
27962
28108
  },
28109
+ {
28110
+ "name": "backdrop-append-to",
28111
+ "type": {
28112
+ "text": "string | undefined"
28113
+ },
28114
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
28115
+ "default": "''",
28116
+ "fieldName": "backdropAppendTo"
28117
+ },
28118
+ {
28119
+ "name": "is-backdrop-invisible",
28120
+ "type": {
28121
+ "text": "boolean | undefined"
28122
+ },
28123
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
28124
+ "default": "false",
28125
+ "fieldName": "isBackdropInvisible"
28126
+ },
27963
28127
  {
27964
28128
  "name": "flip",
27965
28129
  "type": {
@@ -28082,6 +28246,10 @@
28082
28246
  }
28083
28247
  ],
28084
28248
  "mixins": [
28249
+ {
28250
+ "name": "BackdropMixin",
28251
+ "module": "/src/utils/mixins/BackdropMixin"
28252
+ },
28085
28253
  {
28086
28254
  "name": "PreventScrollMixin",
28087
28255
  "module": "/src/utils/mixins/PreventScrollMixin"
@@ -30722,386 +30890,60 @@
30722
30890
  },
30723
30891
  {
30724
30892
  "kind": "javascript-module",
30725
- "path": "components/select/select.component.js",
30893
+ "path": "components/searchfield/searchfield.component.js",
30726
30894
  "declarations": [
30727
30895
  {
30728
30896
  "kind": "class",
30729
- "description": "The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\nIt is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\nThe component ensures accessibility and usability while handling various use cases,\nincluding long text truncation with tooltip support.\n\nEvery mdc-option should have a `value` attribute set to ensure proper form submission.\n\nTo set a default option, use the `selected` attribute on the `mdc-option` element.\n\n**Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.",
30730
- "name": "Select",
30731
- "cssProperties": [
30732
- {
30733
- "description": "The background color of the combobox of select.",
30734
- "name": "--mdc-select-background-color"
30735
- },
30736
- {
30737
- "description": "The background color of the combobox of select when hovered.",
30738
- "name": "--mdc-select-background-color-hover"
30739
- },
30740
- {
30741
- "description": "The background color of the combobox of select when active.",
30742
- "name": "--mdc-select-background-color-active"
30743
- },
30744
- {
30745
- "description": "The background color of the combobox of select when disabled.",
30746
- "name": "--mdc-select-background-color-disabled"
30747
- },
30748
- {
30749
- "description": "The text color of the select.",
30750
- "name": "--mdc-select-text-color"
30751
- },
30752
- {
30753
- "description": "The text color of the selected option in the select.",
30754
- "name": "--mdc-select-text-color-selected"
30755
- },
30756
- {
30757
- "description": "The text color of the select when disabled.",
30758
- "name": "--mdc-select-text-color-disabled"
30759
- },
30760
- {
30761
- "description": "The border color of the select.",
30762
- "name": "--mdc-select-border-color"
30763
- },
30764
- {
30765
- "description": "The border color of the select when disabled.",
30766
- "name": "--mdc-select-border-color-disabled"
30767
- },
30768
- {
30769
- "description": "The border color of the select when in success state.",
30770
- "name": "--mdc-select-border-color-success"
30771
- },
30772
- {
30773
- "description": "The border color of the select when in warning state.",
30774
- "name": "--mdc-select-border-color-warning"
30775
- },
30776
- {
30777
- "description": "The border color of the select when in error state.",
30778
- "name": "--mdc-select-border-color-error"
30779
- },
30780
- {
30781
- "description": "The width of the select.",
30782
- "name": "--mdc-select-width"
30783
- },
30784
- {
30785
- "description": "The height of the listbox inside the select.",
30786
- "name": "--mdc-select-listbox-height"
30787
- },
30788
- {
30789
- "description": "The width of the listbox inside the select (default: `--mdc-select-width`).",
30790
- "name": "--mdc-select-listbox-width"
30791
- }
30792
- ],
30897
+ "description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
30898
+ "name": "Searchfield",
30793
30899
  "slots": [
30794
30900
  {
30795
- "description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
30796
- "name": "default"
30901
+ "description": "Slot for input chips",
30902
+ "name": "filters"
30797
30903
  }
30798
30904
  ],
30799
30905
  "members": [
30800
30906
  {
30801
30907
  "kind": "field",
30802
- "name": "placeholder",
30803
- "type": {
30804
- "text": "string | undefined"
30805
- },
30806
- "description": "The placeholder text which will be shown on the text if provided.",
30807
- "attribute": "placeholder"
30808
- },
30809
- {
30810
- "kind": "field",
30811
- "name": "readonly",
30812
- "type": {
30813
- "text": "boolean"
30814
- },
30815
- "default": "false",
30816
- "description": "readonly attribute of the select field. If true, the select is read-only.",
30817
- "attribute": "readonly"
30818
- },
30819
- {
30820
- "kind": "field",
30821
- "name": "placement",
30822
- "type": {
30823
- "text": "Placement"
30824
- },
30825
- "description": "The placeholder text which will be shown on the text if provided.",
30826
- "attribute": "placement",
30827
- "reflects": true
30828
- },
30829
- {
30830
- "kind": "field",
30831
- "name": "softDisabled",
30832
- "type": {
30833
- "text": "boolean | undefined"
30834
- },
30835
- "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
30836
- "default": "undefined",
30837
- "attribute": "soft-disabled"
30838
- },
30839
- {
30840
- "kind": "field",
30841
- "name": "boundary",
30842
- "type": {
30843
- "text": "'clippingAncestors' | string"
30844
- },
30845
- "description": "This describes the clipping element(s) or area that overflow of the used popover will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
30846
- "default": "'clippingAncestors'",
30847
- "attribute": "boundary",
30848
- "reflects": true
30849
- },
30850
- {
30851
- "kind": "field",
30852
- "name": "strategy",
30908
+ "name": "inputChips",
30853
30909
  "type": {
30854
- "text": "'absolute' | 'fixed'"
30855
- },
30856
- "description": "The strategy of the popover within Select.\nThis determines how the popover is positioned in the DOM.\n\nIn case `boundary` is set to something other than 'clippingAncestors',\nit might be necessary to set the `strategy` to 'fixed' to ensure that the popover\nis not getting clipped by scrollable containers enclosing the select.",
30857
- "default": "absolute",
30858
- "attribute": "strategy",
30859
- "reflects": true
30860
- },
30861
- {
30862
- "kind": "method",
30863
- "name": "getAllValidOptions",
30864
- "privacy": "private",
30865
- "return": {
30866
- "type": {
30867
- "text": "Array<Option>"
30868
- }
30869
- }
30870
- },
30871
- {
30872
- "kind": "method",
30873
- "name": "getFirstValidOption",
30874
- "privacy": "private",
30875
- "return": {
30876
- "type": {
30877
- "text": "Option | null"
30878
- }
30879
- }
30880
- },
30881
- {
30882
- "kind": "method",
30883
- "name": "getLastValidOption",
30884
- "privacy": "private",
30885
- "return": {
30886
- "type": {
30887
- "text": "Option | null"
30888
- }
30889
- }
30890
- },
30891
- {
30892
- "kind": "method",
30893
- "name": "getFirstSelectedOption",
30894
- "privacy": "private",
30895
- "return": {
30896
- "type": {
30897
- "text": "Option | null"
30898
- }
30910
+ "text": "Array<HTMLElement> | undefined"
30899
30911
  }
30900
30912
  },
30901
30913
  {
30902
30914
  "kind": "method",
30903
- "name": "modifyListBoxWrapper",
30904
- "privacy": "private",
30905
- "description": "Modifies the listbox wrapper to ensure it has the correct attributes\nand IDs for accessibility.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers,\nthis an be removed and mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them."
30906
- },
30907
- {
30908
- "kind": "method",
30909
- "name": "handleOptionsClick",
30910
- "privacy": "private",
30911
- "return": {
30912
- "type": {
30913
- "text": "void"
30914
- }
30915
- },
30916
- "parameters": [
30917
- {
30918
- "name": "event",
30919
- "type": {
30920
- "text": "MouseEvent"
30921
- },
30922
- "description": "The event which triggered this function."
30923
- }
30924
- ],
30925
- "description": "A private method which is called when an option is clicked.\nIt sets the selected option, removes selected from other options, updates the tabindex for all options,\ncloses the popover, and fires the change and input events."
30926
- },
30927
- {
30928
- "kind": "method",
30929
- "name": "setSelectedOption",
30930
- "privacy": "private",
30931
- "return": {
30932
- "type": {
30933
- "text": "void"
30934
- }
30935
- },
30936
- "parameters": [
30937
- {
30938
- "name": "option",
30939
- "type": {
30940
- "text": "Option | null"
30941
- },
30942
- "description": "The option element in DOM which gets selected."
30943
- }
30944
- ],
30945
- "description": "Sets the selected option in the component state and updates the input element's value.\nThis method ensures that only the selected option is marked as selected in the DOM,\nand updates the tabindex for all options accordingly.\nIt also updates the validity of the input element based on the selected option.\nThis method is called when an option is selected."
30946
- },
30947
- {
30948
- "kind": "method",
30949
- "name": "updateTabIndexForAllOptions",
30950
- "privacy": "private",
30951
- "return": {
30952
- "type": {
30953
- "text": "void"
30954
- }
30955
- },
30956
- "parameters": [
30957
- {
30958
- "name": "option",
30959
- "optional": true,
30960
- "type": {
30961
- "text": "Option | null"
30962
- },
30963
- "description": "The option which tabIndex should be set to 0."
30964
- }
30965
- ],
30966
- "description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
30967
- },
30968
- {
30969
- "kind": "method",
30970
- "name": "updateSelectedInChildOptions",
30971
- "privacy": "private",
30972
- "return": {
30973
- "type": {
30974
- "text": "void"
30975
- }
30976
- },
30977
- "parameters": [
30978
- {
30979
- "name": "selectedOption",
30980
- "type": {
30981
- "text": "Option | null"
30982
- },
30983
- "description": "The option which gets selected"
30984
- }
30985
- ],
30986
- "description": "Sets selected attribute on the selected option and removes it from all options"
30987
- },
30988
- {
30989
- "kind": "method",
30990
- "name": "fireEvents",
30991
- "privacy": "private",
30992
- "return": {
30993
- "type": {
30994
- "text": "void"
30995
- }
30996
- },
30997
- "description": "A private method which is called to fire the change and input events.\nIt dispatches the input and change events with the selected option's value and label."
30998
- },
30999
- {
31000
- "kind": "method",
31001
- "name": "dispatchChange",
31002
- "privacy": "private",
31003
- "return": {
31004
- "type": {
31005
- "text": "void"
31006
- }
31007
- },
31008
- "parameters": [
31009
- {
31010
- "name": "option",
31011
- "type": {
31012
- "text": "Option"
31013
- }
31014
- }
31015
- ]
31016
- },
31017
- {
31018
- "kind": "method",
31019
- "name": "dispatchInput",
31020
- "privacy": "private",
31021
- "return": {
31022
- "type": {
31023
- "text": "void"
31024
- }
31025
- },
31026
- "parameters": [
31027
- {
31028
- "name": "option",
31029
- "type": {
31030
- "text": "Option"
31031
- }
31032
- }
31033
- ]
31034
- },
31035
- {
31036
- "kind": "method",
31037
- "name": "handleClickCombobox",
31038
- "privacy": "private",
31039
- "return": {
31040
- "type": {
31041
- "text": "void"
31042
- }
31043
- },
31044
- "parameters": [
31045
- {
31046
- "name": "event",
31047
- "type": {
31048
- "text": "MouseEvent"
31049
- },
31050
- "description": "The mouse event which triggered this function."
31051
- }
31052
- ],
31053
- "description": "Handles the click event on the visual combobox.\nIf the select is disabled, soft-disabled or readonly, it does nothing.\nIf the popover is already open, it closes it.\nIf it is closed, it opens it."
31054
- },
31055
- {
31056
- "kind": "method",
31057
- "name": "handleKeydownCombobox",
31058
- "privacy": "private",
31059
- "return": {
31060
- "type": {
31061
- "text": "void"
31062
- }
31063
- },
30915
+ "name": "handleKeyDown",
30916
+ "privacy": "protected",
31064
30917
  "parameters": [
31065
30918
  {
31066
30919
  "name": "event",
31067
30920
  "type": {
31068
30921
  "text": "KeyboardEvent"
31069
30922
  },
31070
- "description": "The keyboard event."
30923
+ "description": "Keyboard event"
31071
30924
  }
31072
30925
  ],
31073
- "description": "Handles the keydown event on the select element when the popover is closed.\nThe options are as follows:\n- ARROW_DOWN, ARROW_UP, SPACE: Opens the popover and prevents the default scrolling behavior.\n- ENTER: Opens the popover, prevents default scrolling, and submits the form if the popover is closed.\n- HOME: Opens the popover and sets focus and tabindex on the first option.\n- END: Opens the popover and sets focus and tabindex on the last option."
30926
+ "description": "Handles the keydown event of the search field.\nIf the key pressed is 'Enter', it submits the form.\nIf the key pressed is 'Escape', it clears the input text.",
30927
+ "inheritedFrom": {
30928
+ "name": "Input",
30929
+ "module": "components/input/input.component.js"
30930
+ }
31074
30931
  },
31075
30932
  {
31076
30933
  "kind": "method",
31077
- "name": "handlePopoverKeydown",
30934
+ "name": "renderInputChips",
31078
30935
  "privacy": "private",
31079
- "return": {
31080
- "type": {
31081
- "text": "void"
31082
- }
31083
- },
31084
- "parameters": [
31085
- {
31086
- "name": "event",
31087
- "type": {
31088
- "text": "KeyboardEvent"
31089
- },
31090
- "description": "The keyboard event."
31091
- }
31092
- ],
31093
- "description": "Handles the keydown event on the select element when the popover is open.\nThe options are as follows:\n- HOME: Sets focus and tabindex on the first option.\n- END: Sets focus and tabindex on the last option.\n- ARROW_DOWN, ARROW_UP, PAGE_DOWN, PAGE_UP: Handles navigation between options."
30936
+ "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
31094
30937
  },
31095
30938
  {
31096
30939
  "kind": "method",
31097
- "name": "updateState",
31098
- "privacy": "public",
31099
- "return": {
31100
- "type": {
31101
- "text": "void"
31102
- }
31103
- },
31104
- "description": "Updates the state of the select component.\nThis public method should be fired when the selected on the option components is updated from the outside.\nIt ensures that the selected attribute is set correctly on the options\nand that the aria-selected attribute is updated accordingly."
30940
+ "name": "clearInputText",
30941
+ "privacy": "protected",
30942
+ "description": "Clears the input field.",
30943
+ "inheritedFrom": {
30944
+ "name": "Input",
30945
+ "module": "components/input/input.component.js"
30946
+ }
31105
30947
  },
31106
30948
  {
31107
30949
  "kind": "field",
@@ -31218,6 +31060,334 @@
31218
31060
  "module": "utils/mixins/DataAriaLabelMixin.js"
31219
31061
  }
31220
31062
  },
31063
+ {
31064
+ "kind": "field",
31065
+ "name": "placeholder",
31066
+ "type": {
31067
+ "text": "string"
31068
+ },
31069
+ "default": "''",
31070
+ "description": "The placeholder text that is displayed when the input field is empty.",
31071
+ "attribute": "placeholder",
31072
+ "inheritedFrom": {
31073
+ "name": "Input",
31074
+ "module": "components/input/input.component.js"
31075
+ }
31076
+ },
31077
+ {
31078
+ "kind": "field",
31079
+ "name": "readonly",
31080
+ "type": {
31081
+ "text": "boolean"
31082
+ },
31083
+ "default": "false",
31084
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
31085
+ "attribute": "readonly",
31086
+ "inheritedFrom": {
31087
+ "name": "Input",
31088
+ "module": "components/input/input.component.js"
31089
+ }
31090
+ },
31091
+ {
31092
+ "kind": "field",
31093
+ "name": "prefixText",
31094
+ "type": {
31095
+ "text": "string | undefined"
31096
+ },
31097
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
31098
+ "attribute": "prefix-text",
31099
+ "inheritedFrom": {
31100
+ "name": "Input",
31101
+ "module": "components/input/input.component.js"
31102
+ }
31103
+ },
31104
+ {
31105
+ "kind": "field",
31106
+ "name": "leadingIcon",
31107
+ "type": {
31108
+ "text": "IconNames | undefined"
31109
+ },
31110
+ "description": "The leading icon that is displayed before the input field.",
31111
+ "attribute": "leading-icon",
31112
+ "inheritedFrom": {
31113
+ "name": "Input",
31114
+ "module": "components/input/input.component.js"
31115
+ }
31116
+ },
31117
+ {
31118
+ "kind": "field",
31119
+ "name": "trailingButton",
31120
+ "type": {
31121
+ "text": "boolean"
31122
+ },
31123
+ "default": "false",
31124
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
31125
+ "attribute": "trailing-button",
31126
+ "inheritedFrom": {
31127
+ "name": "Input",
31128
+ "module": "components/input/input.component.js"
31129
+ }
31130
+ },
31131
+ {
31132
+ "kind": "field",
31133
+ "name": "maxlength",
31134
+ "type": {
31135
+ "text": "number | undefined"
31136
+ },
31137
+ "description": "The maximum number of characters that the input field can accept.",
31138
+ "attribute": "maxlength",
31139
+ "inheritedFrom": {
31140
+ "name": "Input",
31141
+ "module": "components/input/input.component.js"
31142
+ }
31143
+ },
31144
+ {
31145
+ "kind": "field",
31146
+ "name": "minlength",
31147
+ "type": {
31148
+ "text": "number | undefined"
31149
+ },
31150
+ "description": "The minimum number of characters that the input field can accept.",
31151
+ "attribute": "minlength",
31152
+ "inheritedFrom": {
31153
+ "name": "Input",
31154
+ "module": "components/input/input.component.js"
31155
+ }
31156
+ },
31157
+ {
31158
+ "kind": "field",
31159
+ "name": "autocapitalize",
31160
+ "type": {
31161
+ "text": "AutoCapitalizeType"
31162
+ },
31163
+ "description": "The autocapitalize attribute of the input field.",
31164
+ "default": "'off'",
31165
+ "attribute": "autocapitalize",
31166
+ "inheritedFrom": {
31167
+ "name": "Input",
31168
+ "module": "components/input/input.component.js"
31169
+ }
31170
+ },
31171
+ {
31172
+ "kind": "field",
31173
+ "name": "autocomplete",
31174
+ "type": {
31175
+ "text": "AutoCompleteType"
31176
+ },
31177
+ "description": "The autocomplete attribute of the input field.",
31178
+ "default": "'off'",
31179
+ "attribute": "autocomplete",
31180
+ "inheritedFrom": {
31181
+ "name": "Input",
31182
+ "module": "components/input/input.component.js"
31183
+ }
31184
+ },
31185
+ {
31186
+ "kind": "field",
31187
+ "name": "autofocus",
31188
+ "type": {
31189
+ "text": "boolean"
31190
+ },
31191
+ "default": "false",
31192
+ "description": "If true, the input field is focused when the component is rendered.",
31193
+ "attribute": "autofocus",
31194
+ "inheritedFrom": {
31195
+ "name": "Input",
31196
+ "module": "components/input/input.component.js"
31197
+ }
31198
+ },
31199
+ {
31200
+ "kind": "field",
31201
+ "name": "dirname",
31202
+ "type": {
31203
+ "text": "string | undefined"
31204
+ },
31205
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
31206
+ "attribute": "dirname",
31207
+ "inheritedFrom": {
31208
+ "name": "Input",
31209
+ "module": "components/input/input.component.js"
31210
+ }
31211
+ },
31212
+ {
31213
+ "kind": "field",
31214
+ "name": "pattern",
31215
+ "type": {
31216
+ "text": "string | undefined"
31217
+ },
31218
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
31219
+ "attribute": "pattern",
31220
+ "inheritedFrom": {
31221
+ "name": "Input",
31222
+ "module": "components/input/input.component.js"
31223
+ }
31224
+ },
31225
+ {
31226
+ "kind": "field",
31227
+ "name": "list",
31228
+ "type": {
31229
+ "text": "string | undefined"
31230
+ },
31231
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
31232
+ "attribute": "list",
31233
+ "inheritedFrom": {
31234
+ "name": "Input",
31235
+ "module": "components/input/input.component.js"
31236
+ }
31237
+ },
31238
+ {
31239
+ "kind": "field",
31240
+ "name": "size",
31241
+ "type": {
31242
+ "text": "number | undefined | undefined"
31243
+ },
31244
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
31245
+ "default": "undefined",
31246
+ "attribute": "size",
31247
+ "inheritedFrom": {
31248
+ "name": "Input",
31249
+ "module": "components/input/input.component.js"
31250
+ }
31251
+ },
31252
+ {
31253
+ "kind": "field",
31254
+ "name": "clearAriaLabel",
31255
+ "type": {
31256
+ "text": "string"
31257
+ },
31258
+ "default": "''",
31259
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
31260
+ "attribute": "clear-aria-label",
31261
+ "inheritedFrom": {
31262
+ "name": "Input",
31263
+ "module": "components/input/input.component.js"
31264
+ }
31265
+ },
31266
+ {
31267
+ "kind": "method",
31268
+ "name": "setInputValidity",
31269
+ "privacy": "private",
31270
+ "inheritedFrom": {
31271
+ "name": "Input",
31272
+ "module": "components/input/input.component.js"
31273
+ }
31274
+ },
31275
+ {
31276
+ "kind": "method",
31277
+ "name": "updateValue",
31278
+ "privacy": "private",
31279
+ "description": "Updates the value of the input field.\nSets the form value.",
31280
+ "return": {
31281
+ "type": {
31282
+ "text": ""
31283
+ }
31284
+ },
31285
+ "inheritedFrom": {
31286
+ "name": "Input",
31287
+ "module": "components/input/input.component.js"
31288
+ }
31289
+ },
31290
+ {
31291
+ "kind": "method",
31292
+ "name": "onInput",
31293
+ "privacy": "private",
31294
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
31295
+ "inheritedFrom": {
31296
+ "name": "Input",
31297
+ "module": "components/input/input.component.js"
31298
+ }
31299
+ },
31300
+ {
31301
+ "kind": "method",
31302
+ "name": "onChange",
31303
+ "privacy": "private",
31304
+ "parameters": [
31305
+ {
31306
+ "name": "event",
31307
+ "type": {
31308
+ "text": "Event"
31309
+ },
31310
+ "description": "Event which contains information about the value change."
31311
+ }
31312
+ ],
31313
+ "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed",
31314
+ "inheritedFrom": {
31315
+ "name": "Input",
31316
+ "module": "components/input/input.component.js"
31317
+ }
31318
+ },
31319
+ {
31320
+ "kind": "method",
31321
+ "name": "renderLeadingIcon",
31322
+ "privacy": "protected",
31323
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
31324
+ "return": {
31325
+ "type": {
31326
+ "text": ""
31327
+ }
31328
+ },
31329
+ "inheritedFrom": {
31330
+ "name": "Input",
31331
+ "module": "components/input/input.component.js"
31332
+ }
31333
+ },
31334
+ {
31335
+ "kind": "method",
31336
+ "name": "renderPrefixText",
31337
+ "privacy": "protected",
31338
+ "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
31339
+ "return": {
31340
+ "type": {
31341
+ "text": ""
31342
+ }
31343
+ },
31344
+ "inheritedFrom": {
31345
+ "name": "Input",
31346
+ "module": "components/input/input.component.js"
31347
+ }
31348
+ },
31349
+ {
31350
+ "kind": "method",
31351
+ "name": "renderTrailingButton",
31352
+ "privacy": "protected",
31353
+ "parameters": [
31354
+ {
31355
+ "name": "show",
31356
+ "default": "false"
31357
+ }
31358
+ ],
31359
+ "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
31360
+ "return": {
31361
+ "type": {
31362
+ "text": ""
31363
+ }
31364
+ },
31365
+ "inheritedFrom": {
31366
+ "name": "Input",
31367
+ "module": "components/input/input.component.js"
31368
+ }
31369
+ },
31370
+ {
31371
+ "kind": "method",
31372
+ "name": "renderInputElement",
31373
+ "privacy": "protected",
31374
+ "parameters": [
31375
+ {
31376
+ "name": "type",
31377
+ "type": {
31378
+ "text": "InputType"
31379
+ }
31380
+ },
31381
+ {
31382
+ "name": "hidePlaceholder",
31383
+ "default": "false"
31384
+ }
31385
+ ],
31386
+ "inheritedFrom": {
31387
+ "name": "Input",
31388
+ "module": "components/input/input.component.js"
31389
+ }
31390
+ },
31221
31391
  {
31222
31392
  "kind": "field",
31223
31393
  "name": "disabled",
@@ -31425,90 +31595,71 @@
31425
31595
  ],
31426
31596
  "events": [
31427
31597
  {
31428
- "name": "change",
31429
- "type": {
31430
- "text": "CustomEvent"
31431
- },
31432
- "description": "(React: onChange) This event is dispatched when the select is changed.",
31433
- "reactName": "onChange"
31434
- },
31435
- {
31598
+ "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
31436
31599
  "name": "input",
31437
- "type": {
31438
- "text": "CustomEvent"
31439
- },
31440
- "description": "(React: onInput) This event is dispatched when the select is changed.",
31441
- "reactName": "onInput"
31442
- },
31443
- {
31444
- "description": "(React: onClick) This event is dispatched when the select is clicked.",
31445
- "name": "click",
31446
- "reactName": "onClick"
31600
+ "reactName": "onInput",
31601
+ "inheritedFrom": {
31602
+ "name": "Input",
31603
+ "module": "src/components/input/input.component.ts"
31604
+ }
31447
31605
  },
31448
31606
  {
31449
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
31450
- "name": "keydown",
31451
- "reactName": "onKeyDown"
31607
+ "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
31608
+ "name": "change",
31609
+ "reactName": "onChange",
31610
+ "inheritedFrom": {
31611
+ "name": "Input",
31612
+ "module": "src/components/input/input.component.ts"
31613
+ }
31452
31614
  },
31453
31615
  {
31454
- "description": "(React: onFocus) This event is dispatched when the select receives focus.",
31616
+ "description": "(React: onFocus) This event is dispatched when the input receives focus.",
31455
31617
  "name": "focus",
31456
- "reactName": "onFocus"
31457
- }
31458
- ],
31459
- "attributes": [
31460
- {
31461
- "name": "placeholder",
31462
- "type": {
31463
- "text": "string | undefined"
31464
- },
31465
- "description": "The placeholder text which will be shown on the text if provided.",
31466
- "fieldName": "placeholder"
31467
- },
31468
- {
31469
- "name": "readonly",
31470
- "type": {
31471
- "text": "boolean"
31472
- },
31473
- "default": "false",
31474
- "description": "readonly attribute of the select field. If true, the select is read-only.",
31475
- "fieldName": "readonly"
31476
- },
31477
- {
31478
- "name": "placement",
31479
- "type": {
31480
- "text": "Placement"
31481
- },
31482
- "description": "The placeholder text which will be shown on the text if provided.",
31483
- "fieldName": "placement"
31618
+ "reactName": "onFocus",
31619
+ "inheritedFrom": {
31620
+ "name": "Input",
31621
+ "module": "src/components/input/input.component.ts"
31622
+ }
31484
31623
  },
31485
31624
  {
31486
- "name": "soft-disabled",
31487
- "type": {
31488
- "text": "boolean | undefined"
31489
- },
31490
- "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
31491
- "default": "undefined",
31492
- "fieldName": "softDisabled"
31625
+ "description": "(React: onBlur) This event is dispatched when the input loses focus.",
31626
+ "name": "blur",
31627
+ "reactName": "onBlur",
31628
+ "inheritedFrom": {
31629
+ "name": "Input",
31630
+ "module": "src/components/input/input.component.ts"
31631
+ }
31493
31632
  },
31494
31633
  {
31495
- "name": "boundary",
31634
+ "name": "clear",
31496
31635
  "type": {
31497
- "text": "'clippingAncestors' | string"
31636
+ "text": "CustomEvent"
31498
31637
  },
31499
- "description": "This describes the clipping element(s) or area that overflow of the used popover will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
31500
- "default": "'clippingAncestors'",
31501
- "fieldName": "boundary"
31638
+ "description": "(React: onClear) This event is dispatched when the input text is cleared.",
31639
+ "reactName": "onClear",
31640
+ "inheritedFrom": {
31641
+ "name": "Input",
31642
+ "module": "src/components/input/input.component.ts"
31643
+ }
31502
31644
  },
31503
31645
  {
31504
- "name": "strategy",
31505
31646
  "type": {
31506
- "text": "'absolute' | 'fixed'"
31647
+ "text": "EventConstructor"
31507
31648
  },
31508
- "description": "The strategy of the popover within Select.\nThis determines how the popover is positioned in the DOM.\n\nIn case `boundary` is set to something other than 'clippingAncestors',\nit might be necessary to set the `strategy` to 'fixed' to ensure that the popover\nis not getting clipped by scrollable containers enclosing the select.",
31509
- "default": "absolute",
31510
- "fieldName": "strategy"
31511
- },
31649
+ "inheritedFrom": {
31650
+ "name": "Input",
31651
+ "module": "src/components/input/input.component.ts"
31652
+ }
31653
+ }
31654
+ ],
31655
+ "superclass": {
31656
+ "name": "Input",
31657
+ "module": "/src/components/input/input.component"
31658
+ },
31659
+ "tagName": "mdc-searchfield",
31660
+ "jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n * \n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n */",
31661
+ "customElement": true,
31662
+ "attributes": [
31512
31663
  {
31513
31664
  "name": "name",
31514
31665
  "type": {
@@ -31561,70 +31712,258 @@
31561
31712
  }
31562
31713
  },
31563
31714
  {
31564
- "name": "disabled",
31715
+ "name": "placeholder",
31565
31716
  "type": {
31566
- "text": "boolean | undefined"
31717
+ "text": "string"
31567
31718
  },
31568
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
31569
- "default": "undefined",
31570
- "fieldName": "disabled",
31719
+ "default": "''",
31720
+ "description": "The placeholder text that is displayed when the input field is empty.",
31721
+ "fieldName": "placeholder",
31571
31722
  "inheritedFrom": {
31572
- "name": "FormfieldWrapper",
31573
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31723
+ "name": "Input",
31724
+ "module": "src/components/input/input.component.ts"
31574
31725
  }
31575
31726
  },
31576
31727
  {
31577
- "name": "label",
31728
+ "name": "readonly",
31578
31729
  "type": {
31579
- "text": "string | undefined"
31730
+ "text": "boolean"
31580
31731
  },
31581
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
31582
- "fieldName": "label",
31732
+ "default": "false",
31733
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
31734
+ "fieldName": "readonly",
31583
31735
  "inheritedFrom": {
31584
- "name": "FormfieldWrapper",
31585
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31736
+ "name": "Input",
31737
+ "module": "src/components/input/input.component.ts"
31586
31738
  }
31587
31739
  },
31588
31740
  {
31589
- "name": "required",
31741
+ "name": "prefix-text",
31590
31742
  "type": {
31591
- "text": "boolean"
31743
+ "text": "string | undefined"
31592
31744
  },
31593
- "default": "false",
31594
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
31595
- "fieldName": "required",
31745
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
31746
+ "fieldName": "prefixText",
31596
31747
  "inheritedFrom": {
31597
- "name": "FormfieldWrapper",
31598
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31748
+ "name": "Input",
31749
+ "module": "src/components/input/input.component.ts"
31599
31750
  }
31600
31751
  },
31601
31752
  {
31602
- "name": "id",
31753
+ "name": "leading-icon",
31603
31754
  "type": {
31604
- "text": "string"
31755
+ "text": "IconNames | undefined"
31605
31756
  },
31606
- "default": "''",
31607
- "description": "The unique id of the input field. It is used to link the input field with the label.",
31608
- "fieldName": "id",
31757
+ "description": "The leading icon that is displayed before the input field.",
31758
+ "fieldName": "leadingIcon",
31609
31759
  "inheritedFrom": {
31610
- "name": "FormfieldWrapper",
31611
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31760
+ "name": "Input",
31761
+ "module": "src/components/input/input.component.ts"
31612
31762
  }
31613
31763
  },
31614
31764
  {
31615
- "name": "help-text-type",
31765
+ "name": "trailing-button",
31616
31766
  "type": {
31617
- "text": "ValidationType"
31767
+ "text": "boolean"
31618
31768
  },
31619
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
31620
- "fieldName": "helpTextType",
31769
+ "default": "false",
31770
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
31771
+ "fieldName": "trailingButton",
31621
31772
  "inheritedFrom": {
31622
- "name": "FormfieldWrapper",
31623
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31773
+ "name": "Input",
31774
+ "module": "src/components/input/input.component.ts"
31624
31775
  }
31625
31776
  },
31626
31777
  {
31627
- "name": "help-text",
31778
+ "name": "maxlength",
31779
+ "type": {
31780
+ "text": "number | undefined"
31781
+ },
31782
+ "description": "The maximum number of characters that the input field can accept.",
31783
+ "fieldName": "maxlength",
31784
+ "inheritedFrom": {
31785
+ "name": "Input",
31786
+ "module": "src/components/input/input.component.ts"
31787
+ }
31788
+ },
31789
+ {
31790
+ "name": "minlength",
31791
+ "type": {
31792
+ "text": "number | undefined"
31793
+ },
31794
+ "description": "The minimum number of characters that the input field can accept.",
31795
+ "fieldName": "minlength",
31796
+ "inheritedFrom": {
31797
+ "name": "Input",
31798
+ "module": "src/components/input/input.component.ts"
31799
+ }
31800
+ },
31801
+ {
31802
+ "name": "autocapitalize",
31803
+ "type": {
31804
+ "text": "AutoCapitalizeType"
31805
+ },
31806
+ "description": "The autocapitalize attribute of the input field.",
31807
+ "default": "'off'",
31808
+ "fieldName": "autocapitalize",
31809
+ "inheritedFrom": {
31810
+ "name": "Input",
31811
+ "module": "src/components/input/input.component.ts"
31812
+ }
31813
+ },
31814
+ {
31815
+ "name": "autocomplete",
31816
+ "type": {
31817
+ "text": "AutoCompleteType"
31818
+ },
31819
+ "description": "The autocomplete attribute of the input field.",
31820
+ "default": "'off'",
31821
+ "fieldName": "autocomplete",
31822
+ "inheritedFrom": {
31823
+ "name": "Input",
31824
+ "module": "src/components/input/input.component.ts"
31825
+ }
31826
+ },
31827
+ {
31828
+ "name": "autofocus",
31829
+ "type": {
31830
+ "text": "boolean"
31831
+ },
31832
+ "default": "false",
31833
+ "description": "If true, the input field is focused when the component is rendered.",
31834
+ "fieldName": "autofocus",
31835
+ "inheritedFrom": {
31836
+ "name": "Input",
31837
+ "module": "src/components/input/input.component.ts"
31838
+ }
31839
+ },
31840
+ {
31841
+ "name": "dirname",
31842
+ "type": {
31843
+ "text": "string | undefined"
31844
+ },
31845
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
31846
+ "fieldName": "dirname",
31847
+ "inheritedFrom": {
31848
+ "name": "Input",
31849
+ "module": "src/components/input/input.component.ts"
31850
+ }
31851
+ },
31852
+ {
31853
+ "name": "pattern",
31854
+ "type": {
31855
+ "text": "string | undefined"
31856
+ },
31857
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
31858
+ "fieldName": "pattern",
31859
+ "inheritedFrom": {
31860
+ "name": "Input",
31861
+ "module": "src/components/input/input.component.ts"
31862
+ }
31863
+ },
31864
+ {
31865
+ "name": "list",
31866
+ "type": {
31867
+ "text": "string | undefined"
31868
+ },
31869
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
31870
+ "fieldName": "list",
31871
+ "inheritedFrom": {
31872
+ "name": "Input",
31873
+ "module": "src/components/input/input.component.ts"
31874
+ }
31875
+ },
31876
+ {
31877
+ "name": "size",
31878
+ "type": {
31879
+ "text": "number | undefined | undefined"
31880
+ },
31881
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
31882
+ "default": "undefined",
31883
+ "fieldName": "size",
31884
+ "inheritedFrom": {
31885
+ "name": "Input",
31886
+ "module": "src/components/input/input.component.ts"
31887
+ }
31888
+ },
31889
+ {
31890
+ "name": "clear-aria-label",
31891
+ "type": {
31892
+ "text": "string"
31893
+ },
31894
+ "default": "''",
31895
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
31896
+ "fieldName": "clearAriaLabel",
31897
+ "inheritedFrom": {
31898
+ "name": "Input",
31899
+ "module": "src/components/input/input.component.ts"
31900
+ }
31901
+ },
31902
+ {
31903
+ "name": "disabled",
31904
+ "type": {
31905
+ "text": "boolean | undefined"
31906
+ },
31907
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
31908
+ "default": "undefined",
31909
+ "fieldName": "disabled",
31910
+ "inheritedFrom": {
31911
+ "name": "FormfieldWrapper",
31912
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31913
+ }
31914
+ },
31915
+ {
31916
+ "name": "label",
31917
+ "type": {
31918
+ "text": "string | undefined"
31919
+ },
31920
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
31921
+ "fieldName": "label",
31922
+ "inheritedFrom": {
31923
+ "name": "FormfieldWrapper",
31924
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31925
+ }
31926
+ },
31927
+ {
31928
+ "name": "required",
31929
+ "type": {
31930
+ "text": "boolean"
31931
+ },
31932
+ "default": "false",
31933
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
31934
+ "fieldName": "required",
31935
+ "inheritedFrom": {
31936
+ "name": "FormfieldWrapper",
31937
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31938
+ }
31939
+ },
31940
+ {
31941
+ "name": "id",
31942
+ "type": {
31943
+ "text": "string"
31944
+ },
31945
+ "default": "''",
31946
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
31947
+ "fieldName": "id",
31948
+ "inheritedFrom": {
31949
+ "name": "FormfieldWrapper",
31950
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31951
+ }
31952
+ },
31953
+ {
31954
+ "name": "help-text-type",
31955
+ "type": {
31956
+ "text": "ValidationType"
31957
+ },
31958
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
31959
+ "fieldName": "helpTextType",
31960
+ "inheritedFrom": {
31961
+ "name": "FormfieldWrapper",
31962
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31963
+ }
31964
+ },
31965
+ {
31966
+ "name": "help-text",
31628
31967
  "type": {
31629
31968
  "text": "string | undefined"
31630
31969
  },
@@ -31673,23 +32012,136 @@
31673
32012
  }
31674
32013
  }
31675
32014
  ],
31676
- "mixins": [
32015
+ "cssProperties": [
31677
32016
  {
31678
- "name": "FormInternalsMixin",
31679
- "module": "/src/utils/mixins/FormInternalsMixin"
32017
+ "description": "Border color for the input container when disabled",
32018
+ "name": "--mdc-input-disabled-border-color",
32019
+ "inheritedFrom": {
32020
+ "name": "Input",
32021
+ "module": "src/components/input/input.component.ts"
32022
+ }
31680
32023
  },
31681
32024
  {
31682
- "name": "DataAriaLabelMixin",
31683
- "module": "/src/utils/mixins/DataAriaLabelMixin"
32025
+ "description": "Text color for the input field when disabled",
32026
+ "name": "--mdc-input-disabled-text-color",
32027
+ "inheritedFrom": {
32028
+ "name": "Input",
32029
+ "module": "src/components/input/input.component.ts"
32030
+ }
32031
+ },
32032
+ {
32033
+ "description": "Background color for the input field when disabled",
32034
+ "name": "--mdc-input-disabled-background-color",
32035
+ "inheritedFrom": {
32036
+ "name": "Input",
32037
+ "module": "src/components/input/input.component.ts"
32038
+ }
32039
+ },
32040
+ {
32041
+ "description": "Border color for the input container",
32042
+ "name": "--mdc-input-border-color",
32043
+ "inheritedFrom": {
32044
+ "name": "Input",
32045
+ "module": "src/components/input/input.component.ts"
32046
+ }
32047
+ },
32048
+ {
32049
+ "description": "Text color for the input field",
32050
+ "name": "--mdc-input-text-color",
32051
+ "inheritedFrom": {
32052
+ "name": "Input",
32053
+ "module": "src/components/input/input.component.ts"
32054
+ }
32055
+ },
32056
+ {
32057
+ "description": "Background color for the input field",
32058
+ "name": "--mdc-input-background-color",
32059
+ "inheritedFrom": {
32060
+ "name": "Input",
32061
+ "module": "src/components/input/input.component.ts"
32062
+ }
32063
+ },
32064
+ {
32065
+ "description": "Background color for the selected text",
32066
+ "name": "--mdc-input-selection-background-color",
32067
+ "inheritedFrom": {
32068
+ "name": "Input",
32069
+ "module": "src/components/input/input.component.ts"
32070
+ }
32071
+ },
32072
+ {
32073
+ "description": "Text color for the selected text",
32074
+ "name": "--mdc-input-selection-text-color",
32075
+ "inheritedFrom": {
32076
+ "name": "Input",
32077
+ "module": "src/components/input/input.component.ts"
32078
+ }
32079
+ },
32080
+ {
32081
+ "description": "Text color for the help text",
32082
+ "name": "--mdc-input-support-text-color",
32083
+ "inheritedFrom": {
32084
+ "name": "Input",
32085
+ "module": "src/components/input/input.component.ts"
32086
+ }
32087
+ },
32088
+ {
32089
+ "description": "Background color for the input field when hovered",
32090
+ "name": "--mdc-input-hover-background-color",
32091
+ "inheritedFrom": {
32092
+ "name": "Input",
32093
+ "module": "src/components/input/input.component.ts"
32094
+ }
32095
+ },
32096
+ {
32097
+ "description": "Background color for the input field when focused",
32098
+ "name": "--mdc-input-focused-background-color",
32099
+ "inheritedFrom": {
32100
+ "name": "Input",
32101
+ "module": "src/components/input/input.component.ts"
32102
+ }
32103
+ },
32104
+ {
32105
+ "description": "Border color for the input container when focused",
32106
+ "name": "--mdc-input-focused-border-color",
32107
+ "inheritedFrom": {
32108
+ "name": "Input",
32109
+ "module": "src/components/input/input.component.ts"
32110
+ }
32111
+ },
32112
+ {
32113
+ "description": "Border color for the input container when error",
32114
+ "name": "--mdc-input-error-border-color",
32115
+ "inheritedFrom": {
32116
+ "name": "Input",
32117
+ "module": "src/components/input/input.component.ts"
32118
+ }
32119
+ },
32120
+ {
32121
+ "description": "Border color for the input container when warning",
32122
+ "name": "--mdc-input-warning-border-color",
32123
+ "inheritedFrom": {
32124
+ "name": "Input",
32125
+ "module": "src/components/input/input.component.ts"
32126
+ }
32127
+ },
32128
+ {
32129
+ "description": "Border color for the input container when success",
32130
+ "name": "--mdc-input-success-border-color",
32131
+ "inheritedFrom": {
32132
+ "name": "Input",
32133
+ "module": "src/components/input/input.component.ts"
32134
+ }
32135
+ },
32136
+ {
32137
+ "description": "Border color for the input container when primary",
32138
+ "name": "--mdc-input-primary-border-color",
32139
+ "inheritedFrom": {
32140
+ "name": "Input",
32141
+ "module": "src/components/input/input.component.ts"
32142
+ }
31684
32143
  }
31685
- ],
31686
- "superclass": {
31687
- "name": "FormfieldWrapper",
31688
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
31689
- },
31690
- "tagName": "mdc-select",
31691
- "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * Every mdc-option should have a `value` attribute set to ensure proper form submission.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * **Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n *\n * @cssproperty --mdc-select-background-color - The background color of the combobox of select.\n * @cssproperty --mdc-select-background-color-hover - The background color of the combobox of select when hovered.\n * @cssproperty --mdc-select-background-color-active - The background color of the combobox of select when active.\n * @cssproperty --mdc-select-background-color-disabled - The background color of the combobox of select when disabled.\n * @cssproperty --mdc-select-text-color - The text color of the select.\n * @cssproperty --mdc-select-text-color-selected - The text color of the selected option in the select.\n * @cssproperty --mdc-select-text-color-disabled - The text color of the select when disabled.\n * @cssproperty --mdc-select-border-color - The border color of the select.\n * @cssproperty --mdc-select-border-color-disabled - The border color of the select when disabled.\n * @cssproperty --mdc-select-border-color-success - The border color of the select when in success state.\n * @cssproperty --mdc-select-border-color-warning - The border color of the select when in warning state.\n * @cssproperty --mdc-select-border-color-error - The border color of the select when in error state.\n * @cssproperty --mdc-select-width - The width of the select.\n * @cssproperty --mdc-select-listbox-height - The height of the listbox inside the select.\n * @cssproperty --mdc-select-listbox-width - The width of the listbox inside the select (default: `--mdc-select-width`).\n */",
31692
- "customElement": true
32144
+ ]
31693
32145
  }
31694
32146
  ],
31695
32147
  "exports": [
@@ -31697,8 +32149,8 @@
31697
32149
  "kind": "js",
31698
32150
  "name": "default",
31699
32151
  "declaration": {
31700
- "name": "Select",
31701
- "module": "components/select/select.component.js"
32152
+ "name": "Searchfield",
32153
+ "module": "components/searchfield/searchfield.component.js"
31702
32154
  }
31703
32155
  }
31704
32156
  ]
@@ -31745,60 +32197,408 @@
31745
32197
  },
31746
32198
  {
31747
32199
  "kind": "javascript-module",
31748
- "path": "components/searchfield/searchfield.component.js",
32200
+ "path": "components/select/select.component.js",
31749
32201
  "declarations": [
31750
32202
  {
31751
32203
  "kind": "class",
31752
- "description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
31753
- "name": "Searchfield",
32204
+ "description": "The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\nIt is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\nThe component ensures accessibility and usability while handling various use cases,\nincluding long text truncation with tooltip support.\n\nEvery mdc-option should have a `value` attribute set to ensure proper form submission.\n\nTo set a default option, use the `selected` attribute on the `mdc-option` element.\n\n**Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.",
32205
+ "name": "Select",
32206
+ "cssProperties": [
32207
+ {
32208
+ "description": "The background color of the combobox of select.",
32209
+ "name": "--mdc-select-background-color"
32210
+ },
32211
+ {
32212
+ "description": "The background color of the combobox of select when hovered.",
32213
+ "name": "--mdc-select-background-color-hover"
32214
+ },
32215
+ {
32216
+ "description": "The background color of the combobox of select when active.",
32217
+ "name": "--mdc-select-background-color-active"
32218
+ },
32219
+ {
32220
+ "description": "The background color of the combobox of select when disabled.",
32221
+ "name": "--mdc-select-background-color-disabled"
32222
+ },
32223
+ {
32224
+ "description": "The text color of the select.",
32225
+ "name": "--mdc-select-text-color"
32226
+ },
32227
+ {
32228
+ "description": "The text color of the selected option in the select.",
32229
+ "name": "--mdc-select-text-color-selected"
32230
+ },
32231
+ {
32232
+ "description": "The text color of the select when disabled.",
32233
+ "name": "--mdc-select-text-color-disabled"
32234
+ },
32235
+ {
32236
+ "description": "The border color of the select.",
32237
+ "name": "--mdc-select-border-color"
32238
+ },
32239
+ {
32240
+ "description": "The border color of the select when disabled.",
32241
+ "name": "--mdc-select-border-color-disabled"
32242
+ },
32243
+ {
32244
+ "description": "The border color of the select when in success state.",
32245
+ "name": "--mdc-select-border-color-success"
32246
+ },
32247
+ {
32248
+ "description": "The border color of the select when in warning state.",
32249
+ "name": "--mdc-select-border-color-warning"
32250
+ },
32251
+ {
32252
+ "description": "The border color of the select when in error state.",
32253
+ "name": "--mdc-select-border-color-error"
32254
+ },
32255
+ {
32256
+ "description": "The width of the select.",
32257
+ "name": "--mdc-select-width"
32258
+ },
32259
+ {
32260
+ "description": "The height of the listbox inside the select.",
32261
+ "name": "--mdc-select-listbox-height"
32262
+ },
32263
+ {
32264
+ "description": "The width of the listbox inside the select (default: `--mdc-select-width`).",
32265
+ "name": "--mdc-select-listbox-width"
32266
+ }
32267
+ ],
31754
32268
  "slots": [
31755
32269
  {
31756
- "description": "Slot for input chips",
31757
- "name": "filters"
32270
+ "description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
32271
+ "name": "default"
31758
32272
  }
31759
32273
  ],
31760
32274
  "members": [
31761
32275
  {
31762
32276
  "kind": "field",
31763
- "name": "inputChips",
32277
+ "name": "placeholder",
31764
32278
  "type": {
31765
- "text": "Array<HTMLElement> | undefined"
32279
+ "text": "string | undefined"
32280
+ },
32281
+ "description": "The placeholder text which will be shown on the text if provided.",
32282
+ "attribute": "placeholder"
32283
+ },
32284
+ {
32285
+ "kind": "field",
32286
+ "name": "readonly",
32287
+ "type": {
32288
+ "text": "boolean"
32289
+ },
32290
+ "default": "false",
32291
+ "description": "readonly attribute of the select field. If true, the select is read-only.",
32292
+ "attribute": "readonly"
32293
+ },
32294
+ {
32295
+ "kind": "field",
32296
+ "name": "placement",
32297
+ "type": {
32298
+ "text": "Placement"
32299
+ },
32300
+ "description": "The placeholder text which will be shown on the text if provided.",
32301
+ "attribute": "placement",
32302
+ "reflects": true
32303
+ },
32304
+ {
32305
+ "kind": "field",
32306
+ "name": "softDisabled",
32307
+ "type": {
32308
+ "text": "boolean | undefined"
32309
+ },
32310
+ "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
32311
+ "default": "undefined",
32312
+ "attribute": "soft-disabled",
32313
+ "reflects": true
32314
+ },
32315
+ {
32316
+ "kind": "field",
32317
+ "name": "boundary",
32318
+ "type": {
32319
+ "text": "'clippingAncestors' | string"
32320
+ },
32321
+ "description": "This describes the clipping element(s) or area that overflow of the used popover will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
32322
+ "default": "'clippingAncestors'",
32323
+ "attribute": "boundary",
32324
+ "reflects": true
32325
+ },
32326
+ {
32327
+ "kind": "field",
32328
+ "name": "strategy",
32329
+ "type": {
32330
+ "text": "'absolute' | 'fixed'"
32331
+ },
32332
+ "description": "The strategy of the popover within Select.\nThis determines how the popover is positioned in the DOM.\n\nIn case `boundary` is set to something other than 'clippingAncestors',\nit might be necessary to set the `strategy` to 'fixed' to ensure that the popover\nis not getting clipped by scrollable containers enclosing the select.",
32333
+ "default": "absolute",
32334
+ "attribute": "strategy",
32335
+ "reflects": true
32336
+ },
32337
+ {
32338
+ "kind": "field",
32339
+ "name": "popoverZIndex",
32340
+ "type": {
32341
+ "text": "number"
32342
+ },
32343
+ "description": "The z-index of the popover within Select.\n\nOverride this to make sure this stays on top of other components.",
32344
+ "default": "1000",
32345
+ "attribute": "popover-z-index",
32346
+ "reflects": true
32347
+ },
32348
+ {
32349
+ "kind": "field",
32350
+ "name": "backdropAppendTo",
32351
+ "type": {
32352
+ "text": "string | undefined"
32353
+ },
32354
+ "description": "ID of the element where the backdrop will be appended to.\nThis is useful to ensure that the backdrop is appended to the correct element in the DOM.\nIf not set, the backdrop will be appended to the parent element of the select.",
32355
+ "attribute": "backdrop-append-to",
32356
+ "reflects": true
32357
+ },
32358
+ {
32359
+ "kind": "method",
32360
+ "name": "getAllValidOptions",
32361
+ "privacy": "private",
32362
+ "return": {
32363
+ "type": {
32364
+ "text": "Array<Option>"
32365
+ }
31766
32366
  }
31767
32367
  },
31768
32368
  {
31769
32369
  "kind": "method",
31770
- "name": "handleKeyDown",
31771
- "privacy": "protected",
32370
+ "name": "getFirstValidOption",
32371
+ "privacy": "private",
32372
+ "return": {
32373
+ "type": {
32374
+ "text": "Option | null"
32375
+ }
32376
+ }
32377
+ },
32378
+ {
32379
+ "kind": "method",
32380
+ "name": "getLastValidOption",
32381
+ "privacy": "private",
32382
+ "return": {
32383
+ "type": {
32384
+ "text": "Option | null"
32385
+ }
32386
+ }
32387
+ },
32388
+ {
32389
+ "kind": "method",
32390
+ "name": "getFirstSelectedOption",
32391
+ "privacy": "private",
32392
+ "return": {
32393
+ "type": {
32394
+ "text": "Option | null"
32395
+ }
32396
+ }
32397
+ },
32398
+ {
32399
+ "kind": "method",
32400
+ "name": "modifyListBoxWrapper",
32401
+ "privacy": "private",
32402
+ "description": "Modifies the listbox wrapper to ensure it has the correct attributes\nand IDs for accessibility.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers,\nthis an be removed and mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them."
32403
+ },
32404
+ {
32405
+ "kind": "method",
32406
+ "name": "handleOptionsClick",
32407
+ "privacy": "private",
32408
+ "return": {
32409
+ "type": {
32410
+ "text": "void"
32411
+ }
32412
+ },
32413
+ "parameters": [
32414
+ {
32415
+ "name": "event",
32416
+ "type": {
32417
+ "text": "MouseEvent"
32418
+ },
32419
+ "description": "The event which triggered this function."
32420
+ }
32421
+ ],
32422
+ "description": "A private method which is called when an option is clicked.\nIt sets the selected option, removes selected from other options, updates the tabindex for all options,\ncloses the popover, and fires the change and input events."
32423
+ },
32424
+ {
32425
+ "kind": "method",
32426
+ "name": "setSelectedOption",
32427
+ "privacy": "private",
32428
+ "return": {
32429
+ "type": {
32430
+ "text": "void"
32431
+ }
32432
+ },
32433
+ "parameters": [
32434
+ {
32435
+ "name": "option",
32436
+ "type": {
32437
+ "text": "Option | null"
32438
+ },
32439
+ "description": "The option element in DOM which gets selected."
32440
+ }
32441
+ ],
32442
+ "description": "Sets the selected option in the component state and updates the input element's value.\nThis method ensures that only the selected option is marked as selected in the DOM,\nand updates the tabindex for all options accordingly.\nIt also updates the validity of the input element based on the selected option.\nThis method is called when an option is selected."
32443
+ },
32444
+ {
32445
+ "kind": "method",
32446
+ "name": "updateTabIndexForAllOptions",
32447
+ "privacy": "private",
32448
+ "return": {
32449
+ "type": {
32450
+ "text": "void"
32451
+ }
32452
+ },
32453
+ "parameters": [
32454
+ {
32455
+ "name": "option",
32456
+ "optional": true,
32457
+ "type": {
32458
+ "text": "Option | null"
32459
+ },
32460
+ "description": "The option which tabIndex should be set to 0."
32461
+ }
32462
+ ],
32463
+ "description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
32464
+ },
32465
+ {
32466
+ "kind": "method",
32467
+ "name": "updateSelectedInChildOptions",
32468
+ "privacy": "private",
32469
+ "return": {
32470
+ "type": {
32471
+ "text": "void"
32472
+ }
32473
+ },
32474
+ "parameters": [
32475
+ {
32476
+ "name": "selectedOption",
32477
+ "type": {
32478
+ "text": "Option | null"
32479
+ },
32480
+ "description": "The option which gets selected"
32481
+ }
32482
+ ],
32483
+ "description": "Sets selected attribute on the selected option and removes it from all options"
32484
+ },
32485
+ {
32486
+ "kind": "method",
32487
+ "name": "fireEvents",
32488
+ "privacy": "private",
32489
+ "return": {
32490
+ "type": {
32491
+ "text": "void"
32492
+ }
32493
+ },
32494
+ "description": "A private method which is called to fire the change and input events.\nIt dispatches the input and change events with the selected option's value and label."
32495
+ },
32496
+ {
32497
+ "kind": "method",
32498
+ "name": "dispatchChange",
32499
+ "privacy": "private",
32500
+ "return": {
32501
+ "type": {
32502
+ "text": "void"
32503
+ }
32504
+ },
32505
+ "parameters": [
32506
+ {
32507
+ "name": "option",
32508
+ "type": {
32509
+ "text": "Option"
32510
+ }
32511
+ }
32512
+ ]
32513
+ },
32514
+ {
32515
+ "kind": "method",
32516
+ "name": "dispatchInput",
32517
+ "privacy": "private",
32518
+ "return": {
32519
+ "type": {
32520
+ "text": "void"
32521
+ }
32522
+ },
32523
+ "parameters": [
32524
+ {
32525
+ "name": "option",
32526
+ "type": {
32527
+ "text": "Option"
32528
+ }
32529
+ }
32530
+ ]
32531
+ },
32532
+ {
32533
+ "kind": "method",
32534
+ "name": "handleClickCombobox",
32535
+ "privacy": "private",
32536
+ "return": {
32537
+ "type": {
32538
+ "text": "void"
32539
+ }
32540
+ },
32541
+ "parameters": [
32542
+ {
32543
+ "name": "event",
32544
+ "type": {
32545
+ "text": "MouseEvent"
32546
+ },
32547
+ "description": "The mouse event which triggered this function."
32548
+ }
32549
+ ],
32550
+ "description": "Handles the click event on the visual combobox.\nIf the select is disabled, soft-disabled or readonly, it does nothing.\nIf the popover is already open, it closes it.\nIf it is closed, it opens it."
32551
+ },
32552
+ {
32553
+ "kind": "method",
32554
+ "name": "handleKeydownCombobox",
32555
+ "privacy": "private",
32556
+ "return": {
32557
+ "type": {
32558
+ "text": "void"
32559
+ }
32560
+ },
31772
32561
  "parameters": [
31773
32562
  {
31774
32563
  "name": "event",
31775
32564
  "type": {
31776
32565
  "text": "KeyboardEvent"
31777
32566
  },
31778
- "description": "Keyboard event"
32567
+ "description": "The keyboard event."
31779
32568
  }
31780
32569
  ],
31781
- "description": "Handles the keydown event of the search field.\nIf the key pressed is 'Enter', it submits the form.\nIf the key pressed is 'Escape', it clears the input text.",
31782
- "inheritedFrom": {
31783
- "name": "Input",
31784
- "module": "components/input/input.component.js"
31785
- }
32570
+ "description": "Handles the keydown event on the select element when the popover is closed.\nThe options are as follows:\n- ARROW_DOWN, ARROW_UP, SPACE: Opens the popover and prevents the default scrolling behavior.\n- ENTER: Opens the popover, prevents default scrolling, and submits the form if the popover is closed.\n- HOME: Opens the popover and sets focus and tabindex on the first option.\n- END: Opens the popover and sets focus and tabindex on the last option."
31786
32571
  },
31787
32572
  {
31788
32573
  "kind": "method",
31789
- "name": "renderInputChips",
32574
+ "name": "handlePopoverKeydown",
31790
32575
  "privacy": "private",
31791
- "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
32576
+ "return": {
32577
+ "type": {
32578
+ "text": "void"
32579
+ }
32580
+ },
32581
+ "parameters": [
32582
+ {
32583
+ "name": "event",
32584
+ "type": {
32585
+ "text": "KeyboardEvent"
32586
+ },
32587
+ "description": "The keyboard event."
32588
+ }
32589
+ ],
32590
+ "description": "Handles the keydown event on the select element when the popover is open.\nThe options are as follows:\n- HOME: Sets focus and tabindex on the first option.\n- END: Sets focus and tabindex on the last option.\n- ARROW_DOWN, ARROW_UP, PAGE_DOWN, PAGE_UP: Handles navigation between options."
31792
32591
  },
31793
32592
  {
31794
32593
  "kind": "method",
31795
- "name": "clearInputText",
31796
- "privacy": "protected",
31797
- "description": "Clears the input field.",
31798
- "inheritedFrom": {
31799
- "name": "Input",
31800
- "module": "components/input/input.component.js"
31801
- }
32594
+ "name": "updateState",
32595
+ "privacy": "public",
32596
+ "return": {
32597
+ "type": {
32598
+ "text": "void"
32599
+ }
32600
+ },
32601
+ "description": "Updates the state of the select component.\nThis public method should be fired when the selected on the option components is updated from the outside.\nIt ensures that the selected attribute is set correctly on the options\nand that the aria-selected attribute is updated accordingly."
31802
32602
  },
31803
32603
  {
31804
32604
  "kind": "field",
@@ -31915,334 +32715,6 @@
31915
32715
  "module": "utils/mixins/DataAriaLabelMixin.js"
31916
32716
  }
31917
32717
  },
31918
- {
31919
- "kind": "field",
31920
- "name": "placeholder",
31921
- "type": {
31922
- "text": "string"
31923
- },
31924
- "default": "''",
31925
- "description": "The placeholder text that is displayed when the input field is empty.",
31926
- "attribute": "placeholder",
31927
- "inheritedFrom": {
31928
- "name": "Input",
31929
- "module": "components/input/input.component.js"
31930
- }
31931
- },
31932
- {
31933
- "kind": "field",
31934
- "name": "readonly",
31935
- "type": {
31936
- "text": "boolean"
31937
- },
31938
- "default": "false",
31939
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
31940
- "attribute": "readonly",
31941
- "inheritedFrom": {
31942
- "name": "Input",
31943
- "module": "components/input/input.component.js"
31944
- }
31945
- },
31946
- {
31947
- "kind": "field",
31948
- "name": "prefixText",
31949
- "type": {
31950
- "text": "string | undefined"
31951
- },
31952
- "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
31953
- "attribute": "prefix-text",
31954
- "inheritedFrom": {
31955
- "name": "Input",
31956
- "module": "components/input/input.component.js"
31957
- }
31958
- },
31959
- {
31960
- "kind": "field",
31961
- "name": "leadingIcon",
31962
- "type": {
31963
- "text": "IconNames | undefined"
31964
- },
31965
- "description": "The leading icon that is displayed before the input field.",
31966
- "attribute": "leading-icon",
31967
- "inheritedFrom": {
31968
- "name": "Input",
31969
- "module": "components/input/input.component.js"
31970
- }
31971
- },
31972
- {
31973
- "kind": "field",
31974
- "name": "trailingButton",
31975
- "type": {
31976
- "text": "boolean"
31977
- },
31978
- "default": "false",
31979
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
31980
- "attribute": "trailing-button",
31981
- "inheritedFrom": {
31982
- "name": "Input",
31983
- "module": "components/input/input.component.js"
31984
- }
31985
- },
31986
- {
31987
- "kind": "field",
31988
- "name": "maxlength",
31989
- "type": {
31990
- "text": "number | undefined"
31991
- },
31992
- "description": "The maximum number of characters that the input field can accept.",
31993
- "attribute": "maxlength",
31994
- "inheritedFrom": {
31995
- "name": "Input",
31996
- "module": "components/input/input.component.js"
31997
- }
31998
- },
31999
- {
32000
- "kind": "field",
32001
- "name": "minlength",
32002
- "type": {
32003
- "text": "number | undefined"
32004
- },
32005
- "description": "The minimum number of characters that the input field can accept.",
32006
- "attribute": "minlength",
32007
- "inheritedFrom": {
32008
- "name": "Input",
32009
- "module": "components/input/input.component.js"
32010
- }
32011
- },
32012
- {
32013
- "kind": "field",
32014
- "name": "autocapitalize",
32015
- "type": {
32016
- "text": "AutoCapitalizeType"
32017
- },
32018
- "description": "The autocapitalize attribute of the input field.",
32019
- "default": "'off'",
32020
- "attribute": "autocapitalize",
32021
- "inheritedFrom": {
32022
- "name": "Input",
32023
- "module": "components/input/input.component.js"
32024
- }
32025
- },
32026
- {
32027
- "kind": "field",
32028
- "name": "autocomplete",
32029
- "type": {
32030
- "text": "AutoCompleteType"
32031
- },
32032
- "description": "The autocomplete attribute of the input field.",
32033
- "default": "'off'",
32034
- "attribute": "autocomplete",
32035
- "inheritedFrom": {
32036
- "name": "Input",
32037
- "module": "components/input/input.component.js"
32038
- }
32039
- },
32040
- {
32041
- "kind": "field",
32042
- "name": "autofocus",
32043
- "type": {
32044
- "text": "boolean"
32045
- },
32046
- "default": "false",
32047
- "description": "If true, the input field is focused when the component is rendered.",
32048
- "attribute": "autofocus",
32049
- "inheritedFrom": {
32050
- "name": "Input",
32051
- "module": "components/input/input.component.js"
32052
- }
32053
- },
32054
- {
32055
- "kind": "field",
32056
- "name": "dirname",
32057
- "type": {
32058
- "text": "string | undefined"
32059
- },
32060
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
32061
- "attribute": "dirname",
32062
- "inheritedFrom": {
32063
- "name": "Input",
32064
- "module": "components/input/input.component.js"
32065
- }
32066
- },
32067
- {
32068
- "kind": "field",
32069
- "name": "pattern",
32070
- "type": {
32071
- "text": "string | undefined"
32072
- },
32073
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
32074
- "attribute": "pattern",
32075
- "inheritedFrom": {
32076
- "name": "Input",
32077
- "module": "components/input/input.component.js"
32078
- }
32079
- },
32080
- {
32081
- "kind": "field",
32082
- "name": "list",
32083
- "type": {
32084
- "text": "string | undefined"
32085
- },
32086
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
32087
- "attribute": "list",
32088
- "inheritedFrom": {
32089
- "name": "Input",
32090
- "module": "components/input/input.component.js"
32091
- }
32092
- },
32093
- {
32094
- "kind": "field",
32095
- "name": "size",
32096
- "type": {
32097
- "text": "number | undefined | undefined"
32098
- },
32099
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
32100
- "default": "undefined",
32101
- "attribute": "size",
32102
- "inheritedFrom": {
32103
- "name": "Input",
32104
- "module": "components/input/input.component.js"
32105
- }
32106
- },
32107
- {
32108
- "kind": "field",
32109
- "name": "clearAriaLabel",
32110
- "type": {
32111
- "text": "string"
32112
- },
32113
- "default": "''",
32114
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
32115
- "attribute": "clear-aria-label",
32116
- "inheritedFrom": {
32117
- "name": "Input",
32118
- "module": "components/input/input.component.js"
32119
- }
32120
- },
32121
- {
32122
- "kind": "method",
32123
- "name": "setInputValidity",
32124
- "privacy": "private",
32125
- "inheritedFrom": {
32126
- "name": "Input",
32127
- "module": "components/input/input.component.js"
32128
- }
32129
- },
32130
- {
32131
- "kind": "method",
32132
- "name": "updateValue",
32133
- "privacy": "private",
32134
- "description": "Updates the value of the input field.\nSets the form value.",
32135
- "return": {
32136
- "type": {
32137
- "text": ""
32138
- }
32139
- },
32140
- "inheritedFrom": {
32141
- "name": "Input",
32142
- "module": "components/input/input.component.js"
32143
- }
32144
- },
32145
- {
32146
- "kind": "method",
32147
- "name": "onInput",
32148
- "privacy": "private",
32149
- "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
32150
- "inheritedFrom": {
32151
- "name": "Input",
32152
- "module": "components/input/input.component.js"
32153
- }
32154
- },
32155
- {
32156
- "kind": "method",
32157
- "name": "onChange",
32158
- "privacy": "private",
32159
- "parameters": [
32160
- {
32161
- "name": "event",
32162
- "type": {
32163
- "text": "Event"
32164
- },
32165
- "description": "Event which contains information about the value change."
32166
- }
32167
- ],
32168
- "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed",
32169
- "inheritedFrom": {
32170
- "name": "Input",
32171
- "module": "components/input/input.component.js"
32172
- }
32173
- },
32174
- {
32175
- "kind": "method",
32176
- "name": "renderLeadingIcon",
32177
- "privacy": "protected",
32178
- "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
32179
- "return": {
32180
- "type": {
32181
- "text": ""
32182
- }
32183
- },
32184
- "inheritedFrom": {
32185
- "name": "Input",
32186
- "module": "components/input/input.component.js"
32187
- }
32188
- },
32189
- {
32190
- "kind": "method",
32191
- "name": "renderPrefixText",
32192
- "privacy": "protected",
32193
- "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
32194
- "return": {
32195
- "type": {
32196
- "text": ""
32197
- }
32198
- },
32199
- "inheritedFrom": {
32200
- "name": "Input",
32201
- "module": "components/input/input.component.js"
32202
- }
32203
- },
32204
- {
32205
- "kind": "method",
32206
- "name": "renderTrailingButton",
32207
- "privacy": "protected",
32208
- "parameters": [
32209
- {
32210
- "name": "show",
32211
- "default": "false"
32212
- }
32213
- ],
32214
- "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
32215
- "return": {
32216
- "type": {
32217
- "text": ""
32218
- }
32219
- },
32220
- "inheritedFrom": {
32221
- "name": "Input",
32222
- "module": "components/input/input.component.js"
32223
- }
32224
- },
32225
- {
32226
- "kind": "method",
32227
- "name": "renderInputElement",
32228
- "privacy": "protected",
32229
- "parameters": [
32230
- {
32231
- "name": "type",
32232
- "type": {
32233
- "text": "InputType"
32234
- }
32235
- },
32236
- {
32237
- "name": "hidePlaceholder",
32238
- "default": "false"
32239
- }
32240
- ],
32241
- "inheritedFrom": {
32242
- "name": "Input",
32243
- "module": "components/input/input.component.js"
32244
- }
32245
- },
32246
32718
  {
32247
32719
  "kind": "field",
32248
32720
  "name": "disabled",
@@ -32447,311 +32919,159 @@
32447
32919
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
32448
32920
  }
32449
32921
  }
32450
- ],
32451
- "events": [
32452
- {
32453
- "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
32454
- "name": "input",
32455
- "reactName": "onInput",
32456
- "inheritedFrom": {
32457
- "name": "Input",
32458
- "module": "src/components/input/input.component.ts"
32459
- }
32460
- },
32461
- {
32462
- "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
32463
- "name": "change",
32464
- "reactName": "onChange",
32465
- "inheritedFrom": {
32466
- "name": "Input",
32467
- "module": "src/components/input/input.component.ts"
32468
- }
32469
- },
32470
- {
32471
- "description": "(React: onFocus) This event is dispatched when the input receives focus.",
32472
- "name": "focus",
32473
- "reactName": "onFocus",
32474
- "inheritedFrom": {
32475
- "name": "Input",
32476
- "module": "src/components/input/input.component.ts"
32477
- }
32478
- },
32479
- {
32480
- "description": "(React: onBlur) This event is dispatched when the input loses focus.",
32481
- "name": "blur",
32482
- "reactName": "onBlur",
32483
- "inheritedFrom": {
32484
- "name": "Input",
32485
- "module": "src/components/input/input.component.ts"
32486
- }
32487
- },
32488
- {
32489
- "name": "clear",
32490
- "type": {
32491
- "text": "CustomEvent"
32492
- },
32493
- "description": "(React: onClear) This event is dispatched when the input text is cleared.",
32494
- "reactName": "onClear",
32495
- "inheritedFrom": {
32496
- "name": "Input",
32497
- "module": "src/components/input/input.component.ts"
32498
- }
32499
- },
32500
- {
32501
- "type": {
32502
- "text": "EventConstructor"
32503
- },
32504
- "inheritedFrom": {
32505
- "name": "Input",
32506
- "module": "src/components/input/input.component.ts"
32507
- }
32508
- }
32509
- ],
32510
- "superclass": {
32511
- "name": "Input",
32512
- "module": "/src/components/input/input.component"
32513
- },
32514
- "tagName": "mdc-searchfield",
32515
- "jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n * \n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n */",
32516
- "customElement": true,
32517
- "attributes": [
32518
- {
32519
- "name": "name",
32520
- "type": {
32521
- "text": "string"
32522
- },
32523
- "default": "''",
32524
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
32525
- "fieldName": "name",
32526
- "inheritedFrom": {
32527
- "name": "FormInternalsMixin",
32528
- "module": "src/utils/mixins/FormInternalsMixin.ts"
32529
- }
32530
- },
32531
- {
32532
- "name": "value",
32533
- "type": {
32534
- "text": "string"
32535
- },
32536
- "default": "''",
32537
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
32538
- "fieldName": "value",
32539
- "inheritedFrom": {
32540
- "name": "FormInternalsMixin",
32541
- "module": "src/utils/mixins/FormInternalsMixin.ts"
32542
- }
32543
- },
32544
- {
32545
- "name": "validation-message",
32546
- "type": {
32547
- "text": "string | undefined"
32548
- },
32549
- "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.",
32550
- "fieldName": "validationMessage",
32551
- "inheritedFrom": {
32552
- "name": "FormInternalsMixin",
32553
- "module": "src/utils/mixins/FormInternalsMixin.ts"
32554
- }
32555
- },
32556
- {
32557
- "name": "data-aria-label",
32558
- "type": {
32559
- "text": "string | null"
32560
- },
32561
- "default": "null",
32562
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
32563
- "fieldName": "dataAriaLabel",
32564
- "inheritedFrom": {
32565
- "name": "DataAriaLabelMixin",
32566
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
32567
- }
32568
- },
32569
- {
32570
- "name": "placeholder",
32571
- "type": {
32572
- "text": "string"
32573
- },
32574
- "default": "''",
32575
- "description": "The placeholder text that is displayed when the input field is empty.",
32576
- "fieldName": "placeholder",
32577
- "inheritedFrom": {
32578
- "name": "Input",
32579
- "module": "src/components/input/input.component.ts"
32580
- }
32581
- },
32922
+ ],
32923
+ "events": [
32582
32924
  {
32583
- "name": "readonly",
32925
+ "name": "change",
32584
32926
  "type": {
32585
- "text": "boolean"
32927
+ "text": "CustomEvent"
32586
32928
  },
32587
- "default": "false",
32588
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
32589
- "fieldName": "readonly",
32590
- "inheritedFrom": {
32591
- "name": "Input",
32592
- "module": "src/components/input/input.component.ts"
32593
- }
32929
+ "description": "(React: onChange) This event is dispatched when the select is changed.",
32930
+ "reactName": "onChange"
32594
32931
  },
32595
32932
  {
32596
- "name": "prefix-text",
32933
+ "name": "input",
32597
32934
  "type": {
32598
- "text": "string | undefined"
32935
+ "text": "CustomEvent"
32599
32936
  },
32600
- "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
32601
- "fieldName": "prefixText",
32602
- "inheritedFrom": {
32603
- "name": "Input",
32604
- "module": "src/components/input/input.component.ts"
32605
- }
32937
+ "description": "(React: onInput) This event is dispatched when the select is changed.",
32938
+ "reactName": "onInput"
32606
32939
  },
32607
32940
  {
32608
- "name": "leading-icon",
32941
+ "description": "(React: onClick) This event is dispatched when the select is clicked.",
32942
+ "name": "click",
32943
+ "reactName": "onClick"
32944
+ },
32945
+ {
32946
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
32947
+ "name": "keydown",
32948
+ "reactName": "onKeyDown"
32949
+ },
32950
+ {
32951
+ "description": "(React: onFocus) This event is dispatched when the select receives focus.",
32952
+ "name": "focus",
32953
+ "reactName": "onFocus"
32954
+ }
32955
+ ],
32956
+ "attributes": [
32957
+ {
32958
+ "name": "placeholder",
32609
32959
  "type": {
32610
- "text": "IconNames | undefined"
32960
+ "text": "string | undefined"
32611
32961
  },
32612
- "description": "The leading icon that is displayed before the input field.",
32613
- "fieldName": "leadingIcon",
32614
- "inheritedFrom": {
32615
- "name": "Input",
32616
- "module": "src/components/input/input.component.ts"
32617
- }
32962
+ "description": "The placeholder text which will be shown on the text if provided.",
32963
+ "fieldName": "placeholder"
32618
32964
  },
32619
32965
  {
32620
- "name": "trailing-button",
32966
+ "name": "readonly",
32621
32967
  "type": {
32622
32968
  "text": "boolean"
32623
32969
  },
32624
32970
  "default": "false",
32625
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
32626
- "fieldName": "trailingButton",
32627
- "inheritedFrom": {
32628
- "name": "Input",
32629
- "module": "src/components/input/input.component.ts"
32630
- }
32971
+ "description": "readonly attribute of the select field. If true, the select is read-only.",
32972
+ "fieldName": "readonly"
32631
32973
  },
32632
32974
  {
32633
- "name": "maxlength",
32975
+ "name": "placement",
32634
32976
  "type": {
32635
- "text": "number | undefined"
32977
+ "text": "Placement"
32636
32978
  },
32637
- "description": "The maximum number of characters that the input field can accept.",
32638
- "fieldName": "maxlength",
32639
- "inheritedFrom": {
32640
- "name": "Input",
32641
- "module": "src/components/input/input.component.ts"
32642
- }
32979
+ "description": "The placeholder text which will be shown on the text if provided.",
32980
+ "fieldName": "placement"
32643
32981
  },
32644
32982
  {
32645
- "name": "minlength",
32983
+ "name": "soft-disabled",
32646
32984
  "type": {
32647
- "text": "number | undefined"
32985
+ "text": "boolean | undefined"
32648
32986
  },
32649
- "description": "The minimum number of characters that the input field can accept.",
32650
- "fieldName": "minlength",
32651
- "inheritedFrom": {
32652
- "name": "Input",
32653
- "module": "src/components/input/input.component.ts"
32654
- }
32987
+ "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
32988
+ "default": "undefined",
32989
+ "fieldName": "softDisabled"
32655
32990
  },
32656
32991
  {
32657
- "name": "autocapitalize",
32992
+ "name": "boundary",
32658
32993
  "type": {
32659
- "text": "AutoCapitalizeType"
32994
+ "text": "'clippingAncestors' | string"
32660
32995
  },
32661
- "description": "The autocapitalize attribute of the input field.",
32662
- "default": "'off'",
32663
- "fieldName": "autocapitalize",
32664
- "inheritedFrom": {
32665
- "name": "Input",
32666
- "module": "src/components/input/input.component.ts"
32667
- }
32996
+ "description": "This describes the clipping element(s) or area that overflow of the used popover will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
32997
+ "default": "'clippingAncestors'",
32998
+ "fieldName": "boundary"
32668
32999
  },
32669
33000
  {
32670
- "name": "autocomplete",
33001
+ "name": "strategy",
32671
33002
  "type": {
32672
- "text": "AutoCompleteType"
33003
+ "text": "'absolute' | 'fixed'"
32673
33004
  },
32674
- "description": "The autocomplete attribute of the input field.",
32675
- "default": "'off'",
32676
- "fieldName": "autocomplete",
32677
- "inheritedFrom": {
32678
- "name": "Input",
32679
- "module": "src/components/input/input.component.ts"
32680
- }
33005
+ "description": "The strategy of the popover within Select.\nThis determines how the popover is positioned in the DOM.\n\nIn case `boundary` is set to something other than 'clippingAncestors',\nit might be necessary to set the `strategy` to 'fixed' to ensure that the popover\nis not getting clipped by scrollable containers enclosing the select.",
33006
+ "default": "absolute",
33007
+ "fieldName": "strategy"
32681
33008
  },
32682
33009
  {
32683
- "name": "autofocus",
33010
+ "name": "popover-z-index",
32684
33011
  "type": {
32685
- "text": "boolean"
33012
+ "text": "number"
32686
33013
  },
32687
- "default": "false",
32688
- "description": "If true, the input field is focused when the component is rendered.",
32689
- "fieldName": "autofocus",
32690
- "inheritedFrom": {
32691
- "name": "Input",
32692
- "module": "src/components/input/input.component.ts"
32693
- }
33014
+ "description": "The z-index of the popover within Select.\n\nOverride this to make sure this stays on top of other components.",
33015
+ "default": "1000",
33016
+ "fieldName": "popoverZIndex"
32694
33017
  },
32695
33018
  {
32696
- "name": "dirname",
33019
+ "name": "backdrop-append-to",
32697
33020
  "type": {
32698
33021
  "text": "string | undefined"
32699
33022
  },
32700
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
32701
- "fieldName": "dirname",
32702
- "inheritedFrom": {
32703
- "name": "Input",
32704
- "module": "src/components/input/input.component.ts"
32705
- }
33023
+ "description": "ID of the element where the backdrop will be appended to.\nThis is useful to ensure that the backdrop is appended to the correct element in the DOM.\nIf not set, the backdrop will be appended to the parent element of the select.",
33024
+ "fieldName": "backdropAppendTo"
32706
33025
  },
32707
33026
  {
32708
- "name": "pattern",
33027
+ "name": "name",
32709
33028
  "type": {
32710
- "text": "string | undefined"
33029
+ "text": "string"
32711
33030
  },
32712
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
32713
- "fieldName": "pattern",
33031
+ "default": "''",
33032
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
33033
+ "fieldName": "name",
32714
33034
  "inheritedFrom": {
32715
- "name": "Input",
32716
- "module": "src/components/input/input.component.ts"
33035
+ "name": "FormInternalsMixin",
33036
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
32717
33037
  }
32718
33038
  },
32719
33039
  {
32720
- "name": "list",
33040
+ "name": "value",
32721
33041
  "type": {
32722
- "text": "string | undefined"
33042
+ "text": "string"
32723
33043
  },
32724
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
32725
- "fieldName": "list",
33044
+ "default": "''",
33045
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
33046
+ "fieldName": "value",
32726
33047
  "inheritedFrom": {
32727
- "name": "Input",
32728
- "module": "src/components/input/input.component.ts"
33048
+ "name": "FormInternalsMixin",
33049
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
32729
33050
  }
32730
33051
  },
32731
33052
  {
32732
- "name": "size",
33053
+ "name": "validation-message",
32733
33054
  "type": {
32734
- "text": "number | undefined | undefined"
33055
+ "text": "string | undefined"
32735
33056
  },
32736
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
32737
- "default": "undefined",
32738
- "fieldName": "size",
33057
+ "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.",
33058
+ "fieldName": "validationMessage",
32739
33059
  "inheritedFrom": {
32740
- "name": "Input",
32741
- "module": "src/components/input/input.component.ts"
33060
+ "name": "FormInternalsMixin",
33061
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
32742
33062
  }
32743
33063
  },
32744
33064
  {
32745
- "name": "clear-aria-label",
33065
+ "name": "data-aria-label",
32746
33066
  "type": {
32747
- "text": "string"
33067
+ "text": "string | null"
32748
33068
  },
32749
- "default": "''",
32750
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
32751
- "fieldName": "clearAriaLabel",
33069
+ "default": "null",
33070
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
33071
+ "fieldName": "dataAriaLabel",
32752
33072
  "inheritedFrom": {
32753
- "name": "Input",
32754
- "module": "src/components/input/input.component.ts"
33073
+ "name": "DataAriaLabelMixin",
33074
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
32755
33075
  }
32756
33076
  },
32757
33077
  {
@@ -32867,322 +33187,22 @@
32867
33187
  }
32868
33188
  }
32869
33189
  ],
32870
- "cssProperties": [
32871
- {
32872
- "description": "Border color for the input container when disabled",
32873
- "name": "--mdc-input-disabled-border-color",
32874
- "inheritedFrom": {
32875
- "name": "Input",
32876
- "module": "src/components/input/input.component.ts"
32877
- }
32878
- },
32879
- {
32880
- "description": "Text color for the input field when disabled",
32881
- "name": "--mdc-input-disabled-text-color",
32882
- "inheritedFrom": {
32883
- "name": "Input",
32884
- "module": "src/components/input/input.component.ts"
32885
- }
32886
- },
32887
- {
32888
- "description": "Background color for the input field when disabled",
32889
- "name": "--mdc-input-disabled-background-color",
32890
- "inheritedFrom": {
32891
- "name": "Input",
32892
- "module": "src/components/input/input.component.ts"
32893
- }
32894
- },
32895
- {
32896
- "description": "Border color for the input container",
32897
- "name": "--mdc-input-border-color",
32898
- "inheritedFrom": {
32899
- "name": "Input",
32900
- "module": "src/components/input/input.component.ts"
32901
- }
32902
- },
32903
- {
32904
- "description": "Text color for the input field",
32905
- "name": "--mdc-input-text-color",
32906
- "inheritedFrom": {
32907
- "name": "Input",
32908
- "module": "src/components/input/input.component.ts"
32909
- }
32910
- },
32911
- {
32912
- "description": "Background color for the input field",
32913
- "name": "--mdc-input-background-color",
32914
- "inheritedFrom": {
32915
- "name": "Input",
32916
- "module": "src/components/input/input.component.ts"
32917
- }
32918
- },
32919
- {
32920
- "description": "Background color for the selected text",
32921
- "name": "--mdc-input-selection-background-color",
32922
- "inheritedFrom": {
32923
- "name": "Input",
32924
- "module": "src/components/input/input.component.ts"
32925
- }
32926
- },
32927
- {
32928
- "description": "Text color for the selected text",
32929
- "name": "--mdc-input-selection-text-color",
32930
- "inheritedFrom": {
32931
- "name": "Input",
32932
- "module": "src/components/input/input.component.ts"
32933
- }
32934
- },
32935
- {
32936
- "description": "Text color for the help text",
32937
- "name": "--mdc-input-support-text-color",
32938
- "inheritedFrom": {
32939
- "name": "Input",
32940
- "module": "src/components/input/input.component.ts"
32941
- }
32942
- },
32943
- {
32944
- "description": "Background color for the input field when hovered",
32945
- "name": "--mdc-input-hover-background-color",
32946
- "inheritedFrom": {
32947
- "name": "Input",
32948
- "module": "src/components/input/input.component.ts"
32949
- }
32950
- },
32951
- {
32952
- "description": "Background color for the input field when focused",
32953
- "name": "--mdc-input-focused-background-color",
32954
- "inheritedFrom": {
32955
- "name": "Input",
32956
- "module": "src/components/input/input.component.ts"
32957
- }
32958
- },
32959
- {
32960
- "description": "Border color for the input container when focused",
32961
- "name": "--mdc-input-focused-border-color",
32962
- "inheritedFrom": {
32963
- "name": "Input",
32964
- "module": "src/components/input/input.component.ts"
32965
- }
32966
- },
32967
- {
32968
- "description": "Border color for the input container when error",
32969
- "name": "--mdc-input-error-border-color",
32970
- "inheritedFrom": {
32971
- "name": "Input",
32972
- "module": "src/components/input/input.component.ts"
32973
- }
32974
- },
32975
- {
32976
- "description": "Border color for the input container when warning",
32977
- "name": "--mdc-input-warning-border-color",
32978
- "inheritedFrom": {
32979
- "name": "Input",
32980
- "module": "src/components/input/input.component.ts"
32981
- }
32982
- },
32983
- {
32984
- "description": "Border color for the input container when success",
32985
- "name": "--mdc-input-success-border-color",
32986
- "inheritedFrom": {
32987
- "name": "Input",
32988
- "module": "src/components/input/input.component.ts"
32989
- }
32990
- },
32991
- {
32992
- "description": "Border color for the input container when primary",
32993
- "name": "--mdc-input-primary-border-color",
32994
- "inheritedFrom": {
32995
- "name": "Input",
32996
- "module": "src/components/input/input.component.ts"
32997
- }
32998
- }
32999
- ]
33000
- }
33001
- ],
33002
- "exports": [
33003
- {
33004
- "kind": "js",
33005
- "name": "default",
33006
- "declaration": {
33007
- "name": "Searchfield",
33008
- "module": "components/searchfield/searchfield.component.js"
33009
- }
33010
- }
33011
- ]
33012
- },
33013
- {
33014
- "kind": "javascript-module",
33015
- "path": "components/sidenavigation/sidenavigation.component.js",
33016
- "declarations": [
33017
- {
33018
- "kind": "class",
33019
- "description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
33020
- "name": "SideNavigation",
33021
- "cssProperties": [
33022
- {
33023
- "description": "width of the sideNavigation when expanded",
33024
- "name": "--mdc-sidenavigation-expanded-width"
33025
- },
33026
- {
33027
- "description": "width of the sideNavigation when collpased",
33028
- "name": "--mdc-sidenavigation-collapsed-width"
33029
- }
33030
- ],
33031
- "slots": [
33032
- {
33033
- "description": "Slot for the scrollable content area of the side navigation.",
33034
- "name": "scrollable-section"
33035
- },
33036
- {
33037
- "description": "Slot for the fixed content area of the side navigation.",
33038
- "name": "fixed-section"
33039
- },
33040
- {
33041
- "description": "Slot for the brand logo (e.g., icon or img).",
33042
- "name": "brand-logo"
33043
- }
33044
- ],
33045
- "members": [
33046
- {
33047
- "kind": "field",
33048
- "name": "Context",
33049
- "privacy": "public",
33050
- "static": true,
33051
- "readonly": true
33052
- },
33053
- {
33054
- "kind": "field",
33055
- "name": "variant",
33056
- "type": {
33057
- "text": "SideNavigationVariant"
33058
- },
33059
- "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
33060
- "default": "flexible",
33061
- "attribute": "variant",
33062
- "reflects": true
33063
- },
33064
- {
33065
- "kind": "field",
33066
- "name": "footerText",
33067
- "type": {
33068
- "text": "string"
33069
- },
33070
- "default": "''",
33071
- "description": "Displays footer text in the bottom section of the sidenavigation.",
33072
- "attribute": "footer-text",
33073
- "reflects": true
33074
- },
33075
- {
33076
- "kind": "field",
33077
- "name": "grabberBtnAriaLabel",
33078
- "type": {
33079
- "text": "string | undefined"
33080
- },
33081
- "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
33082
- "default": "''",
33083
- "attribute": "grabber-btn-aria-label",
33084
- "reflects": true
33085
- },
33086
- {
33087
- "kind": "field",
33088
- "name": "parentNavTooltipText",
33089
- "type": {
33090
- "text": "string | undefined"
33091
- },
33092
- "description": "Tooltip text shown on parent nav items when a child is active.",
33093
- "attribute": "parent-nav-tooltip-text",
33094
- "reflects": true
33095
- },
33096
- {
33097
- "kind": "method",
33098
- "name": "updateContext",
33099
- "privacy": "protected",
33100
- "return": {
33101
- "type": {
33102
- "text": "void"
33103
- }
33104
- },
33105
- "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
33106
- },
33107
- {
33108
- "kind": "field",
33109
- "name": "navMenuItems",
33110
- "type": {
33111
- "text": "NavMenuItem[]"
33112
- },
33113
- "privacy": "private",
33114
- "description": "Returns all nested, non-disabled mdc-navmenuitem elements inside this component.",
33115
- "readonly": true
33116
- },
33117
- {
33118
- "kind": "method",
33119
- "name": "preventScrollOnSpace",
33120
- "privacy": "private",
33121
- "return": {
33122
- "type": {
33123
- "text": "void"
33124
- }
33125
- },
33126
- "parameters": [
33127
- {
33128
- "name": "event",
33129
- "type": {
33130
- "text": "KeyboardEvent"
33131
- }
33132
- }
33133
- ]
33134
- }
33135
- ],
33136
- "events": [
33137
- {
33138
- "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
33139
- "name": "activechange",
33140
- "reactName": "onActiveChange"
33141
- }
33142
- ],
33143
- "attributes": [
33144
- {
33145
- "name": "variant",
33146
- "type": {
33147
- "text": "SideNavigationVariant"
33148
- },
33149
- "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
33150
- "default": "flexible",
33151
- "fieldName": "variant"
33152
- },
33153
- {
33154
- "name": "footer-text",
33155
- "type": {
33156
- "text": "string"
33157
- },
33158
- "default": "''",
33159
- "description": "Displays footer text in the bottom section of the sidenavigation.",
33160
- "fieldName": "footerText"
33161
- },
33190
+ "mixins": [
33162
33191
  {
33163
- "name": "grabber-btn-aria-label",
33164
- "type": {
33165
- "text": "string | undefined"
33166
- },
33167
- "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
33168
- "default": "''",
33169
- "fieldName": "grabberBtnAriaLabel"
33192
+ "name": "FormInternalsMixin",
33193
+ "module": "/src/utils/mixins/FormInternalsMixin"
33170
33194
  },
33171
33195
  {
33172
- "name": "parent-nav-tooltip-text",
33173
- "type": {
33174
- "text": "string | undefined"
33175
- },
33176
- "description": "Tooltip text shown on parent nav items when a child is active.",
33177
- "fieldName": "parentNavTooltipText"
33196
+ "name": "DataAriaLabelMixin",
33197
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
33178
33198
  }
33179
33199
  ],
33180
33200
  "superclass": {
33181
- "name": "Provider",
33182
- "module": "/src/models"
33201
+ "name": "FormfieldWrapper",
33202
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
33183
33203
  },
33184
- "tagName": "mdc-sidenavigation",
33185
- "jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collpased\n */",
33204
+ "tagName": "mdc-select",
33205
+ "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * Every mdc-option should have a `value` attribute set to ensure proper form submission.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * **Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n *\n * @cssproperty --mdc-select-background-color - The background color of the combobox of select.\n * @cssproperty --mdc-select-background-color-hover - The background color of the combobox of select when hovered.\n * @cssproperty --mdc-select-background-color-active - The background color of the combobox of select when active.\n * @cssproperty --mdc-select-background-color-disabled - The background color of the combobox of select when disabled.\n * @cssproperty --mdc-select-text-color - The text color of the select.\n * @cssproperty --mdc-select-text-color-selected - The text color of the selected option in the select.\n * @cssproperty --mdc-select-text-color-disabled - The text color of the select when disabled.\n * @cssproperty --mdc-select-border-color - The border color of the select.\n * @cssproperty --mdc-select-border-color-disabled - The border color of the select when disabled.\n * @cssproperty --mdc-select-border-color-success - The border color of the select when in success state.\n * @cssproperty --mdc-select-border-color-warning - The border color of the select when in warning state.\n * @cssproperty --mdc-select-border-color-error - The border color of the select when in error state.\n * @cssproperty --mdc-select-width - The width of the select.\n * @cssproperty --mdc-select-listbox-height - The height of the listbox inside the select.\n * @cssproperty --mdc-select-listbox-width - The width of the listbox inside the select (default: `--mdc-select-width`).\n */",
33186
33206
  "customElement": true
33187
33207
  }
33188
33208
  ],
@@ -33191,8 +33211,8 @@
33191
33211
  "kind": "js",
33192
33212
  "name": "default",
33193
33213
  "declaration": {
33194
- "name": "SideNavigation",
33195
- "module": "components/sidenavigation/sidenavigation.component.js"
33214
+ "name": "Select",
33215
+ "module": "components/select/select.component.js"
33196
33216
  }
33197
33217
  }
33198
33218
  ]
@@ -33279,6 +33299,193 @@
33279
33299
  }
33280
33300
  ]
33281
33301
  },
33302
+ {
33303
+ "kind": "javascript-module",
33304
+ "path": "components/sidenavigation/sidenavigation.component.js",
33305
+ "declarations": [
33306
+ {
33307
+ "kind": "class",
33308
+ "description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
33309
+ "name": "SideNavigation",
33310
+ "cssProperties": [
33311
+ {
33312
+ "description": "width of the sideNavigation when expanded",
33313
+ "name": "--mdc-sidenavigation-expanded-width"
33314
+ },
33315
+ {
33316
+ "description": "width of the sideNavigation when collpased",
33317
+ "name": "--mdc-sidenavigation-collapsed-width"
33318
+ }
33319
+ ],
33320
+ "slots": [
33321
+ {
33322
+ "description": "Slot for the scrollable content area of the side navigation.",
33323
+ "name": "scrollable-section"
33324
+ },
33325
+ {
33326
+ "description": "Slot for the fixed content area of the side navigation.",
33327
+ "name": "fixed-section"
33328
+ },
33329
+ {
33330
+ "description": "Slot for the brand logo (e.g., icon or img).",
33331
+ "name": "brand-logo"
33332
+ }
33333
+ ],
33334
+ "members": [
33335
+ {
33336
+ "kind": "field",
33337
+ "name": "Context",
33338
+ "privacy": "public",
33339
+ "static": true,
33340
+ "readonly": true
33341
+ },
33342
+ {
33343
+ "kind": "field",
33344
+ "name": "variant",
33345
+ "type": {
33346
+ "text": "SideNavigationVariant"
33347
+ },
33348
+ "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
33349
+ "default": "flexible",
33350
+ "attribute": "variant",
33351
+ "reflects": true
33352
+ },
33353
+ {
33354
+ "kind": "field",
33355
+ "name": "footerText",
33356
+ "type": {
33357
+ "text": "string"
33358
+ },
33359
+ "default": "''",
33360
+ "description": "Displays footer text in the bottom section of the sidenavigation.",
33361
+ "attribute": "footer-text",
33362
+ "reflects": true
33363
+ },
33364
+ {
33365
+ "kind": "field",
33366
+ "name": "grabberBtnAriaLabel",
33367
+ "type": {
33368
+ "text": "string | undefined"
33369
+ },
33370
+ "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
33371
+ "default": "''",
33372
+ "attribute": "grabber-btn-aria-label",
33373
+ "reflects": true
33374
+ },
33375
+ {
33376
+ "kind": "field",
33377
+ "name": "parentNavTooltipText",
33378
+ "type": {
33379
+ "text": "string | undefined"
33380
+ },
33381
+ "description": "Tooltip text shown on parent nav items when a child is active.",
33382
+ "attribute": "parent-nav-tooltip-text",
33383
+ "reflects": true
33384
+ },
33385
+ {
33386
+ "kind": "method",
33387
+ "name": "updateContext",
33388
+ "privacy": "protected",
33389
+ "return": {
33390
+ "type": {
33391
+ "text": "void"
33392
+ }
33393
+ },
33394
+ "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
33395
+ },
33396
+ {
33397
+ "kind": "field",
33398
+ "name": "navMenuItems",
33399
+ "type": {
33400
+ "text": "NavMenuItem[]"
33401
+ },
33402
+ "privacy": "private",
33403
+ "description": "Returns all nested, non-disabled mdc-navmenuitem elements inside this component.",
33404
+ "readonly": true
33405
+ },
33406
+ {
33407
+ "kind": "method",
33408
+ "name": "preventScrollOnSpace",
33409
+ "privacy": "private",
33410
+ "return": {
33411
+ "type": {
33412
+ "text": "void"
33413
+ }
33414
+ },
33415
+ "parameters": [
33416
+ {
33417
+ "name": "event",
33418
+ "type": {
33419
+ "text": "KeyboardEvent"
33420
+ }
33421
+ }
33422
+ ]
33423
+ }
33424
+ ],
33425
+ "events": [
33426
+ {
33427
+ "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
33428
+ "name": "activechange",
33429
+ "reactName": "onActiveChange"
33430
+ }
33431
+ ],
33432
+ "attributes": [
33433
+ {
33434
+ "name": "variant",
33435
+ "type": {
33436
+ "text": "SideNavigationVariant"
33437
+ },
33438
+ "description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
33439
+ "default": "flexible",
33440
+ "fieldName": "variant"
33441
+ },
33442
+ {
33443
+ "name": "footer-text",
33444
+ "type": {
33445
+ "text": "string"
33446
+ },
33447
+ "default": "''",
33448
+ "description": "Displays footer text in the bottom section of the sidenavigation.",
33449
+ "fieldName": "footerText"
33450
+ },
33451
+ {
33452
+ "name": "grabber-btn-aria-label",
33453
+ "type": {
33454
+ "text": "string | undefined"
33455
+ },
33456
+ "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
33457
+ "default": "''",
33458
+ "fieldName": "grabberBtnAriaLabel"
33459
+ },
33460
+ {
33461
+ "name": "parent-nav-tooltip-text",
33462
+ "type": {
33463
+ "text": "string | undefined"
33464
+ },
33465
+ "description": "Tooltip text shown on parent nav items when a child is active.",
33466
+ "fieldName": "parentNavTooltipText"
33467
+ }
33468
+ ],
33469
+ "superclass": {
33470
+ "name": "Provider",
33471
+ "module": "/src/models"
33472
+ },
33473
+ "tagName": "mdc-sidenavigation",
33474
+ "jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collpased\n */",
33475
+ "customElement": true
33476
+ }
33477
+ ],
33478
+ "exports": [
33479
+ {
33480
+ "kind": "js",
33481
+ "name": "default",
33482
+ "declaration": {
33483
+ "name": "SideNavigation",
33484
+ "module": "components/sidenavigation/sidenavigation.component.js"
33485
+ }
33486
+ }
33487
+ ]
33488
+ },
33282
33489
  {
33283
33490
  "kind": "javascript-module",
33284
33491
  "path": "components/spinner/spinner.component.js",
@@ -33420,52 +33627,48 @@
33420
33627
  },
33421
33628
  {
33422
33629
  "kind": "javascript-module",
33423
- "path": "components/staticradio/staticradio.component.js",
33630
+ "path": "components/staticcheckbox/staticcheckbox.component.js",
33424
33631
  "declarations": [
33425
33632
  {
33426
33633
  "kind": "class",
33427
- "description": "This is a decorative component that is styled to look as a radio.\nIt has 2 properties - checked and disabled.\n\nWe are using the same styling that has been created for the `mdc-radio` component.",
33428
- "name": "StaticRadio",
33634
+ "description": "This is a decorative component that is styled to look as a checkbox.\n\nIt has 3 properties - checked, indeterminate and disabled.\n\nWe are using the same styling that has been created for the `mdc-checkbox` component.",
33635
+ "name": "StaticCheckbox",
33429
33636
  "cssProperties": [
33430
33637
  {
33431
- "description": "size of the inner circle",
33432
- "name": "--mdc-staticradio-inner-circle-size"
33433
- },
33434
- {
33435
- "description": "color of the label when disabled",
33436
- "name": "--mdc-staticradio-text-disabled-color"
33638
+ "description": "Border color in high contrast.",
33639
+ "name": "--mdc-staticcheckbox-border-color"
33437
33640
  },
33438
33641
  {
33439
- "description": "color of the radio button border when normal",
33440
- "name": "--mdc-staticradio-normal-border-color"
33642
+ "description": "Background color for a selected checkbox.",
33643
+ "name": "--mdc-staticcheckbox-checked-background-color"
33441
33644
  },
33442
33645
  {
33443
- "description": "color of the radio button border when disabled",
33444
- "name": "--mdc-staticradio-disabled-border-color"
33646
+ "description": "Background color for a disabled checkbox.",
33647
+ "name": "--mdc-staticcheckbox-disabled-background-color"
33445
33648
  },
33446
33649
  {
33447
- "description": "background color of the inner circle when normal",
33448
- "name": "--mdc-staticradio-inner-circle-normal-background"
33650
+ "description": "Border color for a disabled checkbox.",
33651
+ "name": "--mdc-checkbox-disabled-border-color"
33449
33652
  },
33450
33653
  {
33451
- "description": "background color of the inner circle when disabled",
33452
- "name": "--mdc-staticradio-inner-circle-disabled-background"
33654
+ "description": "Background color for a disabled, selected checkbox.",
33655
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
33453
33656
  },
33454
33657
  {
33455
- "description": "color of the radio button when inactive",
33456
- "name": "--mdc-staticradio-control-inactive-color"
33658
+ "description": "Icon color for a disabled checkbox.",
33659
+ "name": "--mdc-staticcheckbox-disabled-icon-color"
33457
33660
  },
33458
33661
  {
33459
- "description": "background color of the radio button when inactive and disabled",
33460
- "name": "--mdc-staticradio-control-inactive-disabled-background"
33662
+ "description": "Background color for an unselected checkbox.",
33663
+ "name": "--mdc-staticcheckbox-icon-background-color"
33461
33664
  },
33462
33665
  {
33463
- "description": "color of the radio button when active",
33464
- "name": "--mdc-staticradio-control-active-color"
33666
+ "description": "Default background color for an unselected checkbox.",
33667
+ "name": "--mdc-staticcheckbox-icon-border-color"
33465
33668
  },
33466
33669
  {
33467
- "description": "background color of the radio button when active and disabled",
33468
- "name": "--mdc-staticradio-control-active-disabled-background"
33670
+ "description": "Icon color for an unselected checkbox.",
33671
+ "name": "--mdc-staticcheckbox-icon-color"
33469
33672
  }
33470
33673
  ],
33471
33674
  "members": [
@@ -33476,19 +33679,19 @@
33476
33679
  "text": "boolean"
33477
33680
  },
33478
33681
  "default": "false",
33479
- "description": "Determines whether the radio is selected or unselected.",
33682
+ "description": "Determines whether the checkbox is selected or unselected.",
33480
33683
  "attribute": "checked",
33481
33684
  "reflects": true
33482
33685
  },
33483
33686
  {
33484
33687
  "kind": "field",
33485
- "name": "readonly",
33688
+ "name": "indeterminate",
33486
33689
  "type": {
33487
33690
  "text": "boolean"
33488
33691
  },
33489
33692
  "default": "false",
33490
- "description": "Determines whether the radio is read-only.",
33491
- "attribute": "readonly",
33693
+ "description": "Determines whether the checkbox is in an indeterminate state.",
33694
+ "attribute": "indeterminate",
33492
33695
  "reflects": true
33493
33696
  },
33494
33697
  {
@@ -33514,17 +33717,17 @@
33514
33717
  "text": "boolean"
33515
33718
  },
33516
33719
  "default": "false",
33517
- "description": "Determines whether the radio is selected or unselected.",
33720
+ "description": "Determines whether the checkbox is selected or unselected.",
33518
33721
  "fieldName": "checked"
33519
33722
  },
33520
33723
  {
33521
- "name": "readonly",
33724
+ "name": "indeterminate",
33522
33725
  "type": {
33523
33726
  "text": "boolean"
33524
33727
  },
33525
33728
  "default": "false",
33526
- "description": "Determines whether the radio is read-only.",
33527
- "fieldName": "readonly"
33729
+ "description": "Determines whether the checkbox is in an indeterminate state.",
33730
+ "fieldName": "indeterminate"
33528
33731
  },
33529
33732
  {
33530
33733
  "name": "disabled",
@@ -33550,8 +33753,8 @@
33550
33753
  "name": "Component",
33551
33754
  "module": "/src/models"
33552
33755
  },
33553
- "tagName": "mdc-staticradio",
33554
- "jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 2 properties - checked and disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n */",
33756
+ "tagName": "mdc-staticcheckbox",
33757
+ "jsDoc": "/**\n * This is a decorative component that is styled to look as a checkbox.\n *\n * It has 3 properties - checked, indeterminate and disabled.\n *\n * We are using the same styling that has been created for the `mdc-checkbox` component.\n *\n * @tagname mdc-staticcheckbox\n *\n * @dependency mdc-icon\n *\n * @cssproperty --mdc-staticcheckbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-staticcheckbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-color - Icon color for an unselected checkbox.\n *\n */",
33555
33758
  "customElement": true
33556
33759
  }
33557
33760
  ],
@@ -33560,56 +33763,60 @@
33560
33763
  "kind": "js",
33561
33764
  "name": "default",
33562
33765
  "declaration": {
33563
- "name": "StaticRadio",
33564
- "module": "components/staticradio/staticradio.component.js"
33766
+ "name": "StaticCheckbox",
33767
+ "module": "components/staticcheckbox/staticcheckbox.component.js"
33565
33768
  }
33566
33769
  }
33567
33770
  ]
33568
33771
  },
33569
33772
  {
33570
33773
  "kind": "javascript-module",
33571
- "path": "components/staticcheckbox/staticcheckbox.component.js",
33774
+ "path": "components/staticradio/staticradio.component.js",
33572
33775
  "declarations": [
33573
33776
  {
33574
33777
  "kind": "class",
33575
- "description": "This is a decorative component that is styled to look as a checkbox.\n\nIt has 3 properties - checked, indeterminate and disabled.\n\nWe are using the same styling that has been created for the `mdc-checkbox` component.",
33576
- "name": "StaticCheckbox",
33778
+ "description": "This is a decorative component that is styled to look as a radio.\nIt has 2 properties - checked and disabled.\n\nWe are using the same styling that has been created for the `mdc-radio` component.",
33779
+ "name": "StaticRadio",
33577
33780
  "cssProperties": [
33578
33781
  {
33579
- "description": "Border color in high contrast.",
33580
- "name": "--mdc-staticcheckbox-border-color"
33782
+ "description": "size of the inner circle",
33783
+ "name": "--mdc-staticradio-inner-circle-size"
33581
33784
  },
33582
33785
  {
33583
- "description": "Background color for a selected checkbox.",
33584
- "name": "--mdc-staticcheckbox-checked-background-color"
33786
+ "description": "color of the label when disabled",
33787
+ "name": "--mdc-staticradio-text-disabled-color"
33585
33788
  },
33586
33789
  {
33587
- "description": "Background color for a disabled checkbox.",
33588
- "name": "--mdc-staticcheckbox-disabled-background-color"
33790
+ "description": "color of the radio button border when normal",
33791
+ "name": "--mdc-staticradio-normal-border-color"
33589
33792
  },
33590
33793
  {
33591
- "description": "Border color for a disabled checkbox.",
33592
- "name": "--mdc-checkbox-disabled-border-color"
33794
+ "description": "color of the radio button border when disabled",
33795
+ "name": "--mdc-staticradio-disabled-border-color"
33593
33796
  },
33594
33797
  {
33595
- "description": "Background color for a disabled, selected checkbox.",
33596
- "name": "--mdc-checkbox-disabled-checked-icon-color"
33798
+ "description": "background color of the inner circle when normal",
33799
+ "name": "--mdc-staticradio-inner-circle-normal-background"
33597
33800
  },
33598
33801
  {
33599
- "description": "Icon color for a disabled checkbox.",
33600
- "name": "--mdc-staticcheckbox-disabled-icon-color"
33802
+ "description": "background color of the inner circle when disabled",
33803
+ "name": "--mdc-staticradio-inner-circle-disabled-background"
33601
33804
  },
33602
33805
  {
33603
- "description": "Background color for an unselected checkbox.",
33604
- "name": "--mdc-staticcheckbox-icon-background-color"
33806
+ "description": "color of the radio button when inactive",
33807
+ "name": "--mdc-staticradio-control-inactive-color"
33605
33808
  },
33606
33809
  {
33607
- "description": "Default background color for an unselected checkbox.",
33608
- "name": "--mdc-staticcheckbox-icon-border-color"
33810
+ "description": "background color of the radio button when inactive and disabled",
33811
+ "name": "--mdc-staticradio-control-inactive-disabled-background"
33609
33812
  },
33610
33813
  {
33611
- "description": "Icon color for an unselected checkbox.",
33612
- "name": "--mdc-staticcheckbox-icon-color"
33814
+ "description": "color of the radio button when active",
33815
+ "name": "--mdc-staticradio-control-active-color"
33816
+ },
33817
+ {
33818
+ "description": "background color of the radio button when active and disabled",
33819
+ "name": "--mdc-staticradio-control-active-disabled-background"
33613
33820
  }
33614
33821
  ],
33615
33822
  "members": [
@@ -33620,19 +33827,19 @@
33620
33827
  "text": "boolean"
33621
33828
  },
33622
33829
  "default": "false",
33623
- "description": "Determines whether the checkbox is selected or unselected.",
33830
+ "description": "Determines whether the radio is selected or unselected.",
33624
33831
  "attribute": "checked",
33625
33832
  "reflects": true
33626
33833
  },
33627
33834
  {
33628
33835
  "kind": "field",
33629
- "name": "indeterminate",
33836
+ "name": "readonly",
33630
33837
  "type": {
33631
33838
  "text": "boolean"
33632
33839
  },
33633
33840
  "default": "false",
33634
- "description": "Determines whether the checkbox is in an indeterminate state.",
33635
- "attribute": "indeterminate",
33841
+ "description": "Determines whether the radio is read-only.",
33842
+ "attribute": "readonly",
33636
33843
  "reflects": true
33637
33844
  },
33638
33845
  {
@@ -33658,17 +33865,17 @@
33658
33865
  "text": "boolean"
33659
33866
  },
33660
33867
  "default": "false",
33661
- "description": "Determines whether the checkbox is selected or unselected.",
33868
+ "description": "Determines whether the radio is selected or unselected.",
33662
33869
  "fieldName": "checked"
33663
33870
  },
33664
33871
  {
33665
- "name": "indeterminate",
33872
+ "name": "readonly",
33666
33873
  "type": {
33667
33874
  "text": "boolean"
33668
33875
  },
33669
33876
  "default": "false",
33670
- "description": "Determines whether the checkbox is in an indeterminate state.",
33671
- "fieldName": "indeterminate"
33877
+ "description": "Determines whether the radio is read-only.",
33878
+ "fieldName": "readonly"
33672
33879
  },
33673
33880
  {
33674
33881
  "name": "disabled",
@@ -33694,8 +33901,8 @@
33694
33901
  "name": "Component",
33695
33902
  "module": "/src/models"
33696
33903
  },
33697
- "tagName": "mdc-staticcheckbox",
33698
- "jsDoc": "/**\n * This is a decorative component that is styled to look as a checkbox.\n *\n * It has 3 properties - checked, indeterminate and disabled.\n *\n * We are using the same styling that has been created for the `mdc-checkbox` component.\n *\n * @tagname mdc-staticcheckbox\n *\n * @dependency mdc-icon\n *\n * @cssproperty --mdc-staticcheckbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-staticcheckbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-color - Icon color for an unselected checkbox.\n *\n */",
33904
+ "tagName": "mdc-staticradio",
33905
+ "jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 2 properties - checked and disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n */",
33699
33906
  "customElement": true
33700
33907
  }
33701
33908
  ],
@@ -33704,8 +33911,8 @@
33704
33911
  "kind": "js",
33705
33912
  "name": "default",
33706
33913
  "declaration": {
33707
- "name": "StaticCheckbox",
33708
- "module": "components/staticcheckbox/staticcheckbox.component.js"
33914
+ "name": "StaticRadio",
33915
+ "module": "components/staticradio/staticradio.component.js"
33709
33916
  }
33710
33917
  }
33711
33918
  ]
@@ -37675,6 +37882,21 @@
37675
37882
  },
37676
37883
  "description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
37677
37884
  },
37885
+ {
37886
+ "kind": "field",
37887
+ "name": "zIndex",
37888
+ "type": {
37889
+ "text": "number"
37890
+ },
37891
+ "description": "IMPLEMENT THIS IN YOUR COMPONENT.\n\nThe z-index of the component where the backdrop will be attached to.\nThe backdrop itself will have a z-index of `zIndex - 1`.",
37892
+ "default": "1000",
37893
+ "attribute": "z-index",
37894
+ "reflects": true,
37895
+ "inheritedFrom": {
37896
+ "name": "Popover",
37897
+ "module": "components/popover/popover.component.js"
37898
+ }
37899
+ },
37678
37900
  {
37679
37901
  "kind": "field",
37680
37902
  "name": "preventScroll",
@@ -38508,13 +38730,13 @@
38508
38730
  },
38509
38731
  {
38510
38732
  "kind": "field",
38511
- "name": "flip",
38733
+ "name": "backdropAppendTo",
38512
38734
  "type": {
38513
- "text": "boolean"
38735
+ "text": "string | undefined"
38514
38736
  },
38515
- "description": "Changes the placement of popover to keep it in view when scrolling.",
38516
- "default": "true",
38517
- "attribute": "flip",
38737
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
38738
+ "default": "''",
38739
+ "attribute": "backdrop-append-to",
38518
38740
  "reflects": true,
38519
38741
  "inheritedFrom": {
38520
38742
  "name": "Popover",
@@ -38523,13 +38745,13 @@
38523
38745
  },
38524
38746
  {
38525
38747
  "kind": "field",
38526
- "name": "size",
38748
+ "name": "isBackdropInvisible",
38527
38749
  "type": {
38528
- "text": "boolean"
38750
+ "text": "boolean | undefined"
38529
38751
  },
38530
- "description": "Changes the size of popover to keep it in view when scrolling.",
38752
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
38531
38753
  "default": "false",
38532
- "attribute": "size",
38754
+ "attribute": "is-backdrop-invisible",
38533
38755
  "reflects": true,
38534
38756
  "inheritedFrom": {
38535
38757
  "name": "Popover",
@@ -38538,13 +38760,28 @@
38538
38760
  },
38539
38761
  {
38540
38762
  "kind": "field",
38541
- "name": "zIndex",
38763
+ "name": "flip",
38542
38764
  "type": {
38543
- "text": "number"
38765
+ "text": "boolean"
38544
38766
  },
38545
- "description": "The z-index of the popover.",
38546
- "default": "1000",
38547
- "attribute": "z-index",
38767
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
38768
+ "default": "true",
38769
+ "attribute": "flip",
38770
+ "reflects": true,
38771
+ "inheritedFrom": {
38772
+ "name": "Popover",
38773
+ "module": "components/popover/popover.component.js"
38774
+ }
38775
+ },
38776
+ {
38777
+ "kind": "field",
38778
+ "name": "size",
38779
+ "type": {
38780
+ "text": "boolean"
38781
+ },
38782
+ "description": "Changes the size of popover to keep it in view when scrolling.",
38783
+ "default": "false",
38784
+ "attribute": "size",
38548
38785
  "reflects": true,
38549
38786
  "inheritedFrom": {
38550
38787
  "name": "Popover",
@@ -39314,6 +39551,32 @@
39314
39551
  "module": "src/components/popover/popover.component.ts"
39315
39552
  }
39316
39553
  },
39554
+ {
39555
+ "name": "backdrop-append-to",
39556
+ "type": {
39557
+ "text": "string | undefined"
39558
+ },
39559
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
39560
+ "default": "''",
39561
+ "fieldName": "backdropAppendTo",
39562
+ "inheritedFrom": {
39563
+ "name": "Popover",
39564
+ "module": "src/components/popover/popover.component.ts"
39565
+ }
39566
+ },
39567
+ {
39568
+ "name": "is-backdrop-invisible",
39569
+ "type": {
39570
+ "text": "boolean | undefined"
39571
+ },
39572
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
39573
+ "default": "false",
39574
+ "fieldName": "isBackdropInvisible",
39575
+ "inheritedFrom": {
39576
+ "name": "Popover",
39577
+ "module": "src/components/popover/popover.component.ts"
39578
+ }
39579
+ },
39317
39580
  {
39318
39581
  "name": "flip",
39319
39582
  "type": {
@@ -39688,6 +39951,21 @@
39688
39951
  ],
39689
39952
  "description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
39690
39953
  },
39954
+ {
39955
+ "kind": "field",
39956
+ "name": "zIndex",
39957
+ "type": {
39958
+ "text": "number"
39959
+ },
39960
+ "description": "IMPLEMENT THIS IN YOUR COMPONENT.\n\nThe z-index of the component where the backdrop will be attached to.\nThe backdrop itself will have a z-index of `zIndex - 1`.",
39961
+ "default": "1000",
39962
+ "attribute": "z-index",
39963
+ "reflects": true,
39964
+ "inheritedFrom": {
39965
+ "name": "Popover",
39966
+ "module": "components/popover/popover.component.js"
39967
+ }
39968
+ },
39691
39969
  {
39692
39970
  "kind": "field",
39693
39971
  "name": "preventScroll",
@@ -40536,13 +40814,13 @@
40536
40814
  },
40537
40815
  {
40538
40816
  "kind": "field",
40539
- "name": "flip",
40817
+ "name": "backdropAppendTo",
40540
40818
  "type": {
40541
- "text": "boolean"
40819
+ "text": "string | undefined"
40542
40820
  },
40543
- "description": "Changes the placement of popover to keep it in view when scrolling.",
40544
- "default": "true",
40545
- "attribute": "flip",
40821
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
40822
+ "default": "''",
40823
+ "attribute": "backdrop-append-to",
40546
40824
  "reflects": true,
40547
40825
  "inheritedFrom": {
40548
40826
  "name": "Popover",
@@ -40551,13 +40829,13 @@
40551
40829
  },
40552
40830
  {
40553
40831
  "kind": "field",
40554
- "name": "size",
40832
+ "name": "isBackdropInvisible",
40555
40833
  "type": {
40556
- "text": "boolean"
40834
+ "text": "boolean | undefined"
40557
40835
  },
40558
- "description": "Changes the size of popover to keep it in view when scrolling.",
40836
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
40559
40837
  "default": "false",
40560
- "attribute": "size",
40838
+ "attribute": "is-backdrop-invisible",
40561
40839
  "reflects": true,
40562
40840
  "inheritedFrom": {
40563
40841
  "name": "Popover",
@@ -40566,13 +40844,28 @@
40566
40844
  },
40567
40845
  {
40568
40846
  "kind": "field",
40569
- "name": "zIndex",
40847
+ "name": "flip",
40570
40848
  "type": {
40571
- "text": "number"
40849
+ "text": "boolean"
40572
40850
  },
40573
- "description": "The z-index of the popover.",
40574
- "default": "1000",
40575
- "attribute": "z-index",
40851
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
40852
+ "default": "true",
40853
+ "attribute": "flip",
40854
+ "reflects": true,
40855
+ "inheritedFrom": {
40856
+ "name": "Popover",
40857
+ "module": "components/popover/popover.component.js"
40858
+ }
40859
+ },
40860
+ {
40861
+ "kind": "field",
40862
+ "name": "size",
40863
+ "type": {
40864
+ "text": "boolean"
40865
+ },
40866
+ "description": "Changes the size of popover to keep it in view when scrolling.",
40867
+ "default": "false",
40868
+ "attribute": "size",
40576
40869
  "reflects": true,
40577
40870
  "inheritedFrom": {
40578
40871
  "name": "Popover",
@@ -41343,6 +41636,32 @@
41343
41636
  "module": "src/components/popover/popover.component.ts"
41344
41637
  }
41345
41638
  },
41639
+ {
41640
+ "name": "backdrop-append-to",
41641
+ "type": {
41642
+ "text": "string | undefined"
41643
+ },
41644
+ "description": "Element ID the backdrop will be a append to (if `backdrop` is true).",
41645
+ "default": "''",
41646
+ "fieldName": "backdropAppendTo",
41647
+ "inheritedFrom": {
41648
+ "name": "Popover",
41649
+ "module": "src/components/popover/popover.component.ts"
41650
+ }
41651
+ },
41652
+ {
41653
+ "name": "is-backdrop-invisible",
41654
+ "type": {
41655
+ "text": "boolean | undefined"
41656
+ },
41657
+ "description": "Set this property to true to make the backdrop invisible (if `backdrop` is true).\nThis is useful for components that do want a backdrop which stops interaction,\nbut do not want the backdrop to be visible as a overlay.",
41658
+ "default": "false",
41659
+ "fieldName": "isBackdropInvisible",
41660
+ "inheritedFrom": {
41661
+ "name": "Popover",
41662
+ "module": "src/components/popover/popover.component.ts"
41663
+ }
41664
+ },
41346
41665
  {
41347
41666
  "name": "flip",
41348
41667
  "type": {
@@ -42192,6 +42511,157 @@
42192
42511
  }
42193
42512
  ]
42194
42513
  },
42514
+ {
42515
+ "kind": "javascript-module",
42516
+ "path": "utils/mixins/BackdropMixin.js",
42517
+ "declarations": [
42518
+ {
42519
+ "kind": "class",
42520
+ "description": "",
42521
+ "name": "BackdropMixinInterface",
42522
+ "members": [
42523
+ {
42524
+ "kind": "field",
42525
+ "name": "zIndex",
42526
+ "type": {
42527
+ "text": "number"
42528
+ }
42529
+ },
42530
+ {
42531
+ "kind": "field",
42532
+ "name": "backdropElement",
42533
+ "type": {
42534
+ "text": "HTMLElement | null"
42535
+ },
42536
+ "privacy": "protected"
42537
+ },
42538
+ {
42539
+ "kind": "field",
42540
+ "name": "isBackdropInvisible",
42541
+ "type": {
42542
+ "text": "boolean | undefined"
42543
+ },
42544
+ "privacy": "protected"
42545
+ },
42546
+ {
42547
+ "kind": "field",
42548
+ "name": "backdropAppendTo",
42549
+ "type": {
42550
+ "text": "string | undefined"
42551
+ },
42552
+ "privacy": "protected"
42553
+ },
42554
+ {
42555
+ "kind": "method",
42556
+ "name": "createBackdrop",
42557
+ "privacy": "protected",
42558
+ "return": {
42559
+ "type": {
42560
+ "text": "void"
42561
+ }
42562
+ },
42563
+ "parameters": [
42564
+ {
42565
+ "name": "classNamePrefix",
42566
+ "type": {
42567
+ "text": "string"
42568
+ }
42569
+ }
42570
+ ]
42571
+ },
42572
+ {
42573
+ "kind": "method",
42574
+ "name": "removeBackdrop",
42575
+ "privacy": "protected",
42576
+ "return": {
42577
+ "type": {
42578
+ "text": "void"
42579
+ }
42580
+ }
42581
+ },
42582
+ {
42583
+ "kind": "method",
42584
+ "name": "keepElementAboveBackdrop",
42585
+ "privacy": "protected",
42586
+ "return": {
42587
+ "type": {
42588
+ "text": "void"
42589
+ }
42590
+ },
42591
+ "parameters": [
42592
+ {
42593
+ "name": "element",
42594
+ "optional": true,
42595
+ "type": {
42596
+ "text": "HTMLElement | null"
42597
+ }
42598
+ }
42599
+ ]
42600
+ },
42601
+ {
42602
+ "kind": "method",
42603
+ "name": "moveElementBackAfterBackdropRemoval",
42604
+ "privacy": "protected",
42605
+ "return": {
42606
+ "type": {
42607
+ "text": "void"
42608
+ }
42609
+ },
42610
+ "parameters": [
42611
+ {
42612
+ "name": "element",
42613
+ "optional": true,
42614
+ "type": {
42615
+ "text": "HTMLElement | null"
42616
+ }
42617
+ }
42618
+ ]
42619
+ }
42620
+ ]
42621
+ },
42622
+ {
42623
+ "kind": "mixin",
42624
+ "description": "",
42625
+ "name": "BackdropMixin",
42626
+ "members": [
42627
+ {
42628
+ "kind": "field",
42629
+ "name": "zIndex",
42630
+ "type": {
42631
+ "text": "number"
42632
+ },
42633
+ "description": "IMPLEMENT THIS IN YOUR COMPONENT.\n\nThe z-index of the component where the backdrop will be attached to.\nThe backdrop itself will have a z-index of `zIndex - 1`."
42634
+ }
42635
+ ],
42636
+ "parameters": [
42637
+ {
42638
+ "name": "superClass",
42639
+ "type": {
42640
+ "text": "T"
42641
+ }
42642
+ }
42643
+ ]
42644
+ }
42645
+ ],
42646
+ "exports": [
42647
+ {
42648
+ "kind": "js",
42649
+ "name": "BackdropMixinInterface",
42650
+ "declaration": {
42651
+ "name": "BackdropMixinInterface",
42652
+ "module": "utils/mixins/BackdropMixin.js"
42653
+ }
42654
+ },
42655
+ {
42656
+ "kind": "js",
42657
+ "name": "BackdropMixin",
42658
+ "declaration": {
42659
+ "name": "BackdropMixin",
42660
+ "module": "utils/mixins/BackdropMixin.js"
42661
+ }
42662
+ }
42663
+ ]
42664
+ },
42195
42665
  {
42196
42666
  "kind": "javascript-module",
42197
42667
  "path": "utils/mixins/ButtonComponentMixin.js",