@momentum-design/components 0.104.13 → 0.104.14
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 +9 -6
- package/dist/browser/index.js.map +2 -2
- package/dist/components/progressspinner/progressspinner.component.js +1 -1
- package/dist/components/progressspinner/progressspinner.styles.js +8 -5
- package/dist/custom-elements.json +1328 -1328
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/package.json +1 -1
@@ -15715,268 +15715,588 @@
|
|
15715
15715
|
},
|
15716
15716
|
{
|
15717
15717
|
"kind": "javascript-module",
|
15718
|
-
"path": "components/
|
15718
|
+
"path": "components/linkbutton/linkbutton.component.js",
|
15719
15719
|
"declarations": [
|
15720
15720
|
{
|
15721
15721
|
"kind": "class",
|
15722
|
-
"description": "mdc-
|
15723
|
-
"name": "
|
15724
|
-
"
|
15722
|
+
"description": "`mdc-linkbutton` visually mimics a hyperlink while functioning as a button. It blends the appearance of `mdc-link` with the accessibility and interaction capabilities of `mdc-button`.\n\n### Features:\n- Looks like a link, behaves like a button.\n- Supports slots for a text label and an optional trailing icon.\n- Inherits accessibility and keyboard interaction behavior from `mdc-buttonsimple`.",
|
15723
|
+
"name": "LinkButton",
|
15724
|
+
"cssProperties": [
|
15725
15725
|
{
|
15726
|
-
"description": "
|
15727
|
-
"name": "
|
15726
|
+
"description": "Border radius of the linkbutton.",
|
15727
|
+
"name": "--mdc-link-border-radius"
|
15728
|
+
},
|
15729
|
+
{
|
15730
|
+
"description": "Color of the linkbutton’s child content in the active state.",
|
15731
|
+
"name": "--mdc-link-color-active"
|
15732
|
+
},
|
15733
|
+
{
|
15734
|
+
"description": "Color of the linkbutton’s child content in the disabled state.",
|
15735
|
+
"name": "--mdc-link-color-disabled"
|
15736
|
+
},
|
15737
|
+
{
|
15738
|
+
"description": "Color of the linkbutton’s child content in the hover state.",
|
15739
|
+
"name": "--mdc-link-color-hover"
|
15740
|
+
},
|
15741
|
+
{
|
15742
|
+
"description": "Color of the linkbutton’s child content in the normal state.",
|
15743
|
+
"name": "--mdc-link-color-normal"
|
15744
|
+
},
|
15745
|
+
{
|
15746
|
+
"description": "Color of the inverted linkbutton’s child content in the active state.",
|
15747
|
+
"name": "--mdc-link-inverted-color-active"
|
15748
|
+
},
|
15749
|
+
{
|
15750
|
+
"description": "Color of the inverted linkbutton’s child content in the disabled state.",
|
15751
|
+
"name": "--mdc-link-inverted-color-disabled"
|
15752
|
+
},
|
15753
|
+
{
|
15754
|
+
"description": "Color of the inverted linkbutton’s child content in the hover state.",
|
15755
|
+
"name": "--mdc-link-inverted-color-hover"
|
15756
|
+
},
|
15757
|
+
{
|
15758
|
+
"description": "Color of the inverted linkbutton’s child content in the normal state.",
|
15759
|
+
"name": "--mdc-link-inverted-color-normal"
|
15728
15760
|
}
|
15729
15761
|
],
|
15730
15762
|
"slots": [
|
15731
15763
|
{
|
15732
|
-
"description": "
|
15733
|
-
"name": "
|
15734
|
-
},
|
15735
|
-
{
|
15736
|
-
"description": "This slot is used to pass a header for the list, which can be a `mdc-listheader` component.",
|
15737
|
-
"name": "list-header"
|
15764
|
+
"description": "Text label of the linkbutton.",
|
15765
|
+
"name": ""
|
15738
15766
|
}
|
15739
15767
|
],
|
15740
15768
|
"members": [
|
15769
|
+
{
|
15770
|
+
"kind": "field",
|
15771
|
+
"name": "size",
|
15772
|
+
"type": {
|
15773
|
+
"text": "ButtonSize"
|
15774
|
+
},
|
15775
|
+
"description": "Sets the size of the linkbutton.\nAcceptable values: \n- 12\n- 14\n- 16",
|
15776
|
+
"default": "16",
|
15777
|
+
"attribute": "size",
|
15778
|
+
"reflects": true,
|
15779
|
+
"inheritedFrom": {
|
15780
|
+
"name": "Buttonsimple",
|
15781
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15782
|
+
}
|
15783
|
+
},
|
15784
|
+
{
|
15785
|
+
"kind": "field",
|
15786
|
+
"name": "inline",
|
15787
|
+
"type": {
|
15788
|
+
"text": "boolean"
|
15789
|
+
},
|
15790
|
+
"description": "The linkbutton can be inline or standalone.",
|
15791
|
+
"default": "false",
|
15792
|
+
"attribute": "inline",
|
15793
|
+
"reflects": true
|
15794
|
+
},
|
15795
|
+
{
|
15796
|
+
"kind": "field",
|
15797
|
+
"name": "inverted",
|
15798
|
+
"type": {
|
15799
|
+
"text": "boolean"
|
15800
|
+
},
|
15801
|
+
"description": "The linkbutton color can be inverted by setting the inverted attribute to true.",
|
15802
|
+
"default": "false",
|
15803
|
+
"attribute": "inverted",
|
15804
|
+
"reflects": true
|
15805
|
+
},
|
15741
15806
|
{
|
15742
15807
|
"kind": "method",
|
15743
|
-
"name": "
|
15808
|
+
"name": "setSize",
|
15744
15809
|
"privacy": "private",
|
15745
|
-
"return": {
|
15746
|
-
"type": {
|
15747
|
-
"text": "void"
|
15748
|
-
}
|
15749
|
-
},
|
15750
15810
|
"parameters": [
|
15751
15811
|
{
|
15752
|
-
"name": "
|
15812
|
+
"name": "size",
|
15753
15813
|
"type": {
|
15754
|
-
"text": "
|
15814
|
+
"text": "LinkButtonSize"
|
15755
15815
|
},
|
15756
|
-
"description": "The
|
15816
|
+
"description": "The desired link size."
|
15757
15817
|
}
|
15758
15818
|
],
|
15759
|
-
"description": "
|
15819
|
+
"description": "Sets the `size` attribute for the linkbutton, falling back to the default if the value is invalid."
|
15760
15820
|
},
|
15761
15821
|
{
|
15762
|
-
"kind": "
|
15763
|
-
"name": "
|
15764
|
-
"
|
15765
|
-
|
15766
|
-
|
15767
|
-
|
15768
|
-
|
15822
|
+
"kind": "field",
|
15823
|
+
"name": "iconName",
|
15824
|
+
"type": {
|
15825
|
+
"text": "IconNames | undefined"
|
15826
|
+
},
|
15827
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
15828
|
+
"attribute": "icon-name",
|
15829
|
+
"inheritedFrom": {
|
15830
|
+
"name": "IconNameMixin",
|
15831
|
+
"module": "utils/mixins/IconNameMixin.js"
|
15832
|
+
}
|
15833
|
+
},
|
15834
|
+
{
|
15835
|
+
"kind": "field",
|
15836
|
+
"name": "autofocus",
|
15837
|
+
"type": {
|
15838
|
+
"text": "boolean"
|
15839
|
+
},
|
15840
|
+
"default": "false",
|
15841
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
15842
|
+
"attribute": "autofocus",
|
15843
|
+
"reflects": true,
|
15844
|
+
"inheritedFrom": {
|
15845
|
+
"name": "Buttonsimple",
|
15846
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15847
|
+
}
|
15848
|
+
},
|
15849
|
+
{
|
15850
|
+
"kind": "field",
|
15851
|
+
"name": "tabIndex",
|
15852
|
+
"type": {
|
15853
|
+
"text": "number"
|
15854
|
+
},
|
15855
|
+
"default": "0",
|
15856
|
+
"description": "This property specifies the tab order of the element.",
|
15857
|
+
"attribute": "tabIndex",
|
15858
|
+
"reflects": true,
|
15859
|
+
"inheritedFrom": {
|
15860
|
+
"name": "Buttonsimple",
|
15861
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15862
|
+
}
|
15863
|
+
},
|
15864
|
+
{
|
15865
|
+
"kind": "field",
|
15866
|
+
"name": "disabled",
|
15867
|
+
"type": {
|
15868
|
+
"text": "boolean | undefined"
|
15869
|
+
},
|
15870
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
15871
|
+
"default": "undefined",
|
15872
|
+
"attribute": "disabled",
|
15873
|
+
"reflects": true,
|
15874
|
+
"inheritedFrom": {
|
15875
|
+
"name": "Buttonsimple",
|
15876
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15877
|
+
}
|
15878
|
+
},
|
15879
|
+
{
|
15880
|
+
"kind": "field",
|
15881
|
+
"name": "active",
|
15882
|
+
"type": {
|
15883
|
+
"text": "boolean | undefined"
|
15884
|
+
},
|
15885
|
+
"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.",
|
15886
|
+
"default": "undefined",
|
15887
|
+
"attribute": "active",
|
15888
|
+
"reflects": true,
|
15889
|
+
"inheritedFrom": {
|
15890
|
+
"name": "Buttonsimple",
|
15891
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15892
|
+
}
|
15893
|
+
},
|
15894
|
+
{
|
15895
|
+
"kind": "field",
|
15896
|
+
"name": "softDisabled",
|
15897
|
+
"type": {
|
15898
|
+
"text": "boolean | undefined"
|
15899
|
+
},
|
15900
|
+
"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.",
|
15901
|
+
"default": "undefined",
|
15902
|
+
"attribute": "soft-disabled",
|
15903
|
+
"reflects": true,
|
15904
|
+
"inheritedFrom": {
|
15905
|
+
"name": "Buttonsimple",
|
15906
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15907
|
+
}
|
15908
|
+
},
|
15909
|
+
{
|
15910
|
+
"kind": "field",
|
15911
|
+
"name": "role",
|
15912
|
+
"type": {
|
15913
|
+
"text": "RoleType"
|
15914
|
+
},
|
15915
|
+
"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.",
|
15916
|
+
"default": "button",
|
15917
|
+
"attribute": "role",
|
15918
|
+
"reflects": true,
|
15919
|
+
"inheritedFrom": {
|
15920
|
+
"name": "Buttonsimple",
|
15921
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15922
|
+
}
|
15923
|
+
},
|
15924
|
+
{
|
15925
|
+
"kind": "field",
|
15926
|
+
"name": "ariaStateKey",
|
15927
|
+
"type": {
|
15928
|
+
"text": "string | undefined"
|
15929
|
+
},
|
15930
|
+
"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`",
|
15931
|
+
"default": "'aria-pressed' (when)",
|
15932
|
+
"attribute": "ariaStateKey",
|
15933
|
+
"reflects": true,
|
15934
|
+
"inheritedFrom": {
|
15935
|
+
"name": "Buttonsimple",
|
15936
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15937
|
+
}
|
15938
|
+
},
|
15939
|
+
{
|
15940
|
+
"kind": "field",
|
15941
|
+
"name": "type",
|
15942
|
+
"type": {
|
15943
|
+
"text": "ButtonType"
|
15769
15944
|
},
|
15945
|
+
"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.",
|
15946
|
+
"default": "button",
|
15947
|
+
"attribute": "type",
|
15948
|
+
"reflects": true,
|
15949
|
+
"inheritedFrom": {
|
15950
|
+
"name": "Buttonsimple",
|
15951
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15952
|
+
}
|
15953
|
+
},
|
15954
|
+
{
|
15955
|
+
"kind": "method",
|
15956
|
+
"name": "executeAction",
|
15957
|
+
"privacy": "protected",
|
15958
|
+
"inheritedFrom": {
|
15959
|
+
"name": "Buttonsimple",
|
15960
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15961
|
+
}
|
15962
|
+
},
|
15963
|
+
{
|
15964
|
+
"kind": "method",
|
15965
|
+
"name": "setActive",
|
15966
|
+
"privacy": "protected",
|
15770
15967
|
"parameters": [
|
15771
15968
|
{
|
15772
|
-
"name": "
|
15969
|
+
"name": "element",
|
15773
15970
|
"type": {
|
15774
|
-
"text": "
|
15971
|
+
"text": "HTMLElement"
|
15775
15972
|
},
|
15776
|
-
"description": "The
|
15973
|
+
"description": "The button element"
|
15974
|
+
},
|
15975
|
+
{
|
15976
|
+
"name": "active",
|
15977
|
+
"optional": true,
|
15978
|
+
"type": {
|
15979
|
+
"text": "boolean"
|
15980
|
+
},
|
15981
|
+
"description": "The active state of the element"
|
15777
15982
|
}
|
15778
15983
|
],
|
15779
|
-
"description": "
|
15984
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
15985
|
+
"inheritedFrom": {
|
15986
|
+
"name": "Buttonsimple",
|
15987
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
15988
|
+
}
|
15780
15989
|
},
|
15781
15990
|
{
|
15782
15991
|
"kind": "method",
|
15783
|
-
"name": "
|
15992
|
+
"name": "setSoftDisabled",
|
15784
15993
|
"privacy": "private",
|
15785
|
-
"return": {
|
15786
|
-
"type": {
|
15787
|
-
"text": ""
|
15788
|
-
}
|
15789
|
-
},
|
15790
15994
|
"parameters": [
|
15791
15995
|
{
|
15792
|
-
"name": "
|
15996
|
+
"name": "element",
|
15793
15997
|
"type": {
|
15794
|
-
"text": "
|
15998
|
+
"text": "HTMLElement"
|
15795
15999
|
},
|
15796
|
-
"description": "The
|
16000
|
+
"description": "The button element."
|
15797
16001
|
},
|
15798
16002
|
{
|
15799
|
-
"name": "
|
16003
|
+
"name": "softDisabled",
|
16004
|
+
"optional": true,
|
15800
16005
|
"type": {
|
15801
|
-
"text": "
|
16006
|
+
"text": "boolean"
|
15802
16007
|
},
|
15803
|
-
"description": "The
|
16008
|
+
"description": "The soft-disabled state."
|
16009
|
+
}
|
16010
|
+
],
|
16011
|
+
"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.",
|
16012
|
+
"inheritedFrom": {
|
16013
|
+
"name": "Buttonsimple",
|
16014
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
16015
|
+
}
|
16016
|
+
},
|
16017
|
+
{
|
16018
|
+
"kind": "method",
|
16019
|
+
"name": "setDisabled",
|
16020
|
+
"privacy": "private",
|
16021
|
+
"parameters": [
|
16022
|
+
{
|
16023
|
+
"name": "element",
|
16024
|
+
"type": {
|
16025
|
+
"text": "HTMLElement"
|
16026
|
+
},
|
16027
|
+
"description": "The button element."
|
15804
16028
|
},
|
15805
16029
|
{
|
15806
|
-
"name": "
|
16030
|
+
"name": "disabled",
|
15807
16031
|
"type": {
|
15808
|
-
"text": "
|
16032
|
+
"text": "boolean"
|
15809
16033
|
},
|
15810
|
-
"description": "The
|
16034
|
+
"description": "The disabled state."
|
15811
16035
|
}
|
15812
16036
|
],
|
15813
|
-
"description": "
|
16037
|
+
"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.",
|
16038
|
+
"inheritedFrom": {
|
16039
|
+
"name": "Buttonsimple",
|
16040
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
16041
|
+
}
|
15814
16042
|
},
|
15815
16043
|
{
|
15816
16044
|
"kind": "method",
|
15817
|
-
"name": "
|
15818
|
-
"privacy": "
|
15819
|
-
"
|
15820
|
-
"
|
15821
|
-
|
15822
|
-
|
15823
|
-
|
16045
|
+
"name": "triggerClickEvent",
|
16046
|
+
"privacy": "private",
|
16047
|
+
"inheritedFrom": {
|
16048
|
+
"name": "Buttonsimple",
|
16049
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
16050
|
+
}
|
16051
|
+
},
|
16052
|
+
{
|
16053
|
+
"kind": "method",
|
16054
|
+
"name": "handleBlur",
|
16055
|
+
"privacy": "private",
|
16056
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
16057
|
+
"inheritedFrom": {
|
16058
|
+
"name": "Buttonsimple",
|
16059
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
16060
|
+
}
|
16061
|
+
},
|
16062
|
+
{
|
16063
|
+
"kind": "method",
|
16064
|
+
"name": "handleKeyDown",
|
16065
|
+
"privacy": "private",
|
15824
16066
|
"parameters": [
|
15825
16067
|
{
|
15826
16068
|
"name": "event",
|
15827
16069
|
"type": {
|
15828
|
-
"text": "
|
16070
|
+
"text": "KeyboardEvent"
|
15829
16071
|
},
|
15830
|
-
"description": "The
|
16072
|
+
"description": "The keyboard event."
|
15831
16073
|
}
|
15832
16074
|
],
|
15833
|
-
"description": "Handles the
|
16075
|
+
"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.",
|
16076
|
+
"inheritedFrom": {
|
16077
|
+
"name": "Buttonsimple",
|
16078
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
16079
|
+
}
|
15834
16080
|
},
|
15835
16081
|
{
|
15836
16082
|
"kind": "method",
|
15837
|
-
"name": "
|
16083
|
+
"name": "handleKeyUp",
|
15838
16084
|
"privacy": "private",
|
15839
16085
|
"parameters": [
|
15840
16086
|
{
|
15841
|
-
"name": "
|
16087
|
+
"name": "event",
|
15842
16088
|
"type": {
|
15843
|
-
"text": "
|
16089
|
+
"text": "KeyboardEvent"
|
15844
16090
|
},
|
15845
|
-
"description": "The
|
16091
|
+
"description": "The keyboard event."
|
15846
16092
|
}
|
15847
16093
|
],
|
15848
|
-
"description": "
|
16094
|
+
"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.",
|
16095
|
+
"inheritedFrom": {
|
16096
|
+
"name": "Buttonsimple",
|
16097
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
16098
|
+
}
|
15849
16099
|
}
|
15850
16100
|
],
|
15851
|
-
"
|
15852
|
-
"name": "Component",
|
15853
|
-
"module": "/src/models"
|
15854
|
-
},
|
15855
|
-
"tagName": "mdc-list",
|
15856
|
-
"jsDoc": "/**\n * mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.\n *\n * To add a header to the list, use the `mdc-listheader` component and place it in the `list-header` slot.\n * `mdc-listitem` components can be placed in the default slot.\n *\n * @tagname mdc-list\n *\n * @slot default - This is a default/unnamed slot, where listitems can be placed.\n * @slot list-header - This slot is used to pass a header for the list, which can be a `mdc-listheader` component.\n *\n * @csspart container - The container slot around the list items\n */",
|
15857
|
-
"customElement": true
|
15858
|
-
}
|
15859
|
-
],
|
15860
|
-
"exports": [
|
15861
|
-
{
|
15862
|
-
"kind": "js",
|
15863
|
-
"name": "default",
|
15864
|
-
"declaration": {
|
15865
|
-
"name": "List",
|
15866
|
-
"module": "components/list/list.component.js"
|
15867
|
-
}
|
15868
|
-
}
|
15869
|
-
]
|
15870
|
-
},
|
15871
|
-
{
|
15872
|
-
"kind": "javascript-module",
|
15873
|
-
"path": "components/listheader/listheader.component.js",
|
15874
|
-
"declarations": [
|
15875
|
-
{
|
15876
|
-
"kind": "class",
|
15877
|
-
"description": "Listheader component is used to display a header in a list.\nIt can include icons before and after the header text, and allows for additional content via slots.",
|
15878
|
-
"name": "Listheader",
|
15879
|
-
"cssProperties": [
|
16101
|
+
"events": [
|
15880
16102
|
{
|
15881
|
-
"description": "
|
15882
|
-
"name": "
|
16103
|
+
"description": "(React: onClick) This event is dispatched when the linkbutton is clicked.",
|
16104
|
+
"name": "click",
|
16105
|
+
"reactName": "onClick",
|
16106
|
+
"inheritedFrom": {
|
16107
|
+
"name": "Buttonsimple",
|
16108
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16109
|
+
}
|
15883
16110
|
},
|
15884
16111
|
{
|
15885
|
-
"description": "
|
15886
|
-
"name": "
|
16112
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the linkbutton.",
|
16113
|
+
"name": "keydown",
|
16114
|
+
"reactName": "onKeyDown",
|
16115
|
+
"inheritedFrom": {
|
16116
|
+
"name": "Buttonsimple",
|
16117
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16118
|
+
}
|
15887
16119
|
},
|
15888
16120
|
{
|
15889
|
-
"description": "
|
15890
|
-
"name": "
|
15891
|
-
|
15892
|
-
|
15893
|
-
|
16121
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the linkbutton.",
|
16122
|
+
"name": "keyup",
|
16123
|
+
"reactName": "onKeyUp",
|
16124
|
+
"inheritedFrom": {
|
16125
|
+
"name": "Buttonsimple",
|
16126
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16127
|
+
}
|
16128
|
+
},
|
15894
16129
|
{
|
15895
|
-
"description": "
|
15896
|
-
"name": "
|
16130
|
+
"description": "(React: onFocus) This event is dispatched when the linkbutton receives focus.",
|
16131
|
+
"name": "focus",
|
16132
|
+
"reactName": "onFocus",
|
16133
|
+
"inheritedFrom": {
|
16134
|
+
"name": "Buttonsimple",
|
16135
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16136
|
+
}
|
15897
16137
|
}
|
15898
16138
|
],
|
15899
|
-
"
|
16139
|
+
"attributes": [
|
15900
16140
|
{
|
15901
|
-
"
|
15902
|
-
"name": "prefixIcon",
|
16141
|
+
"name": "size",
|
15903
16142
|
"type": {
|
15904
|
-
"text": "
|
16143
|
+
"text": "ButtonSize"
|
15905
16144
|
},
|
15906
|
-
"description": "
|
15907
|
-
"
|
16145
|
+
"description": "Sets the size of the linkbutton.\nAcceptable values: \n- 12\n- 14\n- 16",
|
16146
|
+
"default": "16",
|
16147
|
+
"fieldName": "size",
|
16148
|
+
"inheritedFrom": {
|
16149
|
+
"name": "Buttonsimple",
|
16150
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16151
|
+
}
|
15908
16152
|
},
|
15909
16153
|
{
|
15910
|
-
"
|
15911
|
-
"name": "postfixIcon",
|
16154
|
+
"name": "inline",
|
15912
16155
|
"type": {
|
15913
|
-
"text": "
|
16156
|
+
"text": "boolean"
|
15914
16157
|
},
|
15915
|
-
"description": "
|
15916
|
-
"
|
16158
|
+
"description": "The linkbutton can be inline or standalone.",
|
16159
|
+
"default": "false",
|
16160
|
+
"fieldName": "inline"
|
15917
16161
|
},
|
15918
16162
|
{
|
15919
|
-
"
|
15920
|
-
"name": "headerText",
|
16163
|
+
"name": "inverted",
|
15921
16164
|
"type": {
|
15922
|
-
"text": "
|
16165
|
+
"text": "boolean"
|
15923
16166
|
},
|
15924
|
-
"description": "
|
15925
|
-
"
|
16167
|
+
"description": "The linkbutton color can be inverted by setting the inverted attribute to true.",
|
16168
|
+
"default": "false",
|
16169
|
+
"fieldName": "inverted"
|
15926
16170
|
},
|
15927
16171
|
{
|
15928
|
-
"
|
15929
|
-
"
|
16172
|
+
"name": "icon-name",
|
16173
|
+
"type": {
|
16174
|
+
"text": "IconNames | undefined"
|
16175
|
+
},
|
16176
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
16177
|
+
"fieldName": "iconName",
|
16178
|
+
"inheritedFrom": {
|
16179
|
+
"name": "IconNameMixin",
|
16180
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
16181
|
+
}
|
16182
|
+
},
|
16183
|
+
{
|
16184
|
+
"name": "autofocus",
|
15930
16185
|
"type": {
|
15931
16186
|
"text": "boolean"
|
15932
16187
|
},
|
15933
16188
|
"default": "false",
|
15934
|
-
"description": "
|
15935
|
-
"
|
15936
|
-
"
|
15937
|
-
|
15938
|
-
|
15939
|
-
|
16189
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
16190
|
+
"fieldName": "autofocus",
|
16191
|
+
"inheritedFrom": {
|
16192
|
+
"name": "Buttonsimple",
|
16193
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16194
|
+
}
|
16195
|
+
},
|
15940
16196
|
{
|
15941
|
-
"name": "
|
16197
|
+
"name": "tabIndex",
|
15942
16198
|
"type": {
|
15943
|
-
"text": "
|
16199
|
+
"text": "number"
|
15944
16200
|
},
|
15945
|
-
"
|
15946
|
-
"
|
16201
|
+
"default": "0",
|
16202
|
+
"description": "This property specifies the tab order of the element.",
|
16203
|
+
"fieldName": "tabIndex",
|
16204
|
+
"inheritedFrom": {
|
16205
|
+
"name": "Buttonsimple",
|
16206
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16207
|
+
}
|
15947
16208
|
},
|
15948
16209
|
{
|
15949
|
-
"name": "
|
16210
|
+
"name": "disabled",
|
15950
16211
|
"type": {
|
15951
|
-
"text": "
|
16212
|
+
"text": "boolean | undefined"
|
15952
16213
|
},
|
15953
|
-
"description": "
|
15954
|
-
"
|
16214
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16215
|
+
"default": "undefined",
|
16216
|
+
"fieldName": "disabled",
|
16217
|
+
"inheritedFrom": {
|
16218
|
+
"name": "Buttonsimple",
|
16219
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16220
|
+
}
|
15955
16221
|
},
|
15956
16222
|
{
|
15957
|
-
"name": "
|
16223
|
+
"name": "active",
|
16224
|
+
"type": {
|
16225
|
+
"text": "boolean | undefined"
|
16226
|
+
},
|
16227
|
+
"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.",
|
16228
|
+
"default": "undefined",
|
16229
|
+
"fieldName": "active",
|
16230
|
+
"inheritedFrom": {
|
16231
|
+
"name": "Buttonsimple",
|
16232
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16233
|
+
}
|
16234
|
+
},
|
16235
|
+
{
|
16236
|
+
"name": "soft-disabled",
|
16237
|
+
"type": {
|
16238
|
+
"text": "boolean | undefined"
|
16239
|
+
},
|
16240
|
+
"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.",
|
16241
|
+
"default": "undefined",
|
16242
|
+
"fieldName": "softDisabled",
|
16243
|
+
"inheritedFrom": {
|
16244
|
+
"name": "Buttonsimple",
|
16245
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16246
|
+
}
|
16247
|
+
},
|
16248
|
+
{
|
16249
|
+
"name": "role",
|
16250
|
+
"type": {
|
16251
|
+
"text": "RoleType"
|
16252
|
+
},
|
16253
|
+
"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.",
|
16254
|
+
"default": "button",
|
16255
|
+
"fieldName": "role",
|
16256
|
+
"inheritedFrom": {
|
16257
|
+
"name": "Buttonsimple",
|
16258
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16259
|
+
}
|
16260
|
+
},
|
16261
|
+
{
|
16262
|
+
"name": "ariaStateKey",
|
15958
16263
|
"type": {
|
15959
16264
|
"text": "string | undefined"
|
15960
16265
|
},
|
15961
|
-
"description": "
|
15962
|
-
"
|
16266
|
+
"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`",
|
16267
|
+
"default": "'aria-pressed' (when)",
|
16268
|
+
"fieldName": "ariaStateKey",
|
16269
|
+
"inheritedFrom": {
|
16270
|
+
"name": "Buttonsimple",
|
16271
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16272
|
+
}
|
15963
16273
|
},
|
15964
16274
|
{
|
15965
|
-
"name": "
|
16275
|
+
"name": "type",
|
15966
16276
|
"type": {
|
15967
|
-
"text": "
|
16277
|
+
"text": "ButtonType"
|
15968
16278
|
},
|
15969
|
-
"
|
15970
|
-
"
|
15971
|
-
"fieldName": "
|
16279
|
+
"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.",
|
16280
|
+
"default": "button",
|
16281
|
+
"fieldName": "type",
|
16282
|
+
"inheritedFrom": {
|
16283
|
+
"name": "Buttonsimple",
|
16284
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16285
|
+
}
|
16286
|
+
}
|
16287
|
+
],
|
16288
|
+
"mixins": [
|
16289
|
+
{
|
16290
|
+
"name": "IconNameMixin",
|
16291
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
15972
16292
|
}
|
15973
16293
|
],
|
15974
16294
|
"superclass": {
|
15975
|
-
"name": "
|
15976
|
-
"module": "/src/
|
16295
|
+
"name": "Buttonsimple",
|
16296
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
15977
16297
|
},
|
15978
|
-
"tagName": "mdc-
|
15979
|
-
"jsDoc": "/**\n *
|
16298
|
+
"tagName": "mdc-linkbutton",
|
16299
|
+
"jsDoc": "/**\n * `mdc-linkbutton` visually mimics a hyperlink while functioning as a button. It blends the appearance of `mdc-link` with the accessibility and interaction capabilities of `mdc-button`.\n *\n * ### Features:\n * - Looks like a link, behaves like a button.\n * - Supports slots for a text label and an optional trailing icon.\n * - Inherits accessibility and keyboard interaction behavior from `mdc-buttonsimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-linkbutton\n *\n * @slot - Text label of the linkbutton.\n *\n * @event click - (React: onClick) This event is dispatched when the linkbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the linkbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the linkbutton.\n * @event focus - (React: onFocus) This event is dispatched when the linkbutton receives focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the linkbutton.\n * @cssproperty --mdc-link-color-active - Color of the linkbutton’s child content in the active state.\n * @cssproperty --mdc-link-color-disabled - Color of the linkbutton’s child content in the disabled state.\n * @cssproperty --mdc-link-color-hover - Color of the linkbutton’s child content in the hover state.\n * @cssproperty --mdc-link-color-normal - Color of the linkbutton’s child content in the normal state.\n * @cssproperty --mdc-link-inverted-color-active - Color of the inverted linkbutton’s child content in the active state.\n * @cssproperty --mdc-link-inverted-color-disabled - Color of the inverted linkbutton’s child content in the disabled state.\n * @cssproperty --mdc-link-inverted-color-hover - Color of the inverted linkbutton’s child content in the hover state.\n * @cssproperty --mdc-link-inverted-color-normal - Color of the inverted linkbutton’s child content in the normal state.\n */",
|
15980
16300
|
"customElement": true
|
15981
16301
|
}
|
15982
16302
|
],
|
@@ -15985,8 +16305,8 @@
|
|
15985
16305
|
"kind": "js",
|
15986
16306
|
"name": "default",
|
15987
16307
|
"declaration": {
|
15988
|
-
"name": "
|
15989
|
-
"module": "components/
|
16308
|
+
"name": "LinkButton",
|
16309
|
+
"module": "components/linkbutton/linkbutton.component.js"
|
15990
16310
|
}
|
15991
16311
|
}
|
15992
16312
|
]
|
@@ -16282,588 +16602,268 @@
|
|
16282
16602
|
},
|
16283
16603
|
{
|
16284
16604
|
"kind": "javascript-module",
|
16285
|
-
"path": "components/
|
16605
|
+
"path": "components/list/list.component.js",
|
16286
16606
|
"declarations": [
|
16287
16607
|
{
|
16288
16608
|
"kind": "class",
|
16289
|
-
"description": "
|
16290
|
-
"name": "
|
16291
|
-
"
|
16292
|
-
{
|
16293
|
-
"description": "Border radius of the linkbutton.",
|
16294
|
-
"name": "--mdc-link-border-radius"
|
16295
|
-
},
|
16296
|
-
{
|
16297
|
-
"description": "Color of the linkbutton’s child content in the active state.",
|
16298
|
-
"name": "--mdc-link-color-active"
|
16299
|
-
},
|
16300
|
-
{
|
16301
|
-
"description": "Color of the linkbutton’s child content in the disabled state.",
|
16302
|
-
"name": "--mdc-link-color-disabled"
|
16303
|
-
},
|
16304
|
-
{
|
16305
|
-
"description": "Color of the linkbutton’s child content in the hover state.",
|
16306
|
-
"name": "--mdc-link-color-hover"
|
16307
|
-
},
|
16308
|
-
{
|
16309
|
-
"description": "Color of the linkbutton’s child content in the normal state.",
|
16310
|
-
"name": "--mdc-link-color-normal"
|
16311
|
-
},
|
16312
|
-
{
|
16313
|
-
"description": "Color of the inverted linkbutton’s child content in the active state.",
|
16314
|
-
"name": "--mdc-link-inverted-color-active"
|
16315
|
-
},
|
16316
|
-
{
|
16317
|
-
"description": "Color of the inverted linkbutton’s child content in the disabled state.",
|
16318
|
-
"name": "--mdc-link-inverted-color-disabled"
|
16319
|
-
},
|
16320
|
-
{
|
16321
|
-
"description": "Color of the inverted linkbutton’s child content in the hover state.",
|
16322
|
-
"name": "--mdc-link-inverted-color-hover"
|
16323
|
-
},
|
16324
|
-
{
|
16325
|
-
"description": "Color of the inverted linkbutton’s child content in the normal state.",
|
16326
|
-
"name": "--mdc-link-inverted-color-normal"
|
16327
|
-
}
|
16328
|
-
],
|
16329
|
-
"slots": [
|
16609
|
+
"description": "mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.\n\nTo add a header to the list, use the `mdc-listheader` component and place it in the `list-header` slot.\n`mdc-listitem` components can be placed in the default slot.",
|
16610
|
+
"name": "List",
|
16611
|
+
"cssParts": [
|
16330
16612
|
{
|
16331
|
-
"description": "
|
16332
|
-
"name": ""
|
16613
|
+
"description": "The container slot around the list items",
|
16614
|
+
"name": "container"
|
16333
16615
|
}
|
16334
16616
|
],
|
16335
|
-
"
|
16336
|
-
{
|
16337
|
-
"
|
16338
|
-
"name": "
|
16339
|
-
"type": {
|
16340
|
-
"text": "ButtonSize"
|
16341
|
-
},
|
16342
|
-
"description": "Sets the size of the linkbutton.\nAcceptable values: \n- 12\n- 14\n- 16",
|
16343
|
-
"default": "16",
|
16344
|
-
"attribute": "size",
|
16345
|
-
"reflects": true,
|
16346
|
-
"inheritedFrom": {
|
16347
|
-
"name": "Buttonsimple",
|
16348
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16349
|
-
}
|
16350
|
-
},
|
16351
|
-
{
|
16352
|
-
"kind": "field",
|
16353
|
-
"name": "inline",
|
16354
|
-
"type": {
|
16355
|
-
"text": "boolean"
|
16356
|
-
},
|
16357
|
-
"description": "The linkbutton can be inline or standalone.",
|
16358
|
-
"default": "false",
|
16359
|
-
"attribute": "inline",
|
16360
|
-
"reflects": true
|
16361
|
-
},
|
16362
|
-
{
|
16363
|
-
"kind": "field",
|
16364
|
-
"name": "inverted",
|
16365
|
-
"type": {
|
16366
|
-
"text": "boolean"
|
16367
|
-
},
|
16368
|
-
"description": "The linkbutton color can be inverted by setting the inverted attribute to true.",
|
16369
|
-
"default": "false",
|
16370
|
-
"attribute": "inverted",
|
16371
|
-
"reflects": true
|
16372
|
-
},
|
16373
|
-
{
|
16374
|
-
"kind": "method",
|
16375
|
-
"name": "setSize",
|
16376
|
-
"privacy": "private",
|
16377
|
-
"parameters": [
|
16378
|
-
{
|
16379
|
-
"name": "size",
|
16380
|
-
"type": {
|
16381
|
-
"text": "LinkButtonSize"
|
16382
|
-
},
|
16383
|
-
"description": "The desired link size."
|
16384
|
-
}
|
16385
|
-
],
|
16386
|
-
"description": "Sets the `size` attribute for the linkbutton, falling back to the default if the value is invalid."
|
16387
|
-
},
|
16388
|
-
{
|
16389
|
-
"kind": "field",
|
16390
|
-
"name": "iconName",
|
16391
|
-
"type": {
|
16392
|
-
"text": "IconNames | undefined"
|
16393
|
-
},
|
16394
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
16395
|
-
"attribute": "icon-name",
|
16396
|
-
"inheritedFrom": {
|
16397
|
-
"name": "IconNameMixin",
|
16398
|
-
"module": "utils/mixins/IconNameMixin.js"
|
16399
|
-
}
|
16400
|
-
},
|
16401
|
-
{
|
16402
|
-
"kind": "field",
|
16403
|
-
"name": "autofocus",
|
16404
|
-
"type": {
|
16405
|
-
"text": "boolean"
|
16406
|
-
},
|
16407
|
-
"default": "false",
|
16408
|
-
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
16409
|
-
"attribute": "autofocus",
|
16410
|
-
"reflects": true,
|
16411
|
-
"inheritedFrom": {
|
16412
|
-
"name": "Buttonsimple",
|
16413
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16414
|
-
}
|
16415
|
-
},
|
16416
|
-
{
|
16417
|
-
"kind": "field",
|
16418
|
-
"name": "tabIndex",
|
16419
|
-
"type": {
|
16420
|
-
"text": "number"
|
16421
|
-
},
|
16422
|
-
"default": "0",
|
16423
|
-
"description": "This property specifies the tab order of the element.",
|
16424
|
-
"attribute": "tabIndex",
|
16425
|
-
"reflects": true,
|
16426
|
-
"inheritedFrom": {
|
16427
|
-
"name": "Buttonsimple",
|
16428
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16429
|
-
}
|
16430
|
-
},
|
16431
|
-
{
|
16432
|
-
"kind": "field",
|
16433
|
-
"name": "disabled",
|
16434
|
-
"type": {
|
16435
|
-
"text": "boolean | undefined"
|
16436
|
-
},
|
16437
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16438
|
-
"default": "undefined",
|
16439
|
-
"attribute": "disabled",
|
16440
|
-
"reflects": true,
|
16441
|
-
"inheritedFrom": {
|
16442
|
-
"name": "Buttonsimple",
|
16443
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16444
|
-
}
|
16445
|
-
},
|
16446
|
-
{
|
16447
|
-
"kind": "field",
|
16448
|
-
"name": "active",
|
16449
|
-
"type": {
|
16450
|
-
"text": "boolean | undefined"
|
16451
|
-
},
|
16452
|
-
"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.",
|
16453
|
-
"default": "undefined",
|
16454
|
-
"attribute": "active",
|
16455
|
-
"reflects": true,
|
16456
|
-
"inheritedFrom": {
|
16457
|
-
"name": "Buttonsimple",
|
16458
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16459
|
-
}
|
16460
|
-
},
|
16461
|
-
{
|
16462
|
-
"kind": "field",
|
16463
|
-
"name": "softDisabled",
|
16464
|
-
"type": {
|
16465
|
-
"text": "boolean | undefined"
|
16466
|
-
},
|
16467
|
-
"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.",
|
16468
|
-
"default": "undefined",
|
16469
|
-
"attribute": "soft-disabled",
|
16470
|
-
"reflects": true,
|
16471
|
-
"inheritedFrom": {
|
16472
|
-
"name": "Buttonsimple",
|
16473
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16474
|
-
}
|
16475
|
-
},
|
16476
|
-
{
|
16477
|
-
"kind": "field",
|
16478
|
-
"name": "role",
|
16479
|
-
"type": {
|
16480
|
-
"text": "RoleType"
|
16481
|
-
},
|
16482
|
-
"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.",
|
16483
|
-
"default": "button",
|
16484
|
-
"attribute": "role",
|
16485
|
-
"reflects": true,
|
16486
|
-
"inheritedFrom": {
|
16487
|
-
"name": "Buttonsimple",
|
16488
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16489
|
-
}
|
16490
|
-
},
|
16491
|
-
{
|
16492
|
-
"kind": "field",
|
16493
|
-
"name": "ariaStateKey",
|
16494
|
-
"type": {
|
16495
|
-
"text": "string | undefined"
|
16496
|
-
},
|
16497
|
-
"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`",
|
16498
|
-
"default": "'aria-pressed' (when)",
|
16499
|
-
"attribute": "ariaStateKey",
|
16500
|
-
"reflects": true,
|
16501
|
-
"inheritedFrom": {
|
16502
|
-
"name": "Buttonsimple",
|
16503
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16504
|
-
}
|
16505
|
-
},
|
16506
|
-
{
|
16507
|
-
"kind": "field",
|
16508
|
-
"name": "type",
|
16509
|
-
"type": {
|
16510
|
-
"text": "ButtonType"
|
16511
|
-
},
|
16512
|
-
"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.",
|
16513
|
-
"default": "button",
|
16514
|
-
"attribute": "type",
|
16515
|
-
"reflects": true,
|
16516
|
-
"inheritedFrom": {
|
16517
|
-
"name": "Buttonsimple",
|
16518
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16519
|
-
}
|
16520
|
-
},
|
16521
|
-
{
|
16522
|
-
"kind": "method",
|
16523
|
-
"name": "executeAction",
|
16524
|
-
"privacy": "protected",
|
16525
|
-
"inheritedFrom": {
|
16526
|
-
"name": "Buttonsimple",
|
16527
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16528
|
-
}
|
16617
|
+
"slots": [
|
16618
|
+
{
|
16619
|
+
"description": "This is a default/unnamed slot, where listitems can be placed.",
|
16620
|
+
"name": "default"
|
16529
16621
|
},
|
16622
|
+
{
|
16623
|
+
"description": "This slot is used to pass a header for the list, which can be a `mdc-listheader` component.",
|
16624
|
+
"name": "list-header"
|
16625
|
+
}
|
16626
|
+
],
|
16627
|
+
"members": [
|
16530
16628
|
{
|
16531
16629
|
"kind": "method",
|
16532
|
-
"name": "
|
16533
|
-
"privacy": "
|
16630
|
+
"name": "handleKeyDown",
|
16631
|
+
"privacy": "private",
|
16632
|
+
"return": {
|
16633
|
+
"type": {
|
16634
|
+
"text": "void"
|
16635
|
+
}
|
16636
|
+
},
|
16534
16637
|
"parameters": [
|
16535
16638
|
{
|
16536
|
-
"name": "
|
16537
|
-
"type": {
|
16538
|
-
"text": "HTMLElement"
|
16539
|
-
},
|
16540
|
-
"description": "The button element"
|
16541
|
-
},
|
16542
|
-
{
|
16543
|
-
"name": "active",
|
16544
|
-
"optional": true,
|
16639
|
+
"name": "event",
|
16545
16640
|
"type": {
|
16546
|
-
"text": "
|
16641
|
+
"text": "KeyboardEvent"
|
16547
16642
|
},
|
16548
|
-
"description": "The
|
16643
|
+
"description": "The keyboard event."
|
16549
16644
|
}
|
16550
16645
|
],
|
16551
|
-
"description": "
|
16552
|
-
"inheritedFrom": {
|
16553
|
-
"name": "Buttonsimple",
|
16554
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16555
|
-
}
|
16646
|
+
"description": "Handles the keydown event on the list element.\nIf the key is 'ArrowUp' or 'ArrowDown', it focuses to the previous or next list item\nand sets the active tabindex of the list item.\nPrevents the default event behavior."
|
16556
16647
|
},
|
16557
16648
|
{
|
16558
16649
|
"kind": "method",
|
16559
|
-
"name": "
|
16650
|
+
"name": "getCurrentIndex",
|
16560
16651
|
"privacy": "private",
|
16652
|
+
"return": {
|
16653
|
+
"type": {
|
16654
|
+
"text": ""
|
16655
|
+
}
|
16656
|
+
},
|
16561
16657
|
"parameters": [
|
16562
16658
|
{
|
16563
|
-
"name": "
|
16564
|
-
"type": {
|
16565
|
-
"text": "HTMLElement"
|
16566
|
-
},
|
16567
|
-
"description": "The button element."
|
16568
|
-
},
|
16569
|
-
{
|
16570
|
-
"name": "softDisabled",
|
16571
|
-
"optional": true,
|
16659
|
+
"name": "target",
|
16572
16660
|
"type": {
|
16573
|
-
"text": "
|
16661
|
+
"text": "EventTarget | null"
|
16574
16662
|
},
|
16575
|
-
"description": "The
|
16663
|
+
"description": "The target element to find the index of."
|
16576
16664
|
}
|
16577
16665
|
],
|
16578
|
-
"description": "
|
16579
|
-
"inheritedFrom": {
|
16580
|
-
"name": "Buttonsimple",
|
16581
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16582
|
-
}
|
16666
|
+
"description": "Returns the index of the given target in the listItems array.\nIf the target is not a list item, but a child element of a list item,\nit returns the index of the parent list item."
|
16583
16667
|
},
|
16584
16668
|
{
|
16585
16669
|
"kind": "method",
|
16586
|
-
"name": "
|
16670
|
+
"name": "getNewIndexBasedOnKey",
|
16587
16671
|
"privacy": "private",
|
16672
|
+
"return": {
|
16673
|
+
"type": {
|
16674
|
+
"text": ""
|
16675
|
+
}
|
16676
|
+
},
|
16588
16677
|
"parameters": [
|
16589
16678
|
{
|
16590
|
-
"name": "
|
16679
|
+
"name": "key",
|
16591
16680
|
"type": {
|
16592
|
-
"text": "
|
16681
|
+
"text": "string"
|
16593
16682
|
},
|
16594
|
-
"description": "The
|
16683
|
+
"description": "The key that was pressed."
|
16595
16684
|
},
|
16596
16685
|
{
|
16597
|
-
"name": "
|
16686
|
+
"name": "currentIndex",
|
16598
16687
|
"type": {
|
16599
|
-
"text": "
|
16688
|
+
"text": "number"
|
16600
16689
|
},
|
16601
|
-
"description": "The
|
16690
|
+
"description": "The current index of the focused list item."
|
16691
|
+
},
|
16692
|
+
{
|
16693
|
+
"name": "wrappedDivsCount",
|
16694
|
+
"type": {
|
16695
|
+
"text": "number"
|
16696
|
+
},
|
16697
|
+
"description": "The total number of list items."
|
16602
16698
|
}
|
16603
16699
|
],
|
16604
|
-
"description": "
|
16605
|
-
"inheritedFrom": {
|
16606
|
-
"name": "Buttonsimple",
|
16607
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16608
|
-
}
|
16609
|
-
},
|
16610
|
-
{
|
16611
|
-
"kind": "method",
|
16612
|
-
"name": "triggerClickEvent",
|
16613
|
-
"privacy": "private",
|
16614
|
-
"inheritedFrom": {
|
16615
|
-
"name": "Buttonsimple",
|
16616
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16617
|
-
}
|
16618
|
-
},
|
16619
|
-
{
|
16620
|
-
"kind": "method",
|
16621
|
-
"name": "handleBlur",
|
16622
|
-
"privacy": "private",
|
16623
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
16624
|
-
"inheritedFrom": {
|
16625
|
-
"name": "Buttonsimple",
|
16626
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16627
|
-
}
|
16700
|
+
"description": "Calculates a new index based on the pressed keyboard key.\nSupports navigation keys for moving focus within a list."
|
16628
16701
|
},
|
16629
16702
|
{
|
16630
16703
|
"kind": "method",
|
16631
|
-
"name": "
|
16632
|
-
"privacy": "
|
16704
|
+
"name": "handleMouseClick",
|
16705
|
+
"privacy": "protected",
|
16706
|
+
"return": {
|
16707
|
+
"type": {
|
16708
|
+
"text": "void"
|
16709
|
+
}
|
16710
|
+
},
|
16633
16711
|
"parameters": [
|
16634
16712
|
{
|
16635
16713
|
"name": "event",
|
16636
16714
|
"type": {
|
16637
|
-
"text": "
|
16715
|
+
"text": "MouseEvent"
|
16638
16716
|
},
|
16639
|
-
"description": "The
|
16717
|
+
"description": "The mouse event."
|
16640
16718
|
}
|
16641
16719
|
],
|
16642
|
-
"description": "Handles the
|
16643
|
-
"inheritedFrom": {
|
16644
|
-
"name": "Buttonsimple",
|
16645
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16646
|
-
}
|
16720
|
+
"description": "Handles the mouse click event on the list element.\nFinds the index of the target element in the list items array and calls\n`resetTabIndexAndSetActiveTabIndex` with that index."
|
16647
16721
|
},
|
16648
16722
|
{
|
16649
16723
|
"kind": "method",
|
16650
|
-
"name": "
|
16724
|
+
"name": "resetTabIndexAndSetActiveTabIndex",
|
16651
16725
|
"privacy": "private",
|
16652
16726
|
"parameters": [
|
16653
16727
|
{
|
16654
|
-
"name": "
|
16728
|
+
"name": "newIndex",
|
16655
16729
|
"type": {
|
16656
|
-
"text": "
|
16730
|
+
"text": "number"
|
16657
16731
|
},
|
16658
|
-
"description": "The
|
16732
|
+
"description": "The index of the new active element in the list."
|
16659
16733
|
}
|
16660
16734
|
],
|
16661
|
-
"description": "
|
16662
|
-
"inheritedFrom": {
|
16663
|
-
"name": "Buttonsimple",
|
16664
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
16665
|
-
}
|
16735
|
+
"description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard."
|
16666
16736
|
}
|
16667
16737
|
],
|
16668
|
-
"
|
16669
|
-
|
16670
|
-
|
16671
|
-
|
16672
|
-
|
16673
|
-
|
16674
|
-
|
16675
|
-
|
16676
|
-
|
16677
|
-
|
16738
|
+
"superclass": {
|
16739
|
+
"name": "Component",
|
16740
|
+
"module": "/src/models"
|
16741
|
+
},
|
16742
|
+
"tagName": "mdc-list",
|
16743
|
+
"jsDoc": "/**\n * mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.\n *\n * To add a header to the list, use the `mdc-listheader` component and place it in the `list-header` slot.\n * `mdc-listitem` components can be placed in the default slot.\n *\n * @tagname mdc-list\n *\n * @slot default - This is a default/unnamed slot, where listitems can be placed.\n * @slot list-header - This slot is used to pass a header for the list, which can be a `mdc-listheader` component.\n *\n * @csspart container - The container slot around the list items\n */",
|
16744
|
+
"customElement": true
|
16745
|
+
}
|
16746
|
+
],
|
16747
|
+
"exports": [
|
16748
|
+
{
|
16749
|
+
"kind": "js",
|
16750
|
+
"name": "default",
|
16751
|
+
"declaration": {
|
16752
|
+
"name": "List",
|
16753
|
+
"module": "components/list/list.component.js"
|
16754
|
+
}
|
16755
|
+
}
|
16756
|
+
]
|
16757
|
+
},
|
16758
|
+
{
|
16759
|
+
"kind": "javascript-module",
|
16760
|
+
"path": "components/listheader/listheader.component.js",
|
16761
|
+
"declarations": [
|
16762
|
+
{
|
16763
|
+
"kind": "class",
|
16764
|
+
"description": "Listheader component is used to display a header in a list.\nIt can include icons before and after the header text, and allows for additional content via slots.",
|
16765
|
+
"name": "Listheader",
|
16766
|
+
"cssProperties": [
|
16678
16767
|
{
|
16679
|
-
"description": "
|
16680
|
-
"name": "
|
16681
|
-
"reactName": "onKeyDown",
|
16682
|
-
"inheritedFrom": {
|
16683
|
-
"name": "Buttonsimple",
|
16684
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16685
|
-
}
|
16768
|
+
"description": "height of the header",
|
16769
|
+
"name": "--mdc-listheader-height"
|
16686
16770
|
},
|
16687
16771
|
{
|
16688
|
-
"description": "
|
16689
|
-
"name": "
|
16690
|
-
"reactName": "onKeyUp",
|
16691
|
-
"inheritedFrom": {
|
16692
|
-
"name": "Buttonsimple",
|
16693
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16694
|
-
}
|
16772
|
+
"description": "padding around the header content",
|
16773
|
+
"name": "--mdc-listheader-padding"
|
16695
16774
|
},
|
16696
16775
|
{
|
16697
|
-
"description": "
|
16698
|
-
"name": "
|
16699
|
-
"reactName": "onFocus",
|
16700
|
-
"inheritedFrom": {
|
16701
|
-
"name": "Buttonsimple",
|
16702
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16703
|
-
}
|
16776
|
+
"description": "gap between content",
|
16777
|
+
"name": "--mdc-listheader-gap"
|
16704
16778
|
}
|
16705
16779
|
],
|
16706
|
-
"
|
16707
|
-
{
|
16708
|
-
"name": "size",
|
16709
|
-
"type": {
|
16710
|
-
"text": "ButtonSize"
|
16711
|
-
},
|
16712
|
-
"description": "Sets the size of the linkbutton.\nAcceptable values: \n- 12\n- 14\n- 16",
|
16713
|
-
"default": "16",
|
16714
|
-
"fieldName": "size",
|
16715
|
-
"inheritedFrom": {
|
16716
|
-
"name": "Buttonsimple",
|
16717
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16718
|
-
}
|
16719
|
-
},
|
16720
|
-
{
|
16721
|
-
"name": "inline",
|
16722
|
-
"type": {
|
16723
|
-
"text": "boolean"
|
16724
|
-
},
|
16725
|
-
"description": "The linkbutton can be inline or standalone.",
|
16726
|
-
"default": "false",
|
16727
|
-
"fieldName": "inline"
|
16728
|
-
},
|
16780
|
+
"slots": [
|
16729
16781
|
{
|
16730
|
-
"
|
16731
|
-
"
|
16732
|
-
|
16733
|
-
|
16734
|
-
|
16735
|
-
"default": "false",
|
16736
|
-
"fieldName": "inverted"
|
16737
|
-
},
|
16782
|
+
"description": "to pass in actionable content like buttons or links",
|
16783
|
+
"name": "default"
|
16784
|
+
}
|
16785
|
+
],
|
16786
|
+
"members": [
|
16738
16787
|
{
|
16739
|
-
"
|
16788
|
+
"kind": "field",
|
16789
|
+
"name": "prefixIcon",
|
16740
16790
|
"type": {
|
16741
16791
|
"text": "IconNames | undefined"
|
16742
16792
|
},
|
16743
|
-
"description": "Name of the icon
|
16744
|
-
"
|
16745
|
-
"inheritedFrom": {
|
16746
|
-
"name": "IconNameMixin",
|
16747
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
16748
|
-
}
|
16793
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
16794
|
+
"attribute": "prefix-icon"
|
16749
16795
|
},
|
16750
16796
|
{
|
16751
|
-
"
|
16797
|
+
"kind": "field",
|
16798
|
+
"name": "postfixIcon",
|
16752
16799
|
"type": {
|
16753
|
-
"text": "
|
16800
|
+
"text": "IconNames | undefined"
|
16754
16801
|
},
|
16755
|
-
"
|
16756
|
-
"
|
16757
|
-
"fieldName": "autofocus",
|
16758
|
-
"inheritedFrom": {
|
16759
|
-
"name": "Buttonsimple",
|
16760
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16761
|
-
}
|
16802
|
+
"description": "Name of the icon rendered after the slot & text\n\nIf not provided, no icon will be rendered and content will be aligned to the end.",
|
16803
|
+
"attribute": "postfix-icon"
|
16762
16804
|
},
|
16763
16805
|
{
|
16764
|
-
"
|
16806
|
+
"kind": "field",
|
16807
|
+
"name": "headerText",
|
16765
16808
|
"type": {
|
16766
|
-
"text": "
|
16809
|
+
"text": "string | undefined"
|
16767
16810
|
},
|
16768
|
-
"
|
16769
|
-
"
|
16770
|
-
"fieldName": "tabIndex",
|
16771
|
-
"inheritedFrom": {
|
16772
|
-
"name": "Buttonsimple",
|
16773
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16774
|
-
}
|
16811
|
+
"description": "Text to be rendered in the header",
|
16812
|
+
"attribute": "header-text"
|
16775
16813
|
},
|
16776
16814
|
{
|
16815
|
+
"kind": "field",
|
16777
16816
|
"name": "disabled",
|
16778
16817
|
"type": {
|
16779
|
-
"text": "boolean
|
16780
|
-
},
|
16781
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16782
|
-
"default": "undefined",
|
16783
|
-
"fieldName": "disabled",
|
16784
|
-
"inheritedFrom": {
|
16785
|
-
"name": "Buttonsimple",
|
16786
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16787
|
-
}
|
16788
|
-
},
|
16789
|
-
{
|
16790
|
-
"name": "active",
|
16791
|
-
"type": {
|
16792
|
-
"text": "boolean | undefined"
|
16818
|
+
"text": "boolean"
|
16793
16819
|
},
|
16794
|
-
"
|
16795
|
-
"
|
16796
|
-
"
|
16797
|
-
"
|
16798
|
-
|
16799
|
-
|
16800
|
-
|
16801
|
-
},
|
16820
|
+
"default": "false",
|
16821
|
+
"description": "Disables the header, making it visually styled as disabled.\n\nNOTE: slot content will still be interactive unless individually disabled.\nMake sure to handle the disabled state of any actionable elements inside the slot.",
|
16822
|
+
"attribute": "disabled",
|
16823
|
+
"reflects": true
|
16824
|
+
}
|
16825
|
+
],
|
16826
|
+
"attributes": [
|
16802
16827
|
{
|
16803
|
-
"name": "
|
16828
|
+
"name": "prefix-icon",
|
16804
16829
|
"type": {
|
16805
|
-
"text": "
|
16830
|
+
"text": "IconNames | undefined"
|
16806
16831
|
},
|
16807
|
-
"description": "
|
16808
|
-
"
|
16809
|
-
"fieldName": "softDisabled",
|
16810
|
-
"inheritedFrom": {
|
16811
|
-
"name": "Buttonsimple",
|
16812
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16813
|
-
}
|
16832
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
16833
|
+
"fieldName": "prefixIcon"
|
16814
16834
|
},
|
16815
16835
|
{
|
16816
|
-
"name": "
|
16836
|
+
"name": "postfix-icon",
|
16817
16837
|
"type": {
|
16818
|
-
"text": "
|
16838
|
+
"text": "IconNames | undefined"
|
16819
16839
|
},
|
16820
|
-
"description": "
|
16821
|
-
"
|
16822
|
-
"fieldName": "role",
|
16823
|
-
"inheritedFrom": {
|
16824
|
-
"name": "Buttonsimple",
|
16825
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16826
|
-
}
|
16840
|
+
"description": "Name of the icon rendered after the slot & text\n\nIf not provided, no icon will be rendered and content will be aligned to the end.",
|
16841
|
+
"fieldName": "postfixIcon"
|
16827
16842
|
},
|
16828
16843
|
{
|
16829
|
-
"name": "
|
16844
|
+
"name": "header-text",
|
16830
16845
|
"type": {
|
16831
16846
|
"text": "string | undefined"
|
16832
16847
|
},
|
16833
|
-
"description": "
|
16834
|
-
"
|
16835
|
-
"fieldName": "ariaStateKey",
|
16836
|
-
"inheritedFrom": {
|
16837
|
-
"name": "Buttonsimple",
|
16838
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16839
|
-
}
|
16848
|
+
"description": "Text to be rendered in the header",
|
16849
|
+
"fieldName": "headerText"
|
16840
16850
|
},
|
16841
16851
|
{
|
16842
|
-
"name": "
|
16852
|
+
"name": "disabled",
|
16843
16853
|
"type": {
|
16844
|
-
"text": "
|
16854
|
+
"text": "boolean"
|
16845
16855
|
},
|
16846
|
-
"
|
16847
|
-
"
|
16848
|
-
"fieldName": "
|
16849
|
-
"inheritedFrom": {
|
16850
|
-
"name": "Buttonsimple",
|
16851
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
16852
|
-
}
|
16853
|
-
}
|
16854
|
-
],
|
16855
|
-
"mixins": [
|
16856
|
-
{
|
16857
|
-
"name": "IconNameMixin",
|
16858
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
16856
|
+
"default": "false",
|
16857
|
+
"description": "Disables the header, making it visually styled as disabled.\n\nNOTE: slot content will still be interactive unless individually disabled.\nMake sure to handle the disabled state of any actionable elements inside the slot.",
|
16858
|
+
"fieldName": "disabled"
|
16859
16859
|
}
|
16860
16860
|
],
|
16861
16861
|
"superclass": {
|
16862
|
-
"name": "
|
16863
|
-
"module": "/src/
|
16862
|
+
"name": "Component",
|
16863
|
+
"module": "/src/models"
|
16864
16864
|
},
|
16865
|
-
"tagName": "mdc-
|
16866
|
-
"jsDoc": "/**\n *
|
16865
|
+
"tagName": "mdc-listheader",
|
16866
|
+
"jsDoc": "/**\n * Listheader component is used to display a header in a list.\n * It can include icons before and after the header text, and allows for additional content via slots.\n *\n * @tagname mdc-listheader\n *\n * @slot default - to pass in actionable content like buttons or links\n *\n * @cssproperty --mdc-listheader-height - height of the header\n * @cssproperty --mdc-listheader-padding - padding around the header content\n * @cssproperty --mdc-listheader-gap - gap between content\n */",
|
16867
16867
|
"customElement": true
|
16868
16868
|
}
|
16869
16869
|
],
|
@@ -16872,8 +16872,8 @@
|
|
16872
16872
|
"kind": "js",
|
16873
16873
|
"name": "default",
|
16874
16874
|
"declaration": {
|
16875
|
-
"name": "
|
16876
|
-
"module": "components/
|
16875
|
+
"name": "Listheader",
|
16876
|
+
"module": "components/listheader/listheader.component.js"
|
16877
16877
|
}
|
16878
16878
|
}
|
16879
16879
|
]
|
@@ -36868,690 +36868,376 @@
|
|
36868
36868
|
},
|
36869
36869
|
{
|
36870
36870
|
"kind": "javascript-module",
|
36871
|
-
"path": "components/
|
36871
|
+
"path": "components/toast/toast.component.js",
|
36872
36872
|
"declarations": [
|
36873
36873
|
{
|
36874
36874
|
"kind": "class",
|
36875
|
-
"description": "
|
36876
|
-
"name": "
|
36875
|
+
"description": "`mdc-toast` is a lightweight, non-blocking alert used to inform users about application processes.\nIt supports success, warning, error, and custom messages, and is designed to be controlled externally.\n\n**Note**: When using `slot=\"toast-body-normal\"` and `slot=\"toast-body-detailed\"`, it's strongly recommended to wrap the content with `<mdc-text tagname=\"span\">`.\nIf not used, ensure your custom content is styled appropriately to match the design and alignment expectations of the toast component.",
|
36876
|
+
"name": "Toast",
|
36877
36877
|
"cssProperties": [
|
36878
36878
|
{
|
36879
|
-
"description": "
|
36880
|
-
"name": "--mdc-
|
36879
|
+
"description": "Background color of the toast.",
|
36880
|
+
"name": "--mdc-toast-background-color"
|
36881
36881
|
},
|
36882
36882
|
{
|
36883
|
-
"description": "
|
36884
|
-
"name": "--mdc-
|
36883
|
+
"description": "Border color of the toast.",
|
36884
|
+
"name": "--mdc-toast-border-color"
|
36885
36885
|
},
|
36886
36886
|
{
|
36887
|
-
"description": "
|
36888
|
-
"name": "--mdc-
|
36887
|
+
"description": "Color of the header text in the toast.",
|
36888
|
+
"name": "--mdc-toast-header-text-color"
|
36889
36889
|
},
|
36890
36890
|
{
|
36891
|
-
"description": "
|
36892
|
-
"name": "--mdc-
|
36891
|
+
"description": "Color of the icon in the toast.",
|
36892
|
+
"name": "--mdc-toast-icon-color"
|
36893
36893
|
},
|
36894
36894
|
{
|
36895
|
-
"description": "
|
36896
|
-
"name": "--mdc-
|
36895
|
+
"description": "Elevation effect applied to the toast.",
|
36896
|
+
"name": "--mdc-toast-elevation-3"
|
36897
36897
|
},
|
36898
36898
|
{
|
36899
|
-
"description": "
|
36900
|
-
"name": "--mdc-
|
36899
|
+
"description": "Width of the toast.",
|
36900
|
+
"name": "--mdc-toast-width"
|
36901
36901
|
},
|
36902
36902
|
{
|
36903
|
-
"description": "
|
36904
|
-
"name": "--mdc-
|
36903
|
+
"description": "Padding inside the toast.",
|
36904
|
+
"name": "--mdc-toast-padding"
|
36905
|
+
}
|
36906
|
+
],
|
36907
|
+
"cssParts": [
|
36908
|
+
{
|
36909
|
+
"description": "The container for the toast's main content, including icon, text, and close button.",
|
36910
|
+
"name": "content-container"
|
36905
36911
|
},
|
36906
36912
|
{
|
36907
|
-
"description": "
|
36908
|
-
"name": "
|
36913
|
+
"description": "The icon shown at the start of the toast, styled by variant.",
|
36914
|
+
"name": "toast-prefix-icon"
|
36909
36915
|
},
|
36910
36916
|
{
|
36911
|
-
"description": "
|
36912
|
-
"name": "
|
36917
|
+
"description": "The container for the header and body content of the toast.",
|
36918
|
+
"name": "toast-content"
|
36913
36919
|
},
|
36914
36920
|
{
|
36915
|
-
"description": "
|
36916
|
-
"name": "
|
36921
|
+
"description": "The header text of the toast.",
|
36922
|
+
"name": "toast-header"
|
36917
36923
|
},
|
36918
36924
|
{
|
36919
|
-
"description": "
|
36920
|
-
"name": "
|
36925
|
+
"description": "The container for the toast's footer, including toggle and action buttons.",
|
36926
|
+
"name": "footer"
|
36921
36927
|
},
|
36922
36928
|
{
|
36923
|
-
"description": "
|
36924
|
-
"name": "
|
36929
|
+
"description": "The toggle button for showing/hiding detailed content.",
|
36930
|
+
"name": "footer-button-toggle"
|
36925
36931
|
},
|
36926
36932
|
{
|
36927
|
-
"description": "
|
36928
|
-
"name": "
|
36933
|
+
"description": "The close button for the toast.",
|
36934
|
+
"name": "toast-close-btn"
|
36929
36935
|
}
|
36930
36936
|
],
|
36931
|
-
"
|
36932
|
-
{
|
36933
|
-
"kind": "field",
|
36934
|
-
"name": "checked",
|
36935
|
-
"type": {
|
36936
|
-
"text": "boolean"
|
36937
|
-
},
|
36938
|
-
"default": "false",
|
36939
|
-
"description": "Determines whether the toggle is active or inactive.",
|
36940
|
-
"attribute": "checked",
|
36941
|
-
"reflects": true
|
36942
|
-
},
|
36943
|
-
{
|
36944
|
-
"kind": "field",
|
36945
|
-
"name": "size",
|
36946
|
-
"type": {
|
36947
|
-
"text": "ToggleSize"
|
36948
|
-
},
|
36949
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
36950
|
-
"default": "default",
|
36951
|
-
"attribute": "size",
|
36952
|
-
"reflects": true
|
36953
|
-
},
|
36954
|
-
{
|
36955
|
-
"kind": "field",
|
36956
|
-
"name": "autofocus",
|
36957
|
-
"type": {
|
36958
|
-
"text": "boolean"
|
36959
|
-
},
|
36960
|
-
"default": "false",
|
36961
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
36962
|
-
"attribute": "autofocus",
|
36963
|
-
"reflects": true
|
36964
|
-
},
|
36965
|
-
{
|
36966
|
-
"kind": "method",
|
36967
|
-
"name": "manageRequired",
|
36968
|
-
"privacy": "private",
|
36969
|
-
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
|
36970
|
-
},
|
36971
|
-
{
|
36972
|
-
"kind": "method",
|
36973
|
-
"name": "setFormValue",
|
36974
|
-
"privacy": "private",
|
36975
|
-
"description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
|
36976
|
-
},
|
36937
|
+
"slots": [
|
36977
36938
|
{
|
36978
|
-
"
|
36979
|
-
"name": "
|
36980
|
-
"privacy": "private",
|
36981
|
-
"return": {
|
36982
|
-
"type": {
|
36983
|
-
"text": "void"
|
36984
|
-
}
|
36985
|
-
},
|
36986
|
-
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
36939
|
+
"description": "Slot for custom content before the icon (only for custom variant).",
|
36940
|
+
"name": "content-prefix"
|
36987
36941
|
},
|
36988
36942
|
{
|
36989
|
-
"
|
36990
|
-
"name": "
|
36991
|
-
"privacy": "private",
|
36992
|
-
"return": {
|
36993
|
-
"type": {
|
36994
|
-
"text": "void"
|
36995
|
-
}
|
36996
|
-
},
|
36997
|
-
"parameters": [
|
36998
|
-
{
|
36999
|
-
"name": "event",
|
37000
|
-
"type": {
|
37001
|
-
"text": "KeyboardEvent"
|
37002
|
-
},
|
37003
|
-
"description": "The keyboard event."
|
37004
|
-
}
|
37005
|
-
],
|
37006
|
-
"description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
|
36943
|
+
"description": "Slot for the main body content of the toast.",
|
36944
|
+
"name": "toast-body-normal"
|
37007
36945
|
},
|
37008
36946
|
{
|
37009
|
-
"
|
37010
|
-
"name": "
|
37011
|
-
"privacy": "private",
|
37012
|
-
"parameters": [
|
37013
|
-
{
|
37014
|
-
"name": "event",
|
37015
|
-
"type": {
|
37016
|
-
"text": "Event"
|
37017
|
-
}
|
37018
|
-
}
|
37019
|
-
],
|
37020
|
-
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
36947
|
+
"description": "Slot for additional detailed content, shown when expanded.",
|
36948
|
+
"name": "toast-body-detailed"
|
37021
36949
|
},
|
37022
36950
|
{
|
37023
|
-
"
|
37024
|
-
"name": "
|
37025
|
-
"privacy": "private",
|
37026
|
-
"parameters": [
|
37027
|
-
{
|
37028
|
-
"name": "size",
|
37029
|
-
"type": {
|
37030
|
-
"text": "ToggleSize"
|
37031
|
-
},
|
37032
|
-
"description": "The size to set."
|
37033
|
-
}
|
37034
|
-
],
|
37035
|
-
"description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
|
36951
|
+
"description": "Slot for custom footer content. Prefer using footer-button-primary and footer-button-secondary slots.",
|
36952
|
+
"name": "footer"
|
37036
36953
|
},
|
37037
36954
|
{
|
37038
|
-
"
|
37039
|
-
"name": "
|
37040
|
-
"type": {
|
37041
|
-
"text": "string"
|
37042
|
-
},
|
37043
|
-
"default": "''",
|
37044
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37045
|
-
"attribute": "name",
|
37046
|
-
"reflects": true,
|
37047
|
-
"inheritedFrom": {
|
37048
|
-
"name": "FormInternalsMixin",
|
37049
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37050
|
-
}
|
36955
|
+
"description": "Slot for passing the primary variant of `mdc-button` in the footer.",
|
36956
|
+
"name": "footer-button-primary"
|
37051
36957
|
},
|
36958
|
+
{
|
36959
|
+
"description": "Slot for passing the secondary variant of `mdc-button` in the footer.",
|
36960
|
+
"name": "footer-button-secondary"
|
36961
|
+
}
|
36962
|
+
],
|
36963
|
+
"members": [
|
37052
36964
|
{
|
37053
36965
|
"kind": "field",
|
37054
|
-
"name": "
|
36966
|
+
"name": "variant",
|
37055
36967
|
"type": {
|
37056
|
-
"text": "
|
36968
|
+
"text": "ToastVariant"
|
37057
36969
|
},
|
37058
|
-
"
|
37059
|
-
"
|
37060
|
-
"attribute": "
|
37061
|
-
"reflects": true
|
37062
|
-
"inheritedFrom": {
|
37063
|
-
"name": "FormInternalsMixin",
|
37064
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37065
|
-
}
|
36970
|
+
"description": "Type of toast\n- Can be `custom`, `success`, `warning` or `error`.",
|
36971
|
+
"default": "'custom'",
|
36972
|
+
"attribute": "variant",
|
36973
|
+
"reflects": true
|
37066
36974
|
},
|
37067
36975
|
{
|
37068
36976
|
"kind": "field",
|
37069
|
-
"name": "
|
36977
|
+
"name": "closeButtonAriaLabel",
|
37070
36978
|
"type": {
|
37071
36979
|
"text": "string | undefined"
|
37072
36980
|
},
|
37073
|
-
"description": "
|
37074
|
-
"attribute": "
|
37075
|
-
"reflects": true,
|
37076
|
-
"inheritedFrom": {
|
37077
|
-
"name": "FormInternalsMixin",
|
37078
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37079
|
-
}
|
36981
|
+
"description": "Defines aria-label attribute for close button accessibility",
|
36982
|
+
"attribute": "close-button-aria-label"
|
37080
36983
|
},
|
37081
36984
|
{
|
37082
36985
|
"kind": "field",
|
37083
|
-
"name": "
|
36986
|
+
"name": "headerText",
|
37084
36987
|
"type": {
|
37085
|
-
"text": "
|
36988
|
+
"text": "string | undefined"
|
37086
36989
|
},
|
37087
|
-
"
|
37088
|
-
"
|
37089
|
-
|
37090
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37091
|
-
}
|
36990
|
+
"description": "Defines a string value to display as the title of the toast",
|
36991
|
+
"attribute": "header-text",
|
36992
|
+
"reflects": true
|
37092
36993
|
},
|
37093
36994
|
{
|
37094
36995
|
"kind": "field",
|
37095
|
-
"name": "
|
37096
|
-
"
|
37097
|
-
|
37098
|
-
"name": "FormInternalsMixin",
|
37099
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37100
|
-
}
|
37101
|
-
},
|
37102
|
-
{
|
37103
|
-
"kind": "method",
|
37104
|
-
"name": "setValidity",
|
37105
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
37106
|
-
"return": {
|
37107
|
-
"type": {
|
37108
|
-
"text": ""
|
37109
|
-
}
|
37110
|
-
},
|
37111
|
-
"inheritedFrom": {
|
37112
|
-
"name": "FormInternalsMixin",
|
37113
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37114
|
-
}
|
37115
|
-
},
|
37116
|
-
{
|
37117
|
-
"kind": "method",
|
37118
|
-
"name": "checkValidity",
|
37119
|
-
"return": {
|
37120
|
-
"type": {
|
37121
|
-
"text": "boolean"
|
37122
|
-
}
|
36996
|
+
"name": "headerTagName",
|
36997
|
+
"type": {
|
36998
|
+
"text": "TagName"
|
37123
36999
|
},
|
37124
|
-
"
|
37125
|
-
|
37126
|
-
|
37127
|
-
|
37128
|
-
},
|
37129
|
-
{
|
37130
|
-
"kind": "method",
|
37131
|
-
"name": "reportValidity",
|
37132
|
-
"inheritedFrom": {
|
37133
|
-
"name": "FormInternalsMixin",
|
37134
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
37135
|
-
}
|
37000
|
+
"description": "The html tag to be used for the header text",
|
37001
|
+
"default": "'h2'",
|
37002
|
+
"attribute": "header-tag-name",
|
37003
|
+
"reflects": true
|
37136
37004
|
},
|
37137
37005
|
{
|
37138
37006
|
"kind": "field",
|
37139
|
-
"name": "
|
37007
|
+
"name": "ariaLabel",
|
37140
37008
|
"type": {
|
37141
37009
|
"text": "string | null"
|
37142
37010
|
},
|
37143
37011
|
"default": "null",
|
37144
|
-
"description": "Defines
|
37145
|
-
"attribute": "
|
37146
|
-
"reflects": true
|
37147
|
-
"inheritedFrom": {
|
37148
|
-
"name": "DataAriaLabelMixin",
|
37149
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
37150
|
-
}
|
37012
|
+
"description": "Defines aria-label attribute when header is not used",
|
37013
|
+
"attribute": "aria-label",
|
37014
|
+
"reflects": true
|
37151
37015
|
},
|
37152
37016
|
{
|
37153
37017
|
"kind": "field",
|
37154
|
-
"name": "
|
37018
|
+
"name": "showMoreText",
|
37155
37019
|
"type": {
|
37156
|
-
"text": "
|
37020
|
+
"text": "string | undefined"
|
37157
37021
|
},
|
37158
|
-
"description": "
|
37159
|
-
"
|
37160
|
-
"
|
37161
|
-
"reflects": true,
|
37162
|
-
"inheritedFrom": {
|
37163
|
-
"name": "FormfieldWrapper",
|
37164
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37165
|
-
}
|
37022
|
+
"description": "Defines the text shown on the linkbutton when detailed content is hidden.",
|
37023
|
+
"attribute": "show-more-text",
|
37024
|
+
"reflects": true
|
37166
37025
|
},
|
37167
37026
|
{
|
37168
37027
|
"kind": "field",
|
37169
|
-
"name": "
|
37028
|
+
"name": "showLessText",
|
37170
37029
|
"type": {
|
37171
37030
|
"text": "string | undefined"
|
37172
37031
|
},
|
37173
|
-
"description": "
|
37174
|
-
"attribute": "
|
37175
|
-
"reflects": true
|
37176
|
-
"inheritedFrom": {
|
37177
|
-
"name": "FormfieldWrapper",
|
37178
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37179
|
-
}
|
37032
|
+
"description": "Defines the text shown on the linkbutton when detailed content is visible.",
|
37033
|
+
"attribute": "show-less-text",
|
37034
|
+
"reflects": true
|
37180
37035
|
},
|
37181
37036
|
{
|
37182
37037
|
"kind": "field",
|
37183
|
-
"name": "
|
37038
|
+
"name": "isDetailVisible",
|
37184
37039
|
"type": {
|
37185
37040
|
"text": "boolean"
|
37186
37041
|
},
|
37187
|
-
"
|
37188
|
-
"
|
37189
|
-
"attribute": "required",
|
37190
|
-
"reflects": true,
|
37191
|
-
"inheritedFrom": {
|
37192
|
-
"name": "FormfieldWrapper",
|
37193
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37194
|
-
}
|
37042
|
+
"privacy": "private",
|
37043
|
+
"default": "false"
|
37195
37044
|
},
|
37196
37045
|
{
|
37197
37046
|
"kind": "field",
|
37198
|
-
"name": "
|
37047
|
+
"name": "hasDetailedSlot",
|
37199
37048
|
"type": {
|
37200
|
-
"text": "
|
37049
|
+
"text": "boolean"
|
37201
37050
|
},
|
37202
|
-
"
|
37203
|
-
"
|
37204
|
-
"reflects": true,
|
37205
|
-
"inheritedFrom": {
|
37206
|
-
"name": "FormfieldWrapper",
|
37207
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37208
|
-
}
|
37051
|
+
"privacy": "private",
|
37052
|
+
"default": "false"
|
37209
37053
|
},
|
37210
37054
|
{
|
37211
37055
|
"kind": "field",
|
37212
|
-
"name": "
|
37056
|
+
"name": "detailedElements",
|
37213
37057
|
"type": {
|
37214
|
-
"text": "
|
37058
|
+
"text": "HTMLElement[]"
|
37215
37059
|
},
|
37216
|
-
"
|
37217
|
-
"attribute": "help-text",
|
37218
|
-
"reflects": true,
|
37219
|
-
"inheritedFrom": {
|
37220
|
-
"name": "FormfieldWrapper",
|
37221
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37222
|
-
}
|
37060
|
+
"privacy": "private"
|
37223
37061
|
},
|
37224
37062
|
{
|
37225
37063
|
"kind": "field",
|
37226
|
-
"name": "
|
37064
|
+
"name": "hasFooterButtons",
|
37227
37065
|
"type": {
|
37228
|
-
"text": "string
|
37066
|
+
"text": "string"
|
37229
37067
|
},
|
37230
|
-
"
|
37231
|
-
"
|
37232
|
-
|
37233
|
-
|
37234
|
-
|
37235
|
-
|
37236
|
-
|
37068
|
+
"privacy": "private",
|
37069
|
+
"default": "''"
|
37070
|
+
},
|
37071
|
+
{
|
37072
|
+
"kind": "method",
|
37073
|
+
"name": "closeToast",
|
37074
|
+
"privacy": "private",
|
37075
|
+
"description": "Fired when Close Button is clicked using mouse or keyboard.\nThis method dispatches the close event.\nIt is used to notify that the toast should be closed."
|
37076
|
+
},
|
37077
|
+
{
|
37078
|
+
"kind": "method",
|
37079
|
+
"name": "toggleDetailVisibility",
|
37080
|
+
"privacy": "private"
|
37237
37081
|
},
|
37238
37082
|
{
|
37239
|
-
"kind": "
|
37240
|
-
"name": "
|
37241
|
-
"
|
37242
|
-
"text": "PopoverPlacement"
|
37243
|
-
},
|
37244
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37245
|
-
"default": "'top'",
|
37246
|
-
"attribute": "toggletip-placement",
|
37247
|
-
"reflects": true,
|
37248
|
-
"inheritedFrom": {
|
37249
|
-
"name": "FormfieldWrapper",
|
37250
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37251
|
-
}
|
37083
|
+
"kind": "method",
|
37084
|
+
"name": "updateDetailedSlotPresence",
|
37085
|
+
"privacy": "private"
|
37252
37086
|
},
|
37253
37087
|
{
|
37254
|
-
"kind": "
|
37255
|
-
"name": "
|
37256
|
-
"
|
37257
|
-
"text": "string | undefined"
|
37258
|
-
},
|
37259
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
37260
|
-
"attribute": "info-icon-aria-label",
|
37261
|
-
"reflects": true,
|
37262
|
-
"inheritedFrom": {
|
37263
|
-
"name": "FormfieldWrapper",
|
37264
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37265
|
-
}
|
37088
|
+
"kind": "method",
|
37089
|
+
"name": "updateFooterButtonsPresence",
|
37090
|
+
"privacy": "private"
|
37266
37091
|
},
|
37267
37092
|
{
|
37268
37093
|
"kind": "method",
|
37269
|
-
"name": "
|
37094
|
+
"name": "renderIcon",
|
37270
37095
|
"privacy": "protected",
|
37271
|
-
"
|
37272
|
-
|
37273
|
-
|
37274
|
-
"
|
37096
|
+
"parameters": [
|
37097
|
+
{
|
37098
|
+
"name": "iconName",
|
37099
|
+
"type": {
|
37100
|
+
"text": "string"
|
37101
|
+
}
|
37275
37102
|
}
|
37276
|
-
|
37277
|
-
"inheritedFrom": {
|
37278
|
-
"name": "FormfieldWrapper",
|
37279
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37280
|
-
}
|
37103
|
+
]
|
37281
37104
|
},
|
37282
37105
|
{
|
37283
37106
|
"kind": "method",
|
37284
|
-
"name": "
|
37285
|
-
"privacy": "
|
37286
|
-
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
37287
|
-
"return": {
|
37288
|
-
"type": {
|
37289
|
-
"text": ""
|
37290
|
-
}
|
37291
|
-
},
|
37292
|
-
"inheritedFrom": {
|
37293
|
-
"name": "FormfieldWrapper",
|
37294
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37295
|
-
}
|
37107
|
+
"name": "shouldRenderToggleButton",
|
37108
|
+
"privacy": "private"
|
37296
37109
|
},
|
37297
37110
|
{
|
37298
37111
|
"kind": "method",
|
37299
|
-
"name": "
|
37300
|
-
"privacy": "
|
37301
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
37302
|
-
"return": {
|
37303
|
-
"type": {
|
37304
|
-
"text": ""
|
37305
|
-
}
|
37306
|
-
},
|
37307
|
-
"inheritedFrom": {
|
37308
|
-
"name": "FormfieldWrapper",
|
37309
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37310
|
-
}
|
37112
|
+
"name": "renderToggleDetailButton",
|
37113
|
+
"privacy": "private"
|
37311
37114
|
},
|
37312
37115
|
{
|
37313
37116
|
"kind": "method",
|
37314
|
-
"name": "
|
37117
|
+
"name": "renderHeader",
|
37118
|
+
"privacy": "protected"
|
37119
|
+
},
|
37120
|
+
{
|
37121
|
+
"kind": "method",
|
37122
|
+
"name": "handleFooterSlot",
|
37315
37123
|
"privacy": "protected",
|
37316
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
37317
37124
|
"return": {
|
37318
37125
|
"type": {
|
37319
|
-
"text": ""
|
37126
|
+
"text": "void"
|
37320
37127
|
}
|
37321
37128
|
},
|
37322
|
-
"
|
37323
|
-
|
37324
|
-
|
37325
|
-
|
37129
|
+
"parameters": [
|
37130
|
+
{
|
37131
|
+
"name": "tagname",
|
37132
|
+
"type": {
|
37133
|
+
"text": "string"
|
37134
|
+
}
|
37135
|
+
},
|
37136
|
+
{
|
37137
|
+
"name": "variant",
|
37138
|
+
"optional": true,
|
37139
|
+
"type": {
|
37140
|
+
"text": "string | undefined"
|
37141
|
+
}
|
37142
|
+
}
|
37143
|
+
]
|
37326
37144
|
},
|
37327
37145
|
{
|
37328
37146
|
"kind": "method",
|
37329
|
-
"name": "
|
37147
|
+
"name": "renderFooter",
|
37330
37148
|
"privacy": "protected",
|
37331
|
-
"description": "
|
37149
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
37332
37150
|
"return": {
|
37333
37151
|
"type": {
|
37334
37152
|
"text": ""
|
37335
37153
|
}
|
37336
37154
|
},
|
37337
37155
|
"inheritedFrom": {
|
37338
|
-
"name": "
|
37339
|
-
"module": "
|
37156
|
+
"name": "FooterMixin",
|
37157
|
+
"module": "utils/mixins/FooterMixin.js"
|
37340
37158
|
}
|
37341
37159
|
}
|
37342
37160
|
],
|
37343
37161
|
"events": [
|
37344
37162
|
{
|
37345
|
-
"
|
37346
|
-
|
37347
|
-
|
37348
|
-
},
|
37349
|
-
{
|
37350
|
-
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
37351
|
-
"name": "change",
|
37352
|
-
"reactName": "onChange"
|
37353
|
-
},
|
37354
|
-
{
|
37355
|
-
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
37356
|
-
"name": "focus",
|
37357
|
-
"reactName": "onFocus"
|
37163
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked using mouse or keyboard.",
|
37164
|
+
"name": "close",
|
37165
|
+
"reactName": "onClose"
|
37358
37166
|
}
|
37359
37167
|
],
|
37360
37168
|
"attributes": [
|
37361
37169
|
{
|
37362
|
-
"name": "
|
37363
|
-
"type": {
|
37364
|
-
"text": "boolean"
|
37365
|
-
},
|
37366
|
-
"default": "false",
|
37367
|
-
"description": "Determines whether the toggle is active or inactive.",
|
37368
|
-
"fieldName": "checked"
|
37369
|
-
},
|
37370
|
-
{
|
37371
|
-
"name": "size",
|
37372
|
-
"type": {
|
37373
|
-
"text": "ToggleSize"
|
37374
|
-
},
|
37375
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37376
|
-
"default": "default",
|
37377
|
-
"fieldName": "size"
|
37378
|
-
},
|
37379
|
-
{
|
37380
|
-
"name": "autofocus",
|
37381
|
-
"type": {
|
37382
|
-
"text": "boolean"
|
37383
|
-
},
|
37384
|
-
"default": "false",
|
37385
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
37386
|
-
"fieldName": "autofocus"
|
37387
|
-
},
|
37388
|
-
{
|
37389
|
-
"name": "name",
|
37390
|
-
"type": {
|
37391
|
-
"text": "string"
|
37392
|
-
},
|
37393
|
-
"default": "''",
|
37394
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37395
|
-
"fieldName": "name",
|
37396
|
-
"inheritedFrom": {
|
37397
|
-
"name": "FormInternalsMixin",
|
37398
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37399
|
-
}
|
37400
|
-
},
|
37401
|
-
{
|
37402
|
-
"name": "value",
|
37170
|
+
"name": "variant",
|
37403
37171
|
"type": {
|
37404
|
-
"text": "
|
37172
|
+
"text": "ToastVariant"
|
37405
37173
|
},
|
37406
|
-
"
|
37407
|
-
"
|
37408
|
-
"fieldName": "
|
37409
|
-
"inheritedFrom": {
|
37410
|
-
"name": "FormInternalsMixin",
|
37411
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37412
|
-
}
|
37174
|
+
"description": "Type of toast\n- Can be `custom`, `success`, `warning` or `error`.",
|
37175
|
+
"default": "'custom'",
|
37176
|
+
"fieldName": "variant"
|
37413
37177
|
},
|
37414
37178
|
{
|
37415
|
-
"name": "
|
37179
|
+
"name": "close-button-aria-label",
|
37416
37180
|
"type": {
|
37417
37181
|
"text": "string | undefined"
|
37418
37182
|
},
|
37419
|
-
"description": "
|
37420
|
-
"fieldName": "
|
37421
|
-
"inheritedFrom": {
|
37422
|
-
"name": "FormInternalsMixin",
|
37423
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37424
|
-
}
|
37425
|
-
},
|
37426
|
-
{
|
37427
|
-
"name": "data-aria-label",
|
37428
|
-
"type": {
|
37429
|
-
"text": "string | null"
|
37430
|
-
},
|
37431
|
-
"default": "null",
|
37432
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37433
|
-
"fieldName": "dataAriaLabel",
|
37434
|
-
"inheritedFrom": {
|
37435
|
-
"name": "DataAriaLabelMixin",
|
37436
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
37437
|
-
}
|
37438
|
-
},
|
37439
|
-
{
|
37440
|
-
"name": "disabled",
|
37441
|
-
"type": {
|
37442
|
-
"text": "boolean | undefined"
|
37443
|
-
},
|
37444
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37445
|
-
"default": "undefined",
|
37446
|
-
"fieldName": "disabled",
|
37447
|
-
"inheritedFrom": {
|
37448
|
-
"name": "FormfieldWrapper",
|
37449
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37450
|
-
}
|
37183
|
+
"description": "Defines aria-label attribute for close button accessibility",
|
37184
|
+
"fieldName": "closeButtonAriaLabel"
|
37451
37185
|
},
|
37452
37186
|
{
|
37453
|
-
"name": "
|
37187
|
+
"name": "header-text",
|
37454
37188
|
"type": {
|
37455
37189
|
"text": "string | undefined"
|
37456
37190
|
},
|
37457
|
-
"description": "
|
37458
|
-
"fieldName": "
|
37459
|
-
"inheritedFrom": {
|
37460
|
-
"name": "FormfieldWrapper",
|
37461
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37462
|
-
}
|
37463
|
-
},
|
37464
|
-
{
|
37465
|
-
"name": "required",
|
37466
|
-
"type": {
|
37467
|
-
"text": "boolean"
|
37468
|
-
},
|
37469
|
-
"default": "false",
|
37470
|
-
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37471
|
-
"fieldName": "required",
|
37472
|
-
"inheritedFrom": {
|
37473
|
-
"name": "FormfieldWrapper",
|
37474
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37475
|
-
}
|
37476
|
-
},
|
37477
|
-
{
|
37478
|
-
"name": "help-text-type",
|
37479
|
-
"type": {
|
37480
|
-
"text": "ValidationType"
|
37481
|
-
},
|
37482
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37483
|
-
"fieldName": "helpTextType",
|
37484
|
-
"inheritedFrom": {
|
37485
|
-
"name": "FormfieldWrapper",
|
37486
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37487
|
-
}
|
37191
|
+
"description": "Defines a string value to display as the title of the toast",
|
37192
|
+
"fieldName": "headerText"
|
37488
37193
|
},
|
37489
37194
|
{
|
37490
|
-
"name": "
|
37195
|
+
"name": "header-tag-name",
|
37491
37196
|
"type": {
|
37492
|
-
"text": "
|
37197
|
+
"text": "TagName"
|
37493
37198
|
},
|
37494
|
-
"description": "The
|
37495
|
-
"
|
37496
|
-
"
|
37497
|
-
"name": "FormfieldWrapper",
|
37498
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37499
|
-
}
|
37199
|
+
"description": "The html tag to be used for the header text",
|
37200
|
+
"default": "'h2'",
|
37201
|
+
"fieldName": "headerTagName"
|
37500
37202
|
},
|
37501
37203
|
{
|
37502
|
-
"name": "
|
37204
|
+
"name": "aria-label",
|
37503
37205
|
"type": {
|
37504
|
-
"text": "string |
|
37206
|
+
"text": "string | null"
|
37505
37207
|
},
|
37506
|
-
"
|
37507
|
-
"
|
37508
|
-
"
|
37509
|
-
"name": "FormfieldWrapper",
|
37510
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37511
|
-
}
|
37208
|
+
"default": "null",
|
37209
|
+
"description": "Defines aria-label attribute when header is not used",
|
37210
|
+
"fieldName": "ariaLabel"
|
37512
37211
|
},
|
37513
37212
|
{
|
37514
|
-
"name": "
|
37213
|
+
"name": "show-more-text",
|
37515
37214
|
"type": {
|
37516
|
-
"text": "
|
37215
|
+
"text": "string | undefined"
|
37517
37216
|
},
|
37518
|
-
"description": "
|
37519
|
-
"
|
37520
|
-
"fieldName": "toggletipPlacement",
|
37521
|
-
"inheritedFrom": {
|
37522
|
-
"name": "FormfieldWrapper",
|
37523
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37524
|
-
}
|
37217
|
+
"description": "Defines the text shown on the linkbutton when detailed content is hidden.",
|
37218
|
+
"fieldName": "showMoreText"
|
37525
37219
|
},
|
37526
37220
|
{
|
37527
|
-
"name": "
|
37221
|
+
"name": "show-less-text",
|
37528
37222
|
"type": {
|
37529
37223
|
"text": "string | undefined"
|
37530
37224
|
},
|
37531
|
-
"description": "
|
37532
|
-
"fieldName": "
|
37533
|
-
"inheritedFrom": {
|
37534
|
-
"name": "FormfieldWrapper",
|
37535
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37536
|
-
}
|
37225
|
+
"description": "Defines the text shown on the linkbutton when detailed content is visible.",
|
37226
|
+
"fieldName": "showLessText"
|
37537
37227
|
}
|
37538
37228
|
],
|
37539
37229
|
"mixins": [
|
37540
37230
|
{
|
37541
|
-
"name": "
|
37542
|
-
"module": "/src/utils/mixins/
|
37543
|
-
},
|
37544
|
-
{
|
37545
|
-
"name": "DataAriaLabelMixin",
|
37546
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
37231
|
+
"name": "FooterMixin",
|
37232
|
+
"module": "/src/utils/mixins/FooterMixin"
|
37547
37233
|
}
|
37548
37234
|
],
|
37549
37235
|
"superclass": {
|
37550
|
-
"name": "
|
37551
|
-
"module": "/src/
|
37236
|
+
"name": "Component",
|
37237
|
+
"module": "/src/models"
|
37552
37238
|
},
|
37553
|
-
"tagName": "mdc-
|
37554
|
-
"jsDoc": "/**\n *
|
37239
|
+
"tagName": "mdc-toast",
|
37240
|
+
"jsDoc": "/**\n * `mdc-toast` is a lightweight, non-blocking alert used to inform users about application processes.\n * It supports success, warning, error, and custom messages, and is designed to be controlled externally.\n * \n * **Note**: When using `slot=\"toast-body-normal\"` and `slot=\"toast-body-detailed\"`, it's strongly recommended to wrap the content with `<mdc-text tagname=\"span\">`.\n * If not used, ensure your custom content is styled appropriately to match the design and alignment expectations of the toast component.\n * \n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-linkbutton\n *\n * @slot content-prefix - Slot for custom content before the icon (only for custom variant).\n * @slot toast-body-normal - Slot for the main body content of the toast.\n * @slot toast-body-detailed - Slot for additional detailed content, shown when expanded.\n * @slot footer - Slot for custom footer content. Prefer using footer-button-primary and footer-button-secondary slots.\n * @slot footer-button-primary - Slot for passing the primary variant of `mdc-button` in the footer.\n * @slot footer-button-secondary - Slot for passing the secondary variant of `mdc-button` in the footer.\n *\n * @tagname mdc-toast\n * \n * @event close - (React: onClose) Dispatched when the Close Button is clicked using mouse or keyboard.\n *\n * @csspart content-container - The container for the toast's main content, including icon, text, and close button.\n * @csspart toast-prefix-icon - The icon shown at the start of the toast, styled by variant.\n * @csspart toast-content - The container for the header and body content of the toast.\n * @csspart toast-header - The header text of the toast.\n * @csspart footer - The container for the toast's footer, including toggle and action buttons.\n * @csspart footer-button-toggle - The toggle button for showing/hiding detailed content.\n * @csspart toast-close-btn - The close button for the toast.\n *\n * @cssproperty --mdc-toast-background-color - Background color of the toast.\n * @cssproperty --mdc-toast-border-color - Border color of the toast.\n * @cssproperty --mdc-toast-header-text-color - Color of the header text in the toast.\n * @cssproperty --mdc-toast-icon-color - Color of the icon in the toast.\n * @cssproperty --mdc-toast-elevation-3 - Elevation effect applied to the toast.\n * @cssproperty --mdc-toast-width - Width of the toast.\n * @cssproperty --mdc-toast-padding - Padding inside the toast.\n */",
|
37555
37241
|
"customElement": true
|
37556
37242
|
}
|
37557
37243
|
],
|
@@ -37560,384 +37246,698 @@
|
|
37560
37246
|
"kind": "js",
|
37561
37247
|
"name": "default",
|
37562
37248
|
"declaration": {
|
37563
|
-
"name": "
|
37564
|
-
"module": "components/
|
37249
|
+
"name": "Toast",
|
37250
|
+
"module": "components/toast/toast.component.js"
|
37565
37251
|
}
|
37566
37252
|
}
|
37567
37253
|
]
|
37568
37254
|
},
|
37569
37255
|
{
|
37570
37256
|
"kind": "javascript-module",
|
37571
|
-
"path": "components/
|
37257
|
+
"path": "components/toggle/toggle.component.js",
|
37572
37258
|
"declarations": [
|
37573
37259
|
{
|
37574
37260
|
"kind": "class",
|
37575
|
-
"description": "
|
37576
|
-
"name": "
|
37261
|
+
"description": "Toggle Component is an interactive control used to switch between two mutually exclusive options,\nsuch as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\nwhere users need to enable or disable a feature.\nIt contains an optional label and an optional helper text.\n\nTo create a group of toggles, use the FormFieldGroup component.\n\nNote: It internally renders a checkbox styled as a toggle switch.",
|
37262
|
+
"name": "Toggle",
|
37577
37263
|
"cssProperties": [
|
37578
37264
|
{
|
37579
|
-
"description": "
|
37580
|
-
"name": "--mdc-
|
37265
|
+
"description": "Width of the toggle",
|
37266
|
+
"name": "--mdc-toggle-width"
|
37581
37267
|
},
|
37582
37268
|
{
|
37583
|
-
"description": "
|
37584
|
-
"name": "--mdc-
|
37269
|
+
"description": "Height of the toggle",
|
37270
|
+
"name": "--mdc-toggle-height"
|
37585
37271
|
},
|
37586
37272
|
{
|
37587
|
-
"description": "
|
37588
|
-
"name": "--mdc-
|
37273
|
+
"description": "Width of the toggle when it's size is compact",
|
37274
|
+
"name": "--mdc-toggle-width-compact"
|
37589
37275
|
},
|
37590
37276
|
{
|
37591
|
-
"description": "
|
37592
|
-
"name": "--mdc-
|
37277
|
+
"description": "Height of the toggle when it's size is compact",
|
37278
|
+
"name": "--mdc-toggle-height-compact"
|
37593
37279
|
},
|
37594
37280
|
{
|
37595
|
-
"description": "
|
37596
|
-
"name": "--mdc-
|
37281
|
+
"description": "Line height of the toggle label",
|
37282
|
+
"name": "--mdc-toggle-label-lineheight"
|
37597
37283
|
},
|
37598
37284
|
{
|
37599
|
-
"description": "
|
37600
|
-
"name": "--mdc-
|
37285
|
+
"description": "Font size of the toggle label",
|
37286
|
+
"name": "--mdc-toggle-label-fontsize"
|
37601
37287
|
},
|
37602
37288
|
{
|
37603
|
-
"description": "
|
37604
|
-
"name": "--mdc-
|
37605
|
-
}
|
37606
|
-
],
|
37607
|
-
"cssParts": [
|
37608
|
-
{
|
37609
|
-
"description": "The container for the toast's main content, including icon, text, and close button.",
|
37610
|
-
"name": "content-container"
|
37289
|
+
"description": "Font weight of the toggle label",
|
37290
|
+
"name": "--mdc-toggle-label-fontweight"
|
37611
37291
|
},
|
37612
37292
|
{
|
37613
|
-
"description": "
|
37614
|
-
"name": "
|
37293
|
+
"description": "Color of the toggle label and help text in disabled state",
|
37294
|
+
"name": "--mdc-toggle-label-color-disabled"
|
37615
37295
|
},
|
37616
37296
|
{
|
37617
|
-
"description": "
|
37618
|
-
"name": "
|
37297
|
+
"description": "Color of the help text label",
|
37298
|
+
"name": "--mdc-toggle-help-text-color"
|
37619
37299
|
},
|
37620
37300
|
{
|
37621
|
-
"description": "
|
37622
|
-
"name": "
|
37301
|
+
"description": "Background color of the active toggle in hover state",
|
37302
|
+
"name": "--mdc-toggle-active-hover-color"
|
37623
37303
|
},
|
37624
37304
|
{
|
37625
|
-
"description": "
|
37626
|
-
"name": "
|
37305
|
+
"description": "Background color of the active toggle in pressed state",
|
37306
|
+
"name": "--mdc-toggle-active-pressed-color"
|
37627
37307
|
},
|
37628
37308
|
{
|
37629
|
-
"description": "
|
37630
|
-
"name": "
|
37309
|
+
"description": "Background color of the inactive toggle in hover state",
|
37310
|
+
"name": "--mdc-toggle-inactive-hover-color"
|
37631
37311
|
},
|
37632
37312
|
{
|
37633
|
-
"description": "
|
37634
|
-
"name": "
|
37313
|
+
"description": "Background color of the inactive toggle in pressed state",
|
37314
|
+
"name": "--mdc-toggle-inactive-pressed-color"
|
37635
37315
|
}
|
37636
37316
|
],
|
37637
|
-
"
|
37317
|
+
"members": [
|
37638
37318
|
{
|
37639
|
-
"
|
37640
|
-
"name": "
|
37319
|
+
"kind": "field",
|
37320
|
+
"name": "checked",
|
37321
|
+
"type": {
|
37322
|
+
"text": "boolean"
|
37323
|
+
},
|
37324
|
+
"default": "false",
|
37325
|
+
"description": "Determines whether the toggle is active or inactive.",
|
37326
|
+
"attribute": "checked",
|
37327
|
+
"reflects": true
|
37641
37328
|
},
|
37642
37329
|
{
|
37643
|
-
"
|
37644
|
-
"name": "
|
37330
|
+
"kind": "field",
|
37331
|
+
"name": "size",
|
37332
|
+
"type": {
|
37333
|
+
"text": "ToggleSize"
|
37334
|
+
},
|
37335
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37336
|
+
"default": "default",
|
37337
|
+
"attribute": "size",
|
37338
|
+
"reflects": true
|
37645
37339
|
},
|
37646
37340
|
{
|
37647
|
-
"
|
37648
|
-
"name": "
|
37341
|
+
"kind": "field",
|
37342
|
+
"name": "autofocus",
|
37343
|
+
"type": {
|
37344
|
+
"text": "boolean"
|
37345
|
+
},
|
37346
|
+
"default": "false",
|
37347
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
37348
|
+
"attribute": "autofocus",
|
37349
|
+
"reflects": true
|
37649
37350
|
},
|
37650
37351
|
{
|
37651
|
-
"
|
37652
|
-
"name": "
|
37352
|
+
"kind": "method",
|
37353
|
+
"name": "manageRequired",
|
37354
|
+
"privacy": "private",
|
37355
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
|
37653
37356
|
},
|
37654
37357
|
{
|
37655
|
-
"
|
37656
|
-
"name": "
|
37358
|
+
"kind": "method",
|
37359
|
+
"name": "setFormValue",
|
37360
|
+
"privacy": "private",
|
37361
|
+
"description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
|
37657
37362
|
},
|
37658
37363
|
{
|
37659
|
-
"
|
37660
|
-
"name": "
|
37661
|
-
|
37662
|
-
|
37663
|
-
|
37364
|
+
"kind": "method",
|
37365
|
+
"name": "toggleState",
|
37366
|
+
"privacy": "private",
|
37367
|
+
"return": {
|
37368
|
+
"type": {
|
37369
|
+
"text": "void"
|
37370
|
+
}
|
37371
|
+
},
|
37372
|
+
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
37373
|
+
},
|
37374
|
+
{
|
37375
|
+
"kind": "method",
|
37376
|
+
"name": "handleKeyDown",
|
37377
|
+
"privacy": "private",
|
37378
|
+
"return": {
|
37379
|
+
"type": {
|
37380
|
+
"text": "void"
|
37381
|
+
}
|
37382
|
+
},
|
37383
|
+
"parameters": [
|
37384
|
+
{
|
37385
|
+
"name": "event",
|
37386
|
+
"type": {
|
37387
|
+
"text": "KeyboardEvent"
|
37388
|
+
},
|
37389
|
+
"description": "The keyboard event."
|
37390
|
+
}
|
37391
|
+
],
|
37392
|
+
"description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
|
37393
|
+
},
|
37394
|
+
{
|
37395
|
+
"kind": "method",
|
37396
|
+
"name": "handleChange",
|
37397
|
+
"privacy": "private",
|
37398
|
+
"parameters": [
|
37399
|
+
{
|
37400
|
+
"name": "event",
|
37401
|
+
"type": {
|
37402
|
+
"text": "Event"
|
37403
|
+
}
|
37404
|
+
}
|
37405
|
+
],
|
37406
|
+
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
37407
|
+
},
|
37408
|
+
{
|
37409
|
+
"kind": "method",
|
37410
|
+
"name": "setToggleSize",
|
37411
|
+
"privacy": "private",
|
37412
|
+
"parameters": [
|
37413
|
+
{
|
37414
|
+
"name": "size",
|
37415
|
+
"type": {
|
37416
|
+
"text": "ToggleSize"
|
37417
|
+
},
|
37418
|
+
"description": "The size to set."
|
37419
|
+
}
|
37420
|
+
],
|
37421
|
+
"description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
|
37422
|
+
},
|
37423
|
+
{
|
37424
|
+
"kind": "field",
|
37425
|
+
"name": "name",
|
37426
|
+
"type": {
|
37427
|
+
"text": "string"
|
37428
|
+
},
|
37429
|
+
"default": "''",
|
37430
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37431
|
+
"attribute": "name",
|
37432
|
+
"reflects": true,
|
37433
|
+
"inheritedFrom": {
|
37434
|
+
"name": "FormInternalsMixin",
|
37435
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37436
|
+
}
|
37437
|
+
},
|
37664
37438
|
{
|
37665
37439
|
"kind": "field",
|
37666
|
-
"name": "
|
37440
|
+
"name": "value",
|
37667
37441
|
"type": {
|
37668
|
-
"text": "
|
37442
|
+
"text": "string"
|
37669
37443
|
},
|
37670
|
-
"
|
37671
|
-
"
|
37672
|
-
"attribute": "
|
37673
|
-
"reflects": true
|
37444
|
+
"default": "''",
|
37445
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
37446
|
+
"attribute": "value",
|
37447
|
+
"reflects": true,
|
37448
|
+
"inheritedFrom": {
|
37449
|
+
"name": "FormInternalsMixin",
|
37450
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37451
|
+
}
|
37674
37452
|
},
|
37675
37453
|
{
|
37676
37454
|
"kind": "field",
|
37677
|
-
"name": "
|
37455
|
+
"name": "validationMessage",
|
37678
37456
|
"type": {
|
37679
37457
|
"text": "string | undefined"
|
37680
37458
|
},
|
37681
|
-
"description": "
|
37682
|
-
"attribute": "
|
37459
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
37460
|
+
"attribute": "validation-message",
|
37461
|
+
"reflects": true,
|
37462
|
+
"inheritedFrom": {
|
37463
|
+
"name": "FormInternalsMixin",
|
37464
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37465
|
+
}
|
37683
37466
|
},
|
37684
37467
|
{
|
37685
37468
|
"kind": "field",
|
37686
|
-
"name": "
|
37469
|
+
"name": "validity",
|
37687
37470
|
"type": {
|
37688
|
-
"text": "
|
37471
|
+
"text": "ValidityState"
|
37689
37472
|
},
|
37690
|
-
"
|
37691
|
-
"
|
37692
|
-
|
37473
|
+
"readonly": true,
|
37474
|
+
"inheritedFrom": {
|
37475
|
+
"name": "FormInternalsMixin",
|
37476
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37477
|
+
}
|
37693
37478
|
},
|
37694
37479
|
{
|
37695
37480
|
"kind": "field",
|
37696
|
-
"name": "
|
37697
|
-
"
|
37698
|
-
|
37481
|
+
"name": "willValidate",
|
37482
|
+
"readonly": true,
|
37483
|
+
"inheritedFrom": {
|
37484
|
+
"name": "FormInternalsMixin",
|
37485
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37486
|
+
}
|
37487
|
+
},
|
37488
|
+
{
|
37489
|
+
"kind": "method",
|
37490
|
+
"name": "setValidity",
|
37491
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
37492
|
+
"return": {
|
37493
|
+
"type": {
|
37494
|
+
"text": ""
|
37495
|
+
}
|
37699
37496
|
},
|
37700
|
-
"
|
37701
|
-
|
37702
|
-
|
37703
|
-
|
37497
|
+
"inheritedFrom": {
|
37498
|
+
"name": "FormInternalsMixin",
|
37499
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37500
|
+
}
|
37501
|
+
},
|
37502
|
+
{
|
37503
|
+
"kind": "method",
|
37504
|
+
"name": "checkValidity",
|
37505
|
+
"return": {
|
37506
|
+
"type": {
|
37507
|
+
"text": "boolean"
|
37508
|
+
}
|
37509
|
+
},
|
37510
|
+
"inheritedFrom": {
|
37511
|
+
"name": "FormInternalsMixin",
|
37512
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37513
|
+
}
|
37514
|
+
},
|
37515
|
+
{
|
37516
|
+
"kind": "method",
|
37517
|
+
"name": "reportValidity",
|
37518
|
+
"inheritedFrom": {
|
37519
|
+
"name": "FormInternalsMixin",
|
37520
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
37521
|
+
}
|
37704
37522
|
},
|
37705
37523
|
{
|
37706
37524
|
"kind": "field",
|
37707
|
-
"name": "
|
37525
|
+
"name": "dataAriaLabel",
|
37708
37526
|
"type": {
|
37709
37527
|
"text": "string | null"
|
37710
37528
|
},
|
37711
37529
|
"default": "null",
|
37712
|
-
"description": "Defines
|
37713
|
-
"attribute": "aria-label",
|
37714
|
-
"reflects": true
|
37530
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37531
|
+
"attribute": "data-aria-label",
|
37532
|
+
"reflects": true,
|
37533
|
+
"inheritedFrom": {
|
37534
|
+
"name": "DataAriaLabelMixin",
|
37535
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
37536
|
+
}
|
37715
37537
|
},
|
37716
37538
|
{
|
37717
37539
|
"kind": "field",
|
37718
|
-
"name": "
|
37540
|
+
"name": "disabled",
|
37719
37541
|
"type": {
|
37720
|
-
"text": "
|
37542
|
+
"text": "boolean | undefined"
|
37721
37543
|
},
|
37722
|
-
"description": "
|
37723
|
-
"
|
37724
|
-
"
|
37544
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37545
|
+
"default": "undefined",
|
37546
|
+
"attribute": "disabled",
|
37547
|
+
"reflects": true,
|
37548
|
+
"inheritedFrom": {
|
37549
|
+
"name": "FormfieldWrapper",
|
37550
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37551
|
+
}
|
37725
37552
|
},
|
37726
37553
|
{
|
37727
37554
|
"kind": "field",
|
37728
|
-
"name": "
|
37555
|
+
"name": "label",
|
37729
37556
|
"type": {
|
37730
37557
|
"text": "string | undefined"
|
37731
37558
|
},
|
37732
|
-
"description": "
|
37733
|
-
"attribute": "
|
37734
|
-
"reflects": true
|
37559
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
37560
|
+
"attribute": "label",
|
37561
|
+
"reflects": true,
|
37562
|
+
"inheritedFrom": {
|
37563
|
+
"name": "FormfieldWrapper",
|
37564
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37565
|
+
}
|
37735
37566
|
},
|
37736
37567
|
{
|
37737
37568
|
"kind": "field",
|
37738
|
-
"name": "
|
37569
|
+
"name": "required",
|
37739
37570
|
"type": {
|
37740
37571
|
"text": "boolean"
|
37741
37572
|
},
|
37742
|
-
"
|
37743
|
-
"
|
37573
|
+
"default": "false",
|
37574
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37575
|
+
"attribute": "required",
|
37576
|
+
"reflects": true,
|
37577
|
+
"inheritedFrom": {
|
37578
|
+
"name": "FormfieldWrapper",
|
37579
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37580
|
+
}
|
37744
37581
|
},
|
37745
37582
|
{
|
37746
37583
|
"kind": "field",
|
37747
|
-
"name": "
|
37584
|
+
"name": "helpTextType",
|
37748
37585
|
"type": {
|
37749
|
-
"text": "
|
37586
|
+
"text": "ValidationType"
|
37750
37587
|
},
|
37751
|
-
"
|
37752
|
-
"
|
37588
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37589
|
+
"attribute": "help-text-type",
|
37590
|
+
"reflects": true,
|
37591
|
+
"inheritedFrom": {
|
37592
|
+
"name": "FormfieldWrapper",
|
37593
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37594
|
+
}
|
37753
37595
|
},
|
37754
37596
|
{
|
37755
37597
|
"kind": "field",
|
37756
|
-
"name": "
|
37598
|
+
"name": "helpText",
|
37757
37599
|
"type": {
|
37758
|
-
"text": "
|
37600
|
+
"text": "string | undefined"
|
37759
37601
|
},
|
37760
|
-
"
|
37602
|
+
"description": "The help text that is displayed below the input field.",
|
37603
|
+
"attribute": "help-text",
|
37604
|
+
"reflects": true,
|
37605
|
+
"inheritedFrom": {
|
37606
|
+
"name": "FormfieldWrapper",
|
37607
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37608
|
+
}
|
37761
37609
|
},
|
37762
37610
|
{
|
37763
37611
|
"kind": "field",
|
37764
|
-
"name": "
|
37612
|
+
"name": "toggletipText",
|
37765
37613
|
"type": {
|
37766
|
-
"text": "string"
|
37614
|
+
"text": "string | undefined"
|
37767
37615
|
},
|
37768
|
-
"
|
37769
|
-
"
|
37770
|
-
|
37771
|
-
|
37772
|
-
|
37773
|
-
|
37774
|
-
|
37775
|
-
"description": "Fired when Close Button is clicked using mouse or keyboard.\nThis method dispatches the close event.\nIt is used to notify that the toast should be closed."
|
37776
|
-
},
|
37777
|
-
{
|
37778
|
-
"kind": "method",
|
37779
|
-
"name": "toggleDetailVisibility",
|
37780
|
-
"privacy": "private"
|
37616
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
37617
|
+
"attribute": "toggletip-text",
|
37618
|
+
"reflects": true,
|
37619
|
+
"inheritedFrom": {
|
37620
|
+
"name": "FormfieldWrapper",
|
37621
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37622
|
+
}
|
37781
37623
|
},
|
37782
37624
|
{
|
37783
|
-
"kind": "
|
37784
|
-
"name": "
|
37785
|
-
"
|
37625
|
+
"kind": "field",
|
37626
|
+
"name": "toggletipPlacement",
|
37627
|
+
"type": {
|
37628
|
+
"text": "PopoverPlacement"
|
37629
|
+
},
|
37630
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37631
|
+
"default": "'top'",
|
37632
|
+
"attribute": "toggletip-placement",
|
37633
|
+
"reflects": true,
|
37634
|
+
"inheritedFrom": {
|
37635
|
+
"name": "FormfieldWrapper",
|
37636
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37637
|
+
}
|
37786
37638
|
},
|
37787
37639
|
{
|
37788
|
-
"kind": "
|
37789
|
-
"name": "
|
37790
|
-
"
|
37640
|
+
"kind": "field",
|
37641
|
+
"name": "infoIconAriaLabel",
|
37642
|
+
"type": {
|
37643
|
+
"text": "string | undefined"
|
37644
|
+
},
|
37645
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
37646
|
+
"attribute": "info-icon-aria-label",
|
37647
|
+
"reflects": true,
|
37648
|
+
"inheritedFrom": {
|
37649
|
+
"name": "FormfieldWrapper",
|
37650
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37651
|
+
}
|
37791
37652
|
},
|
37792
37653
|
{
|
37793
37654
|
"kind": "method",
|
37794
|
-
"name": "
|
37655
|
+
"name": "renderLabelElement",
|
37795
37656
|
"privacy": "protected",
|
37796
|
-
"
|
37797
|
-
|
37798
|
-
|
37799
|
-
"
|
37800
|
-
"text": "string"
|
37801
|
-
}
|
37657
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
37658
|
+
"return": {
|
37659
|
+
"type": {
|
37660
|
+
"text": ""
|
37802
37661
|
}
|
37803
|
-
|
37804
|
-
|
37805
|
-
|
37806
|
-
|
37807
|
-
|
37808
|
-
"privacy": "private"
|
37662
|
+
},
|
37663
|
+
"inheritedFrom": {
|
37664
|
+
"name": "FormfieldWrapper",
|
37665
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37666
|
+
}
|
37809
37667
|
},
|
37810
37668
|
{
|
37811
37669
|
"kind": "method",
|
37812
|
-
"name": "
|
37813
|
-
"privacy": "
|
37670
|
+
"name": "renderHelpTextIcon",
|
37671
|
+
"privacy": "protected",
|
37672
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
37673
|
+
"return": {
|
37674
|
+
"type": {
|
37675
|
+
"text": ""
|
37676
|
+
}
|
37677
|
+
},
|
37678
|
+
"inheritedFrom": {
|
37679
|
+
"name": "FormfieldWrapper",
|
37680
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37681
|
+
}
|
37814
37682
|
},
|
37815
37683
|
{
|
37816
37684
|
"kind": "method",
|
37817
|
-
"name": "
|
37818
|
-
"privacy": "protected"
|
37685
|
+
"name": "renderHelpText",
|
37686
|
+
"privacy": "protected",
|
37687
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
37688
|
+
"return": {
|
37689
|
+
"type": {
|
37690
|
+
"text": ""
|
37691
|
+
}
|
37692
|
+
},
|
37693
|
+
"inheritedFrom": {
|
37694
|
+
"name": "FormfieldWrapper",
|
37695
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37696
|
+
}
|
37819
37697
|
},
|
37820
37698
|
{
|
37821
37699
|
"kind": "method",
|
37822
|
-
"name": "
|
37700
|
+
"name": "renderLabel",
|
37823
37701
|
"privacy": "protected",
|
37702
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
37824
37703
|
"return": {
|
37825
37704
|
"type": {
|
37826
|
-
"text": "
|
37705
|
+
"text": ""
|
37827
37706
|
}
|
37828
37707
|
},
|
37829
|
-
"
|
37830
|
-
|
37831
|
-
|
37832
|
-
|
37833
|
-
"text": "string"
|
37834
|
-
}
|
37835
|
-
},
|
37836
|
-
{
|
37837
|
-
"name": "variant",
|
37838
|
-
"optional": true,
|
37839
|
-
"type": {
|
37840
|
-
"text": "string | undefined"
|
37841
|
-
}
|
37842
|
-
}
|
37843
|
-
]
|
37708
|
+
"inheritedFrom": {
|
37709
|
+
"name": "FormfieldWrapper",
|
37710
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37711
|
+
}
|
37844
37712
|
},
|
37845
37713
|
{
|
37846
37714
|
"kind": "method",
|
37847
|
-
"name": "
|
37715
|
+
"name": "renderHelperText",
|
37848
37716
|
"privacy": "protected",
|
37849
|
-
"description": "
|
37717
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
37850
37718
|
"return": {
|
37851
37719
|
"type": {
|
37852
37720
|
"text": ""
|
37853
37721
|
}
|
37854
37722
|
},
|
37855
37723
|
"inheritedFrom": {
|
37856
|
-
"name": "
|
37857
|
-
"module": "
|
37724
|
+
"name": "FormfieldWrapper",
|
37725
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
37858
37726
|
}
|
37859
37727
|
}
|
37860
37728
|
],
|
37861
37729
|
"events": [
|
37862
37730
|
{
|
37863
|
-
"
|
37864
|
-
|
37865
|
-
|
37731
|
+
"type": {
|
37732
|
+
"text": "EventConstructor"
|
37733
|
+
}
|
37734
|
+
},
|
37735
|
+
{
|
37736
|
+
"description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
|
37737
|
+
"name": "change",
|
37738
|
+
"reactName": "onChange"
|
37739
|
+
},
|
37740
|
+
{
|
37741
|
+
"description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
|
37742
|
+
"name": "focus",
|
37743
|
+
"reactName": "onFocus"
|
37866
37744
|
}
|
37867
37745
|
],
|
37868
37746
|
"attributes": [
|
37869
37747
|
{
|
37870
|
-
"name": "
|
37748
|
+
"name": "checked",
|
37871
37749
|
"type": {
|
37872
|
-
"text": "
|
37750
|
+
"text": "boolean"
|
37873
37751
|
},
|
37874
|
-
"
|
37875
|
-
"
|
37876
|
-
"fieldName": "
|
37752
|
+
"default": "false",
|
37753
|
+
"description": "Determines whether the toggle is active or inactive.",
|
37754
|
+
"fieldName": "checked"
|
37877
37755
|
},
|
37878
37756
|
{
|
37879
|
-
"name": "
|
37757
|
+
"name": "size",
|
37880
37758
|
"type": {
|
37881
|
-
"text": "
|
37759
|
+
"text": "ToggleSize"
|
37882
37760
|
},
|
37883
|
-
"description": "
|
37884
|
-
"
|
37761
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
37762
|
+
"default": "default",
|
37763
|
+
"fieldName": "size"
|
37885
37764
|
},
|
37886
37765
|
{
|
37887
|
-
"name": "
|
37766
|
+
"name": "autofocus",
|
37888
37767
|
"type": {
|
37889
|
-
"text": "
|
37768
|
+
"text": "boolean"
|
37890
37769
|
},
|
37891
|
-
"
|
37892
|
-
"
|
37770
|
+
"default": "false",
|
37771
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
37772
|
+
"fieldName": "autofocus"
|
37893
37773
|
},
|
37894
37774
|
{
|
37895
|
-
"name": "
|
37775
|
+
"name": "name",
|
37896
37776
|
"type": {
|
37897
|
-
"text": "
|
37777
|
+
"text": "string"
|
37898
37778
|
},
|
37899
|
-
"
|
37900
|
-
"
|
37901
|
-
"fieldName": "
|
37779
|
+
"default": "''",
|
37780
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
37781
|
+
"fieldName": "name",
|
37782
|
+
"inheritedFrom": {
|
37783
|
+
"name": "FormInternalsMixin",
|
37784
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37785
|
+
}
|
37902
37786
|
},
|
37903
37787
|
{
|
37904
|
-
"name": "
|
37788
|
+
"name": "value",
|
37789
|
+
"type": {
|
37790
|
+
"text": "string"
|
37791
|
+
},
|
37792
|
+
"default": "''",
|
37793
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
37794
|
+
"fieldName": "value",
|
37795
|
+
"inheritedFrom": {
|
37796
|
+
"name": "FormInternalsMixin",
|
37797
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37798
|
+
}
|
37799
|
+
},
|
37800
|
+
{
|
37801
|
+
"name": "validation-message",
|
37802
|
+
"type": {
|
37803
|
+
"text": "string | undefined"
|
37804
|
+
},
|
37805
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
37806
|
+
"fieldName": "validationMessage",
|
37807
|
+
"inheritedFrom": {
|
37808
|
+
"name": "FormInternalsMixin",
|
37809
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
37810
|
+
}
|
37811
|
+
},
|
37812
|
+
{
|
37813
|
+
"name": "data-aria-label",
|
37905
37814
|
"type": {
|
37906
37815
|
"text": "string | null"
|
37907
37816
|
},
|
37908
37817
|
"default": "null",
|
37909
|
-
"description": "Defines
|
37910
|
-
"fieldName": "
|
37818
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
37819
|
+
"fieldName": "dataAriaLabel",
|
37820
|
+
"inheritedFrom": {
|
37821
|
+
"name": "DataAriaLabelMixin",
|
37822
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
37823
|
+
}
|
37911
37824
|
},
|
37912
37825
|
{
|
37913
|
-
"name": "
|
37826
|
+
"name": "disabled",
|
37827
|
+
"type": {
|
37828
|
+
"text": "boolean | undefined"
|
37829
|
+
},
|
37830
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
37831
|
+
"default": "undefined",
|
37832
|
+
"fieldName": "disabled",
|
37833
|
+
"inheritedFrom": {
|
37834
|
+
"name": "FormfieldWrapper",
|
37835
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37836
|
+
}
|
37837
|
+
},
|
37838
|
+
{
|
37839
|
+
"name": "label",
|
37914
37840
|
"type": {
|
37915
37841
|
"text": "string | undefined"
|
37916
37842
|
},
|
37917
|
-
"description": "
|
37918
|
-
"fieldName": "
|
37843
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
37844
|
+
"fieldName": "label",
|
37845
|
+
"inheritedFrom": {
|
37846
|
+
"name": "FormfieldWrapper",
|
37847
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37848
|
+
}
|
37919
37849
|
},
|
37920
37850
|
{
|
37921
|
-
"name": "
|
37851
|
+
"name": "required",
|
37852
|
+
"type": {
|
37853
|
+
"text": "boolean"
|
37854
|
+
},
|
37855
|
+
"default": "false",
|
37856
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
37857
|
+
"fieldName": "required",
|
37858
|
+
"inheritedFrom": {
|
37859
|
+
"name": "FormfieldWrapper",
|
37860
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37861
|
+
}
|
37862
|
+
},
|
37863
|
+
{
|
37864
|
+
"name": "help-text-type",
|
37865
|
+
"type": {
|
37866
|
+
"text": "ValidationType"
|
37867
|
+
},
|
37868
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
37869
|
+
"fieldName": "helpTextType",
|
37870
|
+
"inheritedFrom": {
|
37871
|
+
"name": "FormfieldWrapper",
|
37872
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37873
|
+
}
|
37874
|
+
},
|
37875
|
+
{
|
37876
|
+
"name": "help-text",
|
37922
37877
|
"type": {
|
37923
37878
|
"text": "string | undefined"
|
37924
37879
|
},
|
37925
|
-
"description": "
|
37926
|
-
"fieldName": "
|
37880
|
+
"description": "The help text that is displayed below the input field.",
|
37881
|
+
"fieldName": "helpText",
|
37882
|
+
"inheritedFrom": {
|
37883
|
+
"name": "FormfieldWrapper",
|
37884
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37885
|
+
}
|
37886
|
+
},
|
37887
|
+
{
|
37888
|
+
"name": "toggletip-text",
|
37889
|
+
"type": {
|
37890
|
+
"text": "string | undefined"
|
37891
|
+
},
|
37892
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
37893
|
+
"fieldName": "toggletipText",
|
37894
|
+
"inheritedFrom": {
|
37895
|
+
"name": "FormfieldWrapper",
|
37896
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37897
|
+
}
|
37898
|
+
},
|
37899
|
+
{
|
37900
|
+
"name": "toggletip-placement",
|
37901
|
+
"type": {
|
37902
|
+
"text": "PopoverPlacement"
|
37903
|
+
},
|
37904
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
37905
|
+
"default": "'top'",
|
37906
|
+
"fieldName": "toggletipPlacement",
|
37907
|
+
"inheritedFrom": {
|
37908
|
+
"name": "FormfieldWrapper",
|
37909
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37910
|
+
}
|
37911
|
+
},
|
37912
|
+
{
|
37913
|
+
"name": "info-icon-aria-label",
|
37914
|
+
"type": {
|
37915
|
+
"text": "string | undefined"
|
37916
|
+
},
|
37917
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
37918
|
+
"fieldName": "infoIconAriaLabel",
|
37919
|
+
"inheritedFrom": {
|
37920
|
+
"name": "FormfieldWrapper",
|
37921
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
37922
|
+
}
|
37927
37923
|
}
|
37928
37924
|
],
|
37929
37925
|
"mixins": [
|
37930
37926
|
{
|
37931
|
-
"name": "
|
37932
|
-
"module": "/src/utils/mixins/
|
37927
|
+
"name": "FormInternalsMixin",
|
37928
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
37929
|
+
},
|
37930
|
+
{
|
37931
|
+
"name": "DataAriaLabelMixin",
|
37932
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
37933
37933
|
}
|
37934
37934
|
],
|
37935
37935
|
"superclass": {
|
37936
|
-
"name": "
|
37937
|
-
"module": "/src/
|
37936
|
+
"name": "FormfieldWrapper",
|
37937
|
+
"module": "/src/components/formfieldwrapper"
|
37938
37938
|
},
|
37939
|
-
"tagName": "mdc-
|
37940
|
-
"jsDoc": "/**\n *
|
37939
|
+
"tagName": "mdc-toggle",
|
37940
|
+
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-statictoggle\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width - Width of the toggle\n * @cssproperty --mdc-toggle-height - Height of the toggle\n * @cssproperty --mdc-toggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-label-lineheight - Line height of the toggle label\n * @cssproperty --mdc-toggle-label-fontsize - Font size of the toggle label\n * @cssproperty --mdc-toggle-label-fontweight - Font weight of the toggle label\n * @cssproperty --mdc-toggle-label-color-disabled - Color of the toggle label and help text in disabled state\n * @cssproperty --mdc-toggle-help-text-color - Color of the help text label\n * @cssproperty --mdc-toggle-active-hover-color - Background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - Background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-hover-color - Background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - Background color of the inactive toggle in pressed state\n */",
|
37941
37941
|
"customElement": true
|
37942
37942
|
}
|
37943
37943
|
],
|
@@ -37946,8 +37946,8 @@
|
|
37946
37946
|
"kind": "js",
|
37947
37947
|
"name": "default",
|
37948
37948
|
"declaration": {
|
37949
|
-
"name": "
|
37950
|
-
"module": "components/
|
37949
|
+
"name": "Toggle",
|
37950
|
+
"module": "components/toggle/toggle.component.js"
|
37951
37951
|
}
|
37952
37952
|
}
|
37953
37953
|
]
|