@momentum-design/components 0.120.27 → 0.120.29
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/custom-elements.json +1679 -1679
- package/dist/react/index.d.ts +4 -4
- package/dist/react/index.js +4 -4
- package/package.json +1 -1
|
@@ -24452,15 +24452,15 @@
|
|
|
24452
24452
|
},
|
|
24453
24453
|
{
|
|
24454
24454
|
"kind": "javascript-module",
|
|
24455
|
-
"path": "components/
|
|
24455
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
|
24456
24456
|
"declarations": [
|
|
24457
24457
|
{
|
|
24458
24458
|
"kind": "class",
|
|
24459
|
-
"description": "A
|
|
24460
|
-
"name": "
|
|
24459
|
+
"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.",
|
|
24460
|
+
"name": "MenuItemCheckbox",
|
|
24461
24461
|
"cssProperties": [
|
|
24462
24462
|
{
|
|
24463
|
-
"description": "Controls the padding on the left and right of the
|
|
24463
|
+
"description": "Controls the padding on the left and right of the menuitemcheckbox.",
|
|
24464
24464
|
"name": "--mdc-listitem-padding-left-and-right"
|
|
24465
24465
|
},
|
|
24466
24466
|
{
|
|
@@ -24616,7 +24616,7 @@
|
|
|
24616
24616
|
],
|
|
24617
24617
|
"slots": [
|
|
24618
24618
|
{
|
|
24619
|
-
"description": "slot for menu item
|
|
24619
|
+
"description": "slot for menu item checkbox controls to appear of leading end.",
|
|
24620
24620
|
"name": "leading-controls",
|
|
24621
24621
|
"inheritedFrom": {
|
|
24622
24622
|
"name": "ListItem",
|
|
@@ -24624,7 +24624,7 @@
|
|
|
24624
24624
|
}
|
|
24625
24625
|
},
|
|
24626
24626
|
{
|
|
24627
|
-
"description": "slot for menu item
|
|
24627
|
+
"description": "slot for menu item checkbox primary label.",
|
|
24628
24628
|
"name": "leading-text-primary-label",
|
|
24629
24629
|
"inheritedFrom": {
|
|
24630
24630
|
"name": "ListItem",
|
|
@@ -24632,7 +24632,7 @@
|
|
|
24632
24632
|
}
|
|
24633
24633
|
},
|
|
24634
24634
|
{
|
|
24635
|
-
"description": "slot for menu item
|
|
24635
|
+
"description": "slot for menu item checkbox secondary label.",
|
|
24636
24636
|
"name": "leading-text-secondary-label",
|
|
24637
24637
|
"inheritedFrom": {
|
|
24638
24638
|
"name": "ListItem",
|
|
@@ -24640,7 +24640,7 @@
|
|
|
24640
24640
|
}
|
|
24641
24641
|
},
|
|
24642
24642
|
{
|
|
24643
|
-
"description": "slot for menu item
|
|
24643
|
+
"description": "slot for menu item checkbox tertiary label.",
|
|
24644
24644
|
"name": "leading-text-tertiary-label",
|
|
24645
24645
|
"inheritedFrom": {
|
|
24646
24646
|
"name": "ListItem",
|
|
@@ -24648,7 +24648,7 @@
|
|
|
24648
24648
|
}
|
|
24649
24649
|
},
|
|
24650
24650
|
{
|
|
24651
|
-
"description": "slot for menu item
|
|
24651
|
+
"description": "slot for menu item checkbox side header text.",
|
|
24652
24652
|
"name": "trailing-text-side-header",
|
|
24653
24653
|
"inheritedFrom": {
|
|
24654
24654
|
"name": "ListItem",
|
|
@@ -24656,7 +24656,7 @@
|
|
|
24656
24656
|
}
|
|
24657
24657
|
},
|
|
24658
24658
|
{
|
|
24659
|
-
"description": "slot for menu item
|
|
24659
|
+
"description": "slot for menu item checkbox subline text.",
|
|
24660
24660
|
"name": "trailing-text-subline",
|
|
24661
24661
|
"inheritedFrom": {
|
|
24662
24662
|
"name": "ListItem",
|
|
@@ -24664,7 +24664,7 @@
|
|
|
24664
24664
|
}
|
|
24665
24665
|
},
|
|
24666
24666
|
{
|
|
24667
|
-
"description": "slot for menu item
|
|
24667
|
+
"description": "slot for menu item checkbox controls to appear of trailing end.",
|
|
24668
24668
|
"name": "trailing-controls",
|
|
24669
24669
|
"inheritedFrom": {
|
|
24670
24670
|
"name": "ListItem",
|
|
@@ -24688,7 +24688,7 @@
|
|
|
24688
24688
|
"text": "boolean"
|
|
24689
24689
|
},
|
|
24690
24690
|
"default": "false",
|
|
24691
|
-
"description": "The
|
|
24691
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
|
24692
24692
|
"attribute": "checked",
|
|
24693
24693
|
"reflects": true
|
|
24694
24694
|
},
|
|
@@ -24698,53 +24698,42 @@
|
|
|
24698
24698
|
"type": {
|
|
24699
24699
|
"text": "Indicator"
|
|
24700
24700
|
},
|
|
24701
|
-
"description": "The indicator attribute is used to differentiate between <b>
|
|
24702
|
-
"default": "'
|
|
24701
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
|
24702
|
+
"default": "'checkbox'",
|
|
24703
24703
|
"attribute": "indicator",
|
|
24704
24704
|
"reflects": true
|
|
24705
24705
|
},
|
|
24706
24706
|
{
|
|
24707
24707
|
"kind": "method",
|
|
24708
|
-
"name": "
|
|
24708
|
+
"name": "handleMouseClick",
|
|
24709
24709
|
"privacy": "private",
|
|
24710
|
-
"
|
|
24711
|
-
"type": {
|
|
24712
|
-
"text": "MenuItemRadio[]"
|
|
24713
|
-
}
|
|
24714
|
-
},
|
|
24715
|
-
"description": "Returns all radios within the same group (name)."
|
|
24710
|
+
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles checked if uncontrolled, and dispatches the 'change' event."
|
|
24716
24711
|
},
|
|
24717
24712
|
{
|
|
24718
24713
|
"kind": "method",
|
|
24719
|
-
"name": "
|
|
24714
|
+
"name": "staticCheckbox",
|
|
24720
24715
|
"privacy": "private",
|
|
24721
24716
|
"return": {
|
|
24722
24717
|
"type": {
|
|
24723
|
-
"text": "
|
|
24718
|
+
"text": ""
|
|
24724
24719
|
}
|
|
24725
24720
|
},
|
|
24726
|
-
"description": "
|
|
24727
|
-
},
|
|
24728
|
-
{
|
|
24729
|
-
"kind": "method",
|
|
24730
|
-
"name": "handleMouseClick",
|
|
24731
|
-
"privacy": "private",
|
|
24732
|
-
"description": "Handles click events to set checked state and uncheck siblings in the same group and container.\nIf the menuitemradio is not checked, it sets its checked state to `true`\nand sets all other menuitemradio elements of the same group with checked state to `false`."
|
|
24721
|
+
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
|
24733
24722
|
},
|
|
24734
24723
|
{
|
|
24735
24724
|
"kind": "method",
|
|
24736
|
-
"name": "
|
|
24725
|
+
"name": "staticToggle",
|
|
24737
24726
|
"privacy": "private",
|
|
24738
24727
|
"return": {
|
|
24739
24728
|
"type": {
|
|
24740
24729
|
"text": ""
|
|
24741
24730
|
}
|
|
24742
24731
|
},
|
|
24743
|
-
"description": "Returns a static
|
|
24732
|
+
"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."
|
|
24744
24733
|
},
|
|
24745
24734
|
{
|
|
24746
24735
|
"kind": "method",
|
|
24747
|
-
"name": "
|
|
24736
|
+
"name": "getCheckmarkIcon",
|
|
24748
24737
|
"privacy": "private",
|
|
24749
24738
|
"return": {
|
|
24750
24739
|
"type": {
|
|
@@ -24753,6 +24742,32 @@
|
|
|
24753
24742
|
},
|
|
24754
24743
|
"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."
|
|
24755
24744
|
},
|
|
24745
|
+
{
|
|
24746
|
+
"kind": "field",
|
|
24747
|
+
"name": "controlTypeProviderContext",
|
|
24748
|
+
"privacy": "private",
|
|
24749
|
+
"readonly": true,
|
|
24750
|
+
"inheritedFrom": {
|
|
24751
|
+
"name": "ControlTypeMixin",
|
|
24752
|
+
"module": "utils/mixins/ControlTypeMixin.js"
|
|
24753
|
+
}
|
|
24754
|
+
},
|
|
24755
|
+
{
|
|
24756
|
+
"kind": "field",
|
|
24757
|
+
"name": "controlType",
|
|
24758
|
+
"type": {
|
|
24759
|
+
"text": "ControlType | undefined"
|
|
24760
|
+
},
|
|
24761
|
+
"privacy": "public",
|
|
24762
|
+
"description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
|
|
24763
|
+
"default": "undefined",
|
|
24764
|
+
"attribute": "control-type",
|
|
24765
|
+
"reflects": true,
|
|
24766
|
+
"inheritedFrom": {
|
|
24767
|
+
"name": "ControlTypeMixin",
|
|
24768
|
+
"module": "utils/mixins/ControlTypeMixin.js"
|
|
24769
|
+
}
|
|
24770
|
+
},
|
|
24756
24771
|
{
|
|
24757
24772
|
"kind": "field",
|
|
24758
24773
|
"name": "arrowPosition",
|
|
@@ -25160,11 +25175,11 @@
|
|
|
25160
25175
|
"type": {
|
|
25161
25176
|
"text": "Event"
|
|
25162
25177
|
},
|
|
25163
|
-
"description": "(React: onChange) This event is dispatched when the
|
|
25178
|
+
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
|
25164
25179
|
"reactName": "onChange"
|
|
25165
25180
|
},
|
|
25166
25181
|
{
|
|
25167
|
-
"description": "(React: onClick) This event is dispatched when the
|
|
25182
|
+
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
|
25168
25183
|
"name": "click",
|
|
25169
25184
|
"reactName": "onClick",
|
|
25170
25185
|
"inheritedFrom": {
|
|
@@ -25173,7 +25188,7 @@
|
|
|
25173
25188
|
}
|
|
25174
25189
|
},
|
|
25175
25190
|
{
|
|
25176
|
-
"description": "(React: onFocus) This event is dispatched when the
|
|
25191
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
|
25177
25192
|
"name": "focus",
|
|
25178
25193
|
"reactName": "onFocus",
|
|
25179
25194
|
"inheritedFrom": {
|
|
@@ -25243,7 +25258,7 @@
|
|
|
25243
25258
|
"text": "boolean"
|
|
25244
25259
|
},
|
|
25245
25260
|
"default": "false",
|
|
25246
|
-
"description": "The
|
|
25261
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
|
25247
25262
|
"fieldName": "checked"
|
|
25248
25263
|
},
|
|
25249
25264
|
{
|
|
@@ -25251,10 +25266,23 @@
|
|
|
25251
25266
|
"type": {
|
|
25252
25267
|
"text": "Indicator"
|
|
25253
25268
|
},
|
|
25254
|
-
"description": "The indicator attribute is used to differentiate between <b>
|
|
25255
|
-
"default": "'
|
|
25269
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
|
25270
|
+
"default": "'checkbox'",
|
|
25256
25271
|
"fieldName": "indicator"
|
|
25257
25272
|
},
|
|
25273
|
+
{
|
|
25274
|
+
"name": "control-type",
|
|
25275
|
+
"type": {
|
|
25276
|
+
"text": "ControlType | undefined"
|
|
25277
|
+
},
|
|
25278
|
+
"description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
|
|
25279
|
+
"default": "undefined",
|
|
25280
|
+
"fieldName": "controlType",
|
|
25281
|
+
"inheritedFrom": {
|
|
25282
|
+
"name": "ControlTypeMixin",
|
|
25283
|
+
"module": "src/utils/mixins/ControlTypeMixin.ts"
|
|
25284
|
+
}
|
|
25285
|
+
},
|
|
25258
25286
|
{
|
|
25259
25287
|
"name": "arrow-position",
|
|
25260
25288
|
"type": {
|
|
@@ -25416,12 +25444,18 @@
|
|
|
25416
25444
|
}
|
|
25417
25445
|
}
|
|
25418
25446
|
],
|
|
25447
|
+
"mixins": [
|
|
25448
|
+
{
|
|
25449
|
+
"name": "ControlTypeMixin",
|
|
25450
|
+
"module": "/src/utils/mixins/ControlTypeMixin"
|
|
25451
|
+
}
|
|
25452
|
+
],
|
|
25419
25453
|
"superclass": {
|
|
25420
25454
|
"name": "MenuItem",
|
|
25421
25455
|
"module": "/src/components/menuitem/menuitem.component"
|
|
25422
25456
|
},
|
|
25423
|
-
"tagName": "mdc-
|
|
25424
|
-
"jsDoc": "/**\n * A
|
|
25457
|
+
"tagName": "mdc-menuitemcheckbox",
|
|
25458
|
+
"jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n *\n * @cssproperty --mdc-listitem-padding-left-and-right - Controls the padding on the left and right of the menuitemcheckbox.\n *\n * @csspart checkmark-icon - Allows customization of the checkmark icon.\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-arrow - Allows customization of leading arrow icon.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-arrow - Allows customization of trailing arrow icon.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
|
|
25425
25459
|
"customElement": true
|
|
25426
25460
|
}
|
|
25427
25461
|
],
|
|
@@ -25430,23 +25464,23 @@
|
|
|
25430
25464
|
"kind": "js",
|
|
25431
25465
|
"name": "default",
|
|
25432
25466
|
"declaration": {
|
|
25433
|
-
"name": "
|
|
25434
|
-
"module": "components/
|
|
25467
|
+
"name": "MenuItemCheckbox",
|
|
25468
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
|
25435
25469
|
}
|
|
25436
25470
|
}
|
|
25437
25471
|
]
|
|
25438
25472
|
},
|
|
25439
25473
|
{
|
|
25440
25474
|
"kind": "javascript-module",
|
|
25441
|
-
"path": "components/
|
|
25475
|
+
"path": "components/menuitemradio/menuitemradio.component.js",
|
|
25442
25476
|
"declarations": [
|
|
25443
25477
|
{
|
|
25444
25478
|
"kind": "class",
|
|
25445
|
-
"description": "A
|
|
25446
|
-
"name": "
|
|
25479
|
+
"description": "A menuitemradio component is a checkable menuitem that is used in a menu.\nA menuitemradio should be checked only one at a time. <br/>\nThere should be no focusable descendants inside this menuitemradio component.\n\nThe `checked` menuitemradio attribute is used to indicate that the menuitemradio is checked or not.\n\nMenu item radio has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nIf you want more than one item in a group to be checked, consider using menuitemcheckbox component.\n\nThe `indicator` attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>radio</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe checkmark will always be positioned on the trailing side.\n\nThe radio 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 third 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.",
|
|
25480
|
+
"name": "MenuItemRadio",
|
|
25447
25481
|
"cssProperties": [
|
|
25448
25482
|
{
|
|
25449
|
-
"description": "Controls the padding on the left and right of the
|
|
25483
|
+
"description": "Controls the padding on the left and right of the menuitemradio.",
|
|
25450
25484
|
"name": "--mdc-listitem-padding-left-and-right"
|
|
25451
25485
|
},
|
|
25452
25486
|
{
|
|
@@ -25602,7 +25636,7 @@
|
|
|
25602
25636
|
],
|
|
25603
25637
|
"slots": [
|
|
25604
25638
|
{
|
|
25605
|
-
"description": "slot for menu item
|
|
25639
|
+
"description": "slot for menu item radio controls to appear of leading end.",
|
|
25606
25640
|
"name": "leading-controls",
|
|
25607
25641
|
"inheritedFrom": {
|
|
25608
25642
|
"name": "ListItem",
|
|
@@ -25610,7 +25644,7 @@
|
|
|
25610
25644
|
}
|
|
25611
25645
|
},
|
|
25612
25646
|
{
|
|
25613
|
-
"description": "slot for menu item
|
|
25647
|
+
"description": "slot for menu item radio primary label.",
|
|
25614
25648
|
"name": "leading-text-primary-label",
|
|
25615
25649
|
"inheritedFrom": {
|
|
25616
25650
|
"name": "ListItem",
|
|
@@ -25618,7 +25652,7 @@
|
|
|
25618
25652
|
}
|
|
25619
25653
|
},
|
|
25620
25654
|
{
|
|
25621
|
-
"description": "slot for menu item
|
|
25655
|
+
"description": "slot for menu item radio secondary label.",
|
|
25622
25656
|
"name": "leading-text-secondary-label",
|
|
25623
25657
|
"inheritedFrom": {
|
|
25624
25658
|
"name": "ListItem",
|
|
@@ -25626,7 +25660,7 @@
|
|
|
25626
25660
|
}
|
|
25627
25661
|
},
|
|
25628
25662
|
{
|
|
25629
|
-
"description": "slot for menu item
|
|
25663
|
+
"description": "slot for menu item radio tertiary label.",
|
|
25630
25664
|
"name": "leading-text-tertiary-label",
|
|
25631
25665
|
"inheritedFrom": {
|
|
25632
25666
|
"name": "ListItem",
|
|
@@ -25634,7 +25668,7 @@
|
|
|
25634
25668
|
}
|
|
25635
25669
|
},
|
|
25636
25670
|
{
|
|
25637
|
-
"description": "slot for menu item
|
|
25671
|
+
"description": "slot for menu item radio side header text.",
|
|
25638
25672
|
"name": "trailing-text-side-header",
|
|
25639
25673
|
"inheritedFrom": {
|
|
25640
25674
|
"name": "ListItem",
|
|
@@ -25642,7 +25676,7 @@
|
|
|
25642
25676
|
}
|
|
25643
25677
|
},
|
|
25644
25678
|
{
|
|
25645
|
-
"description": "slot for menu item
|
|
25679
|
+
"description": "slot for menu item radio subline text.",
|
|
25646
25680
|
"name": "trailing-text-subline",
|
|
25647
25681
|
"inheritedFrom": {
|
|
25648
25682
|
"name": "ListItem",
|
|
@@ -25650,7 +25684,7 @@
|
|
|
25650
25684
|
}
|
|
25651
25685
|
},
|
|
25652
25686
|
{
|
|
25653
|
-
"description": "slot for menu item
|
|
25687
|
+
"description": "slot for menu item radio controls to appear of trailing end.",
|
|
25654
25688
|
"name": "trailing-controls",
|
|
25655
25689
|
"inheritedFrom": {
|
|
25656
25690
|
"name": "ListItem",
|
|
@@ -25674,7 +25708,7 @@
|
|
|
25674
25708
|
"text": "boolean"
|
|
25675
25709
|
},
|
|
25676
25710
|
"default": "false",
|
|
25677
|
-
"description": "The checked attribute is used to indicate that the
|
|
25711
|
+
"description": "The aria-checked attribute is used to indicate that the menuitemradio is checked or not.",
|
|
25678
25712
|
"attribute": "checked",
|
|
25679
25713
|
"reflects": true
|
|
25680
25714
|
},
|
|
@@ -25684,42 +25718,53 @@
|
|
|
25684
25718
|
"type": {
|
|
25685
25719
|
"text": "Indicator"
|
|
25686
25720
|
},
|
|
25687
|
-
"description": "The indicator attribute is used to differentiate between <b>
|
|
25688
|
-
"default": "'
|
|
25721
|
+
"description": "The indicator attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.",
|
|
25722
|
+
"default": "'radio'",
|
|
25689
25723
|
"attribute": "indicator",
|
|
25690
25724
|
"reflects": true
|
|
25691
25725
|
},
|
|
25692
25726
|
{
|
|
25693
25727
|
"kind": "method",
|
|
25694
|
-
"name": "
|
|
25728
|
+
"name": "getAllRadiosWithinSameGroup",
|
|
25695
25729
|
"privacy": "private",
|
|
25696
|
-
"
|
|
25730
|
+
"return": {
|
|
25731
|
+
"type": {
|
|
25732
|
+
"text": "MenuItemRadio[]"
|
|
25733
|
+
}
|
|
25734
|
+
},
|
|
25735
|
+
"description": "Returns all radios within the same group (name)."
|
|
25697
25736
|
},
|
|
25698
25737
|
{
|
|
25699
25738
|
"kind": "method",
|
|
25700
|
-
"name": "
|
|
25739
|
+
"name": "updateOtherRadiosCheckedState",
|
|
25701
25740
|
"privacy": "private",
|
|
25702
25741
|
"return": {
|
|
25703
25742
|
"type": {
|
|
25704
|
-
"text": ""
|
|
25743
|
+
"text": "void"
|
|
25705
25744
|
}
|
|
25706
25745
|
},
|
|
25707
|
-
"description": "
|
|
25746
|
+
"description": "Updates the checked state of all other radios in the same group.\nThis method is called when a radio is clicked to ensure that only one radio in the group can be checked at a time.\nIt sets the `checked` property of all other radios in the same group to `false`."
|
|
25708
25747
|
},
|
|
25709
25748
|
{
|
|
25710
25749
|
"kind": "method",
|
|
25711
|
-
"name": "
|
|
25750
|
+
"name": "handleMouseClick",
|
|
25751
|
+
"privacy": "private",
|
|
25752
|
+
"description": "Handles click events to set checked state and uncheck siblings in the same group and container.\nIf the menuitemradio is not checked, it sets its checked state to `true`\nand sets all other menuitemradio elements of the same group with checked state to `false`."
|
|
25753
|
+
},
|
|
25754
|
+
{
|
|
25755
|
+
"kind": "method",
|
|
25756
|
+
"name": "renderStaticRadio",
|
|
25712
25757
|
"privacy": "private",
|
|
25713
25758
|
"return": {
|
|
25714
25759
|
"type": {
|
|
25715
25760
|
"text": ""
|
|
25716
25761
|
}
|
|
25717
25762
|
},
|
|
25718
|
-
"description": "Returns a static
|
|
25763
|
+
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
|
25719
25764
|
},
|
|
25720
25765
|
{
|
|
25721
25766
|
"kind": "method",
|
|
25722
|
-
"name": "
|
|
25767
|
+
"name": "renderCheckmarkIcon",
|
|
25723
25768
|
"privacy": "private",
|
|
25724
25769
|
"return": {
|
|
25725
25770
|
"type": {
|
|
@@ -25728,32 +25773,6 @@
|
|
|
25728
25773
|
},
|
|
25729
25774
|
"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."
|
|
25730
25775
|
},
|
|
25731
|
-
{
|
|
25732
|
-
"kind": "field",
|
|
25733
|
-
"name": "controlTypeProviderContext",
|
|
25734
|
-
"privacy": "private",
|
|
25735
|
-
"readonly": true,
|
|
25736
|
-
"inheritedFrom": {
|
|
25737
|
-
"name": "ControlTypeMixin",
|
|
25738
|
-
"module": "utils/mixins/ControlTypeMixin.js"
|
|
25739
|
-
}
|
|
25740
|
-
},
|
|
25741
|
-
{
|
|
25742
|
-
"kind": "field",
|
|
25743
|
-
"name": "controlType",
|
|
25744
|
-
"type": {
|
|
25745
|
-
"text": "ControlType | undefined"
|
|
25746
|
-
},
|
|
25747
|
-
"privacy": "public",
|
|
25748
|
-
"description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
|
|
25749
|
-
"default": "undefined",
|
|
25750
|
-
"attribute": "control-type",
|
|
25751
|
-
"reflects": true,
|
|
25752
|
-
"inheritedFrom": {
|
|
25753
|
-
"name": "ControlTypeMixin",
|
|
25754
|
-
"module": "utils/mixins/ControlTypeMixin.js"
|
|
25755
|
-
}
|
|
25756
|
-
},
|
|
25757
25776
|
{
|
|
25758
25777
|
"kind": "field",
|
|
25759
25778
|
"name": "arrowPosition",
|
|
@@ -26161,11 +26180,11 @@
|
|
|
26161
26180
|
"type": {
|
|
26162
26181
|
"text": "Event"
|
|
26163
26182
|
},
|
|
26164
|
-
"description": "(React: onChange) This event is dispatched when the
|
|
26183
|
+
"description": "(React: onChange) This event is dispatched when the menuitemradio changes.",
|
|
26165
26184
|
"reactName": "onChange"
|
|
26166
26185
|
},
|
|
26167
26186
|
{
|
|
26168
|
-
"description": "(React: onClick) This event is dispatched when the
|
|
26187
|
+
"description": "(React: onClick) This event is dispatched when the menuitemradio is clicked.",
|
|
26169
26188
|
"name": "click",
|
|
26170
26189
|
"reactName": "onClick",
|
|
26171
26190
|
"inheritedFrom": {
|
|
@@ -26174,7 +26193,7 @@
|
|
|
26174
26193
|
}
|
|
26175
26194
|
},
|
|
26176
26195
|
{
|
|
26177
|
-
"description": "(React: onFocus) This event is dispatched when the
|
|
26196
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemradio receives focus.",
|
|
26178
26197
|
"name": "focus",
|
|
26179
26198
|
"reactName": "onFocus",
|
|
26180
26199
|
"inheritedFrom": {
|
|
@@ -26244,7 +26263,7 @@
|
|
|
26244
26263
|
"text": "boolean"
|
|
26245
26264
|
},
|
|
26246
26265
|
"default": "false",
|
|
26247
|
-
"description": "The checked attribute is used to indicate that the
|
|
26266
|
+
"description": "The aria-checked attribute is used to indicate that the menuitemradio is checked or not.",
|
|
26248
26267
|
"fieldName": "checked"
|
|
26249
26268
|
},
|
|
26250
26269
|
{
|
|
@@ -26252,23 +26271,10 @@
|
|
|
26252
26271
|
"type": {
|
|
26253
26272
|
"text": "Indicator"
|
|
26254
26273
|
},
|
|
26255
|
-
"description": "The indicator attribute is used to differentiate between <b>
|
|
26256
|
-
"default": "'
|
|
26274
|
+
"description": "The indicator attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.",
|
|
26275
|
+
"default": "'radio'",
|
|
26257
26276
|
"fieldName": "indicator"
|
|
26258
26277
|
},
|
|
26259
|
-
{
|
|
26260
|
-
"name": "control-type",
|
|
26261
|
-
"type": {
|
|
26262
|
-
"text": "ControlType | undefined"
|
|
26263
|
-
},
|
|
26264
|
-
"description": "Indicates whether the component is controlled or uncontrolled.\n- 'controlled' it will not handle any interaction itself, e.g. toggling a checkbox.\n- 'uncontrolled' it will handle interactions\n- undefined it will get the value from controltypeprovider, or default to 'uncontrolled'",
|
|
26265
|
-
"default": "undefined",
|
|
26266
|
-
"fieldName": "controlType",
|
|
26267
|
-
"inheritedFrom": {
|
|
26268
|
-
"name": "ControlTypeMixin",
|
|
26269
|
-
"module": "src/utils/mixins/ControlTypeMixin.ts"
|
|
26270
|
-
}
|
|
26271
|
-
},
|
|
26272
26278
|
{
|
|
26273
26279
|
"name": "arrow-position",
|
|
26274
26280
|
"type": {
|
|
@@ -26430,18 +26436,12 @@
|
|
|
26430
26436
|
}
|
|
26431
26437
|
}
|
|
26432
26438
|
],
|
|
26433
|
-
"mixins": [
|
|
26434
|
-
{
|
|
26435
|
-
"name": "ControlTypeMixin",
|
|
26436
|
-
"module": "/src/utils/mixins/ControlTypeMixin"
|
|
26437
|
-
}
|
|
26438
|
-
],
|
|
26439
26439
|
"superclass": {
|
|
26440
26440
|
"name": "MenuItem",
|
|
26441
26441
|
"module": "/src/components/menuitem/menuitem.component"
|
|
26442
26442
|
},
|
|
26443
|
-
"tagName": "mdc-
|
|
26444
|
-
"jsDoc": "/**\n * A
|
|
26443
|
+
"tagName": "mdc-menuitemradio",
|
|
26444
|
+
"jsDoc": "/**\n * A menuitemradio component is a checkable menuitem that is used in a menu.\n * A menuitemradio should be checked only one at a time. <br/>\n * There should be no focusable descendants inside this menuitemradio component.\n *\n * The `checked` menuitemradio attribute is used to indicate that the menuitemradio is checked or not.\n *\n * Menu item radio has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * If you want more than one item in a group to be checked, consider using menuitemcheckbox component.\n *\n * The `indicator` attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>radio</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the checkmark will always be positioned on the trailing side.\n *\n * The radio 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 third 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 * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitemradio\n *\n * @slot leading-controls - slot for menu item radio controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item radio primary label.\n * @slot leading-text-secondary-label - slot for menu item radio secondary label.\n * @slot leading-text-tertiary-label - slot for menu item radio tertiary label.\n * @slot trailing-text-side-header - slot for menu item radio side header text.\n * @slot trailing-text-subline - slot for menu item radio subline text.\n * @slot trailing-controls - slot for menu item radio controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemradio changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemradio is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemradio receives focus.\n *\n * @cssproperty --mdc-listitem-padding-left-and-right - Controls the padding on the left and right of the menuitemradio.\n *\n * @csspart checkmark-icon - Allows customization of the checkmark icon.\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-arrow - Allows customization of leading arrow icon.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-arrow - Allows customization of trailing arrow icon.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
|
|
26445
26445
|
"customElement": true
|
|
26446
26446
|
}
|
|
26447
26447
|
],
|
|
@@ -26450,8 +26450,8 @@
|
|
|
26450
26450
|
"kind": "js",
|
|
26451
26451
|
"name": "default",
|
|
26452
26452
|
"declaration": {
|
|
26453
|
-
"name": "
|
|
26454
|
-
"module": "components/
|
|
26453
|
+
"name": "MenuItemRadio",
|
|
26454
|
+
"module": "components/menuitemradio/menuitemradio.component.js"
|
|
26455
26455
|
}
|
|
26456
26456
|
}
|
|
26457
26457
|
]
|
|
@@ -37542,21 +37542,226 @@
|
|
|
37542
37542
|
},
|
|
37543
37543
|
{
|
|
37544
37544
|
"kind": "javascript-module",
|
|
37545
|
-
"path": "components/
|
|
37545
|
+
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
|
37546
37546
|
"declarations": [
|
|
37547
37547
|
{
|
|
37548
37548
|
"kind": "class",
|
|
37549
|
-
"description": "
|
|
37550
|
-
"name": "
|
|
37551
|
-
"
|
|
37552
|
-
{
|
|
37553
|
-
"
|
|
37554
|
-
"name": "
|
|
37555
|
-
"
|
|
37556
|
-
"
|
|
37557
|
-
|
|
37558
|
-
|
|
37559
|
-
|
|
37549
|
+
"description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
|
|
37550
|
+
"name": "ScreenreaderAnnouncer",
|
|
37551
|
+
"members": [
|
|
37552
|
+
{
|
|
37553
|
+
"kind": "field",
|
|
37554
|
+
"name": "announcement",
|
|
37555
|
+
"type": {
|
|
37556
|
+
"text": "string"
|
|
37557
|
+
},
|
|
37558
|
+
"default": "''",
|
|
37559
|
+
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
|
37560
|
+
"attribute": "announcement",
|
|
37561
|
+
"reflects": true
|
|
37562
|
+
},
|
|
37563
|
+
{
|
|
37564
|
+
"kind": "field",
|
|
37565
|
+
"name": "identity",
|
|
37566
|
+
"type": {
|
|
37567
|
+
"text": "string"
|
|
37568
|
+
},
|
|
37569
|
+
"default": "''",
|
|
37570
|
+
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
|
37571
|
+
"attribute": "identity",
|
|
37572
|
+
"reflects": true
|
|
37573
|
+
},
|
|
37574
|
+
{
|
|
37575
|
+
"kind": "field",
|
|
37576
|
+
"name": "dataAriaLive",
|
|
37577
|
+
"type": {
|
|
37578
|
+
"text": "AriaLive"
|
|
37579
|
+
},
|
|
37580
|
+
"description": "Aria live value for announcement.",
|
|
37581
|
+
"default": "'polite'",
|
|
37582
|
+
"attribute": "data-aria-live",
|
|
37583
|
+
"reflects": true
|
|
37584
|
+
},
|
|
37585
|
+
{
|
|
37586
|
+
"kind": "field",
|
|
37587
|
+
"name": "delay",
|
|
37588
|
+
"type": {
|
|
37589
|
+
"text": "number"
|
|
37590
|
+
},
|
|
37591
|
+
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
|
37592
|
+
"default": "150",
|
|
37593
|
+
"attribute": "delay",
|
|
37594
|
+
"reflects": true
|
|
37595
|
+
},
|
|
37596
|
+
{
|
|
37597
|
+
"kind": "field",
|
|
37598
|
+
"name": "timeout",
|
|
37599
|
+
"type": {
|
|
37600
|
+
"text": "number"
|
|
37601
|
+
},
|
|
37602
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
|
37603
|
+
"default": "20_000",
|
|
37604
|
+
"attribute": "timeout",
|
|
37605
|
+
"reflects": true
|
|
37606
|
+
},
|
|
37607
|
+
{
|
|
37608
|
+
"kind": "field",
|
|
37609
|
+
"name": "debounceTime",
|
|
37610
|
+
"type": {
|
|
37611
|
+
"text": "number"
|
|
37612
|
+
},
|
|
37613
|
+
"description": "The debounce time delay in milliseconds for announcements.",
|
|
37614
|
+
"default": "500",
|
|
37615
|
+
"attribute": "debounce-time",
|
|
37616
|
+
"reflects": true
|
|
37617
|
+
},
|
|
37618
|
+
{
|
|
37619
|
+
"kind": "method",
|
|
37620
|
+
"name": "announce",
|
|
37621
|
+
"parameters": [
|
|
37622
|
+
{
|
|
37623
|
+
"name": "announcement",
|
|
37624
|
+
"type": {
|
|
37625
|
+
"text": "string"
|
|
37626
|
+
},
|
|
37627
|
+
"description": "The announcement to be made."
|
|
37628
|
+
},
|
|
37629
|
+
{
|
|
37630
|
+
"name": "delay",
|
|
37631
|
+
"type": {
|
|
37632
|
+
"text": "number"
|
|
37633
|
+
},
|
|
37634
|
+
"description": "The delay in milliseconds before announcing the message."
|
|
37635
|
+
},
|
|
37636
|
+
{
|
|
37637
|
+
"name": "timeout",
|
|
37638
|
+
"type": {
|
|
37639
|
+
"text": "number"
|
|
37640
|
+
},
|
|
37641
|
+
"description": "The timeout in milliseconds before removing the announcement."
|
|
37642
|
+
},
|
|
37643
|
+
{
|
|
37644
|
+
"name": "ariaLive",
|
|
37645
|
+
"type": {
|
|
37646
|
+
"text": "AriaLive"
|
|
37647
|
+
},
|
|
37648
|
+
"description": "The aria live value for the announcement."
|
|
37649
|
+
}
|
|
37650
|
+
],
|
|
37651
|
+
"description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
|
|
37652
|
+
},
|
|
37653
|
+
{
|
|
37654
|
+
"kind": "method",
|
|
37655
|
+
"name": "clearTimeOutsAndAnnouncements",
|
|
37656
|
+
"privacy": "private",
|
|
37657
|
+
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
|
37658
|
+
},
|
|
37659
|
+
{
|
|
37660
|
+
"kind": "method",
|
|
37661
|
+
"name": "createAnnouncementAriaLiveRegion",
|
|
37662
|
+
"privacy": "private",
|
|
37663
|
+
"description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
|
|
37664
|
+
},
|
|
37665
|
+
{
|
|
37666
|
+
"kind": "method",
|
|
37667
|
+
"name": "setupDebouncedAnnounce",
|
|
37668
|
+
"privacy": "private",
|
|
37669
|
+
"description": "Creates a single debounced function that will read the latest this.announcement when executed.\n\nThis function is used to debounce the announcement so that it will only be made after\nthis.debounceTime milliseconds have passed since the last time this.announcement was updated."
|
|
37670
|
+
}
|
|
37671
|
+
],
|
|
37672
|
+
"attributes": [
|
|
37673
|
+
{
|
|
37674
|
+
"name": "announcement",
|
|
37675
|
+
"type": {
|
|
37676
|
+
"text": "string"
|
|
37677
|
+
},
|
|
37678
|
+
"default": "''",
|
|
37679
|
+
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
|
37680
|
+
"fieldName": "announcement"
|
|
37681
|
+
},
|
|
37682
|
+
{
|
|
37683
|
+
"name": "identity",
|
|
37684
|
+
"type": {
|
|
37685
|
+
"text": "string"
|
|
37686
|
+
},
|
|
37687
|
+
"default": "''",
|
|
37688
|
+
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
|
37689
|
+
"fieldName": "identity"
|
|
37690
|
+
},
|
|
37691
|
+
{
|
|
37692
|
+
"name": "data-aria-live",
|
|
37693
|
+
"type": {
|
|
37694
|
+
"text": "AriaLive"
|
|
37695
|
+
},
|
|
37696
|
+
"description": "Aria live value for announcement.",
|
|
37697
|
+
"default": "'polite'",
|
|
37698
|
+
"fieldName": "dataAriaLive"
|
|
37699
|
+
},
|
|
37700
|
+
{
|
|
37701
|
+
"name": "delay",
|
|
37702
|
+
"type": {
|
|
37703
|
+
"text": "number"
|
|
37704
|
+
},
|
|
37705
|
+
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
|
37706
|
+
"default": "150",
|
|
37707
|
+
"fieldName": "delay"
|
|
37708
|
+
},
|
|
37709
|
+
{
|
|
37710
|
+
"name": "timeout",
|
|
37711
|
+
"type": {
|
|
37712
|
+
"text": "number"
|
|
37713
|
+
},
|
|
37714
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
|
37715
|
+
"default": "20_000",
|
|
37716
|
+
"fieldName": "timeout"
|
|
37717
|
+
},
|
|
37718
|
+
{
|
|
37719
|
+
"name": "debounce-time",
|
|
37720
|
+
"type": {
|
|
37721
|
+
"text": "number"
|
|
37722
|
+
},
|
|
37723
|
+
"description": "The debounce time delay in milliseconds for announcements.",
|
|
37724
|
+
"default": "500",
|
|
37725
|
+
"fieldName": "debounceTime"
|
|
37726
|
+
}
|
|
37727
|
+
],
|
|
37728
|
+
"superclass": {
|
|
37729
|
+
"name": "Component",
|
|
37730
|
+
"module": "/src/models"
|
|
37731
|
+
},
|
|
37732
|
+
"tagName": "mdc-screenreaderannouncer",
|
|
37733
|
+
"jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
|
|
37734
|
+
"customElement": true
|
|
37735
|
+
}
|
|
37736
|
+
],
|
|
37737
|
+
"exports": [
|
|
37738
|
+
{
|
|
37739
|
+
"kind": "js",
|
|
37740
|
+
"name": "default",
|
|
37741
|
+
"declaration": {
|
|
37742
|
+
"name": "ScreenreaderAnnouncer",
|
|
37743
|
+
"module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
|
|
37744
|
+
}
|
|
37745
|
+
}
|
|
37746
|
+
]
|
|
37747
|
+
},
|
|
37748
|
+
{
|
|
37749
|
+
"kind": "javascript-module",
|
|
37750
|
+
"path": "components/searchfield/searchfield.component.js",
|
|
37751
|
+
"declarations": [
|
|
37752
|
+
{
|
|
37753
|
+
"kind": "class",
|
|
37754
|
+
"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.",
|
|
37755
|
+
"name": "Searchfield",
|
|
37756
|
+
"cssProperties": [
|
|
37757
|
+
{
|
|
37758
|
+
"description": "Font size for the label text.",
|
|
37759
|
+
"name": "--mdc-label-font-size",
|
|
37760
|
+
"inheritedFrom": {
|
|
37761
|
+
"name": "FormfieldWrapper",
|
|
37762
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
37763
|
+
}
|
|
37764
|
+
},
|
|
37560
37765
|
{
|
|
37561
37766
|
"description": "Font weight for the label text.",
|
|
37562
37767
|
"name": "--mdc-label-font-weight",
|
|
@@ -37614,29 +37819,53 @@
|
|
|
37614
37819
|
}
|
|
37615
37820
|
},
|
|
37616
37821
|
{
|
|
37617
|
-
"description": "
|
|
37618
|
-
"name": "--mdc-
|
|
37822
|
+
"description": "Text color for the input field",
|
|
37823
|
+
"name": "--mdc-input-text-color",
|
|
37824
|
+
"inheritedFrom": {
|
|
37825
|
+
"name": "Input",
|
|
37826
|
+
"module": "src/components/input/input.component.ts"
|
|
37827
|
+
}
|
|
37619
37828
|
},
|
|
37620
37829
|
{
|
|
37621
|
-
"description": "
|
|
37622
|
-
"name": "--mdc-
|
|
37830
|
+
"description": "Border color for the input container",
|
|
37831
|
+
"name": "--mdc-input-border-color",
|
|
37832
|
+
"inheritedFrom": {
|
|
37833
|
+
"name": "Input",
|
|
37834
|
+
"module": "src/components/input/input.component.ts"
|
|
37835
|
+
}
|
|
37623
37836
|
},
|
|
37624
37837
|
{
|
|
37625
|
-
"description": "
|
|
37626
|
-
"name": "--mdc-
|
|
37838
|
+
"description": "Background color for the input field",
|
|
37839
|
+
"name": "--mdc-input-background-color",
|
|
37840
|
+
"inheritedFrom": {
|
|
37841
|
+
"name": "Input",
|
|
37842
|
+
"module": "src/components/input/input.component.ts"
|
|
37843
|
+
}
|
|
37627
37844
|
},
|
|
37628
37845
|
{
|
|
37629
|
-
"description": "
|
|
37630
|
-
"name": "--mdc-
|
|
37846
|
+
"description": "Text color for the help text",
|
|
37847
|
+
"name": "--mdc-input-support-text-color",
|
|
37848
|
+
"inheritedFrom": {
|
|
37849
|
+
"name": "Input",
|
|
37850
|
+
"module": "src/components/input/input.component.ts"
|
|
37851
|
+
}
|
|
37631
37852
|
},
|
|
37632
37853
|
{
|
|
37633
|
-
"description": "
|
|
37634
|
-
"name": "--mdc-
|
|
37854
|
+
"description": "Text color for the selected text",
|
|
37855
|
+
"name": "--mdc-input-selection-text-color",
|
|
37856
|
+
"inheritedFrom": {
|
|
37857
|
+
"name": "Input",
|
|
37858
|
+
"module": "src/components/input/input.component.ts"
|
|
37859
|
+
}
|
|
37635
37860
|
},
|
|
37636
37861
|
{
|
|
37637
|
-
"description": "
|
|
37638
|
-
"name": "--mdc-
|
|
37639
|
-
|
|
37862
|
+
"description": "Background color for the selected text",
|
|
37863
|
+
"name": "--mdc-input-selection-background-color",
|
|
37864
|
+
"inheritedFrom": {
|
|
37865
|
+
"name": "Input",
|
|
37866
|
+
"module": "src/components/input/input.component.ts"
|
|
37867
|
+
}
|
|
37868
|
+
}
|
|
37640
37869
|
],
|
|
37641
37870
|
"cssParts": [
|
|
37642
37871
|
{
|
|
@@ -37702,12 +37931,60 @@
|
|
|
37702
37931
|
"name": "FormfieldWrapper",
|
|
37703
37932
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
37704
37933
|
}
|
|
37934
|
+
},
|
|
37935
|
+
{
|
|
37936
|
+
"description": "The leading icon element that is displayed before the input field.",
|
|
37937
|
+
"name": "leading-icon",
|
|
37938
|
+
"inheritedFrom": {
|
|
37939
|
+
"name": "Input",
|
|
37940
|
+
"module": "src/components/input/input.component.ts"
|
|
37941
|
+
}
|
|
37942
|
+
},
|
|
37943
|
+
{
|
|
37944
|
+
"description": "The prefix text element that is displayed before the input field.",
|
|
37945
|
+
"name": "prefix-text",
|
|
37946
|
+
"inheritedFrom": {
|
|
37947
|
+
"name": "Input",
|
|
37948
|
+
"module": "src/components/input/input.component.ts"
|
|
37949
|
+
}
|
|
37950
|
+
},
|
|
37951
|
+
{
|
|
37952
|
+
"description": "The container for the input field, leading icon, prefix text, and trailing button elements.",
|
|
37953
|
+
"name": "input-container",
|
|
37954
|
+
"inheritedFrom": {
|
|
37955
|
+
"name": "Input",
|
|
37956
|
+
"module": "src/components/input/input.component.ts"
|
|
37957
|
+
}
|
|
37958
|
+
},
|
|
37959
|
+
{
|
|
37960
|
+
"description": "The container for the input field, leading icon, and prefix text elements.",
|
|
37961
|
+
"name": "input-section",
|
|
37962
|
+
"inheritedFrom": {
|
|
37963
|
+
"name": "Input",
|
|
37964
|
+
"module": "src/components/input/input.component.ts"
|
|
37965
|
+
}
|
|
37966
|
+
},
|
|
37967
|
+
{
|
|
37968
|
+
"description": "The input field element.",
|
|
37969
|
+
"name": "input-text",
|
|
37970
|
+
"inheritedFrom": {
|
|
37971
|
+
"name": "Input",
|
|
37972
|
+
"module": "src/components/input/input.component.ts"
|
|
37973
|
+
}
|
|
37974
|
+
},
|
|
37975
|
+
{
|
|
37976
|
+
"description": "The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.",
|
|
37977
|
+
"name": "trailing-button",
|
|
37978
|
+
"inheritedFrom": {
|
|
37979
|
+
"name": "Input",
|
|
37980
|
+
"module": "src/components/input/input.component.ts"
|
|
37981
|
+
}
|
|
37705
37982
|
}
|
|
37706
37983
|
],
|
|
37707
37984
|
"slots": [
|
|
37708
37985
|
{
|
|
37709
|
-
"description": "
|
|
37710
|
-
"name": "
|
|
37986
|
+
"description": "Slot for input chips",
|
|
37987
|
+
"name": "filters"
|
|
37711
37988
|
},
|
|
37712
37989
|
{
|
|
37713
37990
|
"description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
|
|
@@ -37740,467 +38017,511 @@
|
|
|
37740
38017
|
"name": "FormfieldWrapper",
|
|
37741
38018
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
37742
38019
|
}
|
|
38020
|
+
},
|
|
38021
|
+
{
|
|
38022
|
+
"description": "Slot for the input element. If not provided, the input field will be rendered.",
|
|
38023
|
+
"name": "input",
|
|
38024
|
+
"inheritedFrom": {
|
|
38025
|
+
"name": "Input",
|
|
38026
|
+
"module": "src/components/input/input.component.ts"
|
|
38027
|
+
}
|
|
38028
|
+
},
|
|
38029
|
+
{
|
|
38030
|
+
"description": "Slot for the leading icon before the input field. If not provided, the `leadingIcon` property will be used to render the leading icon.",
|
|
38031
|
+
"name": "input-leading-icon",
|
|
38032
|
+
"inheritedFrom": {
|
|
38033
|
+
"name": "Input",
|
|
38034
|
+
"module": "src/components/input/input.component.ts"
|
|
38035
|
+
}
|
|
38036
|
+
},
|
|
38037
|
+
{
|
|
38038
|
+
"description": "Slot for the prefix text before the input field. If not provided, the `prefixText` property will be used to render the prefix text.",
|
|
38039
|
+
"name": "input-prefix-text",
|
|
38040
|
+
"inheritedFrom": {
|
|
38041
|
+
"name": "Input",
|
|
38042
|
+
"module": "src/components/input/input.component.ts"
|
|
38043
|
+
}
|
|
38044
|
+
},
|
|
38045
|
+
{
|
|
38046
|
+
"description": "Slot for the trailing button to clear the input field. If not provided, the clear button will be rendered when `trailingButton` property is set to true.",
|
|
38047
|
+
"name": "trailing-button",
|
|
38048
|
+
"inheritedFrom": {
|
|
38049
|
+
"name": "Input",
|
|
38050
|
+
"module": "src/components/input/input.component.ts"
|
|
38051
|
+
}
|
|
37743
38052
|
}
|
|
37744
38053
|
],
|
|
37745
38054
|
"members": [
|
|
37746
38055
|
{
|
|
37747
38056
|
"kind": "field",
|
|
37748
|
-
"name": "
|
|
38057
|
+
"name": "inputChips",
|
|
37749
38058
|
"type": {
|
|
37750
|
-
"text": "
|
|
37751
|
-
}
|
|
37752
|
-
|
|
37753
|
-
|
|
38059
|
+
"text": "Array<HTMLElement> | undefined"
|
|
38060
|
+
}
|
|
38061
|
+
},
|
|
38062
|
+
{
|
|
38063
|
+
"kind": "method",
|
|
38064
|
+
"name": "handleKeyDown",
|
|
38065
|
+
"privacy": "protected",
|
|
38066
|
+
"parameters": [
|
|
38067
|
+
{
|
|
38068
|
+
"name": "event",
|
|
38069
|
+
"type": {
|
|
38070
|
+
"text": "KeyboardEvent"
|
|
38071
|
+
},
|
|
38072
|
+
"description": "Keyboard event"
|
|
38073
|
+
}
|
|
38074
|
+
],
|
|
38075
|
+
"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.",
|
|
38076
|
+
"inheritedFrom": {
|
|
38077
|
+
"name": "Input",
|
|
38078
|
+
"module": "components/input/input.component.js"
|
|
38079
|
+
}
|
|
38080
|
+
},
|
|
38081
|
+
{
|
|
38082
|
+
"kind": "method",
|
|
38083
|
+
"name": "renderInputChips",
|
|
38084
|
+
"privacy": "private",
|
|
38085
|
+
"description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
|
|
38086
|
+
},
|
|
38087
|
+
{
|
|
38088
|
+
"kind": "method",
|
|
38089
|
+
"name": "clearInputText",
|
|
38090
|
+
"privacy": "protected",
|
|
38091
|
+
"description": "Clears the input field.",
|
|
38092
|
+
"inheritedFrom": {
|
|
38093
|
+
"name": "Input",
|
|
38094
|
+
"module": "components/input/input.component.js"
|
|
38095
|
+
}
|
|
37754
38096
|
},
|
|
37755
38097
|
{
|
|
37756
38098
|
"kind": "field",
|
|
37757
|
-
"name": "
|
|
38099
|
+
"name": "autoFocusOnMount",
|
|
37758
38100
|
"type": {
|
|
37759
|
-
"text": "
|
|
38101
|
+
"text": "boolean"
|
|
37760
38102
|
},
|
|
37761
|
-
"
|
|
37762
|
-
"
|
|
37763
|
-
"attribute": "
|
|
37764
|
-
"reflects": true
|
|
38103
|
+
"default": "false",
|
|
38104
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
38105
|
+
"attribute": "auto-focus-on-mount",
|
|
38106
|
+
"reflects": true,
|
|
38107
|
+
"inheritedFrom": {
|
|
38108
|
+
"name": "AutoFocusOnMountMixin",
|
|
38109
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
38110
|
+
}
|
|
37765
38111
|
},
|
|
37766
38112
|
{
|
|
37767
38113
|
"kind": "field",
|
|
37768
|
-
"name": "
|
|
38114
|
+
"name": "name",
|
|
37769
38115
|
"type": {
|
|
37770
|
-
"text": "
|
|
38116
|
+
"text": "string"
|
|
37771
38117
|
},
|
|
37772
|
-
"
|
|
37773
|
-
"
|
|
37774
|
-
"attribute": "
|
|
37775
|
-
"reflects": true
|
|
38118
|
+
"default": "''",
|
|
38119
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
|
38120
|
+
"attribute": "name",
|
|
38121
|
+
"reflects": true,
|
|
38122
|
+
"inheritedFrom": {
|
|
38123
|
+
"name": "FormInternalsMixin",
|
|
38124
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38125
|
+
}
|
|
37776
38126
|
},
|
|
37777
38127
|
{
|
|
37778
38128
|
"kind": "field",
|
|
37779
|
-
"name": "
|
|
38129
|
+
"name": "value",
|
|
37780
38130
|
"type": {
|
|
37781
|
-
"text": "
|
|
38131
|
+
"text": "string"
|
|
37782
38132
|
},
|
|
37783
|
-
"
|
|
37784
|
-
"
|
|
37785
|
-
"attribute": "
|
|
37786
|
-
"reflects": true
|
|
38133
|
+
"default": "''",
|
|
38134
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
38135
|
+
"attribute": "value",
|
|
38136
|
+
"reflects": true,
|
|
38137
|
+
"inheritedFrom": {
|
|
38138
|
+
"name": "FormInternalsMixin",
|
|
38139
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38140
|
+
}
|
|
37787
38141
|
},
|
|
37788
38142
|
{
|
|
37789
38143
|
"kind": "field",
|
|
37790
|
-
"name": "
|
|
38144
|
+
"name": "validationMessage",
|
|
37791
38145
|
"type": {
|
|
37792
|
-
"text": "
|
|
38146
|
+
"text": "string | undefined"
|
|
37793
38147
|
},
|
|
37794
|
-
"description": "
|
|
37795
|
-
"
|
|
37796
|
-
"
|
|
37797
|
-
"
|
|
38148
|
+
"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.",
|
|
38149
|
+
"attribute": "validation-message",
|
|
38150
|
+
"reflects": true,
|
|
38151
|
+
"inheritedFrom": {
|
|
38152
|
+
"name": "FormInternalsMixin",
|
|
38153
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38154
|
+
}
|
|
37798
38155
|
},
|
|
37799
38156
|
{
|
|
37800
38157
|
"kind": "field",
|
|
37801
|
-
"name": "
|
|
38158
|
+
"name": "validity",
|
|
37802
38159
|
"type": {
|
|
37803
|
-
"text": "
|
|
38160
|
+
"text": "ValidityState"
|
|
37804
38161
|
},
|
|
37805
|
-
"
|
|
37806
|
-
"
|
|
37807
|
-
|
|
38162
|
+
"readonly": true,
|
|
38163
|
+
"inheritedFrom": {
|
|
38164
|
+
"name": "FormInternalsMixin",
|
|
38165
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38166
|
+
}
|
|
38167
|
+
},
|
|
38168
|
+
{
|
|
38169
|
+
"kind": "field",
|
|
38170
|
+
"name": "willValidate",
|
|
38171
|
+
"readonly": true,
|
|
38172
|
+
"inheritedFrom": {
|
|
38173
|
+
"name": "FormInternalsMixin",
|
|
38174
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38175
|
+
}
|
|
37808
38176
|
},
|
|
37809
38177
|
{
|
|
37810
38178
|
"kind": "method",
|
|
37811
|
-
"name": "
|
|
37812
|
-
"
|
|
38179
|
+
"name": "setValidity",
|
|
38180
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
|
37813
38181
|
"return": {
|
|
37814
38182
|
"type": {
|
|
37815
|
-
"text": "
|
|
38183
|
+
"text": ""
|
|
37816
38184
|
}
|
|
37817
38185
|
},
|
|
37818
|
-
"
|
|
37819
|
-
|
|
37820
|
-
|
|
37821
|
-
|
|
37822
|
-
"text": "MouseEvent"
|
|
37823
|
-
},
|
|
37824
|
-
"description": "The event which triggered this function."
|
|
37825
|
-
}
|
|
37826
|
-
],
|
|
37827
|
-
"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."
|
|
38186
|
+
"inheritedFrom": {
|
|
38187
|
+
"name": "FormInternalsMixin",
|
|
38188
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38189
|
+
}
|
|
37828
38190
|
},
|
|
37829
38191
|
{
|
|
37830
38192
|
"kind": "method",
|
|
37831
|
-
"name": "
|
|
37832
|
-
"privacy": "private",
|
|
38193
|
+
"name": "checkValidity",
|
|
37833
38194
|
"return": {
|
|
37834
38195
|
"type": {
|
|
37835
|
-
"text": "
|
|
38196
|
+
"text": "boolean"
|
|
37836
38197
|
}
|
|
37837
38198
|
},
|
|
37838
|
-
"
|
|
37839
|
-
|
|
37840
|
-
|
|
37841
|
-
|
|
37842
|
-
"text": "Option | null"
|
|
37843
|
-
},
|
|
37844
|
-
"description": "The option element in DOM which gets selected."
|
|
37845
|
-
}
|
|
37846
|
-
],
|
|
37847
|
-
"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."
|
|
37848
|
-
},
|
|
37849
|
-
{
|
|
37850
|
-
"kind": "method",
|
|
37851
|
-
"name": "updateSelectedInChildOptions",
|
|
37852
|
-
"privacy": "private",
|
|
37853
|
-
"return": {
|
|
37854
|
-
"type": {
|
|
37855
|
-
"text": "void"
|
|
37856
|
-
}
|
|
37857
|
-
},
|
|
37858
|
-
"parameters": [
|
|
37859
|
-
{
|
|
37860
|
-
"name": "selectedOption",
|
|
37861
|
-
"type": {
|
|
37862
|
-
"text": "Option | null"
|
|
37863
|
-
},
|
|
37864
|
-
"description": "The option which gets selected"
|
|
37865
|
-
}
|
|
37866
|
-
],
|
|
37867
|
-
"description": "Sets selected attribute on the selected option and removes it from all options"
|
|
38199
|
+
"inheritedFrom": {
|
|
38200
|
+
"name": "FormInternalsMixin",
|
|
38201
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38202
|
+
}
|
|
37868
38203
|
},
|
|
37869
38204
|
{
|
|
37870
38205
|
"kind": "method",
|
|
37871
|
-
"name": "
|
|
37872
|
-
"
|
|
37873
|
-
|
|
37874
|
-
"
|
|
37875
|
-
|
|
37876
|
-
|
|
38206
|
+
"name": "reportValidity",
|
|
38207
|
+
"inheritedFrom": {
|
|
38208
|
+
"name": "FormInternalsMixin",
|
|
38209
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
38210
|
+
}
|
|
38211
|
+
},
|
|
38212
|
+
{
|
|
38213
|
+
"kind": "field",
|
|
38214
|
+
"name": "dataAriaLabel",
|
|
38215
|
+
"type": {
|
|
38216
|
+
"text": "string | null"
|
|
37877
38217
|
},
|
|
37878
|
-
"
|
|
38218
|
+
"default": "null",
|
|
38219
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
|
38220
|
+
"attribute": "data-aria-label",
|
|
38221
|
+
"reflects": true,
|
|
38222
|
+
"inheritedFrom": {
|
|
38223
|
+
"name": "DataAriaLabelMixin",
|
|
38224
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
|
38225
|
+
}
|
|
37879
38226
|
},
|
|
37880
38227
|
{
|
|
37881
|
-
"kind": "
|
|
37882
|
-
"name": "
|
|
37883
|
-
"
|
|
37884
|
-
|
|
37885
|
-
"type": {
|
|
37886
|
-
"text": "void"
|
|
37887
|
-
}
|
|
38228
|
+
"kind": "field",
|
|
38229
|
+
"name": "placeholder",
|
|
38230
|
+
"type": {
|
|
38231
|
+
"text": "string"
|
|
37888
38232
|
},
|
|
37889
|
-
"
|
|
37890
|
-
|
|
37891
|
-
|
|
37892
|
-
|
|
37893
|
-
|
|
37894
|
-
|
|
37895
|
-
|
|
37896
|
-
]
|
|
38233
|
+
"default": "''",
|
|
38234
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
|
38235
|
+
"attribute": "placeholder",
|
|
38236
|
+
"inheritedFrom": {
|
|
38237
|
+
"name": "Input",
|
|
38238
|
+
"module": "components/input/input.component.js"
|
|
38239
|
+
}
|
|
37897
38240
|
},
|
|
37898
38241
|
{
|
|
37899
|
-
"kind": "
|
|
37900
|
-
"name": "
|
|
37901
|
-
"
|
|
37902
|
-
|
|
37903
|
-
"type": {
|
|
37904
|
-
"text": "void"
|
|
37905
|
-
}
|
|
38242
|
+
"kind": "field",
|
|
38243
|
+
"name": "prefixText",
|
|
38244
|
+
"type": {
|
|
38245
|
+
"text": "string | undefined"
|
|
37906
38246
|
},
|
|
37907
|
-
"
|
|
37908
|
-
|
|
37909
|
-
|
|
37910
|
-
|
|
37911
|
-
|
|
37912
|
-
|
|
37913
|
-
}
|
|
37914
|
-
]
|
|
38247
|
+
"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.",
|
|
38248
|
+
"attribute": "prefix-text",
|
|
38249
|
+
"inheritedFrom": {
|
|
38250
|
+
"name": "Input",
|
|
38251
|
+
"module": "components/input/input.component.js"
|
|
38252
|
+
}
|
|
37915
38253
|
},
|
|
37916
38254
|
{
|
|
37917
|
-
"kind": "
|
|
37918
|
-
"name": "
|
|
37919
|
-
"
|
|
37920
|
-
|
|
37921
|
-
"type": {
|
|
37922
|
-
"text": "void"
|
|
37923
|
-
}
|
|
38255
|
+
"kind": "field",
|
|
38256
|
+
"name": "leadingIcon",
|
|
38257
|
+
"type": {
|
|
38258
|
+
"text": "IconNames | undefined"
|
|
37924
38259
|
},
|
|
37925
|
-
"
|
|
37926
|
-
|
|
37927
|
-
|
|
37928
|
-
|
|
37929
|
-
|
|
37930
|
-
|
|
37931
|
-
"description": "The mouse event which triggered this function."
|
|
37932
|
-
}
|
|
37933
|
-
],
|
|
37934
|
-
"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."
|
|
38260
|
+
"description": "The leading icon that is displayed before the input field.",
|
|
38261
|
+
"attribute": "leading-icon",
|
|
38262
|
+
"inheritedFrom": {
|
|
38263
|
+
"name": "Input",
|
|
38264
|
+
"module": "components/input/input.component.js"
|
|
38265
|
+
}
|
|
37935
38266
|
},
|
|
37936
38267
|
{
|
|
37937
|
-
"kind": "
|
|
37938
|
-
"name": "
|
|
37939
|
-
"
|
|
37940
|
-
|
|
37941
|
-
"type": {
|
|
37942
|
-
"text": "void"
|
|
37943
|
-
}
|
|
38268
|
+
"kind": "field",
|
|
38269
|
+
"name": "trailingButton",
|
|
38270
|
+
"type": {
|
|
38271
|
+
"text": "boolean"
|
|
37944
38272
|
},
|
|
37945
|
-
"
|
|
37946
|
-
|
|
37947
|
-
|
|
37948
|
-
|
|
37949
|
-
|
|
37950
|
-
|
|
37951
|
-
|
|
37952
|
-
}
|
|
37953
|
-
],
|
|
37954
|
-
"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."
|
|
38273
|
+
"default": "false",
|
|
38274
|
+
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
|
38275
|
+
"attribute": "trailing-button",
|
|
38276
|
+
"inheritedFrom": {
|
|
38277
|
+
"name": "Input",
|
|
38278
|
+
"module": "components/input/input.component.js"
|
|
38279
|
+
}
|
|
37955
38280
|
},
|
|
37956
38281
|
{
|
|
37957
|
-
"kind": "
|
|
37958
|
-
"name": "
|
|
37959
|
-
"
|
|
37960
|
-
|
|
37961
|
-
"type": {
|
|
37962
|
-
"text": ""
|
|
37963
|
-
}
|
|
38282
|
+
"kind": "field",
|
|
38283
|
+
"name": "maxlength",
|
|
38284
|
+
"type": {
|
|
38285
|
+
"text": "number | undefined"
|
|
37964
38286
|
},
|
|
37965
|
-
"
|
|
37966
|
-
|
|
37967
|
-
"name": "target",
|
|
37968
|
-
"type": {
|
|
37969
|
-
"text": "HTMLElement | null"
|
|
37970
|
-
},
|
|
37971
|
-
"description": "The target element that triggered the event."
|
|
37972
|
-
}
|
|
37973
|
-
],
|
|
37974
|
-
"description": "Retrieves the current index of the item that triggered the event.",
|
|
38287
|
+
"description": "The maximum number of characters that the input field can accept.",
|
|
38288
|
+
"attribute": "maxlength",
|
|
37975
38289
|
"inheritedFrom": {
|
|
37976
|
-
"name": "
|
|
37977
|
-
"module": "
|
|
38290
|
+
"name": "Input",
|
|
38291
|
+
"module": "components/input/input.component.js"
|
|
37978
38292
|
}
|
|
37979
38293
|
},
|
|
37980
38294
|
{
|
|
37981
|
-
"kind": "
|
|
37982
|
-
"name": "
|
|
37983
|
-
"
|
|
37984
|
-
|
|
37985
|
-
|
|
37986
|
-
|
|
37987
|
-
|
|
37988
|
-
"text": "number"
|
|
37989
|
-
},
|
|
37990
|
-
"description": "The index of the currently focused item."
|
|
37991
|
-
}
|
|
37992
|
-
],
|
|
37993
|
-
"description": "Reset all tabindex to -1 and set the tabindex of the current item to 0",
|
|
38295
|
+
"kind": "field",
|
|
38296
|
+
"name": "minlength",
|
|
38297
|
+
"type": {
|
|
38298
|
+
"text": "number | undefined"
|
|
38299
|
+
},
|
|
38300
|
+
"description": "The minimum number of characters that the input field can accept.",
|
|
38301
|
+
"attribute": "minlength",
|
|
37994
38302
|
"inheritedFrom": {
|
|
37995
|
-
"name": "
|
|
37996
|
-
"module": "
|
|
38303
|
+
"name": "Input",
|
|
38304
|
+
"module": "components/input/input.component.js"
|
|
37997
38305
|
}
|
|
37998
38306
|
},
|
|
37999
38307
|
{
|
|
38000
|
-
"kind": "
|
|
38001
|
-
"name": "
|
|
38002
|
-
"
|
|
38003
|
-
|
|
38004
|
-
{
|
|
38005
|
-
"name": "newIndex",
|
|
38006
|
-
"type": {
|
|
38007
|
-
"text": "number"
|
|
38008
|
-
},
|
|
38009
|
-
"description": "The index of the new item to focus."
|
|
38010
|
-
},
|
|
38011
|
-
{
|
|
38012
|
-
"name": "oldIndex",
|
|
38013
|
-
"optional": true,
|
|
38014
|
-
"type": {
|
|
38015
|
-
"text": "number"
|
|
38016
|
-
},
|
|
38017
|
-
"description": "The index of the currently focused item."
|
|
38018
|
-
},
|
|
38019
|
-
{
|
|
38020
|
-
"name": "focusNewItem",
|
|
38021
|
-
"default": "true",
|
|
38022
|
-
"description": "Call focus() on the new item or not. It should be false during firstUpdate"
|
|
38023
|
-
}
|
|
38024
|
-
],
|
|
38025
|
-
"description": "Resets the tabindex of the currently focused item and sets focus to a new item.",
|
|
38026
|
-
"return": {
|
|
38027
|
-
"type": {
|
|
38028
|
-
"text": ""
|
|
38029
|
-
}
|
|
38308
|
+
"kind": "field",
|
|
38309
|
+
"name": "autocapitalize",
|
|
38310
|
+
"type": {
|
|
38311
|
+
"text": "AutoCapitalizeType"
|
|
38030
38312
|
},
|
|
38313
|
+
"description": "The autocapitalize attribute of the input field.",
|
|
38314
|
+
"default": "'off'",
|
|
38315
|
+
"attribute": "autocapitalize",
|
|
38031
38316
|
"inheritedFrom": {
|
|
38032
|
-
"name": "
|
|
38033
|
-
"module": "
|
|
38317
|
+
"name": "Input",
|
|
38318
|
+
"module": "components/input/input.component.js"
|
|
38034
38319
|
}
|
|
38035
38320
|
},
|
|
38036
38321
|
{
|
|
38037
|
-
"kind": "
|
|
38038
|
-
"name": "
|
|
38039
|
-
"
|
|
38040
|
-
|
|
38041
|
-
|
|
38042
|
-
|
|
38043
|
-
|
|
38044
|
-
|
|
38045
|
-
|
|
38046
|
-
|
|
38047
|
-
|
|
38048
|
-
|
|
38049
|
-
|
|
38050
|
-
|
|
38051
|
-
|
|
38052
|
-
|
|
38053
|
-
|
|
38054
|
-
|
|
38055
|
-
],
|
|
38056
|
-
"description": "Resolves the key pressed by the user based on the direction of the layout.\nThis method is used to handle keyboard navigation in a right-to-left (RTL) layout.\nIt checks if the layout is RTL and adjusts the arrow keys accordingly.\nFor example, in RTL, the left arrow key behaves like the right arrow key and vice versa.",
|
|
38057
|
-
"return": {
|
|
38058
|
-
"type": {
|
|
38059
|
-
"text": ""
|
|
38060
|
-
}
|
|
38322
|
+
"kind": "field",
|
|
38323
|
+
"name": "autocomplete",
|
|
38324
|
+
"type": {
|
|
38325
|
+
"text": "AutoCompleteType"
|
|
38326
|
+
},
|
|
38327
|
+
"description": "The autocomplete attribute of the input field.",
|
|
38328
|
+
"default": "'off'",
|
|
38329
|
+
"attribute": "autocomplete",
|
|
38330
|
+
"inheritedFrom": {
|
|
38331
|
+
"name": "Input",
|
|
38332
|
+
"module": "components/input/input.component.js"
|
|
38333
|
+
}
|
|
38334
|
+
},
|
|
38335
|
+
{
|
|
38336
|
+
"kind": "field",
|
|
38337
|
+
"name": "dirname",
|
|
38338
|
+
"type": {
|
|
38339
|
+
"text": "string | undefined"
|
|
38061
38340
|
},
|
|
38341
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
|
38342
|
+
"attribute": "dirname",
|
|
38062
38343
|
"inheritedFrom": {
|
|
38063
|
-
"name": "
|
|
38064
|
-
"module": "
|
|
38344
|
+
"name": "Input",
|
|
38345
|
+
"module": "components/input/input.component.js"
|
|
38065
38346
|
}
|
|
38066
38347
|
},
|
|
38067
38348
|
{
|
|
38068
|
-
"kind": "
|
|
38069
|
-
"name": "
|
|
38070
|
-
"
|
|
38349
|
+
"kind": "field",
|
|
38350
|
+
"name": "pattern",
|
|
38351
|
+
"type": {
|
|
38352
|
+
"text": "string | undefined"
|
|
38353
|
+
},
|
|
38354
|
+
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
|
38355
|
+
"attribute": "pattern",
|
|
38071
38356
|
"inheritedFrom": {
|
|
38072
|
-
"name": "
|
|
38073
|
-
"module": "
|
|
38357
|
+
"name": "Input",
|
|
38358
|
+
"module": "components/input/input.component.js"
|
|
38074
38359
|
}
|
|
38075
38360
|
},
|
|
38076
38361
|
{
|
|
38077
38362
|
"kind": "field",
|
|
38078
|
-
"name": "
|
|
38363
|
+
"name": "list",
|
|
38079
38364
|
"type": {
|
|
38080
|
-
"text": "
|
|
38365
|
+
"text": "string | undefined"
|
|
38081
38366
|
},
|
|
38082
|
-
"
|
|
38083
|
-
"
|
|
38084
|
-
"attribute": "auto-focus-on-mount",
|
|
38085
|
-
"reflects": true,
|
|
38367
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
|
38368
|
+
"attribute": "list",
|
|
38086
38369
|
"inheritedFrom": {
|
|
38087
|
-
"name": "
|
|
38088
|
-
"module": "
|
|
38370
|
+
"name": "Input",
|
|
38371
|
+
"module": "components/input/input.component.js"
|
|
38089
38372
|
}
|
|
38090
38373
|
},
|
|
38091
38374
|
{
|
|
38092
38375
|
"kind": "field",
|
|
38093
|
-
"name": "
|
|
38376
|
+
"name": "size",
|
|
38094
38377
|
"type": {
|
|
38095
|
-
"text": "
|
|
38378
|
+
"text": "number | undefined | undefined"
|
|
38096
38379
|
},
|
|
38097
|
-
"
|
|
38098
|
-
"
|
|
38099
|
-
"attribute": "
|
|
38100
|
-
"reflects": true,
|
|
38380
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
|
38381
|
+
"default": "undefined",
|
|
38382
|
+
"attribute": "size",
|
|
38101
38383
|
"inheritedFrom": {
|
|
38102
|
-
"name": "
|
|
38103
|
-
"module": "
|
|
38384
|
+
"name": "Input",
|
|
38385
|
+
"module": "components/input/input.component.js"
|
|
38104
38386
|
}
|
|
38105
38387
|
},
|
|
38106
38388
|
{
|
|
38107
38389
|
"kind": "field",
|
|
38108
|
-
"name": "
|
|
38390
|
+
"name": "clearAriaLabel",
|
|
38109
38391
|
"type": {
|
|
38110
38392
|
"text": "string"
|
|
38111
38393
|
},
|
|
38112
38394
|
"default": "''",
|
|
38113
|
-
"description": "
|
|
38114
|
-
"attribute": "
|
|
38115
|
-
"reflects": true,
|
|
38395
|
+
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
|
38396
|
+
"attribute": "clear-aria-label",
|
|
38116
38397
|
"inheritedFrom": {
|
|
38117
|
-
"name": "
|
|
38118
|
-
"module": "
|
|
38398
|
+
"name": "Input",
|
|
38399
|
+
"module": "components/input/input.component.js"
|
|
38119
38400
|
}
|
|
38120
38401
|
},
|
|
38121
38402
|
{
|
|
38122
|
-
"kind": "
|
|
38123
|
-
"name": "
|
|
38124
|
-
"
|
|
38125
|
-
"text": "string | undefined"
|
|
38126
|
-
},
|
|
38127
|
-
"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.",
|
|
38128
|
-
"attribute": "validation-message",
|
|
38129
|
-
"reflects": true,
|
|
38403
|
+
"kind": "method",
|
|
38404
|
+
"name": "setInputValidity",
|
|
38405
|
+
"privacy": "private",
|
|
38130
38406
|
"inheritedFrom": {
|
|
38131
|
-
"name": "
|
|
38132
|
-
"module": "
|
|
38407
|
+
"name": "Input",
|
|
38408
|
+
"module": "components/input/input.component.js"
|
|
38133
38409
|
}
|
|
38134
38410
|
},
|
|
38135
38411
|
{
|
|
38136
|
-
"kind": "
|
|
38137
|
-
"name": "
|
|
38138
|
-
"
|
|
38139
|
-
|
|
38412
|
+
"kind": "method",
|
|
38413
|
+
"name": "updateValue",
|
|
38414
|
+
"privacy": "private",
|
|
38415
|
+
"description": "Updates the value of the input field.\nSets the form value.",
|
|
38416
|
+
"return": {
|
|
38417
|
+
"type": {
|
|
38418
|
+
"text": ""
|
|
38419
|
+
}
|
|
38140
38420
|
},
|
|
38141
|
-
"readonly": true,
|
|
38142
38421
|
"inheritedFrom": {
|
|
38143
|
-
"name": "
|
|
38144
|
-
"module": "
|
|
38422
|
+
"name": "Input",
|
|
38423
|
+
"module": "components/input/input.component.js"
|
|
38145
38424
|
}
|
|
38146
38425
|
},
|
|
38147
38426
|
{
|
|
38148
|
-
"kind": "
|
|
38149
|
-
"name": "
|
|
38150
|
-
"
|
|
38427
|
+
"kind": "method",
|
|
38428
|
+
"name": "onInput",
|
|
38429
|
+
"privacy": "private",
|
|
38430
|
+
"description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
|
|
38151
38431
|
"inheritedFrom": {
|
|
38152
|
-
"name": "
|
|
38153
|
-
"module": "
|
|
38432
|
+
"name": "Input",
|
|
38433
|
+
"module": "components/input/input.component.js"
|
|
38154
38434
|
}
|
|
38155
38435
|
},
|
|
38156
38436
|
{
|
|
38157
38437
|
"kind": "method",
|
|
38158
|
-
"name": "
|
|
38159
|
-
"
|
|
38438
|
+
"name": "onChange",
|
|
38439
|
+
"privacy": "private",
|
|
38440
|
+
"parameters": [
|
|
38441
|
+
{
|
|
38442
|
+
"name": "event",
|
|
38443
|
+
"type": {
|
|
38444
|
+
"text": "Event"
|
|
38445
|
+
},
|
|
38446
|
+
"description": "Event which contains information about the value change."
|
|
38447
|
+
}
|
|
38448
|
+
],
|
|
38449
|
+
"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",
|
|
38450
|
+
"inheritedFrom": {
|
|
38451
|
+
"name": "Input",
|
|
38452
|
+
"module": "components/input/input.component.js"
|
|
38453
|
+
}
|
|
38454
|
+
},
|
|
38455
|
+
{
|
|
38456
|
+
"kind": "method",
|
|
38457
|
+
"name": "renderLeadingIcon",
|
|
38458
|
+
"privacy": "protected",
|
|
38459
|
+
"description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
|
|
38160
38460
|
"return": {
|
|
38161
38461
|
"type": {
|
|
38162
38462
|
"text": ""
|
|
38163
38463
|
}
|
|
38164
38464
|
},
|
|
38165
38465
|
"inheritedFrom": {
|
|
38166
|
-
"name": "
|
|
38167
|
-
"module": "
|
|
38466
|
+
"name": "Input",
|
|
38467
|
+
"module": "components/input/input.component.js"
|
|
38168
38468
|
}
|
|
38169
38469
|
},
|
|
38170
38470
|
{
|
|
38171
38471
|
"kind": "method",
|
|
38172
|
-
"name": "
|
|
38472
|
+
"name": "renderPrefixText",
|
|
38473
|
+
"privacy": "protected",
|
|
38474
|
+
"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.",
|
|
38173
38475
|
"return": {
|
|
38174
38476
|
"type": {
|
|
38175
|
-
"text": "
|
|
38477
|
+
"text": ""
|
|
38176
38478
|
}
|
|
38177
38479
|
},
|
|
38178
38480
|
"inheritedFrom": {
|
|
38179
|
-
"name": "
|
|
38180
|
-
"module": "
|
|
38481
|
+
"name": "Input",
|
|
38482
|
+
"module": "components/input/input.component.js"
|
|
38181
38483
|
}
|
|
38182
38484
|
},
|
|
38183
38485
|
{
|
|
38184
38486
|
"kind": "method",
|
|
38185
|
-
"name": "
|
|
38487
|
+
"name": "renderTrailingButton",
|
|
38488
|
+
"privacy": "protected",
|
|
38489
|
+
"parameters": [
|
|
38490
|
+
{
|
|
38491
|
+
"name": "show",
|
|
38492
|
+
"default": "false"
|
|
38493
|
+
}
|
|
38494
|
+
],
|
|
38495
|
+
"description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
|
|
38496
|
+
"return": {
|
|
38497
|
+
"type": {
|
|
38498
|
+
"text": ""
|
|
38499
|
+
}
|
|
38500
|
+
},
|
|
38186
38501
|
"inheritedFrom": {
|
|
38187
|
-
"name": "
|
|
38188
|
-
"module": "
|
|
38502
|
+
"name": "Input",
|
|
38503
|
+
"module": "components/input/input.component.js"
|
|
38189
38504
|
}
|
|
38190
38505
|
},
|
|
38191
38506
|
{
|
|
38192
|
-
"kind": "
|
|
38193
|
-
"name": "
|
|
38194
|
-
"
|
|
38195
|
-
|
|
38196
|
-
|
|
38197
|
-
|
|
38198
|
-
|
|
38199
|
-
|
|
38200
|
-
|
|
38507
|
+
"kind": "method",
|
|
38508
|
+
"name": "renderInputElement",
|
|
38509
|
+
"privacy": "protected",
|
|
38510
|
+
"parameters": [
|
|
38511
|
+
{
|
|
38512
|
+
"name": "type",
|
|
38513
|
+
"type": {
|
|
38514
|
+
"text": "InputType"
|
|
38515
|
+
}
|
|
38516
|
+
},
|
|
38517
|
+
{
|
|
38518
|
+
"name": "hidePlaceholder",
|
|
38519
|
+
"default": "false"
|
|
38520
|
+
}
|
|
38521
|
+
],
|
|
38201
38522
|
"inheritedFrom": {
|
|
38202
|
-
"name": "
|
|
38203
|
-
"module": "
|
|
38523
|
+
"name": "Input",
|
|
38524
|
+
"module": "components/input/input.component.js"
|
|
38204
38525
|
}
|
|
38205
38526
|
},
|
|
38206
38527
|
{
|
|
@@ -38439,90 +38760,71 @@
|
|
|
38439
38760
|
],
|
|
38440
38761
|
"events": [
|
|
38441
38762
|
{
|
|
38442
|
-
"
|
|
38443
|
-
"type": {
|
|
38444
|
-
"text": "CustomEvent"
|
|
38445
|
-
},
|
|
38446
|
-
"description": "(React: onChange) This event is dispatched when the select is changed.",
|
|
38447
|
-
"reactName": "onChange"
|
|
38448
|
-
},
|
|
38449
|
-
{
|
|
38763
|
+
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
|
38450
38764
|
"name": "input",
|
|
38451
|
-
"
|
|
38452
|
-
|
|
38453
|
-
|
|
38454
|
-
|
|
38455
|
-
|
|
38456
|
-
},
|
|
38457
|
-
{
|
|
38458
|
-
"description": "(React: onClick) This event is dispatched when the select is clicked.",
|
|
38459
|
-
"name": "click",
|
|
38460
|
-
"reactName": "onClick"
|
|
38461
|
-
},
|
|
38462
|
-
{
|
|
38463
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
|
|
38464
|
-
"name": "keydown",
|
|
38465
|
-
"reactName": "onKeyDown"
|
|
38466
|
-
},
|
|
38467
|
-
{
|
|
38468
|
-
"description": "(React: onFocus) This event is dispatched when the select receives focus.",
|
|
38469
|
-
"name": "focus",
|
|
38470
|
-
"reactName": "onFocus"
|
|
38471
|
-
}
|
|
38472
|
-
],
|
|
38473
|
-
"attributes": [
|
|
38474
|
-
{
|
|
38475
|
-
"name": "placeholder",
|
|
38476
|
-
"type": {
|
|
38477
|
-
"text": "string | undefined"
|
|
38478
|
-
},
|
|
38479
|
-
"description": "The placeholder text which will be shown on the text if provided.",
|
|
38480
|
-
"fieldName": "placeholder"
|
|
38481
|
-
},
|
|
38482
|
-
{
|
|
38483
|
-
"name": "placement",
|
|
38484
|
-
"type": {
|
|
38485
|
-
"text": "Placement"
|
|
38486
|
-
},
|
|
38487
|
-
"description": "The placement of the popover within Select component.\nThis defines the position of the popover relative to the select input field.\n\nPossible values:\n - 'top-start'\n - 'bottom-start'",
|
|
38488
|
-
"default": "'bottom-start'",
|
|
38489
|
-
"fieldName": "placement"
|
|
38765
|
+
"reactName": "onInput",
|
|
38766
|
+
"inheritedFrom": {
|
|
38767
|
+
"name": "Input",
|
|
38768
|
+
"module": "src/components/input/input.component.ts"
|
|
38769
|
+
}
|
|
38490
38770
|
},
|
|
38491
38771
|
{
|
|
38492
|
-
"
|
|
38493
|
-
"
|
|
38494
|
-
|
|
38495
|
-
|
|
38496
|
-
|
|
38497
|
-
|
|
38498
|
-
|
|
38772
|
+
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
|
38773
|
+
"name": "change",
|
|
38774
|
+
"reactName": "onChange",
|
|
38775
|
+
"inheritedFrom": {
|
|
38776
|
+
"name": "Input",
|
|
38777
|
+
"module": "src/components/input/input.component.ts"
|
|
38778
|
+
}
|
|
38499
38779
|
},
|
|
38500
38780
|
{
|
|
38501
|
-
"
|
|
38502
|
-
"
|
|
38503
|
-
|
|
38504
|
-
|
|
38505
|
-
|
|
38506
|
-
|
|
38507
|
-
|
|
38781
|
+
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
|
38782
|
+
"name": "focus",
|
|
38783
|
+
"reactName": "onFocus",
|
|
38784
|
+
"inheritedFrom": {
|
|
38785
|
+
"name": "Input",
|
|
38786
|
+
"module": "src/components/input/input.component.ts"
|
|
38787
|
+
}
|
|
38508
38788
|
},
|
|
38509
38789
|
{
|
|
38510
|
-
"
|
|
38790
|
+
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
|
38791
|
+
"name": "blur",
|
|
38792
|
+
"reactName": "onBlur",
|
|
38793
|
+
"inheritedFrom": {
|
|
38794
|
+
"name": "Input",
|
|
38795
|
+
"module": "src/components/input/input.component.ts"
|
|
38796
|
+
}
|
|
38797
|
+
},
|
|
38798
|
+
{
|
|
38799
|
+
"name": "clear",
|
|
38511
38800
|
"type": {
|
|
38512
|
-
"text": "
|
|
38801
|
+
"text": "CustomEvent"
|
|
38513
38802
|
},
|
|
38514
|
-
"description": "
|
|
38515
|
-
"
|
|
38516
|
-
"
|
|
38803
|
+
"description": "(React: onClear) This event is dispatched when the input text is cleared.",
|
|
38804
|
+
"reactName": "onClear",
|
|
38805
|
+
"inheritedFrom": {
|
|
38806
|
+
"name": "Input",
|
|
38807
|
+
"module": "src/components/input/input.component.ts"
|
|
38808
|
+
}
|
|
38517
38809
|
},
|
|
38518
38810
|
{
|
|
38519
|
-
"name": "backdrop-append-to",
|
|
38520
38811
|
"type": {
|
|
38521
|
-
"text": "
|
|
38812
|
+
"text": "EventConstructor"
|
|
38522
38813
|
},
|
|
38523
|
-
"
|
|
38524
|
-
|
|
38525
|
-
|
|
38814
|
+
"inheritedFrom": {
|
|
38815
|
+
"name": "Input",
|
|
38816
|
+
"module": "src/components/input/input.component.ts"
|
|
38817
|
+
}
|
|
38818
|
+
}
|
|
38819
|
+
],
|
|
38820
|
+
"superclass": {
|
|
38821
|
+
"name": "Input",
|
|
38822
|
+
"module": "/src/components/input/input.component"
|
|
38823
|
+
},
|
|
38824
|
+
"tagName": "mdc-searchfield",
|
|
38825
|
+
"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 * @slot label - Slot for the label element. If not provided, the `label` property will be used to render the label.\n * @slot toggletip - Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.\n * @slot help-icon - Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.\n * @slot help-text - Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.\n * @slot input - Slot for the input element. If not provided, the input field will be rendered.\n * @slot input-leading-icon - Slot for the leading icon before the input field. If not provided, the `leadingIcon` property will be used to render the leading icon.\n * @slot input-prefix-text - Slot for the prefix text before the input field. If not provided, the `prefixText` property will be used to render the prefix text.\n * @slot trailing-button - Slot for the trailing button to clear the input field. If not provided, the clear button will be rendered when `trailingButton` property is set to true.\n *\n * @cssproperty --mdc-label-font-size - Font size for the label text.\n * @cssproperty --mdc-label-font-weight - Font weight for the label text.\n * @cssproperty --mdc-label-line-height - Line height for the label text.\n * @cssproperty --mdc-label-color - Color for the label text.\n * @cssproperty --mdc-help-text-font-size - Font size for the help text.\n * @cssproperty --mdc-help-text-font-weight - Font weight for the help text.\n * @cssproperty --mdc-help-text-line-height - Line height for the help text.\n * @cssproperty --mdc-help-text-color - Color for the help text.\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n * @csspart leading-icon - The leading icon element that is displayed before the input field.\n * @csspart prefix-text - The prefix text element that is displayed before the input field.\n * @csspart input-container - The container for the input field, leading icon, prefix text, and trailing button elements.\n * @csspart input-section - The container for the input field, leading icon, and prefix text elements.\n * @csspart input-text - The input field element.\n * @csspart trailing-button - The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.\n */",
|
|
38826
|
+
"customElement": true,
|
|
38827
|
+
"attributes": [
|
|
38526
38828
|
{
|
|
38527
38829
|
"name": "auto-focus-on-mount",
|
|
38528
38830
|
"type": {
|
|
@@ -38587,6 +38889,168 @@
|
|
|
38587
38889
|
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
|
38588
38890
|
}
|
|
38589
38891
|
},
|
|
38892
|
+
{
|
|
38893
|
+
"name": "placeholder",
|
|
38894
|
+
"type": {
|
|
38895
|
+
"text": "string"
|
|
38896
|
+
},
|
|
38897
|
+
"default": "''",
|
|
38898
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
|
38899
|
+
"fieldName": "placeholder",
|
|
38900
|
+
"inheritedFrom": {
|
|
38901
|
+
"name": "Input",
|
|
38902
|
+
"module": "src/components/input/input.component.ts"
|
|
38903
|
+
}
|
|
38904
|
+
},
|
|
38905
|
+
{
|
|
38906
|
+
"name": "prefix-text",
|
|
38907
|
+
"type": {
|
|
38908
|
+
"text": "string | undefined"
|
|
38909
|
+
},
|
|
38910
|
+
"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.",
|
|
38911
|
+
"fieldName": "prefixText",
|
|
38912
|
+
"inheritedFrom": {
|
|
38913
|
+
"name": "Input",
|
|
38914
|
+
"module": "src/components/input/input.component.ts"
|
|
38915
|
+
}
|
|
38916
|
+
},
|
|
38917
|
+
{
|
|
38918
|
+
"name": "leading-icon",
|
|
38919
|
+
"type": {
|
|
38920
|
+
"text": "IconNames | undefined"
|
|
38921
|
+
},
|
|
38922
|
+
"description": "The leading icon that is displayed before the input field.",
|
|
38923
|
+
"fieldName": "leadingIcon",
|
|
38924
|
+
"inheritedFrom": {
|
|
38925
|
+
"name": "Input",
|
|
38926
|
+
"module": "src/components/input/input.component.ts"
|
|
38927
|
+
}
|
|
38928
|
+
},
|
|
38929
|
+
{
|
|
38930
|
+
"name": "trailing-button",
|
|
38931
|
+
"type": {
|
|
38932
|
+
"text": "boolean"
|
|
38933
|
+
},
|
|
38934
|
+
"default": "false",
|
|
38935
|
+
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
|
38936
|
+
"fieldName": "trailingButton",
|
|
38937
|
+
"inheritedFrom": {
|
|
38938
|
+
"name": "Input",
|
|
38939
|
+
"module": "src/components/input/input.component.ts"
|
|
38940
|
+
}
|
|
38941
|
+
},
|
|
38942
|
+
{
|
|
38943
|
+
"name": "maxlength",
|
|
38944
|
+
"type": {
|
|
38945
|
+
"text": "number | undefined"
|
|
38946
|
+
},
|
|
38947
|
+
"description": "The maximum number of characters that the input field can accept.",
|
|
38948
|
+
"fieldName": "maxlength",
|
|
38949
|
+
"inheritedFrom": {
|
|
38950
|
+
"name": "Input",
|
|
38951
|
+
"module": "src/components/input/input.component.ts"
|
|
38952
|
+
}
|
|
38953
|
+
},
|
|
38954
|
+
{
|
|
38955
|
+
"name": "minlength",
|
|
38956
|
+
"type": {
|
|
38957
|
+
"text": "number | undefined"
|
|
38958
|
+
},
|
|
38959
|
+
"description": "The minimum number of characters that the input field can accept.",
|
|
38960
|
+
"fieldName": "minlength",
|
|
38961
|
+
"inheritedFrom": {
|
|
38962
|
+
"name": "Input",
|
|
38963
|
+
"module": "src/components/input/input.component.ts"
|
|
38964
|
+
}
|
|
38965
|
+
},
|
|
38966
|
+
{
|
|
38967
|
+
"name": "autocapitalize",
|
|
38968
|
+
"type": {
|
|
38969
|
+
"text": "AutoCapitalizeType"
|
|
38970
|
+
},
|
|
38971
|
+
"description": "The autocapitalize attribute of the input field.",
|
|
38972
|
+
"default": "'off'",
|
|
38973
|
+
"fieldName": "autocapitalize",
|
|
38974
|
+
"inheritedFrom": {
|
|
38975
|
+
"name": "Input",
|
|
38976
|
+
"module": "src/components/input/input.component.ts"
|
|
38977
|
+
}
|
|
38978
|
+
},
|
|
38979
|
+
{
|
|
38980
|
+
"name": "autocomplete",
|
|
38981
|
+
"type": {
|
|
38982
|
+
"text": "AutoCompleteType"
|
|
38983
|
+
},
|
|
38984
|
+
"description": "The autocomplete attribute of the input field.",
|
|
38985
|
+
"default": "'off'",
|
|
38986
|
+
"fieldName": "autocomplete",
|
|
38987
|
+
"inheritedFrom": {
|
|
38988
|
+
"name": "Input",
|
|
38989
|
+
"module": "src/components/input/input.component.ts"
|
|
38990
|
+
}
|
|
38991
|
+
},
|
|
38992
|
+
{
|
|
38993
|
+
"name": "dirname",
|
|
38994
|
+
"type": {
|
|
38995
|
+
"text": "string | undefined"
|
|
38996
|
+
},
|
|
38997
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
|
38998
|
+
"fieldName": "dirname",
|
|
38999
|
+
"inheritedFrom": {
|
|
39000
|
+
"name": "Input",
|
|
39001
|
+
"module": "src/components/input/input.component.ts"
|
|
39002
|
+
}
|
|
39003
|
+
},
|
|
39004
|
+
{
|
|
39005
|
+
"name": "pattern",
|
|
39006
|
+
"type": {
|
|
39007
|
+
"text": "string | undefined"
|
|
39008
|
+
},
|
|
39009
|
+
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
|
39010
|
+
"fieldName": "pattern",
|
|
39011
|
+
"inheritedFrom": {
|
|
39012
|
+
"name": "Input",
|
|
39013
|
+
"module": "src/components/input/input.component.ts"
|
|
39014
|
+
}
|
|
39015
|
+
},
|
|
39016
|
+
{
|
|
39017
|
+
"name": "list",
|
|
39018
|
+
"type": {
|
|
39019
|
+
"text": "string | undefined"
|
|
39020
|
+
},
|
|
39021
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
|
39022
|
+
"fieldName": "list",
|
|
39023
|
+
"inheritedFrom": {
|
|
39024
|
+
"name": "Input",
|
|
39025
|
+
"module": "src/components/input/input.component.ts"
|
|
39026
|
+
}
|
|
39027
|
+
},
|
|
39028
|
+
{
|
|
39029
|
+
"name": "size",
|
|
39030
|
+
"type": {
|
|
39031
|
+
"text": "number | undefined | undefined"
|
|
39032
|
+
},
|
|
39033
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
|
39034
|
+
"default": "undefined",
|
|
39035
|
+
"fieldName": "size",
|
|
39036
|
+
"inheritedFrom": {
|
|
39037
|
+
"name": "Input",
|
|
39038
|
+
"module": "src/components/input/input.component.ts"
|
|
39039
|
+
}
|
|
39040
|
+
},
|
|
39041
|
+
{
|
|
39042
|
+
"name": "clear-aria-label",
|
|
39043
|
+
"type": {
|
|
39044
|
+
"text": "string"
|
|
39045
|
+
},
|
|
39046
|
+
"default": "''",
|
|
39047
|
+
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
|
39048
|
+
"fieldName": "clearAriaLabel",
|
|
39049
|
+
"inheritedFrom": {
|
|
39050
|
+
"name": "Input",
|
|
39051
|
+
"module": "src/components/input/input.component.ts"
|
|
39052
|
+
}
|
|
39053
|
+
},
|
|
38590
39054
|
{
|
|
38591
39055
|
"name": "disabled",
|
|
38592
39056
|
"type": {
|
|
@@ -38702,57 +39166,28 @@
|
|
|
38702
39166
|
"type": {
|
|
38703
39167
|
"text": "boolean"
|
|
38704
39168
|
},
|
|
38705
|
-
"default": "false",
|
|
38706
|
-
"description": "Determines whether the form field is read-only.",
|
|
38707
|
-
"fieldName": "readonly",
|
|
38708
|
-
"inheritedFrom": {
|
|
38709
|
-
"name": "FormfieldWrapper",
|
|
38710
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
38711
|
-
}
|
|
38712
|
-
},
|
|
38713
|
-
{
|
|
38714
|
-
"name": "soft-disabled",
|
|
38715
|
-
"type": {
|
|
38716
|
-
"text": "boolean"
|
|
38717
|
-
},
|
|
38718
|
-
"default": "false",
|
|
38719
|
-
"description": "Determines whether the form field is soft-disabled.",
|
|
38720
|
-
"fieldName": "softDisabled",
|
|
38721
|
-
"inheritedFrom": {
|
|
38722
|
-
"name": "FormfieldWrapper",
|
|
38723
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
38724
|
-
}
|
|
38725
|
-
}
|
|
38726
|
-
],
|
|
38727
|
-
"mixins": [
|
|
38728
|
-
{
|
|
38729
|
-
"name": "ListNavigationMixin",
|
|
38730
|
-
"module": "/src/utils/mixins/ListNavigationMixin"
|
|
38731
|
-
},
|
|
38732
|
-
{
|
|
38733
|
-
"name": "CaptureDestroyEventForChildElement",
|
|
38734
|
-
"module": "/src/utils/mixins/lifecycle/CaptureDestroyEventForChildElement"
|
|
38735
|
-
},
|
|
38736
|
-
{
|
|
38737
|
-
"name": "AutoFocusOnMountMixin",
|
|
38738
|
-
"module": "/src/utils/mixins/AutoFocusOnMountMixin"
|
|
38739
|
-
},
|
|
38740
|
-
{
|
|
38741
|
-
"name": "FormInternalsMixin",
|
|
38742
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
|
39169
|
+
"default": "false",
|
|
39170
|
+
"description": "Determines whether the form field is read-only.",
|
|
39171
|
+
"fieldName": "readonly",
|
|
39172
|
+
"inheritedFrom": {
|
|
39173
|
+
"name": "FormfieldWrapper",
|
|
39174
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
39175
|
+
}
|
|
38743
39176
|
},
|
|
38744
39177
|
{
|
|
38745
|
-
"name": "
|
|
38746
|
-
"
|
|
39178
|
+
"name": "soft-disabled",
|
|
39179
|
+
"type": {
|
|
39180
|
+
"text": "boolean"
|
|
39181
|
+
},
|
|
39182
|
+
"default": "false",
|
|
39183
|
+
"description": "Determines whether the form field is soft-disabled.",
|
|
39184
|
+
"fieldName": "softDisabled",
|
|
39185
|
+
"inheritedFrom": {
|
|
39186
|
+
"name": "FormfieldWrapper",
|
|
39187
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
39188
|
+
}
|
|
38747
39189
|
}
|
|
38748
|
-
]
|
|
38749
|
-
"superclass": {
|
|
38750
|
-
"name": "FormfieldWrapper",
|
|
38751
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
|
38752
|
-
},
|
|
38753
|
-
"tagName": "mdc-select",
|
|
38754
|
-
"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 *\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 * You can also set the `value` attribute on the `mdc-select` element to match the value of the desired option. The component will select the corresponding option automatically.\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 * If you need to use `mdc-tooltip` with any options, make sure to place the tooltip component outside the `mdc-select` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n *\n * @slot label - Slot for the label element. If not provided, the `label` property will be used to render the label.\n * @slot toggletip - Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.\n * @slot help-icon - Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.\n * @slot help-text - Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n *\n * @cssproperty --mdc-label-font-size - Font size for the label text.\n * @cssproperty --mdc-label-font-weight - Font weight for the label text.\n * @cssproperty --mdc-label-line-height - Line height for the label text.\n * @cssproperty --mdc-label-color - Color for the label text.\n * @cssproperty --mdc-help-text-font-size - Font size for the help text.\n * @cssproperty --mdc-help-text-font-weight - Font weight for the help text.\n * @cssproperty --mdc-help-text-line-height - Line height for the help text.\n * @cssproperty --mdc-help-text-color - Color for the help text.\n * @cssproperty --mdc-select-background-color - The background color of the combobox of select.\n * @cssproperty --mdc-select-text-color - The text color of the select.\n * @cssproperty --mdc-select-border-color - The border color of the select.\n * @cssproperty --mdc-select-width - The width of the select.\n * @cssproperty --mdc-select-listbox-height - The height of the listbox inside the select.\n * @cssproperty --mdc-select-listbox-width - The width of the listbox inside the select (default: `--mdc-select-width`).\n */",
|
|
38755
|
-
"customElement": true
|
|
39190
|
+
]
|
|
38756
39191
|
}
|
|
38757
39192
|
],
|
|
38758
39193
|
"exports": [
|
|
@@ -38760,20 +39195,20 @@
|
|
|
38760
39195
|
"kind": "js",
|
|
38761
39196
|
"name": "default",
|
|
38762
39197
|
"declaration": {
|
|
38763
|
-
"name": "
|
|
38764
|
-
"module": "components/
|
|
39198
|
+
"name": "Searchfield",
|
|
39199
|
+
"module": "components/searchfield/searchfield.component.js"
|
|
38765
39200
|
}
|
|
38766
39201
|
}
|
|
38767
39202
|
]
|
|
38768
39203
|
},
|
|
38769
39204
|
{
|
|
38770
39205
|
"kind": "javascript-module",
|
|
38771
|
-
"path": "components/
|
|
39206
|
+
"path": "components/select/select.component.js",
|
|
38772
39207
|
"declarations": [
|
|
38773
39208
|
{
|
|
38774
39209
|
"kind": "class",
|
|
38775
|
-
"description": "
|
|
38776
|
-
"name": "
|
|
39210
|
+
"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.\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.\nYou can also set the `value` attribute on the `mdc-select` element to match the value of the desired option. The component will select the corresponding option automatically.\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\nIf you need to use `mdc-tooltip` with any options, make sure to place the tooltip component outside the `mdc-select` element.",
|
|
39211
|
+
"name": "Select",
|
|
38777
39212
|
"cssProperties": [
|
|
38778
39213
|
{
|
|
38779
39214
|
"description": "Font size for the label text.",
|
|
@@ -38840,52 +39275,28 @@
|
|
|
38840
39275
|
}
|
|
38841
39276
|
},
|
|
38842
39277
|
{
|
|
38843
|
-
"description": "
|
|
38844
|
-
"name": "--mdc-
|
|
38845
|
-
"inheritedFrom": {
|
|
38846
|
-
"name": "Input",
|
|
38847
|
-
"module": "src/components/input/input.component.ts"
|
|
38848
|
-
}
|
|
39278
|
+
"description": "The background color of the combobox of select.",
|
|
39279
|
+
"name": "--mdc-select-background-color"
|
|
38849
39280
|
},
|
|
38850
39281
|
{
|
|
38851
|
-
"description": "
|
|
38852
|
-
"name": "--mdc-
|
|
38853
|
-
"inheritedFrom": {
|
|
38854
|
-
"name": "Input",
|
|
38855
|
-
"module": "src/components/input/input.component.ts"
|
|
38856
|
-
}
|
|
39282
|
+
"description": "The text color of the select.",
|
|
39283
|
+
"name": "--mdc-select-text-color"
|
|
38857
39284
|
},
|
|
38858
39285
|
{
|
|
38859
|
-
"description": "
|
|
38860
|
-
"name": "--mdc-
|
|
38861
|
-
"inheritedFrom": {
|
|
38862
|
-
"name": "Input",
|
|
38863
|
-
"module": "src/components/input/input.component.ts"
|
|
38864
|
-
}
|
|
39286
|
+
"description": "The border color of the select.",
|
|
39287
|
+
"name": "--mdc-select-border-color"
|
|
38865
39288
|
},
|
|
38866
39289
|
{
|
|
38867
|
-
"description": "
|
|
38868
|
-
"name": "--mdc-
|
|
38869
|
-
"inheritedFrom": {
|
|
38870
|
-
"name": "Input",
|
|
38871
|
-
"module": "src/components/input/input.component.ts"
|
|
38872
|
-
}
|
|
39290
|
+
"description": "The width of the select.",
|
|
39291
|
+
"name": "--mdc-select-width"
|
|
38873
39292
|
},
|
|
38874
39293
|
{
|
|
38875
|
-
"description": "
|
|
38876
|
-
"name": "--mdc-
|
|
38877
|
-
"inheritedFrom": {
|
|
38878
|
-
"name": "Input",
|
|
38879
|
-
"module": "src/components/input/input.component.ts"
|
|
38880
|
-
}
|
|
39294
|
+
"description": "The height of the listbox inside the select.",
|
|
39295
|
+
"name": "--mdc-select-listbox-height"
|
|
38881
39296
|
},
|
|
38882
39297
|
{
|
|
38883
|
-
"description": "
|
|
38884
|
-
"name": "--mdc-
|
|
38885
|
-
"inheritedFrom": {
|
|
38886
|
-
"name": "Input",
|
|
38887
|
-
"module": "src/components/input/input.component.ts"
|
|
38888
|
-
}
|
|
39298
|
+
"description": "The width of the listbox inside the select (default: `--mdc-select-width`).",
|
|
39299
|
+
"name": "--mdc-select-listbox-width"
|
|
38889
39300
|
}
|
|
38890
39301
|
],
|
|
38891
39302
|
"cssParts": [
|
|
@@ -38952,60 +39363,12 @@
|
|
|
38952
39363
|
"name": "FormfieldWrapper",
|
|
38953
39364
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
38954
39365
|
}
|
|
38955
|
-
},
|
|
38956
|
-
{
|
|
38957
|
-
"description": "The leading icon element that is displayed before the input field.",
|
|
38958
|
-
"name": "leading-icon",
|
|
38959
|
-
"inheritedFrom": {
|
|
38960
|
-
"name": "Input",
|
|
38961
|
-
"module": "src/components/input/input.component.ts"
|
|
38962
|
-
}
|
|
38963
|
-
},
|
|
38964
|
-
{
|
|
38965
|
-
"description": "The prefix text element that is displayed before the input field.",
|
|
38966
|
-
"name": "prefix-text",
|
|
38967
|
-
"inheritedFrom": {
|
|
38968
|
-
"name": "Input",
|
|
38969
|
-
"module": "src/components/input/input.component.ts"
|
|
38970
|
-
}
|
|
38971
|
-
},
|
|
38972
|
-
{
|
|
38973
|
-
"description": "The container for the input field, leading icon, prefix text, and trailing button elements.",
|
|
38974
|
-
"name": "input-container",
|
|
38975
|
-
"inheritedFrom": {
|
|
38976
|
-
"name": "Input",
|
|
38977
|
-
"module": "src/components/input/input.component.ts"
|
|
38978
|
-
}
|
|
38979
|
-
},
|
|
38980
|
-
{
|
|
38981
|
-
"description": "The container for the input field, leading icon, and prefix text elements.",
|
|
38982
|
-
"name": "input-section",
|
|
38983
|
-
"inheritedFrom": {
|
|
38984
|
-
"name": "Input",
|
|
38985
|
-
"module": "src/components/input/input.component.ts"
|
|
38986
|
-
}
|
|
38987
|
-
},
|
|
38988
|
-
{
|
|
38989
|
-
"description": "The input field element.",
|
|
38990
|
-
"name": "input-text",
|
|
38991
|
-
"inheritedFrom": {
|
|
38992
|
-
"name": "Input",
|
|
38993
|
-
"module": "src/components/input/input.component.ts"
|
|
38994
|
-
}
|
|
38995
|
-
},
|
|
38996
|
-
{
|
|
38997
|
-
"description": "The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.",
|
|
38998
|
-
"name": "trailing-button",
|
|
38999
|
-
"inheritedFrom": {
|
|
39000
|
-
"name": "Input",
|
|
39001
|
-
"module": "src/components/input/input.component.ts"
|
|
39002
|
-
}
|
|
39003
39366
|
}
|
|
39004
39367
|
],
|
|
39005
39368
|
"slots": [
|
|
39006
39369
|
{
|
|
39007
|
-
"description": "
|
|
39008
|
-
"name": "
|
|
39370
|
+
"description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
|
|
39371
|
+
"name": "default"
|
|
39009
39372
|
},
|
|
39010
39373
|
{
|
|
39011
39374
|
"description": "Slot for the label element. If not provided, the `label` property will be used to render the label.",
|
|
@@ -39038,511 +39401,467 @@
|
|
|
39038
39401
|
"name": "FormfieldWrapper",
|
|
39039
39402
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
39040
39403
|
}
|
|
39041
|
-
},
|
|
39042
|
-
{
|
|
39043
|
-
"description": "Slot for the input element. If not provided, the input field will be rendered.",
|
|
39044
|
-
"name": "input",
|
|
39045
|
-
"inheritedFrom": {
|
|
39046
|
-
"name": "Input",
|
|
39047
|
-
"module": "src/components/input/input.component.ts"
|
|
39048
|
-
}
|
|
39049
|
-
},
|
|
39050
|
-
{
|
|
39051
|
-
"description": "Slot for the leading icon before the input field. If not provided, the `leadingIcon` property will be used to render the leading icon.",
|
|
39052
|
-
"name": "input-leading-icon",
|
|
39053
|
-
"inheritedFrom": {
|
|
39054
|
-
"name": "Input",
|
|
39055
|
-
"module": "src/components/input/input.component.ts"
|
|
39056
|
-
}
|
|
39057
|
-
},
|
|
39058
|
-
{
|
|
39059
|
-
"description": "Slot for the prefix text before the input field. If not provided, the `prefixText` property will be used to render the prefix text.",
|
|
39060
|
-
"name": "input-prefix-text",
|
|
39061
|
-
"inheritedFrom": {
|
|
39062
|
-
"name": "Input",
|
|
39063
|
-
"module": "src/components/input/input.component.ts"
|
|
39064
|
-
}
|
|
39065
|
-
},
|
|
39066
|
-
{
|
|
39067
|
-
"description": "Slot for the trailing button to clear the input field. If not provided, the clear button will be rendered when `trailingButton` property is set to true.",
|
|
39068
|
-
"name": "trailing-button",
|
|
39069
|
-
"inheritedFrom": {
|
|
39070
|
-
"name": "Input",
|
|
39071
|
-
"module": "src/components/input/input.component.ts"
|
|
39072
|
-
}
|
|
39073
39404
|
}
|
|
39074
39405
|
],
|
|
39075
39406
|
"members": [
|
|
39076
39407
|
{
|
|
39077
39408
|
"kind": "field",
|
|
39078
|
-
"name": "
|
|
39079
|
-
"type": {
|
|
39080
|
-
"text": "Array<HTMLElement> | undefined"
|
|
39081
|
-
}
|
|
39082
|
-
},
|
|
39083
|
-
{
|
|
39084
|
-
"kind": "method",
|
|
39085
|
-
"name": "handleKeyDown",
|
|
39086
|
-
"privacy": "protected",
|
|
39087
|
-
"parameters": [
|
|
39088
|
-
{
|
|
39089
|
-
"name": "event",
|
|
39090
|
-
"type": {
|
|
39091
|
-
"text": "KeyboardEvent"
|
|
39092
|
-
},
|
|
39093
|
-
"description": "Keyboard event"
|
|
39094
|
-
}
|
|
39095
|
-
],
|
|
39096
|
-
"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.",
|
|
39097
|
-
"inheritedFrom": {
|
|
39098
|
-
"name": "Input",
|
|
39099
|
-
"module": "components/input/input.component.js"
|
|
39100
|
-
}
|
|
39101
|
-
},
|
|
39102
|
-
{
|
|
39103
|
-
"kind": "method",
|
|
39104
|
-
"name": "renderInputChips",
|
|
39105
|
-
"privacy": "private",
|
|
39106
|
-
"description": "This method is used to render the input chips inside filters slot.\nIt will remove any elements that are not input chips."
|
|
39107
|
-
},
|
|
39108
|
-
{
|
|
39109
|
-
"kind": "method",
|
|
39110
|
-
"name": "clearInputText",
|
|
39111
|
-
"privacy": "protected",
|
|
39112
|
-
"description": "Clears the input field.",
|
|
39113
|
-
"inheritedFrom": {
|
|
39114
|
-
"name": "Input",
|
|
39115
|
-
"module": "components/input/input.component.js"
|
|
39116
|
-
}
|
|
39117
|
-
},
|
|
39118
|
-
{
|
|
39119
|
-
"kind": "field",
|
|
39120
|
-
"name": "autoFocusOnMount",
|
|
39409
|
+
"name": "placeholder",
|
|
39121
39410
|
"type": {
|
|
39122
|
-
"text": "
|
|
39411
|
+
"text": "string | undefined"
|
|
39123
39412
|
},
|
|
39124
|
-
"
|
|
39125
|
-
"
|
|
39126
|
-
"attribute": "auto-focus-on-mount",
|
|
39127
|
-
"reflects": true,
|
|
39128
|
-
"inheritedFrom": {
|
|
39129
|
-
"name": "AutoFocusOnMountMixin",
|
|
39130
|
-
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
39131
|
-
}
|
|
39413
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
|
39414
|
+
"attribute": "placeholder"
|
|
39132
39415
|
},
|
|
39133
39416
|
{
|
|
39134
39417
|
"kind": "field",
|
|
39135
|
-
"name": "
|
|
39418
|
+
"name": "placement",
|
|
39136
39419
|
"type": {
|
|
39137
|
-
"text": "
|
|
39420
|
+
"text": "Placement"
|
|
39138
39421
|
},
|
|
39139
|
-
"
|
|
39140
|
-
"
|
|
39141
|
-
"attribute": "
|
|
39142
|
-
"reflects": true
|
|
39143
|
-
"inheritedFrom": {
|
|
39144
|
-
"name": "FormInternalsMixin",
|
|
39145
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39146
|
-
}
|
|
39422
|
+
"description": "The placement of the popover within Select component.\nThis defines the position of the popover relative to the select input field.\n\nPossible values:\n - 'top-start'\n - 'bottom-start'",
|
|
39423
|
+
"default": "'bottom-start'",
|
|
39424
|
+
"attribute": "placement",
|
|
39425
|
+
"reflects": true
|
|
39147
39426
|
},
|
|
39148
39427
|
{
|
|
39149
39428
|
"kind": "field",
|
|
39150
|
-
"name": "
|
|
39151
|
-
"type": {
|
|
39152
|
-
"text": "string"
|
|
39153
|
-
},
|
|
39154
|
-
"
|
|
39155
|
-
"
|
|
39156
|
-
"attribute": "
|
|
39157
|
-
"reflects": true
|
|
39158
|
-
"inheritedFrom": {
|
|
39159
|
-
"name": "FormInternalsMixin",
|
|
39160
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39161
|
-
}
|
|
39429
|
+
"name": "boundary",
|
|
39430
|
+
"type": {
|
|
39431
|
+
"text": "'clippingAncestors' | string"
|
|
39432
|
+
},
|
|
39433
|
+
"description": "This describes the clipping element(s) or area that overflow of the used popover will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
|
39434
|
+
"default": "'clippingAncestors'",
|
|
39435
|
+
"attribute": "boundary",
|
|
39436
|
+
"reflects": true
|
|
39162
39437
|
},
|
|
39163
39438
|
{
|
|
39164
39439
|
"kind": "field",
|
|
39165
|
-
"name": "
|
|
39440
|
+
"name": "strategy",
|
|
39166
39441
|
"type": {
|
|
39167
|
-
"text": "
|
|
39442
|
+
"text": "PopoverStrategy"
|
|
39168
39443
|
},
|
|
39169
|
-
"description": "
|
|
39170
|
-
"
|
|
39171
|
-
"
|
|
39172
|
-
"
|
|
39173
|
-
"name": "FormInternalsMixin",
|
|
39174
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39175
|
-
}
|
|
39444
|
+
"description": "The strategy of the popover within Select.\nThis determines how the popover is positioned in the DOM.\n\nIn case `boundary` is set to something other than 'clippingAncestors',\nit might be necessary to set the `strategy` to 'fixed' to ensure that the popover\nis not getting clipped by scrollable containers enclosing the select.",
|
|
39445
|
+
"default": "absolute",
|
|
39446
|
+
"attribute": "strategy",
|
|
39447
|
+
"reflects": true
|
|
39176
39448
|
},
|
|
39177
39449
|
{
|
|
39178
39450
|
"kind": "field",
|
|
39179
|
-
"name": "
|
|
39451
|
+
"name": "popoverZIndex",
|
|
39180
39452
|
"type": {
|
|
39181
|
-
"text": "
|
|
39453
|
+
"text": "number"
|
|
39182
39454
|
},
|
|
39183
|
-
"
|
|
39184
|
-
"
|
|
39185
|
-
|
|
39186
|
-
|
|
39187
|
-
}
|
|
39455
|
+
"description": "The z-index of the popover within Select.\n\nOverride this to make sure this stays on top of other components.",
|
|
39456
|
+
"default": "1000",
|
|
39457
|
+
"attribute": "popover-z-index",
|
|
39458
|
+
"reflects": true
|
|
39188
39459
|
},
|
|
39189
39460
|
{
|
|
39190
39461
|
"kind": "field",
|
|
39191
|
-
"name": "
|
|
39192
|
-
"
|
|
39193
|
-
|
|
39194
|
-
|
|
39195
|
-
|
|
39196
|
-
|
|
39462
|
+
"name": "backdropAppendTo",
|
|
39463
|
+
"type": {
|
|
39464
|
+
"text": "string | undefined"
|
|
39465
|
+
},
|
|
39466
|
+
"description": "ID of the element where the backdrop will be appended to.\nThis is useful to ensure that the backdrop is appended to the correct element in the DOM.\nIf not set, the backdrop will be appended to the parent element of the select.",
|
|
39467
|
+
"attribute": "backdrop-append-to",
|
|
39468
|
+
"reflects": true
|
|
39197
39469
|
},
|
|
39198
39470
|
{
|
|
39199
39471
|
"kind": "method",
|
|
39200
|
-
"name": "
|
|
39201
|
-
"
|
|
39472
|
+
"name": "handleOptionsClick",
|
|
39473
|
+
"privacy": "private",
|
|
39202
39474
|
"return": {
|
|
39203
39475
|
"type": {
|
|
39204
|
-
"text": ""
|
|
39476
|
+
"text": "void"
|
|
39205
39477
|
}
|
|
39206
39478
|
},
|
|
39207
|
-
"
|
|
39208
|
-
|
|
39209
|
-
|
|
39210
|
-
|
|
39479
|
+
"parameters": [
|
|
39480
|
+
{
|
|
39481
|
+
"name": "event",
|
|
39482
|
+
"type": {
|
|
39483
|
+
"text": "MouseEvent"
|
|
39484
|
+
},
|
|
39485
|
+
"description": "The event which triggered this function."
|
|
39486
|
+
}
|
|
39487
|
+
],
|
|
39488
|
+
"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."
|
|
39211
39489
|
},
|
|
39212
39490
|
{
|
|
39213
39491
|
"kind": "method",
|
|
39214
|
-
"name": "
|
|
39492
|
+
"name": "setSelectedOption",
|
|
39493
|
+
"privacy": "private",
|
|
39215
39494
|
"return": {
|
|
39216
39495
|
"type": {
|
|
39217
|
-
"text": "
|
|
39496
|
+
"text": "void"
|
|
39218
39497
|
}
|
|
39219
39498
|
},
|
|
39220
|
-
"
|
|
39221
|
-
|
|
39222
|
-
|
|
39223
|
-
|
|
39499
|
+
"parameters": [
|
|
39500
|
+
{
|
|
39501
|
+
"name": "option",
|
|
39502
|
+
"type": {
|
|
39503
|
+
"text": "Option | null"
|
|
39504
|
+
},
|
|
39505
|
+
"description": "The option element in DOM which gets selected."
|
|
39506
|
+
}
|
|
39507
|
+
],
|
|
39508
|
+
"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."
|
|
39224
39509
|
},
|
|
39225
39510
|
{
|
|
39226
39511
|
"kind": "method",
|
|
39227
|
-
"name": "
|
|
39228
|
-
"
|
|
39229
|
-
|
|
39230
|
-
"
|
|
39231
|
-
|
|
39232
|
-
|
|
39233
|
-
{
|
|
39234
|
-
"kind": "field",
|
|
39235
|
-
"name": "dataAriaLabel",
|
|
39236
|
-
"type": {
|
|
39237
|
-
"text": "string | null"
|
|
39512
|
+
"name": "updateSelectedInChildOptions",
|
|
39513
|
+
"privacy": "private",
|
|
39514
|
+
"return": {
|
|
39515
|
+
"type": {
|
|
39516
|
+
"text": "void"
|
|
39517
|
+
}
|
|
39238
39518
|
},
|
|
39239
|
-
"
|
|
39240
|
-
|
|
39241
|
-
|
|
39242
|
-
|
|
39243
|
-
|
|
39244
|
-
|
|
39245
|
-
|
|
39246
|
-
|
|
39519
|
+
"parameters": [
|
|
39520
|
+
{
|
|
39521
|
+
"name": "selectedOption",
|
|
39522
|
+
"type": {
|
|
39523
|
+
"text": "Option | null"
|
|
39524
|
+
},
|
|
39525
|
+
"description": "The option which gets selected"
|
|
39526
|
+
}
|
|
39527
|
+
],
|
|
39528
|
+
"description": "Sets selected attribute on the selected option and removes it from all options"
|
|
39247
39529
|
},
|
|
39248
39530
|
{
|
|
39249
|
-
"kind": "
|
|
39250
|
-
"name": "
|
|
39251
|
-
"
|
|
39252
|
-
|
|
39531
|
+
"kind": "method",
|
|
39532
|
+
"name": "fireEvents",
|
|
39533
|
+
"privacy": "private",
|
|
39534
|
+
"return": {
|
|
39535
|
+
"type": {
|
|
39536
|
+
"text": "void"
|
|
39537
|
+
}
|
|
39253
39538
|
},
|
|
39254
|
-
"
|
|
39255
|
-
"description": "The placeholder text that is displayed when the input field is empty.",
|
|
39256
|
-
"attribute": "placeholder",
|
|
39257
|
-
"inheritedFrom": {
|
|
39258
|
-
"name": "Input",
|
|
39259
|
-
"module": "components/input/input.component.js"
|
|
39260
|
-
}
|
|
39539
|
+
"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."
|
|
39261
39540
|
},
|
|
39262
39541
|
{
|
|
39263
|
-
"kind": "
|
|
39264
|
-
"name": "
|
|
39265
|
-
"
|
|
39266
|
-
|
|
39542
|
+
"kind": "method",
|
|
39543
|
+
"name": "dispatchChange",
|
|
39544
|
+
"privacy": "private",
|
|
39545
|
+
"return": {
|
|
39546
|
+
"type": {
|
|
39547
|
+
"text": "void"
|
|
39548
|
+
}
|
|
39267
39549
|
},
|
|
39268
|
-
"
|
|
39269
|
-
|
|
39270
|
-
|
|
39271
|
-
|
|
39272
|
-
|
|
39273
|
-
|
|
39550
|
+
"parameters": [
|
|
39551
|
+
{
|
|
39552
|
+
"name": "option",
|
|
39553
|
+
"type": {
|
|
39554
|
+
"text": "Option"
|
|
39555
|
+
}
|
|
39556
|
+
}
|
|
39557
|
+
]
|
|
39274
39558
|
},
|
|
39275
39559
|
{
|
|
39276
|
-
"kind": "
|
|
39277
|
-
"name": "
|
|
39278
|
-
"
|
|
39279
|
-
|
|
39560
|
+
"kind": "method",
|
|
39561
|
+
"name": "dispatchInput",
|
|
39562
|
+
"privacy": "private",
|
|
39563
|
+
"return": {
|
|
39564
|
+
"type": {
|
|
39565
|
+
"text": "void"
|
|
39566
|
+
}
|
|
39280
39567
|
},
|
|
39281
|
-
"
|
|
39282
|
-
|
|
39283
|
-
|
|
39284
|
-
|
|
39285
|
-
|
|
39286
|
-
|
|
39568
|
+
"parameters": [
|
|
39569
|
+
{
|
|
39570
|
+
"name": "option",
|
|
39571
|
+
"type": {
|
|
39572
|
+
"text": "Option"
|
|
39573
|
+
}
|
|
39574
|
+
}
|
|
39575
|
+
]
|
|
39287
39576
|
},
|
|
39288
39577
|
{
|
|
39289
|
-
"kind": "
|
|
39290
|
-
"name": "
|
|
39291
|
-
"
|
|
39292
|
-
|
|
39578
|
+
"kind": "method",
|
|
39579
|
+
"name": "handleClickCombobox",
|
|
39580
|
+
"privacy": "private",
|
|
39581
|
+
"return": {
|
|
39582
|
+
"type": {
|
|
39583
|
+
"text": "void"
|
|
39584
|
+
}
|
|
39293
39585
|
},
|
|
39294
|
-
"
|
|
39295
|
-
|
|
39296
|
-
|
|
39297
|
-
|
|
39298
|
-
|
|
39299
|
-
|
|
39300
|
-
|
|
39586
|
+
"parameters": [
|
|
39587
|
+
{
|
|
39588
|
+
"name": "event",
|
|
39589
|
+
"type": {
|
|
39590
|
+
"text": "MouseEvent"
|
|
39591
|
+
},
|
|
39592
|
+
"description": "The mouse event which triggered this function."
|
|
39593
|
+
}
|
|
39594
|
+
],
|
|
39595
|
+
"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."
|
|
39301
39596
|
},
|
|
39302
39597
|
{
|
|
39303
|
-
"kind": "
|
|
39304
|
-
"name": "
|
|
39305
|
-
"
|
|
39306
|
-
|
|
39598
|
+
"kind": "method",
|
|
39599
|
+
"name": "handleKeydownCombobox",
|
|
39600
|
+
"privacy": "private",
|
|
39601
|
+
"return": {
|
|
39602
|
+
"type": {
|
|
39603
|
+
"text": "void"
|
|
39604
|
+
}
|
|
39307
39605
|
},
|
|
39308
|
-
"
|
|
39309
|
-
|
|
39310
|
-
|
|
39311
|
-
|
|
39312
|
-
|
|
39313
|
-
|
|
39606
|
+
"parameters": [
|
|
39607
|
+
{
|
|
39608
|
+
"name": "event",
|
|
39609
|
+
"type": {
|
|
39610
|
+
"text": "KeyboardEvent"
|
|
39611
|
+
},
|
|
39612
|
+
"description": "The keyboard event."
|
|
39613
|
+
}
|
|
39614
|
+
],
|
|
39615
|
+
"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."
|
|
39314
39616
|
},
|
|
39315
39617
|
{
|
|
39316
|
-
"kind": "
|
|
39317
|
-
"name": "
|
|
39318
|
-
"
|
|
39319
|
-
|
|
39618
|
+
"kind": "method",
|
|
39619
|
+
"name": "getCurrentIndex",
|
|
39620
|
+
"privacy": "private",
|
|
39621
|
+
"return": {
|
|
39622
|
+
"type": {
|
|
39623
|
+
"text": ""
|
|
39624
|
+
}
|
|
39320
39625
|
},
|
|
39321
|
-
"
|
|
39322
|
-
|
|
39626
|
+
"parameters": [
|
|
39627
|
+
{
|
|
39628
|
+
"name": "target",
|
|
39629
|
+
"type": {
|
|
39630
|
+
"text": "HTMLElement | null"
|
|
39631
|
+
},
|
|
39632
|
+
"description": "The target element that triggered the event."
|
|
39633
|
+
}
|
|
39634
|
+
],
|
|
39635
|
+
"description": "Retrieves the current index of the item that triggered the event.",
|
|
39323
39636
|
"inheritedFrom": {
|
|
39324
|
-
"name": "
|
|
39325
|
-
"module": "
|
|
39637
|
+
"name": "ListNavigationMixin",
|
|
39638
|
+
"module": "utils/mixins/ListNavigationMixin.js"
|
|
39326
39639
|
}
|
|
39327
39640
|
},
|
|
39328
39641
|
{
|
|
39329
|
-
"kind": "
|
|
39330
|
-
"name": "
|
|
39331
|
-
"
|
|
39332
|
-
|
|
39333
|
-
|
|
39334
|
-
|
|
39335
|
-
|
|
39336
|
-
|
|
39642
|
+
"kind": "method",
|
|
39643
|
+
"name": "resetTabIndexes",
|
|
39644
|
+
"privacy": "protected",
|
|
39645
|
+
"parameters": [
|
|
39646
|
+
{
|
|
39647
|
+
"name": "index",
|
|
39648
|
+
"type": {
|
|
39649
|
+
"text": "number"
|
|
39650
|
+
},
|
|
39651
|
+
"description": "The index of the currently focused item."
|
|
39652
|
+
}
|
|
39653
|
+
],
|
|
39654
|
+
"description": "Reset all tabindex to -1 and set the tabindex of the current item to 0",
|
|
39337
39655
|
"inheritedFrom": {
|
|
39338
|
-
"name": "
|
|
39339
|
-
"module": "
|
|
39656
|
+
"name": "ListNavigationMixin",
|
|
39657
|
+
"module": "utils/mixins/ListNavigationMixin.js"
|
|
39340
39658
|
}
|
|
39341
39659
|
},
|
|
39342
39660
|
{
|
|
39343
|
-
"kind": "
|
|
39344
|
-
"name": "
|
|
39345
|
-
"
|
|
39346
|
-
|
|
39661
|
+
"kind": "method",
|
|
39662
|
+
"name": "resetTabIndexAndSetFocus",
|
|
39663
|
+
"privacy": "protected",
|
|
39664
|
+
"parameters": [
|
|
39665
|
+
{
|
|
39666
|
+
"name": "newIndex",
|
|
39667
|
+
"type": {
|
|
39668
|
+
"text": "number"
|
|
39669
|
+
},
|
|
39670
|
+
"description": "The index of the new item to focus."
|
|
39671
|
+
},
|
|
39672
|
+
{
|
|
39673
|
+
"name": "oldIndex",
|
|
39674
|
+
"optional": true,
|
|
39675
|
+
"type": {
|
|
39676
|
+
"text": "number"
|
|
39677
|
+
},
|
|
39678
|
+
"description": "The index of the currently focused item."
|
|
39679
|
+
},
|
|
39680
|
+
{
|
|
39681
|
+
"name": "focusNewItem",
|
|
39682
|
+
"default": "true",
|
|
39683
|
+
"description": "Call focus() on the new item or not. It should be false during firstUpdate"
|
|
39684
|
+
}
|
|
39685
|
+
],
|
|
39686
|
+
"description": "Resets the tabindex of the currently focused item and sets focus to a new item.",
|
|
39687
|
+
"return": {
|
|
39688
|
+
"type": {
|
|
39689
|
+
"text": ""
|
|
39690
|
+
}
|
|
39347
39691
|
},
|
|
39348
|
-
"description": "The autocomplete attribute of the input field.",
|
|
39349
|
-
"default": "'off'",
|
|
39350
|
-
"attribute": "autocomplete",
|
|
39351
39692
|
"inheritedFrom": {
|
|
39352
|
-
"name": "
|
|
39353
|
-
"module": "
|
|
39693
|
+
"name": "ListNavigationMixin",
|
|
39694
|
+
"module": "utils/mixins/ListNavigationMixin.js"
|
|
39354
39695
|
}
|
|
39355
39696
|
},
|
|
39356
39697
|
{
|
|
39357
|
-
"kind": "
|
|
39358
|
-
"name": "
|
|
39359
|
-
"
|
|
39360
|
-
|
|
39698
|
+
"kind": "method",
|
|
39699
|
+
"name": "resolveDirectionKey",
|
|
39700
|
+
"privacy": "private",
|
|
39701
|
+
"parameters": [
|
|
39702
|
+
{
|
|
39703
|
+
"name": "key",
|
|
39704
|
+
"type": {
|
|
39705
|
+
"text": "string"
|
|
39706
|
+
},
|
|
39707
|
+
"description": "The key pressed by the user."
|
|
39708
|
+
},
|
|
39709
|
+
{
|
|
39710
|
+
"name": "isRtl",
|
|
39711
|
+
"type": {
|
|
39712
|
+
"text": "boolean"
|
|
39713
|
+
},
|
|
39714
|
+
"description": "A boolean indicating if the layout is right-to-left (RTL)."
|
|
39715
|
+
}
|
|
39716
|
+
],
|
|
39717
|
+
"description": "Resolves the key pressed by the user based on the direction of the layout.\nThis method is used to handle keyboard navigation in a right-to-left (RTL) layout.\nIt checks if the layout is RTL and adjusts the arrow keys accordingly.\nFor example, in RTL, the left arrow key behaves like the right arrow key and vice versa.",
|
|
39718
|
+
"return": {
|
|
39719
|
+
"type": {
|
|
39720
|
+
"text": ""
|
|
39721
|
+
}
|
|
39361
39722
|
},
|
|
39362
|
-
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
|
39363
|
-
"attribute": "dirname",
|
|
39364
39723
|
"inheritedFrom": {
|
|
39365
|
-
"name": "
|
|
39366
|
-
"module": "
|
|
39724
|
+
"name": "ListNavigationMixin",
|
|
39725
|
+
"module": "utils/mixins/ListNavigationMixin.js"
|
|
39367
39726
|
}
|
|
39368
39727
|
},
|
|
39369
39728
|
{
|
|
39370
|
-
"kind": "
|
|
39371
|
-
"name": "
|
|
39372
|
-
"
|
|
39373
|
-
"text": "string | undefined"
|
|
39374
|
-
},
|
|
39375
|
-
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
|
39376
|
-
"attribute": "pattern",
|
|
39729
|
+
"kind": "method",
|
|
39730
|
+
"name": "shouldLoop",
|
|
39731
|
+
"privacy": "private",
|
|
39377
39732
|
"inheritedFrom": {
|
|
39378
|
-
"name": "
|
|
39379
|
-
"module": "
|
|
39733
|
+
"name": "ListNavigationMixin",
|
|
39734
|
+
"module": "utils/mixins/ListNavigationMixin.js"
|
|
39380
39735
|
}
|
|
39381
39736
|
},
|
|
39382
39737
|
{
|
|
39383
39738
|
"kind": "field",
|
|
39384
|
-
"name": "
|
|
39739
|
+
"name": "autoFocusOnMount",
|
|
39385
39740
|
"type": {
|
|
39386
|
-
"text": "
|
|
39741
|
+
"text": "boolean"
|
|
39387
39742
|
},
|
|
39388
|
-
"
|
|
39389
|
-
"
|
|
39743
|
+
"default": "false",
|
|
39744
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
39745
|
+
"attribute": "auto-focus-on-mount",
|
|
39746
|
+
"reflects": true,
|
|
39390
39747
|
"inheritedFrom": {
|
|
39391
|
-
"name": "
|
|
39392
|
-
"module": "
|
|
39748
|
+
"name": "AutoFocusOnMountMixin",
|
|
39749
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
39393
39750
|
}
|
|
39394
39751
|
},
|
|
39395
39752
|
{
|
|
39396
39753
|
"kind": "field",
|
|
39397
|
-
"name": "
|
|
39754
|
+
"name": "name",
|
|
39398
39755
|
"type": {
|
|
39399
|
-
"text": "
|
|
39756
|
+
"text": "string"
|
|
39400
39757
|
},
|
|
39401
|
-
"
|
|
39402
|
-
"
|
|
39403
|
-
"attribute": "
|
|
39758
|
+
"default": "''",
|
|
39759
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
|
39760
|
+
"attribute": "name",
|
|
39761
|
+
"reflects": true,
|
|
39404
39762
|
"inheritedFrom": {
|
|
39405
|
-
"name": "
|
|
39406
|
-
"module": "
|
|
39763
|
+
"name": "FormInternalsMixin",
|
|
39764
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39407
39765
|
}
|
|
39408
39766
|
},
|
|
39409
39767
|
{
|
|
39410
39768
|
"kind": "field",
|
|
39411
|
-
"name": "
|
|
39769
|
+
"name": "value",
|
|
39412
39770
|
"type": {
|
|
39413
39771
|
"text": "string"
|
|
39414
39772
|
},
|
|
39415
39773
|
"default": "''",
|
|
39416
|
-
"description": "
|
|
39417
|
-
"attribute": "
|
|
39418
|
-
"
|
|
39419
|
-
"name": "Input",
|
|
39420
|
-
"module": "components/input/input.component.js"
|
|
39421
|
-
}
|
|
39422
|
-
},
|
|
39423
|
-
{
|
|
39424
|
-
"kind": "method",
|
|
39425
|
-
"name": "setInputValidity",
|
|
39426
|
-
"privacy": "private",
|
|
39774
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
39775
|
+
"attribute": "value",
|
|
39776
|
+
"reflects": true,
|
|
39427
39777
|
"inheritedFrom": {
|
|
39428
|
-
"name": "
|
|
39429
|
-
"module": "
|
|
39778
|
+
"name": "FormInternalsMixin",
|
|
39779
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39430
39780
|
}
|
|
39431
39781
|
},
|
|
39432
39782
|
{
|
|
39433
|
-
"kind": "
|
|
39434
|
-
"name": "
|
|
39435
|
-
"
|
|
39436
|
-
|
|
39437
|
-
"return": {
|
|
39438
|
-
"type": {
|
|
39439
|
-
"text": ""
|
|
39440
|
-
}
|
|
39783
|
+
"kind": "field",
|
|
39784
|
+
"name": "validationMessage",
|
|
39785
|
+
"type": {
|
|
39786
|
+
"text": "string | undefined"
|
|
39441
39787
|
},
|
|
39788
|
+
"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.",
|
|
39789
|
+
"attribute": "validation-message",
|
|
39790
|
+
"reflects": true,
|
|
39442
39791
|
"inheritedFrom": {
|
|
39443
|
-
"name": "
|
|
39444
|
-
"module": "
|
|
39445
|
-
}
|
|
39446
|
-
},
|
|
39447
|
-
{
|
|
39448
|
-
"kind": "method",
|
|
39449
|
-
"name": "onInput",
|
|
39450
|
-
"privacy": "private",
|
|
39451
|
-
"description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
|
|
39452
|
-
"inheritedFrom": {
|
|
39453
|
-
"name": "Input",
|
|
39454
|
-
"module": "components/input/input.component.js"
|
|
39792
|
+
"name": "FormInternalsMixin",
|
|
39793
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39455
39794
|
}
|
|
39456
39795
|
},
|
|
39457
39796
|
{
|
|
39458
|
-
"kind": "
|
|
39459
|
-
"name": "
|
|
39460
|
-
"
|
|
39461
|
-
|
|
39462
|
-
|
|
39463
|
-
|
|
39464
|
-
"type": {
|
|
39465
|
-
"text": "Event"
|
|
39466
|
-
},
|
|
39467
|
-
"description": "Event which contains information about the value change."
|
|
39468
|
-
}
|
|
39469
|
-
],
|
|
39470
|
-
"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",
|
|
39797
|
+
"kind": "field",
|
|
39798
|
+
"name": "validity",
|
|
39799
|
+
"type": {
|
|
39800
|
+
"text": "ValidityState"
|
|
39801
|
+
},
|
|
39802
|
+
"readonly": true,
|
|
39471
39803
|
"inheritedFrom": {
|
|
39472
|
-
"name": "
|
|
39473
|
-
"module": "
|
|
39804
|
+
"name": "FormInternalsMixin",
|
|
39805
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39474
39806
|
}
|
|
39475
39807
|
},
|
|
39476
39808
|
{
|
|
39477
|
-
"kind": "
|
|
39478
|
-
"name": "
|
|
39479
|
-
"
|
|
39480
|
-
"description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
|
|
39481
|
-
"return": {
|
|
39482
|
-
"type": {
|
|
39483
|
-
"text": ""
|
|
39484
|
-
}
|
|
39485
|
-
},
|
|
39809
|
+
"kind": "field",
|
|
39810
|
+
"name": "willValidate",
|
|
39811
|
+
"readonly": true,
|
|
39486
39812
|
"inheritedFrom": {
|
|
39487
|
-
"name": "
|
|
39488
|
-
"module": "
|
|
39813
|
+
"name": "FormInternalsMixin",
|
|
39814
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39489
39815
|
}
|
|
39490
39816
|
},
|
|
39491
39817
|
{
|
|
39492
39818
|
"kind": "method",
|
|
39493
|
-
"name": "
|
|
39494
|
-
"
|
|
39495
|
-
"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.",
|
|
39819
|
+
"name": "setValidity",
|
|
39820
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
|
39496
39821
|
"return": {
|
|
39497
39822
|
"type": {
|
|
39498
39823
|
"text": ""
|
|
39499
39824
|
}
|
|
39500
39825
|
},
|
|
39501
|
-
"inheritedFrom": {
|
|
39502
|
-
"name": "
|
|
39503
|
-
"module": "
|
|
39826
|
+
"inheritedFrom": {
|
|
39827
|
+
"name": "FormInternalsMixin",
|
|
39828
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39504
39829
|
}
|
|
39505
39830
|
},
|
|
39506
39831
|
{
|
|
39507
39832
|
"kind": "method",
|
|
39508
|
-
"name": "
|
|
39509
|
-
"privacy": "protected",
|
|
39510
|
-
"parameters": [
|
|
39511
|
-
{
|
|
39512
|
-
"name": "show",
|
|
39513
|
-
"default": "false"
|
|
39514
|
-
}
|
|
39515
|
-
],
|
|
39516
|
-
"description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
|
|
39833
|
+
"name": "checkValidity",
|
|
39517
39834
|
"return": {
|
|
39518
39835
|
"type": {
|
|
39519
|
-
"text": ""
|
|
39836
|
+
"text": "boolean"
|
|
39520
39837
|
}
|
|
39521
39838
|
},
|
|
39522
39839
|
"inheritedFrom": {
|
|
39523
|
-
"name": "
|
|
39524
|
-
"module": "
|
|
39840
|
+
"name": "FormInternalsMixin",
|
|
39841
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39525
39842
|
}
|
|
39526
39843
|
},
|
|
39527
39844
|
{
|
|
39528
39845
|
"kind": "method",
|
|
39529
|
-
"name": "
|
|
39530
|
-
"privacy": "protected",
|
|
39531
|
-
"parameters": [
|
|
39532
|
-
{
|
|
39533
|
-
"name": "type",
|
|
39534
|
-
"type": {
|
|
39535
|
-
"text": "InputType"
|
|
39536
|
-
}
|
|
39537
|
-
},
|
|
39538
|
-
{
|
|
39539
|
-
"name": "hidePlaceholder",
|
|
39540
|
-
"default": "false"
|
|
39541
|
-
}
|
|
39542
|
-
],
|
|
39846
|
+
"name": "reportValidity",
|
|
39543
39847
|
"inheritedFrom": {
|
|
39544
|
-
"name": "
|
|
39545
|
-
"module": "
|
|
39848
|
+
"name": "FormInternalsMixin",
|
|
39849
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
|
39850
|
+
}
|
|
39851
|
+
},
|
|
39852
|
+
{
|
|
39853
|
+
"kind": "field",
|
|
39854
|
+
"name": "dataAriaLabel",
|
|
39855
|
+
"type": {
|
|
39856
|
+
"text": "string | null"
|
|
39857
|
+
},
|
|
39858
|
+
"default": "null",
|
|
39859
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
|
39860
|
+
"attribute": "data-aria-label",
|
|
39861
|
+
"reflects": true,
|
|
39862
|
+
"inheritedFrom": {
|
|
39863
|
+
"name": "DataAriaLabelMixin",
|
|
39864
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
|
39546
39865
|
}
|
|
39547
39866
|
},
|
|
39548
39867
|
{
|
|
@@ -39781,295 +40100,152 @@
|
|
|
39781
40100
|
],
|
|
39782
40101
|
"events": [
|
|
39783
40102
|
{
|
|
39784
|
-
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
|
39785
|
-
"name": "input",
|
|
39786
|
-
"reactName": "onInput",
|
|
39787
|
-
"inheritedFrom": {
|
|
39788
|
-
"name": "Input",
|
|
39789
|
-
"module": "src/components/input/input.component.ts"
|
|
39790
|
-
}
|
|
39791
|
-
},
|
|
39792
|
-
{
|
|
39793
|
-
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
|
39794
40103
|
"name": "change",
|
|
39795
|
-
"reactName": "onChange",
|
|
39796
|
-
"inheritedFrom": {
|
|
39797
|
-
"name": "Input",
|
|
39798
|
-
"module": "src/components/input/input.component.ts"
|
|
39799
|
-
}
|
|
39800
|
-
},
|
|
39801
|
-
{
|
|
39802
|
-
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
|
39803
|
-
"name": "focus",
|
|
39804
|
-
"reactName": "onFocus",
|
|
39805
|
-
"inheritedFrom": {
|
|
39806
|
-
"name": "Input",
|
|
39807
|
-
"module": "src/components/input/input.component.ts"
|
|
39808
|
-
}
|
|
39809
|
-
},
|
|
39810
|
-
{
|
|
39811
|
-
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
|
39812
|
-
"name": "blur",
|
|
39813
|
-
"reactName": "onBlur",
|
|
39814
|
-
"inheritedFrom": {
|
|
39815
|
-
"name": "Input",
|
|
39816
|
-
"module": "src/components/input/input.component.ts"
|
|
39817
|
-
}
|
|
39818
|
-
},
|
|
39819
|
-
{
|
|
39820
|
-
"name": "clear",
|
|
39821
40104
|
"type": {
|
|
39822
40105
|
"text": "CustomEvent"
|
|
39823
40106
|
},
|
|
39824
|
-
"description": "(React:
|
|
39825
|
-
"reactName": "
|
|
39826
|
-
"inheritedFrom": {
|
|
39827
|
-
"name": "Input",
|
|
39828
|
-
"module": "src/components/input/input.component.ts"
|
|
39829
|
-
}
|
|
39830
|
-
},
|
|
39831
|
-
{
|
|
39832
|
-
"type": {
|
|
39833
|
-
"text": "EventConstructor"
|
|
39834
|
-
},
|
|
39835
|
-
"inheritedFrom": {
|
|
39836
|
-
"name": "Input",
|
|
39837
|
-
"module": "src/components/input/input.component.ts"
|
|
39838
|
-
}
|
|
39839
|
-
}
|
|
39840
|
-
],
|
|
39841
|
-
"superclass": {
|
|
39842
|
-
"name": "Input",
|
|
39843
|
-
"module": "/src/components/input/input.component"
|
|
39844
|
-
},
|
|
39845
|
-
"tagName": "mdc-searchfield",
|
|
39846
|
-
"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 * @slot label - Slot for the label element. If not provided, the `label` property will be used to render the label.\n * @slot toggletip - Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.\n * @slot help-icon - Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.\n * @slot help-text - Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.\n * @slot input - Slot for the input element. If not provided, the input field will be rendered.\n * @slot input-leading-icon - Slot for the leading icon before the input field. If not provided, the `leadingIcon` property will be used to render the leading icon.\n * @slot input-prefix-text - Slot for the prefix text before the input field. If not provided, the `prefixText` property will be used to render the prefix text.\n * @slot trailing-button - Slot for the trailing button to clear the input field. If not provided, the clear button will be rendered when `trailingButton` property is set to true.\n *\n * @cssproperty --mdc-label-font-size - Font size for the label text.\n * @cssproperty --mdc-label-font-weight - Font weight for the label text.\n * @cssproperty --mdc-label-line-height - Line height for the label text.\n * @cssproperty --mdc-label-color - Color for the label text.\n * @cssproperty --mdc-help-text-font-size - Font size for the help text.\n * @cssproperty --mdc-help-text-font-weight - Font weight for the help text.\n * @cssproperty --mdc-help-text-line-height - Line height for the help text.\n * @cssproperty --mdc-help-text-color - Color for the help text.\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n * @csspart leading-icon - The leading icon element that is displayed before the input field.\n * @csspart prefix-text - The prefix text element that is displayed before the input field.\n * @csspart input-container - The container for the input field, leading icon, prefix text, and trailing button elements.\n * @csspart input-section - The container for the input field, leading icon, and prefix text elements.\n * @csspart input-text - The input field element.\n * @csspart trailing-button - The trailing button element that is displayed to clear the input field when the `trailingButton` property is set to true.\n */",
|
|
39847
|
-
"customElement": true,
|
|
39848
|
-
"attributes": [
|
|
39849
|
-
{
|
|
39850
|
-
"name": "auto-focus-on-mount",
|
|
39851
|
-
"type": {
|
|
39852
|
-
"text": "boolean"
|
|
39853
|
-
},
|
|
39854
|
-
"default": "false",
|
|
39855
|
-
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
39856
|
-
"fieldName": "autoFocusOnMount",
|
|
39857
|
-
"inheritedFrom": {
|
|
39858
|
-
"name": "AutoFocusOnMountMixin",
|
|
39859
|
-
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
|
39860
|
-
}
|
|
40107
|
+
"description": "(React: onChange) This event is dispatched when the select is changed.",
|
|
40108
|
+
"reactName": "onChange"
|
|
39861
40109
|
},
|
|
39862
40110
|
{
|
|
39863
|
-
"name": "
|
|
40111
|
+
"name": "input",
|
|
39864
40112
|
"type": {
|
|
39865
|
-
"text": "
|
|
40113
|
+
"text": "CustomEvent"
|
|
39866
40114
|
},
|
|
39867
|
-
"
|
|
39868
|
-
"
|
|
39869
|
-
"fieldName": "name",
|
|
39870
|
-
"inheritedFrom": {
|
|
39871
|
-
"name": "FormInternalsMixin",
|
|
39872
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
39873
|
-
}
|
|
40115
|
+
"description": "(React: onInput) This event is dispatched when the select is changed.",
|
|
40116
|
+
"reactName": "onInput"
|
|
39874
40117
|
},
|
|
39875
40118
|
{
|
|
39876
|
-
"
|
|
39877
|
-
"
|
|
39878
|
-
|
|
39879
|
-
},
|
|
39880
|
-
"default": "''",
|
|
39881
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
39882
|
-
"fieldName": "value",
|
|
39883
|
-
"inheritedFrom": {
|
|
39884
|
-
"name": "FormInternalsMixin",
|
|
39885
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
39886
|
-
}
|
|
40119
|
+
"description": "(React: onClick) This event is dispatched when the select is clicked.",
|
|
40120
|
+
"name": "click",
|
|
40121
|
+
"reactName": "onClick"
|
|
39887
40122
|
},
|
|
39888
40123
|
{
|
|
39889
|
-
"
|
|
39890
|
-
"
|
|
39891
|
-
|
|
39892
|
-
},
|
|
39893
|
-
"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.",
|
|
39894
|
-
"fieldName": "validationMessage",
|
|
39895
|
-
"inheritedFrom": {
|
|
39896
|
-
"name": "FormInternalsMixin",
|
|
39897
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
39898
|
-
}
|
|
40124
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
|
|
40125
|
+
"name": "keydown",
|
|
40126
|
+
"reactName": "onKeyDown"
|
|
39899
40127
|
},
|
|
39900
40128
|
{
|
|
39901
|
-
"
|
|
39902
|
-
"
|
|
39903
|
-
|
|
39904
|
-
|
|
39905
|
-
|
|
39906
|
-
|
|
39907
|
-
"fieldName": "dataAriaLabel",
|
|
39908
|
-
"inheritedFrom": {
|
|
39909
|
-
"name": "DataAriaLabelMixin",
|
|
39910
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
|
39911
|
-
}
|
|
39912
|
-
},
|
|
40129
|
+
"description": "(React: onFocus) This event is dispatched when the select receives focus.",
|
|
40130
|
+
"name": "focus",
|
|
40131
|
+
"reactName": "onFocus"
|
|
40132
|
+
}
|
|
40133
|
+
],
|
|
40134
|
+
"attributes": [
|
|
39913
40135
|
{
|
|
39914
40136
|
"name": "placeholder",
|
|
39915
|
-
"type": {
|
|
39916
|
-
"text": "string"
|
|
39917
|
-
},
|
|
39918
|
-
"default": "''",
|
|
39919
|
-
"description": "The placeholder text that is displayed when the input field is empty.",
|
|
39920
|
-
"fieldName": "placeholder",
|
|
39921
|
-
"inheritedFrom": {
|
|
39922
|
-
"name": "Input",
|
|
39923
|
-
"module": "src/components/input/input.component.ts"
|
|
39924
|
-
}
|
|
39925
|
-
},
|
|
39926
|
-
{
|
|
39927
|
-
"name": "prefix-text",
|
|
39928
40137
|
"type": {
|
|
39929
40138
|
"text": "string | undefined"
|
|
39930
40139
|
},
|
|
39931
|
-
"description": "The
|
|
39932
|
-
"fieldName": "
|
|
39933
|
-
"inheritedFrom": {
|
|
39934
|
-
"name": "Input",
|
|
39935
|
-
"module": "src/components/input/input.component.ts"
|
|
39936
|
-
}
|
|
39937
|
-
},
|
|
39938
|
-
{
|
|
39939
|
-
"name": "leading-icon",
|
|
39940
|
-
"type": {
|
|
39941
|
-
"text": "IconNames | undefined"
|
|
39942
|
-
},
|
|
39943
|
-
"description": "The leading icon that is displayed before the input field.",
|
|
39944
|
-
"fieldName": "leadingIcon",
|
|
39945
|
-
"inheritedFrom": {
|
|
39946
|
-
"name": "Input",
|
|
39947
|
-
"module": "src/components/input/input.component.ts"
|
|
39948
|
-
}
|
|
40140
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
|
40141
|
+
"fieldName": "placeholder"
|
|
39949
40142
|
},
|
|
39950
40143
|
{
|
|
39951
|
-
"name": "
|
|
40144
|
+
"name": "placement",
|
|
39952
40145
|
"type": {
|
|
39953
|
-
"text": "
|
|
40146
|
+
"text": "Placement"
|
|
39954
40147
|
},
|
|
39955
|
-
"
|
|
39956
|
-
"
|
|
39957
|
-
"fieldName": "
|
|
39958
|
-
"inheritedFrom": {
|
|
39959
|
-
"name": "Input",
|
|
39960
|
-
"module": "src/components/input/input.component.ts"
|
|
39961
|
-
}
|
|
40148
|
+
"description": "The placement of the popover within Select component.\nThis defines the position of the popover relative to the select input field.\n\nPossible values:\n - 'top-start'\n - 'bottom-start'",
|
|
40149
|
+
"default": "'bottom-start'",
|
|
40150
|
+
"fieldName": "placement"
|
|
39962
40151
|
},
|
|
39963
40152
|
{
|
|
39964
|
-
"name": "
|
|
40153
|
+
"name": "boundary",
|
|
39965
40154
|
"type": {
|
|
39966
|
-
"text": "
|
|
40155
|
+
"text": "'clippingAncestors' | string"
|
|
39967
40156
|
},
|
|
39968
|
-
"description": "
|
|
39969
|
-
"
|
|
39970
|
-
"
|
|
39971
|
-
"name": "Input",
|
|
39972
|
-
"module": "src/components/input/input.component.ts"
|
|
39973
|
-
}
|
|
40157
|
+
"description": "This describes the clipping element(s) or area that overflow of the used popover will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
|
40158
|
+
"default": "'clippingAncestors'",
|
|
40159
|
+
"fieldName": "boundary"
|
|
39974
40160
|
},
|
|
39975
40161
|
{
|
|
39976
|
-
"name": "
|
|
40162
|
+
"name": "strategy",
|
|
39977
40163
|
"type": {
|
|
39978
|
-
"text": "
|
|
40164
|
+
"text": "PopoverStrategy"
|
|
39979
40165
|
},
|
|
39980
|
-
"description": "The
|
|
39981
|
-
"
|
|
39982
|
-
"
|
|
39983
|
-
"name": "Input",
|
|
39984
|
-
"module": "src/components/input/input.component.ts"
|
|
39985
|
-
}
|
|
40166
|
+
"description": "The strategy of the popover within Select.\nThis determines how the popover is positioned in the DOM.\n\nIn case `boundary` is set to something other than 'clippingAncestors',\nit might be necessary to set the `strategy` to 'fixed' to ensure that the popover\nis not getting clipped by scrollable containers enclosing the select.",
|
|
40167
|
+
"default": "absolute",
|
|
40168
|
+
"fieldName": "strategy"
|
|
39986
40169
|
},
|
|
39987
40170
|
{
|
|
39988
|
-
"name": "
|
|
40171
|
+
"name": "popover-z-index",
|
|
39989
40172
|
"type": {
|
|
39990
|
-
"text": "
|
|
40173
|
+
"text": "number"
|
|
39991
40174
|
},
|
|
39992
|
-
"description": "The
|
|
39993
|
-
"default": "
|
|
39994
|
-
"fieldName": "
|
|
39995
|
-
"inheritedFrom": {
|
|
39996
|
-
"name": "Input",
|
|
39997
|
-
"module": "src/components/input/input.component.ts"
|
|
39998
|
-
}
|
|
40175
|
+
"description": "The z-index of the popover within Select.\n\nOverride this to make sure this stays on top of other components.",
|
|
40176
|
+
"default": "1000",
|
|
40177
|
+
"fieldName": "popoverZIndex"
|
|
39999
40178
|
},
|
|
40000
40179
|
{
|
|
40001
|
-
"name": "
|
|
40180
|
+
"name": "backdrop-append-to",
|
|
40002
40181
|
"type": {
|
|
40003
|
-
"text": "
|
|
40182
|
+
"text": "string | undefined"
|
|
40004
40183
|
},
|
|
40005
|
-
"description": "
|
|
40006
|
-
"
|
|
40007
|
-
"fieldName": "autocomplete",
|
|
40008
|
-
"inheritedFrom": {
|
|
40009
|
-
"name": "Input",
|
|
40010
|
-
"module": "src/components/input/input.component.ts"
|
|
40011
|
-
}
|
|
40184
|
+
"description": "ID of the element where the backdrop will be appended to.\nThis is useful to ensure that the backdrop is appended to the correct element in the DOM.\nIf not set, the backdrop will be appended to the parent element of the select.",
|
|
40185
|
+
"fieldName": "backdropAppendTo"
|
|
40012
40186
|
},
|
|
40013
40187
|
{
|
|
40014
|
-
"name": "
|
|
40188
|
+
"name": "auto-focus-on-mount",
|
|
40015
40189
|
"type": {
|
|
40016
|
-
"text": "
|
|
40190
|
+
"text": "boolean"
|
|
40017
40191
|
},
|
|
40018
|
-
"
|
|
40019
|
-
"
|
|
40192
|
+
"default": "false",
|
|
40193
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
40194
|
+
"fieldName": "autoFocusOnMount",
|
|
40020
40195
|
"inheritedFrom": {
|
|
40021
|
-
"name": "
|
|
40022
|
-
"module": "src/
|
|
40196
|
+
"name": "AutoFocusOnMountMixin",
|
|
40197
|
+
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
|
40023
40198
|
}
|
|
40024
40199
|
},
|
|
40025
40200
|
{
|
|
40026
|
-
"name": "
|
|
40201
|
+
"name": "name",
|
|
40027
40202
|
"type": {
|
|
40028
|
-
"text": "string
|
|
40203
|
+
"text": "string"
|
|
40029
40204
|
},
|
|
40030
|
-
"
|
|
40031
|
-
"
|
|
40205
|
+
"default": "''",
|
|
40206
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
|
40207
|
+
"fieldName": "name",
|
|
40032
40208
|
"inheritedFrom": {
|
|
40033
|
-
"name": "
|
|
40034
|
-
"module": "src/
|
|
40209
|
+
"name": "FormInternalsMixin",
|
|
40210
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
40035
40211
|
}
|
|
40036
40212
|
},
|
|
40037
40213
|
{
|
|
40038
|
-
"name": "
|
|
40214
|
+
"name": "value",
|
|
40039
40215
|
"type": {
|
|
40040
|
-
"text": "string
|
|
40216
|
+
"text": "string"
|
|
40041
40217
|
},
|
|
40042
|
-
"
|
|
40043
|
-
"
|
|
40218
|
+
"default": "''",
|
|
40219
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
|
40220
|
+
"fieldName": "value",
|
|
40044
40221
|
"inheritedFrom": {
|
|
40045
|
-
"name": "
|
|
40046
|
-
"module": "src/
|
|
40222
|
+
"name": "FormInternalsMixin",
|
|
40223
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
40047
40224
|
}
|
|
40048
40225
|
},
|
|
40049
40226
|
{
|
|
40050
|
-
"name": "
|
|
40227
|
+
"name": "validation-message",
|
|
40051
40228
|
"type": {
|
|
40052
|
-
"text": "
|
|
40229
|
+
"text": "string | undefined"
|
|
40053
40230
|
},
|
|
40054
|
-
"description": "
|
|
40055
|
-
"
|
|
40056
|
-
"fieldName": "size",
|
|
40231
|
+
"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.",
|
|
40232
|
+
"fieldName": "validationMessage",
|
|
40057
40233
|
"inheritedFrom": {
|
|
40058
|
-
"name": "
|
|
40059
|
-
"module": "src/
|
|
40234
|
+
"name": "FormInternalsMixin",
|
|
40235
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
|
40060
40236
|
}
|
|
40061
40237
|
},
|
|
40062
40238
|
{
|
|
40063
|
-
"name": "
|
|
40239
|
+
"name": "data-aria-label",
|
|
40064
40240
|
"type": {
|
|
40065
|
-
"text": "string"
|
|
40241
|
+
"text": "string | null"
|
|
40066
40242
|
},
|
|
40067
|
-
"default": "
|
|
40068
|
-
"description": "
|
|
40069
|
-
"fieldName": "
|
|
40243
|
+
"default": "null",
|
|
40244
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
|
40245
|
+
"fieldName": "dataAriaLabel",
|
|
40070
40246
|
"inheritedFrom": {
|
|
40071
|
-
"name": "
|
|
40072
|
-
"module": "src/
|
|
40247
|
+
"name": "DataAriaLabelMixin",
|
|
40248
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
|
40073
40249
|
}
|
|
40074
40250
|
},
|
|
40075
40251
|
{
|
|
@@ -40208,211 +40384,35 @@
|
|
|
40208
40384
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
|
40209
40385
|
}
|
|
40210
40386
|
}
|
|
40211
|
-
]
|
|
40212
|
-
}
|
|
40213
|
-
],
|
|
40214
|
-
"exports": [
|
|
40215
|
-
{
|
|
40216
|
-
"kind": "js",
|
|
40217
|
-
"name": "default",
|
|
40218
|
-
"declaration": {
|
|
40219
|
-
"name": "Searchfield",
|
|
40220
|
-
"module": "components/searchfield/searchfield.component.js"
|
|
40221
|
-
}
|
|
40222
|
-
}
|
|
40223
|
-
]
|
|
40224
|
-
},
|
|
40225
|
-
{
|
|
40226
|
-
"kind": "javascript-module",
|
|
40227
|
-
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
|
40228
|
-
"declarations": [
|
|
40229
|
-
{
|
|
40230
|
-
"kind": "class",
|
|
40231
|
-
"description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
|
|
40232
|
-
"name": "ScreenreaderAnnouncer",
|
|
40233
|
-
"members": [
|
|
40234
|
-
{
|
|
40235
|
-
"kind": "field",
|
|
40236
|
-
"name": "announcement",
|
|
40237
|
-
"type": {
|
|
40238
|
-
"text": "string"
|
|
40239
|
-
},
|
|
40240
|
-
"default": "''",
|
|
40241
|
-
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
|
40242
|
-
"attribute": "announcement",
|
|
40243
|
-
"reflects": true
|
|
40244
|
-
},
|
|
40245
|
-
{
|
|
40246
|
-
"kind": "field",
|
|
40247
|
-
"name": "identity",
|
|
40248
|
-
"type": {
|
|
40249
|
-
"text": "string"
|
|
40250
|
-
},
|
|
40251
|
-
"default": "''",
|
|
40252
|
-
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
|
40253
|
-
"attribute": "identity",
|
|
40254
|
-
"reflects": true
|
|
40255
|
-
},
|
|
40256
|
-
{
|
|
40257
|
-
"kind": "field",
|
|
40258
|
-
"name": "dataAriaLive",
|
|
40259
|
-
"type": {
|
|
40260
|
-
"text": "AriaLive"
|
|
40261
|
-
},
|
|
40262
|
-
"description": "Aria live value for announcement.",
|
|
40263
|
-
"default": "'polite'",
|
|
40264
|
-
"attribute": "data-aria-live",
|
|
40265
|
-
"reflects": true
|
|
40266
|
-
},
|
|
40267
|
-
{
|
|
40268
|
-
"kind": "field",
|
|
40269
|
-
"name": "delay",
|
|
40270
|
-
"type": {
|
|
40271
|
-
"text": "number"
|
|
40272
|
-
},
|
|
40273
|
-
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
|
40274
|
-
"default": "150",
|
|
40275
|
-
"attribute": "delay",
|
|
40276
|
-
"reflects": true
|
|
40277
|
-
},
|
|
40278
|
-
{
|
|
40279
|
-
"kind": "field",
|
|
40280
|
-
"name": "timeout",
|
|
40281
|
-
"type": {
|
|
40282
|
-
"text": "number"
|
|
40283
|
-
},
|
|
40284
|
-
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
|
40285
|
-
"default": "20_000",
|
|
40286
|
-
"attribute": "timeout",
|
|
40287
|
-
"reflects": true
|
|
40288
|
-
},
|
|
40289
|
-
{
|
|
40290
|
-
"kind": "field",
|
|
40291
|
-
"name": "debounceTime",
|
|
40292
|
-
"type": {
|
|
40293
|
-
"text": "number"
|
|
40294
|
-
},
|
|
40295
|
-
"description": "The debounce time delay in milliseconds for announcements.",
|
|
40296
|
-
"default": "500",
|
|
40297
|
-
"attribute": "debounce-time",
|
|
40298
|
-
"reflects": true
|
|
40299
|
-
},
|
|
40300
|
-
{
|
|
40301
|
-
"kind": "method",
|
|
40302
|
-
"name": "announce",
|
|
40303
|
-
"parameters": [
|
|
40304
|
-
{
|
|
40305
|
-
"name": "announcement",
|
|
40306
|
-
"type": {
|
|
40307
|
-
"text": "string"
|
|
40308
|
-
},
|
|
40309
|
-
"description": "The announcement to be made."
|
|
40310
|
-
},
|
|
40311
|
-
{
|
|
40312
|
-
"name": "delay",
|
|
40313
|
-
"type": {
|
|
40314
|
-
"text": "number"
|
|
40315
|
-
},
|
|
40316
|
-
"description": "The delay in milliseconds before announcing the message."
|
|
40317
|
-
},
|
|
40318
|
-
{
|
|
40319
|
-
"name": "timeout",
|
|
40320
|
-
"type": {
|
|
40321
|
-
"text": "number"
|
|
40322
|
-
},
|
|
40323
|
-
"description": "The timeout in milliseconds before removing the announcement."
|
|
40324
|
-
},
|
|
40325
|
-
{
|
|
40326
|
-
"name": "ariaLive",
|
|
40327
|
-
"type": {
|
|
40328
|
-
"text": "AriaLive"
|
|
40329
|
-
},
|
|
40330
|
-
"description": "The aria live value for the announcement."
|
|
40331
|
-
}
|
|
40332
|
-
],
|
|
40333
|
-
"description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
|
|
40334
|
-
},
|
|
40335
|
-
{
|
|
40336
|
-
"kind": "method",
|
|
40337
|
-
"name": "clearTimeOutsAndAnnouncements",
|
|
40338
|
-
"privacy": "private",
|
|
40339
|
-
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
|
40340
|
-
},
|
|
40341
|
-
{
|
|
40342
|
-
"kind": "method",
|
|
40343
|
-
"name": "createAnnouncementAriaLiveRegion",
|
|
40344
|
-
"privacy": "private",
|
|
40345
|
-
"description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
|
|
40346
|
-
},
|
|
40347
|
-
{
|
|
40348
|
-
"kind": "method",
|
|
40349
|
-
"name": "setupDebouncedAnnounce",
|
|
40350
|
-
"privacy": "private",
|
|
40351
|
-
"description": "Creates a single debounced function that will read the latest this.announcement when executed.\n\nThis function is used to debounce the announcement so that it will only be made after\nthis.debounceTime milliseconds have passed since the last time this.announcement was updated."
|
|
40352
|
-
}
|
|
40353
40387
|
],
|
|
40354
|
-
"
|
|
40355
|
-
{
|
|
40356
|
-
"name": "announcement",
|
|
40357
|
-
"type": {
|
|
40358
|
-
"text": "string"
|
|
40359
|
-
},
|
|
40360
|
-
"default": "''",
|
|
40361
|
-
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
|
40362
|
-
"fieldName": "announcement"
|
|
40363
|
-
},
|
|
40388
|
+
"mixins": [
|
|
40364
40389
|
{
|
|
40365
|
-
"name": "
|
|
40366
|
-
"
|
|
40367
|
-
"text": "string"
|
|
40368
|
-
},
|
|
40369
|
-
"default": "''",
|
|
40370
|
-
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
|
40371
|
-
"fieldName": "identity"
|
|
40390
|
+
"name": "ListNavigationMixin",
|
|
40391
|
+
"module": "/src/utils/mixins/ListNavigationMixin"
|
|
40372
40392
|
},
|
|
40373
40393
|
{
|
|
40374
|
-
"name": "
|
|
40375
|
-
"
|
|
40376
|
-
"text": "AriaLive"
|
|
40377
|
-
},
|
|
40378
|
-
"description": "Aria live value for announcement.",
|
|
40379
|
-
"default": "'polite'",
|
|
40380
|
-
"fieldName": "dataAriaLive"
|
|
40394
|
+
"name": "CaptureDestroyEventForChildElement",
|
|
40395
|
+
"module": "/src/utils/mixins/lifecycle/CaptureDestroyEventForChildElement"
|
|
40381
40396
|
},
|
|
40382
40397
|
{
|
|
40383
|
-
"name": "
|
|
40384
|
-
"
|
|
40385
|
-
"text": "number"
|
|
40386
|
-
},
|
|
40387
|
-
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
|
40388
|
-
"default": "150",
|
|
40389
|
-
"fieldName": "delay"
|
|
40398
|
+
"name": "AutoFocusOnMountMixin",
|
|
40399
|
+
"module": "/src/utils/mixins/AutoFocusOnMountMixin"
|
|
40390
40400
|
},
|
|
40391
40401
|
{
|
|
40392
|
-
"name": "
|
|
40393
|
-
"
|
|
40394
|
-
"text": "number"
|
|
40395
|
-
},
|
|
40396
|
-
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
|
40397
|
-
"default": "20_000",
|
|
40398
|
-
"fieldName": "timeout"
|
|
40402
|
+
"name": "FormInternalsMixin",
|
|
40403
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
|
40399
40404
|
},
|
|
40400
40405
|
{
|
|
40401
|
-
"name": "
|
|
40402
|
-
"
|
|
40403
|
-
"text": "number"
|
|
40404
|
-
},
|
|
40405
|
-
"description": "The debounce time delay in milliseconds for announcements.",
|
|
40406
|
-
"default": "500",
|
|
40407
|
-
"fieldName": "debounceTime"
|
|
40406
|
+
"name": "DataAriaLabelMixin",
|
|
40407
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
|
40408
40408
|
}
|
|
40409
40409
|
],
|
|
40410
40410
|
"superclass": {
|
|
40411
|
-
"name": "
|
|
40412
|
-
"module": "/src/
|
|
40411
|
+
"name": "FormfieldWrapper",
|
|
40412
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
|
40413
40413
|
},
|
|
40414
|
-
"tagName": "mdc-
|
|
40415
|
-
"jsDoc": "/**\n *
|
|
40414
|
+
"tagName": "mdc-select",
|
|
40415
|
+
"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 *\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 * You can also set the `value` attribute on the `mdc-select` element to match the value of the desired option. The component will select the corresponding option automatically.\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 * If you need to use `mdc-tooltip` with any options, make sure to place the tooltip component outside the `mdc-select` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n *\n * @slot label - Slot for the label element. If not provided, the `label` property will be used to render the label.\n * @slot toggletip - Slot for the toggletip info icon button. If not provided, the `toggletip-text` property will be used to render the info icon button and toggletip.\n * @slot help-icon - Slot for the helper/validation icon. If not provided, the icon will be rendered based on the `helpTextType` property.\n * @slot help-text - Slot for the helper/validation text. If not provided, the `helpText` property will be used to render the helper/validation text.\n *\n * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n *\n * @cssproperty --mdc-label-font-size - Font size for the label text.\n * @cssproperty --mdc-label-font-weight - Font weight for the label text.\n * @cssproperty --mdc-label-line-height - Line height for the label text.\n * @cssproperty --mdc-label-color - Color for the label text.\n * @cssproperty --mdc-help-text-font-size - Font size for the help text.\n * @cssproperty --mdc-help-text-font-weight - Font weight for the help text.\n * @cssproperty --mdc-help-text-line-height - Line height for the help text.\n * @cssproperty --mdc-help-text-color - Color for the help text.\n * @cssproperty --mdc-select-background-color - The background color of the combobox of select.\n * @cssproperty --mdc-select-text-color - The text color of the select.\n * @cssproperty --mdc-select-border-color - The border color of the select.\n * @cssproperty --mdc-select-width - The width of the select.\n * @cssproperty --mdc-select-listbox-height - The height of the listbox inside the select.\n * @cssproperty --mdc-select-listbox-width - The width of the listbox inside the select (default: `--mdc-select-width`).\n */",
|
|
40416
40416
|
"customElement": true
|
|
40417
40417
|
}
|
|
40418
40418
|
],
|
|
@@ -40421,8 +40421,8 @@
|
|
|
40421
40421
|
"kind": "js",
|
|
40422
40422
|
"name": "default",
|
|
40423
40423
|
"declaration": {
|
|
40424
|
-
"name": "
|
|
40425
|
-
"module": "components/
|
|
40424
|
+
"name": "Select",
|
|
40425
|
+
"module": "components/select/select.component.js"
|
|
40426
40426
|
}
|
|
40427
40427
|
}
|
|
40428
40428
|
]
|
|
@@ -41705,247 +41705,47 @@
|
|
|
41705
41705
|
"name": "--mdc-staticcheckbox-checked-background-color"
|
|
41706
41706
|
},
|
|
41707
41707
|
{
|
|
41708
|
-
"description": "Background color for a disabled checkbox.",
|
|
41709
|
-
"name": "--mdc-staticcheckbox-disabled-background-color"
|
|
41710
|
-
},
|
|
41711
|
-
{
|
|
41712
|
-
"description": "Border color for a disabled checkbox.",
|
|
41713
|
-
"name": "--mdc-checkbox-disabled-border-color"
|
|
41714
|
-
},
|
|
41715
|
-
{
|
|
41716
|
-
"description": "Background color for a disabled, selected checkbox.",
|
|
41717
|
-
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
|
41718
|
-
},
|
|
41719
|
-
{
|
|
41720
|
-
"description": "Icon color for a disabled checkbox.",
|
|
41721
|
-
"name": "--mdc-staticcheckbox-disabled-icon-color"
|
|
41722
|
-
},
|
|
41723
|
-
{
|
|
41724
|
-
"description": "Background color for an unselected checkbox.",
|
|
41725
|
-
"name": "--mdc-staticcheckbox-icon-background-color"
|
|
41726
|
-
},
|
|
41727
|
-
{
|
|
41728
|
-
"description": "Default background color for an unselected checkbox.",
|
|
41729
|
-
"name": "--mdc-staticcheckbox-icon-border-color"
|
|
41730
|
-
},
|
|
41731
|
-
{
|
|
41732
|
-
"description": "Icon color for an unselected checkbox.",
|
|
41733
|
-
"name": "--mdc-staticcheckbox-icon-color"
|
|
41734
|
-
}
|
|
41735
|
-
],
|
|
41736
|
-
"cssParts": [
|
|
41737
|
-
{
|
|
41738
|
-
"description": "The container for the checkbox icon.",
|
|
41739
|
-
"name": "icon-container"
|
|
41740
|
-
},
|
|
41741
|
-
{
|
|
41742
|
-
"description": "The checkbox icon.",
|
|
41743
|
-
"name": "checkbox-icon"
|
|
41744
|
-
}
|
|
41745
|
-
],
|
|
41746
|
-
"slots": [
|
|
41747
|
-
{
|
|
41748
|
-
"description": "Default slot for adding label text.",
|
|
41749
|
-
"name": ""
|
|
41750
|
-
}
|
|
41751
|
-
],
|
|
41752
|
-
"members": [
|
|
41753
|
-
{
|
|
41754
|
-
"kind": "field",
|
|
41755
|
-
"name": "checked",
|
|
41756
|
-
"type": {
|
|
41757
|
-
"text": "boolean"
|
|
41758
|
-
},
|
|
41759
|
-
"default": "false",
|
|
41760
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
|
41761
|
-
"attribute": "checked",
|
|
41762
|
-
"reflects": true
|
|
41763
|
-
},
|
|
41764
|
-
{
|
|
41765
|
-
"kind": "field",
|
|
41766
|
-
"name": "indeterminate",
|
|
41767
|
-
"type": {
|
|
41768
|
-
"text": "boolean"
|
|
41769
|
-
},
|
|
41770
|
-
"default": "false",
|
|
41771
|
-
"description": "Determines whether the checkbox is in an indeterminate state.",
|
|
41772
|
-
"attribute": "indeterminate",
|
|
41773
|
-
"reflects": true
|
|
41774
|
-
},
|
|
41775
|
-
{
|
|
41776
|
-
"kind": "field",
|
|
41777
|
-
"name": "readonly",
|
|
41778
|
-
"type": {
|
|
41779
|
-
"text": "boolean"
|
|
41780
|
-
},
|
|
41781
|
-
"default": "false",
|
|
41782
|
-
"description": "Determines whether the checkbox is read-only.",
|
|
41783
|
-
"attribute": "readonly",
|
|
41784
|
-
"reflects": true
|
|
41785
|
-
},
|
|
41786
|
-
{
|
|
41787
|
-
"kind": "field",
|
|
41788
|
-
"name": "softDisabled",
|
|
41789
|
-
"type": {
|
|
41790
|
-
"text": "boolean"
|
|
41791
|
-
},
|
|
41792
|
-
"default": "false",
|
|
41793
|
-
"description": "Determines whether the checkbox is soft-disabled.",
|
|
41794
|
-
"attribute": "soft-disabled",
|
|
41795
|
-
"reflects": true
|
|
41796
|
-
},
|
|
41797
|
-
{
|
|
41798
|
-
"kind": "field",
|
|
41799
|
-
"name": "disabled",
|
|
41800
|
-
"type": {
|
|
41801
|
-
"text": "boolean | undefined"
|
|
41802
|
-
},
|
|
41803
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
41804
|
-
"default": "undefined",
|
|
41805
|
-
"attribute": "disabled",
|
|
41806
|
-
"reflects": true,
|
|
41807
|
-
"inheritedFrom": {
|
|
41808
|
-
"name": "DisabledMixin",
|
|
41809
|
-
"module": "utils/mixins/DisabledMixin.js"
|
|
41810
|
-
}
|
|
41811
|
-
}
|
|
41812
|
-
],
|
|
41813
|
-
"attributes": [
|
|
41814
|
-
{
|
|
41815
|
-
"name": "checked",
|
|
41816
|
-
"type": {
|
|
41817
|
-
"text": "boolean"
|
|
41818
|
-
},
|
|
41819
|
-
"default": "false",
|
|
41820
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
|
41821
|
-
"fieldName": "checked"
|
|
41822
|
-
},
|
|
41823
|
-
{
|
|
41824
|
-
"name": "indeterminate",
|
|
41825
|
-
"type": {
|
|
41826
|
-
"text": "boolean"
|
|
41827
|
-
},
|
|
41828
|
-
"default": "false",
|
|
41829
|
-
"description": "Determines whether the checkbox is in an indeterminate state.",
|
|
41830
|
-
"fieldName": "indeterminate"
|
|
41831
|
-
},
|
|
41832
|
-
{
|
|
41833
|
-
"name": "readonly",
|
|
41834
|
-
"type": {
|
|
41835
|
-
"text": "boolean"
|
|
41836
|
-
},
|
|
41837
|
-
"default": "false",
|
|
41838
|
-
"description": "Determines whether the checkbox is read-only.",
|
|
41839
|
-
"fieldName": "readonly"
|
|
41840
|
-
},
|
|
41841
|
-
{
|
|
41842
|
-
"name": "soft-disabled",
|
|
41843
|
-
"type": {
|
|
41844
|
-
"text": "boolean"
|
|
41845
|
-
},
|
|
41846
|
-
"default": "false",
|
|
41847
|
-
"description": "Determines whether the checkbox is soft-disabled.",
|
|
41848
|
-
"fieldName": "softDisabled"
|
|
41849
|
-
},
|
|
41850
|
-
{
|
|
41851
|
-
"name": "disabled",
|
|
41852
|
-
"type": {
|
|
41853
|
-
"text": "boolean | undefined"
|
|
41854
|
-
},
|
|
41855
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
41856
|
-
"default": "undefined",
|
|
41857
|
-
"fieldName": "disabled",
|
|
41858
|
-
"inheritedFrom": {
|
|
41859
|
-
"name": "DisabledMixin",
|
|
41860
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
41861
|
-
}
|
|
41862
|
-
}
|
|
41863
|
-
],
|
|
41864
|
-
"mixins": [
|
|
41865
|
-
{
|
|
41866
|
-
"name": "DisabledMixin",
|
|
41867
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
|
41868
|
-
}
|
|
41869
|
-
],
|
|
41870
|
-
"superclass": {
|
|
41871
|
-
"name": "Component",
|
|
41872
|
-
"module": "/src/models"
|
|
41873
|
-
},
|
|
41874
|
-
"tagName": "mdc-staticcheckbox",
|
|
41875
|
-
"jsDoc": "/**\n * This is a decorative component that is styled to look as a checkbox.\n *\n * It has 5 properties - checked, indeterminate, disabled, readonly and soft-disabled.\n *\n * We are using the same styling that has been created for the `mdc-checkbox` component.\n *\n * @tagname mdc-staticcheckbox\n *\n * @dependency mdc-icon\n *\n * @cssproperty --mdc-staticcheckbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-staticcheckbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-color - Icon color for an unselected checkbox.\n *\n * @csspart icon-container - The container for the checkbox icon.\n * @csspart checkbox-icon - The checkbox icon.\n *\n * @slot - Default slot for adding label text.\n */",
|
|
41876
|
-
"customElement": true
|
|
41877
|
-
}
|
|
41878
|
-
],
|
|
41879
|
-
"exports": [
|
|
41880
|
-
{
|
|
41881
|
-
"kind": "js",
|
|
41882
|
-
"name": "default",
|
|
41883
|
-
"declaration": {
|
|
41884
|
-
"name": "StaticCheckbox",
|
|
41885
|
-
"module": "components/staticcheckbox/staticcheckbox.component.js"
|
|
41886
|
-
}
|
|
41887
|
-
}
|
|
41888
|
-
]
|
|
41889
|
-
},
|
|
41890
|
-
{
|
|
41891
|
-
"kind": "javascript-module",
|
|
41892
|
-
"path": "components/staticradio/staticradio.component.js",
|
|
41893
|
-
"declarations": [
|
|
41894
|
-
{
|
|
41895
|
-
"kind": "class",
|
|
41896
|
-
"description": "This is a decorative component that is styled to look as a radio.\nIt has 4 properties - checked, disabled, readonly and soft-disabled.\n\nWe are using the same styling that has been created for the `mdc-radio` component.",
|
|
41897
|
-
"name": "StaticRadio",
|
|
41898
|
-
"cssProperties": [
|
|
41899
|
-
{
|
|
41900
|
-
"description": "size of the inner circle",
|
|
41901
|
-
"name": "--mdc-staticradio-inner-circle-size"
|
|
41902
|
-
},
|
|
41903
|
-
{
|
|
41904
|
-
"description": "color of the label when disabled",
|
|
41905
|
-
"name": "--mdc-staticradio-text-disabled-color"
|
|
41906
|
-
},
|
|
41907
|
-
{
|
|
41908
|
-
"description": "color of the radio button border when normal",
|
|
41909
|
-
"name": "--mdc-staticradio-normal-border-color"
|
|
41910
|
-
},
|
|
41911
|
-
{
|
|
41912
|
-
"description": "color of the radio button border when disabled",
|
|
41913
|
-
"name": "--mdc-staticradio-disabled-border-color"
|
|
41708
|
+
"description": "Background color for a disabled checkbox.",
|
|
41709
|
+
"name": "--mdc-staticcheckbox-disabled-background-color"
|
|
41914
41710
|
},
|
|
41915
41711
|
{
|
|
41916
|
-
"description": "
|
|
41917
|
-
"name": "--mdc-
|
|
41712
|
+
"description": "Border color for a disabled checkbox.",
|
|
41713
|
+
"name": "--mdc-checkbox-disabled-border-color"
|
|
41918
41714
|
},
|
|
41919
41715
|
{
|
|
41920
|
-
"description": "
|
|
41921
|
-
"name": "--mdc-
|
|
41716
|
+
"description": "Background color for a disabled, selected checkbox.",
|
|
41717
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
|
41922
41718
|
},
|
|
41923
41719
|
{
|
|
41924
|
-
"description": "color
|
|
41925
|
-
"name": "--mdc-
|
|
41720
|
+
"description": "Icon color for a disabled checkbox.",
|
|
41721
|
+
"name": "--mdc-staticcheckbox-disabled-icon-color"
|
|
41926
41722
|
},
|
|
41927
41723
|
{
|
|
41928
|
-
"description": "
|
|
41929
|
-
"name": "--mdc-
|
|
41724
|
+
"description": "Background color for an unselected checkbox.",
|
|
41725
|
+
"name": "--mdc-staticcheckbox-icon-background-color"
|
|
41930
41726
|
},
|
|
41931
41727
|
{
|
|
41932
|
-
"description": "
|
|
41933
|
-
"name": "--mdc-
|
|
41728
|
+
"description": "Default background color for an unselected checkbox.",
|
|
41729
|
+
"name": "--mdc-staticcheckbox-icon-border-color"
|
|
41934
41730
|
},
|
|
41935
41731
|
{
|
|
41936
|
-
"description": "
|
|
41937
|
-
"name": "--mdc-
|
|
41732
|
+
"description": "Icon color for an unselected checkbox.",
|
|
41733
|
+
"name": "--mdc-staticcheckbox-icon-color"
|
|
41938
41734
|
}
|
|
41939
41735
|
],
|
|
41940
41736
|
"cssParts": [
|
|
41941
41737
|
{
|
|
41942
|
-
"description": "The
|
|
41943
|
-
"name": "
|
|
41738
|
+
"description": "The container for the checkbox icon.",
|
|
41739
|
+
"name": "icon-container"
|
|
41740
|
+
},
|
|
41741
|
+
{
|
|
41742
|
+
"description": "The checkbox icon.",
|
|
41743
|
+
"name": "checkbox-icon"
|
|
41944
41744
|
}
|
|
41945
41745
|
],
|
|
41946
41746
|
"slots": [
|
|
41947
41747
|
{
|
|
41948
|
-
"description": "Default slot for
|
|
41748
|
+
"description": "Default slot for adding label text.",
|
|
41949
41749
|
"name": ""
|
|
41950
41750
|
}
|
|
41951
41751
|
],
|
|
@@ -41957,10 +41757,21 @@
|
|
|
41957
41757
|
"text": "boolean"
|
|
41958
41758
|
},
|
|
41959
41759
|
"default": "false",
|
|
41960
|
-
"description": "Determines whether the
|
|
41760
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
|
41961
41761
|
"attribute": "checked",
|
|
41962
41762
|
"reflects": true
|
|
41963
41763
|
},
|
|
41764
|
+
{
|
|
41765
|
+
"kind": "field",
|
|
41766
|
+
"name": "indeterminate",
|
|
41767
|
+
"type": {
|
|
41768
|
+
"text": "boolean"
|
|
41769
|
+
},
|
|
41770
|
+
"default": "false",
|
|
41771
|
+
"description": "Determines whether the checkbox is in an indeterminate state.",
|
|
41772
|
+
"attribute": "indeterminate",
|
|
41773
|
+
"reflects": true
|
|
41774
|
+
},
|
|
41964
41775
|
{
|
|
41965
41776
|
"kind": "field",
|
|
41966
41777
|
"name": "readonly",
|
|
@@ -41968,7 +41779,7 @@
|
|
|
41968
41779
|
"text": "boolean"
|
|
41969
41780
|
},
|
|
41970
41781
|
"default": "false",
|
|
41971
|
-
"description": "Determines whether the
|
|
41782
|
+
"description": "Determines whether the checkbox is read-only.",
|
|
41972
41783
|
"attribute": "readonly",
|
|
41973
41784
|
"reflects": true
|
|
41974
41785
|
},
|
|
@@ -41979,7 +41790,7 @@
|
|
|
41979
41790
|
"text": "boolean"
|
|
41980
41791
|
},
|
|
41981
41792
|
"default": "false",
|
|
41982
|
-
"description": "Determines whether the
|
|
41793
|
+
"description": "Determines whether the checkbox is soft-disabled.",
|
|
41983
41794
|
"attribute": "soft-disabled",
|
|
41984
41795
|
"reflects": true
|
|
41985
41796
|
},
|
|
@@ -42006,16 +41817,25 @@
|
|
|
42006
41817
|
"text": "boolean"
|
|
42007
41818
|
},
|
|
42008
41819
|
"default": "false",
|
|
42009
|
-
"description": "Determines whether the
|
|
41820
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
|
42010
41821
|
"fieldName": "checked"
|
|
42011
41822
|
},
|
|
41823
|
+
{
|
|
41824
|
+
"name": "indeterminate",
|
|
41825
|
+
"type": {
|
|
41826
|
+
"text": "boolean"
|
|
41827
|
+
},
|
|
41828
|
+
"default": "false",
|
|
41829
|
+
"description": "Determines whether the checkbox is in an indeterminate state.",
|
|
41830
|
+
"fieldName": "indeterminate"
|
|
41831
|
+
},
|
|
42012
41832
|
{
|
|
42013
41833
|
"name": "readonly",
|
|
42014
41834
|
"type": {
|
|
42015
41835
|
"text": "boolean"
|
|
42016
41836
|
},
|
|
42017
41837
|
"default": "false",
|
|
42018
|
-
"description": "Determines whether the
|
|
41838
|
+
"description": "Determines whether the checkbox is read-only.",
|
|
42019
41839
|
"fieldName": "readonly"
|
|
42020
41840
|
},
|
|
42021
41841
|
{
|
|
@@ -42024,7 +41844,7 @@
|
|
|
42024
41844
|
"text": "boolean"
|
|
42025
41845
|
},
|
|
42026
41846
|
"default": "false",
|
|
42027
|
-
"description": "Determines whether the
|
|
41847
|
+
"description": "Determines whether the checkbox is soft-disabled.",
|
|
42028
41848
|
"fieldName": "softDisabled"
|
|
42029
41849
|
},
|
|
42030
41850
|
{
|
|
@@ -42051,8 +41871,8 @@
|
|
|
42051
41871
|
"name": "Component",
|
|
42052
41872
|
"module": "/src/models"
|
|
42053
41873
|
},
|
|
42054
|
-
"tagName": "mdc-
|
|
42055
|
-
"jsDoc": "/**\n * This is a decorative component that is styled to look as a
|
|
41874
|
+
"tagName": "mdc-staticcheckbox",
|
|
41875
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a checkbox.\n *\n * It has 5 properties - checked, indeterminate, disabled, readonly and soft-disabled.\n *\n * We are using the same styling that has been created for the `mdc-checkbox` component.\n *\n * @tagname mdc-staticcheckbox\n *\n * @dependency mdc-icon\n *\n * @cssproperty --mdc-staticcheckbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-staticcheckbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-staticcheckbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-color - Icon color for an unselected checkbox.\n *\n * @csspart icon-container - The container for the checkbox icon.\n * @csspart checkbox-icon - The checkbox icon.\n *\n * @slot - Default slot for adding label text.\n */",
|
|
42056
41876
|
"customElement": true
|
|
42057
41877
|
}
|
|
42058
41878
|
],
|
|
@@ -42061,8 +41881,8 @@
|
|
|
42061
41881
|
"kind": "js",
|
|
42062
41882
|
"name": "default",
|
|
42063
41883
|
"declaration": {
|
|
42064
|
-
"name": "
|
|
42065
|
-
"module": "components/
|
|
41884
|
+
"name": "StaticCheckbox",
|
|
41885
|
+
"module": "components/staticcheckbox/staticcheckbox.component.js"
|
|
42066
41886
|
}
|
|
42067
41887
|
}
|
|
42068
41888
|
]
|
|
@@ -42200,6 +42020,186 @@
|
|
|
42200
42020
|
}
|
|
42201
42021
|
]
|
|
42202
42022
|
},
|
|
42023
|
+
{
|
|
42024
|
+
"kind": "javascript-module",
|
|
42025
|
+
"path": "components/staticradio/staticradio.component.js",
|
|
42026
|
+
"declarations": [
|
|
42027
|
+
{
|
|
42028
|
+
"kind": "class",
|
|
42029
|
+
"description": "This is a decorative component that is styled to look as a radio.\nIt has 4 properties - checked, disabled, readonly and soft-disabled.\n\nWe are using the same styling that has been created for the `mdc-radio` component.",
|
|
42030
|
+
"name": "StaticRadio",
|
|
42031
|
+
"cssProperties": [
|
|
42032
|
+
{
|
|
42033
|
+
"description": "size of the inner circle",
|
|
42034
|
+
"name": "--mdc-staticradio-inner-circle-size"
|
|
42035
|
+
},
|
|
42036
|
+
{
|
|
42037
|
+
"description": "color of the label when disabled",
|
|
42038
|
+
"name": "--mdc-staticradio-text-disabled-color"
|
|
42039
|
+
},
|
|
42040
|
+
{
|
|
42041
|
+
"description": "color of the radio button border when normal",
|
|
42042
|
+
"name": "--mdc-staticradio-normal-border-color"
|
|
42043
|
+
},
|
|
42044
|
+
{
|
|
42045
|
+
"description": "color of the radio button border when disabled",
|
|
42046
|
+
"name": "--mdc-staticradio-disabled-border-color"
|
|
42047
|
+
},
|
|
42048
|
+
{
|
|
42049
|
+
"description": "background color of the inner circle when normal",
|
|
42050
|
+
"name": "--mdc-staticradio-inner-circle-normal-background"
|
|
42051
|
+
},
|
|
42052
|
+
{
|
|
42053
|
+
"description": "background color of the inner circle when disabled",
|
|
42054
|
+
"name": "--mdc-staticradio-inner-circle-disabled-background"
|
|
42055
|
+
},
|
|
42056
|
+
{
|
|
42057
|
+
"description": "color of the radio button when inactive",
|
|
42058
|
+
"name": "--mdc-staticradio-control-inactive-color"
|
|
42059
|
+
},
|
|
42060
|
+
{
|
|
42061
|
+
"description": "background color of the radio button when inactive and disabled",
|
|
42062
|
+
"name": "--mdc-staticradio-control-inactive-disabled-background"
|
|
42063
|
+
},
|
|
42064
|
+
{
|
|
42065
|
+
"description": "color of the radio button when active",
|
|
42066
|
+
"name": "--mdc-staticradio-control-active-color"
|
|
42067
|
+
},
|
|
42068
|
+
{
|
|
42069
|
+
"description": "background color of the radio button when active and disabled",
|
|
42070
|
+
"name": "--mdc-staticradio-control-active-disabled-background"
|
|
42071
|
+
}
|
|
42072
|
+
],
|
|
42073
|
+
"cssParts": [
|
|
42074
|
+
{
|
|
42075
|
+
"description": "The radio icon.",
|
|
42076
|
+
"name": "radio-icon"
|
|
42077
|
+
}
|
|
42078
|
+
],
|
|
42079
|
+
"slots": [
|
|
42080
|
+
{
|
|
42081
|
+
"description": "Default slot for the label of the radio.",
|
|
42082
|
+
"name": ""
|
|
42083
|
+
}
|
|
42084
|
+
],
|
|
42085
|
+
"members": [
|
|
42086
|
+
{
|
|
42087
|
+
"kind": "field",
|
|
42088
|
+
"name": "checked",
|
|
42089
|
+
"type": {
|
|
42090
|
+
"text": "boolean"
|
|
42091
|
+
},
|
|
42092
|
+
"default": "false",
|
|
42093
|
+
"description": "Determines whether the radio is selected or unselected.",
|
|
42094
|
+
"attribute": "checked",
|
|
42095
|
+
"reflects": true
|
|
42096
|
+
},
|
|
42097
|
+
{
|
|
42098
|
+
"kind": "field",
|
|
42099
|
+
"name": "readonly",
|
|
42100
|
+
"type": {
|
|
42101
|
+
"text": "boolean"
|
|
42102
|
+
},
|
|
42103
|
+
"default": "false",
|
|
42104
|
+
"description": "Determines whether the radio is read-only.",
|
|
42105
|
+
"attribute": "readonly",
|
|
42106
|
+
"reflects": true
|
|
42107
|
+
},
|
|
42108
|
+
{
|
|
42109
|
+
"kind": "field",
|
|
42110
|
+
"name": "softDisabled",
|
|
42111
|
+
"type": {
|
|
42112
|
+
"text": "boolean"
|
|
42113
|
+
},
|
|
42114
|
+
"default": "false",
|
|
42115
|
+
"description": "Determines whether the radio is soft-disabled.",
|
|
42116
|
+
"attribute": "soft-disabled",
|
|
42117
|
+
"reflects": true
|
|
42118
|
+
},
|
|
42119
|
+
{
|
|
42120
|
+
"kind": "field",
|
|
42121
|
+
"name": "disabled",
|
|
42122
|
+
"type": {
|
|
42123
|
+
"text": "boolean | undefined"
|
|
42124
|
+
},
|
|
42125
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
42126
|
+
"default": "undefined",
|
|
42127
|
+
"attribute": "disabled",
|
|
42128
|
+
"reflects": true,
|
|
42129
|
+
"inheritedFrom": {
|
|
42130
|
+
"name": "DisabledMixin",
|
|
42131
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
42132
|
+
}
|
|
42133
|
+
}
|
|
42134
|
+
],
|
|
42135
|
+
"attributes": [
|
|
42136
|
+
{
|
|
42137
|
+
"name": "checked",
|
|
42138
|
+
"type": {
|
|
42139
|
+
"text": "boolean"
|
|
42140
|
+
},
|
|
42141
|
+
"default": "false",
|
|
42142
|
+
"description": "Determines whether the radio is selected or unselected.",
|
|
42143
|
+
"fieldName": "checked"
|
|
42144
|
+
},
|
|
42145
|
+
{
|
|
42146
|
+
"name": "readonly",
|
|
42147
|
+
"type": {
|
|
42148
|
+
"text": "boolean"
|
|
42149
|
+
},
|
|
42150
|
+
"default": "false",
|
|
42151
|
+
"description": "Determines whether the radio is read-only.",
|
|
42152
|
+
"fieldName": "readonly"
|
|
42153
|
+
},
|
|
42154
|
+
{
|
|
42155
|
+
"name": "soft-disabled",
|
|
42156
|
+
"type": {
|
|
42157
|
+
"text": "boolean"
|
|
42158
|
+
},
|
|
42159
|
+
"default": "false",
|
|
42160
|
+
"description": "Determines whether the radio is soft-disabled.",
|
|
42161
|
+
"fieldName": "softDisabled"
|
|
42162
|
+
},
|
|
42163
|
+
{
|
|
42164
|
+
"name": "disabled",
|
|
42165
|
+
"type": {
|
|
42166
|
+
"text": "boolean | undefined"
|
|
42167
|
+
},
|
|
42168
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
42169
|
+
"default": "undefined",
|
|
42170
|
+
"fieldName": "disabled",
|
|
42171
|
+
"inheritedFrom": {
|
|
42172
|
+
"name": "DisabledMixin",
|
|
42173
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
42174
|
+
}
|
|
42175
|
+
}
|
|
42176
|
+
],
|
|
42177
|
+
"mixins": [
|
|
42178
|
+
{
|
|
42179
|
+
"name": "DisabledMixin",
|
|
42180
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
|
42181
|
+
}
|
|
42182
|
+
],
|
|
42183
|
+
"superclass": {
|
|
42184
|
+
"name": "Component",
|
|
42185
|
+
"module": "/src/models"
|
|
42186
|
+
},
|
|
42187
|
+
"tagName": "mdc-staticradio",
|
|
42188
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 4 properties - checked, disabled, readonly and soft-disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n * @csspart radio-icon - The radio icon.\n *\n * @slot - Default slot for the label of the radio.\n */",
|
|
42189
|
+
"customElement": true
|
|
42190
|
+
}
|
|
42191
|
+
],
|
|
42192
|
+
"exports": [
|
|
42193
|
+
{
|
|
42194
|
+
"kind": "js",
|
|
42195
|
+
"name": "default",
|
|
42196
|
+
"declaration": {
|
|
42197
|
+
"name": "StaticRadio",
|
|
42198
|
+
"module": "components/staticradio/staticradio.component.js"
|
|
42199
|
+
}
|
|
42200
|
+
}
|
|
42201
|
+
]
|
|
42202
|
+
},
|
|
42203
42203
|
{
|
|
42204
42204
|
"kind": "javascript-module",
|
|
42205
42205
|
"path": "components/statictoggle/statictoggle.component.js",
|