@momentum-design/components 0.95.4 → 0.95.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +4 -4
- package/dist/browser/index.js.map +2 -2
- package/dist/components/listitem/listitem.component.d.ts +2 -3
- package/dist/components/listitem/listitem.component.js +4 -5
- package/dist/custom-elements.json +1304 -1304
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/package.json +1 -1
@@ -9589,473 +9589,518 @@
|
|
9589
9589
|
},
|
9590
9590
|
{
|
9591
9591
|
"kind": "javascript-module",
|
9592
|
-
"path": "components/
|
9592
|
+
"path": "components/divider/divider.component.js",
|
9593
9593
|
"declarations": [
|
9594
9594
|
{
|
9595
9595
|
"kind": "class",
|
9596
|
-
"description": "
|
9597
|
-
"name": "
|
9596
|
+
"description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
|
9597
|
+
"name": "Divider",
|
9598
9598
|
"cssProperties": [
|
9599
9599
|
{
|
9600
|
-
"description": "
|
9601
|
-
"name": "--mdc-
|
9600
|
+
"description": "background color of the divider",
|
9601
|
+
"name": "--mdc-divider-background-color"
|
9602
9602
|
},
|
9603
9603
|
{
|
9604
|
-
"description": "
|
9605
|
-
"name": "--mdc-
|
9604
|
+
"description": "width of the divider",
|
9605
|
+
"name": "--mdc-divider-width"
|
9606
9606
|
},
|
9607
9607
|
{
|
9608
|
-
"description": "
|
9609
|
-
"name": "--mdc-
|
9608
|
+
"description": "gradient of the horizontal divider",
|
9609
|
+
"name": "--mdc-divider-horizontal-gradient"
|
9610
9610
|
},
|
9611
9611
|
{
|
9612
|
-
"description": "
|
9613
|
-
"name": "--mdc-
|
9612
|
+
"description": "gradient of the vertical divider",
|
9613
|
+
"name": "--mdc-divider-vertical-gradient"
|
9614
9614
|
},
|
9615
9615
|
{
|
9616
|
-
"description": "
|
9617
|
-
"name": "--mdc-
|
9616
|
+
"description": "font size of label in the text divider",
|
9617
|
+
"name": "--mdc-divider-text-size"
|
9618
9618
|
},
|
9619
9619
|
{
|
9620
|
-
"description": "
|
9621
|
-
"name": "--mdc-
|
9622
|
-
}
|
9623
|
-
],
|
9624
|
-
"slots": [
|
9620
|
+
"description": "font color of label in the text divider",
|
9621
|
+
"name": "--mdc-divider-text-color"
|
9622
|
+
},
|
9625
9623
|
{
|
9626
|
-
"description": "
|
9627
|
-
"name": "
|
9624
|
+
"description": "left and right margin of label in the text divider",
|
9625
|
+
"name": "--mdc-divider-text-margin"
|
9628
9626
|
},
|
9629
9627
|
{
|
9630
|
-
"description": "
|
9631
|
-
"name": "
|
9628
|
+
"description": "line height of label in the text divider",
|
9629
|
+
"name": "--mdc-divider-text-line-height"
|
9632
9630
|
},
|
9633
9631
|
{
|
9634
|
-
"description": "
|
9635
|
-
"name": "
|
9632
|
+
"description": "background color of the grabber button in rest state",
|
9633
|
+
"name": "--mdc-divider-grabber-button-background-color-normal"
|
9636
9634
|
},
|
9637
9635
|
{
|
9638
|
-
"description": "
|
9639
|
-
"name": "
|
9636
|
+
"description": "background color of the grabber button in hover state",
|
9637
|
+
"name": "--mdc-divider-grabber-button-background-color-hover"
|
9640
9638
|
},
|
9641
9639
|
{
|
9642
|
-
"description": "
|
9643
|
-
"name": "
|
9640
|
+
"description": "background color of the grabber button in pressed state",
|
9641
|
+
"name": "--mdc-divider-grabber-button-background-color-pressed"
|
9644
9642
|
},
|
9645
9643
|
{
|
9646
|
-
"description": "
|
9647
|
-
"name": "
|
9644
|
+
"description": "border color of the grabber button",
|
9645
|
+
"name": "--mdc-divider-grabber-button-border-color"
|
9646
|
+
},
|
9647
|
+
{
|
9648
|
+
"description": "border radius of the grabber button",
|
9649
|
+
"name": "--mdc-divider-grabber-button-border-radius"
|
9648
9650
|
}
|
9649
9651
|
],
|
9650
9652
|
"members": [
|
9651
9653
|
{
|
9652
9654
|
"kind": "field",
|
9653
|
-
"name": "
|
9655
|
+
"name": "orientation",
|
9654
9656
|
"type": {
|
9655
|
-
"text": "
|
9657
|
+
"text": "DividerOrientation"
|
9656
9658
|
},
|
9657
|
-
"
|
9658
|
-
"
|
9659
|
-
"attribute": "
|
9659
|
+
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
9660
|
+
"default": "horizontal",
|
9661
|
+
"attribute": "orientation",
|
9660
9662
|
"reflects": true
|
9661
9663
|
},
|
9662
9664
|
{
|
9663
9665
|
"kind": "field",
|
9664
|
-
"name": "
|
9666
|
+
"name": "variant",
|
9665
9667
|
"type": {
|
9666
|
-
"text": "
|
9668
|
+
"text": "DividerVariant"
|
9667
9669
|
},
|
9668
|
-
"description": "
|
9669
|
-
"default": "
|
9670
|
-
"attribute": "
|
9670
|
+
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
9671
|
+
"default": "solid",
|
9672
|
+
"attribute": "variant",
|
9671
9673
|
"reflects": true
|
9672
9674
|
},
|
9673
9675
|
{
|
9674
9676
|
"kind": "field",
|
9675
|
-
"name": "
|
9677
|
+
"name": "arrowDirection",
|
9676
9678
|
"type": {
|
9677
|
-
"text": "
|
9679
|
+
"text": "Directions"
|
9678
9680
|
},
|
9679
|
-
"description": "
|
9680
|
-
"default": "
|
9681
|
-
"attribute": "
|
9681
|
+
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9682
|
+
"default": "'negative'",
|
9683
|
+
"attribute": "arrow-direction",
|
9682
9684
|
"reflects": true
|
9683
9685
|
},
|
9684
9686
|
{
|
9685
9687
|
"kind": "field",
|
9686
|
-
"name": "
|
9688
|
+
"name": "buttonPosition",
|
9687
9689
|
"type": {
|
9688
|
-
"text": "
|
9690
|
+
"text": "Directions"
|
9689
9691
|
},
|
9690
|
-
"description": "
|
9691
|
-
"default": "
|
9692
|
-
"attribute": "
|
9692
|
+
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9693
|
+
"default": "'negative'",
|
9694
|
+
"attribute": "button-position",
|
9693
9695
|
"reflects": true
|
9694
9696
|
},
|
9695
9697
|
{
|
9696
|
-
"kind": "
|
9697
|
-
"name": "
|
9698
|
-
"
|
9699
|
-
|
9700
|
-
|
9701
|
-
|
9702
|
-
|
9703
|
-
|
9704
|
-
|
9698
|
+
"kind": "method",
|
9699
|
+
"name": "setVariant",
|
9700
|
+
"privacy": "private",
|
9701
|
+
"parameters": [
|
9702
|
+
{
|
9703
|
+
"name": "variant",
|
9704
|
+
"type": {
|
9705
|
+
"text": "DividerVariant"
|
9706
|
+
},
|
9707
|
+
"description": "The variant to set."
|
9708
|
+
}
|
9709
|
+
],
|
9710
|
+
"description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
9705
9711
|
},
|
9706
9712
|
{
|
9707
|
-
"kind": "
|
9708
|
-
"name": "
|
9709
|
-
"
|
9710
|
-
|
9711
|
-
|
9712
|
-
|
9713
|
-
|
9714
|
-
|
9715
|
-
|
9713
|
+
"kind": "method",
|
9714
|
+
"name": "setOrientation",
|
9715
|
+
"privacy": "private",
|
9716
|
+
"parameters": [
|
9717
|
+
{
|
9718
|
+
"name": "orientation",
|
9719
|
+
"type": {
|
9720
|
+
"text": "DividerOrientation"
|
9721
|
+
},
|
9722
|
+
"description": "The orientation to set."
|
9723
|
+
}
|
9724
|
+
],
|
9725
|
+
"description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
|
9716
9726
|
},
|
9717
9727
|
{
|
9718
|
-
"kind": "
|
9719
|
-
"name": "
|
9720
|
-
"
|
9721
|
-
|
9722
|
-
|
9723
|
-
|
9724
|
-
|
9725
|
-
|
9728
|
+
"kind": "method",
|
9729
|
+
"name": "ensureValidDirections",
|
9730
|
+
"privacy": "private",
|
9731
|
+
"description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
|
9732
|
+
"parameters": [
|
9733
|
+
{
|
9734
|
+
"description": "The buttonPosition to set.",
|
9735
|
+
"name": "buttonPosition"
|
9736
|
+
},
|
9737
|
+
{
|
9738
|
+
"description": "The arrowDirection to set.",
|
9739
|
+
"name": "arrowDirection"
|
9740
|
+
}
|
9741
|
+
]
|
9726
9742
|
},
|
9727
9743
|
{
|
9728
|
-
"kind": "
|
9729
|
-
"name": "
|
9730
|
-
"
|
9731
|
-
|
9744
|
+
"kind": "method",
|
9745
|
+
"name": "setGrabberButton",
|
9746
|
+
"privacy": "private",
|
9747
|
+
"return": {
|
9748
|
+
"type": {
|
9749
|
+
"text": "void"
|
9750
|
+
}
|
9732
9751
|
},
|
9733
|
-
"
|
9734
|
-
"description": "Defines a string value for the aria-label attribute when header is not used",
|
9735
|
-
"attribute": "aria-label",
|
9736
|
-
"reflects": true
|
9752
|
+
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
9737
9753
|
},
|
9738
9754
|
{
|
9739
|
-
"kind": "
|
9740
|
-
"name": "
|
9741
|
-
"
|
9742
|
-
|
9755
|
+
"kind": "method",
|
9756
|
+
"name": "getArrowIcon",
|
9757
|
+
"privacy": "private",
|
9758
|
+
"return": {
|
9759
|
+
"type": {
|
9760
|
+
"text": ""
|
9761
|
+
}
|
9743
9762
|
},
|
9744
|
-
"
|
9745
|
-
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
9746
|
-
"attribute": "aria-labelledby",
|
9747
|
-
"reflects": true
|
9763
|
+
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
9748
9764
|
},
|
9749
9765
|
{
|
9750
|
-
"kind": "
|
9751
|
-
"name": "
|
9766
|
+
"kind": "method",
|
9767
|
+
"name": "inferDividerType",
|
9768
|
+
"privacy": "private",
|
9769
|
+
"description": "Infers the type of divider based on the kind of slot present.",
|
9770
|
+
"parameters": [
|
9771
|
+
{
|
9772
|
+
"description": "default slot of divider",
|
9773
|
+
"name": "slot"
|
9774
|
+
}
|
9775
|
+
]
|
9776
|
+
}
|
9777
|
+
],
|
9778
|
+
"attributes": [
|
9779
|
+
{
|
9780
|
+
"name": "orientation",
|
9752
9781
|
"type": {
|
9753
|
-
"text": "
|
9782
|
+
"text": "DividerOrientation"
|
9754
9783
|
},
|
9755
|
-
"
|
9756
|
-
"
|
9757
|
-
"
|
9758
|
-
"reflects": true
|
9784
|
+
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
9785
|
+
"default": "horizontal",
|
9786
|
+
"fieldName": "orientation"
|
9759
9787
|
},
|
9760
9788
|
{
|
9761
|
-
"
|
9762
|
-
"name": "ariaDescription",
|
9789
|
+
"name": "variant",
|
9763
9790
|
"type": {
|
9764
|
-
"text": "
|
9791
|
+
"text": "DividerVariant"
|
9765
9792
|
},
|
9766
|
-
"
|
9767
|
-
"
|
9768
|
-
"
|
9769
|
-
"reflects": true
|
9793
|
+
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
9794
|
+
"default": "solid",
|
9795
|
+
"fieldName": "variant"
|
9770
9796
|
},
|
9771
9797
|
{
|
9772
|
-
"
|
9773
|
-
"name": "headerText",
|
9798
|
+
"name": "arrow-direction",
|
9774
9799
|
"type": {
|
9775
|
-
"text": "
|
9800
|
+
"text": "Directions"
|
9776
9801
|
},
|
9777
|
-
"description": "
|
9778
|
-
"
|
9779
|
-
"
|
9802
|
+
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9803
|
+
"default": "'negative'",
|
9804
|
+
"fieldName": "arrowDirection"
|
9780
9805
|
},
|
9781
9806
|
{
|
9782
|
-
"
|
9783
|
-
"name": "descriptionText",
|
9807
|
+
"name": "button-position",
|
9784
9808
|
"type": {
|
9785
|
-
"text": "
|
9809
|
+
"text": "Directions"
|
9786
9810
|
},
|
9787
|
-
"description": "
|
9788
|
-
"
|
9789
|
-
"
|
9790
|
-
}
|
9811
|
+
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9812
|
+
"default": "'negative'",
|
9813
|
+
"fieldName": "buttonPosition"
|
9814
|
+
}
|
9815
|
+
],
|
9816
|
+
"superclass": {
|
9817
|
+
"name": "Component",
|
9818
|
+
"module": "/src/models"
|
9819
|
+
},
|
9820
|
+
"tagName": "mdc-divider",
|
9821
|
+
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
9822
|
+
"customElement": true
|
9823
|
+
}
|
9824
|
+
],
|
9825
|
+
"exports": [
|
9826
|
+
{
|
9827
|
+
"kind": "js",
|
9828
|
+
"name": "default",
|
9829
|
+
"declaration": {
|
9830
|
+
"name": "Divider",
|
9831
|
+
"module": "components/divider/divider.component.js"
|
9832
|
+
}
|
9833
|
+
}
|
9834
|
+
]
|
9835
|
+
},
|
9836
|
+
{
|
9837
|
+
"kind": "javascript-module",
|
9838
|
+
"path": "components/filterchip/filterchip.component.js",
|
9839
|
+
"declarations": [
|
9840
|
+
{
|
9841
|
+
"kind": "class",
|
9842
|
+
"description": "mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\nThey can be found with lists or tables as quick filters.\n\nThis component is built on top of the mdc-chip component.",
|
9843
|
+
"name": "FilterChip",
|
9844
|
+
"members": [
|
9791
9845
|
{
|
9792
9846
|
"kind": "field",
|
9793
|
-
"name": "
|
9847
|
+
"name": "selected",
|
9794
9848
|
"type": {
|
9795
|
-
"text": "
|
9849
|
+
"text": "boolean"
|
9796
9850
|
},
|
9797
|
-
"
|
9798
|
-
"
|
9851
|
+
"default": "false",
|
9852
|
+
"description": "The selected state of the filterchip.",
|
9853
|
+
"attribute": "selected",
|
9799
9854
|
"reflects": true
|
9800
9855
|
},
|
9801
9856
|
{
|
9802
|
-
"kind": "
|
9803
|
-
"name": "
|
9804
|
-
"
|
9805
|
-
|
9806
|
-
|
9807
|
-
|
9808
|
-
|
9809
|
-
|
9857
|
+
"kind": "method",
|
9858
|
+
"name": "setSelected",
|
9859
|
+
"privacy": "private",
|
9860
|
+
"parameters": [
|
9861
|
+
{
|
9862
|
+
"name": "selected",
|
9863
|
+
"type": {
|
9864
|
+
"text": "boolean"
|
9865
|
+
},
|
9866
|
+
"description": "The selected state of the filterchip."
|
9867
|
+
}
|
9868
|
+
],
|
9869
|
+
"description": "Sets the selected state of the filterchip along with the icon.\naria-pressed attribute is also set to true or false."
|
9810
9870
|
},
|
9811
9871
|
{
|
9812
|
-
"kind": "
|
9813
|
-
"name": "
|
9814
|
-
"
|
9815
|
-
|
9872
|
+
"kind": "method",
|
9873
|
+
"name": "executeAction",
|
9874
|
+
"privacy": "protected",
|
9875
|
+
"inheritedFrom": {
|
9876
|
+
"name": "Buttonsimple",
|
9877
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9816
9878
|
},
|
9817
|
-
"
|
9818
|
-
|
9819
|
-
|
9820
|
-
|
9879
|
+
"return": {
|
9880
|
+
"type": {
|
9881
|
+
"text": "void"
|
9882
|
+
}
|
9883
|
+
}
|
9821
9884
|
},
|
9822
9885
|
{
|
9823
9886
|
"kind": "field",
|
9824
|
-
"name": "
|
9887
|
+
"name": "iconName",
|
9825
9888
|
"type": {
|
9826
|
-
"text": "
|
9889
|
+
"text": "IconNames | undefined"
|
9827
9890
|
},
|
9828
|
-
"description": "
|
9829
|
-
"
|
9830
|
-
"
|
9831
|
-
|
9891
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
9892
|
+
"attribute": "icon-name",
|
9893
|
+
"inheritedFrom": {
|
9894
|
+
"name": "IconNameMixin",
|
9895
|
+
"module": "utils/mixins/IconNameMixin.js"
|
9896
|
+
}
|
9832
9897
|
},
|
9833
9898
|
{
|
9834
9899
|
"kind": "field",
|
9835
|
-
"name": "
|
9900
|
+
"name": "color",
|
9836
9901
|
"type": {
|
9837
|
-
"text": "
|
9902
|
+
"text": "ColorType"
|
9838
9903
|
},
|
9839
|
-
"
|
9840
|
-
"
|
9841
|
-
"
|
9842
|
-
"attribute": "focus-trap",
|
9904
|
+
"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",
|
9905
|
+
"default": "default",
|
9906
|
+
"attribute": "color",
|
9843
9907
|
"reflects": true,
|
9844
9908
|
"inheritedFrom": {
|
9845
|
-
"name": "
|
9846
|
-
"module": "
|
9909
|
+
"name": "Chip",
|
9910
|
+
"module": "components/chip/chip.component.js"
|
9847
9911
|
}
|
9848
9912
|
},
|
9849
9913
|
{
|
9850
|
-
"kind": "
|
9851
|
-
"name": "
|
9852
|
-
"
|
9853
|
-
|
9914
|
+
"kind": "field",
|
9915
|
+
"name": "label",
|
9916
|
+
"type": {
|
9917
|
+
"text": "string"
|
9918
|
+
},
|
9919
|
+
"default": "''",
|
9920
|
+
"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.",
|
9921
|
+
"attribute": "label",
|
9922
|
+
"inheritedFrom": {
|
9923
|
+
"name": "Chip",
|
9924
|
+
"module": "components/chip/chip.component.js"
|
9925
|
+
}
|
9854
9926
|
},
|
9855
9927
|
{
|
9856
9928
|
"kind": "method",
|
9857
|
-
"name": "
|
9929
|
+
"name": "renderIcon",
|
9858
9930
|
"privacy": "private",
|
9859
|
-
"
|
9860
|
-
|
9861
|
-
|
9862
|
-
"
|
9863
|
-
"text": "boolean | undefined"
|
9864
|
-
},
|
9865
|
-
"description": "The old value of the visible property."
|
9866
|
-
},
|
9867
|
-
{
|
9868
|
-
"name": "newValue",
|
9869
|
-
"type": {
|
9870
|
-
"text": "boolean"
|
9871
|
-
},
|
9872
|
-
"description": "The new value of the visible property."
|
9931
|
+
"description": "Renders the icon element if available.",
|
9932
|
+
"return": {
|
9933
|
+
"type": {
|
9934
|
+
"text": ""
|
9873
9935
|
}
|
9874
|
-
|
9875
|
-
"
|
9936
|
+
},
|
9937
|
+
"inheritedFrom": {
|
9938
|
+
"name": "Chip",
|
9939
|
+
"module": "components/chip/chip.component.js"
|
9940
|
+
}
|
9876
9941
|
},
|
9877
9942
|
{
|
9878
9943
|
"kind": "field",
|
9879
|
-
"name": "
|
9944
|
+
"name": "autofocus",
|
9880
9945
|
"type": {
|
9881
9946
|
"text": "boolean"
|
9882
9947
|
},
|
9883
|
-
"
|
9884
|
-
"description": "
|
9948
|
+
"default": "false",
|
9949
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
9950
|
+
"attribute": "autofocus",
|
9951
|
+
"reflects": true,
|
9885
9952
|
"inheritedFrom": {
|
9886
|
-
"name": "
|
9887
|
-
"module": "
|
9953
|
+
"name": "Buttonsimple",
|
9954
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9888
9955
|
}
|
9889
9956
|
},
|
9890
9957
|
{
|
9891
|
-
"kind": "
|
9892
|
-
"name": "
|
9893
|
-
"
|
9958
|
+
"kind": "field",
|
9959
|
+
"name": "tabIndex",
|
9960
|
+
"type": {
|
9961
|
+
"text": "number"
|
9962
|
+
},
|
9963
|
+
"default": "0",
|
9964
|
+
"description": "This property specifies the tab order of the element.",
|
9965
|
+
"attribute": "tabIndex",
|
9966
|
+
"reflects": true,
|
9894
9967
|
"inheritedFrom": {
|
9895
|
-
"name": "
|
9896
|
-
"module": "
|
9968
|
+
"name": "Buttonsimple",
|
9969
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9897
9970
|
}
|
9898
9971
|
},
|
9899
9972
|
{
|
9900
|
-
"kind": "
|
9901
|
-
"name": "
|
9902
|
-
"
|
9973
|
+
"kind": "field",
|
9974
|
+
"name": "disabled",
|
9975
|
+
"type": {
|
9976
|
+
"text": "boolean | undefined"
|
9977
|
+
},
|
9978
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
9979
|
+
"default": "undefined",
|
9980
|
+
"attribute": "disabled",
|
9981
|
+
"reflects": true,
|
9903
9982
|
"inheritedFrom": {
|
9904
|
-
"name": "
|
9905
|
-
"module": "
|
9983
|
+
"name": "Buttonsimple",
|
9984
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9906
9985
|
}
|
9907
9986
|
},
|
9908
9987
|
{
|
9909
9988
|
"kind": "field",
|
9910
|
-
"name": "
|
9989
|
+
"name": "active",
|
9911
9990
|
"type": {
|
9912
|
-
"text": "boolean"
|
9991
|
+
"text": "boolean | undefined"
|
9913
9992
|
},
|
9914
|
-
"
|
9915
|
-
"
|
9916
|
-
"attribute": "
|
9993
|
+
"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.",
|
9994
|
+
"default": "undefined",
|
9995
|
+
"attribute": "active",
|
9917
9996
|
"reflects": true,
|
9918
9997
|
"inheritedFrom": {
|
9919
|
-
"name": "
|
9920
|
-
"module": "
|
9998
|
+
"name": "Buttonsimple",
|
9999
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9921
10000
|
}
|
9922
10001
|
},
|
9923
10002
|
{
|
9924
|
-
"kind": "
|
9925
|
-
"name": "
|
9926
|
-
"
|
9927
|
-
|
9928
|
-
|
9929
|
-
|
9930
|
-
|
9931
|
-
|
9932
|
-
|
9933
|
-
}
|
9934
|
-
],
|
10003
|
+
"kind": "field",
|
10004
|
+
"name": "softDisabled",
|
10005
|
+
"type": {
|
10006
|
+
"text": "boolean | undefined"
|
10007
|
+
},
|
10008
|
+
"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.",
|
10009
|
+
"default": "undefined",
|
10010
|
+
"attribute": "soft-disabled",
|
10011
|
+
"reflects": true,
|
9935
10012
|
"inheritedFrom": {
|
9936
|
-
"name": "
|
9937
|
-
"module": "
|
10013
|
+
"name": "Buttonsimple",
|
10014
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9938
10015
|
}
|
9939
10016
|
},
|
9940
10017
|
{
|
9941
|
-
"kind": "
|
9942
|
-
"name": "
|
9943
|
-
"
|
9944
|
-
|
10018
|
+
"kind": "field",
|
10019
|
+
"name": "size",
|
10020
|
+
"type": {
|
10021
|
+
"text": "ButtonSize"
|
10022
|
+
},
|
10023
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
10024
|
+
"default": "32",
|
10025
|
+
"attribute": "size",
|
10026
|
+
"reflects": true,
|
9945
10027
|
"inheritedFrom": {
|
9946
|
-
"name": "
|
9947
|
-
"module": "
|
10028
|
+
"name": "Buttonsimple",
|
10029
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9948
10030
|
}
|
9949
10031
|
},
|
9950
10032
|
{
|
9951
|
-
"kind": "
|
9952
|
-
"name": "
|
9953
|
-
"
|
9954
|
-
"
|
10033
|
+
"kind": "field",
|
10034
|
+
"name": "role",
|
10035
|
+
"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.",
|
10036
|
+
"default": "button",
|
10037
|
+
"attribute": "role",
|
10038
|
+
"reflects": true,
|
9955
10039
|
"inheritedFrom": {
|
9956
|
-
"name": "
|
9957
|
-
"module": "
|
10040
|
+
"name": "Buttonsimple",
|
10041
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9958
10042
|
}
|
9959
10043
|
},
|
9960
10044
|
{
|
9961
|
-
"kind": "
|
9962
|
-
"name": "
|
9963
|
-
"
|
9964
|
-
|
9965
|
-
{
|
9966
|
-
"name": "element",
|
9967
|
-
"type": {
|
9968
|
-
"text": "HTMLElement"
|
9969
|
-
},
|
9970
|
-
"description": "The element to check."
|
9971
|
-
}
|
9972
|
-
],
|
9973
|
-
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
9974
|
-
"return": {
|
9975
|
-
"type": {
|
9976
|
-
"text": ""
|
9977
|
-
}
|
10045
|
+
"kind": "field",
|
10046
|
+
"name": "ariaStateKey",
|
10047
|
+
"type": {
|
10048
|
+
"text": "string | undefined"
|
9978
10049
|
},
|
10050
|
+
"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`",
|
10051
|
+
"default": "'aria-pressed' (when)",
|
10052
|
+
"attribute": "ariaStateKey",
|
10053
|
+
"reflects": true,
|
9979
10054
|
"inheritedFrom": {
|
9980
|
-
"name": "
|
9981
|
-
"module": "
|
10055
|
+
"name": "Buttonsimple",
|
10056
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
9982
10057
|
}
|
9983
10058
|
},
|
9984
10059
|
{
|
9985
|
-
"kind": "
|
9986
|
-
"name": "
|
9987
|
-
"
|
9988
|
-
|
9989
|
-
{
|
9990
|
-
"name": "element",
|
9991
|
-
"type": {
|
9992
|
-
"text": "HTMLElement"
|
9993
|
-
},
|
9994
|
-
"description": "The element to check."
|
9995
|
-
}
|
9996
|
-
],
|
9997
|
-
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
9998
|
-
"return": {
|
9999
|
-
"type": {
|
10000
|
-
"text": ""
|
10001
|
-
}
|
10060
|
+
"kind": "field",
|
10061
|
+
"name": "type",
|
10062
|
+
"type": {
|
10063
|
+
"text": "ButtonType"
|
10002
10064
|
},
|
10065
|
+
"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.",
|
10066
|
+
"default": "button",
|
10067
|
+
"attribute": "type",
|
10068
|
+
"reflects": true,
|
10003
10069
|
"inheritedFrom": {
|
10004
|
-
"name": "
|
10005
|
-
"module": "
|
10070
|
+
"name": "Buttonsimple",
|
10071
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10006
10072
|
}
|
10007
10073
|
},
|
10008
10074
|
{
|
10009
10075
|
"kind": "method",
|
10010
|
-
"name": "
|
10011
|
-
"privacy": "
|
10076
|
+
"name": "setActive",
|
10077
|
+
"privacy": "protected",
|
10012
10078
|
"parameters": [
|
10013
10079
|
{
|
10014
10080
|
"name": "element",
|
10015
10081
|
"type": {
|
10016
10082
|
"text": "HTMLElement"
|
10017
10083
|
},
|
10018
|
-
"description": "The element
|
10019
|
-
}
|
10020
|
-
],
|
10021
|
-
"description": "Determines if the element is not visible in the DOM.",
|
10022
|
-
"return": {
|
10023
|
-
"type": {
|
10024
|
-
"text": ""
|
10025
|
-
}
|
10026
|
-
},
|
10027
|
-
"inheritedFrom": {
|
10028
|
-
"name": "FocusTrapMixin",
|
10029
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10030
|
-
}
|
10031
|
-
},
|
10032
|
-
{
|
10033
|
-
"kind": "method",
|
10034
|
-
"name": "hasHiddenStyle",
|
10035
|
-
"privacy": "private",
|
10036
|
-
"parameters": [
|
10084
|
+
"description": "The button element"
|
10085
|
+
},
|
10037
10086
|
{
|
10038
|
-
"name": "
|
10087
|
+
"name": "active",
|
10088
|
+
"optional": true,
|
10039
10089
|
"type": {
|
10040
|
-
"text": "
|
10090
|
+
"text": "boolean"
|
10041
10091
|
},
|
10042
|
-
"description": "The
|
10092
|
+
"description": "The active state of the element"
|
10043
10093
|
}
|
10044
10094
|
],
|
10045
|
-
"description": "
|
10046
|
-
"return": {
|
10047
|
-
"type": {
|
10048
|
-
"text": ""
|
10049
|
-
}
|
10050
|
-
},
|
10095
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
10051
10096
|
"inheritedFrom": {
|
10052
|
-
"name": "
|
10053
|
-
"module": "
|
10097
|
+
"name": "Buttonsimple",
|
10098
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10054
10099
|
}
|
10055
10100
|
},
|
10056
10101
|
{
|
10057
10102
|
"kind": "method",
|
10058
|
-
"name": "
|
10103
|
+
"name": "setSoftDisabled",
|
10059
10104
|
"privacy": "private",
|
10060
10105
|
"parameters": [
|
10061
10106
|
{
|
@@ -10063,23 +10108,26 @@
|
|
10063
10108
|
"type": {
|
10064
10109
|
"text": "HTMLElement"
|
10065
10110
|
},
|
10066
|
-
"description": "The element
|
10111
|
+
"description": "The button element."
|
10112
|
+
},
|
10113
|
+
{
|
10114
|
+
"name": "softDisabled",
|
10115
|
+
"optional": true,
|
10116
|
+
"type": {
|
10117
|
+
"text": "boolean"
|
10118
|
+
},
|
10119
|
+
"description": "The soft-disabled state."
|
10067
10120
|
}
|
10068
10121
|
],
|
10069
|
-
"description": "
|
10070
|
-
"return": {
|
10071
|
-
"type": {
|
10072
|
-
"text": ""
|
10073
|
-
}
|
10074
|
-
},
|
10122
|
+
"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.",
|
10075
10123
|
"inheritedFrom": {
|
10076
|
-
"name": "
|
10077
|
-
"module": "
|
10124
|
+
"name": "Buttonsimple",
|
10125
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10078
10126
|
}
|
10079
10127
|
},
|
10080
10128
|
{
|
10081
10129
|
"kind": "method",
|
10082
|
-
"name": "
|
10130
|
+
"name": "setDisabled",
|
10083
10131
|
"privacy": "private",
|
10084
10132
|
"parameters": [
|
10085
10133
|
{
|
@@ -10087,557 +10135,314 @@
|
|
10087
10135
|
"type": {
|
10088
10136
|
"text": "HTMLElement"
|
10089
10137
|
},
|
10090
|
-
"description": "The element
|
10138
|
+
"description": "The button element."
|
10139
|
+
},
|
10140
|
+
{
|
10141
|
+
"name": "disabled",
|
10142
|
+
"type": {
|
10143
|
+
"text": "boolean"
|
10144
|
+
},
|
10145
|
+
"description": "The disabled state."
|
10091
10146
|
}
|
10092
10147
|
],
|
10093
|
-
"description": "
|
10094
|
-
"return": {
|
10095
|
-
"type": {
|
10096
|
-
"text": ""
|
10097
|
-
}
|
10098
|
-
},
|
10148
|
+
"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.",
|
10099
10149
|
"inheritedFrom": {
|
10100
|
-
"name": "
|
10101
|
-
"module": "
|
10150
|
+
"name": "Buttonsimple",
|
10151
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10102
10152
|
}
|
10103
10153
|
},
|
10104
10154
|
{
|
10105
10155
|
"kind": "method",
|
10106
|
-
"name": "
|
10156
|
+
"name": "triggerClickEvent",
|
10107
10157
|
"privacy": "private",
|
10108
|
-
"parameters": [
|
10109
|
-
{
|
10110
|
-
"name": "element",
|
10111
|
-
"type": {
|
10112
|
-
"text": "any"
|
10113
|
-
},
|
10114
|
-
"description": "The element to check."
|
10115
|
-
}
|
10116
|
-
],
|
10117
|
-
"description": "Checks if the element is disabled.",
|
10118
|
-
"return": {
|
10119
|
-
"type": {
|
10120
|
-
"text": ""
|
10121
|
-
}
|
10122
|
-
},
|
10123
10158
|
"inheritedFrom": {
|
10124
|
-
"name": "
|
10125
|
-
"module": "
|
10159
|
+
"name": "Buttonsimple",
|
10160
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10126
10161
|
}
|
10127
10162
|
},
|
10128
10163
|
{
|
10129
10164
|
"kind": "method",
|
10130
|
-
"name": "
|
10165
|
+
"name": "handleBlur",
|
10131
10166
|
"privacy": "private",
|
10132
|
-
"
|
10133
|
-
{
|
10134
|
-
"name": "element",
|
10135
|
-
"type": {
|
10136
|
-
"text": "HTMLElement"
|
10137
|
-
},
|
10138
|
-
"description": "The element to check."
|
10139
|
-
}
|
10140
|
-
],
|
10141
|
-
"description": "Checks if the element is not tabbable.",
|
10142
|
-
"return": {
|
10143
|
-
"type": {
|
10144
|
-
"text": ""
|
10145
|
-
}
|
10146
|
-
},
|
10167
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
10147
10168
|
"inheritedFrom": {
|
10148
|
-
"name": "
|
10149
|
-
"module": "
|
10169
|
+
"name": "Buttonsimple",
|
10170
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10150
10171
|
}
|
10151
10172
|
},
|
10152
10173
|
{
|
10153
10174
|
"kind": "method",
|
10154
|
-
"name": "
|
10175
|
+
"name": "handleKeyDown",
|
10155
10176
|
"privacy": "private",
|
10156
|
-
"return": {
|
10157
|
-
"type": {
|
10158
|
-
"text": ""
|
10159
|
-
}
|
10160
|
-
},
|
10161
10177
|
"parameters": [
|
10162
10178
|
{
|
10163
|
-
"name": "
|
10179
|
+
"name": "event",
|
10164
10180
|
"type": {
|
10165
|
-
"text": "
|
10181
|
+
"text": "KeyboardEvent"
|
10166
10182
|
},
|
10167
|
-
"description": "The
|
10183
|
+
"description": "The keyboard event."
|
10168
10184
|
}
|
10169
10185
|
],
|
10170
|
-
"description": "
|
10186
|
+
"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.",
|
10171
10187
|
"inheritedFrom": {
|
10172
|
-
"name": "
|
10173
|
-
"module": "
|
10188
|
+
"name": "Buttonsimple",
|
10189
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10174
10190
|
}
|
10175
10191
|
},
|
10176
10192
|
{
|
10177
10193
|
"kind": "method",
|
10178
|
-
"name": "
|
10194
|
+
"name": "handleKeyUp",
|
10179
10195
|
"privacy": "private",
|
10180
10196
|
"parameters": [
|
10181
10197
|
{
|
10182
|
-
"name": "
|
10198
|
+
"name": "event",
|
10183
10199
|
"type": {
|
10184
|
-
"text": "
|
10200
|
+
"text": "KeyboardEvent"
|
10185
10201
|
},
|
10186
|
-
"description": "The
|
10202
|
+
"description": "The keyboard event."
|
10187
10203
|
}
|
10188
10204
|
],
|
10189
|
-
"description": "
|
10190
|
-
"return": {
|
10191
|
-
"type": {
|
10192
|
-
"text": ""
|
10193
|
-
}
|
10194
|
-
},
|
10205
|
+
"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.",
|
10195
10206
|
"inheritedFrom": {
|
10196
|
-
"name": "
|
10197
|
-
"module": "
|
10207
|
+
"name": "Buttonsimple",
|
10208
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
10198
10209
|
}
|
10199
|
-
}
|
10210
|
+
}
|
10211
|
+
],
|
10212
|
+
"attributes": [
|
10200
10213
|
{
|
10201
|
-
"
|
10202
|
-
"
|
10203
|
-
|
10204
|
-
"return": {
|
10205
|
-
"type": {
|
10206
|
-
"text": ""
|
10207
|
-
}
|
10214
|
+
"name": "selected",
|
10215
|
+
"type": {
|
10216
|
+
"text": "boolean"
|
10208
10217
|
},
|
10209
|
-
"parameters": [
|
10210
|
-
{
|
10211
|
-
"name": "root",
|
10212
|
-
"type": {
|
10213
|
-
"text": "ShadowRoot | HTMLElement"
|
10214
|
-
},
|
10215
|
-
"description": "The root element to search for focusable elements."
|
10216
|
-
},
|
10217
|
-
{
|
10218
|
-
"name": "matches",
|
10219
|
-
"default": "new Set()",
|
10220
|
-
"type": {
|
10221
|
-
"text": "Set<HTMLElement>"
|
10222
|
-
},
|
10223
|
-
"description": "The set of focusable elements."
|
10224
|
-
}
|
10225
|
-
],
|
10226
|
-
"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.",
|
10227
|
-
"inheritedFrom": {
|
10228
|
-
"name": "FocusTrapMixin",
|
10229
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10230
|
-
}
|
10231
|
-
},
|
10232
|
-
{
|
10233
|
-
"kind": "method",
|
10234
|
-
"name": "setFocusableElements",
|
10235
|
-
"privacy": "private",
|
10236
|
-
"description": "Updates the list of focusable elements within the component's shadow root.",
|
10237
|
-
"inheritedFrom": {
|
10238
|
-
"name": "FocusTrapMixin",
|
10239
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10240
|
-
}
|
10241
|
-
},
|
10242
|
-
{
|
10243
|
-
"kind": "method",
|
10244
|
-
"name": "setInitialFocus",
|
10245
|
-
"privacy": "public",
|
10246
|
-
"parameters": [
|
10247
|
-
{
|
10248
|
-
"name": "elementIndexToReceiveFocus",
|
10249
|
-
"default": "0",
|
10250
|
-
"type": {
|
10251
|
-
"text": "number"
|
10252
|
-
},
|
10253
|
-
"description": "The index of the preferable element to focus."
|
10254
|
-
}
|
10255
|
-
],
|
10256
|
-
"description": "Sets the initial focus within the container.",
|
10257
|
-
"inheritedFrom": {
|
10258
|
-
"name": "FocusTrapMixin",
|
10259
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10260
|
-
}
|
10261
|
-
},
|
10262
|
-
{
|
10263
|
-
"kind": "method",
|
10264
|
-
"name": "calculateNextIndex",
|
10265
|
-
"privacy": "private",
|
10266
|
-
"parameters": [
|
10267
|
-
{
|
10268
|
-
"name": "currentIndex",
|
10269
|
-
"type": {
|
10270
|
-
"text": "number"
|
10271
|
-
},
|
10272
|
-
"description": "The current index."
|
10273
|
-
},
|
10274
|
-
{
|
10275
|
-
"name": "step",
|
10276
|
-
"type": {
|
10277
|
-
"text": "number"
|
10278
|
-
},
|
10279
|
-
"description": "The step to calculate the next index."
|
10280
|
-
}
|
10281
|
-
],
|
10282
|
-
"description": "Calculates the next index for the focus trap.",
|
10283
|
-
"return": {
|
10284
|
-
"type": {
|
10285
|
-
"text": ""
|
10286
|
-
}
|
10287
|
-
},
|
10288
|
-
"inheritedFrom": {
|
10289
|
-
"name": "FocusTrapMixin",
|
10290
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10291
|
-
}
|
10292
|
-
},
|
10293
|
-
{
|
10294
|
-
"kind": "method",
|
10295
|
-
"name": "getDeepActiveElement",
|
10296
|
-
"privacy": "private",
|
10297
|
-
"description": "Returns the deepest active element in the shadow DOM.",
|
10298
|
-
"return": {
|
10299
|
-
"type": {
|
10300
|
-
"text": ""
|
10301
|
-
}
|
10302
|
-
},
|
10303
|
-
"inheritedFrom": {
|
10304
|
-
"name": "FocusTrapMixin",
|
10305
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10306
|
-
}
|
10307
|
-
},
|
10308
|
-
{
|
10309
|
-
"kind": "method",
|
10310
|
-
"name": "findElement",
|
10311
|
-
"privacy": "private",
|
10312
|
-
"parameters": [
|
10313
|
-
{
|
10314
|
-
"name": "activeElement",
|
10315
|
-
"type": {
|
10316
|
-
"text": "HTMLElement"
|
10317
|
-
},
|
10318
|
-
"description": "The active element."
|
10319
|
-
}
|
10320
|
-
],
|
10321
|
-
"description": "Finds the index of the active element within the focusable elements.",
|
10322
|
-
"return": {
|
10323
|
-
"type": {
|
10324
|
-
"text": ""
|
10325
|
-
}
|
10326
|
-
},
|
10327
|
-
"inheritedFrom": {
|
10328
|
-
"name": "FocusTrapMixin",
|
10329
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10330
|
-
}
|
10331
|
-
},
|
10332
|
-
{
|
10333
|
-
"kind": "method",
|
10334
|
-
"name": "isEqualFocusNode",
|
10335
|
-
"privacy": "private",
|
10336
|
-
"parameters": [
|
10337
|
-
{
|
10338
|
-
"name": "activeElement",
|
10339
|
-
"type": {
|
10340
|
-
"text": "HTMLElement"
|
10341
|
-
},
|
10342
|
-
"description": "The active element."
|
10343
|
-
},
|
10344
|
-
{
|
10345
|
-
"name": "element",
|
10346
|
-
"type": {
|
10347
|
-
"text": "HTMLElement"
|
10348
|
-
},
|
10349
|
-
"description": "The element to compare."
|
10350
|
-
}
|
10351
|
-
],
|
10352
|
-
"description": "Checks if the active element is equal to the given element.",
|
10353
|
-
"return": {
|
10354
|
-
"type": {
|
10355
|
-
"text": ""
|
10356
|
-
}
|
10357
|
-
},
|
10358
|
-
"inheritedFrom": {
|
10359
|
-
"name": "FocusTrapMixin",
|
10360
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10361
|
-
}
|
10362
|
-
},
|
10363
|
-
{
|
10364
|
-
"kind": "method",
|
10365
|
-
"name": "trapFocus",
|
10366
|
-
"privacy": "private",
|
10367
|
-
"parameters": [
|
10368
|
-
{
|
10369
|
-
"name": "event",
|
10370
|
-
"type": {
|
10371
|
-
"text": "KeyboardEvent"
|
10372
|
-
}
|
10373
|
-
},
|
10374
|
-
{
|
10375
|
-
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
10376
|
-
"name": "direction"
|
10377
|
-
}
|
10378
|
-
],
|
10379
|
-
"description": "Traps focus within the container.",
|
10380
|
-
"inheritedFrom": {
|
10381
|
-
"name": "FocusTrapMixin",
|
10382
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10383
|
-
}
|
10384
|
-
},
|
10385
|
-
{
|
10386
|
-
"kind": "method",
|
10387
|
-
"name": "handleTabKeydown",
|
10388
|
-
"privacy": "private",
|
10389
|
-
"parameters": [
|
10390
|
-
{
|
10391
|
-
"name": "event",
|
10392
|
-
"type": {
|
10393
|
-
"text": "KeyboardEvent"
|
10394
|
-
},
|
10395
|
-
"description": "The keyboard event."
|
10396
|
-
}
|
10397
|
-
],
|
10398
|
-
"description": "Traps focus within the container.",
|
10399
|
-
"inheritedFrom": {
|
10400
|
-
"name": "FocusTrapMixin",
|
10401
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
10402
|
-
}
|
10403
|
-
},
|
10404
|
-
{
|
10405
|
-
"kind": "method",
|
10406
|
-
"name": "renderFooter",
|
10407
|
-
"privacy": "protected",
|
10408
|
-
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
10409
|
-
"return": {
|
10410
|
-
"type": {
|
10411
|
-
"text": ""
|
10412
|
-
}
|
10413
|
-
},
|
10414
|
-
"inheritedFrom": {
|
10415
|
-
"name": "FooterMixin",
|
10416
|
-
"module": "utils/mixins/FooterMixin.js"
|
10417
|
-
}
|
10418
|
-
}
|
10419
|
-
],
|
10420
|
-
"events": [
|
10421
|
-
{
|
10422
|
-
"description": "(React: onShown) Dispatched when the dialog is shown",
|
10423
|
-
"name": "shown",
|
10424
|
-
"reactName": "onShown"
|
10425
|
-
},
|
10426
|
-
{
|
10427
|
-
"description": "(React: onHidden) Dispatched when the dialog is hidden",
|
10428
|
-
"name": "hidden",
|
10429
|
-
"reactName": "onHidden"
|
10430
|
-
},
|
10431
|
-
{
|
10432
|
-
"description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
|
10433
|
-
"name": "created",
|
10434
|
-
"reactName": "onCreated"
|
10435
|
-
},
|
10436
|
-
{
|
10437
|
-
"description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
|
10438
|
-
"name": "destroyed",
|
10439
|
-
"reactName": "onDestroyed"
|
10440
|
-
},
|
10441
|
-
{
|
10442
|
-
"description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
|
10443
|
-
"name": "close",
|
10444
|
-
"reactName": "onClose"
|
10445
|
-
}
|
10446
|
-
],
|
10447
|
-
"attributes": [
|
10448
|
-
{
|
10449
|
-
"name": "id",
|
10450
|
-
"type": {
|
10451
|
-
"text": "string"
|
10452
|
-
},
|
10453
|
-
"default": "''",
|
10454
|
-
"description": "The unique ID of the dialog",
|
10455
|
-
"fieldName": "id"
|
10456
|
-
},
|
10457
|
-
{
|
10458
|
-
"name": "triggerId",
|
10459
|
-
"type": {
|
10460
|
-
"text": "string | undefined"
|
10461
|
-
},
|
10462
|
-
"description": "The ID of the element that triggers the dialog",
|
10463
|
-
"default": "undefined",
|
10464
|
-
"fieldName": "triggerId"
|
10465
|
-
},
|
10466
|
-
{
|
10467
|
-
"name": "visible",
|
10468
|
-
"type": {
|
10469
|
-
"text": "boolean"
|
10470
|
-
},
|
10471
|
-
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
10472
10218
|
"default": "false",
|
10473
|
-
"
|
10474
|
-
|
10475
|
-
{
|
10476
|
-
"name": "z-index",
|
10477
|
-
"type": {
|
10478
|
-
"text": "number"
|
10479
|
-
},
|
10480
|
-
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
10481
|
-
"default": "1000",
|
10482
|
-
"fieldName": "zIndex"
|
10483
|
-
},
|
10484
|
-
{
|
10485
|
-
"name": "size",
|
10486
|
-
"type": {
|
10487
|
-
"text": "DialogSize"
|
10488
|
-
},
|
10489
|
-
"description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
10490
|
-
"default": "small",
|
10491
|
-
"fieldName": "size"
|
10492
|
-
},
|
10493
|
-
{
|
10494
|
-
"name": "variant",
|
10495
|
-
"type": {
|
10496
|
-
"text": "DialogVariant"
|
10497
|
-
},
|
10498
|
-
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
10499
|
-
"default": "default",
|
10500
|
-
"fieldName": "variant"
|
10219
|
+
"description": "The selected state of the filterchip.",
|
10220
|
+
"fieldName": "selected"
|
10501
10221
|
},
|
10502
10222
|
{
|
10503
|
-
"name": "
|
10223
|
+
"name": "icon-name",
|
10504
10224
|
"type": {
|
10505
|
-
"text": "
|
10225
|
+
"text": "IconNames | undefined"
|
10506
10226
|
},
|
10507
|
-
"
|
10508
|
-
"
|
10509
|
-
"
|
10227
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
10228
|
+
"fieldName": "iconName",
|
10229
|
+
"inheritedFrom": {
|
10230
|
+
"name": "IconNameMixin",
|
10231
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
10232
|
+
}
|
10510
10233
|
},
|
10511
10234
|
{
|
10512
|
-
"name": "
|
10235
|
+
"name": "color",
|
10513
10236
|
"type": {
|
10514
|
-
"text": "
|
10237
|
+
"text": "ColorType"
|
10515
10238
|
},
|
10516
|
-
"
|
10517
|
-
"
|
10518
|
-
"fieldName": "
|
10239
|
+
"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",
|
10240
|
+
"default": "default",
|
10241
|
+
"fieldName": "color",
|
10242
|
+
"inheritedFrom": {
|
10243
|
+
"name": "Chip",
|
10244
|
+
"module": "src/components/chip/chip.component.ts"
|
10245
|
+
}
|
10519
10246
|
},
|
10520
10247
|
{
|
10521
|
-
"name": "
|
10248
|
+
"name": "label",
|
10522
10249
|
"type": {
|
10523
|
-
"text": "string
|
10250
|
+
"text": "string"
|
10524
10251
|
},
|
10525
|
-
"default": "
|
10526
|
-
"description": "
|
10527
|
-
"fieldName": "
|
10252
|
+
"default": "''",
|
10253
|
+
"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.",
|
10254
|
+
"fieldName": "label",
|
10255
|
+
"inheritedFrom": {
|
10256
|
+
"name": "Chip",
|
10257
|
+
"module": "src/components/chip/chip.component.ts"
|
10258
|
+
}
|
10528
10259
|
},
|
10529
10260
|
{
|
10530
|
-
"name": "
|
10261
|
+
"name": "autofocus",
|
10531
10262
|
"type": {
|
10532
|
-
"text": "
|
10263
|
+
"text": "boolean"
|
10533
10264
|
},
|
10534
|
-
"default": "
|
10535
|
-
"description": "
|
10536
|
-
"fieldName": "
|
10265
|
+
"default": "false",
|
10266
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
10267
|
+
"fieldName": "autofocus",
|
10268
|
+
"inheritedFrom": {
|
10269
|
+
"name": "Buttonsimple",
|
10270
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10271
|
+
}
|
10537
10272
|
},
|
10538
10273
|
{
|
10539
|
-
"name": "
|
10274
|
+
"name": "tabIndex",
|
10540
10275
|
"type": {
|
10541
|
-
"text": "
|
10276
|
+
"text": "number"
|
10542
10277
|
},
|
10543
|
-
"default": "
|
10544
|
-
"description": "
|
10545
|
-
"fieldName": "
|
10278
|
+
"default": "0",
|
10279
|
+
"description": "This property specifies the tab order of the element.",
|
10280
|
+
"fieldName": "tabIndex",
|
10281
|
+
"inheritedFrom": {
|
10282
|
+
"name": "Buttonsimple",
|
10283
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10284
|
+
}
|
10546
10285
|
},
|
10547
10286
|
{
|
10548
|
-
"name": "
|
10287
|
+
"name": "disabled",
|
10549
10288
|
"type": {
|
10550
|
-
"text": "
|
10289
|
+
"text": "boolean | undefined"
|
10551
10290
|
},
|
10552
|
-
"description": "
|
10553
|
-
"
|
10291
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
10292
|
+
"default": "undefined",
|
10293
|
+
"fieldName": "disabled",
|
10294
|
+
"inheritedFrom": {
|
10295
|
+
"name": "Buttonsimple",
|
10296
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10297
|
+
}
|
10554
10298
|
},
|
10555
10299
|
{
|
10556
|
-
"name": "
|
10300
|
+
"name": "active",
|
10557
10301
|
"type": {
|
10558
|
-
"text": "
|
10302
|
+
"text": "boolean | undefined"
|
10559
10303
|
},
|
10560
|
-
"description": "
|
10561
|
-
"
|
10304
|
+
"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.",
|
10305
|
+
"default": "undefined",
|
10306
|
+
"fieldName": "active",
|
10307
|
+
"inheritedFrom": {
|
10308
|
+
"name": "Buttonsimple",
|
10309
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10310
|
+
}
|
10562
10311
|
},
|
10563
10312
|
{
|
10564
|
-
"name": "
|
10313
|
+
"name": "soft-disabled",
|
10565
10314
|
"type": {
|
10566
|
-
"text": "
|
10315
|
+
"text": "boolean | undefined"
|
10567
10316
|
},
|
10568
|
-
"description": "
|
10569
|
-
"
|
10317
|
+
"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.",
|
10318
|
+
"default": "undefined",
|
10319
|
+
"fieldName": "softDisabled",
|
10320
|
+
"inheritedFrom": {
|
10321
|
+
"name": "Buttonsimple",
|
10322
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10323
|
+
}
|
10570
10324
|
},
|
10571
10325
|
{
|
10572
|
-
"name": "
|
10326
|
+
"name": "size",
|
10573
10327
|
"type": {
|
10574
|
-
"text": "
|
10328
|
+
"text": "ButtonSize"
|
10575
10329
|
},
|
10576
|
-
"description": "
|
10577
|
-
"
|
10330
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
10331
|
+
"default": "32",
|
10332
|
+
"fieldName": "size",
|
10333
|
+
"inheritedFrom": {
|
10334
|
+
"name": "Buttonsimple",
|
10335
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10336
|
+
}
|
10578
10337
|
},
|
10579
10338
|
{
|
10580
10339
|
"name": "role",
|
10581
|
-
"
|
10582
|
-
|
10583
|
-
|
10584
|
-
"
|
10585
|
-
|
10586
|
-
|
10340
|
+
"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.",
|
10341
|
+
"default": "button",
|
10342
|
+
"fieldName": "role",
|
10343
|
+
"inheritedFrom": {
|
10344
|
+
"name": "Buttonsimple",
|
10345
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10346
|
+
}
|
10587
10347
|
},
|
10588
10348
|
{
|
10589
|
-
"name": "
|
10349
|
+
"name": "ariaStateKey",
|
10590
10350
|
"type": {
|
10591
|
-
"text": "
|
10351
|
+
"text": "string | undefined"
|
10592
10352
|
},
|
10593
|
-
"description": "
|
10594
|
-
"default": "
|
10595
|
-
"fieldName": "
|
10353
|
+
"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`",
|
10354
|
+
"default": "'aria-pressed' (when)",
|
10355
|
+
"fieldName": "ariaStateKey",
|
10356
|
+
"inheritedFrom": {
|
10357
|
+
"name": "Buttonsimple",
|
10358
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10359
|
+
}
|
10596
10360
|
},
|
10597
10361
|
{
|
10598
|
-
"name": "
|
10362
|
+
"name": "type",
|
10599
10363
|
"type": {
|
10600
|
-
"text": "
|
10364
|
+
"text": "ButtonType"
|
10601
10365
|
},
|
10602
|
-
"description": "
|
10603
|
-
"default": "
|
10604
|
-
"fieldName": "
|
10366
|
+
"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.",
|
10367
|
+
"default": "button",
|
10368
|
+
"fieldName": "type",
|
10369
|
+
"inheritedFrom": {
|
10370
|
+
"name": "Buttonsimple",
|
10371
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10372
|
+
}
|
10373
|
+
}
|
10374
|
+
],
|
10375
|
+
"superclass": {
|
10376
|
+
"name": "Chip",
|
10377
|
+
"module": "/src/components/chip/chip.component"
|
10378
|
+
},
|
10379
|
+
"tagName": "mdc-filterchip",
|
10380
|
+
"jsDoc": "/**\n * mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\n * They can be found with lists or tables as quick filters.\n *\n * This component is built on top of the mdc-chip component.\n *\n * @tagname mdc-filterchip\n *\n */",
|
10381
|
+
"customElement": true,
|
10382
|
+
"cssProperties": [
|
10383
|
+
{
|
10384
|
+
"description": "The color of the chip.",
|
10385
|
+
"name": "--mdc-chip-color",
|
10386
|
+
"inheritedFrom": {
|
10387
|
+
"name": "Chip",
|
10388
|
+
"module": "src/components/chip/chip.component.ts"
|
10389
|
+
}
|
10605
10390
|
},
|
10606
10391
|
{
|
10607
|
-
"
|
10608
|
-
"
|
10609
|
-
"text": "boolean"
|
10610
|
-
},
|
10611
|
-
"default": "true",
|
10612
|
-
"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.",
|
10613
|
-
"fieldName": "shouldFocusTrapWrap",
|
10392
|
+
"description": "The border color of the chip.",
|
10393
|
+
"name": "--mdc-chip-border-color",
|
10614
10394
|
"inheritedFrom": {
|
10615
|
-
"name": "
|
10616
|
-
"module": "src/
|
10395
|
+
"name": "Chip",
|
10396
|
+
"module": "src/components/chip/chip.component.ts"
|
10397
|
+
}
|
10398
|
+
},
|
10399
|
+
{
|
10400
|
+
"description": "The background color of the chip.",
|
10401
|
+
"name": "--mdc-chip-background-color",
|
10402
|
+
"inheritedFrom": {
|
10403
|
+
"name": "Chip",
|
10404
|
+
"module": "src/components/chip/chip.component.ts"
|
10617
10405
|
}
|
10618
10406
|
}
|
10619
10407
|
],
|
10620
|
-
"
|
10408
|
+
"events": [
|
10621
10409
|
{
|
10622
|
-
"
|
10623
|
-
"
|
10410
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
10411
|
+
"name": "click",
|
10412
|
+
"reactName": "onClick",
|
10413
|
+
"inheritedFrom": {
|
10414
|
+
"name": "Buttonsimple",
|
10415
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10416
|
+
}
|
10624
10417
|
},
|
10625
10418
|
{
|
10626
|
-
"
|
10627
|
-
"
|
10419
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
10420
|
+
"name": "keydown",
|
10421
|
+
"reactName": "onKeyDown",
|
10422
|
+
"inheritedFrom": {
|
10423
|
+
"name": "Buttonsimple",
|
10424
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10425
|
+
}
|
10628
10426
|
},
|
10629
10427
|
{
|
10630
|
-
"
|
10631
|
-
"
|
10428
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
10429
|
+
"name": "keyup",
|
10430
|
+
"reactName": "onKeyUp",
|
10431
|
+
"inheritedFrom": {
|
10432
|
+
"name": "Buttonsimple",
|
10433
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10434
|
+
}
|
10435
|
+
},
|
10436
|
+
{
|
10437
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
10438
|
+
"name": "focus",
|
10439
|
+
"reactName": "onFocus",
|
10440
|
+
"inheritedFrom": {
|
10441
|
+
"name": "Buttonsimple",
|
10442
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
10443
|
+
}
|
10632
10444
|
}
|
10633
|
-
]
|
10634
|
-
"superclass": {
|
10635
|
-
"name": "Component",
|
10636
|
-
"module": "/src/models"
|
10637
|
-
},
|
10638
|
-
"tagName": "mdc-dialog",
|
10639
|
-
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
10640
|
-
"customElement": true
|
10445
|
+
]
|
10641
10446
|
}
|
10642
10447
|
],
|
10643
10448
|
"exports": [
|
@@ -10645,617 +10450,810 @@
|
|
10645
10450
|
"kind": "js",
|
10646
10451
|
"name": "default",
|
10647
10452
|
"declaration": {
|
10648
|
-
"name": "
|
10649
|
-
"module": "components/
|
10453
|
+
"name": "FilterChip",
|
10454
|
+
"module": "components/filterchip/filterchip.component.js"
|
10650
10455
|
}
|
10651
10456
|
}
|
10652
10457
|
]
|
10653
10458
|
},
|
10654
10459
|
{
|
10655
10460
|
"kind": "javascript-module",
|
10656
|
-
"path": "components/
|
10461
|
+
"path": "components/dialog/dialog.component.js",
|
10657
10462
|
"declarations": [
|
10658
10463
|
{
|
10659
10464
|
"kind": "class",
|
10660
|
-
"description": "
|
10661
|
-
"name": "
|
10465
|
+
"description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
10466
|
+
"name": "Dialog",
|
10662
10467
|
"cssProperties": [
|
10663
10468
|
{
|
10664
|
-
"description": "background color of the
|
10665
|
-
"name": "--mdc-
|
10666
|
-
},
|
10667
|
-
{
|
10668
|
-
"description": "width of the divider",
|
10669
|
-
"name": "--mdc-divider-width"
|
10670
|
-
},
|
10671
|
-
{
|
10672
|
-
"description": "gradient of the horizontal divider",
|
10673
|
-
"name": "--mdc-divider-horizontal-gradient"
|
10469
|
+
"description": "primary background color of the dialog",
|
10470
|
+
"name": "--mdc-dialog-primary-background-color"
|
10674
10471
|
},
|
10675
10472
|
{
|
10676
|
-
"description": "
|
10677
|
-
"name": "--mdc-
|
10473
|
+
"description": "border color of the dialog",
|
10474
|
+
"name": "--mdc-dialog-border-color"
|
10678
10475
|
},
|
10679
10476
|
{
|
10680
|
-
"description": "
|
10681
|
-
"name": "--mdc-
|
10477
|
+
"description": "text color of the header/title of the dialog",
|
10478
|
+
"name": "--mdc-dialog-header-text-color"
|
10682
10479
|
},
|
10683
10480
|
{
|
10684
|
-
"description": "
|
10685
|
-
"name": "--mdc-
|
10481
|
+
"description": "text color of the below header description of the dialog",
|
10482
|
+
"name": "--mdc-dialog-description-text-color"
|
10686
10483
|
},
|
10687
10484
|
{
|
10688
|
-
"description": "
|
10689
|
-
"name": "--mdc-
|
10485
|
+
"description": "elevation of the dialog",
|
10486
|
+
"name": "--mdc-dialog-elevation-3"
|
10690
10487
|
},
|
10691
10488
|
{
|
10692
|
-
"description": "
|
10693
|
-
"name": "--mdc-
|
10489
|
+
"description": "width of the dialog",
|
10490
|
+
"name": "--mdc-dialog-width"
|
10491
|
+
}
|
10492
|
+
],
|
10493
|
+
"slots": [
|
10494
|
+
{
|
10495
|
+
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
10496
|
+
"name": "header-prefix"
|
10694
10497
|
},
|
10695
10498
|
{
|
10696
|
-
"description": "
|
10697
|
-
"name": "
|
10499
|
+
"description": "Slot for the dialog body content",
|
10500
|
+
"name": "dialog-body"
|
10698
10501
|
},
|
10699
10502
|
{
|
10700
|
-
"description": "
|
10701
|
-
"name": "
|
10503
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
10504
|
+
"name": "footer-link"
|
10702
10505
|
},
|
10703
10506
|
{
|
10704
|
-
"description": "
|
10705
|
-
"name": "
|
10507
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
10508
|
+
"name": "footer-button-secondary"
|
10706
10509
|
},
|
10707
10510
|
{
|
10708
|
-
"description": "
|
10709
|
-
"name": "
|
10511
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
10512
|
+
"name": "footer-button-primary"
|
10710
10513
|
},
|
10711
10514
|
{
|
10712
|
-
"description": "
|
10713
|
-
"name": "
|
10515
|
+
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
|
10516
|
+
"name": "footer"
|
10714
10517
|
}
|
10715
10518
|
],
|
10716
10519
|
"members": [
|
10717
10520
|
{
|
10718
10521
|
"kind": "field",
|
10719
|
-
"name": "
|
10522
|
+
"name": "id",
|
10720
10523
|
"type": {
|
10721
|
-
"text": "
|
10524
|
+
"text": "string"
|
10722
10525
|
},
|
10723
|
-
"
|
10724
|
-
"
|
10725
|
-
"attribute": "
|
10526
|
+
"default": "''",
|
10527
|
+
"description": "The unique ID of the dialog",
|
10528
|
+
"attribute": "id",
|
10529
|
+
"reflects": true
|
10530
|
+
},
|
10531
|
+
{
|
10532
|
+
"kind": "field",
|
10533
|
+
"name": "triggerId",
|
10534
|
+
"type": {
|
10535
|
+
"text": "string | undefined"
|
10536
|
+
},
|
10537
|
+
"description": "The ID of the element that triggers the dialog",
|
10538
|
+
"default": "undefined",
|
10539
|
+
"attribute": "triggerId",
|
10540
|
+
"reflects": true
|
10541
|
+
},
|
10542
|
+
{
|
10543
|
+
"kind": "field",
|
10544
|
+
"name": "visible",
|
10545
|
+
"type": {
|
10546
|
+
"text": "boolean"
|
10547
|
+
},
|
10548
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
10549
|
+
"default": "false",
|
10550
|
+
"attribute": "visible",
|
10551
|
+
"reflects": true
|
10552
|
+
},
|
10553
|
+
{
|
10554
|
+
"kind": "field",
|
10555
|
+
"name": "zIndex",
|
10556
|
+
"type": {
|
10557
|
+
"text": "number"
|
10558
|
+
},
|
10559
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
10560
|
+
"default": "1000",
|
10561
|
+
"attribute": "z-index",
|
10562
|
+
"reflects": true
|
10563
|
+
},
|
10564
|
+
{
|
10565
|
+
"kind": "field",
|
10566
|
+
"name": "size",
|
10567
|
+
"type": {
|
10568
|
+
"text": "DialogSize"
|
10569
|
+
},
|
10570
|
+
"description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
10571
|
+
"default": "small",
|
10572
|
+
"attribute": "size",
|
10726
10573
|
"reflects": true
|
10727
10574
|
},
|
10728
10575
|
{
|
10729
10576
|
"kind": "field",
|
10730
10577
|
"name": "variant",
|
10731
10578
|
"type": {
|
10732
|
-
"text": "
|
10579
|
+
"text": "DialogVariant"
|
10733
10580
|
},
|
10734
|
-
"description": "
|
10735
|
-
"default": "
|
10581
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
10582
|
+
"default": "default",
|
10736
10583
|
"attribute": "variant",
|
10737
10584
|
"reflects": true
|
10738
10585
|
},
|
10739
10586
|
{
|
10740
10587
|
"kind": "field",
|
10741
|
-
"name": "
|
10588
|
+
"name": "closeButtonAriaLabel",
|
10742
10589
|
"type": {
|
10743
|
-
"text": "
|
10590
|
+
"text": "string | null"
|
10744
10591
|
},
|
10745
|
-
"
|
10746
|
-
"
|
10747
|
-
"attribute": "
|
10592
|
+
"default": "null",
|
10593
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
10594
|
+
"attribute": "close-button-aria-label"
|
10595
|
+
},
|
10596
|
+
{
|
10597
|
+
"kind": "field",
|
10598
|
+
"name": "ariaLabel",
|
10599
|
+
"type": {
|
10600
|
+
"text": "string | null"
|
10601
|
+
},
|
10602
|
+
"default": "null",
|
10603
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
10604
|
+
"attribute": "aria-label",
|
10748
10605
|
"reflects": true
|
10749
10606
|
},
|
10750
10607
|
{
|
10751
10608
|
"kind": "field",
|
10752
|
-
"name": "
|
10609
|
+
"name": "ariaLabelledby",
|
10753
10610
|
"type": {
|
10754
|
-
"text": "
|
10611
|
+
"text": "string | null"
|
10755
10612
|
},
|
10756
|
-
"
|
10757
|
-
"
|
10758
|
-
"attribute": "
|
10613
|
+
"default": "null",
|
10614
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
10615
|
+
"attribute": "aria-labelledby",
|
10759
10616
|
"reflects": true
|
10760
10617
|
},
|
10761
10618
|
{
|
10762
|
-
"kind": "
|
10763
|
-
"name": "
|
10764
|
-
"
|
10765
|
-
|
10766
|
-
|
10767
|
-
|
10768
|
-
|
10769
|
-
|
10770
|
-
|
10771
|
-
"description": "The variant to set."
|
10772
|
-
}
|
10773
|
-
],
|
10774
|
-
"description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
10619
|
+
"kind": "field",
|
10620
|
+
"name": "ariaDescribedBy",
|
10621
|
+
"type": {
|
10622
|
+
"text": "string | null"
|
10623
|
+
},
|
10624
|
+
"default": "null",
|
10625
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
10626
|
+
"attribute": "aria-describedby",
|
10627
|
+
"reflects": true
|
10775
10628
|
},
|
10776
10629
|
{
|
10777
|
-
"kind": "
|
10778
|
-
"name": "
|
10779
|
-
"
|
10780
|
-
|
10781
|
-
|
10782
|
-
|
10783
|
-
|
10784
|
-
|
10785
|
-
|
10786
|
-
"description": "The orientation to set."
|
10787
|
-
}
|
10788
|
-
],
|
10789
|
-
"description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
|
10630
|
+
"kind": "field",
|
10631
|
+
"name": "ariaDescription",
|
10632
|
+
"type": {
|
10633
|
+
"text": "string | null"
|
10634
|
+
},
|
10635
|
+
"default": "null",
|
10636
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
10637
|
+
"attribute": "aria-description",
|
10638
|
+
"reflects": true
|
10790
10639
|
},
|
10791
10640
|
{
|
10792
|
-
"kind": "
|
10793
|
-
"name": "
|
10794
|
-
"
|
10795
|
-
|
10796
|
-
|
10797
|
-
|
10798
|
-
|
10799
|
-
|
10800
|
-
},
|
10801
|
-
{
|
10802
|
-
"description": "The arrowDirection to set.",
|
10803
|
-
"name": "arrowDirection"
|
10804
|
-
}
|
10805
|
-
]
|
10641
|
+
"kind": "field",
|
10642
|
+
"name": "headerText",
|
10643
|
+
"type": {
|
10644
|
+
"text": "string | undefined"
|
10645
|
+
},
|
10646
|
+
"description": "Defines a string value to display as the title of the dialog",
|
10647
|
+
"attribute": "header-text",
|
10648
|
+
"reflects": true
|
10806
10649
|
},
|
10807
10650
|
{
|
10808
|
-
"kind": "
|
10809
|
-
"name": "
|
10810
|
-
"
|
10811
|
-
|
10812
|
-
|
10813
|
-
|
10814
|
-
|
10651
|
+
"kind": "field",
|
10652
|
+
"name": "descriptionText",
|
10653
|
+
"type": {
|
10654
|
+
"text": "string | undefined"
|
10655
|
+
},
|
10656
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
10657
|
+
"attribute": "description-text",
|
10658
|
+
"reflects": true
|
10659
|
+
},
|
10660
|
+
{
|
10661
|
+
"kind": "field",
|
10662
|
+
"name": "headerTagName",
|
10663
|
+
"type": {
|
10664
|
+
"text": "string"
|
10665
|
+
},
|
10666
|
+
"description": "The html tag to be used for the header text",
|
10667
|
+
"attribute": "header-tag-name",
|
10668
|
+
"reflects": true
|
10669
|
+
},
|
10670
|
+
{
|
10671
|
+
"kind": "field",
|
10672
|
+
"name": "descriptionTagName",
|
10673
|
+
"type": {
|
10674
|
+
"text": "string"
|
10675
|
+
},
|
10676
|
+
"description": "The html tag to be used for the below-header description text",
|
10677
|
+
"attribute": "description-tag-name",
|
10678
|
+
"reflects": true
|
10679
|
+
},
|
10680
|
+
{
|
10681
|
+
"kind": "field",
|
10682
|
+
"name": "role",
|
10683
|
+
"type": {
|
10684
|
+
"text": "DialogRole"
|
10685
|
+
},
|
10686
|
+
"description": "Role of the dialog",
|
10687
|
+
"default": "dialog",
|
10688
|
+
"attribute": "role",
|
10689
|
+
"reflects": true
|
10690
|
+
},
|
10691
|
+
{
|
10692
|
+
"kind": "field",
|
10693
|
+
"name": "disableAriaHasPopup",
|
10694
|
+
"type": {
|
10695
|
+
"text": "boolean"
|
10696
|
+
},
|
10697
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
10698
|
+
"default": "false",
|
10699
|
+
"attribute": "disable-aria-haspopup",
|
10700
|
+
"reflects": true
|
10701
|
+
},
|
10702
|
+
{
|
10703
|
+
"kind": "field",
|
10704
|
+
"name": "focusTrap",
|
10705
|
+
"type": {
|
10706
|
+
"text": "boolean"
|
10815
10707
|
},
|
10816
|
-
"
|
10708
|
+
"privacy": "protected",
|
10709
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
|
10710
|
+
"default": "true",
|
10711
|
+
"attribute": "focus-trap",
|
10712
|
+
"reflects": true,
|
10713
|
+
"inheritedFrom": {
|
10714
|
+
"name": "FocusTrapMixin",
|
10715
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10716
|
+
}
|
10817
10717
|
},
|
10818
10718
|
{
|
10819
10719
|
"kind": "method",
|
10820
|
-
"name": "
|
10720
|
+
"name": "closeDialog",
|
10821
10721
|
"privacy": "private",
|
10822
|
-
"
|
10823
|
-
"type": {
|
10824
|
-
"text": ""
|
10825
|
-
}
|
10826
|
-
},
|
10827
|
-
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
10722
|
+
"description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component."
|
10828
10723
|
},
|
10829
10724
|
{
|
10830
10725
|
"kind": "method",
|
10831
|
-
"name": "
|
10726
|
+
"name": "isOpenUpdated",
|
10832
10727
|
"privacy": "private",
|
10833
|
-
"description": "Infers the type of divider based on the kind of slot present.",
|
10834
10728
|
"parameters": [
|
10835
10729
|
{
|
10836
|
-
"
|
10837
|
-
"
|
10730
|
+
"name": "oldValue",
|
10731
|
+
"type": {
|
10732
|
+
"text": "boolean | undefined"
|
10733
|
+
},
|
10734
|
+
"description": "The old value of the visible property."
|
10735
|
+
},
|
10736
|
+
{
|
10737
|
+
"name": "newValue",
|
10738
|
+
"type": {
|
10739
|
+
"text": "boolean"
|
10740
|
+
},
|
10741
|
+
"description": "The new value of the visible property."
|
10838
10742
|
}
|
10839
|
-
]
|
10840
|
-
|
10841
|
-
],
|
10842
|
-
"attributes": [
|
10843
|
-
{
|
10844
|
-
"name": "orientation",
|
10845
|
-
"type": {
|
10846
|
-
"text": "DividerOrientation"
|
10847
|
-
},
|
10848
|
-
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
10849
|
-
"default": "horizontal",
|
10850
|
-
"fieldName": "orientation"
|
10743
|
+
],
|
10744
|
+
"description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
|
10851
10745
|
},
|
10852
10746
|
{
|
10853
|
-
"
|
10747
|
+
"kind": "field",
|
10748
|
+
"name": "preventScroll",
|
10854
10749
|
"type": {
|
10855
|
-
"text": "
|
10750
|
+
"text": "boolean"
|
10856
10751
|
},
|
10857
|
-
"
|
10858
|
-
"
|
10859
|
-
"
|
10752
|
+
"privacy": "protected",
|
10753
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
10754
|
+
"inheritedFrom": {
|
10755
|
+
"name": "PreventScrollMixin",
|
10756
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
10757
|
+
}
|
10860
10758
|
},
|
10861
10759
|
{
|
10862
|
-
"
|
10863
|
-
"
|
10864
|
-
|
10865
|
-
|
10866
|
-
|
10867
|
-
|
10868
|
-
|
10760
|
+
"kind": "method",
|
10761
|
+
"name": "activatePreventScroll",
|
10762
|
+
"privacy": "protected",
|
10763
|
+
"inheritedFrom": {
|
10764
|
+
"name": "PreventScrollMixin",
|
10765
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
10766
|
+
}
|
10869
10767
|
},
|
10870
10768
|
{
|
10871
|
-
"
|
10872
|
-
"
|
10873
|
-
|
10874
|
-
|
10875
|
-
|
10876
|
-
|
10877
|
-
|
10878
|
-
}
|
10879
|
-
],
|
10880
|
-
"superclass": {
|
10881
|
-
"name": "Component",
|
10882
|
-
"module": "/src/models"
|
10883
|
-
},
|
10884
|
-
"tagName": "mdc-divider",
|
10885
|
-
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
10886
|
-
"customElement": true
|
10887
|
-
}
|
10888
|
-
],
|
10889
|
-
"exports": [
|
10890
|
-
{
|
10891
|
-
"kind": "js",
|
10892
|
-
"name": "default",
|
10893
|
-
"declaration": {
|
10894
|
-
"name": "Divider",
|
10895
|
-
"module": "components/divider/divider.component.js"
|
10896
|
-
}
|
10897
|
-
}
|
10898
|
-
]
|
10899
|
-
},
|
10900
|
-
{
|
10901
|
-
"kind": "javascript-module",
|
10902
|
-
"path": "components/filterchip/filterchip.component.js",
|
10903
|
-
"declarations": [
|
10904
|
-
{
|
10905
|
-
"kind": "class",
|
10906
|
-
"description": "mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\nThey can be found with lists or tables as quick filters.\n\nThis component is built on top of the mdc-chip component.",
|
10907
|
-
"name": "FilterChip",
|
10908
|
-
"members": [
|
10769
|
+
"kind": "method",
|
10770
|
+
"name": "deactivatePreventScroll",
|
10771
|
+
"privacy": "protected",
|
10772
|
+
"inheritedFrom": {
|
10773
|
+
"name": "PreventScrollMixin",
|
10774
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
10775
|
+
}
|
10776
|
+
},
|
10909
10777
|
{
|
10910
10778
|
"kind": "field",
|
10911
|
-
"name": "
|
10779
|
+
"name": "shouldFocusTrapWrap",
|
10912
10780
|
"type": {
|
10913
10781
|
"text": "boolean"
|
10914
10782
|
},
|
10915
|
-
"default": "
|
10916
|
-
"description": "
|
10917
|
-
"attribute": "
|
10918
|
-
"reflects": true
|
10783
|
+
"default": "true",
|
10784
|
+
"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.",
|
10785
|
+
"attribute": "should-focus-trap-wrap",
|
10786
|
+
"reflects": true,
|
10787
|
+
"inheritedFrom": {
|
10788
|
+
"name": "FocusTrapMixin",
|
10789
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10790
|
+
}
|
10919
10791
|
},
|
10920
10792
|
{
|
10921
10793
|
"kind": "method",
|
10922
|
-
"name": "
|
10794
|
+
"name": "setIsFocusTrapActivated",
|
10923
10795
|
"privacy": "private",
|
10924
10796
|
"parameters": [
|
10925
10797
|
{
|
10926
|
-
"name": "
|
10798
|
+
"name": "isActivated",
|
10927
10799
|
"type": {
|
10928
10800
|
"text": "boolean"
|
10929
|
-
}
|
10930
|
-
"description": "The selected state of the filterchip."
|
10801
|
+
}
|
10931
10802
|
}
|
10932
10803
|
],
|
10933
|
-
"
|
10804
|
+
"inheritedFrom": {
|
10805
|
+
"name": "FocusTrapMixin",
|
10806
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10807
|
+
}
|
10934
10808
|
},
|
10935
10809
|
{
|
10936
10810
|
"kind": "method",
|
10937
|
-
"name": "
|
10938
|
-
"privacy": "
|
10811
|
+
"name": "activateFocusTrap",
|
10812
|
+
"privacy": "public",
|
10813
|
+
"description": "Activate the focus trap",
|
10939
10814
|
"inheritedFrom": {
|
10940
|
-
"name": "
|
10941
|
-
"module": "
|
10942
|
-
},
|
10943
|
-
"return": {
|
10944
|
-
"type": {
|
10945
|
-
"text": "void"
|
10946
|
-
}
|
10815
|
+
"name": "FocusTrapMixin",
|
10816
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10947
10817
|
}
|
10948
10818
|
},
|
10949
10819
|
{
|
10950
|
-
"kind": "
|
10951
|
-
"name": "
|
10952
|
-
"
|
10953
|
-
|
10820
|
+
"kind": "method",
|
10821
|
+
"name": "deactivateFocusTrap",
|
10822
|
+
"privacy": "public",
|
10823
|
+
"description": "Deactivate the focus trap.",
|
10824
|
+
"inheritedFrom": {
|
10825
|
+
"name": "FocusTrapMixin",
|
10826
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10827
|
+
}
|
10828
|
+
},
|
10829
|
+
{
|
10830
|
+
"kind": "method",
|
10831
|
+
"name": "hasNoClientRects",
|
10832
|
+
"privacy": "private",
|
10833
|
+
"parameters": [
|
10834
|
+
{
|
10835
|
+
"name": "element",
|
10836
|
+
"type": {
|
10837
|
+
"text": "HTMLElement"
|
10838
|
+
},
|
10839
|
+
"description": "The element to check."
|
10840
|
+
}
|
10841
|
+
],
|
10842
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
10843
|
+
"return": {
|
10844
|
+
"type": {
|
10845
|
+
"text": ""
|
10846
|
+
}
|
10954
10847
|
},
|
10955
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
10956
|
-
"attribute": "icon-name",
|
10957
10848
|
"inheritedFrom": {
|
10958
|
-
"name": "
|
10959
|
-
"module": "utils/mixins/
|
10849
|
+
"name": "FocusTrapMixin",
|
10850
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10960
10851
|
}
|
10961
10852
|
},
|
10962
10853
|
{
|
10963
|
-
"kind": "
|
10964
|
-
"name": "
|
10965
|
-
"
|
10966
|
-
|
10854
|
+
"kind": "method",
|
10855
|
+
"name": "hasZeroDimensions",
|
10856
|
+
"privacy": "private",
|
10857
|
+
"parameters": [
|
10858
|
+
{
|
10859
|
+
"name": "element",
|
10860
|
+
"type": {
|
10861
|
+
"text": "HTMLElement"
|
10862
|
+
},
|
10863
|
+
"description": "The element to check."
|
10864
|
+
}
|
10865
|
+
],
|
10866
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
10867
|
+
"return": {
|
10868
|
+
"type": {
|
10869
|
+
"text": ""
|
10870
|
+
}
|
10967
10871
|
},
|
10968
|
-
"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",
|
10969
|
-
"default": "default",
|
10970
|
-
"attribute": "color",
|
10971
|
-
"reflects": true,
|
10972
10872
|
"inheritedFrom": {
|
10973
|
-
"name": "
|
10974
|
-
"module": "
|
10873
|
+
"name": "FocusTrapMixin",
|
10874
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10975
10875
|
}
|
10976
10876
|
},
|
10977
10877
|
{
|
10978
|
-
"kind": "
|
10979
|
-
"name": "
|
10980
|
-
"
|
10981
|
-
|
10878
|
+
"kind": "method",
|
10879
|
+
"name": "isNotVisible",
|
10880
|
+
"privacy": "private",
|
10881
|
+
"parameters": [
|
10882
|
+
{
|
10883
|
+
"name": "element",
|
10884
|
+
"type": {
|
10885
|
+
"text": "HTMLElement"
|
10886
|
+
},
|
10887
|
+
"description": "The element to check."
|
10888
|
+
}
|
10889
|
+
],
|
10890
|
+
"description": "Determines if the element is not visible in the DOM.",
|
10891
|
+
"return": {
|
10892
|
+
"type": {
|
10893
|
+
"text": ""
|
10894
|
+
}
|
10982
10895
|
},
|
10983
|
-
"default": "''",
|
10984
|
-
"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.",
|
10985
|
-
"attribute": "label",
|
10986
10896
|
"inheritedFrom": {
|
10987
|
-
"name": "
|
10988
|
-
"module": "
|
10897
|
+
"name": "FocusTrapMixin",
|
10898
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
10989
10899
|
}
|
10990
10900
|
},
|
10991
10901
|
{
|
10992
10902
|
"kind": "method",
|
10993
|
-
"name": "
|
10903
|
+
"name": "hasHiddenStyle",
|
10994
10904
|
"privacy": "private",
|
10995
|
-
"
|
10905
|
+
"parameters": [
|
10906
|
+
{
|
10907
|
+
"name": "element",
|
10908
|
+
"type": {
|
10909
|
+
"text": "HTMLElement"
|
10910
|
+
},
|
10911
|
+
"description": "The element to check."
|
10912
|
+
}
|
10913
|
+
],
|
10914
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
10996
10915
|
"return": {
|
10997
10916
|
"type": {
|
10998
10917
|
"text": ""
|
10999
10918
|
}
|
11000
10919
|
},
|
11001
10920
|
"inheritedFrom": {
|
11002
|
-
"name": "
|
11003
|
-
"module": "
|
10921
|
+
"name": "FocusTrapMixin",
|
10922
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11004
10923
|
}
|
11005
10924
|
},
|
11006
10925
|
{
|
11007
|
-
"kind": "
|
11008
|
-
"name": "
|
11009
|
-
"
|
11010
|
-
|
10926
|
+
"kind": "method",
|
10927
|
+
"name": "hasComputedHidden",
|
10928
|
+
"privacy": "private",
|
10929
|
+
"parameters": [
|
10930
|
+
{
|
10931
|
+
"name": "element",
|
10932
|
+
"type": {
|
10933
|
+
"text": "HTMLElement"
|
10934
|
+
},
|
10935
|
+
"description": "The element to check."
|
10936
|
+
}
|
10937
|
+
],
|
10938
|
+
"description": "Checks if the element is hidden by a computed style.",
|
10939
|
+
"return": {
|
10940
|
+
"type": {
|
10941
|
+
"text": ""
|
10942
|
+
}
|
11011
10943
|
},
|
11012
|
-
"default": "false",
|
11013
|
-
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
11014
|
-
"attribute": "autofocus",
|
11015
|
-
"reflects": true,
|
11016
10944
|
"inheritedFrom": {
|
11017
|
-
"name": "
|
11018
|
-
"module": "
|
10945
|
+
"name": "FocusTrapMixin",
|
10946
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11019
10947
|
}
|
11020
10948
|
},
|
11021
10949
|
{
|
11022
|
-
"kind": "
|
11023
|
-
"name": "
|
11024
|
-
"
|
11025
|
-
|
10950
|
+
"kind": "method",
|
10951
|
+
"name": "isHidden",
|
10952
|
+
"privacy": "private",
|
10953
|
+
"parameters": [
|
10954
|
+
{
|
10955
|
+
"name": "element",
|
10956
|
+
"type": {
|
10957
|
+
"text": "HTMLElement"
|
10958
|
+
},
|
10959
|
+
"description": "The element to check."
|
10960
|
+
}
|
10961
|
+
],
|
10962
|
+
"description": "Checks if the element is hidden from the user.",
|
10963
|
+
"return": {
|
10964
|
+
"type": {
|
10965
|
+
"text": ""
|
10966
|
+
}
|
11026
10967
|
},
|
11027
|
-
"default": "0",
|
11028
|
-
"description": "This property specifies the tab order of the element.",
|
11029
|
-
"attribute": "tabIndex",
|
11030
|
-
"reflects": true,
|
11031
10968
|
"inheritedFrom": {
|
11032
|
-
"name": "
|
11033
|
-
"module": "
|
10969
|
+
"name": "FocusTrapMixin",
|
10970
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11034
10971
|
}
|
11035
10972
|
},
|
11036
10973
|
{
|
11037
|
-
"kind": "
|
11038
|
-
"name": "
|
11039
|
-
"
|
11040
|
-
|
10974
|
+
"kind": "method",
|
10975
|
+
"name": "isDisabled",
|
10976
|
+
"privacy": "private",
|
10977
|
+
"parameters": [
|
10978
|
+
{
|
10979
|
+
"name": "element",
|
10980
|
+
"type": {
|
10981
|
+
"text": "any"
|
10982
|
+
},
|
10983
|
+
"description": "The element to check."
|
10984
|
+
}
|
10985
|
+
],
|
10986
|
+
"description": "Checks if the element is disabled.",
|
10987
|
+
"return": {
|
10988
|
+
"type": {
|
10989
|
+
"text": ""
|
10990
|
+
}
|
11041
10991
|
},
|
11042
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
11043
|
-
"default": "undefined",
|
11044
|
-
"attribute": "disabled",
|
11045
|
-
"reflects": true,
|
11046
10992
|
"inheritedFrom": {
|
11047
|
-
"name": "
|
11048
|
-
"module": "
|
10993
|
+
"name": "FocusTrapMixin",
|
10994
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11049
10995
|
}
|
11050
10996
|
},
|
11051
10997
|
{
|
11052
|
-
"kind": "
|
11053
|
-
"name": "
|
11054
|
-
"
|
11055
|
-
|
10998
|
+
"kind": "method",
|
10999
|
+
"name": "isNotTabbable",
|
11000
|
+
"privacy": "private",
|
11001
|
+
"parameters": [
|
11002
|
+
{
|
11003
|
+
"name": "element",
|
11004
|
+
"type": {
|
11005
|
+
"text": "HTMLElement"
|
11006
|
+
},
|
11007
|
+
"description": "The element to check."
|
11008
|
+
}
|
11009
|
+
],
|
11010
|
+
"description": "Checks if the element is not tabbable.",
|
11011
|
+
"return": {
|
11012
|
+
"type": {
|
11013
|
+
"text": ""
|
11014
|
+
}
|
11056
11015
|
},
|
11057
|
-
"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.",
|
11058
|
-
"default": "undefined",
|
11059
|
-
"attribute": "active",
|
11060
|
-
"reflects": true,
|
11061
11016
|
"inheritedFrom": {
|
11062
|
-
"name": "
|
11063
|
-
"module": "
|
11017
|
+
"name": "FocusTrapMixin",
|
11018
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11064
11019
|
}
|
11065
11020
|
},
|
11066
11021
|
{
|
11067
|
-
"kind": "
|
11068
|
-
"name": "
|
11069
|
-
"
|
11070
|
-
|
11022
|
+
"kind": "method",
|
11023
|
+
"name": "isInteractiveElement",
|
11024
|
+
"privacy": "private",
|
11025
|
+
"return": {
|
11026
|
+
"type": {
|
11027
|
+
"text": ""
|
11028
|
+
}
|
11071
11029
|
},
|
11072
|
-
"
|
11073
|
-
|
11074
|
-
|
11075
|
-
|
11030
|
+
"parameters": [
|
11031
|
+
{
|
11032
|
+
"name": "element",
|
11033
|
+
"type": {
|
11034
|
+
"text": "HTMLElement"
|
11035
|
+
},
|
11036
|
+
"description": "The element to check."
|
11037
|
+
}
|
11038
|
+
],
|
11039
|
+
"description": "Checks if the element is interactive.",
|
11076
11040
|
"inheritedFrom": {
|
11077
|
-
"name": "
|
11078
|
-
"module": "
|
11041
|
+
"name": "FocusTrapMixin",
|
11042
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11079
11043
|
}
|
11080
11044
|
},
|
11081
11045
|
{
|
11082
|
-
"kind": "
|
11083
|
-
"name": "
|
11084
|
-
"
|
11085
|
-
|
11046
|
+
"kind": "method",
|
11047
|
+
"name": "isFocusable",
|
11048
|
+
"privacy": "private",
|
11049
|
+
"parameters": [
|
11050
|
+
{
|
11051
|
+
"name": "element",
|
11052
|
+
"type": {
|
11053
|
+
"text": "HTMLElement"
|
11054
|
+
},
|
11055
|
+
"description": "The element to check."
|
11056
|
+
}
|
11057
|
+
],
|
11058
|
+
"description": "Checks if the element is focusable.",
|
11059
|
+
"return": {
|
11060
|
+
"type": {
|
11061
|
+
"text": ""
|
11062
|
+
}
|
11086
11063
|
},
|
11087
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
11088
|
-
"default": "32",
|
11089
|
-
"attribute": "size",
|
11090
|
-
"reflects": true,
|
11091
11064
|
"inheritedFrom": {
|
11092
|
-
"name": "
|
11093
|
-
"module": "
|
11065
|
+
"name": "FocusTrapMixin",
|
11066
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11094
11067
|
}
|
11095
11068
|
},
|
11096
11069
|
{
|
11097
|
-
"kind": "
|
11098
|
-
"name": "
|
11099
|
-
"
|
11100
|
-
"
|
11101
|
-
|
11102
|
-
|
11070
|
+
"kind": "method",
|
11071
|
+
"name": "findFocusable",
|
11072
|
+
"privacy": "private",
|
11073
|
+
"return": {
|
11074
|
+
"type": {
|
11075
|
+
"text": ""
|
11076
|
+
}
|
11077
|
+
},
|
11078
|
+
"parameters": [
|
11079
|
+
{
|
11080
|
+
"name": "root",
|
11081
|
+
"type": {
|
11082
|
+
"text": "ShadowRoot | HTMLElement"
|
11083
|
+
},
|
11084
|
+
"description": "The root element to search for focusable elements."
|
11085
|
+
},
|
11086
|
+
{
|
11087
|
+
"name": "matches",
|
11088
|
+
"default": "new Set()",
|
11089
|
+
"type": {
|
11090
|
+
"text": "Set<HTMLElement>"
|
11091
|
+
},
|
11092
|
+
"description": "The set of focusable elements."
|
11093
|
+
}
|
11094
|
+
],
|
11095
|
+
"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.",
|
11103
11096
|
"inheritedFrom": {
|
11104
|
-
"name": "
|
11105
|
-
"module": "
|
11097
|
+
"name": "FocusTrapMixin",
|
11098
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11106
11099
|
}
|
11107
11100
|
},
|
11108
11101
|
{
|
11109
|
-
"kind": "
|
11110
|
-
"name": "
|
11111
|
-
"
|
11112
|
-
|
11113
|
-
},
|
11114
|
-
"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`",
|
11115
|
-
"default": "'aria-pressed' (when)",
|
11116
|
-
"attribute": "ariaStateKey",
|
11117
|
-
"reflects": true,
|
11102
|
+
"kind": "method",
|
11103
|
+
"name": "setFocusableElements",
|
11104
|
+
"privacy": "private",
|
11105
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
11118
11106
|
"inheritedFrom": {
|
11119
|
-
"name": "
|
11120
|
-
"module": "
|
11107
|
+
"name": "FocusTrapMixin",
|
11108
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11121
11109
|
}
|
11122
11110
|
},
|
11123
11111
|
{
|
11124
|
-
"kind": "
|
11125
|
-
"name": "
|
11126
|
-
"
|
11127
|
-
|
11128
|
-
|
11129
|
-
|
11130
|
-
|
11131
|
-
|
11132
|
-
|
11112
|
+
"kind": "method",
|
11113
|
+
"name": "setInitialFocus",
|
11114
|
+
"privacy": "public",
|
11115
|
+
"parameters": [
|
11116
|
+
{
|
11117
|
+
"name": "elementIndexToReceiveFocus",
|
11118
|
+
"default": "0",
|
11119
|
+
"type": {
|
11120
|
+
"text": "number"
|
11121
|
+
},
|
11122
|
+
"description": "The index of the preferable element to focus."
|
11123
|
+
}
|
11124
|
+
],
|
11125
|
+
"description": "Sets the initial focus within the container.",
|
11133
11126
|
"inheritedFrom": {
|
11134
|
-
"name": "
|
11135
|
-
"module": "
|
11127
|
+
"name": "FocusTrapMixin",
|
11128
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11136
11129
|
}
|
11137
11130
|
},
|
11138
11131
|
{
|
11139
11132
|
"kind": "method",
|
11140
|
-
"name": "
|
11141
|
-
"privacy": "
|
11133
|
+
"name": "calculateNextIndex",
|
11134
|
+
"privacy": "private",
|
11142
11135
|
"parameters": [
|
11143
11136
|
{
|
11144
|
-
"name": "
|
11137
|
+
"name": "currentIndex",
|
11145
11138
|
"type": {
|
11146
|
-
"text": "
|
11139
|
+
"text": "number"
|
11147
11140
|
},
|
11148
|
-
"description": "The
|
11141
|
+
"description": "The current index."
|
11149
11142
|
},
|
11150
11143
|
{
|
11151
|
-
"name": "
|
11152
|
-
"optional": true,
|
11144
|
+
"name": "step",
|
11153
11145
|
"type": {
|
11154
|
-
"text": "
|
11146
|
+
"text": "number"
|
11155
11147
|
},
|
11156
|
-
"description": "The
|
11148
|
+
"description": "The step to calculate the next index."
|
11157
11149
|
}
|
11158
11150
|
],
|
11159
|
-
"description": "
|
11151
|
+
"description": "Calculates the next index for the focus trap.",
|
11152
|
+
"return": {
|
11153
|
+
"type": {
|
11154
|
+
"text": ""
|
11155
|
+
}
|
11156
|
+
},
|
11160
11157
|
"inheritedFrom": {
|
11161
|
-
"name": "
|
11162
|
-
"module": "
|
11158
|
+
"name": "FocusTrapMixin",
|
11159
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11163
11160
|
}
|
11164
11161
|
},
|
11165
11162
|
{
|
11166
11163
|
"kind": "method",
|
11167
|
-
"name": "
|
11164
|
+
"name": "getDeepActiveElement",
|
11165
|
+
"privacy": "private",
|
11166
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
11167
|
+
"return": {
|
11168
|
+
"type": {
|
11169
|
+
"text": ""
|
11170
|
+
}
|
11171
|
+
},
|
11172
|
+
"inheritedFrom": {
|
11173
|
+
"name": "FocusTrapMixin",
|
11174
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11175
|
+
}
|
11176
|
+
},
|
11177
|
+
{
|
11178
|
+
"kind": "method",
|
11179
|
+
"name": "findElement",
|
11168
11180
|
"privacy": "private",
|
11169
11181
|
"parameters": [
|
11170
11182
|
{
|
11171
|
-
"name": "
|
11183
|
+
"name": "activeElement",
|
11172
11184
|
"type": {
|
11173
11185
|
"text": "HTMLElement"
|
11174
11186
|
},
|
11175
|
-
"description": "The
|
11176
|
-
},
|
11177
|
-
{
|
11178
|
-
"name": "softDisabled",
|
11179
|
-
"optional": true,
|
11180
|
-
"type": {
|
11181
|
-
"text": "boolean"
|
11182
|
-
},
|
11183
|
-
"description": "The soft-disabled state."
|
11187
|
+
"description": "The active element."
|
11184
11188
|
}
|
11185
11189
|
],
|
11186
|
-
"description": "
|
11190
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
11191
|
+
"return": {
|
11192
|
+
"type": {
|
11193
|
+
"text": ""
|
11194
|
+
}
|
11195
|
+
},
|
11187
11196
|
"inheritedFrom": {
|
11188
|
-
"name": "
|
11189
|
-
"module": "
|
11197
|
+
"name": "FocusTrapMixin",
|
11198
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11190
11199
|
}
|
11191
11200
|
},
|
11192
11201
|
{
|
11193
11202
|
"kind": "method",
|
11194
|
-
"name": "
|
11203
|
+
"name": "isEqualFocusNode",
|
11195
11204
|
"privacy": "private",
|
11196
11205
|
"parameters": [
|
11197
11206
|
{
|
11198
|
-
"name": "
|
11207
|
+
"name": "activeElement",
|
11199
11208
|
"type": {
|
11200
11209
|
"text": "HTMLElement"
|
11201
11210
|
},
|
11202
|
-
"description": "The
|
11211
|
+
"description": "The active element."
|
11203
11212
|
},
|
11204
11213
|
{
|
11205
|
-
"name": "
|
11214
|
+
"name": "element",
|
11206
11215
|
"type": {
|
11207
|
-
"text": "
|
11216
|
+
"text": "HTMLElement"
|
11208
11217
|
},
|
11209
|
-
"description": "The
|
11218
|
+
"description": "The element to compare."
|
11210
11219
|
}
|
11211
11220
|
],
|
11212
|
-
"description": "
|
11213
|
-
"
|
11214
|
-
"
|
11215
|
-
|
11216
|
-
|
11217
|
-
|
11218
|
-
{
|
11219
|
-
"kind": "method",
|
11220
|
-
"name": "triggerClickEvent",
|
11221
|
-
"privacy": "private",
|
11222
|
-
"inheritedFrom": {
|
11223
|
-
"name": "Buttonsimple",
|
11224
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
11225
|
-
}
|
11226
|
-
},
|
11227
|
-
{
|
11228
|
-
"kind": "method",
|
11229
|
-
"name": "handleBlur",
|
11230
|
-
"privacy": "private",
|
11231
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
11221
|
+
"description": "Checks if the active element is equal to the given element.",
|
11222
|
+
"return": {
|
11223
|
+
"type": {
|
11224
|
+
"text": ""
|
11225
|
+
}
|
11226
|
+
},
|
11232
11227
|
"inheritedFrom": {
|
11233
|
-
"name": "
|
11234
|
-
"module": "
|
11228
|
+
"name": "FocusTrapMixin",
|
11229
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11235
11230
|
}
|
11236
11231
|
},
|
11237
11232
|
{
|
11238
11233
|
"kind": "method",
|
11239
|
-
"name": "
|
11234
|
+
"name": "trapFocus",
|
11240
11235
|
"privacy": "private",
|
11241
11236
|
"parameters": [
|
11242
11237
|
{
|
11243
11238
|
"name": "event",
|
11244
11239
|
"type": {
|
11245
11240
|
"text": "KeyboardEvent"
|
11246
|
-
}
|
11247
|
-
|
11241
|
+
}
|
11242
|
+
},
|
11243
|
+
{
|
11244
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
11245
|
+
"name": "direction"
|
11248
11246
|
}
|
11249
11247
|
],
|
11250
|
-
"description": "
|
11248
|
+
"description": "Traps focus within the container.",
|
11251
11249
|
"inheritedFrom": {
|
11252
|
-
"name": "
|
11253
|
-
"module": "
|
11250
|
+
"name": "FocusTrapMixin",
|
11251
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11254
11252
|
}
|
11255
11253
|
},
|
11256
11254
|
{
|
11257
11255
|
"kind": "method",
|
11258
|
-
"name": "
|
11256
|
+
"name": "handleTabKeydown",
|
11259
11257
|
"privacy": "private",
|
11260
11258
|
"parameters": [
|
11261
11259
|
{
|
@@ -11266,247 +11264,249 @@
|
|
11266
11264
|
"description": "The keyboard event."
|
11267
11265
|
}
|
11268
11266
|
],
|
11269
|
-
"description": "
|
11267
|
+
"description": "Traps focus within the container.",
|
11270
11268
|
"inheritedFrom": {
|
11271
|
-
"name": "
|
11272
|
-
"module": "
|
11269
|
+
"name": "FocusTrapMixin",
|
11270
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
11273
11271
|
}
|
11272
|
+
},
|
11273
|
+
{
|
11274
|
+
"kind": "method",
|
11275
|
+
"name": "renderFooter",
|
11276
|
+
"privacy": "protected",
|
11277
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
11278
|
+
"return": {
|
11279
|
+
"type": {
|
11280
|
+
"text": ""
|
11281
|
+
}
|
11282
|
+
},
|
11283
|
+
"inheritedFrom": {
|
11284
|
+
"name": "FooterMixin",
|
11285
|
+
"module": "utils/mixins/FooterMixin.js"
|
11286
|
+
}
|
11287
|
+
}
|
11288
|
+
],
|
11289
|
+
"events": [
|
11290
|
+
{
|
11291
|
+
"description": "(React: onShown) Dispatched when the dialog is shown",
|
11292
|
+
"name": "shown",
|
11293
|
+
"reactName": "onShown"
|
11294
|
+
},
|
11295
|
+
{
|
11296
|
+
"description": "(React: onHidden) Dispatched when the dialog is hidden",
|
11297
|
+
"name": "hidden",
|
11298
|
+
"reactName": "onHidden"
|
11299
|
+
},
|
11300
|
+
{
|
11301
|
+
"description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
|
11302
|
+
"name": "created",
|
11303
|
+
"reactName": "onCreated"
|
11304
|
+
},
|
11305
|
+
{
|
11306
|
+
"description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
|
11307
|
+
"name": "destroyed",
|
11308
|
+
"reactName": "onDestroyed"
|
11309
|
+
},
|
11310
|
+
{
|
11311
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
|
11312
|
+
"name": "close",
|
11313
|
+
"reactName": "onClose"
|
11274
11314
|
}
|
11275
11315
|
],
|
11276
11316
|
"attributes": [
|
11277
11317
|
{
|
11278
|
-
"name": "
|
11318
|
+
"name": "id",
|
11319
|
+
"type": {
|
11320
|
+
"text": "string"
|
11321
|
+
},
|
11322
|
+
"default": "''",
|
11323
|
+
"description": "The unique ID of the dialog",
|
11324
|
+
"fieldName": "id"
|
11325
|
+
},
|
11326
|
+
{
|
11327
|
+
"name": "triggerId",
|
11328
|
+
"type": {
|
11329
|
+
"text": "string | undefined"
|
11330
|
+
},
|
11331
|
+
"description": "The ID of the element that triggers the dialog",
|
11332
|
+
"default": "undefined",
|
11333
|
+
"fieldName": "triggerId"
|
11334
|
+
},
|
11335
|
+
{
|
11336
|
+
"name": "visible",
|
11337
|
+
"type": {
|
11338
|
+
"text": "boolean"
|
11339
|
+
},
|
11340
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
11341
|
+
"default": "false",
|
11342
|
+
"fieldName": "visible"
|
11343
|
+
},
|
11344
|
+
{
|
11345
|
+
"name": "z-index",
|
11346
|
+
"type": {
|
11347
|
+
"text": "number"
|
11348
|
+
},
|
11349
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
11350
|
+
"default": "1000",
|
11351
|
+
"fieldName": "zIndex"
|
11352
|
+
},
|
11353
|
+
{
|
11354
|
+
"name": "size",
|
11355
|
+
"type": {
|
11356
|
+
"text": "DialogSize"
|
11357
|
+
},
|
11358
|
+
"description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
11359
|
+
"default": "small",
|
11360
|
+
"fieldName": "size"
|
11361
|
+
},
|
11362
|
+
{
|
11363
|
+
"name": "variant",
|
11364
|
+
"type": {
|
11365
|
+
"text": "DialogVariant"
|
11366
|
+
},
|
11367
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
11368
|
+
"default": "default",
|
11369
|
+
"fieldName": "variant"
|
11370
|
+
},
|
11371
|
+
{
|
11372
|
+
"name": "close-button-aria-label",
|
11279
11373
|
"type": {
|
11280
|
-
"text": "
|
11374
|
+
"text": "string | null"
|
11281
11375
|
},
|
11282
|
-
"default": "
|
11283
|
-
"description": "
|
11284
|
-
"fieldName": "
|
11376
|
+
"default": "null",
|
11377
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
11378
|
+
"fieldName": "closeButtonAriaLabel"
|
11285
11379
|
},
|
11286
11380
|
{
|
11287
|
-
"name": "
|
11381
|
+
"name": "aria-label",
|
11288
11382
|
"type": {
|
11289
|
-
"text": "
|
11383
|
+
"text": "string | null"
|
11290
11384
|
},
|
11291
|
-
"
|
11292
|
-
"
|
11293
|
-
"
|
11294
|
-
"name": "IconNameMixin",
|
11295
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
11296
|
-
}
|
11385
|
+
"default": "null",
|
11386
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
11387
|
+
"fieldName": "ariaLabel"
|
11297
11388
|
},
|
11298
11389
|
{
|
11299
|
-
"name": "
|
11390
|
+
"name": "aria-labelledby",
|
11300
11391
|
"type": {
|
11301
|
-
"text": "
|
11392
|
+
"text": "string | null"
|
11302
11393
|
},
|
11303
|
-
"
|
11304
|
-
"
|
11305
|
-
"fieldName": "
|
11306
|
-
"inheritedFrom": {
|
11307
|
-
"name": "Chip",
|
11308
|
-
"module": "src/components/chip/chip.component.ts"
|
11309
|
-
}
|
11394
|
+
"default": "null",
|
11395
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
11396
|
+
"fieldName": "ariaLabelledby"
|
11310
11397
|
},
|
11311
11398
|
{
|
11312
|
-
"name": "
|
11399
|
+
"name": "aria-describedby",
|
11313
11400
|
"type": {
|
11314
|
-
"text": "string"
|
11401
|
+
"text": "string | null"
|
11315
11402
|
},
|
11316
|
-
"default": "
|
11317
|
-
"description": "
|
11318
|
-
"fieldName": "
|
11319
|
-
"inheritedFrom": {
|
11320
|
-
"name": "Chip",
|
11321
|
-
"module": "src/components/chip/chip.component.ts"
|
11322
|
-
}
|
11403
|
+
"default": "null",
|
11404
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
11405
|
+
"fieldName": "ariaDescribedBy"
|
11323
11406
|
},
|
11324
11407
|
{
|
11325
|
-
"name": "
|
11408
|
+
"name": "aria-description",
|
11326
11409
|
"type": {
|
11327
|
-
"text": "
|
11410
|
+
"text": "string | null"
|
11328
11411
|
},
|
11329
|
-
"default": "
|
11330
|
-
"description": "
|
11331
|
-
"fieldName": "
|
11332
|
-
"inheritedFrom": {
|
11333
|
-
"name": "Buttonsimple",
|
11334
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11335
|
-
}
|
11412
|
+
"default": "null",
|
11413
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
11414
|
+
"fieldName": "ariaDescription"
|
11336
11415
|
},
|
11337
11416
|
{
|
11338
|
-
"name": "
|
11417
|
+
"name": "header-text",
|
11339
11418
|
"type": {
|
11340
|
-
"text": "
|
11419
|
+
"text": "string | undefined"
|
11341
11420
|
},
|
11342
|
-
"
|
11343
|
-
"
|
11344
|
-
"fieldName": "tabIndex",
|
11345
|
-
"inheritedFrom": {
|
11346
|
-
"name": "Buttonsimple",
|
11347
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11348
|
-
}
|
11421
|
+
"description": "Defines a string value to display as the title of the dialog",
|
11422
|
+
"fieldName": "headerText"
|
11349
11423
|
},
|
11350
11424
|
{
|
11351
|
-
"name": "
|
11425
|
+
"name": "description-text",
|
11352
11426
|
"type": {
|
11353
|
-
"text": "
|
11427
|
+
"text": "string | undefined"
|
11354
11428
|
},
|
11355
|
-
"description": "
|
11356
|
-
"
|
11357
|
-
"fieldName": "disabled",
|
11358
|
-
"inheritedFrom": {
|
11359
|
-
"name": "Buttonsimple",
|
11360
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11361
|
-
}
|
11429
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
11430
|
+
"fieldName": "descriptionText"
|
11362
11431
|
},
|
11363
11432
|
{
|
11364
|
-
"name": "
|
11433
|
+
"name": "header-tag-name",
|
11365
11434
|
"type": {
|
11366
|
-
"text": "
|
11435
|
+
"text": "string"
|
11367
11436
|
},
|
11368
|
-
"description": "The
|
11369
|
-
"
|
11370
|
-
"fieldName": "active",
|
11371
|
-
"inheritedFrom": {
|
11372
|
-
"name": "Buttonsimple",
|
11373
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11374
|
-
}
|
11437
|
+
"description": "The html tag to be used for the header text",
|
11438
|
+
"fieldName": "headerTagName"
|
11375
11439
|
},
|
11376
11440
|
{
|
11377
|
-
"name": "
|
11441
|
+
"name": "description-tag-name",
|
11378
11442
|
"type": {
|
11379
|
-
"text": "
|
11443
|
+
"text": "string"
|
11380
11444
|
},
|
11381
|
-
"description": "
|
11382
|
-
"
|
11383
|
-
"fieldName": "softDisabled",
|
11384
|
-
"inheritedFrom": {
|
11385
|
-
"name": "Buttonsimple",
|
11386
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11387
|
-
}
|
11445
|
+
"description": "The html tag to be used for the below-header description text",
|
11446
|
+
"fieldName": "descriptionTagName"
|
11388
11447
|
},
|
11389
11448
|
{
|
11390
|
-
"name": "
|
11449
|
+
"name": "role",
|
11391
11450
|
"type": {
|
11392
|
-
"text": "
|
11451
|
+
"text": "DialogRole"
|
11393
11452
|
},
|
11394
|
-
"description": "
|
11395
|
-
"default": "
|
11396
|
-
"fieldName": "
|
11397
|
-
"inheritedFrom": {
|
11398
|
-
"name": "Buttonsimple",
|
11399
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11400
|
-
}
|
11453
|
+
"description": "Role of the dialog",
|
11454
|
+
"default": "dialog",
|
11455
|
+
"fieldName": "role"
|
11401
11456
|
},
|
11402
11457
|
{
|
11403
|
-
"name": "
|
11404
|
-
"
|
11405
|
-
|
11406
|
-
|
11407
|
-
"
|
11408
|
-
|
11409
|
-
|
11410
|
-
}
|
11458
|
+
"name": "disable-aria-haspopup",
|
11459
|
+
"type": {
|
11460
|
+
"text": "boolean"
|
11461
|
+
},
|
11462
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
11463
|
+
"default": "false",
|
11464
|
+
"fieldName": "disableAriaHasPopup"
|
11411
11465
|
},
|
11412
11466
|
{
|
11413
|
-
"name": "
|
11467
|
+
"name": "focus-trap",
|
11414
11468
|
"type": {
|
11415
|
-
"text": "
|
11469
|
+
"text": "boolean"
|
11416
11470
|
},
|
11417
|
-
"description": "
|
11418
|
-
"default": "
|
11419
|
-
"fieldName": "
|
11420
|
-
"inheritedFrom": {
|
11421
|
-
"name": "Buttonsimple",
|
11422
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11423
|
-
}
|
11471
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
|
11472
|
+
"default": "true",
|
11473
|
+
"fieldName": "focusTrap"
|
11424
11474
|
},
|
11425
11475
|
{
|
11426
|
-
"name": "
|
11476
|
+
"name": "should-focus-trap-wrap",
|
11427
11477
|
"type": {
|
11428
|
-
"text": "
|
11478
|
+
"text": "boolean"
|
11429
11479
|
},
|
11430
|
-
"
|
11431
|
-
"
|
11432
|
-
"fieldName": "
|
11480
|
+
"default": "true",
|
11481
|
+
"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.",
|
11482
|
+
"fieldName": "shouldFocusTrapWrap",
|
11433
11483
|
"inheritedFrom": {
|
11434
|
-
"name": "
|
11435
|
-
"module": "src/
|
11484
|
+
"name": "FocusTrapMixin",
|
11485
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
11436
11486
|
}
|
11437
11487
|
}
|
11438
11488
|
],
|
11439
|
-
"
|
11440
|
-
"name": "Chip",
|
11441
|
-
"module": "/src/components/chip/chip.component"
|
11442
|
-
},
|
11443
|
-
"tagName": "mdc-filterchip",
|
11444
|
-
"jsDoc": "/**\n * mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\n * They can be found with lists or tables as quick filters.\n *\n * This component is built on top of the mdc-chip component.\n *\n * @tagname mdc-filterchip\n *\n */",
|
11445
|
-
"customElement": true,
|
11446
|
-
"cssProperties": [
|
11489
|
+
"mixins": [
|
11447
11490
|
{
|
11448
|
-
"
|
11449
|
-
"
|
11450
|
-
"inheritedFrom": {
|
11451
|
-
"name": "Chip",
|
11452
|
-
"module": "src/components/chip/chip.component.ts"
|
11453
|
-
}
|
11491
|
+
"name": "PreventScrollMixin",
|
11492
|
+
"module": "/src/utils/mixins/PreventScrollMixin"
|
11454
11493
|
},
|
11455
11494
|
{
|
11456
|
-
"
|
11457
|
-
"
|
11458
|
-
"inheritedFrom": {
|
11459
|
-
"name": "Chip",
|
11460
|
-
"module": "src/components/chip/chip.component.ts"
|
11461
|
-
}
|
11495
|
+
"name": "FocusTrapMixin",
|
11496
|
+
"module": "/src/utils/mixins/FocusTrapMixin"
|
11462
11497
|
},
|
11463
11498
|
{
|
11464
|
-
"
|
11465
|
-
"
|
11466
|
-
"inheritedFrom": {
|
11467
|
-
"name": "Chip",
|
11468
|
-
"module": "src/components/chip/chip.component.ts"
|
11469
|
-
}
|
11499
|
+
"name": "FooterMixin",
|
11500
|
+
"module": "/src/utils/mixins/FooterMixin"
|
11470
11501
|
}
|
11471
11502
|
],
|
11472
|
-
"
|
11473
|
-
|
11474
|
-
|
11475
|
-
|
11476
|
-
|
11477
|
-
|
11478
|
-
|
11479
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11480
|
-
}
|
11481
|
-
},
|
11482
|
-
{
|
11483
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
11484
|
-
"name": "keydown",
|
11485
|
-
"reactName": "onKeyDown",
|
11486
|
-
"inheritedFrom": {
|
11487
|
-
"name": "Buttonsimple",
|
11488
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11489
|
-
}
|
11490
|
-
},
|
11491
|
-
{
|
11492
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
11493
|
-
"name": "keyup",
|
11494
|
-
"reactName": "onKeyUp",
|
11495
|
-
"inheritedFrom": {
|
11496
|
-
"name": "Buttonsimple",
|
11497
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11498
|
-
}
|
11499
|
-
},
|
11500
|
-
{
|
11501
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
11502
|
-
"name": "focus",
|
11503
|
-
"reactName": "onFocus",
|
11504
|
-
"inheritedFrom": {
|
11505
|
-
"name": "Buttonsimple",
|
11506
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
11507
|
-
}
|
11508
|
-
}
|
11509
|
-
]
|
11503
|
+
"superclass": {
|
11504
|
+
"name": "Component",
|
11505
|
+
"module": "/src/models"
|
11506
|
+
},
|
11507
|
+
"tagName": "mdc-dialog",
|
11508
|
+
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
11509
|
+
"customElement": true
|
11510
11510
|
}
|
11511
11511
|
],
|
11512
11512
|
"exports": [
|
@@ -11514,8 +11514,8 @@
|
|
11514
11514
|
"kind": "js",
|
11515
11515
|
"name": "default",
|
11516
11516
|
"declaration": {
|
11517
|
-
"name": "
|
11518
|
-
"module": "components/
|
11517
|
+
"name": "Dialog",
|
11518
|
+
"module": "components/dialog/dialog.component.js"
|
11519
11519
|
}
|
11520
11520
|
}
|
11521
11521
|
]
|