@momentum-design/components 0.83.1 → 0.83.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +178 -178
- package/dist/browser/index.js.map +4 -4
- package/dist/components/dialog/dialog.component.d.ts +7 -2
- package/dist/components/dialog/dialog.component.js +28 -9
- package/dist/components/popover/popover.component.d.ts +19 -7
- package/dist/components/popover/popover.component.js +69 -24
- package/dist/components/popover/popover.constants.d.ts +1 -0
- package/dist/components/popover/popover.constants.js +1 -0
- package/dist/components/tooltip/tooltip.component.js +1 -1
- package/dist/custom-elements.json +1411 -1150
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/dist/utils/mixins/FocusTrapMixin.d.ts +2 -2
- package/dist/utils/mixins/FocusTrapMixin.js +78 -40
- package/dist/utils/mixins/PreventScrollMixin.d.ts +9 -0
- package/dist/utils/mixins/PreventScrollMixin.js +32 -0
- package/package.json +1 -1
@@ -2132,6 +2132,77 @@
|
|
2132
2132
|
}
|
2133
2133
|
]
|
2134
2134
|
},
|
2135
|
+
{
|
2136
|
+
"kind": "javascript-module",
|
2137
|
+
"path": "components/bullet/bullet.component.js",
|
2138
|
+
"declarations": [
|
2139
|
+
{
|
2140
|
+
"kind": "class",
|
2141
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2142
|
+
"name": "Bullet",
|
2143
|
+
"cssProperties": [
|
2144
|
+
{
|
2145
|
+
"description": "background color of the bullet",
|
2146
|
+
"name": "--mdc-bullet-background-color"
|
2147
|
+
},
|
2148
|
+
{
|
2149
|
+
"description": "small size value of the bullet",
|
2150
|
+
"name": "--mdc-bullet-size-small"
|
2151
|
+
},
|
2152
|
+
{
|
2153
|
+
"description": "medium size value of the bullet",
|
2154
|
+
"name": "--mdc-bullet-size-medium"
|
2155
|
+
},
|
2156
|
+
{
|
2157
|
+
"description": "large size value of the bullet",
|
2158
|
+
"name": "--mdc-bullet-size-large"
|
2159
|
+
}
|
2160
|
+
],
|
2161
|
+
"members": [
|
2162
|
+
{
|
2163
|
+
"kind": "field",
|
2164
|
+
"name": "size",
|
2165
|
+
"type": {
|
2166
|
+
"text": "Size"
|
2167
|
+
},
|
2168
|
+
"privacy": "public",
|
2169
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2170
|
+
"default": "small",
|
2171
|
+
"attribute": "size",
|
2172
|
+
"reflects": true
|
2173
|
+
}
|
2174
|
+
],
|
2175
|
+
"attributes": [
|
2176
|
+
{
|
2177
|
+
"name": "size",
|
2178
|
+
"type": {
|
2179
|
+
"text": "Size"
|
2180
|
+
},
|
2181
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2182
|
+
"default": "small",
|
2183
|
+
"fieldName": "size"
|
2184
|
+
}
|
2185
|
+
],
|
2186
|
+
"superclass": {
|
2187
|
+
"name": "Component",
|
2188
|
+
"module": "/src/models"
|
2189
|
+
},
|
2190
|
+
"tagName": "mdc-bullet",
|
2191
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
2192
|
+
"customElement": true
|
2193
|
+
}
|
2194
|
+
],
|
2195
|
+
"exports": [
|
2196
|
+
{
|
2197
|
+
"kind": "js",
|
2198
|
+
"name": "default",
|
2199
|
+
"declaration": {
|
2200
|
+
"name": "Bullet",
|
2201
|
+
"module": "components/bullet/bullet.component.js"
|
2202
|
+
}
|
2203
|
+
}
|
2204
|
+
]
|
2205
|
+
},
|
2135
2206
|
{
|
2136
2207
|
"kind": "javascript-module",
|
2137
2208
|
"path": "components/button/button.component.js",
|
@@ -2827,77 +2898,6 @@
|
|
2827
2898
|
}
|
2828
2899
|
]
|
2829
2900
|
},
|
2830
|
-
{
|
2831
|
-
"kind": "javascript-module",
|
2832
|
-
"path": "components/bullet/bullet.component.js",
|
2833
|
-
"declarations": [
|
2834
|
-
{
|
2835
|
-
"kind": "class",
|
2836
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2837
|
-
"name": "Bullet",
|
2838
|
-
"cssProperties": [
|
2839
|
-
{
|
2840
|
-
"description": "background color of the bullet",
|
2841
|
-
"name": "--mdc-bullet-background-color"
|
2842
|
-
},
|
2843
|
-
{
|
2844
|
-
"description": "small size value of the bullet",
|
2845
|
-
"name": "--mdc-bullet-size-small"
|
2846
|
-
},
|
2847
|
-
{
|
2848
|
-
"description": "medium size value of the bullet",
|
2849
|
-
"name": "--mdc-bullet-size-medium"
|
2850
|
-
},
|
2851
|
-
{
|
2852
|
-
"description": "large size value of the bullet",
|
2853
|
-
"name": "--mdc-bullet-size-large"
|
2854
|
-
}
|
2855
|
-
],
|
2856
|
-
"members": [
|
2857
|
-
{
|
2858
|
-
"kind": "field",
|
2859
|
-
"name": "size",
|
2860
|
-
"type": {
|
2861
|
-
"text": "Size"
|
2862
|
-
},
|
2863
|
-
"privacy": "public",
|
2864
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2865
|
-
"default": "small",
|
2866
|
-
"attribute": "size",
|
2867
|
-
"reflects": true
|
2868
|
-
}
|
2869
|
-
],
|
2870
|
-
"attributes": [
|
2871
|
-
{
|
2872
|
-
"name": "size",
|
2873
|
-
"type": {
|
2874
|
-
"text": "Size"
|
2875
|
-
},
|
2876
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2877
|
-
"default": "small",
|
2878
|
-
"fieldName": "size"
|
2879
|
-
}
|
2880
|
-
],
|
2881
|
-
"superclass": {
|
2882
|
-
"name": "Component",
|
2883
|
-
"module": "/src/models"
|
2884
|
-
},
|
2885
|
-
"tagName": "mdc-bullet",
|
2886
|
-
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
2887
|
-
"customElement": true
|
2888
|
-
}
|
2889
|
-
],
|
2890
|
-
"exports": [
|
2891
|
-
{
|
2892
|
-
"kind": "js",
|
2893
|
-
"name": "default",
|
2894
|
-
"declaration": {
|
2895
|
-
"name": "Bullet",
|
2896
|
-
"module": "components/bullet/bullet.component.js"
|
2897
|
-
}
|
2898
|
-
}
|
2899
|
-
]
|
2900
|
-
},
|
2901
2901
|
{
|
2902
2902
|
"kind": "javascript-module",
|
2903
2903
|
"path": "components/buttongroup/buttongroup.component.js",
|
@@ -6454,248 +6454,100 @@
|
|
6454
6454
|
},
|
6455
6455
|
{
|
6456
6456
|
"kind": "javascript-module",
|
6457
|
-
"path": "components/
|
6457
|
+
"path": "components/chip/chip.component.js",
|
6458
6458
|
"declarations": [
|
6459
6459
|
{
|
6460
6460
|
"kind": "class",
|
6461
|
-
"description": "
|
6462
|
-
"name": "
|
6461
|
+
"description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
|
6462
|
+
"name": "Chip",
|
6463
6463
|
"cssProperties": [
|
6464
6464
|
{
|
6465
|
-
"description": "
|
6466
|
-
"name": "--mdc-
|
6467
|
-
},
|
6468
|
-
{
|
6469
|
-
"description": "Background color for a selected checkbox when hovered.",
|
6470
|
-
"name": "--mdc-checkbox-checked-background-color-hover"
|
6471
|
-
},
|
6472
|
-
{
|
6473
|
-
"description": "Background color for a selected checkbox when pressed.",
|
6474
|
-
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
6465
|
+
"description": "The color of the chip.",
|
6466
|
+
"name": "--mdc-chip-color"
|
6475
6467
|
},
|
6476
6468
|
{
|
6477
|
-
"description": "
|
6478
|
-
"name": "--mdc-
|
6469
|
+
"description": "The border color of the chip.",
|
6470
|
+
"name": "--mdc-chip-border-color"
|
6479
6471
|
},
|
6480
6472
|
{
|
6481
|
-
"description": "
|
6482
|
-
"name": "--mdc-
|
6473
|
+
"description": "The background color of the chip.",
|
6474
|
+
"name": "--mdc-chip-background-color"
|
6483
6475
|
}
|
6484
6476
|
],
|
6485
6477
|
"members": [
|
6486
6478
|
{
|
6487
6479
|
"kind": "field",
|
6488
|
-
"name": "
|
6489
|
-
"type": {
|
6490
|
-
"text": "boolean"
|
6491
|
-
},
|
6492
|
-
"default": "false",
|
6493
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
6494
|
-
"attribute": "checked",
|
6495
|
-
"reflects": true
|
6496
|
-
},
|
6497
|
-
{
|
6498
|
-
"kind": "field",
|
6499
|
-
"name": "indeterminate",
|
6480
|
+
"name": "color",
|
6500
6481
|
"type": {
|
6501
|
-
"text": "
|
6482
|
+
"text": "ColorType"
|
6502
6483
|
},
|
6503
|
-
"
|
6504
|
-
"
|
6505
|
-
"attribute": "
|
6484
|
+
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
|
6485
|
+
"default": "default",
|
6486
|
+
"attribute": "color",
|
6506
6487
|
"reflects": true
|
6507
6488
|
},
|
6508
6489
|
{
|
6509
6490
|
"kind": "field",
|
6510
|
-
"name": "
|
6491
|
+
"name": "label",
|
6511
6492
|
"type": {
|
6512
|
-
"text": "
|
6513
|
-
},
|
6514
|
-
"default": "false",
|
6515
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
6516
|
-
"attribute": "autofocus",
|
6517
|
-
"reflects": true
|
6518
|
-
},
|
6519
|
-
{
|
6520
|
-
"kind": "method",
|
6521
|
-
"name": "setFormValue",
|
6522
|
-
"privacy": "private",
|
6523
|
-
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
6524
|
-
},
|
6525
|
-
{
|
6526
|
-
"kind": "method",
|
6527
|
-
"name": "manageRequired",
|
6528
|
-
"privacy": "private",
|
6529
|
-
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
|
6530
|
-
},
|
6531
|
-
{
|
6532
|
-
"kind": "method",
|
6533
|
-
"name": "toggleState",
|
6534
|
-
"privacy": "private",
|
6535
|
-
"return": {
|
6536
|
-
"type": {
|
6537
|
-
"text": "void"
|
6538
|
-
}
|
6493
|
+
"text": "string"
|
6539
6494
|
},
|
6540
|
-
"
|
6495
|
+
"default": "''",
|
6496
|
+
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
6497
|
+
"attribute": "label"
|
6541
6498
|
},
|
6542
6499
|
{
|
6543
6500
|
"kind": "method",
|
6544
|
-
"name": "
|
6501
|
+
"name": "renderIcon",
|
6545
6502
|
"privacy": "private",
|
6503
|
+
"description": "Renders the icon element if available.",
|
6546
6504
|
"return": {
|
6547
6505
|
"type": {
|
6548
|
-
"text": "
|
6549
|
-
}
|
6550
|
-
},
|
6551
|
-
"parameters": [
|
6552
|
-
{
|
6553
|
-
"name": "event",
|
6554
|
-
"type": {
|
6555
|
-
"text": "KeyboardEvent"
|
6556
|
-
},
|
6557
|
-
"description": "The keyboard event."
|
6558
|
-
}
|
6559
|
-
],
|
6560
|
-
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
6561
|
-
},
|
6562
|
-
{
|
6563
|
-
"kind": "method",
|
6564
|
-
"name": "handleChange",
|
6565
|
-
"privacy": "public",
|
6566
|
-
"return": {
|
6567
|
-
"type": {
|
6568
|
-
"text": "void"
|
6569
|
-
}
|
6570
|
-
},
|
6571
|
-
"parameters": [
|
6572
|
-
{
|
6573
|
-
"name": "event",
|
6574
|
-
"type": {
|
6575
|
-
"text": "Event"
|
6576
|
-
}
|
6506
|
+
"text": ""
|
6577
6507
|
}
|
6578
|
-
],
|
6579
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
6580
|
-
},
|
6581
|
-
{
|
6582
|
-
"kind": "field",
|
6583
|
-
"name": "renderLabelAndHelperText",
|
6584
|
-
"privacy": "private"
|
6585
|
-
},
|
6586
|
-
{
|
6587
|
-
"kind": "field",
|
6588
|
-
"name": "name",
|
6589
|
-
"type": {
|
6590
|
-
"text": "string"
|
6591
|
-
},
|
6592
|
-
"default": "''",
|
6593
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
6594
|
-
"attribute": "name",
|
6595
|
-
"reflects": true,
|
6596
|
-
"inheritedFrom": {
|
6597
|
-
"name": "FormInternalsMixin",
|
6598
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6599
6508
|
}
|
6600
6509
|
},
|
6601
6510
|
{
|
6602
6511
|
"kind": "field",
|
6603
|
-
"name": "
|
6512
|
+
"name": "iconName",
|
6604
6513
|
"type": {
|
6605
|
-
"text": "
|
6514
|
+
"text": "IconNames | undefined"
|
6606
6515
|
},
|
6607
|
-
"
|
6608
|
-
"
|
6609
|
-
"attribute": "value",
|
6610
|
-
"reflects": true,
|
6516
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
6517
|
+
"attribute": "icon-name",
|
6611
6518
|
"inheritedFrom": {
|
6612
|
-
"name": "
|
6613
|
-
"module": "utils/mixins/
|
6519
|
+
"name": "IconNameMixin",
|
6520
|
+
"module": "utils/mixins/IconNameMixin.js"
|
6614
6521
|
}
|
6615
6522
|
},
|
6616
6523
|
{
|
6617
6524
|
"kind": "field",
|
6618
|
-
"name": "
|
6525
|
+
"name": "autofocus",
|
6619
6526
|
"type": {
|
6620
|
-
"text": "
|
6527
|
+
"text": "boolean"
|
6621
6528
|
},
|
6622
|
-
"
|
6623
|
-
"
|
6529
|
+
"default": "false",
|
6530
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
6531
|
+
"attribute": "autofocus",
|
6624
6532
|
"reflects": true,
|
6625
6533
|
"inheritedFrom": {
|
6626
|
-
"name": "
|
6627
|
-
"module": "
|
6628
|
-
}
|
6629
|
-
},
|
6630
|
-
{
|
6631
|
-
"kind": "field",
|
6632
|
-
"name": "validity",
|
6633
|
-
"type": {
|
6634
|
-
"text": "ValidityState"
|
6635
|
-
},
|
6636
|
-
"readonly": true,
|
6637
|
-
"inheritedFrom": {
|
6638
|
-
"name": "FormInternalsMixin",
|
6639
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6640
|
-
}
|
6641
|
-
},
|
6642
|
-
{
|
6643
|
-
"kind": "field",
|
6644
|
-
"name": "willValidate",
|
6645
|
-
"readonly": true,
|
6646
|
-
"inheritedFrom": {
|
6647
|
-
"name": "FormInternalsMixin",
|
6648
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6649
|
-
}
|
6650
|
-
},
|
6651
|
-
{
|
6652
|
-
"kind": "method",
|
6653
|
-
"name": "setValidity",
|
6654
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
6655
|
-
"return": {
|
6656
|
-
"type": {
|
6657
|
-
"text": ""
|
6658
|
-
}
|
6659
|
-
},
|
6660
|
-
"inheritedFrom": {
|
6661
|
-
"name": "FormInternalsMixin",
|
6662
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6663
|
-
}
|
6664
|
-
},
|
6665
|
-
{
|
6666
|
-
"kind": "method",
|
6667
|
-
"name": "checkValidity",
|
6668
|
-
"return": {
|
6669
|
-
"type": {
|
6670
|
-
"text": "boolean"
|
6671
|
-
}
|
6672
|
-
},
|
6673
|
-
"inheritedFrom": {
|
6674
|
-
"name": "FormInternalsMixin",
|
6675
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6676
|
-
}
|
6677
|
-
},
|
6678
|
-
{
|
6679
|
-
"kind": "method",
|
6680
|
-
"name": "reportValidity",
|
6681
|
-
"inheritedFrom": {
|
6682
|
-
"name": "FormInternalsMixin",
|
6683
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6534
|
+
"name": "Buttonsimple",
|
6535
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6684
6536
|
}
|
6685
6537
|
},
|
6686
6538
|
{
|
6687
6539
|
"kind": "field",
|
6688
|
-
"name": "
|
6540
|
+
"name": "tabIndex",
|
6689
6541
|
"type": {
|
6690
|
-
"text": "
|
6542
|
+
"text": "number"
|
6691
6543
|
},
|
6692
|
-
"default": "
|
6693
|
-
"description": "
|
6694
|
-
"attribute": "
|
6544
|
+
"default": "0",
|
6545
|
+
"description": "This property specifies the tab order of the element.",
|
6546
|
+
"attribute": "tabIndex",
|
6695
6547
|
"reflects": true,
|
6696
6548
|
"inheritedFrom": {
|
6697
|
-
"name": "
|
6698
|
-
"module": "
|
6549
|
+
"name": "Buttonsimple",
|
6550
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6699
6551
|
}
|
6700
6552
|
},
|
6701
6553
|
{
|
@@ -6709,294 +6561,299 @@
|
|
6709
6561
|
"attribute": "disabled",
|
6710
6562
|
"reflects": true,
|
6711
6563
|
"inheritedFrom": {
|
6712
|
-
"name": "
|
6713
|
-
"module": "
|
6564
|
+
"name": "Buttonsimple",
|
6565
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6714
6566
|
}
|
6715
6567
|
},
|
6716
6568
|
{
|
6717
6569
|
"kind": "field",
|
6718
|
-
"name": "
|
6570
|
+
"name": "active",
|
6719
6571
|
"type": {
|
6720
|
-
"text": "
|
6572
|
+
"text": "boolean | undefined"
|
6721
6573
|
},
|
6722
|
-
"description": "The
|
6723
|
-
"
|
6574
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
6575
|
+
"default": "undefined",
|
6576
|
+
"attribute": "active",
|
6724
6577
|
"reflects": true,
|
6725
6578
|
"inheritedFrom": {
|
6726
|
-
"name": "
|
6727
|
-
"module": "components/
|
6579
|
+
"name": "Buttonsimple",
|
6580
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6728
6581
|
}
|
6729
6582
|
},
|
6730
6583
|
{
|
6731
6584
|
"kind": "field",
|
6732
|
-
"name": "
|
6585
|
+
"name": "softDisabled",
|
6733
6586
|
"type": {
|
6734
|
-
"text": "boolean"
|
6587
|
+
"text": "boolean | undefined"
|
6735
6588
|
},
|
6736
|
-
"
|
6737
|
-
"
|
6738
|
-
"attribute": "
|
6589
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
6590
|
+
"default": "undefined",
|
6591
|
+
"attribute": "soft-disabled",
|
6739
6592
|
"reflects": true,
|
6740
6593
|
"inheritedFrom": {
|
6741
|
-
"name": "
|
6742
|
-
"module": "components/
|
6743
|
-
}
|
6744
|
-
},
|
6745
|
-
{
|
6746
|
-
"kind": "field",
|
6747
|
-
"name": "id",
|
6748
|
-
"type": {
|
6749
|
-
"text": "string"
|
6750
|
-
},
|
6751
|
-
"default": "''",
|
6752
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
6753
|
-
"attribute": "id",
|
6754
|
-
"inheritedFrom": {
|
6755
|
-
"name": "FormfieldWrapper",
|
6756
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6594
|
+
"name": "Buttonsimple",
|
6595
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6757
6596
|
}
|
6758
6597
|
},
|
6759
6598
|
{
|
6760
6599
|
"kind": "field",
|
6761
|
-
"name": "
|
6600
|
+
"name": "size",
|
6762
6601
|
"type": {
|
6763
|
-
"text": "
|
6602
|
+
"text": "ButtonSize"
|
6764
6603
|
},
|
6765
|
-
"description": "
|
6766
|
-
"
|
6604
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
6605
|
+
"default": "32",
|
6606
|
+
"attribute": "size",
|
6767
6607
|
"reflects": true,
|
6768
6608
|
"inheritedFrom": {
|
6769
|
-
"name": "
|
6770
|
-
"module": "components/
|
6609
|
+
"name": "Buttonsimple",
|
6610
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6771
6611
|
}
|
6772
6612
|
},
|
6773
6613
|
{
|
6774
6614
|
"kind": "field",
|
6775
|
-
"name": "
|
6776
|
-
"
|
6777
|
-
|
6778
|
-
|
6779
|
-
"description": "The help text that is displayed below the input field.",
|
6780
|
-
"attribute": "help-text",
|
6615
|
+
"name": "role",
|
6616
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
6617
|
+
"default": "button",
|
6618
|
+
"attribute": "role",
|
6781
6619
|
"reflects": true,
|
6782
6620
|
"inheritedFrom": {
|
6783
|
-
"name": "
|
6784
|
-
"module": "components/
|
6621
|
+
"name": "Buttonsimple",
|
6622
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6785
6623
|
}
|
6786
6624
|
},
|
6787
6625
|
{
|
6788
6626
|
"kind": "field",
|
6789
|
-
"name": "
|
6627
|
+
"name": "ariaStateKey",
|
6790
6628
|
"type": {
|
6791
6629
|
"text": "string | undefined"
|
6792
6630
|
},
|
6793
|
-
"description": "
|
6794
|
-
"
|
6795
|
-
"
|
6796
|
-
"inheritedFrom": {
|
6797
|
-
"name": "FormfieldWrapper",
|
6798
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6799
|
-
}
|
6800
|
-
},
|
6801
|
-
{
|
6802
|
-
"kind": "field",
|
6803
|
-
"name": "toggletipPlacement",
|
6804
|
-
"type": {
|
6805
|
-
"text": "PopoverPlacement"
|
6806
|
-
},
|
6807
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
6808
|
-
"default": "'top'",
|
6809
|
-
"attribute": "toggletip-placement",
|
6631
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
6632
|
+
"default": "'aria-pressed' (when)",
|
6633
|
+
"attribute": "ariaStateKey",
|
6810
6634
|
"reflects": true,
|
6811
6635
|
"inheritedFrom": {
|
6812
|
-
"name": "
|
6813
|
-
"module": "components/
|
6636
|
+
"name": "Buttonsimple",
|
6637
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6814
6638
|
}
|
6815
6639
|
},
|
6816
6640
|
{
|
6817
6641
|
"kind": "field",
|
6818
|
-
"name": "
|
6642
|
+
"name": "type",
|
6819
6643
|
"type": {
|
6820
|
-
"text": "
|
6644
|
+
"text": "ButtonType"
|
6821
6645
|
},
|
6822
|
-
"description": "
|
6823
|
-
"
|
6646
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
6647
|
+
"default": "button",
|
6648
|
+
"attribute": "type",
|
6824
6649
|
"reflects": true,
|
6825
6650
|
"inheritedFrom": {
|
6826
|
-
"name": "
|
6827
|
-
"module": "components/
|
6651
|
+
"name": "Buttonsimple",
|
6652
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6828
6653
|
}
|
6829
6654
|
},
|
6830
6655
|
{
|
6831
6656
|
"kind": "method",
|
6832
|
-
"name": "
|
6657
|
+
"name": "executeAction",
|
6833
6658
|
"privacy": "protected",
|
6834
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
6835
|
-
"return": {
|
6836
|
-
"type": {
|
6837
|
-
"text": ""
|
6838
|
-
}
|
6839
|
-
},
|
6840
6659
|
"inheritedFrom": {
|
6841
|
-
"name": "
|
6842
|
-
"module": "components/
|
6660
|
+
"name": "Buttonsimple",
|
6661
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6843
6662
|
}
|
6844
6663
|
},
|
6845
6664
|
{
|
6846
6665
|
"kind": "method",
|
6847
|
-
"name": "
|
6666
|
+
"name": "setActive",
|
6848
6667
|
"privacy": "protected",
|
6849
|
-
"
|
6850
|
-
|
6851
|
-
|
6852
|
-
"
|
6853
|
-
|
6854
|
-
|
6855
|
-
|
6856
|
-
|
6857
|
-
|
6858
|
-
|
6859
|
-
|
6860
|
-
|
6861
|
-
|
6862
|
-
|
6863
|
-
|
6864
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
6865
|
-
"return": {
|
6866
|
-
"type": {
|
6867
|
-
"text": ""
|
6668
|
+
"parameters": [
|
6669
|
+
{
|
6670
|
+
"name": "element",
|
6671
|
+
"type": {
|
6672
|
+
"text": "HTMLElement"
|
6673
|
+
},
|
6674
|
+
"description": "The button element"
|
6675
|
+
},
|
6676
|
+
{
|
6677
|
+
"name": "active",
|
6678
|
+
"optional": true,
|
6679
|
+
"type": {
|
6680
|
+
"text": "boolean"
|
6681
|
+
},
|
6682
|
+
"description": "The active state of the element"
|
6868
6683
|
}
|
6869
|
-
|
6684
|
+
],
|
6685
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
6870
6686
|
"inheritedFrom": {
|
6871
|
-
"name": "
|
6872
|
-
"module": "components/
|
6687
|
+
"name": "Buttonsimple",
|
6688
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6873
6689
|
}
|
6874
6690
|
},
|
6875
6691
|
{
|
6876
6692
|
"kind": "method",
|
6877
|
-
"name": "
|
6878
|
-
"privacy": "
|
6879
|
-
"
|
6880
|
-
|
6881
|
-
|
6882
|
-
"
|
6693
|
+
"name": "setSoftDisabled",
|
6694
|
+
"privacy": "private",
|
6695
|
+
"parameters": [
|
6696
|
+
{
|
6697
|
+
"name": "element",
|
6698
|
+
"type": {
|
6699
|
+
"text": "HTMLElement"
|
6700
|
+
},
|
6701
|
+
"description": "The button element."
|
6702
|
+
},
|
6703
|
+
{
|
6704
|
+
"name": "softDisabled",
|
6705
|
+
"optional": true,
|
6706
|
+
"type": {
|
6707
|
+
"text": "boolean"
|
6708
|
+
},
|
6709
|
+
"description": "The soft-disabled state."
|
6883
6710
|
}
|
6884
|
-
|
6711
|
+
],
|
6712
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
6885
6713
|
"inheritedFrom": {
|
6886
|
-
"name": "
|
6887
|
-
"module": "components/
|
6714
|
+
"name": "Buttonsimple",
|
6715
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6888
6716
|
}
|
6889
6717
|
},
|
6890
6718
|
{
|
6891
6719
|
"kind": "method",
|
6892
|
-
"name": "
|
6893
|
-
"privacy": "
|
6894
|
-
"
|
6895
|
-
|
6896
|
-
|
6897
|
-
"
|
6720
|
+
"name": "setDisabled",
|
6721
|
+
"privacy": "private",
|
6722
|
+
"parameters": [
|
6723
|
+
{
|
6724
|
+
"name": "element",
|
6725
|
+
"type": {
|
6726
|
+
"text": "HTMLElement"
|
6727
|
+
},
|
6728
|
+
"description": "The button element."
|
6729
|
+
},
|
6730
|
+
{
|
6731
|
+
"name": "disabled",
|
6732
|
+
"type": {
|
6733
|
+
"text": "boolean"
|
6734
|
+
},
|
6735
|
+
"description": "The disabled state."
|
6898
6736
|
}
|
6899
|
-
|
6737
|
+
],
|
6738
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
6900
6739
|
"inheritedFrom": {
|
6901
|
-
"name": "
|
6902
|
-
"module": "components/
|
6740
|
+
"name": "Buttonsimple",
|
6741
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6903
6742
|
}
|
6904
|
-
}
|
6905
|
-
],
|
6906
|
-
"events": [
|
6743
|
+
},
|
6907
6744
|
{
|
6908
|
-
"
|
6909
|
-
|
6745
|
+
"kind": "method",
|
6746
|
+
"name": "triggerClickEvent",
|
6747
|
+
"privacy": "private",
|
6748
|
+
"inheritedFrom": {
|
6749
|
+
"name": "Buttonsimple",
|
6750
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6910
6751
|
}
|
6911
6752
|
},
|
6912
6753
|
{
|
6913
|
-
"
|
6914
|
-
"name": "
|
6915
|
-
"
|
6754
|
+
"kind": "method",
|
6755
|
+
"name": "handleBlur",
|
6756
|
+
"privacy": "private",
|
6757
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
6758
|
+
"inheritedFrom": {
|
6759
|
+
"name": "Buttonsimple",
|
6760
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6761
|
+
}
|
6916
6762
|
},
|
6917
6763
|
{
|
6918
|
-
"
|
6919
|
-
"name": "
|
6920
|
-
"
|
6764
|
+
"kind": "method",
|
6765
|
+
"name": "handleKeyDown",
|
6766
|
+
"privacy": "private",
|
6767
|
+
"parameters": [
|
6768
|
+
{
|
6769
|
+
"name": "event",
|
6770
|
+
"type": {
|
6771
|
+
"text": "KeyboardEvent"
|
6772
|
+
},
|
6773
|
+
"description": "The keyboard event."
|
6774
|
+
}
|
6775
|
+
],
|
6776
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
6777
|
+
"inheritedFrom": {
|
6778
|
+
"name": "Buttonsimple",
|
6779
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6780
|
+
}
|
6781
|
+
},
|
6782
|
+
{
|
6783
|
+
"kind": "method",
|
6784
|
+
"name": "handleKeyUp",
|
6785
|
+
"privacy": "private",
|
6786
|
+
"parameters": [
|
6787
|
+
{
|
6788
|
+
"name": "event",
|
6789
|
+
"type": {
|
6790
|
+
"text": "KeyboardEvent"
|
6791
|
+
},
|
6792
|
+
"description": "The keyboard event."
|
6793
|
+
}
|
6794
|
+
],
|
6795
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
6796
|
+
"inheritedFrom": {
|
6797
|
+
"name": "Buttonsimple",
|
6798
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
6799
|
+
}
|
6921
6800
|
}
|
6922
6801
|
],
|
6923
6802
|
"attributes": [
|
6924
6803
|
{
|
6925
|
-
"name": "
|
6926
|
-
"type": {
|
6927
|
-
"text": "boolean"
|
6928
|
-
},
|
6929
|
-
"default": "false",
|
6930
|
-
"description": "Determines whether the checkbox is selected or unselected.",
|
6931
|
-
"fieldName": "checked"
|
6932
|
-
},
|
6933
|
-
{
|
6934
|
-
"name": "indeterminate",
|
6935
|
-
"type": {
|
6936
|
-
"text": "boolean"
|
6937
|
-
},
|
6938
|
-
"default": "false",
|
6939
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
6940
|
-
"fieldName": "indeterminate"
|
6941
|
-
},
|
6942
|
-
{
|
6943
|
-
"name": "autofocus",
|
6804
|
+
"name": "color",
|
6944
6805
|
"type": {
|
6945
|
-
"text": "
|
6806
|
+
"text": "ColorType"
|
6946
6807
|
},
|
6947
|
-
"
|
6948
|
-
"
|
6949
|
-
"fieldName": "
|
6808
|
+
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
|
6809
|
+
"default": "default",
|
6810
|
+
"fieldName": "color"
|
6950
6811
|
},
|
6951
6812
|
{
|
6952
|
-
"name": "
|
6813
|
+
"name": "label",
|
6953
6814
|
"type": {
|
6954
6815
|
"text": "string"
|
6955
6816
|
},
|
6956
6817
|
"default": "''",
|
6957
|
-
"description": "
|
6958
|
-
"fieldName": "
|
6959
|
-
"inheritedFrom": {
|
6960
|
-
"name": "FormInternalsMixin",
|
6961
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6962
|
-
}
|
6818
|
+
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
6819
|
+
"fieldName": "label"
|
6963
6820
|
},
|
6964
6821
|
{
|
6965
|
-
"name": "
|
6822
|
+
"name": "icon-name",
|
6966
6823
|
"type": {
|
6967
|
-
"text": "
|
6824
|
+
"text": "IconNames | undefined"
|
6968
6825
|
},
|
6969
|
-
"
|
6970
|
-
"
|
6971
|
-
"fieldName": "value",
|
6826
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
6827
|
+
"fieldName": "iconName",
|
6972
6828
|
"inheritedFrom": {
|
6973
|
-
"name": "
|
6974
|
-
"module": "src/utils/mixins/
|
6829
|
+
"name": "IconNameMixin",
|
6830
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
6975
6831
|
}
|
6976
6832
|
},
|
6977
6833
|
{
|
6978
|
-
"name": "
|
6834
|
+
"name": "autofocus",
|
6979
6835
|
"type": {
|
6980
|
-
"text": "
|
6836
|
+
"text": "boolean"
|
6981
6837
|
},
|
6982
|
-
"
|
6983
|
-
"
|
6838
|
+
"default": "false",
|
6839
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
6840
|
+
"fieldName": "autofocus",
|
6984
6841
|
"inheritedFrom": {
|
6985
|
-
"name": "
|
6986
|
-
"module": "src/
|
6842
|
+
"name": "Buttonsimple",
|
6843
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6987
6844
|
}
|
6988
6845
|
},
|
6989
6846
|
{
|
6990
|
-
"name": "
|
6847
|
+
"name": "tabIndex",
|
6991
6848
|
"type": {
|
6992
|
-
"text": "
|
6849
|
+
"text": "number"
|
6993
6850
|
},
|
6994
|
-
"default": "
|
6995
|
-
"description": "
|
6996
|
-
"fieldName": "
|
6851
|
+
"default": "0",
|
6852
|
+
"description": "This property specifies the tab order of the element.",
|
6853
|
+
"fieldName": "tabIndex",
|
6997
6854
|
"inheritedFrom": {
|
6998
|
-
"name": "
|
6999
|
-
"module": "src/
|
6855
|
+
"name": "Buttonsimple",
|
6856
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7000
6857
|
}
|
7001
6858
|
},
|
7002
6859
|
{
|
@@ -7008,127 +6865,137 @@
|
|
7008
6865
|
"default": "undefined",
|
7009
6866
|
"fieldName": "disabled",
|
7010
6867
|
"inheritedFrom": {
|
7011
|
-
"name": "
|
7012
|
-
"module": "src/
|
6868
|
+
"name": "Buttonsimple",
|
6869
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7013
6870
|
}
|
7014
6871
|
},
|
7015
6872
|
{
|
7016
|
-
"name": "
|
6873
|
+
"name": "active",
|
7017
6874
|
"type": {
|
7018
|
-
"text": "
|
6875
|
+
"text": "boolean | undefined"
|
7019
6876
|
},
|
7020
|
-
"description": "The
|
7021
|
-
"
|
6877
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
6878
|
+
"default": "undefined",
|
6879
|
+
"fieldName": "active",
|
7022
6880
|
"inheritedFrom": {
|
7023
|
-
"name": "
|
7024
|
-
"module": "src/components/
|
6881
|
+
"name": "Buttonsimple",
|
6882
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7025
6883
|
}
|
7026
6884
|
},
|
7027
6885
|
{
|
7028
|
-
"name": "
|
6886
|
+
"name": "soft-disabled",
|
7029
6887
|
"type": {
|
7030
|
-
"text": "boolean"
|
6888
|
+
"text": "boolean | undefined"
|
7031
6889
|
},
|
7032
|
-
"
|
7033
|
-
"
|
7034
|
-
"fieldName": "
|
6890
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
6891
|
+
"default": "undefined",
|
6892
|
+
"fieldName": "softDisabled",
|
7035
6893
|
"inheritedFrom": {
|
7036
|
-
"name": "
|
7037
|
-
"module": "src/components/
|
6894
|
+
"name": "Buttonsimple",
|
6895
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7038
6896
|
}
|
7039
6897
|
},
|
7040
6898
|
{
|
7041
|
-
"name": "
|
6899
|
+
"name": "size",
|
7042
6900
|
"type": {
|
7043
|
-
"text": "
|
6901
|
+
"text": "ButtonSize"
|
7044
6902
|
},
|
7045
|
-
"
|
7046
|
-
"
|
7047
|
-
"fieldName": "
|
6903
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
6904
|
+
"default": "32",
|
6905
|
+
"fieldName": "size",
|
7048
6906
|
"inheritedFrom": {
|
7049
|
-
"name": "
|
7050
|
-
"module": "src/components/
|
6907
|
+
"name": "Buttonsimple",
|
6908
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7051
6909
|
}
|
7052
6910
|
},
|
7053
6911
|
{
|
7054
|
-
"name": "
|
7055
|
-
"
|
7056
|
-
|
7057
|
-
|
7058
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7059
|
-
"fieldName": "helpTextType",
|
6912
|
+
"name": "role",
|
6913
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
6914
|
+
"default": "button",
|
6915
|
+
"fieldName": "role",
|
7060
6916
|
"inheritedFrom": {
|
7061
|
-
"name": "
|
7062
|
-
"module": "src/components/
|
6917
|
+
"name": "Buttonsimple",
|
6918
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7063
6919
|
}
|
7064
6920
|
},
|
7065
6921
|
{
|
7066
|
-
"name": "
|
6922
|
+
"name": "ariaStateKey",
|
7067
6923
|
"type": {
|
7068
6924
|
"text": "string | undefined"
|
7069
6925
|
},
|
7070
|
-
"description": "
|
7071
|
-
"
|
6926
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
6927
|
+
"default": "'aria-pressed' (when)",
|
6928
|
+
"fieldName": "ariaStateKey",
|
7072
6929
|
"inheritedFrom": {
|
7073
|
-
"name": "
|
7074
|
-
"module": "src/components/
|
6930
|
+
"name": "Buttonsimple",
|
6931
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7075
6932
|
}
|
7076
6933
|
},
|
7077
6934
|
{
|
7078
|
-
"name": "
|
6935
|
+
"name": "type",
|
7079
6936
|
"type": {
|
7080
|
-
"text": "
|
6937
|
+
"text": "ButtonType"
|
7081
6938
|
},
|
7082
|
-
"description": "
|
7083
|
-
"
|
6939
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
6940
|
+
"default": "button",
|
6941
|
+
"fieldName": "type",
|
7084
6942
|
"inheritedFrom": {
|
7085
|
-
"name": "
|
7086
|
-
"module": "src/components/
|
6943
|
+
"name": "Buttonsimple",
|
6944
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7087
6945
|
}
|
7088
|
-
}
|
6946
|
+
}
|
6947
|
+
],
|
6948
|
+
"mixins": [
|
7089
6949
|
{
|
7090
|
-
"name": "
|
7091
|
-
"
|
7092
|
-
|
7093
|
-
|
7094
|
-
|
7095
|
-
|
7096
|
-
|
6950
|
+
"name": "IconNameMixin",
|
6951
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
6952
|
+
}
|
6953
|
+
],
|
6954
|
+
"superclass": {
|
6955
|
+
"name": "Buttonsimple",
|
6956
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
6957
|
+
},
|
6958
|
+
"tagName": "mdc-chip",
|
6959
|
+
"jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
6960
|
+
"customElement": true,
|
6961
|
+
"events": [
|
6962
|
+
{
|
6963
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
6964
|
+
"name": "click",
|
6965
|
+
"reactName": "onClick",
|
7097
6966
|
"inheritedFrom": {
|
7098
|
-
"name": "
|
7099
|
-
"module": "src/components/
|
6967
|
+
"name": "Buttonsimple",
|
6968
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7100
6969
|
}
|
7101
6970
|
},
|
7102
6971
|
{
|
7103
|
-
"
|
7104
|
-
"
|
7105
|
-
|
7106
|
-
},
|
7107
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
7108
|
-
"fieldName": "infoIconAriaLabel",
|
6972
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
6973
|
+
"name": "keydown",
|
6974
|
+
"reactName": "onKeyDown",
|
7109
6975
|
"inheritedFrom": {
|
7110
|
-
"name": "
|
7111
|
-
"module": "src/components/
|
6976
|
+
"name": "Buttonsimple",
|
6977
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7112
6978
|
}
|
7113
|
-
}
|
7114
|
-
],
|
7115
|
-
"mixins": [
|
6979
|
+
},
|
7116
6980
|
{
|
7117
|
-
"
|
7118
|
-
"
|
6981
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
6982
|
+
"name": "keyup",
|
6983
|
+
"reactName": "onKeyUp",
|
6984
|
+
"inheritedFrom": {
|
6985
|
+
"name": "Buttonsimple",
|
6986
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6987
|
+
}
|
7119
6988
|
},
|
7120
6989
|
{
|
7121
|
-
"
|
7122
|
-
"
|
6990
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
6991
|
+
"name": "focus",
|
6992
|
+
"reactName": "onFocus",
|
6993
|
+
"inheritedFrom": {
|
6994
|
+
"name": "Buttonsimple",
|
6995
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
6996
|
+
}
|
7123
6997
|
}
|
7124
|
-
]
|
7125
|
-
"superclass": {
|
7126
|
-
"name": "FormfieldWrapper",
|
7127
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
7128
|
-
},
|
7129
|
-
"tagName": "mdc-checkbox",
|
7130
|
-
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
7131
|
-
"customElement": true
|
6998
|
+
]
|
7132
6999
|
}
|
7133
7000
|
],
|
7134
7001
|
"exports": [
|
@@ -7136,108 +7003,256 @@
|
|
7136
7003
|
"kind": "js",
|
7137
7004
|
"name": "default",
|
7138
7005
|
"declaration": {
|
7139
|
-
"name": "
|
7140
|
-
"module": "components/
|
7006
|
+
"name": "Chip",
|
7007
|
+
"module": "components/chip/chip.component.js"
|
7141
7008
|
}
|
7142
7009
|
}
|
7143
7010
|
]
|
7144
7011
|
},
|
7145
7012
|
{
|
7146
7013
|
"kind": "javascript-module",
|
7147
|
-
"path": "components/
|
7014
|
+
"path": "components/checkbox/checkbox.component.js",
|
7148
7015
|
"declarations": [
|
7149
7016
|
{
|
7150
7017
|
"kind": "class",
|
7151
|
-
"description": "
|
7152
|
-
"name": "
|
7018
|
+
"description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
|
7019
|
+
"name": "Checkbox",
|
7153
7020
|
"cssProperties": [
|
7154
7021
|
{
|
7155
|
-
"description": "
|
7156
|
-
"name": "--mdc-
|
7022
|
+
"description": "Allows customization of the background color on hover.",
|
7023
|
+
"name": "--mdc-checkbox-background-color-hover"
|
7157
7024
|
},
|
7158
7025
|
{
|
7159
|
-
"description": "
|
7160
|
-
"name": "--mdc-
|
7026
|
+
"description": "Background color for a selected checkbox when hovered.",
|
7027
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
7161
7028
|
},
|
7162
7029
|
{
|
7163
|
-
"description": "
|
7164
|
-
"name": "--mdc-
|
7030
|
+
"description": "Background color for a selected checkbox when pressed.",
|
7031
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
7032
|
+
},
|
7033
|
+
{
|
7034
|
+
"description": "Background color for a selected checkbox when pressed.",
|
7035
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
7036
|
+
},
|
7037
|
+
{
|
7038
|
+
"description": "Background color for a selected checkbox when disabled.",
|
7039
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
7165
7040
|
}
|
7166
7041
|
],
|
7167
7042
|
"members": [
|
7168
7043
|
{
|
7169
7044
|
"kind": "field",
|
7170
|
-
"name": "
|
7045
|
+
"name": "checked",
|
7171
7046
|
"type": {
|
7172
|
-
"text": "
|
7047
|
+
"text": "boolean"
|
7173
7048
|
},
|
7174
|
-
"
|
7175
|
-
"
|
7176
|
-
"attribute": "
|
7049
|
+
"default": "false",
|
7050
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
7051
|
+
"attribute": "checked",
|
7177
7052
|
"reflects": true
|
7178
7053
|
},
|
7179
7054
|
{
|
7180
7055
|
"kind": "field",
|
7181
|
-
"name": "
|
7056
|
+
"name": "indeterminate",
|
7182
7057
|
"type": {
|
7183
|
-
"text": "
|
7058
|
+
"text": "boolean"
|
7184
7059
|
},
|
7185
|
-
"default": "
|
7186
|
-
"description": "
|
7187
|
-
"attribute": "
|
7060
|
+
"default": "false",
|
7061
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
7062
|
+
"attribute": "indeterminate",
|
7063
|
+
"reflects": true
|
7064
|
+
},
|
7065
|
+
{
|
7066
|
+
"kind": "field",
|
7067
|
+
"name": "autofocus",
|
7068
|
+
"type": {
|
7069
|
+
"text": "boolean"
|
7070
|
+
},
|
7071
|
+
"default": "false",
|
7072
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
7073
|
+
"attribute": "autofocus",
|
7074
|
+
"reflects": true
|
7188
7075
|
},
|
7189
7076
|
{
|
7190
7077
|
"kind": "method",
|
7191
|
-
"name": "
|
7078
|
+
"name": "setFormValue",
|
7079
|
+
"privacy": "private",
|
7080
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
7081
|
+
},
|
7082
|
+
{
|
7083
|
+
"kind": "method",
|
7084
|
+
"name": "manageRequired",
|
7085
|
+
"privacy": "private",
|
7086
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
|
7087
|
+
},
|
7088
|
+
{
|
7089
|
+
"kind": "method",
|
7090
|
+
"name": "toggleState",
|
7192
7091
|
"privacy": "private",
|
7193
|
-
"description": "Renders the icon element if available.",
|
7194
7092
|
"return": {
|
7195
7093
|
"type": {
|
7196
|
-
"text": ""
|
7094
|
+
"text": "void"
|
7095
|
+
}
|
7096
|
+
},
|
7097
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
7098
|
+
},
|
7099
|
+
{
|
7100
|
+
"kind": "method",
|
7101
|
+
"name": "handleKeyDown",
|
7102
|
+
"privacy": "private",
|
7103
|
+
"return": {
|
7104
|
+
"type": {
|
7105
|
+
"text": "void"
|
7106
|
+
}
|
7107
|
+
},
|
7108
|
+
"parameters": [
|
7109
|
+
{
|
7110
|
+
"name": "event",
|
7111
|
+
"type": {
|
7112
|
+
"text": "KeyboardEvent"
|
7113
|
+
},
|
7114
|
+
"description": "The keyboard event."
|
7115
|
+
}
|
7116
|
+
],
|
7117
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
7118
|
+
},
|
7119
|
+
{
|
7120
|
+
"kind": "method",
|
7121
|
+
"name": "handleChange",
|
7122
|
+
"privacy": "public",
|
7123
|
+
"return": {
|
7124
|
+
"type": {
|
7125
|
+
"text": "void"
|
7197
7126
|
}
|
7127
|
+
},
|
7128
|
+
"parameters": [
|
7129
|
+
{
|
7130
|
+
"name": "event",
|
7131
|
+
"type": {
|
7132
|
+
"text": "Event"
|
7133
|
+
}
|
7134
|
+
}
|
7135
|
+
],
|
7136
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
7137
|
+
},
|
7138
|
+
{
|
7139
|
+
"kind": "field",
|
7140
|
+
"name": "renderLabelAndHelperText",
|
7141
|
+
"privacy": "private"
|
7142
|
+
},
|
7143
|
+
{
|
7144
|
+
"kind": "field",
|
7145
|
+
"name": "name",
|
7146
|
+
"type": {
|
7147
|
+
"text": "string"
|
7148
|
+
},
|
7149
|
+
"default": "''",
|
7150
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7151
|
+
"attribute": "name",
|
7152
|
+
"reflects": true,
|
7153
|
+
"inheritedFrom": {
|
7154
|
+
"name": "FormInternalsMixin",
|
7155
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7198
7156
|
}
|
7199
7157
|
},
|
7200
7158
|
{
|
7201
7159
|
"kind": "field",
|
7202
|
-
"name": "
|
7160
|
+
"name": "value",
|
7203
7161
|
"type": {
|
7204
|
-
"text": "
|
7162
|
+
"text": "string"
|
7205
7163
|
},
|
7206
|
-
"
|
7207
|
-
"
|
7164
|
+
"default": "''",
|
7165
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7166
|
+
"attribute": "value",
|
7167
|
+
"reflects": true,
|
7208
7168
|
"inheritedFrom": {
|
7209
|
-
"name": "
|
7210
|
-
"module": "utils/mixins/
|
7169
|
+
"name": "FormInternalsMixin",
|
7170
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7211
7171
|
}
|
7212
7172
|
},
|
7213
7173
|
{
|
7214
7174
|
"kind": "field",
|
7215
|
-
"name": "
|
7175
|
+
"name": "validationMessage",
|
7216
7176
|
"type": {
|
7217
|
-
"text": "
|
7177
|
+
"text": "string | undefined"
|
7218
7178
|
},
|
7219
|
-
"
|
7220
|
-
"
|
7221
|
-
"attribute": "autofocus",
|
7179
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
7180
|
+
"attribute": "validation-message",
|
7222
7181
|
"reflects": true,
|
7223
7182
|
"inheritedFrom": {
|
7224
|
-
"name": "
|
7225
|
-
"module": "
|
7183
|
+
"name": "FormInternalsMixin",
|
7184
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7226
7185
|
}
|
7227
7186
|
},
|
7228
7187
|
{
|
7229
7188
|
"kind": "field",
|
7230
|
-
"name": "
|
7189
|
+
"name": "validity",
|
7231
7190
|
"type": {
|
7232
|
-
"text": "
|
7191
|
+
"text": "ValidityState"
|
7233
7192
|
},
|
7234
|
-
"
|
7235
|
-
"
|
7236
|
-
|
7193
|
+
"readonly": true,
|
7194
|
+
"inheritedFrom": {
|
7195
|
+
"name": "FormInternalsMixin",
|
7196
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7197
|
+
}
|
7198
|
+
},
|
7199
|
+
{
|
7200
|
+
"kind": "field",
|
7201
|
+
"name": "willValidate",
|
7202
|
+
"readonly": true,
|
7203
|
+
"inheritedFrom": {
|
7204
|
+
"name": "FormInternalsMixin",
|
7205
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7206
|
+
}
|
7207
|
+
},
|
7208
|
+
{
|
7209
|
+
"kind": "method",
|
7210
|
+
"name": "setValidity",
|
7211
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
7212
|
+
"return": {
|
7213
|
+
"type": {
|
7214
|
+
"text": ""
|
7215
|
+
}
|
7216
|
+
},
|
7217
|
+
"inheritedFrom": {
|
7218
|
+
"name": "FormInternalsMixin",
|
7219
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7220
|
+
}
|
7221
|
+
},
|
7222
|
+
{
|
7223
|
+
"kind": "method",
|
7224
|
+
"name": "checkValidity",
|
7225
|
+
"return": {
|
7226
|
+
"type": {
|
7227
|
+
"text": "boolean"
|
7228
|
+
}
|
7229
|
+
},
|
7230
|
+
"inheritedFrom": {
|
7231
|
+
"name": "FormInternalsMixin",
|
7232
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7233
|
+
}
|
7234
|
+
},
|
7235
|
+
{
|
7236
|
+
"kind": "method",
|
7237
|
+
"name": "reportValidity",
|
7238
|
+
"inheritedFrom": {
|
7239
|
+
"name": "FormInternalsMixin",
|
7240
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7241
|
+
}
|
7242
|
+
},
|
7243
|
+
{
|
7244
|
+
"kind": "field",
|
7245
|
+
"name": "dataAriaLabel",
|
7246
|
+
"type": {
|
7247
|
+
"text": "string | null"
|
7248
|
+
},
|
7249
|
+
"default": "null",
|
7250
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7251
|
+
"attribute": "data-aria-label",
|
7237
7252
|
"reflects": true,
|
7238
7253
|
"inheritedFrom": {
|
7239
|
-
"name": "
|
7240
|
-
"module": "
|
7254
|
+
"name": "DataAriaLabelMixin",
|
7255
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
7241
7256
|
}
|
7242
7257
|
},
|
7243
7258
|
{
|
@@ -7251,299 +7266,294 @@
|
|
7251
7266
|
"attribute": "disabled",
|
7252
7267
|
"reflects": true,
|
7253
7268
|
"inheritedFrom": {
|
7254
|
-
"name": "
|
7255
|
-
"module": "
|
7269
|
+
"name": "DisabledMixin",
|
7270
|
+
"module": "utils/mixins/DisabledMixin.js"
|
7256
7271
|
}
|
7257
7272
|
},
|
7258
7273
|
{
|
7259
7274
|
"kind": "field",
|
7260
|
-
"name": "
|
7275
|
+
"name": "label",
|
7261
7276
|
"type": {
|
7262
|
-
"text": "
|
7277
|
+
"text": "string | undefined"
|
7263
7278
|
},
|
7264
|
-
"description": "The
|
7265
|
-
"
|
7266
|
-
"attribute": "active",
|
7279
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7280
|
+
"attribute": "label",
|
7267
7281
|
"reflects": true,
|
7268
7282
|
"inheritedFrom": {
|
7269
|
-
"name": "
|
7270
|
-
"module": "components/
|
7283
|
+
"name": "FormfieldWrapper",
|
7284
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7271
7285
|
}
|
7272
7286
|
},
|
7273
7287
|
{
|
7274
7288
|
"kind": "field",
|
7275
|
-
"name": "
|
7289
|
+
"name": "required",
|
7276
7290
|
"type": {
|
7277
|
-
"text": "boolean
|
7291
|
+
"text": "boolean"
|
7278
7292
|
},
|
7279
|
-
"
|
7280
|
-
"
|
7281
|
-
"attribute": "
|
7293
|
+
"default": "false",
|
7294
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
7295
|
+
"attribute": "required",
|
7282
7296
|
"reflects": true,
|
7283
7297
|
"inheritedFrom": {
|
7284
|
-
"name": "
|
7285
|
-
"module": "components/
|
7298
|
+
"name": "FormfieldWrapper",
|
7299
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7286
7300
|
}
|
7287
7301
|
},
|
7288
7302
|
{
|
7289
7303
|
"kind": "field",
|
7290
|
-
"name": "
|
7304
|
+
"name": "id",
|
7291
7305
|
"type": {
|
7292
|
-
"text": "
|
7306
|
+
"text": "string"
|
7293
7307
|
},
|
7294
|
-
"
|
7295
|
-
"
|
7296
|
-
"attribute": "
|
7297
|
-
"reflects": true,
|
7308
|
+
"default": "''",
|
7309
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7310
|
+
"attribute": "id",
|
7298
7311
|
"inheritedFrom": {
|
7299
|
-
"name": "
|
7300
|
-
"module": "components/
|
7312
|
+
"name": "FormfieldWrapper",
|
7313
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7301
7314
|
}
|
7302
7315
|
},
|
7303
7316
|
{
|
7304
7317
|
"kind": "field",
|
7305
|
-
"name": "
|
7306
|
-
"
|
7307
|
-
|
7308
|
-
|
7318
|
+
"name": "helpTextType",
|
7319
|
+
"type": {
|
7320
|
+
"text": "ValidationType"
|
7321
|
+
},
|
7322
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7323
|
+
"attribute": "help-text-type",
|
7309
7324
|
"reflects": true,
|
7310
7325
|
"inheritedFrom": {
|
7311
|
-
"name": "
|
7312
|
-
"module": "components/
|
7326
|
+
"name": "FormfieldWrapper",
|
7327
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7313
7328
|
}
|
7314
7329
|
},
|
7315
7330
|
{
|
7316
7331
|
"kind": "field",
|
7317
|
-
"name": "
|
7332
|
+
"name": "helpText",
|
7318
7333
|
"type": {
|
7319
7334
|
"text": "string | undefined"
|
7320
7335
|
},
|
7321
|
-
"description": "
|
7322
|
-
"
|
7323
|
-
"attribute": "ariaStateKey",
|
7336
|
+
"description": "The help text that is displayed below the input field.",
|
7337
|
+
"attribute": "help-text",
|
7324
7338
|
"reflects": true,
|
7325
7339
|
"inheritedFrom": {
|
7326
|
-
"name": "
|
7327
|
-
"module": "components/
|
7340
|
+
"name": "FormfieldWrapper",
|
7341
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7328
7342
|
}
|
7329
7343
|
},
|
7330
7344
|
{
|
7331
7345
|
"kind": "field",
|
7332
|
-
"name": "
|
7346
|
+
"name": "toggletipText",
|
7333
7347
|
"type": {
|
7334
|
-
"text": "
|
7348
|
+
"text": "string | undefined"
|
7335
7349
|
},
|
7336
|
-
"description": "
|
7337
|
-
"
|
7338
|
-
"attribute": "type",
|
7350
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
7351
|
+
"attribute": "toggletip-text",
|
7339
7352
|
"reflects": true,
|
7340
7353
|
"inheritedFrom": {
|
7341
|
-
"name": "
|
7342
|
-
"module": "components/
|
7343
|
-
}
|
7344
|
-
},
|
7345
|
-
{
|
7346
|
-
"kind": "method",
|
7347
|
-
"name": "executeAction",
|
7348
|
-
"privacy": "protected",
|
7349
|
-
"inheritedFrom": {
|
7350
|
-
"name": "Buttonsimple",
|
7351
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
7354
|
+
"name": "FormfieldWrapper",
|
7355
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7352
7356
|
}
|
7353
7357
|
},
|
7354
7358
|
{
|
7355
|
-
"kind": "
|
7356
|
-
"name": "
|
7357
|
-
"
|
7358
|
-
|
7359
|
-
|
7360
|
-
|
7361
|
-
|
7362
|
-
|
7363
|
-
|
7364
|
-
"description": "The button element"
|
7365
|
-
},
|
7366
|
-
{
|
7367
|
-
"name": "active",
|
7368
|
-
"optional": true,
|
7369
|
-
"type": {
|
7370
|
-
"text": "boolean"
|
7371
|
-
},
|
7372
|
-
"description": "The active state of the element"
|
7373
|
-
}
|
7374
|
-
],
|
7375
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
7359
|
+
"kind": "field",
|
7360
|
+
"name": "toggletipPlacement",
|
7361
|
+
"type": {
|
7362
|
+
"text": "PopoverPlacement"
|
7363
|
+
},
|
7364
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
7365
|
+
"default": "'top'",
|
7366
|
+
"attribute": "toggletip-placement",
|
7367
|
+
"reflects": true,
|
7376
7368
|
"inheritedFrom": {
|
7377
|
-
"name": "
|
7378
|
-
"module": "components/
|
7369
|
+
"name": "FormfieldWrapper",
|
7370
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7379
7371
|
}
|
7380
7372
|
},
|
7381
7373
|
{
|
7382
|
-
"kind": "
|
7383
|
-
"name": "
|
7384
|
-
"
|
7385
|
-
|
7386
|
-
|
7387
|
-
|
7388
|
-
|
7389
|
-
|
7390
|
-
},
|
7391
|
-
"description": "The button element."
|
7392
|
-
},
|
7393
|
-
{
|
7394
|
-
"name": "softDisabled",
|
7395
|
-
"optional": true,
|
7396
|
-
"type": {
|
7397
|
-
"text": "boolean"
|
7398
|
-
},
|
7399
|
-
"description": "The soft-disabled state."
|
7400
|
-
}
|
7401
|
-
],
|
7402
|
-
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
7374
|
+
"kind": "field",
|
7375
|
+
"name": "infoIconAriaLabel",
|
7376
|
+
"type": {
|
7377
|
+
"text": "string | undefined"
|
7378
|
+
},
|
7379
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
7380
|
+
"attribute": "info-icon-aria-label",
|
7381
|
+
"reflects": true,
|
7403
7382
|
"inheritedFrom": {
|
7404
|
-
"name": "
|
7405
|
-
"module": "components/
|
7383
|
+
"name": "FormfieldWrapper",
|
7384
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7406
7385
|
}
|
7407
7386
|
},
|
7408
7387
|
{
|
7409
7388
|
"kind": "method",
|
7410
|
-
"name": "
|
7411
|
-
"privacy": "
|
7412
|
-
"
|
7413
|
-
|
7414
|
-
|
7415
|
-
"
|
7416
|
-
"text": "HTMLElement"
|
7417
|
-
},
|
7418
|
-
"description": "The button element."
|
7419
|
-
},
|
7420
|
-
{
|
7421
|
-
"name": "disabled",
|
7422
|
-
"type": {
|
7423
|
-
"text": "boolean"
|
7424
|
-
},
|
7425
|
-
"description": "The disabled state."
|
7389
|
+
"name": "renderLabelElement",
|
7390
|
+
"privacy": "protected",
|
7391
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
7392
|
+
"return": {
|
7393
|
+
"type": {
|
7394
|
+
"text": ""
|
7426
7395
|
}
|
7427
|
-
|
7428
|
-
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
7396
|
+
},
|
7429
7397
|
"inheritedFrom": {
|
7430
|
-
"name": "
|
7431
|
-
"module": "components/
|
7398
|
+
"name": "FormfieldWrapper",
|
7399
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7432
7400
|
}
|
7433
7401
|
},
|
7434
7402
|
{
|
7435
7403
|
"kind": "method",
|
7436
|
-
"name": "
|
7437
|
-
"privacy": "
|
7404
|
+
"name": "renderHelpTextIcon",
|
7405
|
+
"privacy": "protected",
|
7406
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
7407
|
+
"return": {
|
7408
|
+
"type": {
|
7409
|
+
"text": ""
|
7410
|
+
}
|
7411
|
+
},
|
7438
7412
|
"inheritedFrom": {
|
7439
|
-
"name": "
|
7440
|
-
"module": "components/
|
7413
|
+
"name": "FormfieldWrapper",
|
7414
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7441
7415
|
}
|
7442
7416
|
},
|
7443
7417
|
{
|
7444
7418
|
"kind": "method",
|
7445
|
-
"name": "
|
7446
|
-
"privacy": "
|
7447
|
-
"description": "
|
7419
|
+
"name": "renderHelpText",
|
7420
|
+
"privacy": "protected",
|
7421
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
7422
|
+
"return": {
|
7423
|
+
"type": {
|
7424
|
+
"text": ""
|
7425
|
+
}
|
7426
|
+
},
|
7448
7427
|
"inheritedFrom": {
|
7449
|
-
"name": "
|
7450
|
-
"module": "components/
|
7428
|
+
"name": "FormfieldWrapper",
|
7429
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7451
7430
|
}
|
7452
7431
|
},
|
7453
7432
|
{
|
7454
7433
|
"kind": "method",
|
7455
|
-
"name": "
|
7456
|
-
"privacy": "
|
7457
|
-
"
|
7458
|
-
|
7459
|
-
|
7460
|
-
"
|
7461
|
-
"text": "KeyboardEvent"
|
7462
|
-
},
|
7463
|
-
"description": "The keyboard event."
|
7434
|
+
"name": "renderLabel",
|
7435
|
+
"privacy": "protected",
|
7436
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
7437
|
+
"return": {
|
7438
|
+
"type": {
|
7439
|
+
"text": ""
|
7464
7440
|
}
|
7465
|
-
|
7466
|
-
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
7441
|
+
},
|
7467
7442
|
"inheritedFrom": {
|
7468
|
-
"name": "
|
7469
|
-
"module": "components/
|
7443
|
+
"name": "FormfieldWrapper",
|
7444
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7470
7445
|
}
|
7471
7446
|
},
|
7472
7447
|
{
|
7473
7448
|
"kind": "method",
|
7474
|
-
"name": "
|
7475
|
-
"privacy": "
|
7476
|
-
"
|
7477
|
-
|
7478
|
-
|
7479
|
-
"
|
7480
|
-
"text": "KeyboardEvent"
|
7481
|
-
},
|
7482
|
-
"description": "The keyboard event."
|
7449
|
+
"name": "renderHelperText",
|
7450
|
+
"privacy": "protected",
|
7451
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
7452
|
+
"return": {
|
7453
|
+
"type": {
|
7454
|
+
"text": ""
|
7483
7455
|
}
|
7484
|
-
|
7485
|
-
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
7456
|
+
},
|
7486
7457
|
"inheritedFrom": {
|
7487
|
-
"name": "
|
7488
|
-
"module": "components/
|
7458
|
+
"name": "FormfieldWrapper",
|
7459
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7489
7460
|
}
|
7490
7461
|
}
|
7491
7462
|
],
|
7463
|
+
"events": [
|
7464
|
+
{
|
7465
|
+
"type": {
|
7466
|
+
"text": "EventConstructor"
|
7467
|
+
}
|
7468
|
+
},
|
7469
|
+
{
|
7470
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
7471
|
+
"name": "change",
|
7472
|
+
"reactName": "onChange"
|
7473
|
+
},
|
7474
|
+
{
|
7475
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
7476
|
+
"name": "focus",
|
7477
|
+
"reactName": "onFocus"
|
7478
|
+
}
|
7479
|
+
],
|
7492
7480
|
"attributes": [
|
7493
7481
|
{
|
7494
|
-
"name": "
|
7482
|
+
"name": "checked",
|
7495
7483
|
"type": {
|
7496
|
-
"text": "
|
7484
|
+
"text": "boolean"
|
7497
7485
|
},
|
7498
|
-
"
|
7499
|
-
"
|
7500
|
-
"fieldName": "
|
7486
|
+
"default": "false",
|
7487
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
7488
|
+
"fieldName": "checked"
|
7501
7489
|
},
|
7502
7490
|
{
|
7503
|
-
"name": "
|
7491
|
+
"name": "indeterminate",
|
7492
|
+
"type": {
|
7493
|
+
"text": "boolean"
|
7494
|
+
},
|
7495
|
+
"default": "false",
|
7496
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
7497
|
+
"fieldName": "indeterminate"
|
7498
|
+
},
|
7499
|
+
{
|
7500
|
+
"name": "autofocus",
|
7501
|
+
"type": {
|
7502
|
+
"text": "boolean"
|
7503
|
+
},
|
7504
|
+
"default": "false",
|
7505
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
7506
|
+
"fieldName": "autofocus"
|
7507
|
+
},
|
7508
|
+
{
|
7509
|
+
"name": "name",
|
7504
7510
|
"type": {
|
7505
7511
|
"text": "string"
|
7506
7512
|
},
|
7507
7513
|
"default": "''",
|
7508
|
-
"description": "
|
7509
|
-
"fieldName": "
|
7514
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7515
|
+
"fieldName": "name",
|
7516
|
+
"inheritedFrom": {
|
7517
|
+
"name": "FormInternalsMixin",
|
7518
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7519
|
+
}
|
7510
7520
|
},
|
7511
7521
|
{
|
7512
|
-
"name": "
|
7522
|
+
"name": "value",
|
7513
7523
|
"type": {
|
7514
|
-
"text": "
|
7524
|
+
"text": "string"
|
7515
7525
|
},
|
7516
|
-
"
|
7517
|
-
"
|
7526
|
+
"default": "''",
|
7527
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7528
|
+
"fieldName": "value",
|
7518
7529
|
"inheritedFrom": {
|
7519
|
-
"name": "
|
7520
|
-
"module": "src/utils/mixins/
|
7530
|
+
"name": "FormInternalsMixin",
|
7531
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7521
7532
|
}
|
7522
7533
|
},
|
7523
7534
|
{
|
7524
|
-
"name": "
|
7535
|
+
"name": "validation-message",
|
7525
7536
|
"type": {
|
7526
|
-
"text": "
|
7537
|
+
"text": "string | undefined"
|
7527
7538
|
},
|
7528
|
-
"
|
7529
|
-
"
|
7530
|
-
"fieldName": "autofocus",
|
7539
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
7540
|
+
"fieldName": "validationMessage",
|
7531
7541
|
"inheritedFrom": {
|
7532
|
-
"name": "
|
7533
|
-
"module": "src/
|
7542
|
+
"name": "FormInternalsMixin",
|
7543
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7534
7544
|
}
|
7535
7545
|
},
|
7536
7546
|
{
|
7537
|
-
"name": "
|
7547
|
+
"name": "data-aria-label",
|
7538
7548
|
"type": {
|
7539
|
-
"text": "
|
7549
|
+
"text": "string | null"
|
7540
7550
|
},
|
7541
|
-
"default": "
|
7542
|
-
"description": "
|
7543
|
-
"fieldName": "
|
7551
|
+
"default": "null",
|
7552
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
7553
|
+
"fieldName": "dataAriaLabel",
|
7544
7554
|
"inheritedFrom": {
|
7545
|
-
"name": "
|
7546
|
-
"module": "src/
|
7555
|
+
"name": "DataAriaLabelMixin",
|
7556
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
7547
7557
|
}
|
7548
7558
|
},
|
7549
7559
|
{
|
@@ -7555,137 +7565,127 @@
|
|
7555
7565
|
"default": "undefined",
|
7556
7566
|
"fieldName": "disabled",
|
7557
7567
|
"inheritedFrom": {
|
7558
|
-
"name": "
|
7559
|
-
"module": "src/
|
7568
|
+
"name": "DisabledMixin",
|
7569
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
7560
7570
|
}
|
7561
7571
|
},
|
7562
7572
|
{
|
7563
|
-
"name": "
|
7573
|
+
"name": "label",
|
7564
7574
|
"type": {
|
7565
|
-
"text": "
|
7575
|
+
"text": "string | undefined"
|
7566
7576
|
},
|
7567
|
-
"description": "The
|
7568
|
-
"
|
7569
|
-
"fieldName": "active",
|
7577
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
7578
|
+
"fieldName": "label",
|
7570
7579
|
"inheritedFrom": {
|
7571
|
-
"name": "
|
7572
|
-
"module": "src/components/
|
7580
|
+
"name": "FormfieldWrapper",
|
7581
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7573
7582
|
}
|
7574
7583
|
},
|
7575
7584
|
{
|
7576
|
-
"name": "
|
7585
|
+
"name": "required",
|
7577
7586
|
"type": {
|
7578
|
-
"text": "boolean
|
7587
|
+
"text": "boolean"
|
7579
7588
|
},
|
7580
|
-
"
|
7581
|
-
"
|
7582
|
-
"fieldName": "
|
7589
|
+
"default": "false",
|
7590
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
7591
|
+
"fieldName": "required",
|
7583
7592
|
"inheritedFrom": {
|
7584
|
-
"name": "
|
7585
|
-
"module": "src/components/
|
7593
|
+
"name": "FormfieldWrapper",
|
7594
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7586
7595
|
}
|
7587
7596
|
},
|
7588
7597
|
{
|
7589
|
-
"name": "
|
7598
|
+
"name": "id",
|
7590
7599
|
"type": {
|
7591
|
-
"text": "
|
7600
|
+
"text": "string"
|
7592
7601
|
},
|
7593
|
-
"
|
7594
|
-
"
|
7595
|
-
"fieldName": "
|
7602
|
+
"default": "''",
|
7603
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
7604
|
+
"fieldName": "id",
|
7596
7605
|
"inheritedFrom": {
|
7597
|
-
"name": "
|
7598
|
-
"module": "src/components/
|
7606
|
+
"name": "FormfieldWrapper",
|
7607
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7599
7608
|
}
|
7600
7609
|
},
|
7601
7610
|
{
|
7602
|
-
"name": "
|
7603
|
-
"
|
7604
|
-
|
7605
|
-
|
7611
|
+
"name": "help-text-type",
|
7612
|
+
"type": {
|
7613
|
+
"text": "ValidationType"
|
7614
|
+
},
|
7615
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
7616
|
+
"fieldName": "helpTextType",
|
7606
7617
|
"inheritedFrom": {
|
7607
|
-
"name": "
|
7608
|
-
"module": "src/components/
|
7618
|
+
"name": "FormfieldWrapper",
|
7619
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7609
7620
|
}
|
7610
7621
|
},
|
7611
7622
|
{
|
7612
|
-
"name": "
|
7623
|
+
"name": "help-text",
|
7613
7624
|
"type": {
|
7614
7625
|
"text": "string | undefined"
|
7615
7626
|
},
|
7616
|
-
"description": "
|
7617
|
-
"
|
7618
|
-
"fieldName": "ariaStateKey",
|
7627
|
+
"description": "The help text that is displayed below the input field.",
|
7628
|
+
"fieldName": "helpText",
|
7619
7629
|
"inheritedFrom": {
|
7620
|
-
"name": "
|
7621
|
-
"module": "src/components/
|
7630
|
+
"name": "FormfieldWrapper",
|
7631
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7622
7632
|
}
|
7623
7633
|
},
|
7624
7634
|
{
|
7625
|
-
"name": "
|
7635
|
+
"name": "toggletip-text",
|
7626
7636
|
"type": {
|
7627
|
-
"text": "
|
7637
|
+
"text": "string | undefined"
|
7628
7638
|
},
|
7629
|
-
"description": "
|
7630
|
-
"
|
7631
|
-
"fieldName": "type",
|
7632
|
-
"inheritedFrom": {
|
7633
|
-
"name": "Buttonsimple",
|
7634
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7635
|
-
}
|
7636
|
-
}
|
7637
|
-
],
|
7638
|
-
"mixins": [
|
7639
|
-
{
|
7640
|
-
"name": "IconNameMixin",
|
7641
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
7642
|
-
}
|
7643
|
-
],
|
7644
|
-
"superclass": {
|
7645
|
-
"name": "Buttonsimple",
|
7646
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
7647
|
-
},
|
7648
|
-
"tagName": "mdc-chip",
|
7649
|
-
"jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
7650
|
-
"customElement": true,
|
7651
|
-
"events": [
|
7652
|
-
{
|
7653
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
7654
|
-
"name": "click",
|
7655
|
-
"reactName": "onClick",
|
7639
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
7640
|
+
"fieldName": "toggletipText",
|
7656
7641
|
"inheritedFrom": {
|
7657
|
-
"name": "
|
7658
|
-
"module": "src/components/
|
7642
|
+
"name": "FormfieldWrapper",
|
7643
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7659
7644
|
}
|
7660
7645
|
},
|
7661
7646
|
{
|
7662
|
-
"
|
7663
|
-
"
|
7664
|
-
|
7647
|
+
"name": "toggletip-placement",
|
7648
|
+
"type": {
|
7649
|
+
"text": "PopoverPlacement"
|
7650
|
+
},
|
7651
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
7652
|
+
"default": "'top'",
|
7653
|
+
"fieldName": "toggletipPlacement",
|
7665
7654
|
"inheritedFrom": {
|
7666
|
-
"name": "
|
7667
|
-
"module": "src/components/
|
7655
|
+
"name": "FormfieldWrapper",
|
7656
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7668
7657
|
}
|
7669
7658
|
},
|
7670
7659
|
{
|
7671
|
-
"
|
7672
|
-
"
|
7673
|
-
|
7660
|
+
"name": "info-icon-aria-label",
|
7661
|
+
"type": {
|
7662
|
+
"text": "string | undefined"
|
7663
|
+
},
|
7664
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
7665
|
+
"fieldName": "infoIconAriaLabel",
|
7674
7666
|
"inheritedFrom": {
|
7675
|
-
"name": "
|
7676
|
-
"module": "src/components/
|
7667
|
+
"name": "FormfieldWrapper",
|
7668
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
7677
7669
|
}
|
7670
|
+
}
|
7671
|
+
],
|
7672
|
+
"mixins": [
|
7673
|
+
{
|
7674
|
+
"name": "FormInternalsMixin",
|
7675
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
7678
7676
|
},
|
7679
7677
|
{
|
7680
|
-
"
|
7681
|
-
"
|
7682
|
-
"reactName": "onFocus",
|
7683
|
-
"inheritedFrom": {
|
7684
|
-
"name": "Buttonsimple",
|
7685
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
7686
|
-
}
|
7678
|
+
"name": "DataAriaLabelMixin",
|
7679
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
7687
7680
|
}
|
7688
|
-
]
|
7681
|
+
],
|
7682
|
+
"superclass": {
|
7683
|
+
"name": "FormfieldWrapper",
|
7684
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
7685
|
+
},
|
7686
|
+
"tagName": "mdc-checkbox",
|
7687
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
7688
|
+
"customElement": true
|
7689
7689
|
}
|
7690
7690
|
],
|
7691
7691
|
"exports": [
|
@@ -7693,8 +7693,8 @@
|
|
7693
7693
|
"kind": "js",
|
7694
7694
|
"name": "default",
|
7695
7695
|
"declaration": {
|
7696
|
-
"name": "
|
7697
|
-
"module": "components/
|
7696
|
+
"name": "Checkbox",
|
7697
|
+
"module": "components/checkbox/checkbox.component.js"
|
7698
7698
|
}
|
7699
7699
|
}
|
7700
7700
|
]
|
@@ -7860,13 +7860,47 @@
|
|
7860
7860
|
"module": "components/popover/popover.component.js"
|
7861
7861
|
}
|
7862
7862
|
},
|
7863
|
+
{
|
7864
|
+
"kind": "field",
|
7865
|
+
"name": "preventScroll",
|
7866
|
+
"type": {
|
7867
|
+
"text": "boolean"
|
7868
|
+
},
|
7869
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
7870
|
+
"default": "false",
|
7871
|
+
"attribute": "prevent-scroll",
|
7872
|
+
"reflects": true,
|
7873
|
+
"privacy": "protected",
|
7874
|
+
"inheritedFrom": {
|
7875
|
+
"name": "Popover",
|
7876
|
+
"module": "components/popover/popover.component.js"
|
7877
|
+
}
|
7878
|
+
},
|
7879
|
+
{
|
7880
|
+
"kind": "method",
|
7881
|
+
"name": "activatePreventScroll",
|
7882
|
+
"privacy": "protected",
|
7883
|
+
"inheritedFrom": {
|
7884
|
+
"name": "PreventScrollMixin",
|
7885
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
7886
|
+
}
|
7887
|
+
},
|
7888
|
+
{
|
7889
|
+
"kind": "method",
|
7890
|
+
"name": "deactivatePreventScroll",
|
7891
|
+
"privacy": "protected",
|
7892
|
+
"inheritedFrom": {
|
7893
|
+
"name": "PreventScrollMixin",
|
7894
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
7895
|
+
}
|
7896
|
+
},
|
7863
7897
|
{
|
7864
7898
|
"kind": "field",
|
7865
7899
|
"name": "focusTrap",
|
7866
7900
|
"type": {
|
7867
7901
|
"text": "boolean"
|
7868
7902
|
},
|
7869
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
7903
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
7870
7904
|
"default": "false",
|
7871
7905
|
"attribute": "focus-trap",
|
7872
7906
|
"reflects": true,
|
@@ -7883,7 +7917,7 @@
|
|
7883
7917
|
"text": "boolean"
|
7884
7918
|
},
|
7885
7919
|
"default": "true",
|
7886
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
7920
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
7887
7921
|
"attribute": "should-focus-trap-wrap",
|
7888
7922
|
"reflects": true,
|
7889
7923
|
"inheritedFrom": {
|
@@ -7892,14 +7926,17 @@
|
|
7892
7926
|
}
|
7893
7927
|
},
|
7894
7928
|
{
|
7895
|
-
"kind": "
|
7896
|
-
"name": "
|
7897
|
-
"
|
7898
|
-
|
7899
|
-
|
7900
|
-
|
7901
|
-
|
7902
|
-
|
7929
|
+
"kind": "method",
|
7930
|
+
"name": "setIsFocusTrapActivated",
|
7931
|
+
"privacy": "private",
|
7932
|
+
"parameters": [
|
7933
|
+
{
|
7934
|
+
"name": "isActivated",
|
7935
|
+
"type": {
|
7936
|
+
"text": "boolean"
|
7937
|
+
}
|
7938
|
+
}
|
7939
|
+
],
|
7903
7940
|
"inheritedFrom": {
|
7904
7941
|
"name": "FocusTrapMixin",
|
7905
7942
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -7909,7 +7946,7 @@
|
|
7909
7946
|
"kind": "method",
|
7910
7947
|
"name": "activateFocusTrap",
|
7911
7948
|
"privacy": "public",
|
7912
|
-
"description": "Activate the focus trap
|
7949
|
+
"description": "Activate the focus trap",
|
7913
7950
|
"inheritedFrom": {
|
7914
7951
|
"name": "FocusTrapMixin",
|
7915
7952
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -8167,7 +8204,7 @@
|
|
8167
8204
|
"description": "The set of focusable elements."
|
8168
8205
|
}
|
8169
8206
|
],
|
8170
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
8207
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
8171
8208
|
"inheritedFrom": {
|
8172
8209
|
"name": "FocusTrapMixin",
|
8173
8210
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -8176,7 +8213,7 @@
|
|
8176
8213
|
{
|
8177
8214
|
"kind": "method",
|
8178
8215
|
"name": "setFocusableElements",
|
8179
|
-
"privacy": "
|
8216
|
+
"privacy": "private",
|
8180
8217
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
8181
8218
|
"inheritedFrom": {
|
8182
8219
|
"name": "FocusTrapMixin",
|
@@ -8432,28 +8469,13 @@
|
|
8432
8469
|
"module": "components/popover/popover.component.js"
|
8433
8470
|
}
|
8434
8471
|
},
|
8435
|
-
{
|
8436
|
-
"kind": "field",
|
8437
|
-
"name": "preventScroll",
|
8438
|
-
"type": {
|
8439
|
-
"text": "boolean"
|
8440
|
-
},
|
8441
|
-
"description": "Prevent outside scrolling when popover show.",
|
8442
|
-
"default": "false",
|
8443
|
-
"attribute": "prevent-scroll",
|
8444
|
-
"reflects": true,
|
8445
|
-
"inheritedFrom": {
|
8446
|
-
"name": "Popover",
|
8447
|
-
"module": "components/popover/popover.component.js"
|
8448
|
-
}
|
8449
|
-
},
|
8450
8472
|
{
|
8451
8473
|
"kind": "field",
|
8452
8474
|
"name": "interactive",
|
8453
8475
|
"type": {
|
8454
8476
|
"text": "boolean"
|
8455
8477
|
},
|
8456
|
-
"description": "Determines whether the popover is interactive
|
8478
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
8457
8479
|
"default": "false",
|
8458
8480
|
"attribute": "interactive",
|
8459
8481
|
"reflects": true,
|
@@ -8492,6 +8514,21 @@
|
|
8492
8514
|
"module": "components/popover/popover.component.js"
|
8493
8515
|
}
|
8494
8516
|
},
|
8517
|
+
{
|
8518
|
+
"kind": "field",
|
8519
|
+
"name": "propagateEventOnEscape",
|
8520
|
+
"type": {
|
8521
|
+
"text": "boolean"
|
8522
|
+
},
|
8523
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
8524
|
+
"default": "false",
|
8525
|
+
"attribute": "propagate-event-on-escape",
|
8526
|
+
"reflects": true,
|
8527
|
+
"inheritedFrom": {
|
8528
|
+
"name": "Popover",
|
8529
|
+
"module": "components/popover/popover.component.js"
|
8530
|
+
}
|
8531
|
+
},
|
8495
8532
|
{
|
8496
8533
|
"kind": "field",
|
8497
8534
|
"name": "hideOnBlur",
|
@@ -8753,7 +8790,7 @@
|
|
8753
8790
|
"kind": "field",
|
8754
8791
|
"name": "onEscapeKeydown",
|
8755
8792
|
"privacy": "private",
|
8756
|
-
"description": "Handles the escape keydown event to close the popover.",
|
8793
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
8757
8794
|
"parameters": [
|
8758
8795
|
{
|
8759
8796
|
"description": "The keyboard event.",
|
@@ -8857,16 +8894,6 @@
|
|
8857
8894
|
"module": "components/popover/popover.component.js"
|
8858
8895
|
}
|
8859
8896
|
},
|
8860
|
-
{
|
8861
|
-
"kind": "method",
|
8862
|
-
"name": "handleCreatePopoverFirstUpdate",
|
8863
|
-
"privacy": "private",
|
8864
|
-
"description": "Sets the focusable elements inside the popover.",
|
8865
|
-
"inheritedFrom": {
|
8866
|
-
"name": "Popover",
|
8867
|
-
"module": "components/popover/popover.component.js"
|
8868
|
-
}
|
8869
|
-
},
|
8870
8897
|
{
|
8871
8898
|
"kind": "method",
|
8872
8899
|
"name": "positionPopover",
|
@@ -8984,26 +9011,13 @@
|
|
8984
9011
|
"text": "boolean"
|
8985
9012
|
},
|
8986
9013
|
"default": "true",
|
8987
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
9014
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
8988
9015
|
"fieldName": "shouldFocusTrapWrap",
|
8989
9016
|
"inheritedFrom": {
|
8990
9017
|
"name": "FocusTrapMixin",
|
8991
9018
|
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
8992
9019
|
}
|
8993
9020
|
},
|
8994
|
-
{
|
8995
|
-
"name": "enabledPreventScroll",
|
8996
|
-
"type": {
|
8997
|
-
"text": "boolean"
|
8998
|
-
},
|
8999
|
-
"default": "false",
|
9000
|
-
"description": "Prevent outside scrolling when element is shown.",
|
9001
|
-
"fieldName": "enabledPreventScroll",
|
9002
|
-
"inheritedFrom": {
|
9003
|
-
"name": "FocusTrapMixin",
|
9004
|
-
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
9005
|
-
}
|
9006
|
-
},
|
9007
9021
|
{
|
9008
9022
|
"name": "id",
|
9009
9023
|
"type": {
|
@@ -9100,7 +9114,7 @@
|
|
9100
9114
|
"type": {
|
9101
9115
|
"text": "boolean"
|
9102
9116
|
},
|
9103
|
-
"description": "Prevent outside scrolling when popover
|
9117
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
9104
9118
|
"default": "false",
|
9105
9119
|
"fieldName": "preventScroll",
|
9106
9120
|
"inheritedFrom": {
|
@@ -9113,7 +9127,7 @@
|
|
9113
9127
|
"type": {
|
9114
9128
|
"text": "boolean"
|
9115
9129
|
},
|
9116
|
-
"description": "Determines whether the popover is interactive
|
9130
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
9117
9131
|
"default": "false",
|
9118
9132
|
"fieldName": "interactive",
|
9119
9133
|
"inheritedFrom": {
|
@@ -9147,6 +9161,19 @@
|
|
9147
9161
|
"module": "src/components/popover/popover.component.ts"
|
9148
9162
|
}
|
9149
9163
|
},
|
9164
|
+
{
|
9165
|
+
"name": "propagate-event-on-escape",
|
9166
|
+
"type": {
|
9167
|
+
"text": "boolean"
|
9168
|
+
},
|
9169
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
9170
|
+
"default": "false",
|
9171
|
+
"fieldName": "propagateEventOnEscape",
|
9172
|
+
"inheritedFrom": {
|
9173
|
+
"name": "Popover",
|
9174
|
+
"module": "src/components/popover/popover.component.ts"
|
9175
|
+
}
|
9176
|
+
},
|
9150
9177
|
{
|
9151
9178
|
"name": "hide-on-blur",
|
9152
9179
|
"type": {
|
@@ -9580,6 +9607,20 @@
|
|
9580
9607
|
"attribute": "disable-aria-haspopup",
|
9581
9608
|
"reflects": true
|
9582
9609
|
},
|
9610
|
+
{
|
9611
|
+
"kind": "field",
|
9612
|
+
"name": "focusTrap",
|
9613
|
+
"type": {
|
9614
|
+
"text": "boolean"
|
9615
|
+
},
|
9616
|
+
"privacy": "protected",
|
9617
|
+
"description": "For now FocusTrap is always true as the dialog is a modal component only.\nThis means it will always trap focus within the dialog when it is open.",
|
9618
|
+
"default": "true",
|
9619
|
+
"inheritedFrom": {
|
9620
|
+
"name": "FocusTrapMixin",
|
9621
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9622
|
+
}
|
9623
|
+
},
|
9583
9624
|
{
|
9584
9625
|
"kind": "method",
|
9585
9626
|
"name": "isOpenUpdated",
|
@@ -9604,16 +9645,33 @@
|
|
9604
9645
|
},
|
9605
9646
|
{
|
9606
9647
|
"kind": "field",
|
9607
|
-
"name": "
|
9648
|
+
"name": "preventScroll",
|
9608
9649
|
"type": {
|
9609
9650
|
"text": "boolean"
|
9610
9651
|
},
|
9611
9652
|
"privacy": "protected",
|
9612
|
-
"description": "
|
9613
|
-
"default": "false",
|
9653
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
9614
9654
|
"inheritedFrom": {
|
9615
|
-
"name": "
|
9616
|
-
"module": "utils/mixins/
|
9655
|
+
"name": "PreventScrollMixin",
|
9656
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
9657
|
+
}
|
9658
|
+
},
|
9659
|
+
{
|
9660
|
+
"kind": "method",
|
9661
|
+
"name": "activatePreventScroll",
|
9662
|
+
"privacy": "protected",
|
9663
|
+
"inheritedFrom": {
|
9664
|
+
"name": "PreventScrollMixin",
|
9665
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
9666
|
+
}
|
9667
|
+
},
|
9668
|
+
{
|
9669
|
+
"kind": "method",
|
9670
|
+
"name": "deactivatePreventScroll",
|
9671
|
+
"privacy": "protected",
|
9672
|
+
"inheritedFrom": {
|
9673
|
+
"name": "PreventScrollMixin",
|
9674
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
9617
9675
|
}
|
9618
9676
|
},
|
9619
9677
|
{
|
@@ -9623,7 +9681,7 @@
|
|
9623
9681
|
"text": "boolean"
|
9624
9682
|
},
|
9625
9683
|
"default": "true",
|
9626
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
9684
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
9627
9685
|
"attribute": "should-focus-trap-wrap",
|
9628
9686
|
"reflects": true,
|
9629
9687
|
"inheritedFrom": {
|
@@ -9632,14 +9690,17 @@
|
|
9632
9690
|
}
|
9633
9691
|
},
|
9634
9692
|
{
|
9635
|
-
"kind": "
|
9636
|
-
"name": "
|
9637
|
-
"
|
9638
|
-
|
9639
|
-
|
9640
|
-
|
9641
|
-
|
9642
|
-
|
9693
|
+
"kind": "method",
|
9694
|
+
"name": "setIsFocusTrapActivated",
|
9695
|
+
"privacy": "private",
|
9696
|
+
"parameters": [
|
9697
|
+
{
|
9698
|
+
"name": "isActivated",
|
9699
|
+
"type": {
|
9700
|
+
"text": "boolean"
|
9701
|
+
}
|
9702
|
+
}
|
9703
|
+
],
|
9643
9704
|
"inheritedFrom": {
|
9644
9705
|
"name": "FocusTrapMixin",
|
9645
9706
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -9649,7 +9710,7 @@
|
|
9649
9710
|
"kind": "method",
|
9650
9711
|
"name": "activateFocusTrap",
|
9651
9712
|
"privacy": "public",
|
9652
|
-
"description": "Activate the focus trap
|
9713
|
+
"description": "Activate the focus trap",
|
9653
9714
|
"inheritedFrom": {
|
9654
9715
|
"name": "FocusTrapMixin",
|
9655
9716
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -9907,7 +9968,7 @@
|
|
9907
9968
|
"description": "The set of focusable elements."
|
9908
9969
|
}
|
9909
9970
|
],
|
9910
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
9971
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
9911
9972
|
"inheritedFrom": {
|
9912
9973
|
"name": "FocusTrapMixin",
|
9913
9974
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -9916,7 +9977,7 @@
|
|
9916
9977
|
{
|
9917
9978
|
"kind": "method",
|
9918
9979
|
"name": "setFocusableElements",
|
9919
|
-
"privacy": "
|
9980
|
+
"privacy": "private",
|
9920
9981
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
9921
9982
|
"inheritedFrom": {
|
9922
9983
|
"name": "FocusTrapMixin",
|
@@ -10276,28 +10337,19 @@
|
|
10276
10337
|
"text": "boolean"
|
10277
10338
|
},
|
10278
10339
|
"default": "true",
|
10279
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
10340
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
10280
10341
|
"fieldName": "shouldFocusTrapWrap",
|
10281
10342
|
"inheritedFrom": {
|
10282
10343
|
"name": "FocusTrapMixin",
|
10283
10344
|
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
10284
10345
|
}
|
10285
|
-
},
|
10286
|
-
{
|
10287
|
-
"name": "enabledPreventScroll",
|
10288
|
-
"type": {
|
10289
|
-
"text": "boolean"
|
10290
|
-
},
|
10291
|
-
"default": "false",
|
10292
|
-
"description": "Prevent outside scrolling when element is shown.",
|
10293
|
-
"fieldName": "enabledPreventScroll",
|
10294
|
-
"inheritedFrom": {
|
10295
|
-
"name": "FocusTrapMixin",
|
10296
|
-
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
10297
|
-
}
|
10298
10346
|
}
|
10299
10347
|
],
|
10300
10348
|
"mixins": [
|
10349
|
+
{
|
10350
|
+
"name": "PreventScrollMixin",
|
10351
|
+
"module": "/src/utils/mixins/PreventScrollMixin"
|
10352
|
+
},
|
10301
10353
|
{
|
10302
10354
|
"name": "FocusTrapMixin",
|
10303
10355
|
"module": "/src/utils/mixins/FocusTrapMixin"
|
@@ -18497,13 +18549,47 @@
|
|
18497
18549
|
"module": "utils/mixins/MenuMixin.js"
|
18498
18550
|
}
|
18499
18551
|
},
|
18552
|
+
{
|
18553
|
+
"kind": "field",
|
18554
|
+
"name": "preventScroll",
|
18555
|
+
"type": {
|
18556
|
+
"text": "boolean"
|
18557
|
+
},
|
18558
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
18559
|
+
"default": "false",
|
18560
|
+
"attribute": "prevent-scroll",
|
18561
|
+
"reflects": true,
|
18562
|
+
"privacy": "protected",
|
18563
|
+
"inheritedFrom": {
|
18564
|
+
"name": "Popover",
|
18565
|
+
"module": "components/popover/popover.component.js"
|
18566
|
+
}
|
18567
|
+
},
|
18568
|
+
{
|
18569
|
+
"kind": "method",
|
18570
|
+
"name": "activatePreventScroll",
|
18571
|
+
"privacy": "protected",
|
18572
|
+
"inheritedFrom": {
|
18573
|
+
"name": "PreventScrollMixin",
|
18574
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
18575
|
+
}
|
18576
|
+
},
|
18577
|
+
{
|
18578
|
+
"kind": "method",
|
18579
|
+
"name": "deactivatePreventScroll",
|
18580
|
+
"privacy": "protected",
|
18581
|
+
"inheritedFrom": {
|
18582
|
+
"name": "PreventScrollMixin",
|
18583
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
18584
|
+
}
|
18585
|
+
},
|
18500
18586
|
{
|
18501
18587
|
"kind": "field",
|
18502
18588
|
"name": "focusTrap",
|
18503
18589
|
"type": {
|
18504
18590
|
"text": "boolean"
|
18505
18591
|
},
|
18506
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
18592
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
18507
18593
|
"default": "false",
|
18508
18594
|
"attribute": "focus-trap",
|
18509
18595
|
"reflects": true,
|
@@ -18520,7 +18606,7 @@
|
|
18520
18606
|
"text": "boolean"
|
18521
18607
|
},
|
18522
18608
|
"default": "true",
|
18523
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
18609
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
18524
18610
|
"attribute": "should-focus-trap-wrap",
|
18525
18611
|
"reflects": true,
|
18526
18612
|
"inheritedFrom": {
|
@@ -18529,14 +18615,17 @@
|
|
18529
18615
|
}
|
18530
18616
|
},
|
18531
18617
|
{
|
18532
|
-
"kind": "
|
18533
|
-
"name": "
|
18534
|
-
"
|
18535
|
-
|
18536
|
-
|
18537
|
-
|
18538
|
-
|
18539
|
-
|
18618
|
+
"kind": "method",
|
18619
|
+
"name": "setIsFocusTrapActivated",
|
18620
|
+
"privacy": "private",
|
18621
|
+
"parameters": [
|
18622
|
+
{
|
18623
|
+
"name": "isActivated",
|
18624
|
+
"type": {
|
18625
|
+
"text": "boolean"
|
18626
|
+
}
|
18627
|
+
}
|
18628
|
+
],
|
18540
18629
|
"inheritedFrom": {
|
18541
18630
|
"name": "FocusTrapMixin",
|
18542
18631
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -18546,7 +18635,7 @@
|
|
18546
18635
|
"kind": "method",
|
18547
18636
|
"name": "activateFocusTrap",
|
18548
18637
|
"privacy": "public",
|
18549
|
-
"description": "Activate the focus trap
|
18638
|
+
"description": "Activate the focus trap",
|
18550
18639
|
"inheritedFrom": {
|
18551
18640
|
"name": "FocusTrapMixin",
|
18552
18641
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -18804,7 +18893,7 @@
|
|
18804
18893
|
"description": "The set of focusable elements."
|
18805
18894
|
}
|
18806
18895
|
],
|
18807
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
18896
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
18808
18897
|
"inheritedFrom": {
|
18809
18898
|
"name": "FocusTrapMixin",
|
18810
18899
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -18813,7 +18902,7 @@
|
|
18813
18902
|
{
|
18814
18903
|
"kind": "method",
|
18815
18904
|
"name": "setFocusableElements",
|
18816
|
-
"privacy": "
|
18905
|
+
"privacy": "private",
|
18817
18906
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
18818
18907
|
"inheritedFrom": {
|
18819
18908
|
"name": "FocusTrapMixin",
|
@@ -19084,21 +19173,6 @@
|
|
19084
19173
|
"module": "components/popover/popover.component.js"
|
19085
19174
|
}
|
19086
19175
|
},
|
19087
|
-
{
|
19088
|
-
"kind": "field",
|
19089
|
-
"name": "preventScroll",
|
19090
|
-
"type": {
|
19091
|
-
"text": "boolean"
|
19092
|
-
},
|
19093
|
-
"description": "Prevent outside scrolling when popover show.",
|
19094
|
-
"default": "false",
|
19095
|
-
"attribute": "prevent-scroll",
|
19096
|
-
"reflects": true,
|
19097
|
-
"inheritedFrom": {
|
19098
|
-
"name": "Popover",
|
19099
|
-
"module": "components/popover/popover.component.js"
|
19100
|
-
}
|
19101
|
-
},
|
19102
19176
|
{
|
19103
19177
|
"kind": "field",
|
19104
19178
|
"name": "showArrow",
|
@@ -19135,7 +19209,7 @@
|
|
19135
19209
|
"type": {
|
19136
19210
|
"text": "boolean"
|
19137
19211
|
},
|
19138
|
-
"description": "Determines whether the popover is interactive
|
19212
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
19139
19213
|
"default": "false",
|
19140
19214
|
"attribute": "interactive",
|
19141
19215
|
"reflects": true,
|
@@ -19174,6 +19248,21 @@
|
|
19174
19248
|
"module": "components/popover/popover.component.js"
|
19175
19249
|
}
|
19176
19250
|
},
|
19251
|
+
{
|
19252
|
+
"kind": "field",
|
19253
|
+
"name": "propagateEventOnEscape",
|
19254
|
+
"type": {
|
19255
|
+
"text": "boolean"
|
19256
|
+
},
|
19257
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
19258
|
+
"default": "false",
|
19259
|
+
"attribute": "propagate-event-on-escape",
|
19260
|
+
"reflects": true,
|
19261
|
+
"inheritedFrom": {
|
19262
|
+
"name": "Popover",
|
19263
|
+
"module": "components/popover/popover.component.js"
|
19264
|
+
}
|
19265
|
+
},
|
19177
19266
|
{
|
19178
19267
|
"kind": "field",
|
19179
19268
|
"name": "hideOnBlur",
|
@@ -19450,7 +19539,7 @@
|
|
19450
19539
|
"kind": "field",
|
19451
19540
|
"name": "onEscapeKeydown",
|
19452
19541
|
"privacy": "private",
|
19453
|
-
"description": "Handles the escape keydown event to close the popover.",
|
19542
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
19454
19543
|
"parameters": [
|
19455
19544
|
{
|
19456
19545
|
"description": "The keyboard event.",
|
@@ -19554,16 +19643,6 @@
|
|
19554
19643
|
"module": "components/popover/popover.component.js"
|
19555
19644
|
}
|
19556
19645
|
},
|
19557
|
-
{
|
19558
|
-
"kind": "method",
|
19559
|
-
"name": "handleCreatePopoverFirstUpdate",
|
19560
|
-
"privacy": "private",
|
19561
|
-
"description": "Sets the focusable elements inside the popover.",
|
19562
|
-
"inheritedFrom": {
|
19563
|
-
"name": "Popover",
|
19564
|
-
"module": "components/popover/popover.component.js"
|
19565
|
-
}
|
19566
|
-
},
|
19567
19646
|
{
|
19568
19647
|
"kind": "method",
|
19569
19648
|
"name": "positionPopover",
|
@@ -19617,26 +19696,13 @@
|
|
19617
19696
|
"text": "boolean"
|
19618
19697
|
},
|
19619
19698
|
"default": "true",
|
19620
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
19699
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
19621
19700
|
"fieldName": "shouldFocusTrapWrap",
|
19622
19701
|
"inheritedFrom": {
|
19623
19702
|
"name": "FocusTrapMixin",
|
19624
19703
|
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
19625
19704
|
}
|
19626
19705
|
},
|
19627
|
-
{
|
19628
|
-
"name": "enabledPreventScroll",
|
19629
|
-
"type": {
|
19630
|
-
"text": "boolean"
|
19631
|
-
},
|
19632
|
-
"default": "false",
|
19633
|
-
"description": "Prevent outside scrolling when element is shown.",
|
19634
|
-
"fieldName": "enabledPreventScroll",
|
19635
|
-
"inheritedFrom": {
|
19636
|
-
"name": "FocusTrapMixin",
|
19637
|
-
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
19638
|
-
}
|
19639
|
-
},
|
19640
19706
|
{
|
19641
19707
|
"name": "id",
|
19642
19708
|
"type": {
|
@@ -19746,7 +19812,7 @@
|
|
19746
19812
|
"type": {
|
19747
19813
|
"text": "boolean"
|
19748
19814
|
},
|
19749
|
-
"description": "Prevent outside scrolling when popover
|
19815
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
19750
19816
|
"default": "false",
|
19751
19817
|
"fieldName": "preventScroll",
|
19752
19818
|
"inheritedFrom": {
|
@@ -19785,7 +19851,7 @@
|
|
19785
19851
|
"type": {
|
19786
19852
|
"text": "boolean"
|
19787
19853
|
},
|
19788
|
-
"description": "Determines whether the popover is interactive
|
19854
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
19789
19855
|
"default": "false",
|
19790
19856
|
"fieldName": "interactive",
|
19791
19857
|
"inheritedFrom": {
|
@@ -19819,6 +19885,19 @@
|
|
19819
19885
|
"module": "src/components/popover/popover.component.ts"
|
19820
19886
|
}
|
19821
19887
|
},
|
19888
|
+
{
|
19889
|
+
"name": "propagate-event-on-escape",
|
19890
|
+
"type": {
|
19891
|
+
"text": "boolean"
|
19892
|
+
},
|
19893
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
19894
|
+
"default": "false",
|
19895
|
+
"fieldName": "propagateEventOnEscape",
|
19896
|
+
"inheritedFrom": {
|
19897
|
+
"name": "Popover",
|
19898
|
+
"module": "src/components/popover/popover.component.ts"
|
19899
|
+
}
|
19900
|
+
},
|
19822
19901
|
{
|
19823
19902
|
"name": "hide-on-blur",
|
19824
19903
|
"type": {
|
@@ -23024,10 +23103,15 @@
|
|
23024
23103
|
"type": {
|
23025
23104
|
"text": "boolean"
|
23026
23105
|
},
|
23027
|
-
"
|
23106
|
+
"privacy": "protected",
|
23107
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
23028
23108
|
"default": "false",
|
23029
23109
|
"attribute": "prevent-scroll",
|
23030
|
-
"reflects": true
|
23110
|
+
"reflects": true,
|
23111
|
+
"inheritedFrom": {
|
23112
|
+
"name": "PreventScrollMixin",
|
23113
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
23114
|
+
}
|
23031
23115
|
},
|
23032
23116
|
{
|
23033
23117
|
"kind": "field",
|
@@ -23057,7 +23141,7 @@
|
|
23057
23141
|
"type": {
|
23058
23142
|
"text": "boolean"
|
23059
23143
|
},
|
23060
|
-
"description": "Determines whether the popover is interactive
|
23144
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
23061
23145
|
"default": "false",
|
23062
23146
|
"attribute": "interactive",
|
23063
23147
|
"reflects": true
|
@@ -23084,6 +23168,17 @@
|
|
23084
23168
|
"attribute": "hide-on-escape",
|
23085
23169
|
"reflects": true
|
23086
23170
|
},
|
23171
|
+
{
|
23172
|
+
"kind": "field",
|
23173
|
+
"name": "propagateEventOnEscape",
|
23174
|
+
"type": {
|
23175
|
+
"text": "boolean"
|
23176
|
+
},
|
23177
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
23178
|
+
"default": "false",
|
23179
|
+
"attribute": "propagate-event-on-escape",
|
23180
|
+
"reflects": true
|
23181
|
+
},
|
23087
23182
|
{
|
23088
23183
|
"kind": "field",
|
23089
23184
|
"name": "hideOnBlur",
|
@@ -23284,7 +23379,7 @@
|
|
23284
23379
|
"kind": "field",
|
23285
23380
|
"name": "onEscapeKeydown",
|
23286
23381
|
"privacy": "private",
|
23287
|
-
"description": "Handles the escape keydown event to close the popover.",
|
23382
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
23288
23383
|
"parameters": [
|
23289
23384
|
{
|
23290
23385
|
"description": "The keyboard event.",
|
@@ -23356,12 +23451,6 @@
|
|
23356
23451
|
"privacy": "public",
|
23357
23452
|
"description": "Toggles the popover visibility."
|
23358
23453
|
},
|
23359
|
-
{
|
23360
|
-
"kind": "method",
|
23361
|
-
"name": "handleCreatePopoverFirstUpdate",
|
23362
|
-
"privacy": "private",
|
23363
|
-
"description": "Sets the focusable elements inside the popover."
|
23364
|
-
},
|
23365
23454
|
{
|
23366
23455
|
"kind": "method",
|
23367
23456
|
"name": "positionPopover",
|
@@ -23373,6 +23462,24 @@
|
|
23373
23462
|
"name": "utils",
|
23374
23463
|
"default": "new PopoverUtils(this)"
|
23375
23464
|
},
|
23465
|
+
{
|
23466
|
+
"kind": "method",
|
23467
|
+
"name": "activatePreventScroll",
|
23468
|
+
"privacy": "protected",
|
23469
|
+
"inheritedFrom": {
|
23470
|
+
"name": "PreventScrollMixin",
|
23471
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
23472
|
+
}
|
23473
|
+
},
|
23474
|
+
{
|
23475
|
+
"kind": "method",
|
23476
|
+
"name": "deactivatePreventScroll",
|
23477
|
+
"privacy": "protected",
|
23478
|
+
"inheritedFrom": {
|
23479
|
+
"name": "PreventScrollMixin",
|
23480
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
23481
|
+
}
|
23482
|
+
},
|
23376
23483
|
{
|
23377
23484
|
"kind": "field",
|
23378
23485
|
"name": "shouldFocusTrapWrap",
|
@@ -23380,7 +23487,7 @@
|
|
23380
23487
|
"text": "boolean"
|
23381
23488
|
},
|
23382
23489
|
"default": "true",
|
23383
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
23490
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
23384
23491
|
"attribute": "should-focus-trap-wrap",
|
23385
23492
|
"reflects": true,
|
23386
23493
|
"inheritedFrom": {
|
@@ -23389,14 +23496,17 @@
|
|
23389
23496
|
}
|
23390
23497
|
},
|
23391
23498
|
{
|
23392
|
-
"kind": "
|
23393
|
-
"name": "
|
23394
|
-
"
|
23395
|
-
|
23396
|
-
|
23397
|
-
|
23398
|
-
|
23399
|
-
|
23499
|
+
"kind": "method",
|
23500
|
+
"name": "setIsFocusTrapActivated",
|
23501
|
+
"privacy": "private",
|
23502
|
+
"parameters": [
|
23503
|
+
{
|
23504
|
+
"name": "isActivated",
|
23505
|
+
"type": {
|
23506
|
+
"text": "boolean"
|
23507
|
+
}
|
23508
|
+
}
|
23509
|
+
],
|
23400
23510
|
"inheritedFrom": {
|
23401
23511
|
"name": "FocusTrapMixin",
|
23402
23512
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -23406,7 +23516,7 @@
|
|
23406
23516
|
"kind": "method",
|
23407
23517
|
"name": "activateFocusTrap",
|
23408
23518
|
"privacy": "public",
|
23409
|
-
"description": "Activate the focus trap
|
23519
|
+
"description": "Activate the focus trap",
|
23410
23520
|
"inheritedFrom": {
|
23411
23521
|
"name": "FocusTrapMixin",
|
23412
23522
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -23664,7 +23774,7 @@
|
|
23664
23774
|
"description": "The set of focusable elements."
|
23665
23775
|
}
|
23666
23776
|
],
|
23667
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
23777
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
23668
23778
|
"inheritedFrom": {
|
23669
23779
|
"name": "FocusTrapMixin",
|
23670
23780
|
"module": "utils/mixins/FocusTrapMixin.js"
|
@@ -23673,7 +23783,7 @@
|
|
23673
23783
|
{
|
23674
23784
|
"kind": "method",
|
23675
23785
|
"name": "setFocusableElements",
|
23676
|
-
"privacy": "
|
23786
|
+
"privacy": "private",
|
23677
23787
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
23678
23788
|
"inheritedFrom": {
|
23679
23789
|
"name": "FocusTrapMixin",
|
@@ -23940,7 +24050,7 @@
|
|
23940
24050
|
"type": {
|
23941
24051
|
"text": "boolean"
|
23942
24052
|
},
|
23943
|
-
"description": "Prevent outside scrolling when popover
|
24053
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
23944
24054
|
"default": "false",
|
23945
24055
|
"fieldName": "preventScroll"
|
23946
24056
|
},
|
@@ -23967,7 +24077,7 @@
|
|
23967
24077
|
"type": {
|
23968
24078
|
"text": "boolean"
|
23969
24079
|
},
|
23970
|
-
"description": "Determines whether the popover is interactive
|
24080
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
23971
24081
|
"default": "false",
|
23972
24082
|
"fieldName": "interactive"
|
23973
24083
|
},
|
@@ -23989,6 +24099,15 @@
|
|
23989
24099
|
"default": "false",
|
23990
24100
|
"fieldName": "hideOnEscape"
|
23991
24101
|
},
|
24102
|
+
{
|
24103
|
+
"name": "propagate-event-on-escape",
|
24104
|
+
"type": {
|
24105
|
+
"text": "boolean"
|
24106
|
+
},
|
24107
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
24108
|
+
"default": "false",
|
24109
|
+
"fieldName": "propagateEventOnEscape"
|
24110
|
+
},
|
23992
24111
|
{
|
23993
24112
|
"name": "hide-on-blur",
|
23994
24113
|
"type": {
|
@@ -24121,28 +24240,19 @@
|
|
24121
24240
|
"text": "boolean"
|
24122
24241
|
},
|
24123
24242
|
"default": "true",
|
24124
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
24243
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
24125
24244
|
"fieldName": "shouldFocusTrapWrap",
|
24126
24245
|
"inheritedFrom": {
|
24127
24246
|
"name": "FocusTrapMixin",
|
24128
24247
|
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
24129
24248
|
}
|
24130
|
-
},
|
24131
|
-
{
|
24132
|
-
"name": "enabledPreventScroll",
|
24133
|
-
"type": {
|
24134
|
-
"text": "boolean"
|
24135
|
-
},
|
24136
|
-
"default": "false",
|
24137
|
-
"description": "Prevent outside scrolling when element is shown.",
|
24138
|
-
"fieldName": "enabledPreventScroll",
|
24139
|
-
"inheritedFrom": {
|
24140
|
-
"name": "FocusTrapMixin",
|
24141
|
-
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
24142
|
-
}
|
24143
24249
|
}
|
24144
24250
|
],
|
24145
24251
|
"mixins": [
|
24252
|
+
{
|
24253
|
+
"name": "PreventScrollMixin",
|
24254
|
+
"module": "/src/utils/mixins/PreventScrollMixin"
|
24255
|
+
},
|
24146
24256
|
{
|
24147
24257
|
"name": "FocusTrapMixin",
|
24148
24258
|
"module": "/src/utils/mixins/FocusTrapMixin"
|
@@ -32729,6 +32839,40 @@
|
|
32729
32839
|
},
|
32730
32840
|
"description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
|
32731
32841
|
},
|
32842
|
+
{
|
32843
|
+
"kind": "field",
|
32844
|
+
"name": "preventScroll",
|
32845
|
+
"type": {
|
32846
|
+
"text": "boolean"
|
32847
|
+
},
|
32848
|
+
"privacy": "protected",
|
32849
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
32850
|
+
"default": "false",
|
32851
|
+
"attribute": "prevent-scroll",
|
32852
|
+
"reflects": true,
|
32853
|
+
"inheritedFrom": {
|
32854
|
+
"name": "Popover",
|
32855
|
+
"module": "components/popover/popover.component.js"
|
32856
|
+
}
|
32857
|
+
},
|
32858
|
+
{
|
32859
|
+
"kind": "method",
|
32860
|
+
"name": "activatePreventScroll",
|
32861
|
+
"privacy": "protected",
|
32862
|
+
"inheritedFrom": {
|
32863
|
+
"name": "Popover",
|
32864
|
+
"module": "components/popover/popover.component.js"
|
32865
|
+
}
|
32866
|
+
},
|
32867
|
+
{
|
32868
|
+
"kind": "method",
|
32869
|
+
"name": "deactivatePreventScroll",
|
32870
|
+
"privacy": "protected",
|
32871
|
+
"inheritedFrom": {
|
32872
|
+
"name": "Popover",
|
32873
|
+
"module": "components/popover/popover.component.js"
|
32874
|
+
}
|
32875
|
+
},
|
32732
32876
|
{
|
32733
32877
|
"kind": "field",
|
32734
32878
|
"name": "focusTrap",
|
@@ -32736,7 +32880,7 @@
|
|
32736
32880
|
"text": "boolean"
|
32737
32881
|
},
|
32738
32882
|
"privacy": "protected",
|
32739
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
32883
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
32740
32884
|
"default": "false",
|
32741
32885
|
"attribute": "focus-trap",
|
32742
32886
|
"reflects": true,
|
@@ -32752,7 +32896,7 @@
|
|
32752
32896
|
"text": "boolean"
|
32753
32897
|
},
|
32754
32898
|
"default": "true",
|
32755
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
32899
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
32756
32900
|
"attribute": "should-focus-trap-wrap",
|
32757
32901
|
"reflects": true,
|
32758
32902
|
"inheritedFrom": {
|
@@ -32761,14 +32905,17 @@
|
|
32761
32905
|
}
|
32762
32906
|
},
|
32763
32907
|
{
|
32764
|
-
"kind": "
|
32765
|
-
"name": "
|
32766
|
-
"
|
32767
|
-
|
32768
|
-
|
32769
|
-
|
32770
|
-
|
32771
|
-
|
32908
|
+
"kind": "method",
|
32909
|
+
"name": "setIsFocusTrapActivated",
|
32910
|
+
"privacy": "private",
|
32911
|
+
"parameters": [
|
32912
|
+
{
|
32913
|
+
"name": "isActivated",
|
32914
|
+
"type": {
|
32915
|
+
"text": "boolean"
|
32916
|
+
}
|
32917
|
+
}
|
32918
|
+
],
|
32772
32919
|
"inheritedFrom": {
|
32773
32920
|
"name": "Popover",
|
32774
32921
|
"module": "components/popover/popover.component.js"
|
@@ -32778,7 +32925,7 @@
|
|
32778
32925
|
"kind": "method",
|
32779
32926
|
"name": "activateFocusTrap",
|
32780
32927
|
"privacy": "public",
|
32781
|
-
"description": "Activate the focus trap
|
32928
|
+
"description": "Activate the focus trap",
|
32782
32929
|
"inheritedFrom": {
|
32783
32930
|
"name": "Popover",
|
32784
32931
|
"module": "components/popover/popover.component.js"
|
@@ -33036,7 +33183,7 @@
|
|
33036
33183
|
"description": "The set of focusable elements."
|
33037
33184
|
}
|
33038
33185
|
],
|
33039
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
33186
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
33040
33187
|
"inheritedFrom": {
|
33041
33188
|
"name": "Popover",
|
33042
33189
|
"module": "components/popover/popover.component.js"
|
@@ -33045,7 +33192,7 @@
|
|
33045
33192
|
{
|
33046
33193
|
"kind": "method",
|
33047
33194
|
"name": "setFocusableElements",
|
33048
|
-
"privacy": "
|
33195
|
+
"privacy": "private",
|
33049
33196
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
33050
33197
|
"inheritedFrom": {
|
33051
33198
|
"name": "Popover",
|
@@ -33316,21 +33463,6 @@
|
|
33316
33463
|
"module": "components/popover/popover.component.js"
|
33317
33464
|
}
|
33318
33465
|
},
|
33319
|
-
{
|
33320
|
-
"kind": "field",
|
33321
|
-
"name": "preventScroll",
|
33322
|
-
"type": {
|
33323
|
-
"text": "boolean"
|
33324
|
-
},
|
33325
|
-
"description": "Prevent outside scrolling when popover show.",
|
33326
|
-
"default": "false",
|
33327
|
-
"attribute": "prevent-scroll",
|
33328
|
-
"reflects": true,
|
33329
|
-
"inheritedFrom": {
|
33330
|
-
"name": "Popover",
|
33331
|
-
"module": "components/popover/popover.component.js"
|
33332
|
-
}
|
33333
|
-
},
|
33334
33466
|
{
|
33335
33467
|
"kind": "field",
|
33336
33468
|
"name": "showArrow",
|
@@ -33367,7 +33499,7 @@
|
|
33367
33499
|
"type": {
|
33368
33500
|
"text": "boolean"
|
33369
33501
|
},
|
33370
|
-
"description": "Determines whether the popover is interactive
|
33502
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
33371
33503
|
"default": "false",
|
33372
33504
|
"attribute": "interactive",
|
33373
33505
|
"reflects": true,
|
@@ -33406,6 +33538,21 @@
|
|
33406
33538
|
"module": "components/popover/popover.component.js"
|
33407
33539
|
}
|
33408
33540
|
},
|
33541
|
+
{
|
33542
|
+
"kind": "field",
|
33543
|
+
"name": "propagateEventOnEscape",
|
33544
|
+
"type": {
|
33545
|
+
"text": "boolean"
|
33546
|
+
},
|
33547
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
33548
|
+
"default": "false",
|
33549
|
+
"attribute": "propagate-event-on-escape",
|
33550
|
+
"reflects": true,
|
33551
|
+
"inheritedFrom": {
|
33552
|
+
"name": "Popover",
|
33553
|
+
"module": "components/popover/popover.component.js"
|
33554
|
+
}
|
33555
|
+
},
|
33409
33556
|
{
|
33410
33557
|
"kind": "field",
|
33411
33558
|
"name": "hideOnBlur",
|
@@ -33682,7 +33829,7 @@
|
|
33682
33829
|
"kind": "field",
|
33683
33830
|
"name": "onEscapeKeydown",
|
33684
33831
|
"privacy": "private",
|
33685
|
-
"description": "Handles the escape keydown event to close the popover.",
|
33832
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
33686
33833
|
"parameters": [
|
33687
33834
|
{
|
33688
33835
|
"description": "The keyboard event.",
|
@@ -33786,16 +33933,6 @@
|
|
33786
33933
|
"module": "components/popover/popover.component.js"
|
33787
33934
|
}
|
33788
33935
|
},
|
33789
|
-
{
|
33790
|
-
"kind": "method",
|
33791
|
-
"name": "handleCreatePopoverFirstUpdate",
|
33792
|
-
"privacy": "private",
|
33793
|
-
"description": "Sets the focusable elements inside the popover.",
|
33794
|
-
"inheritedFrom": {
|
33795
|
-
"name": "Popover",
|
33796
|
-
"module": "components/popover/popover.component.js"
|
33797
|
-
}
|
33798
|
-
},
|
33799
33936
|
{
|
33800
33937
|
"kind": "method",
|
33801
33938
|
"name": "positionPopover",
|
@@ -33869,26 +34006,13 @@
|
|
33869
34006
|
"text": "boolean"
|
33870
34007
|
},
|
33871
34008
|
"default": "true",
|
33872
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
34009
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
33873
34010
|
"fieldName": "shouldFocusTrapWrap",
|
33874
34011
|
"inheritedFrom": {
|
33875
34012
|
"name": "Popover",
|
33876
34013
|
"module": "src/components/popover/popover.component.ts"
|
33877
34014
|
}
|
33878
34015
|
},
|
33879
|
-
{
|
33880
|
-
"name": "enabledPreventScroll",
|
33881
|
-
"type": {
|
33882
|
-
"text": "boolean"
|
33883
|
-
},
|
33884
|
-
"default": "false",
|
33885
|
-
"description": "Prevent outside scrolling when element is shown.",
|
33886
|
-
"fieldName": "enabledPreventScroll",
|
33887
|
-
"inheritedFrom": {
|
33888
|
-
"name": "Popover",
|
33889
|
-
"module": "src/components/popover/popover.component.ts"
|
33890
|
-
}
|
33891
|
-
},
|
33892
34016
|
{
|
33893
34017
|
"name": "id",
|
33894
34018
|
"type": {
|
@@ -33998,7 +34122,7 @@
|
|
33998
34122
|
"type": {
|
33999
34123
|
"text": "boolean"
|
34000
34124
|
},
|
34001
|
-
"description": "Prevent outside scrolling when popover
|
34125
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
34002
34126
|
"default": "false",
|
34003
34127
|
"fieldName": "preventScroll",
|
34004
34128
|
"inheritedFrom": {
|
@@ -34037,7 +34161,7 @@
|
|
34037
34161
|
"type": {
|
34038
34162
|
"text": "boolean"
|
34039
34163
|
},
|
34040
|
-
"description": "Determines whether the popover is interactive
|
34164
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
34041
34165
|
"default": "false",
|
34042
34166
|
"fieldName": "interactive",
|
34043
34167
|
"inheritedFrom": {
|
@@ -34071,6 +34195,19 @@
|
|
34071
34195
|
"module": "src/components/popover/popover.component.ts"
|
34072
34196
|
}
|
34073
34197
|
},
|
34198
|
+
{
|
34199
|
+
"name": "propagate-event-on-escape",
|
34200
|
+
"type": {
|
34201
|
+
"text": "boolean"
|
34202
|
+
},
|
34203
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
34204
|
+
"default": "false",
|
34205
|
+
"fieldName": "propagateEventOnEscape",
|
34206
|
+
"inheritedFrom": {
|
34207
|
+
"name": "Popover",
|
34208
|
+
"module": "src/components/popover/popover.component.ts"
|
34209
|
+
}
|
34210
|
+
},
|
34074
34211
|
{
|
34075
34212
|
"name": "hide-on-blur",
|
34076
34213
|
"type": {
|
@@ -34472,6 +34609,40 @@
|
|
34472
34609
|
],
|
34473
34610
|
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
34474
34611
|
},
|
34612
|
+
{
|
34613
|
+
"kind": "field",
|
34614
|
+
"name": "preventScroll",
|
34615
|
+
"type": {
|
34616
|
+
"text": "boolean"
|
34617
|
+
},
|
34618
|
+
"privacy": "protected",
|
34619
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
34620
|
+
"default": "false",
|
34621
|
+
"attribute": "prevent-scroll",
|
34622
|
+
"reflects": true,
|
34623
|
+
"inheritedFrom": {
|
34624
|
+
"name": "Popover",
|
34625
|
+
"module": "components/popover/popover.component.js"
|
34626
|
+
}
|
34627
|
+
},
|
34628
|
+
{
|
34629
|
+
"kind": "method",
|
34630
|
+
"name": "activatePreventScroll",
|
34631
|
+
"privacy": "protected",
|
34632
|
+
"inheritedFrom": {
|
34633
|
+
"name": "Popover",
|
34634
|
+
"module": "components/popover/popover.component.js"
|
34635
|
+
}
|
34636
|
+
},
|
34637
|
+
{
|
34638
|
+
"kind": "method",
|
34639
|
+
"name": "deactivatePreventScroll",
|
34640
|
+
"privacy": "protected",
|
34641
|
+
"inheritedFrom": {
|
34642
|
+
"name": "Popover",
|
34643
|
+
"module": "components/popover/popover.component.js"
|
34644
|
+
}
|
34645
|
+
},
|
34475
34646
|
{
|
34476
34647
|
"kind": "field",
|
34477
34648
|
"name": "focusTrap",
|
@@ -34479,7 +34650,7 @@
|
|
34479
34650
|
"text": "boolean"
|
34480
34651
|
},
|
34481
34652
|
"privacy": "protected",
|
34482
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
34653
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
34483
34654
|
"default": "false",
|
34484
34655
|
"attribute": "focus-trap",
|
34485
34656
|
"reflects": true,
|
@@ -34495,7 +34666,7 @@
|
|
34495
34666
|
"text": "boolean"
|
34496
34667
|
},
|
34497
34668
|
"default": "true",
|
34498
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
34669
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
34499
34670
|
"attribute": "should-focus-trap-wrap",
|
34500
34671
|
"reflects": true,
|
34501
34672
|
"inheritedFrom": {
|
@@ -34504,14 +34675,17 @@
|
|
34504
34675
|
}
|
34505
34676
|
},
|
34506
34677
|
{
|
34507
|
-
"kind": "
|
34508
|
-
"name": "
|
34509
|
-
"
|
34510
|
-
|
34511
|
-
|
34512
|
-
|
34513
|
-
|
34514
|
-
|
34678
|
+
"kind": "method",
|
34679
|
+
"name": "setIsFocusTrapActivated",
|
34680
|
+
"privacy": "private",
|
34681
|
+
"parameters": [
|
34682
|
+
{
|
34683
|
+
"name": "isActivated",
|
34684
|
+
"type": {
|
34685
|
+
"text": "boolean"
|
34686
|
+
}
|
34687
|
+
}
|
34688
|
+
],
|
34515
34689
|
"inheritedFrom": {
|
34516
34690
|
"name": "Popover",
|
34517
34691
|
"module": "components/popover/popover.component.js"
|
@@ -34521,7 +34695,7 @@
|
|
34521
34695
|
"kind": "method",
|
34522
34696
|
"name": "activateFocusTrap",
|
34523
34697
|
"privacy": "public",
|
34524
|
-
"description": "Activate the focus trap
|
34698
|
+
"description": "Activate the focus trap",
|
34525
34699
|
"inheritedFrom": {
|
34526
34700
|
"name": "Popover",
|
34527
34701
|
"module": "components/popover/popover.component.js"
|
@@ -34779,7 +34953,7 @@
|
|
34779
34953
|
"description": "The set of focusable elements."
|
34780
34954
|
}
|
34781
34955
|
],
|
34782
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
34956
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
34783
34957
|
"inheritedFrom": {
|
34784
34958
|
"name": "Popover",
|
34785
34959
|
"module": "components/popover/popover.component.js"
|
@@ -34788,7 +34962,7 @@
|
|
34788
34962
|
{
|
34789
34963
|
"kind": "method",
|
34790
34964
|
"name": "setFocusableElements",
|
34791
|
-
"privacy": "
|
34965
|
+
"privacy": "private",
|
34792
34966
|
"description": "Updates the list of focusable elements within the component's shadow root.",
|
34793
34967
|
"inheritedFrom": {
|
34794
34968
|
"name": "Popover",
|
@@ -35059,21 +35233,6 @@
|
|
35059
35233
|
"module": "components/popover/popover.component.js"
|
35060
35234
|
}
|
35061
35235
|
},
|
35062
|
-
{
|
35063
|
-
"kind": "field",
|
35064
|
-
"name": "preventScroll",
|
35065
|
-
"type": {
|
35066
|
-
"text": "boolean"
|
35067
|
-
},
|
35068
|
-
"description": "Prevent outside scrolling when popover show.",
|
35069
|
-
"default": "false",
|
35070
|
-
"attribute": "prevent-scroll",
|
35071
|
-
"reflects": true,
|
35072
|
-
"inheritedFrom": {
|
35073
|
-
"name": "Popover",
|
35074
|
-
"module": "components/popover/popover.component.js"
|
35075
|
-
}
|
35076
|
-
},
|
35077
35236
|
{
|
35078
35237
|
"kind": "field",
|
35079
35238
|
"name": "showArrow",
|
@@ -35110,7 +35269,7 @@
|
|
35110
35269
|
"type": {
|
35111
35270
|
"text": "boolean"
|
35112
35271
|
},
|
35113
|
-
"description": "Determines whether the popover is interactive
|
35272
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
35114
35273
|
"default": "false",
|
35115
35274
|
"attribute": "interactive",
|
35116
35275
|
"reflects": true,
|
@@ -35149,6 +35308,21 @@
|
|
35149
35308
|
"module": "components/popover/popover.component.js"
|
35150
35309
|
}
|
35151
35310
|
},
|
35311
|
+
{
|
35312
|
+
"kind": "field",
|
35313
|
+
"name": "propagateEventOnEscape",
|
35314
|
+
"type": {
|
35315
|
+
"text": "boolean"
|
35316
|
+
},
|
35317
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
35318
|
+
"default": "false",
|
35319
|
+
"attribute": "propagate-event-on-escape",
|
35320
|
+
"reflects": true,
|
35321
|
+
"inheritedFrom": {
|
35322
|
+
"name": "Popover",
|
35323
|
+
"module": "components/popover/popover.component.js"
|
35324
|
+
}
|
35325
|
+
},
|
35152
35326
|
{
|
35153
35327
|
"kind": "field",
|
35154
35328
|
"name": "hideOnBlur",
|
@@ -35425,7 +35599,7 @@
|
|
35425
35599
|
"kind": "field",
|
35426
35600
|
"name": "onEscapeKeydown",
|
35427
35601
|
"privacy": "private",
|
35428
|
-
"description": "Handles the escape keydown event to close the popover.",
|
35602
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
35429
35603
|
"parameters": [
|
35430
35604
|
{
|
35431
35605
|
"description": "The keyboard event.",
|
@@ -35529,16 +35703,6 @@
|
|
35529
35703
|
"module": "components/popover/popover.component.js"
|
35530
35704
|
}
|
35531
35705
|
},
|
35532
|
-
{
|
35533
|
-
"kind": "method",
|
35534
|
-
"name": "handleCreatePopoverFirstUpdate",
|
35535
|
-
"privacy": "private",
|
35536
|
-
"description": "Sets the focusable elements inside the popover.",
|
35537
|
-
"inheritedFrom": {
|
35538
|
-
"name": "Popover",
|
35539
|
-
"module": "components/popover/popover.component.js"
|
35540
|
-
}
|
35541
|
-
},
|
35542
35706
|
{
|
35543
35707
|
"kind": "method",
|
35544
35708
|
"name": "positionPopover",
|
@@ -35613,26 +35777,13 @@
|
|
35613
35777
|
"text": "boolean"
|
35614
35778
|
},
|
35615
35779
|
"default": "true",
|
35616
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
35780
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
35617
35781
|
"fieldName": "shouldFocusTrapWrap",
|
35618
35782
|
"inheritedFrom": {
|
35619
35783
|
"name": "Popover",
|
35620
35784
|
"module": "src/components/popover/popover.component.ts"
|
35621
35785
|
}
|
35622
35786
|
},
|
35623
|
-
{
|
35624
|
-
"name": "enabledPreventScroll",
|
35625
|
-
"type": {
|
35626
|
-
"text": "boolean"
|
35627
|
-
},
|
35628
|
-
"default": "false",
|
35629
|
-
"description": "Prevent outside scrolling when element is shown.",
|
35630
|
-
"fieldName": "enabledPreventScroll",
|
35631
|
-
"inheritedFrom": {
|
35632
|
-
"name": "Popover",
|
35633
|
-
"module": "src/components/popover/popover.component.ts"
|
35634
|
-
}
|
35635
|
-
},
|
35636
35787
|
{
|
35637
35788
|
"name": "id",
|
35638
35789
|
"type": {
|
@@ -35742,7 +35893,7 @@
|
|
35742
35893
|
"type": {
|
35743
35894
|
"text": "boolean"
|
35744
35895
|
},
|
35745
|
-
"description": "Prevent outside scrolling when popover
|
35896
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
35746
35897
|
"default": "false",
|
35747
35898
|
"fieldName": "preventScroll",
|
35748
35899
|
"inheritedFrom": {
|
@@ -35781,7 +35932,7 @@
|
|
35781
35932
|
"type": {
|
35782
35933
|
"text": "boolean"
|
35783
35934
|
},
|
35784
|
-
"description": "Determines whether the popover is interactive
|
35935
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
35785
35936
|
"default": "false",
|
35786
35937
|
"fieldName": "interactive",
|
35787
35938
|
"inheritedFrom": {
|
@@ -35815,6 +35966,19 @@
|
|
35815
35966
|
"module": "src/components/popover/popover.component.ts"
|
35816
35967
|
}
|
35817
35968
|
},
|
35969
|
+
{
|
35970
|
+
"name": "propagate-event-on-escape",
|
35971
|
+
"type": {
|
35972
|
+
"text": "boolean"
|
35973
|
+
},
|
35974
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
35975
|
+
"default": "false",
|
35976
|
+
"fieldName": "propagateEventOnEscape",
|
35977
|
+
"inheritedFrom": {
|
35978
|
+
"name": "Popover",
|
35979
|
+
"module": "src/components/popover/popover.component.ts"
|
35980
|
+
}
|
35981
|
+
},
|
35818
35982
|
{
|
35819
35983
|
"name": "hide-on-blur",
|
35820
35984
|
"type": {
|
@@ -37237,13 +37401,6 @@
|
|
37237
37401
|
},
|
37238
37402
|
"privacy": "protected"
|
37239
37403
|
},
|
37240
|
-
{
|
37241
|
-
"kind": "field",
|
37242
|
-
"name": "enabledPreventScroll",
|
37243
|
-
"type": {
|
37244
|
-
"text": "boolean"
|
37245
|
-
}
|
37246
|
-
},
|
37247
37404
|
{
|
37248
37405
|
"kind": "method",
|
37249
37406
|
"name": "setInitialFocus",
|
@@ -37279,6 +37436,24 @@
|
|
37279
37436
|
"text": "void"
|
37280
37437
|
}
|
37281
37438
|
}
|
37439
|
+
},
|
37440
|
+
{
|
37441
|
+
"kind": "method",
|
37442
|
+
"name": "setIsFocusTrapActivated",
|
37443
|
+
"privacy": "private",
|
37444
|
+
"return": {
|
37445
|
+
"type": {
|
37446
|
+
"text": "void"
|
37447
|
+
}
|
37448
|
+
},
|
37449
|
+
"parameters": [
|
37450
|
+
{
|
37451
|
+
"name": "isActivated",
|
37452
|
+
"type": {
|
37453
|
+
"text": "boolean"
|
37454
|
+
}
|
37455
|
+
}
|
37456
|
+
]
|
37282
37457
|
}
|
37283
37458
|
]
|
37284
37459
|
},
|
@@ -37294,8 +37469,7 @@
|
|
37294
37469
|
"text": "boolean"
|
37295
37470
|
},
|
37296
37471
|
"privacy": "protected",
|
37297
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component."
|
37298
|
-
"default": "false"
|
37472
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT."
|
37299
37473
|
},
|
37300
37474
|
{
|
37301
37475
|
"kind": "field",
|
@@ -37304,25 +37478,28 @@
|
|
37304
37478
|
"text": "boolean"
|
37305
37479
|
},
|
37306
37480
|
"default": "true",
|
37307
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
37481
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
37308
37482
|
"attribute": "should-focus-trap-wrap",
|
37309
37483
|
"reflects": true
|
37310
37484
|
},
|
37311
37485
|
{
|
37312
|
-
"kind": "
|
37313
|
-
"name": "
|
37314
|
-
"
|
37315
|
-
|
37316
|
-
|
37317
|
-
|
37318
|
-
|
37319
|
-
|
37486
|
+
"kind": "method",
|
37487
|
+
"name": "setIsFocusTrapActivated",
|
37488
|
+
"privacy": "private",
|
37489
|
+
"parameters": [
|
37490
|
+
{
|
37491
|
+
"name": "isActivated",
|
37492
|
+
"type": {
|
37493
|
+
"text": "boolean"
|
37494
|
+
}
|
37495
|
+
}
|
37496
|
+
]
|
37320
37497
|
},
|
37321
37498
|
{
|
37322
37499
|
"kind": "method",
|
37323
37500
|
"name": "activateFocusTrap",
|
37324
37501
|
"privacy": "public",
|
37325
|
-
"description": "Activate the focus trap
|
37502
|
+
"description": "Activate the focus trap"
|
37326
37503
|
},
|
37327
37504
|
{
|
37328
37505
|
"kind": "method",
|
@@ -37536,12 +37713,12 @@
|
|
37536
37713
|
"description": "The set of focusable elements."
|
37537
37714
|
}
|
37538
37715
|
],
|
37539
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants."
|
37716
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times."
|
37540
37717
|
},
|
37541
37718
|
{
|
37542
37719
|
"kind": "method",
|
37543
37720
|
"name": "setFocusableElements",
|
37544
|
-
"privacy": "
|
37721
|
+
"privacy": "private",
|
37545
37722
|
"description": "Updates the list of focusable elements within the component's shadow root."
|
37546
37723
|
},
|
37547
37724
|
{
|
@@ -37683,17 +37860,8 @@
|
|
37683
37860
|
"text": "boolean"
|
37684
37861
|
},
|
37685
37862
|
"default": "true",
|
37686
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `
|
37863
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
37687
37864
|
"fieldName": "shouldFocusTrapWrap"
|
37688
|
-
},
|
37689
|
-
{
|
37690
|
-
"name": "enabledPreventScroll",
|
37691
|
-
"type": {
|
37692
|
-
"text": "boolean"
|
37693
|
-
},
|
37694
|
-
"default": "false",
|
37695
|
-
"description": "Prevent outside scrolling when element is shown.",
|
37696
|
-
"fieldName": "enabledPreventScroll"
|
37697
37865
|
}
|
37698
37866
|
],
|
37699
37867
|
"parameters": [
|
@@ -38633,6 +38801,99 @@
|
|
38633
38801
|
}
|
38634
38802
|
]
|
38635
38803
|
},
|
38804
|
+
{
|
38805
|
+
"kind": "javascript-module",
|
38806
|
+
"path": "utils/mixins/PreventScrollMixin.js",
|
38807
|
+
"declarations": [
|
38808
|
+
{
|
38809
|
+
"kind": "class",
|
38810
|
+
"description": "",
|
38811
|
+
"name": "PreventScrollMixinInterface",
|
38812
|
+
"members": [
|
38813
|
+
{
|
38814
|
+
"kind": "field",
|
38815
|
+
"name": "preventScroll",
|
38816
|
+
"type": {
|
38817
|
+
"text": "boolean | undefined"
|
38818
|
+
},
|
38819
|
+
"privacy": "protected"
|
38820
|
+
},
|
38821
|
+
{
|
38822
|
+
"kind": "method",
|
38823
|
+
"name": "activatePreventScroll",
|
38824
|
+
"privacy": "protected",
|
38825
|
+
"return": {
|
38826
|
+
"type": {
|
38827
|
+
"text": "void"
|
38828
|
+
}
|
38829
|
+
}
|
38830
|
+
},
|
38831
|
+
{
|
38832
|
+
"kind": "method",
|
38833
|
+
"name": "deactivatePreventScroll",
|
38834
|
+
"privacy": "protected",
|
38835
|
+
"return": {
|
38836
|
+
"type": {
|
38837
|
+
"text": "void"
|
38838
|
+
}
|
38839
|
+
}
|
38840
|
+
}
|
38841
|
+
]
|
38842
|
+
},
|
38843
|
+
{
|
38844
|
+
"kind": "mixin",
|
38845
|
+
"description": "",
|
38846
|
+
"name": "PreventScrollMixin",
|
38847
|
+
"members": [
|
38848
|
+
{
|
38849
|
+
"kind": "field",
|
38850
|
+
"name": "preventScroll",
|
38851
|
+
"type": {
|
38852
|
+
"text": "boolean"
|
38853
|
+
},
|
38854
|
+
"privacy": "protected",
|
38855
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT."
|
38856
|
+
},
|
38857
|
+
{
|
38858
|
+
"kind": "method",
|
38859
|
+
"name": "activatePreventScroll",
|
38860
|
+
"privacy": "protected"
|
38861
|
+
},
|
38862
|
+
{
|
38863
|
+
"kind": "method",
|
38864
|
+
"name": "deactivatePreventScroll",
|
38865
|
+
"privacy": "protected"
|
38866
|
+
}
|
38867
|
+
],
|
38868
|
+
"parameters": [
|
38869
|
+
{
|
38870
|
+
"name": "superClass",
|
38871
|
+
"type": {
|
38872
|
+
"text": "T"
|
38873
|
+
}
|
38874
|
+
}
|
38875
|
+
]
|
38876
|
+
}
|
38877
|
+
],
|
38878
|
+
"exports": [
|
38879
|
+
{
|
38880
|
+
"kind": "js",
|
38881
|
+
"name": "PreventScrollMixinInterface",
|
38882
|
+
"declaration": {
|
38883
|
+
"name": "PreventScrollMixinInterface",
|
38884
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
38885
|
+
}
|
38886
|
+
},
|
38887
|
+
{
|
38888
|
+
"kind": "js",
|
38889
|
+
"name": "PreventScrollMixin",
|
38890
|
+
"declaration": {
|
38891
|
+
"name": "PreventScrollMixin",
|
38892
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
38893
|
+
}
|
38894
|
+
}
|
38895
|
+
]
|
38896
|
+
},
|
38636
38897
|
{
|
38637
38898
|
"kind": "javascript-module",
|
38638
38899
|
"path": "utils/mixins/TabIndexMixin.js",
|