@momentum-design/components 0.102.5 → 0.102.7
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.
- package/dist/browser/index.js +1 -1
- package/dist/browser/index.js.map +3 -3
- package/dist/components/radio/radio.component.d.ts +0 -7
- package/dist/components/radio/radio.component.js +7 -17
- package/dist/custom-elements.json +1304 -1340
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
@@ -17787,15 +17787,15 @@
|
|
17787
17787
|
},
|
17788
17788
|
{
|
17789
17789
|
"kind": "javascript-module",
|
17790
|
-
"path": "components/
|
17790
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
17791
17791
|
"declarations": [
|
17792
17792
|
{
|
17793
17793
|
"kind": "class",
|
17794
|
-
"description": "
|
17795
|
-
"name": "
|
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",
|
17796
17796
|
"slots": [
|
17797
17797
|
{
|
17798
|
-
"description": "slot for menu item controls to appear of leading end.",
|
17798
|
+
"description": "slot for menu item checkbox 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 primary label.",
|
17806
|
+
"description": "slot for menu item checkbox 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 secondary label.",
|
17814
|
+
"description": "slot for menu item checkbox 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 tertiary label.",
|
17822
|
+
"description": "slot for menu item checkbox 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 side header text.",
|
17830
|
+
"description": "slot for menu item checkbox 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 subline text.",
|
17838
|
+
"description": "slot for menu item checkbox 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 controls to appear of trailing end.",
|
17846
|
+
"description": "slot for menu item checkbox controls to appear of trailing end.",
|
17847
17847
|
"name": "trailing-controls",
|
17848
17848
|
"inheritedFrom": {
|
17849
17849
|
"name": "ListItem",
|
@@ -17860,6 +17860,67 @@
|
|
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
|
+
},
|
17863
17924
|
{
|
17864
17925
|
"kind": "field",
|
17865
17926
|
"name": "arrowPosition",
|
@@ -17868,7 +17929,11 @@
|
|
17868
17929
|
},
|
17869
17930
|
"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.",
|
17870
17931
|
"attribute": "arrow-position",
|
17871
|
-
"reflects": true
|
17932
|
+
"reflects": true,
|
17933
|
+
"inheritedFrom": {
|
17934
|
+
"name": "MenuItem",
|
17935
|
+
"module": "components/menuitem/menuitem.component.js"
|
17936
|
+
}
|
17872
17937
|
},
|
17873
17938
|
{
|
17874
17939
|
"kind": "field",
|
@@ -17878,7 +17943,11 @@
|
|
17878
17943
|
},
|
17879
17944
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
17880
17945
|
"attribute": "arrow-direction",
|
17881
|
-
"reflects": true
|
17946
|
+
"reflects": true,
|
17947
|
+
"inheritedFrom": {
|
17948
|
+
"name": "MenuItem",
|
17949
|
+
"module": "components/menuitem/menuitem.component.js"
|
17950
|
+
}
|
17882
17951
|
},
|
17883
17952
|
{
|
17884
17953
|
"kind": "field",
|
@@ -17889,7 +17958,11 @@
|
|
17889
17958
|
"default": "undefined",
|
17890
17959
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
17891
17960
|
"attribute": "name",
|
17892
|
-
"reflects": true
|
17961
|
+
"reflects": true,
|
17962
|
+
"inheritedFrom": {
|
17963
|
+
"name": "MenuItem",
|
17964
|
+
"module": "components/menuitem/menuitem.component.js"
|
17965
|
+
}
|
17893
17966
|
},
|
17894
17967
|
{
|
17895
17968
|
"kind": "field",
|
@@ -17900,7 +17973,11 @@
|
|
17900
17973
|
"default": "undefined",
|
17901
17974
|
"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.",
|
17902
17975
|
"attribute": "value",
|
17903
|
-
"reflects": true
|
17976
|
+
"reflects": true,
|
17977
|
+
"inheritedFrom": {
|
17978
|
+
"name": "MenuItem",
|
17979
|
+
"module": "components/menuitem/menuitem.component.js"
|
17980
|
+
}
|
17904
17981
|
},
|
17905
17982
|
{
|
17906
17983
|
"kind": "method",
|
@@ -17944,7 +18021,11 @@
|
|
17944
18021
|
"description": "The keyboard event that triggered the action."
|
17945
18022
|
}
|
17946
18023
|
],
|
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."
|
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
|
+
}
|
17948
18029
|
},
|
17949
18030
|
{
|
17950
18031
|
"kind": "method",
|
@@ -18281,7 +18362,15 @@
|
|
18281
18362
|
],
|
18282
18363
|
"events": [
|
18283
18364
|
{
|
18284
|
-
"
|
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.",
|
18285
18374
|
"name": "click",
|
18286
18375
|
"reactName": "onClick",
|
18287
18376
|
"inheritedFrom": {
|
@@ -18290,27 +18379,27 @@
|
|
18290
18379
|
}
|
18291
18380
|
},
|
18292
18381
|
{
|
18293
|
-
"description": "(React:
|
18294
|
-
"name": "
|
18295
|
-
"reactName": "
|
18382
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
18383
|
+
"name": "focus",
|
18384
|
+
"reactName": "onFocus",
|
18296
18385
|
"inheritedFrom": {
|
18297
18386
|
"name": "ListItem",
|
18298
18387
|
"module": "src/components/listitem/listitem.component.ts"
|
18299
18388
|
}
|
18300
18389
|
},
|
18301
18390
|
{
|
18302
|
-
"description": "(React:
|
18303
|
-
"name": "
|
18304
|
-
"reactName": "
|
18391
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
18392
|
+
"name": "keydown",
|
18393
|
+
"reactName": "onKeyDown",
|
18305
18394
|
"inheritedFrom": {
|
18306
18395
|
"name": "ListItem",
|
18307
18396
|
"module": "src/components/listitem/listitem.component.ts"
|
18308
18397
|
}
|
18309
18398
|
},
|
18310
18399
|
{
|
18311
|
-
"description": "(React:
|
18312
|
-
"name": "
|
18313
|
-
"reactName": "
|
18400
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
|
18401
|
+
"name": "keyup",
|
18402
|
+
"reactName": "onKeyUp",
|
18314
18403
|
"inheritedFrom": {
|
18315
18404
|
"name": "ListItem",
|
18316
18405
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -18354,13 +18443,35 @@
|
|
18354
18443
|
}
|
18355
18444
|
],
|
18356
18445
|
"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
|
+
},
|
18357
18464
|
{
|
18358
18465
|
"name": "arrow-position",
|
18359
18466
|
"type": {
|
18360
18467
|
"text": "ArrowPositions | undefined"
|
18361
18468
|
},
|
18362
18469
|
"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.",
|
18363
|
-
"fieldName": "arrowPosition"
|
18470
|
+
"fieldName": "arrowPosition",
|
18471
|
+
"inheritedFrom": {
|
18472
|
+
"name": "MenuItem",
|
18473
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18474
|
+
}
|
18364
18475
|
},
|
18365
18476
|
{
|
18366
18477
|
"name": "arrow-direction",
|
@@ -18368,7 +18479,11 @@
|
|
18368
18479
|
"text": "ArrowDirections | undefined"
|
18369
18480
|
},
|
18370
18481
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
18371
|
-
"fieldName": "arrowDirection"
|
18482
|
+
"fieldName": "arrowDirection",
|
18483
|
+
"inheritedFrom": {
|
18484
|
+
"name": "MenuItem",
|
18485
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18486
|
+
}
|
18372
18487
|
},
|
18373
18488
|
{
|
18374
18489
|
"name": "name",
|
@@ -18377,7 +18492,11 @@
|
|
18377
18492
|
},
|
18378
18493
|
"default": "undefined",
|
18379
18494
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
18380
|
-
"fieldName": "name"
|
18495
|
+
"fieldName": "name",
|
18496
|
+
"inheritedFrom": {
|
18497
|
+
"name": "MenuItem",
|
18498
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18499
|
+
}
|
18381
18500
|
},
|
18382
18501
|
{
|
18383
18502
|
"name": "value",
|
@@ -18386,7 +18505,11 @@
|
|
18386
18505
|
},
|
18387
18506
|
"default": "undefined",
|
18388
18507
|
"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.",
|
18389
|
-
"fieldName": "value"
|
18508
|
+
"fieldName": "value",
|
18509
|
+
"inheritedFrom": {
|
18510
|
+
"name": "MenuItem",
|
18511
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18512
|
+
}
|
18390
18513
|
},
|
18391
18514
|
{
|
18392
18515
|
"name": "disabled",
|
@@ -18527,11 +18650,11 @@
|
|
18527
18650
|
}
|
18528
18651
|
],
|
18529
18652
|
"superclass": {
|
18530
|
-
"name": "
|
18531
|
-
"module": "/src/components/
|
18653
|
+
"name": "MenuItem",
|
18654
|
+
"module": "/src/components/menuitem/menuitem.component"
|
18532
18655
|
},
|
18533
|
-
"tagName": "mdc-
|
18534
|
-
"jsDoc": "/**\n *
|
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 */",
|
18535
18658
|
"customElement": true,
|
18536
18659
|
"cssProperties": [
|
18537
18660
|
{
|
@@ -18638,23 +18761,23 @@
|
|
18638
18761
|
"kind": "js",
|
18639
18762
|
"name": "default",
|
18640
18763
|
"declaration": {
|
18641
|
-
"name": "
|
18642
|
-
"module": "components/
|
18764
|
+
"name": "MenuItemCheckbox",
|
18765
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
18643
18766
|
}
|
18644
18767
|
}
|
18645
18768
|
]
|
18646
18769
|
},
|
18647
18770
|
{
|
18648
18771
|
"kind": "javascript-module",
|
18649
|
-
"path": "components/
|
18772
|
+
"path": "components/menuitem/menuitem.component.js",
|
18650
18773
|
"declarations": [
|
18651
18774
|
{
|
18652
18775
|
"kind": "class",
|
18653
|
-
"description": "
|
18654
|
-
"name": "
|
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",
|
18655
18778
|
"slots": [
|
18656
18779
|
{
|
18657
|
-
"description": "slot for menu item
|
18780
|
+
"description": "slot for menu item controls to appear of leading end.",
|
18658
18781
|
"name": "leading-controls",
|
18659
18782
|
"inheritedFrom": {
|
18660
18783
|
"name": "ListItem",
|
@@ -18662,7 +18785,7 @@
|
|
18662
18785
|
}
|
18663
18786
|
},
|
18664
18787
|
{
|
18665
|
-
"description": "slot for menu item
|
18788
|
+
"description": "slot for menu item primary label.",
|
18666
18789
|
"name": "leading-text-primary-label",
|
18667
18790
|
"inheritedFrom": {
|
18668
18791
|
"name": "ListItem",
|
@@ -18670,7 +18793,7 @@
|
|
18670
18793
|
}
|
18671
18794
|
},
|
18672
18795
|
{
|
18673
|
-
"description": "slot for menu item
|
18796
|
+
"description": "slot for menu item secondary label.",
|
18674
18797
|
"name": "leading-text-secondary-label",
|
18675
18798
|
"inheritedFrom": {
|
18676
18799
|
"name": "ListItem",
|
@@ -18678,7 +18801,7 @@
|
|
18678
18801
|
}
|
18679
18802
|
},
|
18680
18803
|
{
|
18681
|
-
"description": "slot for menu item
|
18804
|
+
"description": "slot for menu item tertiary label.",
|
18682
18805
|
"name": "leading-text-tertiary-label",
|
18683
18806
|
"inheritedFrom": {
|
18684
18807
|
"name": "ListItem",
|
@@ -18686,7 +18809,7 @@
|
|
18686
18809
|
}
|
18687
18810
|
},
|
18688
18811
|
{
|
18689
|
-
"description": "slot for menu item
|
18812
|
+
"description": "slot for menu item side header text.",
|
18690
18813
|
"name": "trailing-text-side-header",
|
18691
18814
|
"inheritedFrom": {
|
18692
18815
|
"name": "ListItem",
|
@@ -18694,7 +18817,7 @@
|
|
18694
18817
|
}
|
18695
18818
|
},
|
18696
18819
|
{
|
18697
|
-
"description": "slot for menu item
|
18820
|
+
"description": "slot for menu item subline text.",
|
18698
18821
|
"name": "trailing-text-subline",
|
18699
18822
|
"inheritedFrom": {
|
18700
18823
|
"name": "ListItem",
|
@@ -18702,7 +18825,7 @@
|
|
18702
18825
|
}
|
18703
18826
|
},
|
18704
18827
|
{
|
18705
|
-
"description": "slot for menu item
|
18828
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
18706
18829
|
"name": "trailing-controls",
|
18707
18830
|
"inheritedFrom": {
|
18708
18831
|
"name": "ListItem",
|
@@ -18721,107 +18844,34 @@
|
|
18721
18844
|
"members": [
|
18722
18845
|
{
|
18723
18846
|
"kind": "field",
|
18724
|
-
"name": "
|
18847
|
+
"name": "arrowPosition",
|
18725
18848
|
"type": {
|
18726
|
-
"text": "
|
18849
|
+
"text": "ArrowPositions | undefined"
|
18727
18850
|
},
|
18728
|
-
"
|
18729
|
-
"
|
18730
|
-
"attribute": "checked",
|
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",
|
18731
18853
|
"reflects": true
|
18732
18854
|
},
|
18733
18855
|
{
|
18734
18856
|
"kind": "field",
|
18735
|
-
"name": "
|
18857
|
+
"name": "arrowDirection",
|
18736
18858
|
"type": {
|
18737
|
-
"text": "
|
18859
|
+
"text": "ArrowDirections | undefined"
|
18738
18860
|
},
|
18739
|
-
"description": "
|
18740
|
-
"
|
18741
|
-
"attribute": "indicator",
|
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",
|
18742
18863
|
"reflects": true
|
18743
18864
|
},
|
18744
18865
|
{
|
18745
|
-
"kind": "
|
18746
|
-
"name": "
|
18747
|
-
"
|
18748
|
-
|
18749
|
-
},
|
18750
|
-
{
|
18751
|
-
"kind": "method",
|
18752
|
-
"name": "staticCheckbox",
|
18753
|
-
"privacy": "private",
|
18754
|
-
"return": {
|
18755
|
-
"type": {
|
18756
|
-
"text": ""
|
18757
|
-
}
|
18866
|
+
"kind": "field",
|
18867
|
+
"name": "name",
|
18868
|
+
"type": {
|
18869
|
+
"text": "undefined | string | undefined"
|
18758
18870
|
},
|
18759
|
-
"
|
18760
|
-
|
18761
|
-
|
18762
|
-
"
|
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
|
-
}
|
18871
|
+
"default": "undefined",
|
18872
|
+
"description": "The name attribute is used to identify the menu item when it is selected.",
|
18873
|
+
"attribute": "name",
|
18874
|
+
"reflects": true
|
18825
18875
|
},
|
18826
18876
|
{
|
18827
18877
|
"kind": "field",
|
@@ -18832,11 +18882,7 @@
|
|
18832
18882
|
"default": "undefined",
|
18833
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.",
|
18834
18884
|
"attribute": "value",
|
18835
|
-
"reflects": true
|
18836
|
-
"inheritedFrom": {
|
18837
|
-
"name": "MenuItem",
|
18838
|
-
"module": "components/menuitem/menuitem.component.js"
|
18839
|
-
}
|
18885
|
+
"reflects": true
|
18840
18886
|
},
|
18841
18887
|
{
|
18842
18888
|
"kind": "method",
|
@@ -18880,11 +18926,7 @@
|
|
18880
18926
|
"description": "The keyboard event that triggered the action."
|
18881
18927
|
}
|
18882
18928
|
],
|
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
|
-
}
|
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."
|
18888
18930
|
},
|
18889
18931
|
{
|
18890
18932
|
"kind": "method",
|
@@ -19221,15 +19263,7 @@
|
|
19221
19263
|
],
|
19222
19264
|
"events": [
|
19223
19265
|
{
|
19224
|
-
"
|
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.",
|
19266
|
+
"description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
|
19233
19267
|
"name": "click",
|
19234
19268
|
"reactName": "onClick",
|
19235
19269
|
"inheritedFrom": {
|
@@ -19237,15 +19271,6 @@
|
|
19237
19271
|
"module": "src/components/listitem/listitem.component.ts"
|
19238
19272
|
}
|
19239
19273
|
},
|
19240
|
-
{
|
19241
|
-
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
19242
|
-
"name": "focus",
|
19243
|
-
"reactName": "onFocus",
|
19244
|
-
"inheritedFrom": {
|
19245
|
-
"name": "ListItem",
|
19246
|
-
"module": "src/components/listitem/listitem.component.ts"
|
19247
|
-
}
|
19248
|
-
},
|
19249
19274
|
{
|
19250
19275
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
19251
19276
|
"name": "keydown",
|
@@ -19264,6 +19289,15 @@
|
|
19264
19289
|
"module": "src/components/listitem/listitem.component.ts"
|
19265
19290
|
}
|
19266
19291
|
},
|
19292
|
+
{
|
19293
|
+
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
19294
|
+
"name": "focus",
|
19295
|
+
"reactName": "onFocus",
|
19296
|
+
"inheritedFrom": {
|
19297
|
+
"name": "ListItem",
|
19298
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19299
|
+
}
|
19300
|
+
},
|
19267
19301
|
{
|
19268
19302
|
"description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
|
19269
19303
|
"name": "enabled",
|
@@ -19302,35 +19336,13 @@
|
|
19302
19336
|
}
|
19303
19337
|
],
|
19304
19338
|
"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
|
-
},
|
19323
19339
|
{
|
19324
19340
|
"name": "arrow-position",
|
19325
19341
|
"type": {
|
19326
19342
|
"text": "ArrowPositions | undefined"
|
19327
19343
|
},
|
19328
19344
|
"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.",
|
19329
|
-
"fieldName": "arrowPosition"
|
19330
|
-
"inheritedFrom": {
|
19331
|
-
"name": "MenuItem",
|
19332
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19333
|
-
}
|
19345
|
+
"fieldName": "arrowPosition"
|
19334
19346
|
},
|
19335
19347
|
{
|
19336
19348
|
"name": "arrow-direction",
|
@@ -19338,11 +19350,7 @@
|
|
19338
19350
|
"text": "ArrowDirections | undefined"
|
19339
19351
|
},
|
19340
19352
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
19341
|
-
"fieldName": "arrowDirection"
|
19342
|
-
"inheritedFrom": {
|
19343
|
-
"name": "MenuItem",
|
19344
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19345
|
-
}
|
19353
|
+
"fieldName": "arrowDirection"
|
19346
19354
|
},
|
19347
19355
|
{
|
19348
19356
|
"name": "name",
|
@@ -19351,11 +19359,7 @@
|
|
19351
19359
|
},
|
19352
19360
|
"default": "undefined",
|
19353
19361
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
19354
|
-
"fieldName": "name"
|
19355
|
-
"inheritedFrom": {
|
19356
|
-
"name": "MenuItem",
|
19357
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19358
|
-
}
|
19362
|
+
"fieldName": "name"
|
19359
19363
|
},
|
19360
19364
|
{
|
19361
19365
|
"name": "value",
|
@@ -19364,11 +19368,7 @@
|
|
19364
19368
|
},
|
19365
19369
|
"default": "undefined",
|
19366
19370
|
"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.",
|
19367
|
-
"fieldName": "value"
|
19368
|
-
"inheritedFrom": {
|
19369
|
-
"name": "MenuItem",
|
19370
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19371
|
-
}
|
19371
|
+
"fieldName": "value"
|
19372
19372
|
},
|
19373
19373
|
{
|
19374
19374
|
"name": "disabled",
|
@@ -19509,11 +19509,11 @@
|
|
19509
19509
|
}
|
19510
19510
|
],
|
19511
19511
|
"superclass": {
|
19512
|
-
"name": "
|
19513
|
-
"module": "/src/components/
|
19512
|
+
"name": "ListItem",
|
19513
|
+
"module": "/src/components/listitem/listitem.component"
|
19514
19514
|
},
|
19515
|
-
"tagName": "mdc-
|
19516
|
-
"jsDoc": "/**\n *
|
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 */",
|
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": "
|
19624
|
-
"module": "components/
|
19623
|
+
"name": "MenuItem",
|
19624
|
+
"module": "components/menuitem/menuitem.component.js"
|
19625
19625
|
}
|
19626
19626
|
}
|
19627
19627
|
]
|
@@ -29315,25 +29315,6 @@
|
|
29315
29315
|
},
|
29316
29316
|
"description": "Returns all radios within the same group (name)."
|
29317
29317
|
},
|
29318
|
-
{
|
29319
|
-
"kind": "method",
|
29320
|
-
"name": "dispatchChangeEvent",
|
29321
|
-
"privacy": "private",
|
29322
|
-
"return": {
|
29323
|
-
"type": {
|
29324
|
-
"text": "void"
|
29325
|
-
}
|
29326
|
-
},
|
29327
|
-
"parameters": [
|
29328
|
-
{
|
29329
|
-
"name": "event",
|
29330
|
-
"type": {
|
29331
|
-
"text": "Event"
|
29332
|
-
}
|
29333
|
-
}
|
29334
|
-
],
|
29335
|
-
"description": "The '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"
|
29336
|
-
},
|
29337
29318
|
{
|
29338
29319
|
"kind": "method",
|
29339
29320
|
"name": "setGroupValidity",
|
@@ -29371,14 +29352,6 @@
|
|
29371
29352
|
"text": "void"
|
29372
29353
|
}
|
29373
29354
|
},
|
29374
|
-
"parameters": [
|
29375
|
-
{
|
29376
|
-
"name": "event",
|
29377
|
-
"type": {
|
29378
|
-
"text": "Event"
|
29379
|
-
}
|
29380
|
-
}
|
29381
|
-
],
|
29382
29355
|
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
29383
29356
|
},
|
29384
29357
|
{
|
@@ -29399,13 +29372,6 @@
|
|
29399
29372
|
"text": "number"
|
29400
29373
|
},
|
29401
29374
|
"description": "The index of the radio button to be updated within the enabled radios array."
|
29402
|
-
},
|
29403
|
-
{
|
29404
|
-
"name": "event",
|
29405
|
-
"type": {
|
29406
|
-
"text": "Event"
|
29407
|
-
},
|
29408
|
-
"description": "The event that triggered the update."
|
29409
29375
|
}
|
29410
29376
|
],
|
29411
29377
|
"description": "Updates the state of the radio button at the specified index within the enabled radios.\nFocuses the radio button and triggers the change event if the radio button is not read-only."
|
@@ -29767,13 +29733,11 @@
|
|
29767
29733
|
],
|
29768
29734
|
"events": [
|
29769
29735
|
{
|
29736
|
+
"name": "change",
|
29770
29737
|
"type": {
|
29771
|
-
"text": "
|
29772
|
-
}
|
29773
|
-
},
|
29774
|
-
{
|
29738
|
+
"text": "Event"
|
29739
|
+
},
|
29775
29740
|
"description": "(React: onChange) Event that gets dispatched when the radio state changes.",
|
29776
|
-
"name": "change",
|
29777
29741
|
"reactName": "onChange"
|
29778
29742
|
},
|
29779
29743
|
{
|
@@ -30596,502 +30560,426 @@
|
|
30596
30560
|
},
|
30597
30561
|
{
|
30598
30562
|
"kind": "javascript-module",
|
30599
|
-
"path": "components/
|
30563
|
+
"path": "components/select/select.component.js",
|
30600
30564
|
"declarations": [
|
30601
30565
|
{
|
30602
30566
|
"kind": "class",
|
30603
|
-
"description": "
|
30604
|
-
"name": "
|
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",
|
30605
30569
|
"slots": [
|
30606
30570
|
{
|
30607
|
-
"description": "
|
30608
|
-
"name": "
|
30571
|
+
"description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
|
30572
|
+
"name": "default"
|
30609
30573
|
}
|
30610
30574
|
],
|
30611
30575
|
"members": [
|
30612
30576
|
{
|
30613
30577
|
"kind": "field",
|
30614
|
-
"name": "
|
30578
|
+
"name": "placeholder",
|
30615
30579
|
"type": {
|
30616
|
-
"text": "
|
30617
|
-
}
|
30618
|
-
|
30619
|
-
|
30620
|
-
"kind": "method",
|
30621
|
-
"name": "handleKeyDown",
|
30622
|
-
"privacy": "protected",
|
30623
|
-
"parameters": [
|
30624
|
-
{
|
30625
|
-
"name": "event",
|
30626
|
-
"type": {
|
30627
|
-
"text": "KeyboardEvent"
|
30628
|
-
},
|
30629
|
-
"description": "Keyboard event"
|
30630
|
-
}
|
30631
|
-
],
|
30632
|
-
"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.",
|
30633
|
-
"inheritedFrom": {
|
30634
|
-
"name": "Input",
|
30635
|
-
"module": "components/input/input.component.js"
|
30636
|
-
}
|
30637
|
-
},
|
30638
|
-
{
|
30639
|
-
"kind": "method",
|
30640
|
-
"name": "renderInputChips",
|
30641
|
-
"privacy": "private",
|
30642
|
-
"description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
|
30580
|
+
"text": "string | undefined"
|
30581
|
+
},
|
30582
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
30583
|
+
"attribute": "placeholder"
|
30643
30584
|
},
|
30644
30585
|
{
|
30645
|
-
"kind": "
|
30646
|
-
"name": "
|
30647
|
-
"
|
30648
|
-
|
30649
|
-
|
30650
|
-
|
30651
|
-
|
30652
|
-
|
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"
|
30653
30594
|
},
|
30654
30595
|
{
|
30655
30596
|
"kind": "field",
|
30656
|
-
"name": "
|
30597
|
+
"name": "height",
|
30657
30598
|
"type": {
|
30658
30599
|
"text": "string"
|
30659
30600
|
},
|
30660
|
-
"default": "''",
|
30661
|
-
"description": "
|
30662
|
-
"attribute": "
|
30663
|
-
"reflects": true,
|
30664
|
-
"inheritedFrom": {
|
30665
|
-
"name": "FormInternalsMixin",
|
30666
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30667
|
-
}
|
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"
|
30668
30604
|
},
|
30669
30605
|
{
|
30670
30606
|
"kind": "field",
|
30671
|
-
"name": "
|
30607
|
+
"name": "placement",
|
30672
30608
|
"type": {
|
30673
|
-
"text": "
|
30609
|
+
"text": "Placement"
|
30674
30610
|
},
|
30675
|
-
"
|
30676
|
-
"
|
30677
|
-
"
|
30678
|
-
"reflects": true,
|
30679
|
-
"inheritedFrom": {
|
30680
|
-
"name": "FormInternalsMixin",
|
30681
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30682
|
-
}
|
30611
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
30612
|
+
"attribute": "placement",
|
30613
|
+
"reflects": true
|
30683
30614
|
},
|
30684
30615
|
{
|
30685
30616
|
"kind": "field",
|
30686
|
-
"name": "
|
30617
|
+
"name": "softDisabled",
|
30687
30618
|
"type": {
|
30688
|
-
"text": "
|
30619
|
+
"text": "boolean | undefined"
|
30689
30620
|
},
|
30690
|
-
"description": "
|
30691
|
-
"
|
30692
|
-
"
|
30693
|
-
"inheritedFrom": {
|
30694
|
-
"name": "FormInternalsMixin",
|
30695
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30696
|
-
}
|
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"
|
30697
30624
|
},
|
30698
30625
|
{
|
30699
|
-
"kind": "
|
30700
|
-
"name": "
|
30701
|
-
"
|
30702
|
-
|
30703
|
-
|
30704
|
-
|
30705
|
-
|
30706
|
-
"name": "FormInternalsMixin",
|
30707
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30626
|
+
"kind": "method",
|
30627
|
+
"name": "getAllValidOptions",
|
30628
|
+
"privacy": "private",
|
30629
|
+
"return": {
|
30630
|
+
"type": {
|
30631
|
+
"text": "Array<Option>"
|
30632
|
+
}
|
30708
30633
|
}
|
30709
30634
|
},
|
30710
30635
|
{
|
30711
|
-
"kind": "
|
30712
|
-
"name": "
|
30713
|
-
"
|
30714
|
-
"
|
30715
|
-
"
|
30716
|
-
|
30636
|
+
"kind": "method",
|
30637
|
+
"name": "getFirstValidOption",
|
30638
|
+
"privacy": "private",
|
30639
|
+
"return": {
|
30640
|
+
"type": {
|
30641
|
+
"text": "Option | null"
|
30642
|
+
}
|
30717
30643
|
}
|
30718
30644
|
},
|
30719
30645
|
{
|
30720
30646
|
"kind": "method",
|
30721
|
-
"name": "
|
30722
|
-
"
|
30647
|
+
"name": "getLastValidOption",
|
30648
|
+
"privacy": "private",
|
30723
30649
|
"return": {
|
30724
30650
|
"type": {
|
30725
|
-
"text": ""
|
30651
|
+
"text": "Option | null"
|
30726
30652
|
}
|
30727
|
-
},
|
30728
|
-
"inheritedFrom": {
|
30729
|
-
"name": "FormInternalsMixin",
|
30730
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30731
30653
|
}
|
30732
30654
|
},
|
30733
30655
|
{
|
30734
30656
|
"kind": "method",
|
30735
|
-
"name": "
|
30657
|
+
"name": "getFirstSelectedOption",
|
30658
|
+
"privacy": "private",
|
30736
30659
|
"return": {
|
30737
30660
|
"type": {
|
30738
|
-
"text": "
|
30661
|
+
"text": "Option | null"
|
30739
30662
|
}
|
30740
|
-
},
|
30741
|
-
"inheritedFrom": {
|
30742
|
-
"name": "FormInternalsMixin",
|
30743
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30744
30663
|
}
|
30745
30664
|
},
|
30746
30665
|
{
|
30747
30666
|
"kind": "method",
|
30748
|
-
"name": "
|
30749
|
-
"
|
30750
|
-
|
30751
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
30752
|
-
}
|
30667
|
+
"name": "modifyListBoxWrapper",
|
30668
|
+
"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."
|
30753
30670
|
},
|
30754
30671
|
{
|
30755
|
-
"kind": "
|
30756
|
-
"name": "
|
30757
|
-
"
|
30758
|
-
|
30672
|
+
"kind": "method",
|
30673
|
+
"name": "handleOptionsClick",
|
30674
|
+
"privacy": "private",
|
30675
|
+
"return": {
|
30676
|
+
"type": {
|
30677
|
+
"text": "void"
|
30678
|
+
}
|
30759
30679
|
},
|
30760
|
-
"
|
30761
|
-
|
30762
|
-
|
30763
|
-
|
30764
|
-
|
30765
|
-
|
30766
|
-
|
30767
|
-
|
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."
|
30768
30690
|
},
|
30769
30691
|
{
|
30770
|
-
"kind": "
|
30771
|
-
"name": "
|
30772
|
-
"
|
30773
|
-
|
30692
|
+
"kind": "method",
|
30693
|
+
"name": "setSelectedOption",
|
30694
|
+
"privacy": "private",
|
30695
|
+
"return": {
|
30696
|
+
"type": {
|
30697
|
+
"text": "void"
|
30698
|
+
}
|
30774
30699
|
},
|
30775
|
-
"
|
30776
|
-
|
30777
|
-
|
30778
|
-
|
30779
|
-
|
30780
|
-
|
30781
|
-
|
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."
|
30782
30710
|
},
|
30783
30711
|
{
|
30784
|
-
"kind": "
|
30785
|
-
"name": "
|
30786
|
-
"
|
30787
|
-
|
30712
|
+
"kind": "method",
|
30713
|
+
"name": "updateTabIndexForAllOptions",
|
30714
|
+
"privacy": "private",
|
30715
|
+
"return": {
|
30716
|
+
"type": {
|
30717
|
+
"text": "void"
|
30718
|
+
}
|
30788
30719
|
},
|
30789
|
-
"
|
30790
|
-
|
30791
|
-
|
30792
|
-
|
30793
|
-
|
30794
|
-
|
30795
|
-
|
30720
|
+
"parameters": [
|
30721
|
+
{
|
30722
|
+
"name": "option",
|
30723
|
+
"optional": true,
|
30724
|
+
"type": {
|
30725
|
+
"text": "Option | null"
|
30726
|
+
},
|
30727
|
+
"description": "The option which tabIndex should be set to 0."
|
30728
|
+
}
|
30729
|
+
],
|
30730
|
+
"description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
|
30796
30731
|
},
|
30797
30732
|
{
|
30798
|
-
"kind": "
|
30799
|
-
"name": "
|
30800
|
-
"
|
30801
|
-
|
30733
|
+
"kind": "method",
|
30734
|
+
"name": "updateSelectedInChildOptions",
|
30735
|
+
"privacy": "private",
|
30736
|
+
"return": {
|
30737
|
+
"type": {
|
30738
|
+
"text": "void"
|
30739
|
+
}
|
30802
30740
|
},
|
30803
|
-
"
|
30804
|
-
|
30805
|
-
|
30806
|
-
|
30807
|
-
|
30808
|
-
|
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"
|
30809
30751
|
},
|
30810
30752
|
{
|
30811
|
-
"kind": "
|
30812
|
-
"name": "
|
30813
|
-
"
|
30814
|
-
|
30753
|
+
"kind": "method",
|
30754
|
+
"name": "fireEvents",
|
30755
|
+
"privacy": "private",
|
30756
|
+
"return": {
|
30757
|
+
"type": {
|
30758
|
+
"text": "void"
|
30759
|
+
}
|
30815
30760
|
},
|
30816
|
-
"description": "
|
30817
|
-
"attribute": "leading-icon",
|
30818
|
-
"inheritedFrom": {
|
30819
|
-
"name": "Input",
|
30820
|
-
"module": "components/input/input.component.js"
|
30821
|
-
}
|
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."
|
30822
30762
|
},
|
30823
30763
|
{
|
30824
|
-
"kind": "
|
30825
|
-
"name": "
|
30826
|
-
"
|
30827
|
-
|
30764
|
+
"kind": "method",
|
30765
|
+
"name": "dispatchChange",
|
30766
|
+
"privacy": "private",
|
30767
|
+
"return": {
|
30768
|
+
"type": {
|
30769
|
+
"text": "void"
|
30770
|
+
}
|
30828
30771
|
},
|
30829
|
-
"
|
30830
|
-
|
30831
|
-
|
30832
|
-
|
30833
|
-
|
30834
|
-
|
30835
|
-
|
30772
|
+
"parameters": [
|
30773
|
+
{
|
30774
|
+
"name": "option",
|
30775
|
+
"type": {
|
30776
|
+
"text": "Option"
|
30777
|
+
}
|
30778
|
+
}
|
30779
|
+
]
|
30836
30780
|
},
|
30837
30781
|
{
|
30838
|
-
"kind": "
|
30839
|
-
"name": "
|
30840
|
-
"
|
30841
|
-
|
30782
|
+
"kind": "method",
|
30783
|
+
"name": "dispatchInput",
|
30784
|
+
"privacy": "private",
|
30785
|
+
"return": {
|
30786
|
+
"type": {
|
30787
|
+
"text": "void"
|
30788
|
+
}
|
30842
30789
|
},
|
30843
|
-
"
|
30844
|
-
|
30845
|
-
|
30846
|
-
|
30847
|
-
|
30848
|
-
|
30790
|
+
"parameters": [
|
30791
|
+
{
|
30792
|
+
"name": "option",
|
30793
|
+
"type": {
|
30794
|
+
"text": "Option"
|
30795
|
+
}
|
30796
|
+
}
|
30797
|
+
]
|
30849
30798
|
},
|
30850
30799
|
{
|
30851
|
-
"kind": "
|
30852
|
-
"name": "
|
30853
|
-
"
|
30854
|
-
|
30800
|
+
"kind": "method",
|
30801
|
+
"name": "handleClickCombobox",
|
30802
|
+
"privacy": "private",
|
30803
|
+
"return": {
|
30804
|
+
"type": {
|
30805
|
+
"text": "void"
|
30806
|
+
}
|
30855
30807
|
},
|
30856
|
-
"
|
30857
|
-
|
30858
|
-
|
30859
|
-
|
30860
|
-
|
30861
|
-
|
30808
|
+
"parameters": [
|
30809
|
+
{
|
30810
|
+
"name": "event",
|
30811
|
+
"type": {
|
30812
|
+
"text": "MouseEvent"
|
30813
|
+
},
|
30814
|
+
"description": "The mouse event which triggered this function."
|
30815
|
+
}
|
30816
|
+
],
|
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."
|
30862
30818
|
},
|
30863
30819
|
{
|
30864
|
-
"kind": "
|
30865
|
-
"name": "
|
30866
|
-
"
|
30867
|
-
|
30820
|
+
"kind": "method",
|
30821
|
+
"name": "handleKeydownCombobox",
|
30822
|
+
"privacy": "private",
|
30823
|
+
"return": {
|
30824
|
+
"type": {
|
30825
|
+
"text": "void"
|
30826
|
+
}
|
30868
30827
|
},
|
30869
|
-
"
|
30870
|
-
|
30871
|
-
|
30872
|
-
|
30873
|
-
|
30874
|
-
|
30875
|
-
|
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."
|
30876
30838
|
},
|
30877
30839
|
{
|
30878
|
-
"kind": "
|
30879
|
-
"name": "
|
30880
|
-
"
|
30881
|
-
|
30840
|
+
"kind": "method",
|
30841
|
+
"name": "handlePopoverKeydown",
|
30842
|
+
"privacy": "private",
|
30843
|
+
"return": {
|
30844
|
+
"type": {
|
30845
|
+
"text": "void"
|
30846
|
+
}
|
30882
30847
|
},
|
30883
|
-
"
|
30884
|
-
|
30885
|
-
|
30886
|
-
|
30887
|
-
|
30888
|
-
|
30889
|
-
|
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."
|
30890
30858
|
},
|
30891
30859
|
{
|
30892
|
-
"kind": "
|
30893
|
-
"name": "
|
30894
|
-
"
|
30895
|
-
|
30860
|
+
"kind": "method",
|
30861
|
+
"name": "updateState",
|
30862
|
+
"privacy": "public",
|
30863
|
+
"return": {
|
30864
|
+
"type": {
|
30865
|
+
"text": "void"
|
30866
|
+
}
|
30896
30867
|
},
|
30897
|
-
"
|
30898
|
-
"description": "If true, the input field is focused when the component is rendered.",
|
30899
|
-
"attribute": "autofocus",
|
30900
|
-
"inheritedFrom": {
|
30901
|
-
"name": "Input",
|
30902
|
-
"module": "components/input/input.component.js"
|
30903
|
-
}
|
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."
|
30904
30869
|
},
|
30905
30870
|
{
|
30906
30871
|
"kind": "field",
|
30907
|
-
"name": "
|
30872
|
+
"name": "name",
|
30908
30873
|
"type": {
|
30909
|
-
"text": "string
|
30874
|
+
"text": "string"
|
30910
30875
|
},
|
30911
|
-
"
|
30912
|
-
"
|
30876
|
+
"default": "''",
|
30877
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
30878
|
+
"attribute": "name",
|
30879
|
+
"reflects": true,
|
30913
30880
|
"inheritedFrom": {
|
30914
|
-
"name": "
|
30915
|
-
"module": "
|
30881
|
+
"name": "FormInternalsMixin",
|
30882
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
30916
30883
|
}
|
30917
30884
|
},
|
30918
30885
|
{
|
30919
30886
|
"kind": "field",
|
30920
|
-
"name": "
|
30887
|
+
"name": "value",
|
30921
30888
|
"type": {
|
30922
|
-
"text": "string
|
30889
|
+
"text": "string"
|
30923
30890
|
},
|
30924
|
-
"
|
30925
|
-
"
|
30891
|
+
"default": "''",
|
30892
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
30893
|
+
"attribute": "value",
|
30894
|
+
"reflects": true,
|
30926
30895
|
"inheritedFrom": {
|
30927
|
-
"name": "
|
30928
|
-
"module": "
|
30896
|
+
"name": "FormInternalsMixin",
|
30897
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
30929
30898
|
}
|
30930
30899
|
},
|
30931
30900
|
{
|
30932
30901
|
"kind": "field",
|
30933
|
-
"name": "
|
30902
|
+
"name": "validationMessage",
|
30934
30903
|
"type": {
|
30935
30904
|
"text": "string | undefined"
|
30936
30905
|
},
|
30937
|
-
"description": "
|
30938
|
-
"attribute": "
|
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",
|
30908
|
+
"reflects": true,
|
30939
30909
|
"inheritedFrom": {
|
30940
|
-
"name": "
|
30941
|
-
"module": "
|
30910
|
+
"name": "FormInternalsMixin",
|
30911
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
30942
30912
|
}
|
30943
30913
|
},
|
30944
30914
|
{
|
30945
30915
|
"kind": "field",
|
30946
|
-
"name": "
|
30916
|
+
"name": "validity",
|
30947
30917
|
"type": {
|
30948
|
-
"text": "
|
30918
|
+
"text": "ValidityState"
|
30949
30919
|
},
|
30950
|
-
"
|
30951
|
-
"default": "undefined",
|
30952
|
-
"attribute": "size",
|
30920
|
+
"readonly": true,
|
30953
30921
|
"inheritedFrom": {
|
30954
|
-
"name": "
|
30955
|
-
"module": "
|
30922
|
+
"name": "FormInternalsMixin",
|
30923
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
30956
30924
|
}
|
30957
30925
|
},
|
30958
30926
|
{
|
30959
30927
|
"kind": "field",
|
30960
|
-
"name": "
|
30961
|
-
"
|
30962
|
-
"text": "string"
|
30963
|
-
},
|
30964
|
-
"default": "''",
|
30965
|
-
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
30966
|
-
"attribute": "clear-aria-label",
|
30967
|
-
"inheritedFrom": {
|
30968
|
-
"name": "Input",
|
30969
|
-
"module": "components/input/input.component.js"
|
30970
|
-
}
|
30971
|
-
},
|
30972
|
-
{
|
30973
|
-
"kind": "method",
|
30974
|
-
"name": "setInputValidity",
|
30975
|
-
"privacy": "private",
|
30928
|
+
"name": "willValidate",
|
30929
|
+
"readonly": true,
|
30976
30930
|
"inheritedFrom": {
|
30977
|
-
"name": "
|
30978
|
-
"module": "
|
30931
|
+
"name": "FormInternalsMixin",
|
30932
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
30979
30933
|
}
|
30980
30934
|
},
|
30981
30935
|
{
|
30982
30936
|
"kind": "method",
|
30983
|
-
"name": "
|
30984
|
-
"
|
30985
|
-
"description": "Updates the value of the input field.\nSets the form value.",
|
30937
|
+
"name": "setValidity",
|
30938
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
30986
30939
|
"return": {
|
30987
30940
|
"type": {
|
30988
30941
|
"text": ""
|
30989
30942
|
}
|
30990
30943
|
},
|
30991
30944
|
"inheritedFrom": {
|
30992
|
-
"name": "
|
30993
|
-
"module": "
|
30945
|
+
"name": "FormInternalsMixin",
|
30946
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
30994
30947
|
}
|
30995
30948
|
},
|
30996
30949
|
{
|
30997
30950
|
"kind": "method",
|
30998
|
-
"name": "
|
30999
|
-
"
|
31000
|
-
|
30951
|
+
"name": "checkValidity",
|
30952
|
+
"return": {
|
30953
|
+
"type": {
|
30954
|
+
"text": "boolean"
|
30955
|
+
}
|
30956
|
+
},
|
31001
30957
|
"inheritedFrom": {
|
31002
|
-
"name": "
|
31003
|
-
"module": "
|
30958
|
+
"name": "FormInternalsMixin",
|
30959
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31004
30960
|
}
|
31005
30961
|
},
|
31006
30962
|
{
|
31007
30963
|
"kind": "method",
|
31008
|
-
"name": "
|
31009
|
-
"privacy": "private",
|
31010
|
-
"parameters": [
|
31011
|
-
{
|
31012
|
-
"name": "event",
|
31013
|
-
"type": {
|
31014
|
-
"text": "Event"
|
31015
|
-
},
|
31016
|
-
"description": "Event which contains information about the value change."
|
31017
|
-
}
|
31018
|
-
],
|
31019
|
-
"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",
|
30964
|
+
"name": "reportValidity",
|
31020
30965
|
"inheritedFrom": {
|
31021
|
-
"name": "
|
31022
|
-
"module": "
|
30966
|
+
"name": "FormInternalsMixin",
|
30967
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31023
30968
|
}
|
31024
30969
|
},
|
31025
30970
|
{
|
31026
|
-
"kind": "
|
31027
|
-
"name": "
|
31028
|
-
"
|
31029
|
-
|
31030
|
-
"return": {
|
31031
|
-
"type": {
|
31032
|
-
"text": ""
|
31033
|
-
}
|
30971
|
+
"kind": "field",
|
30972
|
+
"name": "dataAriaLabel",
|
30973
|
+
"type": {
|
30974
|
+
"text": "string | null"
|
31034
30975
|
},
|
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,
|
31035
30980
|
"inheritedFrom": {
|
31036
|
-
"name": "
|
31037
|
-
"module": "
|
31038
|
-
}
|
31039
|
-
},
|
31040
|
-
{
|
31041
|
-
"kind": "method",
|
31042
|
-
"name": "renderPrefixText",
|
31043
|
-
"privacy": "protected",
|
31044
|
-
"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.",
|
31045
|
-
"return": {
|
31046
|
-
"type": {
|
31047
|
-
"text": ""
|
31048
|
-
}
|
31049
|
-
},
|
31050
|
-
"inheritedFrom": {
|
31051
|
-
"name": "Input",
|
31052
|
-
"module": "components/input/input.component.js"
|
31053
|
-
}
|
31054
|
-
},
|
31055
|
-
{
|
31056
|
-
"kind": "method",
|
31057
|
-
"name": "renderTrailingButton",
|
31058
|
-
"privacy": "protected",
|
31059
|
-
"parameters": [
|
31060
|
-
{
|
31061
|
-
"name": "show",
|
31062
|
-
"default": "false"
|
31063
|
-
}
|
31064
|
-
],
|
31065
|
-
"description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
|
31066
|
-
"return": {
|
31067
|
-
"type": {
|
31068
|
-
"text": ""
|
31069
|
-
}
|
31070
|
-
},
|
31071
|
-
"inheritedFrom": {
|
31072
|
-
"name": "Input",
|
31073
|
-
"module": "components/input/input.component.js"
|
31074
|
-
}
|
31075
|
-
},
|
31076
|
-
{
|
31077
|
-
"kind": "method",
|
31078
|
-
"name": "renderInputElement",
|
31079
|
-
"privacy": "protected",
|
31080
|
-
"parameters": [
|
31081
|
-
{
|
31082
|
-
"name": "type",
|
31083
|
-
"type": {
|
31084
|
-
"text": "InputType"
|
31085
|
-
}
|
31086
|
-
},
|
31087
|
-
{
|
31088
|
-
"name": "hidePlaceholder",
|
31089
|
-
"default": "false"
|
31090
|
-
}
|
31091
|
-
],
|
31092
|
-
"inheritedFrom": {
|
31093
|
-
"name": "Input",
|
31094
|
-
"module": "components/input/input.component.js"
|
30981
|
+
"name": "DataAriaLabelMixin",
|
30982
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
31095
30983
|
}
|
31096
30984
|
},
|
31097
30985
|
{
|
@@ -31301,71 +31189,81 @@
|
|
31301
31189
|
],
|
31302
31190
|
"events": [
|
31303
31191
|
{
|
31304
|
-
"
|
31192
|
+
"name": "change",
|
31193
|
+
"type": {
|
31194
|
+
"text": "CustomEvent"
|
31195
|
+
},
|
31196
|
+
"description": "(React: onChange) This event is dispatched when the select is changed.",
|
31197
|
+
"reactName": "onChange"
|
31198
|
+
},
|
31199
|
+
{
|
31305
31200
|
"name": "input",
|
31306
|
-
"
|
31307
|
-
|
31308
|
-
|
31309
|
-
|
31310
|
-
|
31201
|
+
"type": {
|
31202
|
+
"text": "CustomEvent"
|
31203
|
+
},
|
31204
|
+
"description": "(React: onInput) This event is dispatched when the select is changed.",
|
31205
|
+
"reactName": "onInput"
|
31311
31206
|
},
|
31312
31207
|
{
|
31313
|
-
"description": "(React:
|
31314
|
-
"name": "
|
31315
|
-
"reactName": "
|
31316
|
-
"inheritedFrom": {
|
31317
|
-
"name": "Input",
|
31318
|
-
"module": "src/components/input/input.component.ts"
|
31319
|
-
}
|
31208
|
+
"description": "(React: onClick) This event is dispatched when the select is clicked.",
|
31209
|
+
"name": "click",
|
31210
|
+
"reactName": "onClick"
|
31320
31211
|
},
|
31321
31212
|
{
|
31322
|
-
"description": "(React:
|
31213
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
|
31214
|
+
"name": "keydown",
|
31215
|
+
"reactName": "onKeyDown"
|
31216
|
+
},
|
31217
|
+
{
|
31218
|
+
"description": "(React: onFocus) This event is dispatched when the select receives focus.",
|
31323
31219
|
"name": "focus",
|
31324
|
-
"reactName": "onFocus"
|
31325
|
-
|
31326
|
-
|
31327
|
-
|
31328
|
-
|
31220
|
+
"reactName": "onFocus"
|
31221
|
+
}
|
31222
|
+
],
|
31223
|
+
"attributes": [
|
31224
|
+
{
|
31225
|
+
"name": "placeholder",
|
31226
|
+
"type": {
|
31227
|
+
"text": "string | undefined"
|
31228
|
+
},
|
31229
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
31230
|
+
"fieldName": "placeholder"
|
31329
31231
|
},
|
31330
31232
|
{
|
31331
|
-
"
|
31332
|
-
"
|
31333
|
-
|
31334
|
-
|
31335
|
-
|
31336
|
-
|
31337
|
-
|
31233
|
+
"name": "readonly",
|
31234
|
+
"type": {
|
31235
|
+
"text": "boolean"
|
31236
|
+
},
|
31237
|
+
"default": "false",
|
31238
|
+
"description": "readonly attribute of the select field. If true, the select is read-only.",
|
31239
|
+
"fieldName": "readonly"
|
31338
31240
|
},
|
31339
31241
|
{
|
31340
|
-
"name": "
|
31242
|
+
"name": "height",
|
31341
31243
|
"type": {
|
31342
|
-
"text": "
|
31244
|
+
"text": "string"
|
31343
31245
|
},
|
31344
|
-
"
|
31345
|
-
"
|
31346
|
-
"
|
31347
|
-
"name": "Input",
|
31348
|
-
"module": "src/components/input/input.component.ts"
|
31349
|
-
}
|
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"
|
31350
31249
|
},
|
31351
31250
|
{
|
31251
|
+
"name": "placement",
|
31352
31252
|
"type": {
|
31353
|
-
"text": "
|
31253
|
+
"text": "Placement"
|
31354
31254
|
},
|
31355
|
-
"
|
31356
|
-
|
31357
|
-
|
31358
|
-
|
31359
|
-
|
31360
|
-
|
31361
|
-
|
31362
|
-
|
31363
|
-
|
31364
|
-
|
31365
|
-
|
31366
|
-
|
31367
|
-
"customElement": true,
|
31368
|
-
"attributes": [
|
31255
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
31256
|
+
"fieldName": "placement"
|
31257
|
+
},
|
31258
|
+
{
|
31259
|
+
"name": "soft-disabled",
|
31260
|
+
"type": {
|
31261
|
+
"text": "boolean | undefined"
|
31262
|
+
},
|
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"
|
31266
|
+
},
|
31369
31267
|
{
|
31370
31268
|
"name": "name",
|
31371
31269
|
"type": {
|
@@ -31418,871 +31316,646 @@
|
|
31418
31316
|
}
|
31419
31317
|
},
|
31420
31318
|
{
|
31421
|
-
"name": "
|
31319
|
+
"name": "disabled",
|
31422
31320
|
"type": {
|
31423
|
-
"text": "
|
31321
|
+
"text": "boolean | undefined"
|
31424
31322
|
},
|
31425
|
-
"
|
31426
|
-
"
|
31427
|
-
"fieldName": "
|
31323
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
31324
|
+
"default": "undefined",
|
31325
|
+
"fieldName": "disabled",
|
31428
31326
|
"inheritedFrom": {
|
31429
|
-
"name": "
|
31430
|
-
"module": "src/components/
|
31327
|
+
"name": "FormfieldWrapper",
|
31328
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31431
31329
|
}
|
31432
31330
|
},
|
31433
31331
|
{
|
31434
|
-
"name": "
|
31332
|
+
"name": "label",
|
31435
31333
|
"type": {
|
31436
|
-
"text": "
|
31334
|
+
"text": "string | undefined"
|
31437
31335
|
},
|
31438
|
-
"
|
31439
|
-
"
|
31440
|
-
"fieldName": "readonly",
|
31336
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
31337
|
+
"fieldName": "label",
|
31441
31338
|
"inheritedFrom": {
|
31442
|
-
"name": "
|
31443
|
-
"module": "src/components/
|
31339
|
+
"name": "FormfieldWrapper",
|
31340
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31444
31341
|
}
|
31445
31342
|
},
|
31446
31343
|
{
|
31447
|
-
"name": "
|
31344
|
+
"name": "required",
|
31448
31345
|
"type": {
|
31449
|
-
"text": "
|
31346
|
+
"text": "boolean"
|
31450
31347
|
},
|
31451
|
-
"
|
31452
|
-
"
|
31348
|
+
"default": "false",
|
31349
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
31350
|
+
"fieldName": "required",
|
31453
31351
|
"inheritedFrom": {
|
31454
|
-
"name": "
|
31455
|
-
"module": "src/components/
|
31352
|
+
"name": "FormfieldWrapper",
|
31353
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31456
31354
|
}
|
31457
31355
|
},
|
31458
31356
|
{
|
31459
|
-
"name": "
|
31357
|
+
"name": "id",
|
31460
31358
|
"type": {
|
31461
|
-
"text": "
|
31359
|
+
"text": "string"
|
31462
31360
|
},
|
31463
|
-
"
|
31464
|
-
"
|
31361
|
+
"default": "''",
|
31362
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
31363
|
+
"fieldName": "id",
|
31465
31364
|
"inheritedFrom": {
|
31466
|
-
"name": "
|
31467
|
-
"module": "src/components/
|
31365
|
+
"name": "FormfieldWrapper",
|
31366
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31468
31367
|
}
|
31469
31368
|
},
|
31470
31369
|
{
|
31471
|
-
"name": "
|
31370
|
+
"name": "help-text-type",
|
31472
31371
|
"type": {
|
31473
|
-
"text": "
|
31372
|
+
"text": "ValidationType"
|
31474
31373
|
},
|
31475
|
-
"
|
31476
|
-
"
|
31477
|
-
"fieldName": "trailingButton",
|
31374
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
31375
|
+
"fieldName": "helpTextType",
|
31478
31376
|
"inheritedFrom": {
|
31479
|
-
"name": "
|
31480
|
-
"module": "src/components/
|
31377
|
+
"name": "FormfieldWrapper",
|
31378
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31481
31379
|
}
|
31482
31380
|
},
|
31483
31381
|
{
|
31484
|
-
"name": "
|
31382
|
+
"name": "help-text",
|
31485
31383
|
"type": {
|
31486
|
-
"text": "
|
31384
|
+
"text": "string | undefined"
|
31487
31385
|
},
|
31488
|
-
"description": "The
|
31489
|
-
"fieldName": "
|
31386
|
+
"description": "The help text that is displayed below the input field.",
|
31387
|
+
"fieldName": "helpText",
|
31490
31388
|
"inheritedFrom": {
|
31491
|
-
"name": "
|
31492
|
-
"module": "src/components/
|
31389
|
+
"name": "FormfieldWrapper",
|
31390
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31493
31391
|
}
|
31494
31392
|
},
|
31495
31393
|
{
|
31496
|
-
"name": "
|
31394
|
+
"name": "toggletip-text",
|
31497
31395
|
"type": {
|
31498
|
-
"text": "
|
31396
|
+
"text": "string | undefined"
|
31499
31397
|
},
|
31500
|
-
"description": "The
|
31501
|
-
"fieldName": "
|
31398
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
31399
|
+
"fieldName": "toggletipText",
|
31502
31400
|
"inheritedFrom": {
|
31503
|
-
"name": "
|
31504
|
-
"module": "src/components/
|
31401
|
+
"name": "FormfieldWrapper",
|
31402
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31505
31403
|
}
|
31506
31404
|
},
|
31507
31405
|
{
|
31508
|
-
"name": "
|
31406
|
+
"name": "toggletip-placement",
|
31509
31407
|
"type": {
|
31510
|
-
"text": "
|
31408
|
+
"text": "PopoverPlacement"
|
31511
31409
|
},
|
31512
|
-
"description": "The
|
31513
|
-
"default": "'
|
31514
|
-
"fieldName": "
|
31410
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
31411
|
+
"default": "'top'",
|
31412
|
+
"fieldName": "toggletipPlacement",
|
31515
31413
|
"inheritedFrom": {
|
31516
|
-
"name": "
|
31517
|
-
"module": "src/components/
|
31414
|
+
"name": "FormfieldWrapper",
|
31415
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31518
31416
|
}
|
31519
31417
|
},
|
31520
31418
|
{
|
31521
|
-
"name": "
|
31419
|
+
"name": "info-icon-aria-label",
|
31522
31420
|
"type": {
|
31523
|
-
"text": "
|
31421
|
+
"text": "string | undefined"
|
31524
31422
|
},
|
31525
|
-
"description": "
|
31526
|
-
"
|
31527
|
-
"fieldName": "autocomplete",
|
31423
|
+
"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.",
|
31424
|
+
"fieldName": "infoIconAriaLabel",
|
31528
31425
|
"inheritedFrom": {
|
31529
|
-
"name": "
|
31530
|
-
"module": "src/components/
|
31426
|
+
"name": "FormfieldWrapper",
|
31427
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
31531
31428
|
}
|
31532
|
-
}
|
31429
|
+
}
|
31430
|
+
],
|
31431
|
+
"mixins": [
|
31533
31432
|
{
|
31534
|
-
"name": "
|
31535
|
-
"
|
31536
|
-
"text": "boolean"
|
31537
|
-
},
|
31538
|
-
"default": "false",
|
31539
|
-
"description": "If true, the input field is focused when the component is rendered.",
|
31540
|
-
"fieldName": "autofocus",
|
31541
|
-
"inheritedFrom": {
|
31542
|
-
"name": "Input",
|
31543
|
-
"module": "src/components/input/input.component.ts"
|
31544
|
-
}
|
31433
|
+
"name": "FormInternalsMixin",
|
31434
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
31545
31435
|
},
|
31546
31436
|
{
|
31547
|
-
"name": "
|
31437
|
+
"name": "DataAriaLabelMixin",
|
31438
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
31439
|
+
}
|
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
|
31448
|
+
}
|
31449
|
+
],
|
31450
|
+
"exports": [
|
31451
|
+
{
|
31452
|
+
"kind": "js",
|
31453
|
+
"name": "default",
|
31454
|
+
"declaration": {
|
31455
|
+
"name": "Select",
|
31456
|
+
"module": "components/select/select.component.js"
|
31457
|
+
}
|
31458
|
+
}
|
31459
|
+
]
|
31460
|
+
},
|
31461
|
+
{
|
31462
|
+
"kind": "javascript-module",
|
31463
|
+
"path": "components/searchfield/searchfield.component.js",
|
31464
|
+
"declarations": [
|
31465
|
+
{
|
31466
|
+
"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",
|
31469
|
+
"slots": [
|
31470
|
+
{
|
31471
|
+
"description": "Slot for input chips",
|
31472
|
+
"name": "filters"
|
31473
|
+
}
|
31474
|
+
],
|
31475
|
+
"members": [
|
31476
|
+
{
|
31477
|
+
"kind": "field",
|
31478
|
+
"name": "inputChips",
|
31548
31479
|
"type": {
|
31549
|
-
"text": "
|
31550
|
-
},
|
31551
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
31552
|
-
"fieldName": "dirname",
|
31553
|
-
"inheritedFrom": {
|
31554
|
-
"name": "Input",
|
31555
|
-
"module": "src/components/input/input.component.ts"
|
31480
|
+
"text": "Array<HTMLElement> | undefined"
|
31556
31481
|
}
|
31557
31482
|
},
|
31558
31483
|
{
|
31559
|
-
"
|
31560
|
-
"
|
31561
|
-
|
31562
|
-
|
31563
|
-
|
31564
|
-
|
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.",
|
31565
31497
|
"inheritedFrom": {
|
31566
31498
|
"name": "Input",
|
31567
|
-
"module": "
|
31499
|
+
"module": "components/input/input.component.js"
|
31568
31500
|
}
|
31569
31501
|
},
|
31570
31502
|
{
|
31571
|
-
"
|
31572
|
-
"
|
31573
|
-
|
31574
|
-
|
31575
|
-
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
31576
|
-
"fieldName": "list",
|
31577
|
-
"inheritedFrom": {
|
31578
|
-
"name": "Input",
|
31579
|
-
"module": "src/components/input/input.component.ts"
|
31580
|
-
}
|
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."
|
31581
31507
|
},
|
31582
31508
|
{
|
31583
|
-
"
|
31584
|
-
"
|
31585
|
-
|
31586
|
-
|
31587
|
-
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
31588
|
-
"default": "undefined",
|
31589
|
-
"fieldName": "size",
|
31509
|
+
"kind": "method",
|
31510
|
+
"name": "clearInputText",
|
31511
|
+
"privacy": "protected",
|
31512
|
+
"description": "Clears the input field.",
|
31590
31513
|
"inheritedFrom": {
|
31591
31514
|
"name": "Input",
|
31592
|
-
"module": "
|
31515
|
+
"module": "components/input/input.component.js"
|
31593
31516
|
}
|
31594
31517
|
},
|
31595
31518
|
{
|
31596
|
-
"
|
31519
|
+
"kind": "field",
|
31520
|
+
"name": "name",
|
31597
31521
|
"type": {
|
31598
31522
|
"text": "string"
|
31599
31523
|
},
|
31600
31524
|
"default": "''",
|
31601
|
-
"description": "
|
31602
|
-
"
|
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,
|
31603
31528
|
"inheritedFrom": {
|
31604
|
-
"name": "
|
31605
|
-
"module": "
|
31529
|
+
"name": "FormInternalsMixin",
|
31530
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31606
31531
|
}
|
31607
31532
|
},
|
31608
31533
|
{
|
31609
|
-
"
|
31534
|
+
"kind": "field",
|
31535
|
+
"name": "value",
|
31610
31536
|
"type": {
|
31611
|
-
"text": "
|
31537
|
+
"text": "string"
|
31612
31538
|
},
|
31613
|
-
"
|
31614
|
-
"
|
31615
|
-
"
|
31539
|
+
"default": "''",
|
31540
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
31541
|
+
"attribute": "value",
|
31542
|
+
"reflects": true,
|
31616
31543
|
"inheritedFrom": {
|
31617
|
-
"name": "
|
31618
|
-
"module": "
|
31544
|
+
"name": "FormInternalsMixin",
|
31545
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31619
31546
|
}
|
31620
31547
|
},
|
31621
31548
|
{
|
31622
|
-
"
|
31549
|
+
"kind": "field",
|
31550
|
+
"name": "validationMessage",
|
31623
31551
|
"type": {
|
31624
31552
|
"text": "string | undefined"
|
31625
31553
|
},
|
31626
|
-
"description": "
|
31627
|
-
"
|
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,
|
31628
31557
|
"inheritedFrom": {
|
31629
|
-
"name": "
|
31630
|
-
"module": "
|
31558
|
+
"name": "FormInternalsMixin",
|
31559
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31631
31560
|
}
|
31632
31561
|
},
|
31633
31562
|
{
|
31634
|
-
"
|
31563
|
+
"kind": "field",
|
31564
|
+
"name": "validity",
|
31635
31565
|
"type": {
|
31636
|
-
"text": "
|
31566
|
+
"text": "ValidityState"
|
31637
31567
|
},
|
31638
|
-
"
|
31639
|
-
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
31640
|
-
"fieldName": "required",
|
31568
|
+
"readonly": true,
|
31641
31569
|
"inheritedFrom": {
|
31642
|
-
"name": "
|
31643
|
-
"module": "
|
31570
|
+
"name": "FormInternalsMixin",
|
31571
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31644
31572
|
}
|
31645
31573
|
},
|
31646
31574
|
{
|
31647
|
-
"
|
31648
|
-
"
|
31649
|
-
|
31650
|
-
},
|
31651
|
-
"default": "''",
|
31652
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
31653
|
-
"fieldName": "id",
|
31575
|
+
"kind": "field",
|
31576
|
+
"name": "willValidate",
|
31577
|
+
"readonly": true,
|
31654
31578
|
"inheritedFrom": {
|
31655
|
-
"name": "
|
31656
|
-
"module": "
|
31579
|
+
"name": "FormInternalsMixin",
|
31580
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31657
31581
|
}
|
31658
31582
|
},
|
31659
31583
|
{
|
31660
|
-
"
|
31661
|
-
"
|
31662
|
-
|
31584
|
+
"kind": "method",
|
31585
|
+
"name": "setValidity",
|
31586
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
31587
|
+
"return": {
|
31588
|
+
"type": {
|
31589
|
+
"text": ""
|
31590
|
+
}
|
31663
31591
|
},
|
31664
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
31665
|
-
"fieldName": "helpTextType",
|
31666
31592
|
"inheritedFrom": {
|
31667
|
-
"name": "
|
31668
|
-
"module": "
|
31593
|
+
"name": "FormInternalsMixin",
|
31594
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31669
31595
|
}
|
31670
31596
|
},
|
31671
31597
|
{
|
31672
|
-
"
|
31673
|
-
"
|
31674
|
-
|
31598
|
+
"kind": "method",
|
31599
|
+
"name": "checkValidity",
|
31600
|
+
"return": {
|
31601
|
+
"type": {
|
31602
|
+
"text": "boolean"
|
31603
|
+
}
|
31675
31604
|
},
|
31676
|
-
"description": "The help text that is displayed below the input field.",
|
31677
|
-
"fieldName": "helpText",
|
31678
31605
|
"inheritedFrom": {
|
31679
|
-
"name": "
|
31680
|
-
"module": "
|
31606
|
+
"name": "FormInternalsMixin",
|
31607
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31681
31608
|
}
|
31682
31609
|
},
|
31683
31610
|
{
|
31684
|
-
"
|
31685
|
-
"
|
31686
|
-
"text": "string | undefined"
|
31687
|
-
},
|
31688
|
-
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
31689
|
-
"fieldName": "toggletipText",
|
31611
|
+
"kind": "method",
|
31612
|
+
"name": "reportValidity",
|
31690
31613
|
"inheritedFrom": {
|
31691
|
-
"name": "
|
31692
|
-
"module": "
|
31614
|
+
"name": "FormInternalsMixin",
|
31615
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
31693
31616
|
}
|
31694
31617
|
},
|
31695
31618
|
{
|
31696
|
-
"
|
31619
|
+
"kind": "field",
|
31620
|
+
"name": "dataAriaLabel",
|
31697
31621
|
"type": {
|
31698
|
-
"text": "
|
31622
|
+
"text": "string | null"
|
31699
31623
|
},
|
31700
|
-
"
|
31701
|
-
"
|
31702
|
-
"
|
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,
|
31703
31628
|
"inheritedFrom": {
|
31704
|
-
"name": "
|
31705
|
-
"module": "
|
31629
|
+
"name": "DataAriaLabelMixin",
|
31630
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
31706
31631
|
}
|
31707
31632
|
},
|
31708
31633
|
{
|
31709
|
-
"
|
31634
|
+
"kind": "field",
|
31635
|
+
"name": "placeholder",
|
31710
31636
|
"type": {
|
31711
|
-
"text": "string
|
31637
|
+
"text": "string"
|
31712
31638
|
},
|
31713
|
-
"
|
31714
|
-
"
|
31639
|
+
"default": "''",
|
31640
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
31641
|
+
"attribute": "placeholder",
|
31715
31642
|
"inheritedFrom": {
|
31716
|
-
"name": "
|
31717
|
-
"module": "
|
31643
|
+
"name": "Input",
|
31644
|
+
"module": "components/input/input.component.js"
|
31718
31645
|
}
|
31719
|
-
}
|
31720
|
-
],
|
31721
|
-
"cssProperties": [
|
31646
|
+
},
|
31722
31647
|
{
|
31723
|
-
"
|
31724
|
-
"name": "
|
31648
|
+
"kind": "field",
|
31649
|
+
"name": "readonly",
|
31650
|
+
"type": {
|
31651
|
+
"text": "boolean"
|
31652
|
+
},
|
31653
|
+
"default": "false",
|
31654
|
+
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
31655
|
+
"attribute": "readonly",
|
31725
31656
|
"inheritedFrom": {
|
31726
31657
|
"name": "Input",
|
31727
|
-
"module": "
|
31658
|
+
"module": "components/input/input.component.js"
|
31728
31659
|
}
|
31729
31660
|
},
|
31730
31661
|
{
|
31731
|
-
"
|
31732
|
-
"name": "
|
31662
|
+
"kind": "field",
|
31663
|
+
"name": "prefixText",
|
31664
|
+
"type": {
|
31665
|
+
"text": "string | undefined"
|
31666
|
+
},
|
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",
|
31733
31669
|
"inheritedFrom": {
|
31734
31670
|
"name": "Input",
|
31735
|
-
"module": "
|
31671
|
+
"module": "components/input/input.component.js"
|
31736
31672
|
}
|
31737
31673
|
},
|
31738
31674
|
{
|
31739
|
-
"
|
31740
|
-
"name": "
|
31675
|
+
"kind": "field",
|
31676
|
+
"name": "leadingIcon",
|
31677
|
+
"type": {
|
31678
|
+
"text": "IconNames | undefined"
|
31679
|
+
},
|
31680
|
+
"description": "The leading icon that is displayed before the input field.",
|
31681
|
+
"attribute": "leading-icon",
|
31741
31682
|
"inheritedFrom": {
|
31742
31683
|
"name": "Input",
|
31743
|
-
"module": "
|
31684
|
+
"module": "components/input/input.component.js"
|
31744
31685
|
}
|
31745
31686
|
},
|
31746
31687
|
{
|
31747
|
-
"
|
31748
|
-
"name": "
|
31688
|
+
"kind": "field",
|
31689
|
+
"name": "trailingButton",
|
31690
|
+
"type": {
|
31691
|
+
"text": "boolean"
|
31692
|
+
},
|
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",
|
31749
31696
|
"inheritedFrom": {
|
31750
31697
|
"name": "Input",
|
31751
|
-
"module": "
|
31698
|
+
"module": "components/input/input.component.js"
|
31752
31699
|
}
|
31753
31700
|
},
|
31754
31701
|
{
|
31755
|
-
"
|
31756
|
-
"name": "
|
31702
|
+
"kind": "field",
|
31703
|
+
"name": "maxlength",
|
31704
|
+
"type": {
|
31705
|
+
"text": "number | undefined"
|
31706
|
+
},
|
31707
|
+
"description": "The maximum number of characters that the input field can accept.",
|
31708
|
+
"attribute": "maxlength",
|
31757
31709
|
"inheritedFrom": {
|
31758
31710
|
"name": "Input",
|
31759
|
-
"module": "
|
31711
|
+
"module": "components/input/input.component.js"
|
31760
31712
|
}
|
31761
31713
|
},
|
31762
31714
|
{
|
31763
|
-
"
|
31764
|
-
"name": "
|
31715
|
+
"kind": "field",
|
31716
|
+
"name": "minlength",
|
31717
|
+
"type": {
|
31718
|
+
"text": "number | undefined"
|
31719
|
+
},
|
31720
|
+
"description": "The minimum number of characters that the input field can accept.",
|
31721
|
+
"attribute": "minlength",
|
31765
31722
|
"inheritedFrom": {
|
31766
31723
|
"name": "Input",
|
31767
|
-
"module": "
|
31724
|
+
"module": "components/input/input.component.js"
|
31768
31725
|
}
|
31769
31726
|
},
|
31770
31727
|
{
|
31771
|
-
"
|
31772
|
-
"name": "
|
31728
|
+
"kind": "field",
|
31729
|
+
"name": "autocapitalize",
|
31730
|
+
"type": {
|
31731
|
+
"text": "AutoCapitalizeType"
|
31732
|
+
},
|
31733
|
+
"description": "The autocapitalize attribute of the input field.",
|
31734
|
+
"default": "'off'",
|
31735
|
+
"attribute": "autocapitalize",
|
31773
31736
|
"inheritedFrom": {
|
31774
31737
|
"name": "Input",
|
31775
|
-
"module": "
|
31738
|
+
"module": "components/input/input.component.js"
|
31776
31739
|
}
|
31777
31740
|
},
|
31778
31741
|
{
|
31779
|
-
"
|
31780
|
-
"name": "
|
31742
|
+
"kind": "field",
|
31743
|
+
"name": "autocomplete",
|
31744
|
+
"type": {
|
31745
|
+
"text": "AutoCompleteType"
|
31746
|
+
},
|
31747
|
+
"description": "The autocomplete attribute of the input field.",
|
31748
|
+
"default": "'off'",
|
31749
|
+
"attribute": "autocomplete",
|
31781
31750
|
"inheritedFrom": {
|
31782
31751
|
"name": "Input",
|
31783
|
-
"module": "
|
31752
|
+
"module": "components/input/input.component.js"
|
31784
31753
|
}
|
31785
31754
|
},
|
31786
31755
|
{
|
31787
|
-
"
|
31788
|
-
"name": "
|
31756
|
+
"kind": "field",
|
31757
|
+
"name": "autofocus",
|
31758
|
+
"type": {
|
31759
|
+
"text": "boolean"
|
31760
|
+
},
|
31761
|
+
"default": "false",
|
31762
|
+
"description": "If true, the input field is focused when the component is rendered.",
|
31763
|
+
"attribute": "autofocus",
|
31789
31764
|
"inheritedFrom": {
|
31790
31765
|
"name": "Input",
|
31791
|
-
"module": "
|
31766
|
+
"module": "components/input/input.component.js"
|
31792
31767
|
}
|
31793
31768
|
},
|
31794
31769
|
{
|
31795
|
-
"
|
31796
|
-
"name": "
|
31770
|
+
"kind": "field",
|
31771
|
+
"name": "dirname",
|
31772
|
+
"type": {
|
31773
|
+
"text": "string | undefined"
|
31774
|
+
},
|
31775
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
31776
|
+
"attribute": "dirname",
|
31797
31777
|
"inheritedFrom": {
|
31798
31778
|
"name": "Input",
|
31799
|
-
"module": "
|
31779
|
+
"module": "components/input/input.component.js"
|
31800
31780
|
}
|
31801
31781
|
},
|
31802
31782
|
{
|
31803
|
-
"
|
31804
|
-
"name": "
|
31783
|
+
"kind": "field",
|
31784
|
+
"name": "pattern",
|
31785
|
+
"type": {
|
31786
|
+
"text": "string | undefined"
|
31787
|
+
},
|
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",
|
31805
31790
|
"inheritedFrom": {
|
31806
31791
|
"name": "Input",
|
31807
|
-
"module": "
|
31792
|
+
"module": "components/input/input.component.js"
|
31808
31793
|
}
|
31809
31794
|
},
|
31810
31795
|
{
|
31811
|
-
"
|
31812
|
-
"name": "
|
31796
|
+
"kind": "field",
|
31797
|
+
"name": "list",
|
31798
|
+
"type": {
|
31799
|
+
"text": "string | undefined"
|
31800
|
+
},
|
31801
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
31802
|
+
"attribute": "list",
|
31813
31803
|
"inheritedFrom": {
|
31814
31804
|
"name": "Input",
|
31815
|
-
"module": "
|
31805
|
+
"module": "components/input/input.component.js"
|
31816
31806
|
}
|
31817
31807
|
},
|
31818
31808
|
{
|
31819
|
-
"
|
31820
|
-
"name": "
|
31809
|
+
"kind": "field",
|
31810
|
+
"name": "size",
|
31811
|
+
"type": {
|
31812
|
+
"text": "number | undefined | undefined"
|
31813
|
+
},
|
31814
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
31815
|
+
"default": "undefined",
|
31816
|
+
"attribute": "size",
|
31821
31817
|
"inheritedFrom": {
|
31822
31818
|
"name": "Input",
|
31823
|
-
"module": "
|
31819
|
+
"module": "components/input/input.component.js"
|
31824
31820
|
}
|
31825
31821
|
},
|
31826
31822
|
{
|
31827
|
-
"
|
31828
|
-
"name": "
|
31823
|
+
"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",
|
31829
31831
|
"inheritedFrom": {
|
31830
31832
|
"name": "Input",
|
31831
|
-
"module": "
|
31833
|
+
"module": "components/input/input.component.js"
|
31832
31834
|
}
|
31833
31835
|
},
|
31834
31836
|
{
|
31835
|
-
"
|
31836
|
-
"name": "
|
31837
|
+
"kind": "method",
|
31838
|
+
"name": "setInputValidity",
|
31839
|
+
"privacy": "private",
|
31837
31840
|
"inheritedFrom": {
|
31838
31841
|
"name": "Input",
|
31839
|
-
"module": "
|
31842
|
+
"module": "components/input/input.component.js"
|
31840
31843
|
}
|
31841
31844
|
},
|
31842
31845
|
{
|
31843
|
-
"
|
31844
|
-
"name": "
|
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
|
+
},
|
31845
31855
|
"inheritedFrom": {
|
31846
31856
|
"name": "Input",
|
31847
|
-
"module": "
|
31848
|
-
}
|
31849
|
-
}
|
31850
|
-
]
|
31851
|
-
}
|
31852
|
-
],
|
31853
|
-
"exports": [
|
31854
|
-
{
|
31855
|
-
"kind": "js",
|
31856
|
-
"name": "default",
|
31857
|
-
"declaration": {
|
31858
|
-
"name": "Searchfield",
|
31859
|
-
"module": "components/searchfield/searchfield.component.js"
|
31860
|
-
}
|
31861
|
-
}
|
31862
|
-
]
|
31863
|
-
},
|
31864
|
-
{
|
31865
|
-
"kind": "javascript-module",
|
31866
|
-
"path": "components/select/select.component.js",
|
31867
|
-
"declarations": [
|
31868
|
-
{
|
31869
|
-
"kind": "class",
|
31870
|
-
"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.",
|
31871
|
-
"name": "Select",
|
31872
|
-
"slots": [
|
31873
|
-
{
|
31874
|
-
"description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
|
31875
|
-
"name": "default"
|
31876
|
-
}
|
31877
|
-
],
|
31878
|
-
"members": [
|
31879
|
-
{
|
31880
|
-
"kind": "field",
|
31881
|
-
"name": "placeholder",
|
31882
|
-
"type": {
|
31883
|
-
"text": "string | undefined"
|
31884
|
-
},
|
31885
|
-
"description": "The placeholder text which will be shown on the text if provided.",
|
31886
|
-
"attribute": "placeholder"
|
31887
|
-
},
|
31888
|
-
{
|
31889
|
-
"kind": "field",
|
31890
|
-
"name": "readonly",
|
31891
|
-
"type": {
|
31892
|
-
"text": "boolean"
|
31893
|
-
},
|
31894
|
-
"default": "false",
|
31895
|
-
"description": "readonly attribute of the select field. If true, the select is read-only.",
|
31896
|
-
"attribute": "readonly"
|
31897
|
-
},
|
31898
|
-
{
|
31899
|
-
"kind": "field",
|
31900
|
-
"name": "height",
|
31901
|
-
"type": {
|
31902
|
-
"text": "string"
|
31903
|
-
},
|
31904
|
-
"default": "'auto'",
|
31905
|
-
"description": "height attribute of the select field. If set,\nthen a scroll bar will be visible when there more options than the adjusted height.",
|
31906
|
-
"attribute": "height"
|
31907
|
-
},
|
31908
|
-
{
|
31909
|
-
"kind": "field",
|
31910
|
-
"name": "placement",
|
31911
|
-
"type": {
|
31912
|
-
"text": "Placement"
|
31913
|
-
},
|
31914
|
-
"description": "The placeholder text which will be shown on the text if provided.",
|
31915
|
-
"attribute": "placement",
|
31916
|
-
"reflects": true
|
31917
|
-
},
|
31918
|
-
{
|
31919
|
-
"kind": "field",
|
31920
|
-
"name": "softDisabled",
|
31921
|
-
"type": {
|
31922
|
-
"text": "boolean | undefined"
|
31923
|
-
},
|
31924
|
-
"description": "Indicates whether the select is soft disabled.\nWhen set to `true`, the select appears visually disabled but still allows\nfocus.",
|
31925
|
-
"default": "undefined",
|
31926
|
-
"attribute": "soft-disabled"
|
31927
|
-
},
|
31928
|
-
{
|
31929
|
-
"kind": "method",
|
31930
|
-
"name": "getAllValidOptions",
|
31931
|
-
"privacy": "private",
|
31932
|
-
"return": {
|
31933
|
-
"type": {
|
31934
|
-
"text": "Array<Option>"
|
31935
|
-
}
|
31857
|
+
"module": "components/input/input.component.js"
|
31936
31858
|
}
|
31937
31859
|
},
|
31938
31860
|
{
|
31939
31861
|
"kind": "method",
|
31940
|
-
"name": "
|
31941
|
-
"privacy": "private",
|
31942
|
-
"return": {
|
31943
|
-
"type": {
|
31944
|
-
"text": "Option | null"
|
31945
|
-
}
|
31946
|
-
}
|
31947
|
-
},
|
31948
|
-
{
|
31949
|
-
"kind": "method",
|
31950
|
-
"name": "getLastValidOption",
|
31951
|
-
"privacy": "private",
|
31952
|
-
"return": {
|
31953
|
-
"type": {
|
31954
|
-
"text": "Option | null"
|
31955
|
-
}
|
31956
|
-
}
|
31957
|
-
},
|
31958
|
-
{
|
31959
|
-
"kind": "method",
|
31960
|
-
"name": "getFirstSelectedOption",
|
31862
|
+
"name": "onInput",
|
31961
31863
|
"privacy": "private",
|
31962
|
-
"
|
31963
|
-
|
31964
|
-
|
31965
|
-
|
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"
|
31966
31868
|
}
|
31967
31869
|
},
|
31968
31870
|
{
|
31969
31871
|
"kind": "method",
|
31970
|
-
"name": "
|
31971
|
-
"privacy": "private",
|
31972
|
-
"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."
|
31973
|
-
},
|
31974
|
-
{
|
31975
|
-
"kind": "method",
|
31976
|
-
"name": "handleOptionsClick",
|
31977
|
-
"privacy": "private",
|
31978
|
-
"return": {
|
31979
|
-
"type": {
|
31980
|
-
"text": "void"
|
31981
|
-
}
|
31982
|
-
},
|
31983
|
-
"parameters": [
|
31984
|
-
{
|
31985
|
-
"name": "event",
|
31986
|
-
"type": {
|
31987
|
-
"text": "MouseEvent"
|
31988
|
-
},
|
31989
|
-
"description": "The event which triggered this function."
|
31990
|
-
}
|
31991
|
-
],
|
31992
|
-
"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."
|
31993
|
-
},
|
31994
|
-
{
|
31995
|
-
"kind": "method",
|
31996
|
-
"name": "setSelectedOption",
|
31997
|
-
"privacy": "private",
|
31998
|
-
"return": {
|
31999
|
-
"type": {
|
32000
|
-
"text": "void"
|
32001
|
-
}
|
32002
|
-
},
|
32003
|
-
"parameters": [
|
32004
|
-
{
|
32005
|
-
"name": "option",
|
32006
|
-
"type": {
|
32007
|
-
"text": "Option | null"
|
32008
|
-
},
|
32009
|
-
"description": "The option element in DOM which gets selected."
|
32010
|
-
}
|
32011
|
-
],
|
32012
|
-
"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."
|
32013
|
-
},
|
32014
|
-
{
|
32015
|
-
"kind": "method",
|
32016
|
-
"name": "updateTabIndexForAllOptions",
|
32017
|
-
"privacy": "private",
|
32018
|
-
"return": {
|
32019
|
-
"type": {
|
32020
|
-
"text": "void"
|
32021
|
-
}
|
32022
|
-
},
|
32023
|
-
"parameters": [
|
32024
|
-
{
|
32025
|
-
"name": "option",
|
32026
|
-
"optional": true,
|
32027
|
-
"type": {
|
32028
|
-
"text": "Option | null"
|
32029
|
-
},
|
32030
|
-
"description": "The option which tabIndex should be set to 0."
|
32031
|
-
}
|
32032
|
-
],
|
32033
|
-
"description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
|
32034
|
-
},
|
32035
|
-
{
|
32036
|
-
"kind": "method",
|
32037
|
-
"name": "updateSelectedInChildOptions",
|
32038
|
-
"privacy": "private",
|
32039
|
-
"return": {
|
32040
|
-
"type": {
|
32041
|
-
"text": "void"
|
32042
|
-
}
|
32043
|
-
},
|
32044
|
-
"parameters": [
|
32045
|
-
{
|
32046
|
-
"name": "selectedOption",
|
32047
|
-
"type": {
|
32048
|
-
"text": "Option | null"
|
32049
|
-
},
|
32050
|
-
"description": "The option which gets selected"
|
32051
|
-
}
|
32052
|
-
],
|
32053
|
-
"description": "Sets selected attribute on the selected option and removes it from all options"
|
32054
|
-
},
|
32055
|
-
{
|
32056
|
-
"kind": "method",
|
32057
|
-
"name": "fireEvents",
|
32058
|
-
"privacy": "private",
|
32059
|
-
"return": {
|
32060
|
-
"type": {
|
32061
|
-
"text": "void"
|
32062
|
-
}
|
32063
|
-
},
|
32064
|
-
"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."
|
32065
|
-
},
|
32066
|
-
{
|
32067
|
-
"kind": "method",
|
32068
|
-
"name": "dispatchChange",
|
32069
|
-
"privacy": "private",
|
32070
|
-
"return": {
|
32071
|
-
"type": {
|
32072
|
-
"text": "void"
|
32073
|
-
}
|
32074
|
-
},
|
32075
|
-
"parameters": [
|
32076
|
-
{
|
32077
|
-
"name": "option",
|
32078
|
-
"type": {
|
32079
|
-
"text": "Option"
|
32080
|
-
}
|
32081
|
-
}
|
32082
|
-
]
|
32083
|
-
},
|
32084
|
-
{
|
32085
|
-
"kind": "method",
|
32086
|
-
"name": "dispatchInput",
|
32087
|
-
"privacy": "private",
|
32088
|
-
"return": {
|
32089
|
-
"type": {
|
32090
|
-
"text": "void"
|
32091
|
-
}
|
32092
|
-
},
|
32093
|
-
"parameters": [
|
32094
|
-
{
|
32095
|
-
"name": "option",
|
32096
|
-
"type": {
|
32097
|
-
"text": "Option"
|
32098
|
-
}
|
32099
|
-
}
|
32100
|
-
]
|
32101
|
-
},
|
32102
|
-
{
|
32103
|
-
"kind": "method",
|
32104
|
-
"name": "handleClickCombobox",
|
32105
|
-
"privacy": "private",
|
32106
|
-
"return": {
|
32107
|
-
"type": {
|
32108
|
-
"text": "void"
|
32109
|
-
}
|
32110
|
-
},
|
32111
|
-
"parameters": [
|
32112
|
-
{
|
32113
|
-
"name": "event",
|
32114
|
-
"type": {
|
32115
|
-
"text": "MouseEvent"
|
32116
|
-
},
|
32117
|
-
"description": "The mouse event which triggered this function."
|
32118
|
-
}
|
32119
|
-
],
|
32120
|
-
"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."
|
32121
|
-
},
|
32122
|
-
{
|
32123
|
-
"kind": "method",
|
32124
|
-
"name": "handleKeydownCombobox",
|
32125
|
-
"privacy": "private",
|
32126
|
-
"return": {
|
32127
|
-
"type": {
|
32128
|
-
"text": "void"
|
32129
|
-
}
|
32130
|
-
},
|
32131
|
-
"parameters": [
|
32132
|
-
{
|
32133
|
-
"name": "event",
|
32134
|
-
"type": {
|
32135
|
-
"text": "KeyboardEvent"
|
32136
|
-
},
|
32137
|
-
"description": "The keyboard event."
|
32138
|
-
}
|
32139
|
-
],
|
32140
|
-
"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."
|
32141
|
-
},
|
32142
|
-
{
|
32143
|
-
"kind": "method",
|
32144
|
-
"name": "handlePopoverKeydown",
|
31872
|
+
"name": "onChange",
|
32145
31873
|
"privacy": "private",
|
32146
|
-
"return": {
|
32147
|
-
"type": {
|
32148
|
-
"text": "void"
|
32149
|
-
}
|
32150
|
-
},
|
32151
31874
|
"parameters": [
|
32152
31875
|
{
|
32153
31876
|
"name": "event",
|
32154
31877
|
"type": {
|
32155
|
-
"text": "
|
31878
|
+
"text": "Event"
|
32156
31879
|
},
|
32157
|
-
"description": "
|
31880
|
+
"description": "Event which contains information about the value change."
|
32158
31881
|
}
|
32159
31882
|
],
|
32160
|
-
"description": "Handles the
|
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
|
+
}
|
32161
31888
|
},
|
32162
31889
|
{
|
32163
31890
|
"kind": "method",
|
32164
|
-
"name": "
|
32165
|
-
"privacy": "
|
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.",
|
32166
31894
|
"return": {
|
32167
31895
|
"type": {
|
32168
|
-
"text": "
|
31896
|
+
"text": ""
|
32169
31897
|
}
|
32170
31898
|
},
|
32171
|
-
"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."
|
32172
|
-
},
|
32173
|
-
{
|
32174
|
-
"kind": "field",
|
32175
|
-
"name": "name",
|
32176
|
-
"type": {
|
32177
|
-
"text": "string"
|
32178
|
-
},
|
32179
|
-
"default": "''",
|
32180
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
32181
|
-
"attribute": "name",
|
32182
|
-
"reflects": true,
|
32183
|
-
"inheritedFrom": {
|
32184
|
-
"name": "FormInternalsMixin",
|
32185
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
32186
|
-
}
|
32187
|
-
},
|
32188
|
-
{
|
32189
|
-
"kind": "field",
|
32190
|
-
"name": "value",
|
32191
|
-
"type": {
|
32192
|
-
"text": "string"
|
32193
|
-
},
|
32194
|
-
"default": "''",
|
32195
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
32196
|
-
"attribute": "value",
|
32197
|
-
"reflects": true,
|
32198
|
-
"inheritedFrom": {
|
32199
|
-
"name": "FormInternalsMixin",
|
32200
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
32201
|
-
}
|
32202
|
-
},
|
32203
|
-
{
|
32204
|
-
"kind": "field",
|
32205
|
-
"name": "validationMessage",
|
32206
|
-
"type": {
|
32207
|
-
"text": "string | undefined"
|
32208
|
-
},
|
32209
|
-
"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.",
|
32210
|
-
"attribute": "validation-message",
|
32211
|
-
"reflects": true,
|
32212
|
-
"inheritedFrom": {
|
32213
|
-
"name": "FormInternalsMixin",
|
32214
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
32215
|
-
}
|
32216
|
-
},
|
32217
|
-
{
|
32218
|
-
"kind": "field",
|
32219
|
-
"name": "validity",
|
32220
|
-
"type": {
|
32221
|
-
"text": "ValidityState"
|
32222
|
-
},
|
32223
|
-
"readonly": true,
|
32224
31899
|
"inheritedFrom": {
|
32225
|
-
"name": "
|
32226
|
-
"module": "
|
32227
|
-
}
|
32228
|
-
},
|
32229
|
-
{
|
32230
|
-
"kind": "field",
|
32231
|
-
"name": "willValidate",
|
32232
|
-
"readonly": true,
|
32233
|
-
"inheritedFrom": {
|
32234
|
-
"name": "FormInternalsMixin",
|
32235
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
31900
|
+
"name": "Input",
|
31901
|
+
"module": "components/input/input.component.js"
|
32236
31902
|
}
|
32237
31903
|
},
|
32238
31904
|
{
|
32239
31905
|
"kind": "method",
|
32240
|
-
"name": "
|
32241
|
-
"
|
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.",
|
32242
31909
|
"return": {
|
32243
31910
|
"type": {
|
32244
31911
|
"text": ""
|
32245
31912
|
}
|
32246
31913
|
},
|
32247
31914
|
"inheritedFrom": {
|
32248
|
-
"name": "
|
32249
|
-
"module": "
|
31915
|
+
"name": "Input",
|
31916
|
+
"module": "components/input/input.component.js"
|
32250
31917
|
}
|
32251
31918
|
},
|
32252
31919
|
{
|
32253
31920
|
"kind": "method",
|
32254
|
-
"name": "
|
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.",
|
32255
31930
|
"return": {
|
32256
31931
|
"type": {
|
32257
|
-
"text": "
|
31932
|
+
"text": ""
|
32258
31933
|
}
|
32259
31934
|
},
|
32260
31935
|
"inheritedFrom": {
|
32261
|
-
"name": "
|
32262
|
-
"module": "
|
31936
|
+
"name": "Input",
|
31937
|
+
"module": "components/input/input.component.js"
|
32263
31938
|
}
|
32264
31939
|
},
|
32265
31940
|
{
|
32266
31941
|
"kind": "method",
|
32267
|
-
"name": "
|
32268
|
-
"
|
32269
|
-
|
32270
|
-
|
32271
|
-
|
32272
|
-
|
32273
|
-
|
32274
|
-
|
32275
|
-
|
32276
|
-
|
32277
|
-
|
32278
|
-
|
32279
|
-
|
32280
|
-
|
32281
|
-
"attribute": "data-aria-label",
|
32282
|
-
"reflects": true,
|
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
|
+
],
|
32283
31956
|
"inheritedFrom": {
|
32284
|
-
"name": "
|
32285
|
-
"module": "
|
31957
|
+
"name": "Input",
|
31958
|
+
"module": "components/input/input.component.js"
|
32286
31959
|
}
|
32287
31960
|
},
|
32288
31961
|
{
|
@@ -32492,130 +32165,308 @@
|
|
32492
32165
|
],
|
32493
32166
|
"events": [
|
32494
32167
|
{
|
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).",
|
32495
32178
|
"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",
|
32496
32205
|
"type": {
|
32497
32206
|
"text": "CustomEvent"
|
32498
32207
|
},
|
32499
|
-
"description": "(React:
|
32500
|
-
"reactName": "
|
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
|
+
}
|
32501
32214
|
},
|
32502
32215
|
{
|
32503
|
-
"name": "input",
|
32504
32216
|
"type": {
|
32505
|
-
"text": "
|
32217
|
+
"text": "EventConstructor"
|
32506
32218
|
},
|
32507
|
-
"
|
32508
|
-
|
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
|
+
}
|
32509
32245
|
},
|
32510
32246
|
{
|
32511
|
-
"
|
32512
|
-
"
|
32513
|
-
|
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
|
+
}
|
32514
32258
|
},
|
32515
32259
|
{
|
32516
|
-
"
|
32517
|
-
"
|
32518
|
-
|
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
|
+
}
|
32519
32270
|
},
|
32520
32271
|
{
|
32521
|
-
"
|
32522
|
-
"
|
32523
|
-
|
32524
|
-
|
32525
|
-
|
32526
|
-
|
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
|
+
},
|
32527
32284
|
{
|
32528
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
|
+
}
|
32309
|
+
},
|
32310
|
+
{
|
32311
|
+
"name": "prefix-text",
|
32529
32312
|
"type": {
|
32530
32313
|
"text": "string | undefined"
|
32531
32314
|
},
|
32532
|
-
"description": "The
|
32533
|
-
"fieldName": "
|
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
|
+
}
|
32321
|
+
},
|
32322
|
+
{
|
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
|
+
}
|
32333
|
+
},
|
32334
|
+
{
|
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
|
+
}
|
32346
|
+
},
|
32347
|
+
{
|
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
|
+
},
|
32359
|
+
{
|
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
|
+
}
|
32534
32370
|
},
|
32535
32371
|
{
|
32536
|
-
"name": "
|
32372
|
+
"name": "autocapitalize",
|
32537
32373
|
"type": {
|
32538
|
-
"text": "
|
32374
|
+
"text": "AutoCapitalizeType"
|
32539
32375
|
},
|
32540
|
-
"
|
32541
|
-
"
|
32542
|
-
"fieldName": "
|
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
|
+
}
|
32543
32383
|
},
|
32544
32384
|
{
|
32545
|
-
"name": "
|
32385
|
+
"name": "autocomplete",
|
32546
32386
|
"type": {
|
32547
|
-
"text": "
|
32387
|
+
"text": "AutoCompleteType"
|
32548
32388
|
},
|
32549
|
-
"
|
32550
|
-
"
|
32551
|
-
"fieldName": "
|
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
|
+
}
|
32552
32396
|
},
|
32553
32397
|
{
|
32554
|
-
"name": "
|
32398
|
+
"name": "autofocus",
|
32555
32399
|
"type": {
|
32556
|
-
"text": "
|
32400
|
+
"text": "boolean"
|
32557
32401
|
},
|
32558
|
-
"
|
32559
|
-
"
|
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
|
+
}
|
32560
32409
|
},
|
32561
32410
|
{
|
32562
|
-
"name": "
|
32411
|
+
"name": "dirname",
|
32563
32412
|
"type": {
|
32564
|
-
"text": "
|
32413
|
+
"text": "string | undefined"
|
32565
32414
|
},
|
32566
|
-
"description": "
|
32567
|
-
"
|
32568
|
-
"
|
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
|
+
}
|
32569
32421
|
},
|
32570
32422
|
{
|
32571
|
-
"name": "
|
32423
|
+
"name": "pattern",
|
32572
32424
|
"type": {
|
32573
|
-
"text": "string"
|
32425
|
+
"text": "string | undefined"
|
32574
32426
|
},
|
32575
|
-
"
|
32576
|
-
"
|
32577
|
-
"fieldName": "name",
|
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",
|
32578
32429
|
"inheritedFrom": {
|
32579
|
-
"name": "
|
32580
|
-
"module": "src/
|
32430
|
+
"name": "Input",
|
32431
|
+
"module": "src/components/input/input.component.ts"
|
32581
32432
|
}
|
32582
32433
|
},
|
32583
32434
|
{
|
32584
|
-
"name": "
|
32435
|
+
"name": "list",
|
32585
32436
|
"type": {
|
32586
|
-
"text": "string"
|
32437
|
+
"text": "string | undefined"
|
32587
32438
|
},
|
32588
|
-
"
|
32589
|
-
"
|
32590
|
-
"fieldName": "value",
|
32439
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
32440
|
+
"fieldName": "list",
|
32591
32441
|
"inheritedFrom": {
|
32592
|
-
"name": "
|
32593
|
-
"module": "src/
|
32442
|
+
"name": "Input",
|
32443
|
+
"module": "src/components/input/input.component.ts"
|
32594
32444
|
}
|
32595
32445
|
},
|
32596
32446
|
{
|
32597
|
-
"name": "
|
32447
|
+
"name": "size",
|
32598
32448
|
"type": {
|
32599
|
-
"text": "
|
32449
|
+
"text": "number | undefined | undefined"
|
32600
32450
|
},
|
32601
|
-
"description": "
|
32602
|
-
"
|
32451
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
32452
|
+
"default": "undefined",
|
32453
|
+
"fieldName": "size",
|
32603
32454
|
"inheritedFrom": {
|
32604
|
-
"name": "
|
32605
|
-
"module": "src/
|
32455
|
+
"name": "Input",
|
32456
|
+
"module": "src/components/input/input.component.ts"
|
32606
32457
|
}
|
32607
32458
|
},
|
32608
32459
|
{
|
32609
|
-
"name": "
|
32460
|
+
"name": "clear-aria-label",
|
32610
32461
|
"type": {
|
32611
|
-
"text": "string
|
32462
|
+
"text": "string"
|
32612
32463
|
},
|
32613
|
-
"default": "
|
32614
|
-
"description": "
|
32615
|
-
"fieldName": "
|
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",
|
32616
32467
|
"inheritedFrom": {
|
32617
|
-
"name": "
|
32618
|
-
"module": "src/
|
32468
|
+
"name": "Input",
|
32469
|
+
"module": "src/components/input/input.component.ts"
|
32619
32470
|
}
|
32620
32471
|
},
|
32621
32472
|
{
|
@@ -32731,23 +32582,136 @@
|
|
32731
32582
|
}
|
32732
32583
|
}
|
32733
32584
|
],
|
32734
|
-
"
|
32585
|
+
"cssProperties": [
|
32735
32586
|
{
|
32736
|
-
"
|
32737
|
-
"
|
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
|
+
}
|
32738
32593
|
},
|
32739
32594
|
{
|
32740
|
-
"
|
32741
|
-
"
|
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
|
+
{
|
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
|
+
}
|
32705
|
+
},
|
32706
|
+
{
|
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
|
+
}
|
32742
32713
|
}
|
32743
|
-
]
|
32744
|
-
"superclass": {
|
32745
|
-
"name": "FormfieldWrapper",
|
32746
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
32747
|
-
},
|
32748
|
-
"tagName": "mdc-select",
|
32749
|
-
"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 */",
|
32750
|
-
"customElement": true
|
32714
|
+
]
|
32751
32715
|
}
|
32752
32716
|
],
|
32753
32717
|
"exports": [
|
@@ -32755,8 +32719,8 @@
|
|
32755
32719
|
"kind": "js",
|
32756
32720
|
"name": "default",
|
32757
32721
|
"declaration": {
|
32758
|
-
"name": "
|
32759
|
-
"module": "components/
|
32722
|
+
"name": "Searchfield",
|
32723
|
+
"module": "components/searchfield/searchfield.component.js"
|
32760
32724
|
}
|
32761
32725
|
}
|
32762
32726
|
]
|