@momentum-design/components 0.102.7 → 0.102.8

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.
@@ -17787,15 +17787,15 @@
17787
17787
  },
17788
17788
  {
17789
17789
  "kind": "javascript-module",
17790
- "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
17790
+ "path": "components/menuitem/menuitem.component.js",
17791
17791
  "declarations": [
17792
17792
  {
17793
17793
  "kind": "class",
17794
- "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
17795
- "name": "MenuItemCheckbox",
17794
+ "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
17795
+ "name": "MenuItem",
17796
17796
  "slots": [
17797
17797
  {
17798
- "description": "slot for menu item checkbox controls to appear of leading end.",
17798
+ "description": "slot for menu item controls to appear of leading end.",
17799
17799
  "name": "leading-controls",
17800
17800
  "inheritedFrom": {
17801
17801
  "name": "ListItem",
@@ -17803,7 +17803,7 @@
17803
17803
  }
17804
17804
  },
17805
17805
  {
17806
- "description": "slot for menu item checkbox primary label.",
17806
+ "description": "slot for menu item primary label.",
17807
17807
  "name": "leading-text-primary-label",
17808
17808
  "inheritedFrom": {
17809
17809
  "name": "ListItem",
@@ -17811,7 +17811,7 @@
17811
17811
  }
17812
17812
  },
17813
17813
  {
17814
- "description": "slot for menu item checkbox secondary label.",
17814
+ "description": "slot for menu item secondary label.",
17815
17815
  "name": "leading-text-secondary-label",
17816
17816
  "inheritedFrom": {
17817
17817
  "name": "ListItem",
@@ -17819,7 +17819,7 @@
17819
17819
  }
17820
17820
  },
17821
17821
  {
17822
- "description": "slot for menu item checkbox tertiary label.",
17822
+ "description": "slot for menu item tertiary label.",
17823
17823
  "name": "leading-text-tertiary-label",
17824
17824
  "inheritedFrom": {
17825
17825
  "name": "ListItem",
@@ -17827,7 +17827,7 @@
17827
17827
  }
17828
17828
  },
17829
17829
  {
17830
- "description": "slot for menu item checkbox side header text.",
17830
+ "description": "slot for menu item side header text.",
17831
17831
  "name": "trailing-text-side-header",
17832
17832
  "inheritedFrom": {
17833
17833
  "name": "ListItem",
@@ -17835,7 +17835,7 @@
17835
17835
  }
17836
17836
  },
17837
17837
  {
17838
- "description": "slot for menu item checkbox subline text.",
17838
+ "description": "slot for menu item subline text.",
17839
17839
  "name": "trailing-text-subline",
17840
17840
  "inheritedFrom": {
17841
17841
  "name": "ListItem",
@@ -17843,7 +17843,7 @@
17843
17843
  }
17844
17844
  },
17845
17845
  {
17846
- "description": "slot for menu item checkbox controls to appear of trailing end.",
17846
+ "description": "slot for menu item controls to appear of trailing end.",
17847
17847
  "name": "trailing-controls",
17848
17848
  "inheritedFrom": {
17849
17849
  "name": "ListItem",
@@ -17860,67 +17860,6 @@
17860
17860
  }
17861
17861
  ],
17862
17862
  "members": [
17863
- {
17864
- "kind": "field",
17865
- "name": "checked",
17866
- "type": {
17867
- "text": "boolean"
17868
- },
17869
- "default": "false",
17870
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
17871
- "attribute": "checked",
17872
- "reflects": true
17873
- },
17874
- {
17875
- "kind": "field",
17876
- "name": "indicator",
17877
- "type": {
17878
- "text": "Indicator"
17879
- },
17880
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
17881
- "default": "'checkbox'",
17882
- "attribute": "indicator",
17883
- "reflects": true
17884
- },
17885
- {
17886
- "kind": "method",
17887
- "name": "handleMouseClick",
17888
- "privacy": "private",
17889
- "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
17890
- },
17891
- {
17892
- "kind": "method",
17893
- "name": "staticCheckbox",
17894
- "privacy": "private",
17895
- "return": {
17896
- "type": {
17897
- "text": ""
17898
- }
17899
- },
17900
- "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
17901
- },
17902
- {
17903
- "kind": "method",
17904
- "name": "staticToggle",
17905
- "privacy": "private",
17906
- "return": {
17907
- "type": {
17908
- "text": ""
17909
- }
17910
- },
17911
- "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
17912
- },
17913
- {
17914
- "kind": "method",
17915
- "name": "getCheckmarkIcon",
17916
- "privacy": "private",
17917
- "return": {
17918
- "type": {
17919
- "text": ""
17920
- }
17921
- },
17922
- "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
17923
- },
17924
17863
  {
17925
17864
  "kind": "field",
17926
17865
  "name": "arrowPosition",
@@ -17929,11 +17868,7 @@
17929
17868
  },
17930
17869
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
17931
17870
  "attribute": "arrow-position",
17932
- "reflects": true,
17933
- "inheritedFrom": {
17934
- "name": "MenuItem",
17935
- "module": "components/menuitem/menuitem.component.js"
17936
- }
17871
+ "reflects": true
17937
17872
  },
17938
17873
  {
17939
17874
  "kind": "field",
@@ -17943,11 +17878,7 @@
17943
17878
  },
17944
17879
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
17945
17880
  "attribute": "arrow-direction",
17946
- "reflects": true,
17947
- "inheritedFrom": {
17948
- "name": "MenuItem",
17949
- "module": "components/menuitem/menuitem.component.js"
17950
- }
17881
+ "reflects": true
17951
17882
  },
17952
17883
  {
17953
17884
  "kind": "field",
@@ -17958,11 +17889,7 @@
17958
17889
  "default": "undefined",
17959
17890
  "description": "The name attribute is used to identify the menu item when it is selected.",
17960
17891
  "attribute": "name",
17961
- "reflects": true,
17962
- "inheritedFrom": {
17963
- "name": "MenuItem",
17964
- "module": "components/menuitem/menuitem.component.js"
17965
- }
17892
+ "reflects": true
17966
17893
  },
17967
17894
  {
17968
17895
  "kind": "field",
@@ -17973,11 +17900,7 @@
17973
17900
  "default": "undefined",
17974
17901
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
17975
17902
  "attribute": "value",
17976
- "reflects": true,
17977
- "inheritedFrom": {
17978
- "name": "MenuItem",
17979
- "module": "components/menuitem/menuitem.component.js"
17980
- }
17903
+ "reflects": true
17981
17904
  },
17982
17905
  {
17983
17906
  "kind": "method",
@@ -18021,11 +17944,7 @@
18021
17944
  "description": "The keyboard event that triggered the action."
18022
17945
  }
18023
17946
  ],
18024
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
18025
- "inheritedFrom": {
18026
- "name": "MenuItem",
18027
- "module": "components/menuitem/menuitem.component.js"
18028
- }
17947
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
18029
17948
  },
18030
17949
  {
18031
17950
  "kind": "method",
@@ -18362,15 +18281,7 @@
18362
18281
  ],
18363
18282
  "events": [
18364
18283
  {
18365
- "name": "change",
18366
- "type": {
18367
- "text": "Event"
18368
- },
18369
- "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
18370
- "reactName": "onChange"
18371
- },
18372
- {
18373
- "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
18284
+ "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
18374
18285
  "name": "click",
18375
18286
  "reactName": "onClick",
18376
18287
  "inheritedFrom": {
@@ -18378,15 +18289,6 @@
18378
18289
  "module": "src/components/listitem/listitem.component.ts"
18379
18290
  }
18380
18291
  },
18381
- {
18382
- "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
18383
- "name": "focus",
18384
- "reactName": "onFocus",
18385
- "inheritedFrom": {
18386
- "name": "ListItem",
18387
- "module": "src/components/listitem/listitem.component.ts"
18388
- }
18389
- },
18390
18292
  {
18391
18293
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
18392
18294
  "name": "keydown",
@@ -18405,6 +18307,15 @@
18405
18307
  "module": "src/components/listitem/listitem.component.ts"
18406
18308
  }
18407
18309
  },
18310
+ {
18311
+ "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
18312
+ "name": "focus",
18313
+ "reactName": "onFocus",
18314
+ "inheritedFrom": {
18315
+ "name": "ListItem",
18316
+ "module": "src/components/listitem/listitem.component.ts"
18317
+ }
18318
+ },
18408
18319
  {
18409
18320
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
18410
18321
  "name": "enabled",
@@ -18443,35 +18354,13 @@
18443
18354
  }
18444
18355
  ],
18445
18356
  "attributes": [
18446
- {
18447
- "name": "checked",
18448
- "type": {
18449
- "text": "boolean"
18450
- },
18451
- "default": "false",
18452
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
18453
- "fieldName": "checked"
18454
- },
18455
- {
18456
- "name": "indicator",
18457
- "type": {
18458
- "text": "Indicator"
18459
- },
18460
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
18461
- "default": "'checkbox'",
18462
- "fieldName": "indicator"
18463
- },
18464
18357
  {
18465
18358
  "name": "arrow-position",
18466
18359
  "type": {
18467
18360
  "text": "ArrowPositions | undefined"
18468
18361
  },
18469
18362
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
18470
- "fieldName": "arrowPosition",
18471
- "inheritedFrom": {
18472
- "name": "MenuItem",
18473
- "module": "src/components/menuitem/menuitem.component.ts"
18474
- }
18363
+ "fieldName": "arrowPosition"
18475
18364
  },
18476
18365
  {
18477
18366
  "name": "arrow-direction",
@@ -18479,11 +18368,7 @@
18479
18368
  "text": "ArrowDirections | undefined"
18480
18369
  },
18481
18370
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
18482
- "fieldName": "arrowDirection",
18483
- "inheritedFrom": {
18484
- "name": "MenuItem",
18485
- "module": "src/components/menuitem/menuitem.component.ts"
18486
- }
18371
+ "fieldName": "arrowDirection"
18487
18372
  },
18488
18373
  {
18489
18374
  "name": "name",
@@ -18492,11 +18377,7 @@
18492
18377
  },
18493
18378
  "default": "undefined",
18494
18379
  "description": "The name attribute is used to identify the menu item when it is selected.",
18495
- "fieldName": "name",
18496
- "inheritedFrom": {
18497
- "name": "MenuItem",
18498
- "module": "src/components/menuitem/menuitem.component.ts"
18499
- }
18380
+ "fieldName": "name"
18500
18381
  },
18501
18382
  {
18502
18383
  "name": "value",
@@ -18505,11 +18386,7 @@
18505
18386
  },
18506
18387
  "default": "undefined",
18507
18388
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
18508
- "fieldName": "value",
18509
- "inheritedFrom": {
18510
- "name": "MenuItem",
18511
- "module": "src/components/menuitem/menuitem.component.ts"
18512
- }
18389
+ "fieldName": "value"
18513
18390
  },
18514
18391
  {
18515
18392
  "name": "disabled",
@@ -18650,11 +18527,11 @@
18650
18527
  }
18651
18528
  ],
18652
18529
  "superclass": {
18653
- "name": "MenuItem",
18654
- "module": "/src/components/menuitem/menuitem.component"
18530
+ "name": "ListItem",
18531
+ "module": "/src/components/listitem/listitem.component"
18655
18532
  },
18656
- "tagName": "mdc-menuitemcheckbox",
18657
- "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
18533
+ "tagName": "mdc-menuitem",
18534
+ "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
18658
18535
  "customElement": true,
18659
18536
  "cssProperties": [
18660
18537
  {
@@ -18761,23 +18638,23 @@
18761
18638
  "kind": "js",
18762
18639
  "name": "default",
18763
18640
  "declaration": {
18764
- "name": "MenuItemCheckbox",
18765
- "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
18641
+ "name": "MenuItem",
18642
+ "module": "components/menuitem/menuitem.component.js"
18766
18643
  }
18767
18644
  }
18768
18645
  ]
18769
18646
  },
18770
18647
  {
18771
18648
  "kind": "javascript-module",
18772
- "path": "components/menuitem/menuitem.component.js",
18649
+ "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
18773
18650
  "declarations": [
18774
18651
  {
18775
18652
  "kind": "class",
18776
- "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
18777
- "name": "MenuItem",
18653
+ "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
18654
+ "name": "MenuItemCheckbox",
18778
18655
  "slots": [
18779
18656
  {
18780
- "description": "slot for menu item controls to appear of leading end.",
18657
+ "description": "slot for menu item checkbox controls to appear of leading end.",
18781
18658
  "name": "leading-controls",
18782
18659
  "inheritedFrom": {
18783
18660
  "name": "ListItem",
@@ -18785,7 +18662,7 @@
18785
18662
  }
18786
18663
  },
18787
18664
  {
18788
- "description": "slot for menu item primary label.",
18665
+ "description": "slot for menu item checkbox primary label.",
18789
18666
  "name": "leading-text-primary-label",
18790
18667
  "inheritedFrom": {
18791
18668
  "name": "ListItem",
@@ -18793,7 +18670,7 @@
18793
18670
  }
18794
18671
  },
18795
18672
  {
18796
- "description": "slot for menu item secondary label.",
18673
+ "description": "slot for menu item checkbox secondary label.",
18797
18674
  "name": "leading-text-secondary-label",
18798
18675
  "inheritedFrom": {
18799
18676
  "name": "ListItem",
@@ -18801,7 +18678,7 @@
18801
18678
  }
18802
18679
  },
18803
18680
  {
18804
- "description": "slot for menu item tertiary label.",
18681
+ "description": "slot for menu item checkbox tertiary label.",
18805
18682
  "name": "leading-text-tertiary-label",
18806
18683
  "inheritedFrom": {
18807
18684
  "name": "ListItem",
@@ -18809,7 +18686,7 @@
18809
18686
  }
18810
18687
  },
18811
18688
  {
18812
- "description": "slot for menu item side header text.",
18689
+ "description": "slot for menu item checkbox side header text.",
18813
18690
  "name": "trailing-text-side-header",
18814
18691
  "inheritedFrom": {
18815
18692
  "name": "ListItem",
@@ -18817,7 +18694,7 @@
18817
18694
  }
18818
18695
  },
18819
18696
  {
18820
- "description": "slot for menu item subline text.",
18697
+ "description": "slot for menu item checkbox subline text.",
18821
18698
  "name": "trailing-text-subline",
18822
18699
  "inheritedFrom": {
18823
18700
  "name": "ListItem",
@@ -18825,7 +18702,7 @@
18825
18702
  }
18826
18703
  },
18827
18704
  {
18828
- "description": "slot for menu item controls to appear of trailing end.",
18705
+ "description": "slot for menu item checkbox controls to appear of trailing end.",
18829
18706
  "name": "trailing-controls",
18830
18707
  "inheritedFrom": {
18831
18708
  "name": "ListItem",
@@ -18844,49 +18721,126 @@
18844
18721
  "members": [
18845
18722
  {
18846
18723
  "kind": "field",
18847
- "name": "arrowPosition",
18848
- "type": {
18849
- "text": "ArrowPositions | undefined"
18850
- },
18851
- "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
18852
- "attribute": "arrow-position",
18853
- "reflects": true
18854
- },
18855
- {
18856
- "kind": "field",
18857
- "name": "arrowDirection",
18724
+ "name": "checked",
18858
18725
  "type": {
18859
- "text": "ArrowDirections | undefined"
18726
+ "text": "boolean"
18860
18727
  },
18861
- "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
18862
- "attribute": "arrow-direction",
18728
+ "default": "false",
18729
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
18730
+ "attribute": "checked",
18863
18731
  "reflects": true
18864
18732
  },
18865
18733
  {
18866
18734
  "kind": "field",
18867
- "name": "name",
18735
+ "name": "indicator",
18868
18736
  "type": {
18869
- "text": "undefined | string | undefined"
18737
+ "text": "Indicator"
18870
18738
  },
18871
- "default": "undefined",
18872
- "description": "The name attribute is used to identify the menu item when it is selected.",
18873
- "attribute": "name",
18739
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
18740
+ "default": "'checkbox'",
18741
+ "attribute": "indicator",
18874
18742
  "reflects": true
18875
18743
  },
18876
18744
  {
18877
- "kind": "field",
18878
- "name": "value",
18879
- "type": {
18880
- "text": "undefined | string | undefined"
18881
- },
18882
- "default": "undefined",
18883
- "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
18884
- "attribute": "value",
18885
- "reflects": true
18745
+ "kind": "method",
18746
+ "name": "handleMouseClick",
18747
+ "privacy": "private",
18748
+ "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
18886
18749
  },
18887
18750
  {
18888
18751
  "kind": "method",
18889
- "name": "handleKeyDown",
18752
+ "name": "staticCheckbox",
18753
+ "privacy": "private",
18754
+ "return": {
18755
+ "type": {
18756
+ "text": ""
18757
+ }
18758
+ },
18759
+ "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
18760
+ },
18761
+ {
18762
+ "kind": "method",
18763
+ "name": "staticToggle",
18764
+ "privacy": "private",
18765
+ "return": {
18766
+ "type": {
18767
+ "text": ""
18768
+ }
18769
+ },
18770
+ "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
18771
+ },
18772
+ {
18773
+ "kind": "method",
18774
+ "name": "getCheckmarkIcon",
18775
+ "privacy": "private",
18776
+ "return": {
18777
+ "type": {
18778
+ "text": ""
18779
+ }
18780
+ },
18781
+ "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
18782
+ },
18783
+ {
18784
+ "kind": "field",
18785
+ "name": "arrowPosition",
18786
+ "type": {
18787
+ "text": "ArrowPositions | undefined"
18788
+ },
18789
+ "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
18790
+ "attribute": "arrow-position",
18791
+ "reflects": true,
18792
+ "inheritedFrom": {
18793
+ "name": "MenuItem",
18794
+ "module": "components/menuitem/menuitem.component.js"
18795
+ }
18796
+ },
18797
+ {
18798
+ "kind": "field",
18799
+ "name": "arrowDirection",
18800
+ "type": {
18801
+ "text": "ArrowDirections | undefined"
18802
+ },
18803
+ "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
18804
+ "attribute": "arrow-direction",
18805
+ "reflects": true,
18806
+ "inheritedFrom": {
18807
+ "name": "MenuItem",
18808
+ "module": "components/menuitem/menuitem.component.js"
18809
+ }
18810
+ },
18811
+ {
18812
+ "kind": "field",
18813
+ "name": "name",
18814
+ "type": {
18815
+ "text": "undefined | string | undefined"
18816
+ },
18817
+ "default": "undefined",
18818
+ "description": "The name attribute is used to identify the menu item when it is selected.",
18819
+ "attribute": "name",
18820
+ "reflects": true,
18821
+ "inheritedFrom": {
18822
+ "name": "MenuItem",
18823
+ "module": "components/menuitem/menuitem.component.js"
18824
+ }
18825
+ },
18826
+ {
18827
+ "kind": "field",
18828
+ "name": "value",
18829
+ "type": {
18830
+ "text": "undefined | string | undefined"
18831
+ },
18832
+ "default": "undefined",
18833
+ "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
18834
+ "attribute": "value",
18835
+ "reflects": true,
18836
+ "inheritedFrom": {
18837
+ "name": "MenuItem",
18838
+ "module": "components/menuitem/menuitem.component.js"
18839
+ }
18840
+ },
18841
+ {
18842
+ "kind": "method",
18843
+ "name": "handleKeyDown",
18890
18844
  "privacy": "protected",
18891
18845
  "return": {
18892
18846
  "type": {
@@ -18926,7 +18880,11 @@
18926
18880
  "description": "The keyboard event that triggered the action."
18927
18881
  }
18928
18882
  ],
18929
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
18883
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
18884
+ "inheritedFrom": {
18885
+ "name": "MenuItem",
18886
+ "module": "components/menuitem/menuitem.component.js"
18887
+ }
18930
18888
  },
18931
18889
  {
18932
18890
  "kind": "method",
@@ -19263,7 +19221,15 @@
19263
19221
  ],
19264
19222
  "events": [
19265
19223
  {
19266
- "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
19224
+ "name": "change",
19225
+ "type": {
19226
+ "text": "Event"
19227
+ },
19228
+ "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
19229
+ "reactName": "onChange"
19230
+ },
19231
+ {
19232
+ "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
19267
19233
  "name": "click",
19268
19234
  "reactName": "onClick",
19269
19235
  "inheritedFrom": {
@@ -19272,27 +19238,27 @@
19272
19238
  }
19273
19239
  },
19274
19240
  {
19275
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
19276
- "name": "keydown",
19277
- "reactName": "onKeyDown",
19241
+ "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
19242
+ "name": "focus",
19243
+ "reactName": "onFocus",
19278
19244
  "inheritedFrom": {
19279
19245
  "name": "ListItem",
19280
19246
  "module": "src/components/listitem/listitem.component.ts"
19281
19247
  }
19282
19248
  },
19283
19249
  {
19284
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
19285
- "name": "keyup",
19286
- "reactName": "onKeyUp",
19250
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
19251
+ "name": "keydown",
19252
+ "reactName": "onKeyDown",
19287
19253
  "inheritedFrom": {
19288
19254
  "name": "ListItem",
19289
19255
  "module": "src/components/listitem/listitem.component.ts"
19290
19256
  }
19291
19257
  },
19292
19258
  {
19293
- "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
19294
- "name": "focus",
19295
- "reactName": "onFocus",
19259
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
19260
+ "name": "keyup",
19261
+ "reactName": "onKeyUp",
19296
19262
  "inheritedFrom": {
19297
19263
  "name": "ListItem",
19298
19264
  "module": "src/components/listitem/listitem.component.ts"
@@ -19336,13 +19302,35 @@
19336
19302
  }
19337
19303
  ],
19338
19304
  "attributes": [
19305
+ {
19306
+ "name": "checked",
19307
+ "type": {
19308
+ "text": "boolean"
19309
+ },
19310
+ "default": "false",
19311
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
19312
+ "fieldName": "checked"
19313
+ },
19314
+ {
19315
+ "name": "indicator",
19316
+ "type": {
19317
+ "text": "Indicator"
19318
+ },
19319
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
19320
+ "default": "'checkbox'",
19321
+ "fieldName": "indicator"
19322
+ },
19339
19323
  {
19340
19324
  "name": "arrow-position",
19341
19325
  "type": {
19342
19326
  "text": "ArrowPositions | undefined"
19343
19327
  },
19344
19328
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
19345
- "fieldName": "arrowPosition"
19329
+ "fieldName": "arrowPosition",
19330
+ "inheritedFrom": {
19331
+ "name": "MenuItem",
19332
+ "module": "src/components/menuitem/menuitem.component.ts"
19333
+ }
19346
19334
  },
19347
19335
  {
19348
19336
  "name": "arrow-direction",
@@ -19350,7 +19338,11 @@
19350
19338
  "text": "ArrowDirections | undefined"
19351
19339
  },
19352
19340
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
19353
- "fieldName": "arrowDirection"
19341
+ "fieldName": "arrowDirection",
19342
+ "inheritedFrom": {
19343
+ "name": "MenuItem",
19344
+ "module": "src/components/menuitem/menuitem.component.ts"
19345
+ }
19354
19346
  },
19355
19347
  {
19356
19348
  "name": "name",
@@ -19359,7 +19351,11 @@
19359
19351
  },
19360
19352
  "default": "undefined",
19361
19353
  "description": "The name attribute is used to identify the menu item when it is selected.",
19362
- "fieldName": "name"
19354
+ "fieldName": "name",
19355
+ "inheritedFrom": {
19356
+ "name": "MenuItem",
19357
+ "module": "src/components/menuitem/menuitem.component.ts"
19358
+ }
19363
19359
  },
19364
19360
  {
19365
19361
  "name": "value",
@@ -19368,7 +19364,11 @@
19368
19364
  },
19369
19365
  "default": "undefined",
19370
19366
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
19371
- "fieldName": "value"
19367
+ "fieldName": "value",
19368
+ "inheritedFrom": {
19369
+ "name": "MenuItem",
19370
+ "module": "src/components/menuitem/menuitem.component.ts"
19371
+ }
19372
19372
  },
19373
19373
  {
19374
19374
  "name": "disabled",
@@ -19509,11 +19509,11 @@
19509
19509
  }
19510
19510
  ],
19511
19511
  "superclass": {
19512
- "name": "ListItem",
19513
- "module": "/src/components/listitem/listitem.component"
19512
+ "name": "MenuItem",
19513
+ "module": "/src/components/menuitem/menuitem.component"
19514
19514
  },
19515
- "tagName": "mdc-menuitem",
19516
- "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
19515
+ "tagName": "mdc-menuitemcheckbox",
19516
+ "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
19517
19517
  "customElement": true,
19518
19518
  "cssProperties": [
19519
19519
  {
@@ -19620,8 +19620,8 @@
19620
19620
  "kind": "js",
19621
19621
  "name": "default",
19622
19622
  "declaration": {
19623
- "name": "MenuItem",
19624
- "module": "components/menuitem/menuitem.component.js"
19623
+ "name": "MenuItemCheckbox",
19624
+ "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
19625
19625
  }
19626
19626
  }
19627
19627
  ]
@@ -30560,759 +30560,1013 @@
30560
30560
  },
30561
30561
  {
30562
30562
  "kind": "javascript-module",
30563
- "path": "components/select/select.component.js",
30563
+ "path": "components/searchfield/searchfield.component.js",
30564
30564
  "declarations": [
30565
30565
  {
30566
30566
  "kind": "class",
30567
- "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.",
30568
- "name": "Select",
30567
+ "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.",
30568
+ "name": "Searchfield",
30569
30569
  "slots": [
30570
30570
  {
30571
- "description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
30572
- "name": "default"
30571
+ "description": "Slot for input chips",
30572
+ "name": "filters"
30573
30573
  }
30574
30574
  ],
30575
30575
  "members": [
30576
30576
  {
30577
30577
  "kind": "field",
30578
- "name": "placeholder",
30578
+ "name": "inputChips",
30579
30579
  "type": {
30580
- "text": "string | undefined"
30581
- },
30582
- "description": "The placeholder text which will be shown on the text if provided.",
30583
- "attribute": "placeholder"
30580
+ "text": "Array<HTMLElement> | undefined"
30581
+ }
30584
30582
  },
30585
30583
  {
30586
- "kind": "field",
30587
- "name": "readonly",
30588
- "type": {
30589
- "text": "boolean"
30590
- },
30591
- "default": "false",
30592
- "description": "readonly attribute of the select field. If true, the select is read-only.",
30593
- "attribute": "readonly"
30584
+ "kind": "method",
30585
+ "name": "handleKeyDown",
30586
+ "privacy": "protected",
30587
+ "parameters": [
30588
+ {
30589
+ "name": "event",
30590
+ "type": {
30591
+ "text": "KeyboardEvent"
30592
+ },
30593
+ "description": "Keyboard event"
30594
+ }
30595
+ ],
30596
+ "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.",
30597
+ "inheritedFrom": {
30598
+ "name": "Input",
30599
+ "module": "components/input/input.component.js"
30600
+ }
30601
+ },
30602
+ {
30603
+ "kind": "method",
30604
+ "name": "renderInputChips",
30605
+ "privacy": "private",
30606
+ "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
30607
+ },
30608
+ {
30609
+ "kind": "method",
30610
+ "name": "clearInputText",
30611
+ "privacy": "protected",
30612
+ "description": "Clears the input field.",
30613
+ "inheritedFrom": {
30614
+ "name": "Input",
30615
+ "module": "components/input/input.component.js"
30616
+ }
30594
30617
  },
30595
30618
  {
30596
30619
  "kind": "field",
30597
- "name": "height",
30620
+ "name": "name",
30598
30621
  "type": {
30599
30622
  "text": "string"
30600
30623
  },
30601
- "default": "'auto'",
30602
- "description": "height attribute of the select field. If set,\nthen a scroll bar will be visible when there more options than the adjusted height.",
30603
- "attribute": "height"
30624
+ "default": "''",
30625
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
30626
+ "attribute": "name",
30627
+ "reflects": true,
30628
+ "inheritedFrom": {
30629
+ "name": "FormInternalsMixin",
30630
+ "module": "utils/mixins/FormInternalsMixin.js"
30631
+ }
30604
30632
  },
30605
30633
  {
30606
30634
  "kind": "field",
30607
- "name": "placement",
30635
+ "name": "value",
30608
30636
  "type": {
30609
- "text": "Placement"
30637
+ "text": "string"
30610
30638
  },
30611
- "description": "The placeholder text which will be shown on the text if provided.",
30612
- "attribute": "placement",
30613
- "reflects": true
30639
+ "default": "''",
30640
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
30641
+ "attribute": "value",
30642
+ "reflects": true,
30643
+ "inheritedFrom": {
30644
+ "name": "FormInternalsMixin",
30645
+ "module": "utils/mixins/FormInternalsMixin.js"
30646
+ }
30614
30647
  },
30615
30648
  {
30616
30649
  "kind": "field",
30617
- "name": "softDisabled",
30650
+ "name": "validationMessage",
30618
30651
  "type": {
30619
- "text": "boolean | undefined"
30652
+ "text": "string | undefined"
30620
30653
  },
30621
- "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
30622
- "default": "undefined",
30623
- "attribute": "soft-disabled"
30654
+ "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.",
30655
+ "attribute": "validation-message",
30656
+ "reflects": true,
30657
+ "inheritedFrom": {
30658
+ "name": "FormInternalsMixin",
30659
+ "module": "utils/mixins/FormInternalsMixin.js"
30660
+ }
30624
30661
  },
30625
30662
  {
30626
- "kind": "method",
30627
- "name": "getAllValidOptions",
30628
- "privacy": "private",
30629
- "return": {
30630
- "type": {
30631
- "text": "Array<Option>"
30632
- }
30663
+ "kind": "field",
30664
+ "name": "validity",
30665
+ "type": {
30666
+ "text": "ValidityState"
30667
+ },
30668
+ "readonly": true,
30669
+ "inheritedFrom": {
30670
+ "name": "FormInternalsMixin",
30671
+ "module": "utils/mixins/FormInternalsMixin.js"
30672
+ }
30673
+ },
30674
+ {
30675
+ "kind": "field",
30676
+ "name": "willValidate",
30677
+ "readonly": true,
30678
+ "inheritedFrom": {
30679
+ "name": "FormInternalsMixin",
30680
+ "module": "utils/mixins/FormInternalsMixin.js"
30633
30681
  }
30634
30682
  },
30635
30683
  {
30636
30684
  "kind": "method",
30637
- "name": "getFirstValidOption",
30638
- "privacy": "private",
30685
+ "name": "setValidity",
30686
+ "description": "Sets the validity of the input field based on the input field's validity.",
30639
30687
  "return": {
30640
30688
  "type": {
30641
- "text": "Option | null"
30689
+ "text": ""
30642
30690
  }
30691
+ },
30692
+ "inheritedFrom": {
30693
+ "name": "FormInternalsMixin",
30694
+ "module": "utils/mixins/FormInternalsMixin.js"
30643
30695
  }
30644
30696
  },
30645
30697
  {
30646
30698
  "kind": "method",
30647
- "name": "getLastValidOption",
30648
- "privacy": "private",
30699
+ "name": "checkValidity",
30649
30700
  "return": {
30650
30701
  "type": {
30651
- "text": "Option | null"
30702
+ "text": "boolean"
30652
30703
  }
30704
+ },
30705
+ "inheritedFrom": {
30706
+ "name": "FormInternalsMixin",
30707
+ "module": "utils/mixins/FormInternalsMixin.js"
30653
30708
  }
30654
30709
  },
30655
30710
  {
30656
30711
  "kind": "method",
30657
- "name": "getFirstSelectedOption",
30658
- "privacy": "private",
30659
- "return": {
30660
- "type": {
30661
- "text": "Option | null"
30662
- }
30712
+ "name": "reportValidity",
30713
+ "inheritedFrom": {
30714
+ "name": "FormInternalsMixin",
30715
+ "module": "utils/mixins/FormInternalsMixin.js"
30716
+ }
30717
+ },
30718
+ {
30719
+ "kind": "field",
30720
+ "name": "dataAriaLabel",
30721
+ "type": {
30722
+ "text": "string | null"
30723
+ },
30724
+ "default": "null",
30725
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
30726
+ "attribute": "data-aria-label",
30727
+ "reflects": true,
30728
+ "inheritedFrom": {
30729
+ "name": "DataAriaLabelMixin",
30730
+ "module": "utils/mixins/DataAriaLabelMixin.js"
30731
+ }
30732
+ },
30733
+ {
30734
+ "kind": "field",
30735
+ "name": "placeholder",
30736
+ "type": {
30737
+ "text": "string"
30738
+ },
30739
+ "default": "''",
30740
+ "description": "The placeholder text that is displayed when the input field is empty.",
30741
+ "attribute": "placeholder",
30742
+ "inheritedFrom": {
30743
+ "name": "Input",
30744
+ "module": "components/input/input.component.js"
30745
+ }
30746
+ },
30747
+ {
30748
+ "kind": "field",
30749
+ "name": "readonly",
30750
+ "type": {
30751
+ "text": "boolean"
30752
+ },
30753
+ "default": "false",
30754
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
30755
+ "attribute": "readonly",
30756
+ "inheritedFrom": {
30757
+ "name": "Input",
30758
+ "module": "components/input/input.component.js"
30759
+ }
30760
+ },
30761
+ {
30762
+ "kind": "field",
30763
+ "name": "prefixText",
30764
+ "type": {
30765
+ "text": "string | undefined"
30766
+ },
30767
+ "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.",
30768
+ "attribute": "prefix-text",
30769
+ "inheritedFrom": {
30770
+ "name": "Input",
30771
+ "module": "components/input/input.component.js"
30772
+ }
30773
+ },
30774
+ {
30775
+ "kind": "field",
30776
+ "name": "leadingIcon",
30777
+ "type": {
30778
+ "text": "IconNames | undefined"
30779
+ },
30780
+ "description": "The leading icon that is displayed before the input field.",
30781
+ "attribute": "leading-icon",
30782
+ "inheritedFrom": {
30783
+ "name": "Input",
30784
+ "module": "components/input/input.component.js"
30785
+ }
30786
+ },
30787
+ {
30788
+ "kind": "field",
30789
+ "name": "trailingButton",
30790
+ "type": {
30791
+ "text": "boolean"
30792
+ },
30793
+ "default": "false",
30794
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
30795
+ "attribute": "trailing-button",
30796
+ "inheritedFrom": {
30797
+ "name": "Input",
30798
+ "module": "components/input/input.component.js"
30799
+ }
30800
+ },
30801
+ {
30802
+ "kind": "field",
30803
+ "name": "maxlength",
30804
+ "type": {
30805
+ "text": "number | undefined"
30806
+ },
30807
+ "description": "The maximum number of characters that the input field can accept.",
30808
+ "attribute": "maxlength",
30809
+ "inheritedFrom": {
30810
+ "name": "Input",
30811
+ "module": "components/input/input.component.js"
30812
+ }
30813
+ },
30814
+ {
30815
+ "kind": "field",
30816
+ "name": "minlength",
30817
+ "type": {
30818
+ "text": "number | undefined"
30819
+ },
30820
+ "description": "The minimum number of characters that the input field can accept.",
30821
+ "attribute": "minlength",
30822
+ "inheritedFrom": {
30823
+ "name": "Input",
30824
+ "module": "components/input/input.component.js"
30825
+ }
30826
+ },
30827
+ {
30828
+ "kind": "field",
30829
+ "name": "autocapitalize",
30830
+ "type": {
30831
+ "text": "AutoCapitalizeType"
30832
+ },
30833
+ "description": "The autocapitalize attribute of the input field.",
30834
+ "default": "'off'",
30835
+ "attribute": "autocapitalize",
30836
+ "inheritedFrom": {
30837
+ "name": "Input",
30838
+ "module": "components/input/input.component.js"
30839
+ }
30840
+ },
30841
+ {
30842
+ "kind": "field",
30843
+ "name": "autocomplete",
30844
+ "type": {
30845
+ "text": "AutoCompleteType"
30846
+ },
30847
+ "description": "The autocomplete attribute of the input field.",
30848
+ "default": "'off'",
30849
+ "attribute": "autocomplete",
30850
+ "inheritedFrom": {
30851
+ "name": "Input",
30852
+ "module": "components/input/input.component.js"
30853
+ }
30854
+ },
30855
+ {
30856
+ "kind": "field",
30857
+ "name": "autofocus",
30858
+ "type": {
30859
+ "text": "boolean"
30860
+ },
30861
+ "default": "false",
30862
+ "description": "If true, the input field is focused when the component is rendered.",
30863
+ "attribute": "autofocus",
30864
+ "inheritedFrom": {
30865
+ "name": "Input",
30866
+ "module": "components/input/input.component.js"
30867
+ }
30868
+ },
30869
+ {
30870
+ "kind": "field",
30871
+ "name": "dirname",
30872
+ "type": {
30873
+ "text": "string | undefined"
30874
+ },
30875
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
30876
+ "attribute": "dirname",
30877
+ "inheritedFrom": {
30878
+ "name": "Input",
30879
+ "module": "components/input/input.component.js"
30880
+ }
30881
+ },
30882
+ {
30883
+ "kind": "field",
30884
+ "name": "pattern",
30885
+ "type": {
30886
+ "text": "string | undefined"
30887
+ },
30888
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
30889
+ "attribute": "pattern",
30890
+ "inheritedFrom": {
30891
+ "name": "Input",
30892
+ "module": "components/input/input.component.js"
30893
+ }
30894
+ },
30895
+ {
30896
+ "kind": "field",
30897
+ "name": "list",
30898
+ "type": {
30899
+ "text": "string | undefined"
30900
+ },
30901
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
30902
+ "attribute": "list",
30903
+ "inheritedFrom": {
30904
+ "name": "Input",
30905
+ "module": "components/input/input.component.js"
30906
+ }
30907
+ },
30908
+ {
30909
+ "kind": "field",
30910
+ "name": "size",
30911
+ "type": {
30912
+ "text": "number | undefined | undefined"
30913
+ },
30914
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
30915
+ "default": "undefined",
30916
+ "attribute": "size",
30917
+ "inheritedFrom": {
30918
+ "name": "Input",
30919
+ "module": "components/input/input.component.js"
30920
+ }
30921
+ },
30922
+ {
30923
+ "kind": "field",
30924
+ "name": "clearAriaLabel",
30925
+ "type": {
30926
+ "text": "string"
30927
+ },
30928
+ "default": "''",
30929
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
30930
+ "attribute": "clear-aria-label",
30931
+ "inheritedFrom": {
30932
+ "name": "Input",
30933
+ "module": "components/input/input.component.js"
30663
30934
  }
30664
30935
  },
30665
30936
  {
30666
30937
  "kind": "method",
30667
- "name": "modifyListBoxWrapper",
30938
+ "name": "setInputValidity",
30668
30939
  "privacy": "private",
30669
- "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."
30940
+ "inheritedFrom": {
30941
+ "name": "Input",
30942
+ "module": "components/input/input.component.js"
30943
+ }
30670
30944
  },
30671
30945
  {
30672
30946
  "kind": "method",
30673
- "name": "handleOptionsClick",
30947
+ "name": "updateValue",
30674
30948
  "privacy": "private",
30949
+ "description": "Updates the value of the input field.\nSets the form value.",
30675
30950
  "return": {
30676
30951
  "type": {
30677
- "text": "void"
30952
+ "text": ""
30678
30953
  }
30679
30954
  },
30680
- "parameters": [
30681
- {
30682
- "name": "event",
30683
- "type": {
30684
- "text": "MouseEvent"
30685
- },
30686
- "description": "The event which triggered this function."
30687
- }
30688
- ],
30689
- "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."
30955
+ "inheritedFrom": {
30956
+ "name": "Input",
30957
+ "module": "components/input/input.component.js"
30958
+ }
30690
30959
  },
30691
30960
  {
30692
30961
  "kind": "method",
30693
- "name": "setSelectedOption",
30962
+ "name": "onInput",
30694
30963
  "privacy": "private",
30695
- "return": {
30696
- "type": {
30697
- "text": "void"
30698
- }
30699
- },
30700
- "parameters": [
30701
- {
30702
- "name": "option",
30703
- "type": {
30704
- "text": "Option | null"
30705
- },
30706
- "description": "The option element in DOM which gets selected."
30707
- }
30708
- ],
30709
- "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."
30964
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
30965
+ "inheritedFrom": {
30966
+ "name": "Input",
30967
+ "module": "components/input/input.component.js"
30968
+ }
30710
30969
  },
30711
30970
  {
30712
30971
  "kind": "method",
30713
- "name": "updateTabIndexForAllOptions",
30972
+ "name": "onChange",
30714
30973
  "privacy": "private",
30715
- "return": {
30716
- "type": {
30717
- "text": "void"
30718
- }
30719
- },
30720
30974
  "parameters": [
30721
30975
  {
30722
- "name": "option",
30723
- "optional": true,
30976
+ "name": "event",
30724
30977
  "type": {
30725
- "text": "Option | null"
30978
+ "text": "Event"
30726
30979
  },
30727
- "description": "The option which tabIndex should be set to 0."
30980
+ "description": "Event which contains information about the value change."
30728
30981
  }
30729
30982
  ],
30730
- "description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
30983
+ "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",
30984
+ "inheritedFrom": {
30985
+ "name": "Input",
30986
+ "module": "components/input/input.component.js"
30987
+ }
30731
30988
  },
30732
30989
  {
30733
30990
  "kind": "method",
30734
- "name": "updateSelectedInChildOptions",
30735
- "privacy": "private",
30991
+ "name": "renderLeadingIcon",
30992
+ "privacy": "protected",
30993
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
30736
30994
  "return": {
30737
30995
  "type": {
30738
- "text": "void"
30996
+ "text": ""
30739
30997
  }
30740
30998
  },
30741
- "parameters": [
30742
- {
30743
- "name": "selectedOption",
30744
- "type": {
30745
- "text": "Option | null"
30746
- },
30747
- "description": "The option which gets selected"
30748
- }
30749
- ],
30750
- "description": "Sets selected attribute on the selected option and removes it from all options"
30999
+ "inheritedFrom": {
31000
+ "name": "Input",
31001
+ "module": "components/input/input.component.js"
31002
+ }
30751
31003
  },
30752
31004
  {
30753
31005
  "kind": "method",
30754
- "name": "fireEvents",
30755
- "privacy": "private",
31006
+ "name": "renderPrefixText",
31007
+ "privacy": "protected",
31008
+ "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.",
30756
31009
  "return": {
30757
31010
  "type": {
30758
- "text": "void"
31011
+ "text": ""
30759
31012
  }
30760
31013
  },
30761
- "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."
31014
+ "inheritedFrom": {
31015
+ "name": "Input",
31016
+ "module": "components/input/input.component.js"
31017
+ }
30762
31018
  },
30763
31019
  {
30764
31020
  "kind": "method",
30765
- "name": "dispatchChange",
30766
- "privacy": "private",
30767
- "return": {
30768
- "type": {
30769
- "text": "void"
30770
- }
30771
- },
31021
+ "name": "renderTrailingButton",
31022
+ "privacy": "protected",
30772
31023
  "parameters": [
30773
31024
  {
30774
- "name": "option",
30775
- "type": {
30776
- "text": "Option"
30777
- }
31025
+ "name": "show",
31026
+ "default": "false"
30778
31027
  }
30779
- ]
30780
- },
30781
- {
30782
- "kind": "method",
30783
- "name": "dispatchInput",
30784
- "privacy": "private",
31028
+ ],
31029
+ "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
30785
31030
  "return": {
30786
31031
  "type": {
30787
- "text": "void"
31032
+ "text": ""
30788
31033
  }
30789
31034
  },
30790
- "parameters": [
30791
- {
30792
- "name": "option",
30793
- "type": {
30794
- "text": "Option"
30795
- }
30796
- }
30797
- ]
31035
+ "inheritedFrom": {
31036
+ "name": "Input",
31037
+ "module": "components/input/input.component.js"
31038
+ }
30798
31039
  },
30799
31040
  {
30800
31041
  "kind": "method",
30801
- "name": "handleClickCombobox",
30802
- "privacy": "private",
30803
- "return": {
30804
- "type": {
30805
- "text": "void"
30806
- }
30807
- },
31042
+ "name": "renderInputElement",
31043
+ "privacy": "protected",
30808
31044
  "parameters": [
30809
31045
  {
30810
- "name": "event",
31046
+ "name": "type",
30811
31047
  "type": {
30812
- "text": "MouseEvent"
30813
- },
30814
- "description": "The mouse event which triggered this function."
31048
+ "text": "InputType"
31049
+ }
31050
+ },
31051
+ {
31052
+ "name": "hidePlaceholder",
31053
+ "default": "false"
30815
31054
  }
30816
31055
  ],
30817
- "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."
31056
+ "inheritedFrom": {
31057
+ "name": "Input",
31058
+ "module": "components/input/input.component.js"
31059
+ }
30818
31060
  },
30819
31061
  {
30820
- "kind": "method",
30821
- "name": "handleKeydownCombobox",
30822
- "privacy": "private",
30823
- "return": {
30824
- "type": {
30825
- "text": "void"
30826
- }
31062
+ "kind": "field",
31063
+ "name": "disabled",
31064
+ "type": {
31065
+ "text": "boolean | undefined"
30827
31066
  },
30828
- "parameters": [
30829
- {
30830
- "name": "event",
30831
- "type": {
30832
- "text": "KeyboardEvent"
30833
- },
30834
- "description": "The keyboard event."
30835
- }
30836
- ],
30837
- "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."
31067
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
31068
+ "default": "undefined",
31069
+ "attribute": "disabled",
31070
+ "reflects": true,
31071
+ "inheritedFrom": {
31072
+ "name": "FormfieldWrapper",
31073
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31074
+ }
30838
31075
  },
30839
31076
  {
30840
- "kind": "method",
30841
- "name": "handlePopoverKeydown",
30842
- "privacy": "private",
30843
- "return": {
30844
- "type": {
30845
- "text": "void"
30846
- }
31077
+ "kind": "field",
31078
+ "name": "label",
31079
+ "type": {
31080
+ "text": "string | undefined"
30847
31081
  },
30848
- "parameters": [
30849
- {
30850
- "name": "event",
30851
- "type": {
30852
- "text": "KeyboardEvent"
30853
- },
30854
- "description": "The keyboard event."
30855
- }
30856
- ],
30857
- "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."
31082
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
31083
+ "attribute": "label",
31084
+ "reflects": true,
31085
+ "inheritedFrom": {
31086
+ "name": "FormfieldWrapper",
31087
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31088
+ }
30858
31089
  },
30859
31090
  {
30860
- "kind": "method",
30861
- "name": "updateState",
30862
- "privacy": "public",
30863
- "return": {
30864
- "type": {
30865
- "text": "void"
30866
- }
31091
+ "kind": "field",
31092
+ "name": "required",
31093
+ "type": {
31094
+ "text": "boolean"
30867
31095
  },
30868
- "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."
31096
+ "default": "false",
31097
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
31098
+ "attribute": "required",
31099
+ "reflects": true,
31100
+ "inheritedFrom": {
31101
+ "name": "FormfieldWrapper",
31102
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31103
+ }
30869
31104
  },
30870
31105
  {
30871
31106
  "kind": "field",
30872
- "name": "name",
31107
+ "name": "id",
30873
31108
  "type": {
30874
31109
  "text": "string"
30875
31110
  },
30876
31111
  "default": "''",
30877
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
30878
- "attribute": "name",
31112
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
31113
+ "attribute": "id",
31114
+ "inheritedFrom": {
31115
+ "name": "FormfieldWrapper",
31116
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31117
+ }
31118
+ },
31119
+ {
31120
+ "kind": "field",
31121
+ "name": "helpTextType",
31122
+ "type": {
31123
+ "text": "ValidationType"
31124
+ },
31125
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
31126
+ "attribute": "help-text-type",
30879
31127
  "reflects": true,
30880
31128
  "inheritedFrom": {
30881
- "name": "FormInternalsMixin",
30882
- "module": "utils/mixins/FormInternalsMixin.js"
31129
+ "name": "FormfieldWrapper",
31130
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30883
31131
  }
30884
31132
  },
30885
31133
  {
30886
31134
  "kind": "field",
30887
- "name": "value",
31135
+ "name": "helpText",
30888
31136
  "type": {
30889
- "text": "string"
31137
+ "text": "string | undefined"
30890
31138
  },
30891
- "default": "''",
30892
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
30893
- "attribute": "value",
31139
+ "description": "The help text that is displayed below the input field.",
31140
+ "attribute": "help-text",
30894
31141
  "reflects": true,
30895
31142
  "inheritedFrom": {
30896
- "name": "FormInternalsMixin",
30897
- "module": "utils/mixins/FormInternalsMixin.js"
31143
+ "name": "FormfieldWrapper",
31144
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30898
31145
  }
30899
31146
  },
30900
31147
  {
30901
31148
  "kind": "field",
30902
- "name": "validationMessage",
31149
+ "name": "toggletipText",
30903
31150
  "type": {
30904
31151
  "text": "string | undefined"
30905
31152
  },
30906
- "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.",
30907
- "attribute": "validation-message",
31153
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
31154
+ "attribute": "toggletip-text",
30908
31155
  "reflects": true,
30909
31156
  "inheritedFrom": {
30910
- "name": "FormInternalsMixin",
30911
- "module": "utils/mixins/FormInternalsMixin.js"
31157
+ "name": "FormfieldWrapper",
31158
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30912
31159
  }
30913
31160
  },
30914
31161
  {
30915
31162
  "kind": "field",
30916
- "name": "validity",
31163
+ "name": "toggletipPlacement",
30917
31164
  "type": {
30918
- "text": "ValidityState"
31165
+ "text": "PopoverPlacement"
30919
31166
  },
30920
- "readonly": true,
31167
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
31168
+ "default": "'top'",
31169
+ "attribute": "toggletip-placement",
31170
+ "reflects": true,
30921
31171
  "inheritedFrom": {
30922
- "name": "FormInternalsMixin",
30923
- "module": "utils/mixins/FormInternalsMixin.js"
31172
+ "name": "FormfieldWrapper",
31173
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30924
31174
  }
30925
31175
  },
30926
31176
  {
30927
31177
  "kind": "field",
30928
- "name": "willValidate",
30929
- "readonly": true,
31178
+ "name": "infoIconAriaLabel",
31179
+ "type": {
31180
+ "text": "string | undefined"
31181
+ },
31182
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
31183
+ "attribute": "info-icon-aria-label",
31184
+ "reflects": true,
30930
31185
  "inheritedFrom": {
30931
- "name": "FormInternalsMixin",
30932
- "module": "utils/mixins/FormInternalsMixin.js"
31186
+ "name": "FormfieldWrapper",
31187
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30933
31188
  }
30934
31189
  },
30935
31190
  {
30936
31191
  "kind": "method",
30937
- "name": "setValidity",
30938
- "description": "Sets the validity of the input field based on the input field's validity.",
31192
+ "name": "renderLabelElement",
31193
+ "privacy": "protected",
31194
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
30939
31195
  "return": {
30940
31196
  "type": {
30941
31197
  "text": ""
30942
31198
  }
30943
31199
  },
30944
31200
  "inheritedFrom": {
30945
- "name": "FormInternalsMixin",
30946
- "module": "utils/mixins/FormInternalsMixin.js"
31201
+ "name": "FormfieldWrapper",
31202
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30947
31203
  }
30948
31204
  },
30949
31205
  {
30950
31206
  "kind": "method",
30951
- "name": "checkValidity",
31207
+ "name": "renderHelpTextIcon",
31208
+ "privacy": "protected",
31209
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
30952
31210
  "return": {
30953
31211
  "type": {
30954
- "text": "boolean"
31212
+ "text": ""
30955
31213
  }
30956
31214
  },
30957
31215
  "inheritedFrom": {
30958
- "name": "FormInternalsMixin",
30959
- "module": "utils/mixins/FormInternalsMixin.js"
31216
+ "name": "FormfieldWrapper",
31217
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30960
31218
  }
30961
31219
  },
30962
31220
  {
30963
31221
  "kind": "method",
30964
- "name": "reportValidity",
31222
+ "name": "renderHelpText",
31223
+ "privacy": "protected",
31224
+ "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
31225
+ "return": {
31226
+ "type": {
31227
+ "text": ""
31228
+ }
31229
+ },
30965
31230
  "inheritedFrom": {
30966
- "name": "FormInternalsMixin",
30967
- "module": "utils/mixins/FormInternalsMixin.js"
31231
+ "name": "FormfieldWrapper",
31232
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30968
31233
  }
30969
31234
  },
30970
31235
  {
30971
- "kind": "field",
30972
- "name": "dataAriaLabel",
30973
- "type": {
30974
- "text": "string | null"
31236
+ "kind": "method",
31237
+ "name": "renderLabel",
31238
+ "privacy": "protected",
31239
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
31240
+ "return": {
31241
+ "type": {
31242
+ "text": ""
31243
+ }
30975
31244
  },
30976
- "default": "null",
30977
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
30978
- "attribute": "data-aria-label",
30979
- "reflects": true,
30980
31245
  "inheritedFrom": {
30981
- "name": "DataAriaLabelMixin",
30982
- "module": "utils/mixins/DataAriaLabelMixin.js"
31246
+ "name": "FormfieldWrapper",
31247
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30983
31248
  }
30984
31249
  },
30985
31250
  {
30986
- "kind": "field",
30987
- "name": "disabled",
30988
- "type": {
30989
- "text": "boolean | undefined"
31251
+ "kind": "method",
31252
+ "name": "renderHelperText",
31253
+ "privacy": "protected",
31254
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
31255
+ "return": {
31256
+ "type": {
31257
+ "text": ""
31258
+ }
30990
31259
  },
30991
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
30992
- "default": "undefined",
30993
- "attribute": "disabled",
30994
- "reflects": true,
30995
31260
  "inheritedFrom": {
30996
31261
  "name": "FormfieldWrapper",
30997
31262
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30998
31263
  }
31264
+ }
31265
+ ],
31266
+ "events": [
31267
+ {
31268
+ "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
31269
+ "name": "input",
31270
+ "reactName": "onInput",
31271
+ "inheritedFrom": {
31272
+ "name": "Input",
31273
+ "module": "src/components/input/input.component.ts"
31274
+ }
30999
31275
  },
31000
31276
  {
31001
- "kind": "field",
31002
- "name": "label",
31003
- "type": {
31004
- "text": "string | undefined"
31005
- },
31006
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
31007
- "attribute": "label",
31008
- "reflects": true,
31277
+ "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
31278
+ "name": "change",
31279
+ "reactName": "onChange",
31009
31280
  "inheritedFrom": {
31010
- "name": "FormfieldWrapper",
31011
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31281
+ "name": "Input",
31282
+ "module": "src/components/input/input.component.ts"
31012
31283
  }
31013
31284
  },
31014
31285
  {
31015
- "kind": "field",
31016
- "name": "required",
31286
+ "description": "(React: onFocus) This event is dispatched when the input receives focus.",
31287
+ "name": "focus",
31288
+ "reactName": "onFocus",
31289
+ "inheritedFrom": {
31290
+ "name": "Input",
31291
+ "module": "src/components/input/input.component.ts"
31292
+ }
31293
+ },
31294
+ {
31295
+ "description": "(React: onBlur) This event is dispatched when the input loses focus.",
31296
+ "name": "blur",
31297
+ "reactName": "onBlur",
31298
+ "inheritedFrom": {
31299
+ "name": "Input",
31300
+ "module": "src/components/input/input.component.ts"
31301
+ }
31302
+ },
31303
+ {
31304
+ "name": "clear",
31017
31305
  "type": {
31018
- "text": "boolean"
31306
+ "text": "CustomEvent"
31019
31307
  },
31020
- "default": "false",
31021
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
31022
- "attribute": "required",
31023
- "reflects": true,
31308
+ "description": "(React: onClear) This event is dispatched when the input text is cleared.",
31309
+ "reactName": "onClear",
31024
31310
  "inheritedFrom": {
31025
- "name": "FormfieldWrapper",
31026
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31311
+ "name": "Input",
31312
+ "module": "src/components/input/input.component.ts"
31027
31313
  }
31028
31314
  },
31029
31315
  {
31030
- "kind": "field",
31031
- "name": "id",
31032
31316
  "type": {
31033
- "text": "string"
31317
+ "text": "EventConstructor"
31034
31318
  },
31035
- "default": "''",
31036
- "description": "The unique id of the input field. It is used to link the input field with the label.",
31037
- "attribute": "id",
31038
31319
  "inheritedFrom": {
31039
- "name": "FormfieldWrapper",
31040
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31320
+ "name": "Input",
31321
+ "module": "src/components/input/input.component.ts"
31041
31322
  }
31042
- },
31323
+ }
31324
+ ],
31325
+ "superclass": {
31326
+ "name": "Input",
31327
+ "module": "/src/components/input/input.component"
31328
+ },
31329
+ "tagName": "mdc-searchfield",
31330
+ "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 */",
31331
+ "customElement": true,
31332
+ "attributes": [
31043
31333
  {
31044
- "kind": "field",
31045
- "name": "helpTextType",
31334
+ "name": "name",
31046
31335
  "type": {
31047
- "text": "ValidationType"
31336
+ "text": "string"
31048
31337
  },
31049
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
31050
- "attribute": "help-text-type",
31051
- "reflects": true,
31338
+ "default": "''",
31339
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
31340
+ "fieldName": "name",
31052
31341
  "inheritedFrom": {
31053
- "name": "FormfieldWrapper",
31054
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31342
+ "name": "FormInternalsMixin",
31343
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
31055
31344
  }
31056
31345
  },
31057
31346
  {
31058
- "kind": "field",
31059
- "name": "helpText",
31347
+ "name": "value",
31060
31348
  "type": {
31061
- "text": "string | undefined"
31349
+ "text": "string"
31062
31350
  },
31063
- "description": "The help text that is displayed below the input field.",
31064
- "attribute": "help-text",
31065
- "reflects": true,
31351
+ "default": "''",
31352
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
31353
+ "fieldName": "value",
31066
31354
  "inheritedFrom": {
31067
- "name": "FormfieldWrapper",
31068
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31355
+ "name": "FormInternalsMixin",
31356
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
31069
31357
  }
31070
31358
  },
31071
31359
  {
31072
- "kind": "field",
31073
- "name": "toggletipText",
31360
+ "name": "validation-message",
31074
31361
  "type": {
31075
31362
  "text": "string | undefined"
31076
31363
  },
31077
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
31078
- "attribute": "toggletip-text",
31079
- "reflects": true,
31364
+ "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.",
31365
+ "fieldName": "validationMessage",
31080
31366
  "inheritedFrom": {
31081
- "name": "FormfieldWrapper",
31082
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31367
+ "name": "FormInternalsMixin",
31368
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
31083
31369
  }
31084
31370
  },
31085
31371
  {
31086
- "kind": "field",
31087
- "name": "toggletipPlacement",
31372
+ "name": "data-aria-label",
31088
31373
  "type": {
31089
- "text": "PopoverPlacement"
31374
+ "text": "string | null"
31090
31375
  },
31091
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
31092
- "default": "'top'",
31093
- "attribute": "toggletip-placement",
31094
- "reflects": true,
31376
+ "default": "null",
31377
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
31378
+ "fieldName": "dataAriaLabel",
31095
31379
  "inheritedFrom": {
31096
- "name": "FormfieldWrapper",
31097
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31380
+ "name": "DataAriaLabelMixin",
31381
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
31098
31382
  }
31099
31383
  },
31100
31384
  {
31101
- "kind": "field",
31102
- "name": "infoIconAriaLabel",
31385
+ "name": "placeholder",
31103
31386
  "type": {
31104
- "text": "string | undefined"
31387
+ "text": "string"
31105
31388
  },
31106
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
31107
- "attribute": "info-icon-aria-label",
31108
- "reflects": true,
31389
+ "default": "''",
31390
+ "description": "The placeholder text that is displayed when the input field is empty.",
31391
+ "fieldName": "placeholder",
31109
31392
  "inheritedFrom": {
31110
- "name": "FormfieldWrapper",
31111
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31393
+ "name": "Input",
31394
+ "module": "src/components/input/input.component.ts"
31112
31395
  }
31113
31396
  },
31114
31397
  {
31115
- "kind": "method",
31116
- "name": "renderLabelElement",
31117
- "privacy": "protected",
31118
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
31119
- "return": {
31120
- "type": {
31121
- "text": ""
31122
- }
31398
+ "name": "readonly",
31399
+ "type": {
31400
+ "text": "boolean"
31123
31401
  },
31402
+ "default": "false",
31403
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
31404
+ "fieldName": "readonly",
31124
31405
  "inheritedFrom": {
31125
- "name": "FormfieldWrapper",
31126
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31406
+ "name": "Input",
31407
+ "module": "src/components/input/input.component.ts"
31127
31408
  }
31128
31409
  },
31129
31410
  {
31130
- "kind": "method",
31131
- "name": "renderHelpTextIcon",
31132
- "privacy": "protected",
31133
- "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
31134
- "return": {
31135
- "type": {
31136
- "text": ""
31137
- }
31411
+ "name": "prefix-text",
31412
+ "type": {
31413
+ "text": "string | undefined"
31138
31414
  },
31415
+ "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.",
31416
+ "fieldName": "prefixText",
31139
31417
  "inheritedFrom": {
31140
- "name": "FormfieldWrapper",
31141
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31418
+ "name": "Input",
31419
+ "module": "src/components/input/input.component.ts"
31142
31420
  }
31143
31421
  },
31144
31422
  {
31145
- "kind": "method",
31146
- "name": "renderHelpText",
31147
- "privacy": "protected",
31148
- "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
31149
- "return": {
31150
- "type": {
31151
- "text": ""
31152
- }
31423
+ "name": "leading-icon",
31424
+ "type": {
31425
+ "text": "IconNames | undefined"
31153
31426
  },
31427
+ "description": "The leading icon that is displayed before the input field.",
31428
+ "fieldName": "leadingIcon",
31154
31429
  "inheritedFrom": {
31155
- "name": "FormfieldWrapper",
31156
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31430
+ "name": "Input",
31431
+ "module": "src/components/input/input.component.ts"
31157
31432
  }
31158
31433
  },
31159
31434
  {
31160
- "kind": "method",
31161
- "name": "renderLabel",
31162
- "privacy": "protected",
31163
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
31164
- "return": {
31165
- "type": {
31166
- "text": ""
31167
- }
31435
+ "name": "trailing-button",
31436
+ "type": {
31437
+ "text": "boolean"
31168
31438
  },
31439
+ "default": "false",
31440
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
31441
+ "fieldName": "trailingButton",
31169
31442
  "inheritedFrom": {
31170
- "name": "FormfieldWrapper",
31171
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31443
+ "name": "Input",
31444
+ "module": "src/components/input/input.component.ts"
31172
31445
  }
31173
31446
  },
31174
31447
  {
31175
- "kind": "method",
31176
- "name": "renderHelperText",
31177
- "privacy": "protected",
31178
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
31179
- "return": {
31180
- "type": {
31181
- "text": ""
31182
- }
31448
+ "name": "maxlength",
31449
+ "type": {
31450
+ "text": "number | undefined"
31183
31451
  },
31452
+ "description": "The maximum number of characters that the input field can accept.",
31453
+ "fieldName": "maxlength",
31184
31454
  "inheritedFrom": {
31185
- "name": "FormfieldWrapper",
31186
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31455
+ "name": "Input",
31456
+ "module": "src/components/input/input.component.ts"
31187
31457
  }
31188
- }
31189
- ],
31190
- "events": [
31458
+ },
31191
31459
  {
31192
- "name": "change",
31460
+ "name": "minlength",
31193
31461
  "type": {
31194
- "text": "CustomEvent"
31462
+ "text": "number | undefined"
31195
31463
  },
31196
- "description": "(React: onChange) This event is dispatched when the select is changed.",
31197
- "reactName": "onChange"
31464
+ "description": "The minimum number of characters that the input field can accept.",
31465
+ "fieldName": "minlength",
31466
+ "inheritedFrom": {
31467
+ "name": "Input",
31468
+ "module": "src/components/input/input.component.ts"
31469
+ }
31198
31470
  },
31199
31471
  {
31200
- "name": "input",
31472
+ "name": "autocapitalize",
31201
31473
  "type": {
31202
- "text": "CustomEvent"
31474
+ "text": "AutoCapitalizeType"
31203
31475
  },
31204
- "description": "(React: onInput) This event is dispatched when the select is changed.",
31205
- "reactName": "onInput"
31206
- },
31207
- {
31208
- "description": "(React: onClick) This event is dispatched when the select is clicked.",
31209
- "name": "click",
31210
- "reactName": "onClick"
31211
- },
31212
- {
31213
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
31214
- "name": "keydown",
31215
- "reactName": "onKeyDown"
31476
+ "description": "The autocapitalize attribute of the input field.",
31477
+ "default": "'off'",
31478
+ "fieldName": "autocapitalize",
31479
+ "inheritedFrom": {
31480
+ "name": "Input",
31481
+ "module": "src/components/input/input.component.ts"
31482
+ }
31216
31483
  },
31217
31484
  {
31218
- "description": "(React: onFocus) This event is dispatched when the select receives focus.",
31219
- "name": "focus",
31220
- "reactName": "onFocus"
31221
- }
31222
- ],
31223
- "attributes": [
31224
- {
31225
- "name": "placeholder",
31485
+ "name": "autocomplete",
31226
31486
  "type": {
31227
- "text": "string | undefined"
31487
+ "text": "AutoCompleteType"
31228
31488
  },
31229
- "description": "The placeholder text which will be shown on the text if provided.",
31230
- "fieldName": "placeholder"
31489
+ "description": "The autocomplete attribute of the input field.",
31490
+ "default": "'off'",
31491
+ "fieldName": "autocomplete",
31492
+ "inheritedFrom": {
31493
+ "name": "Input",
31494
+ "module": "src/components/input/input.component.ts"
31495
+ }
31231
31496
  },
31232
31497
  {
31233
- "name": "readonly",
31498
+ "name": "autofocus",
31234
31499
  "type": {
31235
31500
  "text": "boolean"
31236
31501
  },
31237
31502
  "default": "false",
31238
- "description": "readonly attribute of the select field. If true, the select is read-only.",
31239
- "fieldName": "readonly"
31240
- },
31241
- {
31242
- "name": "height",
31243
- "type": {
31244
- "text": "string"
31245
- },
31246
- "default": "'auto'",
31247
- "description": "height attribute of the select field. If set,\nthen a scroll bar will be visible when there more options than the adjusted height.",
31248
- "fieldName": "height"
31249
- },
31250
- {
31251
- "name": "placement",
31252
- "type": {
31253
- "text": "Placement"
31254
- },
31255
- "description": "The placeholder text which will be shown on the text if provided.",
31256
- "fieldName": "placement"
31503
+ "description": "If true, the input field is focused when the component is rendered.",
31504
+ "fieldName": "autofocus",
31505
+ "inheritedFrom": {
31506
+ "name": "Input",
31507
+ "module": "src/components/input/input.component.ts"
31508
+ }
31257
31509
  },
31258
31510
  {
31259
- "name": "soft-disabled",
31511
+ "name": "dirname",
31260
31512
  "type": {
31261
- "text": "boolean | undefined"
31513
+ "text": "string | undefined"
31262
31514
  },
31263
- "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
31264
- "default": "undefined",
31265
- "fieldName": "softDisabled"
31515
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
31516
+ "fieldName": "dirname",
31517
+ "inheritedFrom": {
31518
+ "name": "Input",
31519
+ "module": "src/components/input/input.component.ts"
31520
+ }
31266
31521
  },
31267
31522
  {
31268
- "name": "name",
31523
+ "name": "pattern",
31269
31524
  "type": {
31270
- "text": "string"
31525
+ "text": "string | undefined"
31271
31526
  },
31272
- "default": "''",
31273
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
31274
- "fieldName": "name",
31527
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
31528
+ "fieldName": "pattern",
31275
31529
  "inheritedFrom": {
31276
- "name": "FormInternalsMixin",
31277
- "module": "src/utils/mixins/FormInternalsMixin.ts"
31530
+ "name": "Input",
31531
+ "module": "src/components/input/input.component.ts"
31278
31532
  }
31279
31533
  },
31280
31534
  {
31281
- "name": "value",
31535
+ "name": "list",
31282
31536
  "type": {
31283
- "text": "string"
31537
+ "text": "string | undefined"
31284
31538
  },
31285
- "default": "''",
31286
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
31287
- "fieldName": "value",
31539
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
31540
+ "fieldName": "list",
31288
31541
  "inheritedFrom": {
31289
- "name": "FormInternalsMixin",
31290
- "module": "src/utils/mixins/FormInternalsMixin.ts"
31542
+ "name": "Input",
31543
+ "module": "src/components/input/input.component.ts"
31291
31544
  }
31292
31545
  },
31293
31546
  {
31294
- "name": "validation-message",
31547
+ "name": "size",
31295
31548
  "type": {
31296
- "text": "string | undefined"
31549
+ "text": "number | undefined | undefined"
31297
31550
  },
31298
- "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.",
31299
- "fieldName": "validationMessage",
31551
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
31552
+ "default": "undefined",
31553
+ "fieldName": "size",
31300
31554
  "inheritedFrom": {
31301
- "name": "FormInternalsMixin",
31302
- "module": "src/utils/mixins/FormInternalsMixin.ts"
31555
+ "name": "Input",
31556
+ "module": "src/components/input/input.component.ts"
31303
31557
  }
31304
31558
  },
31305
31559
  {
31306
- "name": "data-aria-label",
31560
+ "name": "clear-aria-label",
31307
31561
  "type": {
31308
- "text": "string | null"
31562
+ "text": "string"
31309
31563
  },
31310
- "default": "null",
31311
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
31312
- "fieldName": "dataAriaLabel",
31564
+ "default": "''",
31565
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
31566
+ "fieldName": "clearAriaLabel",
31313
31567
  "inheritedFrom": {
31314
- "name": "DataAriaLabelMixin",
31315
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
31568
+ "name": "Input",
31569
+ "module": "src/components/input/input.component.ts"
31316
31570
  }
31317
31571
  },
31318
31572
  {
@@ -31428,23 +31682,136 @@
31428
31682
  }
31429
31683
  }
31430
31684
  ],
31431
- "mixins": [
31685
+ "cssProperties": [
31432
31686
  {
31433
- "name": "FormInternalsMixin",
31434
- "module": "/src/utils/mixins/FormInternalsMixin"
31687
+ "description": "Border color for the input container when disabled",
31688
+ "name": "--mdc-input-disabled-border-color",
31689
+ "inheritedFrom": {
31690
+ "name": "Input",
31691
+ "module": "src/components/input/input.component.ts"
31692
+ }
31435
31693
  },
31436
31694
  {
31437
- "name": "DataAriaLabelMixin",
31438
- "module": "/src/utils/mixins/DataAriaLabelMixin"
31695
+ "description": "Text color for the input field when disabled",
31696
+ "name": "--mdc-input-disabled-text-color",
31697
+ "inheritedFrom": {
31698
+ "name": "Input",
31699
+ "module": "src/components/input/input.component.ts"
31700
+ }
31701
+ },
31702
+ {
31703
+ "description": "Background color for the input field when disabled",
31704
+ "name": "--mdc-input-disabled-background-color",
31705
+ "inheritedFrom": {
31706
+ "name": "Input",
31707
+ "module": "src/components/input/input.component.ts"
31708
+ }
31709
+ },
31710
+ {
31711
+ "description": "Border color for the input container",
31712
+ "name": "--mdc-input-border-color",
31713
+ "inheritedFrom": {
31714
+ "name": "Input",
31715
+ "module": "src/components/input/input.component.ts"
31716
+ }
31717
+ },
31718
+ {
31719
+ "description": "Text color for the input field",
31720
+ "name": "--mdc-input-text-color",
31721
+ "inheritedFrom": {
31722
+ "name": "Input",
31723
+ "module": "src/components/input/input.component.ts"
31724
+ }
31725
+ },
31726
+ {
31727
+ "description": "Background color for the input field",
31728
+ "name": "--mdc-input-background-color",
31729
+ "inheritedFrom": {
31730
+ "name": "Input",
31731
+ "module": "src/components/input/input.component.ts"
31732
+ }
31733
+ },
31734
+ {
31735
+ "description": "Background color for the selected text",
31736
+ "name": "--mdc-input-selection-background-color",
31737
+ "inheritedFrom": {
31738
+ "name": "Input",
31739
+ "module": "src/components/input/input.component.ts"
31740
+ }
31741
+ },
31742
+ {
31743
+ "description": "Text color for the selected text",
31744
+ "name": "--mdc-input-selection-text-color",
31745
+ "inheritedFrom": {
31746
+ "name": "Input",
31747
+ "module": "src/components/input/input.component.ts"
31748
+ }
31749
+ },
31750
+ {
31751
+ "description": "Text color for the help text",
31752
+ "name": "--mdc-input-support-text-color",
31753
+ "inheritedFrom": {
31754
+ "name": "Input",
31755
+ "module": "src/components/input/input.component.ts"
31756
+ }
31757
+ },
31758
+ {
31759
+ "description": "Background color for the input field when hovered",
31760
+ "name": "--mdc-input-hover-background-color",
31761
+ "inheritedFrom": {
31762
+ "name": "Input",
31763
+ "module": "src/components/input/input.component.ts"
31764
+ }
31765
+ },
31766
+ {
31767
+ "description": "Background color for the input field when focused",
31768
+ "name": "--mdc-input-focused-background-color",
31769
+ "inheritedFrom": {
31770
+ "name": "Input",
31771
+ "module": "src/components/input/input.component.ts"
31772
+ }
31773
+ },
31774
+ {
31775
+ "description": "Border color for the input container when focused",
31776
+ "name": "--mdc-input-focused-border-color",
31777
+ "inheritedFrom": {
31778
+ "name": "Input",
31779
+ "module": "src/components/input/input.component.ts"
31780
+ }
31781
+ },
31782
+ {
31783
+ "description": "Border color for the input container when error",
31784
+ "name": "--mdc-input-error-border-color",
31785
+ "inheritedFrom": {
31786
+ "name": "Input",
31787
+ "module": "src/components/input/input.component.ts"
31788
+ }
31789
+ },
31790
+ {
31791
+ "description": "Border color for the input container when warning",
31792
+ "name": "--mdc-input-warning-border-color",
31793
+ "inheritedFrom": {
31794
+ "name": "Input",
31795
+ "module": "src/components/input/input.component.ts"
31796
+ }
31797
+ },
31798
+ {
31799
+ "description": "Border color for the input container when success",
31800
+ "name": "--mdc-input-success-border-color",
31801
+ "inheritedFrom": {
31802
+ "name": "Input",
31803
+ "module": "src/components/input/input.component.ts"
31804
+ }
31805
+ },
31806
+ {
31807
+ "description": "Border color for the input container when primary",
31808
+ "name": "--mdc-input-primary-border-color",
31809
+ "inheritedFrom": {
31810
+ "name": "Input",
31811
+ "module": "src/components/input/input.component.ts"
31812
+ }
31439
31813
  }
31440
- ],
31441
- "superclass": {
31442
- "name": "FormfieldWrapper",
31443
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
31444
- },
31445
- "tagName": "mdc-select",
31446
- "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 */",
31447
- "customElement": true
31814
+ ]
31448
31815
  }
31449
31816
  ],
31450
31817
  "exports": [
@@ -31452,510 +31819,434 @@
31452
31819
  "kind": "js",
31453
31820
  "name": "default",
31454
31821
  "declaration": {
31455
- "name": "Select",
31456
- "module": "components/select/select.component.js"
31822
+ "name": "Searchfield",
31823
+ "module": "components/searchfield/searchfield.component.js"
31457
31824
  }
31458
31825
  }
31459
31826
  ]
31460
31827
  },
31461
31828
  {
31462
31829
  "kind": "javascript-module",
31463
- "path": "components/searchfield/searchfield.component.js",
31830
+ "path": "components/select/select.component.js",
31464
31831
  "declarations": [
31465
31832
  {
31466
31833
  "kind": "class",
31467
- "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.",
31468
- "name": "Searchfield",
31834
+ "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.",
31835
+ "name": "Select",
31469
31836
  "slots": [
31470
31837
  {
31471
- "description": "Slot for input chips",
31472
- "name": "filters"
31838
+ "description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
31839
+ "name": "default"
31473
31840
  }
31474
31841
  ],
31475
31842
  "members": [
31476
31843
  {
31477
31844
  "kind": "field",
31478
- "name": "inputChips",
31845
+ "name": "placeholder",
31479
31846
  "type": {
31480
- "text": "Array<HTMLElement> | undefined"
31481
- }
31482
- },
31483
- {
31484
- "kind": "method",
31485
- "name": "handleKeyDown",
31486
- "privacy": "protected",
31487
- "parameters": [
31488
- {
31489
- "name": "event",
31490
- "type": {
31491
- "text": "KeyboardEvent"
31492
- },
31493
- "description": "Keyboard event"
31494
- }
31495
- ],
31496
- "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.",
31497
- "inheritedFrom": {
31498
- "name": "Input",
31499
- "module": "components/input/input.component.js"
31500
- }
31501
- },
31502
- {
31503
- "kind": "method",
31504
- "name": "renderInputChips",
31505
- "privacy": "private",
31506
- "description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
31507
- },
31508
- {
31509
- "kind": "method",
31510
- "name": "clearInputText",
31511
- "privacy": "protected",
31512
- "description": "Clears the input field.",
31513
- "inheritedFrom": {
31514
- "name": "Input",
31515
- "module": "components/input/input.component.js"
31516
- }
31847
+ "text": "string | undefined"
31848
+ },
31849
+ "description": "The placeholder text which will be shown on the text if provided.",
31850
+ "attribute": "placeholder"
31517
31851
  },
31518
31852
  {
31519
31853
  "kind": "field",
31520
- "name": "name",
31854
+ "name": "readonly",
31521
31855
  "type": {
31522
- "text": "string"
31856
+ "text": "boolean"
31523
31857
  },
31524
- "default": "''",
31525
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
31526
- "attribute": "name",
31527
- "reflects": true,
31528
- "inheritedFrom": {
31529
- "name": "FormInternalsMixin",
31530
- "module": "utils/mixins/FormInternalsMixin.js"
31531
- }
31858
+ "default": "false",
31859
+ "description": "readonly attribute of the select field. If true, the select is read-only.",
31860
+ "attribute": "readonly"
31532
31861
  },
31533
31862
  {
31534
31863
  "kind": "field",
31535
- "name": "value",
31864
+ "name": "height",
31536
31865
  "type": {
31537
31866
  "text": "string"
31538
31867
  },
31539
- "default": "''",
31540
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
31541
- "attribute": "value",
31542
- "reflects": true,
31543
- "inheritedFrom": {
31544
- "name": "FormInternalsMixin",
31545
- "module": "utils/mixins/FormInternalsMixin.js"
31546
- }
31868
+ "default": "'auto'",
31869
+ "description": "height attribute of the select field. If set,\nthen a scroll bar will be visible when there more options than the adjusted height.",
31870
+ "attribute": "height"
31547
31871
  },
31548
31872
  {
31549
31873
  "kind": "field",
31550
- "name": "validationMessage",
31874
+ "name": "placement",
31551
31875
  "type": {
31552
- "text": "string | undefined"
31876
+ "text": "Placement"
31553
31877
  },
31554
- "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.",
31555
- "attribute": "validation-message",
31556
- "reflects": true,
31557
- "inheritedFrom": {
31558
- "name": "FormInternalsMixin",
31559
- "module": "utils/mixins/FormInternalsMixin.js"
31560
- }
31878
+ "description": "The placeholder text which will be shown on the text if provided.",
31879
+ "attribute": "placement",
31880
+ "reflects": true
31561
31881
  },
31562
31882
  {
31563
31883
  "kind": "field",
31564
- "name": "validity",
31884
+ "name": "softDisabled",
31565
31885
  "type": {
31566
- "text": "ValidityState"
31886
+ "text": "boolean | undefined"
31567
31887
  },
31568
- "readonly": true,
31569
- "inheritedFrom": {
31570
- "name": "FormInternalsMixin",
31571
- "module": "utils/mixins/FormInternalsMixin.js"
31572
- }
31888
+ "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
31889
+ "default": "undefined",
31890
+ "attribute": "soft-disabled"
31573
31891
  },
31574
31892
  {
31575
- "kind": "field",
31576
- "name": "willValidate",
31577
- "readonly": true,
31578
- "inheritedFrom": {
31579
- "name": "FormInternalsMixin",
31580
- "module": "utils/mixins/FormInternalsMixin.js"
31893
+ "kind": "method",
31894
+ "name": "getAllValidOptions",
31895
+ "privacy": "private",
31896
+ "return": {
31897
+ "type": {
31898
+ "text": "Array<Option>"
31899
+ }
31581
31900
  }
31582
31901
  },
31583
31902
  {
31584
31903
  "kind": "method",
31585
- "name": "setValidity",
31586
- "description": "Sets the validity of the input field based on the input field's validity.",
31904
+ "name": "getFirstValidOption",
31905
+ "privacy": "private",
31587
31906
  "return": {
31588
31907
  "type": {
31589
- "text": ""
31908
+ "text": "Option | null"
31590
31909
  }
31591
- },
31592
- "inheritedFrom": {
31593
- "name": "FormInternalsMixin",
31594
- "module": "utils/mixins/FormInternalsMixin.js"
31595
31910
  }
31596
31911
  },
31597
31912
  {
31598
31913
  "kind": "method",
31599
- "name": "checkValidity",
31914
+ "name": "getLastValidOption",
31915
+ "privacy": "private",
31600
31916
  "return": {
31601
31917
  "type": {
31602
- "text": "boolean"
31918
+ "text": "Option | null"
31603
31919
  }
31604
- },
31605
- "inheritedFrom": {
31606
- "name": "FormInternalsMixin",
31607
- "module": "utils/mixins/FormInternalsMixin.js"
31608
31920
  }
31609
31921
  },
31610
31922
  {
31611
31923
  "kind": "method",
31612
- "name": "reportValidity",
31613
- "inheritedFrom": {
31614
- "name": "FormInternalsMixin",
31615
- "module": "utils/mixins/FormInternalsMixin.js"
31924
+ "name": "getFirstSelectedOption",
31925
+ "privacy": "private",
31926
+ "return": {
31927
+ "type": {
31928
+ "text": "Option | null"
31929
+ }
31616
31930
  }
31617
31931
  },
31618
31932
  {
31619
- "kind": "field",
31620
- "name": "dataAriaLabel",
31621
- "type": {
31622
- "text": "string | null"
31933
+ "kind": "method",
31934
+ "name": "modifyListBoxWrapper",
31935
+ "privacy": "private",
31936
+ "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."
31937
+ },
31938
+ {
31939
+ "kind": "method",
31940
+ "name": "handleOptionsClick",
31941
+ "privacy": "private",
31942
+ "return": {
31943
+ "type": {
31944
+ "text": "void"
31945
+ }
31623
31946
  },
31624
- "default": "null",
31625
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
31626
- "attribute": "data-aria-label",
31627
- "reflects": true,
31628
- "inheritedFrom": {
31629
- "name": "DataAriaLabelMixin",
31630
- "module": "utils/mixins/DataAriaLabelMixin.js"
31631
- }
31947
+ "parameters": [
31948
+ {
31949
+ "name": "event",
31950
+ "type": {
31951
+ "text": "MouseEvent"
31952
+ },
31953
+ "description": "The event which triggered this function."
31954
+ }
31955
+ ],
31956
+ "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."
31632
31957
  },
31633
31958
  {
31634
- "kind": "field",
31635
- "name": "placeholder",
31636
- "type": {
31637
- "text": "string"
31959
+ "kind": "method",
31960
+ "name": "setSelectedOption",
31961
+ "privacy": "private",
31962
+ "return": {
31963
+ "type": {
31964
+ "text": "void"
31965
+ }
31638
31966
  },
31639
- "default": "''",
31640
- "description": "The placeholder text that is displayed when the input field is empty.",
31641
- "attribute": "placeholder",
31642
- "inheritedFrom": {
31643
- "name": "Input",
31644
- "module": "components/input/input.component.js"
31645
- }
31967
+ "parameters": [
31968
+ {
31969
+ "name": "option",
31970
+ "type": {
31971
+ "text": "Option | null"
31972
+ },
31973
+ "description": "The option element in DOM which gets selected."
31974
+ }
31975
+ ],
31976
+ "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."
31646
31977
  },
31647
31978
  {
31648
- "kind": "field",
31649
- "name": "readonly",
31650
- "type": {
31651
- "text": "boolean"
31979
+ "kind": "method",
31980
+ "name": "updateTabIndexForAllOptions",
31981
+ "privacy": "private",
31982
+ "return": {
31983
+ "type": {
31984
+ "text": "void"
31985
+ }
31652
31986
  },
31653
- "default": "false",
31654
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
31655
- "attribute": "readonly",
31656
- "inheritedFrom": {
31657
- "name": "Input",
31658
- "module": "components/input/input.component.js"
31659
- }
31987
+ "parameters": [
31988
+ {
31989
+ "name": "option",
31990
+ "optional": true,
31991
+ "type": {
31992
+ "text": "Option | null"
31993
+ },
31994
+ "description": "The option which tabIndex should be set to 0."
31995
+ }
31996
+ ],
31997
+ "description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
31660
31998
  },
31661
31999
  {
31662
- "kind": "field",
31663
- "name": "prefixText",
31664
- "type": {
31665
- "text": "string | undefined"
32000
+ "kind": "method",
32001
+ "name": "updateSelectedInChildOptions",
32002
+ "privacy": "private",
32003
+ "return": {
32004
+ "type": {
32005
+ "text": "void"
32006
+ }
31666
32007
  },
31667
- "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.",
31668
- "attribute": "prefix-text",
31669
- "inheritedFrom": {
31670
- "name": "Input",
31671
- "module": "components/input/input.component.js"
31672
- }
32008
+ "parameters": [
32009
+ {
32010
+ "name": "selectedOption",
32011
+ "type": {
32012
+ "text": "Option | null"
32013
+ },
32014
+ "description": "The option which gets selected"
32015
+ }
32016
+ ],
32017
+ "description": "Sets selected attribute on the selected option and removes it from all options"
31673
32018
  },
31674
32019
  {
31675
- "kind": "field",
31676
- "name": "leadingIcon",
31677
- "type": {
31678
- "text": "IconNames | undefined"
32020
+ "kind": "method",
32021
+ "name": "fireEvents",
32022
+ "privacy": "private",
32023
+ "return": {
32024
+ "type": {
32025
+ "text": "void"
32026
+ }
31679
32027
  },
31680
- "description": "The leading icon that is displayed before the input field.",
31681
- "attribute": "leading-icon",
31682
- "inheritedFrom": {
31683
- "name": "Input",
31684
- "module": "components/input/input.component.js"
31685
- }
32028
+ "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."
31686
32029
  },
31687
32030
  {
31688
- "kind": "field",
31689
- "name": "trailingButton",
31690
- "type": {
31691
- "text": "boolean"
32031
+ "kind": "method",
32032
+ "name": "dispatchChange",
32033
+ "privacy": "private",
32034
+ "return": {
32035
+ "type": {
32036
+ "text": "void"
32037
+ }
31692
32038
  },
31693
- "default": "false",
31694
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
31695
- "attribute": "trailing-button",
31696
- "inheritedFrom": {
31697
- "name": "Input",
31698
- "module": "components/input/input.component.js"
31699
- }
32039
+ "parameters": [
32040
+ {
32041
+ "name": "option",
32042
+ "type": {
32043
+ "text": "Option"
32044
+ }
32045
+ }
32046
+ ]
31700
32047
  },
31701
32048
  {
31702
- "kind": "field",
31703
- "name": "maxlength",
31704
- "type": {
31705
- "text": "number | undefined"
32049
+ "kind": "method",
32050
+ "name": "dispatchInput",
32051
+ "privacy": "private",
32052
+ "return": {
32053
+ "type": {
32054
+ "text": "void"
32055
+ }
31706
32056
  },
31707
- "description": "The maximum number of characters that the input field can accept.",
31708
- "attribute": "maxlength",
31709
- "inheritedFrom": {
31710
- "name": "Input",
31711
- "module": "components/input/input.component.js"
31712
- }
32057
+ "parameters": [
32058
+ {
32059
+ "name": "option",
32060
+ "type": {
32061
+ "text": "Option"
32062
+ }
32063
+ }
32064
+ ]
31713
32065
  },
31714
32066
  {
31715
- "kind": "field",
31716
- "name": "minlength",
31717
- "type": {
31718
- "text": "number | undefined"
32067
+ "kind": "method",
32068
+ "name": "handleClickCombobox",
32069
+ "privacy": "private",
32070
+ "return": {
32071
+ "type": {
32072
+ "text": "void"
32073
+ }
31719
32074
  },
31720
- "description": "The minimum number of characters that the input field can accept.",
31721
- "attribute": "minlength",
31722
- "inheritedFrom": {
31723
- "name": "Input",
31724
- "module": "components/input/input.component.js"
31725
- }
32075
+ "parameters": [
32076
+ {
32077
+ "name": "event",
32078
+ "type": {
32079
+ "text": "MouseEvent"
32080
+ },
32081
+ "description": "The mouse event which triggered this function."
32082
+ }
32083
+ ],
32084
+ "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."
31726
32085
  },
31727
32086
  {
31728
- "kind": "field",
31729
- "name": "autocapitalize",
31730
- "type": {
31731
- "text": "AutoCapitalizeType"
32087
+ "kind": "method",
32088
+ "name": "handleKeydownCombobox",
32089
+ "privacy": "private",
32090
+ "return": {
32091
+ "type": {
32092
+ "text": "void"
32093
+ }
31732
32094
  },
31733
- "description": "The autocapitalize attribute of the input field.",
31734
- "default": "'off'",
31735
- "attribute": "autocapitalize",
31736
- "inheritedFrom": {
31737
- "name": "Input",
31738
- "module": "components/input/input.component.js"
31739
- }
32095
+ "parameters": [
32096
+ {
32097
+ "name": "event",
32098
+ "type": {
32099
+ "text": "KeyboardEvent"
32100
+ },
32101
+ "description": "The keyboard event."
32102
+ }
32103
+ ],
32104
+ "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."
31740
32105
  },
31741
32106
  {
31742
- "kind": "field",
31743
- "name": "autocomplete",
31744
- "type": {
31745
- "text": "AutoCompleteType"
32107
+ "kind": "method",
32108
+ "name": "handlePopoverKeydown",
32109
+ "privacy": "private",
32110
+ "return": {
32111
+ "type": {
32112
+ "text": "void"
32113
+ }
31746
32114
  },
31747
- "description": "The autocomplete attribute of the input field.",
31748
- "default": "'off'",
31749
- "attribute": "autocomplete",
31750
- "inheritedFrom": {
31751
- "name": "Input",
31752
- "module": "components/input/input.component.js"
31753
- }
32115
+ "parameters": [
32116
+ {
32117
+ "name": "event",
32118
+ "type": {
32119
+ "text": "KeyboardEvent"
32120
+ },
32121
+ "description": "The keyboard event."
32122
+ }
32123
+ ],
32124
+ "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."
31754
32125
  },
31755
32126
  {
31756
- "kind": "field",
31757
- "name": "autofocus",
31758
- "type": {
31759
- "text": "boolean"
32127
+ "kind": "method",
32128
+ "name": "updateState",
32129
+ "privacy": "public",
32130
+ "return": {
32131
+ "type": {
32132
+ "text": "void"
32133
+ }
31760
32134
  },
31761
- "default": "false",
31762
- "description": "If true, the input field is focused when the component is rendered.",
31763
- "attribute": "autofocus",
31764
- "inheritedFrom": {
31765
- "name": "Input",
31766
- "module": "components/input/input.component.js"
31767
- }
32135
+ "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."
31768
32136
  },
31769
32137
  {
31770
32138
  "kind": "field",
31771
- "name": "dirname",
32139
+ "name": "name",
31772
32140
  "type": {
31773
- "text": "string | undefined"
32141
+ "text": "string"
31774
32142
  },
31775
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
31776
- "attribute": "dirname",
32143
+ "default": "''",
32144
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
32145
+ "attribute": "name",
32146
+ "reflects": true,
31777
32147
  "inheritedFrom": {
31778
- "name": "Input",
31779
- "module": "components/input/input.component.js"
32148
+ "name": "FormInternalsMixin",
32149
+ "module": "utils/mixins/FormInternalsMixin.js"
31780
32150
  }
31781
32151
  },
31782
32152
  {
31783
32153
  "kind": "field",
31784
- "name": "pattern",
32154
+ "name": "value",
31785
32155
  "type": {
31786
- "text": "string | undefined"
32156
+ "text": "string"
31787
32157
  },
31788
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
31789
- "attribute": "pattern",
32158
+ "default": "''",
32159
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
32160
+ "attribute": "value",
32161
+ "reflects": true,
31790
32162
  "inheritedFrom": {
31791
- "name": "Input",
31792
- "module": "components/input/input.component.js"
32163
+ "name": "FormInternalsMixin",
32164
+ "module": "utils/mixins/FormInternalsMixin.js"
31793
32165
  }
31794
32166
  },
31795
32167
  {
31796
32168
  "kind": "field",
31797
- "name": "list",
32169
+ "name": "validationMessage",
31798
32170
  "type": {
31799
32171
  "text": "string | undefined"
31800
32172
  },
31801
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
31802
- "attribute": "list",
32173
+ "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.",
32174
+ "attribute": "validation-message",
32175
+ "reflects": true,
31803
32176
  "inheritedFrom": {
31804
- "name": "Input",
31805
- "module": "components/input/input.component.js"
32177
+ "name": "FormInternalsMixin",
32178
+ "module": "utils/mixins/FormInternalsMixin.js"
31806
32179
  }
31807
32180
  },
31808
32181
  {
31809
32182
  "kind": "field",
31810
- "name": "size",
32183
+ "name": "validity",
31811
32184
  "type": {
31812
- "text": "number | undefined | undefined"
32185
+ "text": "ValidityState"
31813
32186
  },
31814
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
31815
- "default": "undefined",
31816
- "attribute": "size",
32187
+ "readonly": true,
31817
32188
  "inheritedFrom": {
31818
- "name": "Input",
31819
- "module": "components/input/input.component.js"
32189
+ "name": "FormInternalsMixin",
32190
+ "module": "utils/mixins/FormInternalsMixin.js"
31820
32191
  }
31821
32192
  },
31822
32193
  {
31823
32194
  "kind": "field",
31824
- "name": "clearAriaLabel",
31825
- "type": {
31826
- "text": "string"
31827
- },
31828
- "default": "''",
31829
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
31830
- "attribute": "clear-aria-label",
31831
- "inheritedFrom": {
31832
- "name": "Input",
31833
- "module": "components/input/input.component.js"
31834
- }
31835
- },
31836
- {
31837
- "kind": "method",
31838
- "name": "setInputValidity",
31839
- "privacy": "private",
31840
- "inheritedFrom": {
31841
- "name": "Input",
31842
- "module": "components/input/input.component.js"
31843
- }
31844
- },
31845
- {
31846
- "kind": "method",
31847
- "name": "updateValue",
31848
- "privacy": "private",
31849
- "description": "Updates the value of the input field.\nSets the form value.",
31850
- "return": {
31851
- "type": {
31852
- "text": ""
31853
- }
31854
- },
31855
- "inheritedFrom": {
31856
- "name": "Input",
31857
- "module": "components/input/input.component.js"
31858
- }
31859
- },
31860
- {
31861
- "kind": "method",
31862
- "name": "onInput",
31863
- "privacy": "private",
31864
- "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
31865
- "inheritedFrom": {
31866
- "name": "Input",
31867
- "module": "components/input/input.component.js"
31868
- }
31869
- },
31870
- {
31871
- "kind": "method",
31872
- "name": "onChange",
31873
- "privacy": "private",
31874
- "parameters": [
31875
- {
31876
- "name": "event",
31877
- "type": {
31878
- "text": "Event"
31879
- },
31880
- "description": "Event which contains information about the value change."
31881
- }
31882
- ],
31883
- "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",
31884
- "inheritedFrom": {
31885
- "name": "Input",
31886
- "module": "components/input/input.component.js"
31887
- }
31888
- },
31889
- {
31890
- "kind": "method",
31891
- "name": "renderLeadingIcon",
31892
- "privacy": "protected",
31893
- "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
31894
- "return": {
31895
- "type": {
31896
- "text": ""
31897
- }
31898
- },
32195
+ "name": "willValidate",
32196
+ "readonly": true,
31899
32197
  "inheritedFrom": {
31900
- "name": "Input",
31901
- "module": "components/input/input.component.js"
32198
+ "name": "FormInternalsMixin",
32199
+ "module": "utils/mixins/FormInternalsMixin.js"
31902
32200
  }
31903
32201
  },
31904
32202
  {
31905
32203
  "kind": "method",
31906
- "name": "renderPrefixText",
31907
- "privacy": "protected",
31908
- "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.",
32204
+ "name": "setValidity",
32205
+ "description": "Sets the validity of the input field based on the input field's validity.",
31909
32206
  "return": {
31910
32207
  "type": {
31911
32208
  "text": ""
31912
32209
  }
31913
32210
  },
31914
32211
  "inheritedFrom": {
31915
- "name": "Input",
31916
- "module": "components/input/input.component.js"
32212
+ "name": "FormInternalsMixin",
32213
+ "module": "utils/mixins/FormInternalsMixin.js"
31917
32214
  }
31918
32215
  },
31919
32216
  {
31920
32217
  "kind": "method",
31921
- "name": "renderTrailingButton",
31922
- "privacy": "protected",
31923
- "parameters": [
31924
- {
31925
- "name": "show",
31926
- "default": "false"
31927
- }
31928
- ],
31929
- "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
32218
+ "name": "checkValidity",
31930
32219
  "return": {
31931
32220
  "type": {
31932
- "text": ""
32221
+ "text": "boolean"
31933
32222
  }
31934
32223
  },
31935
32224
  "inheritedFrom": {
31936
- "name": "Input",
31937
- "module": "components/input/input.component.js"
32225
+ "name": "FormInternalsMixin",
32226
+ "module": "utils/mixins/FormInternalsMixin.js"
31938
32227
  }
31939
32228
  },
31940
32229
  {
31941
32230
  "kind": "method",
31942
- "name": "renderInputElement",
31943
- "privacy": "protected",
31944
- "parameters": [
31945
- {
31946
- "name": "type",
31947
- "type": {
31948
- "text": "InputType"
31949
- }
31950
- },
31951
- {
31952
- "name": "hidePlaceholder",
31953
- "default": "false"
31954
- }
31955
- ],
32231
+ "name": "reportValidity",
31956
32232
  "inheritedFrom": {
31957
- "name": "Input",
31958
- "module": "components/input/input.component.js"
32233
+ "name": "FormInternalsMixin",
32234
+ "module": "utils/mixins/FormInternalsMixin.js"
32235
+ }
32236
+ },
32237
+ {
32238
+ "kind": "field",
32239
+ "name": "dataAriaLabel",
32240
+ "type": {
32241
+ "text": "string | null"
32242
+ },
32243
+ "default": "null",
32244
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
32245
+ "attribute": "data-aria-label",
32246
+ "reflects": true,
32247
+ "inheritedFrom": {
32248
+ "name": "DataAriaLabelMixin",
32249
+ "module": "utils/mixins/DataAriaLabelMixin.js"
31959
32250
  }
31960
32251
  },
31961
32252
  {
@@ -32165,308 +32456,130 @@
32165
32456
  ],
32166
32457
  "events": [
32167
32458
  {
32168
- "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
32169
- "name": "input",
32170
- "reactName": "onInput",
32171
- "inheritedFrom": {
32172
- "name": "Input",
32173
- "module": "src/components/input/input.component.ts"
32174
- }
32175
- },
32176
- {
32177
- "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
32178
32459
  "name": "change",
32179
- "reactName": "onChange",
32180
- "inheritedFrom": {
32181
- "name": "Input",
32182
- "module": "src/components/input/input.component.ts"
32183
- }
32184
- },
32185
- {
32186
- "description": "(React: onFocus) This event is dispatched when the input receives focus.",
32187
- "name": "focus",
32188
- "reactName": "onFocus",
32189
- "inheritedFrom": {
32190
- "name": "Input",
32191
- "module": "src/components/input/input.component.ts"
32192
- }
32193
- },
32194
- {
32195
- "description": "(React: onBlur) This event is dispatched when the input loses focus.",
32196
- "name": "blur",
32197
- "reactName": "onBlur",
32198
- "inheritedFrom": {
32199
- "name": "Input",
32200
- "module": "src/components/input/input.component.ts"
32201
- }
32202
- },
32203
- {
32204
- "name": "clear",
32205
32460
  "type": {
32206
32461
  "text": "CustomEvent"
32207
32462
  },
32208
- "description": "(React: onClear) This event is dispatched when the input text is cleared.",
32209
- "reactName": "onClear",
32210
- "inheritedFrom": {
32211
- "name": "Input",
32212
- "module": "src/components/input/input.component.ts"
32213
- }
32214
- },
32215
- {
32216
- "type": {
32217
- "text": "EventConstructor"
32218
- },
32219
- "inheritedFrom": {
32220
- "name": "Input",
32221
- "module": "src/components/input/input.component.ts"
32222
- }
32223
- }
32224
- ],
32225
- "superclass": {
32226
- "name": "Input",
32227
- "module": "/src/components/input/input.component"
32228
- },
32229
- "tagName": "mdc-searchfield",
32230
- "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 */",
32231
- "customElement": true,
32232
- "attributes": [
32233
- {
32234
- "name": "name",
32235
- "type": {
32236
- "text": "string"
32237
- },
32238
- "default": "''",
32239
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
32240
- "fieldName": "name",
32241
- "inheritedFrom": {
32242
- "name": "FormInternalsMixin",
32243
- "module": "src/utils/mixins/FormInternalsMixin.ts"
32244
- }
32245
- },
32246
- {
32247
- "name": "value",
32248
- "type": {
32249
- "text": "string"
32250
- },
32251
- "default": "''",
32252
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
32253
- "fieldName": "value",
32254
- "inheritedFrom": {
32255
- "name": "FormInternalsMixin",
32256
- "module": "src/utils/mixins/FormInternalsMixin.ts"
32257
- }
32258
- },
32259
- {
32260
- "name": "validation-message",
32261
- "type": {
32262
- "text": "string | undefined"
32263
- },
32264
- "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.",
32265
- "fieldName": "validationMessage",
32266
- "inheritedFrom": {
32267
- "name": "FormInternalsMixin",
32268
- "module": "src/utils/mixins/FormInternalsMixin.ts"
32269
- }
32270
- },
32271
- {
32272
- "name": "data-aria-label",
32273
- "type": {
32274
- "text": "string | null"
32275
- },
32276
- "default": "null",
32277
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
32278
- "fieldName": "dataAriaLabel",
32279
- "inheritedFrom": {
32280
- "name": "DataAriaLabelMixin",
32281
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
32282
- }
32283
- },
32284
- {
32285
- "name": "placeholder",
32286
- "type": {
32287
- "text": "string"
32288
- },
32289
- "default": "''",
32290
- "description": "The placeholder text that is displayed when the input field is empty.",
32291
- "fieldName": "placeholder",
32292
- "inheritedFrom": {
32293
- "name": "Input",
32294
- "module": "src/components/input/input.component.ts"
32295
- }
32296
- },
32297
- {
32298
- "name": "readonly",
32299
- "type": {
32300
- "text": "boolean"
32301
- },
32302
- "default": "false",
32303
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
32304
- "fieldName": "readonly",
32305
- "inheritedFrom": {
32306
- "name": "Input",
32307
- "module": "src/components/input/input.component.ts"
32308
- }
32463
+ "description": "(React: onChange) This event is dispatched when the select is changed.",
32464
+ "reactName": "onChange"
32309
32465
  },
32310
32466
  {
32311
- "name": "prefix-text",
32467
+ "name": "input",
32312
32468
  "type": {
32313
- "text": "string | undefined"
32469
+ "text": "CustomEvent"
32314
32470
  },
32315
- "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.",
32316
- "fieldName": "prefixText",
32317
- "inheritedFrom": {
32318
- "name": "Input",
32319
- "module": "src/components/input/input.component.ts"
32320
- }
32471
+ "description": "(React: onInput) This event is dispatched when the select is changed.",
32472
+ "reactName": "onInput"
32321
32473
  },
32322
32474
  {
32323
- "name": "leading-icon",
32324
- "type": {
32325
- "text": "IconNames | undefined"
32326
- },
32327
- "description": "The leading icon that is displayed before the input field.",
32328
- "fieldName": "leadingIcon",
32329
- "inheritedFrom": {
32330
- "name": "Input",
32331
- "module": "src/components/input/input.component.ts"
32332
- }
32475
+ "description": "(React: onClick) This event is dispatched when the select is clicked.",
32476
+ "name": "click",
32477
+ "reactName": "onClick"
32333
32478
  },
32334
32479
  {
32335
- "name": "trailing-button",
32336
- "type": {
32337
- "text": "boolean"
32338
- },
32339
- "default": "false",
32340
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
32341
- "fieldName": "trailingButton",
32342
- "inheritedFrom": {
32343
- "name": "Input",
32344
- "module": "src/components/input/input.component.ts"
32345
- }
32480
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
32481
+ "name": "keydown",
32482
+ "reactName": "onKeyDown"
32346
32483
  },
32347
32484
  {
32348
- "name": "maxlength",
32349
- "type": {
32350
- "text": "number | undefined"
32351
- },
32352
- "description": "The maximum number of characters that the input field can accept.",
32353
- "fieldName": "maxlength",
32354
- "inheritedFrom": {
32355
- "name": "Input",
32356
- "module": "src/components/input/input.component.ts"
32357
- }
32358
- },
32485
+ "description": "(React: onFocus) This event is dispatched when the select receives focus.",
32486
+ "name": "focus",
32487
+ "reactName": "onFocus"
32488
+ }
32489
+ ],
32490
+ "attributes": [
32359
32491
  {
32360
- "name": "minlength",
32361
- "type": {
32362
- "text": "number | undefined"
32363
- },
32364
- "description": "The minimum number of characters that the input field can accept.",
32365
- "fieldName": "minlength",
32366
- "inheritedFrom": {
32367
- "name": "Input",
32368
- "module": "src/components/input/input.component.ts"
32369
- }
32492
+ "name": "placeholder",
32493
+ "type": {
32494
+ "text": "string | undefined"
32495
+ },
32496
+ "description": "The placeholder text which will be shown on the text if provided.",
32497
+ "fieldName": "placeholder"
32370
32498
  },
32371
32499
  {
32372
- "name": "autocapitalize",
32500
+ "name": "readonly",
32373
32501
  "type": {
32374
- "text": "AutoCapitalizeType"
32502
+ "text": "boolean"
32375
32503
  },
32376
- "description": "The autocapitalize attribute of the input field.",
32377
- "default": "'off'",
32378
- "fieldName": "autocapitalize",
32379
- "inheritedFrom": {
32380
- "name": "Input",
32381
- "module": "src/components/input/input.component.ts"
32382
- }
32504
+ "default": "false",
32505
+ "description": "readonly attribute of the select field. If true, the select is read-only.",
32506
+ "fieldName": "readonly"
32383
32507
  },
32384
32508
  {
32385
- "name": "autocomplete",
32509
+ "name": "height",
32386
32510
  "type": {
32387
- "text": "AutoCompleteType"
32511
+ "text": "string"
32388
32512
  },
32389
- "description": "The autocomplete attribute of the input field.",
32390
- "default": "'off'",
32391
- "fieldName": "autocomplete",
32392
- "inheritedFrom": {
32393
- "name": "Input",
32394
- "module": "src/components/input/input.component.ts"
32395
- }
32513
+ "default": "'auto'",
32514
+ "description": "height attribute of the select field. If set,\nthen a scroll bar will be visible when there more options than the adjusted height.",
32515
+ "fieldName": "height"
32396
32516
  },
32397
32517
  {
32398
- "name": "autofocus",
32518
+ "name": "placement",
32399
32519
  "type": {
32400
- "text": "boolean"
32520
+ "text": "Placement"
32401
32521
  },
32402
- "default": "false",
32403
- "description": "If true, the input field is focused when the component is rendered.",
32404
- "fieldName": "autofocus",
32405
- "inheritedFrom": {
32406
- "name": "Input",
32407
- "module": "src/components/input/input.component.ts"
32408
- }
32522
+ "description": "The placeholder text which will be shown on the text if provided.",
32523
+ "fieldName": "placement"
32409
32524
  },
32410
32525
  {
32411
- "name": "dirname",
32526
+ "name": "soft-disabled",
32412
32527
  "type": {
32413
- "text": "string | undefined"
32528
+ "text": "boolean | undefined"
32414
32529
  },
32415
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
32416
- "fieldName": "dirname",
32417
- "inheritedFrom": {
32418
- "name": "Input",
32419
- "module": "src/components/input/input.component.ts"
32420
- }
32530
+ "description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
32531
+ "default": "undefined",
32532
+ "fieldName": "softDisabled"
32421
32533
  },
32422
32534
  {
32423
- "name": "pattern",
32535
+ "name": "name",
32424
32536
  "type": {
32425
- "text": "string | undefined"
32537
+ "text": "string"
32426
32538
  },
32427
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
32428
- "fieldName": "pattern",
32539
+ "default": "''",
32540
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
32541
+ "fieldName": "name",
32429
32542
  "inheritedFrom": {
32430
- "name": "Input",
32431
- "module": "src/components/input/input.component.ts"
32543
+ "name": "FormInternalsMixin",
32544
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
32432
32545
  }
32433
32546
  },
32434
32547
  {
32435
- "name": "list",
32548
+ "name": "value",
32436
32549
  "type": {
32437
- "text": "string | undefined"
32550
+ "text": "string"
32438
32551
  },
32439
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
32440
- "fieldName": "list",
32552
+ "default": "''",
32553
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
32554
+ "fieldName": "value",
32441
32555
  "inheritedFrom": {
32442
- "name": "Input",
32443
- "module": "src/components/input/input.component.ts"
32556
+ "name": "FormInternalsMixin",
32557
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
32444
32558
  }
32445
32559
  },
32446
32560
  {
32447
- "name": "size",
32561
+ "name": "validation-message",
32448
32562
  "type": {
32449
- "text": "number | undefined | undefined"
32563
+ "text": "string | undefined"
32450
32564
  },
32451
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
32452
- "default": "undefined",
32453
- "fieldName": "size",
32565
+ "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.",
32566
+ "fieldName": "validationMessage",
32454
32567
  "inheritedFrom": {
32455
- "name": "Input",
32456
- "module": "src/components/input/input.component.ts"
32568
+ "name": "FormInternalsMixin",
32569
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
32457
32570
  }
32458
32571
  },
32459
32572
  {
32460
- "name": "clear-aria-label",
32573
+ "name": "data-aria-label",
32461
32574
  "type": {
32462
- "text": "string"
32575
+ "text": "string | null"
32463
32576
  },
32464
- "default": "''",
32465
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
32466
- "fieldName": "clearAriaLabel",
32577
+ "default": "null",
32578
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
32579
+ "fieldName": "dataAriaLabel",
32467
32580
  "inheritedFrom": {
32468
- "name": "Input",
32469
- "module": "src/components/input/input.component.ts"
32581
+ "name": "DataAriaLabelMixin",
32582
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
32470
32583
  }
32471
32584
  },
32472
32585
  {
@@ -32582,136 +32695,23 @@
32582
32695
  }
32583
32696
  }
32584
32697
  ],
32585
- "cssProperties": [
32586
- {
32587
- "description": "Border color for the input container when disabled",
32588
- "name": "--mdc-input-disabled-border-color",
32589
- "inheritedFrom": {
32590
- "name": "Input",
32591
- "module": "src/components/input/input.component.ts"
32592
- }
32593
- },
32594
- {
32595
- "description": "Text color for the input field when disabled",
32596
- "name": "--mdc-input-disabled-text-color",
32597
- "inheritedFrom": {
32598
- "name": "Input",
32599
- "module": "src/components/input/input.component.ts"
32600
- }
32601
- },
32602
- {
32603
- "description": "Background color for the input field when disabled",
32604
- "name": "--mdc-input-disabled-background-color",
32605
- "inheritedFrom": {
32606
- "name": "Input",
32607
- "module": "src/components/input/input.component.ts"
32608
- }
32609
- },
32610
- {
32611
- "description": "Border color for the input container",
32612
- "name": "--mdc-input-border-color",
32613
- "inheritedFrom": {
32614
- "name": "Input",
32615
- "module": "src/components/input/input.component.ts"
32616
- }
32617
- },
32618
- {
32619
- "description": "Text color for the input field",
32620
- "name": "--mdc-input-text-color",
32621
- "inheritedFrom": {
32622
- "name": "Input",
32623
- "module": "src/components/input/input.component.ts"
32624
- }
32625
- },
32626
- {
32627
- "description": "Background color for the input field",
32628
- "name": "--mdc-input-background-color",
32629
- "inheritedFrom": {
32630
- "name": "Input",
32631
- "module": "src/components/input/input.component.ts"
32632
- }
32633
- },
32634
- {
32635
- "description": "Background color for the selected text",
32636
- "name": "--mdc-input-selection-background-color",
32637
- "inheritedFrom": {
32638
- "name": "Input",
32639
- "module": "src/components/input/input.component.ts"
32640
- }
32641
- },
32642
- {
32643
- "description": "Text color for the selected text",
32644
- "name": "--mdc-input-selection-text-color",
32645
- "inheritedFrom": {
32646
- "name": "Input",
32647
- "module": "src/components/input/input.component.ts"
32648
- }
32649
- },
32650
- {
32651
- "description": "Text color for the help text",
32652
- "name": "--mdc-input-support-text-color",
32653
- "inheritedFrom": {
32654
- "name": "Input",
32655
- "module": "src/components/input/input.component.ts"
32656
- }
32657
- },
32658
- {
32659
- "description": "Background color for the input field when hovered",
32660
- "name": "--mdc-input-hover-background-color",
32661
- "inheritedFrom": {
32662
- "name": "Input",
32663
- "module": "src/components/input/input.component.ts"
32664
- }
32665
- },
32666
- {
32667
- "description": "Background color for the input field when focused",
32668
- "name": "--mdc-input-focused-background-color",
32669
- "inheritedFrom": {
32670
- "name": "Input",
32671
- "module": "src/components/input/input.component.ts"
32672
- }
32673
- },
32674
- {
32675
- "description": "Border color for the input container when focused",
32676
- "name": "--mdc-input-focused-border-color",
32677
- "inheritedFrom": {
32678
- "name": "Input",
32679
- "module": "src/components/input/input.component.ts"
32680
- }
32681
- },
32682
- {
32683
- "description": "Border color for the input container when error",
32684
- "name": "--mdc-input-error-border-color",
32685
- "inheritedFrom": {
32686
- "name": "Input",
32687
- "module": "src/components/input/input.component.ts"
32688
- }
32689
- },
32690
- {
32691
- "description": "Border color for the input container when warning",
32692
- "name": "--mdc-input-warning-border-color",
32693
- "inheritedFrom": {
32694
- "name": "Input",
32695
- "module": "src/components/input/input.component.ts"
32696
- }
32697
- },
32698
+ "mixins": [
32698
32699
  {
32699
- "description": "Border color for the input container when success",
32700
- "name": "--mdc-input-success-border-color",
32701
- "inheritedFrom": {
32702
- "name": "Input",
32703
- "module": "src/components/input/input.component.ts"
32704
- }
32700
+ "name": "FormInternalsMixin",
32701
+ "module": "/src/utils/mixins/FormInternalsMixin"
32705
32702
  },
32706
32703
  {
32707
- "description": "Border color for the input container when primary",
32708
- "name": "--mdc-input-primary-border-color",
32709
- "inheritedFrom": {
32710
- "name": "Input",
32711
- "module": "src/components/input/input.component.ts"
32712
- }
32704
+ "name": "DataAriaLabelMixin",
32705
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
32713
32706
  }
32714
- ]
32707
+ ],
32708
+ "superclass": {
32709
+ "name": "FormfieldWrapper",
32710
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
32711
+ },
32712
+ "tagName": "mdc-select",
32713
+ "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 */",
32714
+ "customElement": true
32715
32715
  }
32716
32716
  ],
32717
32717
  "exports": [
@@ -32719,8 +32719,8 @@
32719
32719
  "kind": "js",
32720
32720
  "name": "default",
32721
32721
  "declaration": {
32722
- "name": "Searchfield",
32723
- "module": "components/searchfield/searchfield.component.js"
32722
+ "name": "Select",
32723
+ "module": "components/select/select.component.js"
32724
32724
  }
32725
32725
  }
32726
32726
  ]