@momentum-design/components 0.89.0 → 0.89.1
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 +158 -158
- package/dist/browser/index.js.map +3 -3
- package/dist/components/menupopover/menupopover.component.d.ts +1 -0
- package/dist/components/menupopover/menupopover.component.js +14 -1
- package/dist/components/menupopover/menupopover.utils.js +4 -2
- package/dist/components/popover/popover.component.d.ts +11 -1
- package/dist/components/popover/popover.component.js +28 -0
- package/dist/custom-elements.json +1070 -951
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
@@ -5872,68 +5872,32 @@
|
|
5872
5872
|
},
|
5873
5873
|
{
|
5874
5874
|
"kind": "javascript-module",
|
5875
|
-
"path": "components/
|
5875
|
+
"path": "components/checkbox/checkbox.component.js",
|
5876
5876
|
"declarations": [
|
5877
5877
|
{
|
5878
5878
|
"kind": "class",
|
5879
|
-
"description": "
|
5880
|
-
"name": "
|
5881
|
-
"
|
5882
|
-
{
|
5883
|
-
"description": "This slot is for passing the content before the body",
|
5884
|
-
"name": "before-body",
|
5885
|
-
"inheritedFrom": {
|
5886
|
-
"name": "Card",
|
5887
|
-
"module": "src/components/card/card.component.ts"
|
5888
|
-
}
|
5889
|
-
},
|
5890
|
-
{
|
5891
|
-
"description": "This slot is for passing the text content for the card",
|
5892
|
-
"name": "body",
|
5893
|
-
"inheritedFrom": {
|
5894
|
-
"name": "Card",
|
5895
|
-
"module": "src/components/card/card.component.ts"
|
5896
|
-
}
|
5897
|
-
},
|
5879
|
+
"description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
|
5880
|
+
"name": "Checkbox",
|
5881
|
+
"cssProperties": [
|
5898
5882
|
{
|
5899
|
-
"description": "
|
5900
|
-
"name": "
|
5901
|
-
"inheritedFrom": {
|
5902
|
-
"name": "Card",
|
5903
|
-
"module": "src/components/card/card.component.ts"
|
5904
|
-
}
|
5883
|
+
"description": "Allows customization of the background color on hover.",
|
5884
|
+
"name": "--mdc-checkbox-background-color-hover"
|
5905
5885
|
},
|
5906
5886
|
{
|
5907
|
-
"description": "
|
5908
|
-
"name": "
|
5909
|
-
"inheritedFrom": {
|
5910
|
-
"name": "Card",
|
5911
|
-
"module": "src/components/card/card.component.ts"
|
5912
|
-
}
|
5887
|
+
"description": "Background color for a selected checkbox when hovered.",
|
5888
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
5913
5889
|
},
|
5914
5890
|
{
|
5915
|
-
"description": "
|
5916
|
-
"name": "
|
5917
|
-
"inheritedFrom": {
|
5918
|
-
"name": "Card",
|
5919
|
-
"module": "src/components/card/card.component.ts"
|
5920
|
-
}
|
5891
|
+
"description": "Background color for a selected checkbox when pressed.",
|
5892
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
5921
5893
|
},
|
5922
5894
|
{
|
5923
|
-
"description": "
|
5924
|
-
"name": "
|
5925
|
-
"inheritedFrom": {
|
5926
|
-
"name": "Card",
|
5927
|
-
"module": "src/components/card/card.component.ts"
|
5928
|
-
}
|
5895
|
+
"description": "Background color for a selected checkbox when pressed.",
|
5896
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
5929
5897
|
},
|
5930
5898
|
{
|
5931
|
-
"description": "
|
5932
|
-
"name": "
|
5933
|
-
"inheritedFrom": {
|
5934
|
-
"name": "Card",
|
5935
|
-
"module": "src/components/card/card.component.ts"
|
5936
|
-
}
|
5899
|
+
"description": "Background color for a selected checkbox when disabled.",
|
5900
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
5937
5901
|
}
|
5938
5902
|
],
|
5939
5903
|
"members": [
|
@@ -5944,376 +5908,432 @@
|
|
5944
5908
|
"text": "boolean"
|
5945
5909
|
},
|
5946
5910
|
"default": "false",
|
5947
|
-
"description": "
|
5911
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
5948
5912
|
"attribute": "checked",
|
5949
5913
|
"reflects": true
|
5950
5914
|
},
|
5951
5915
|
{
|
5952
5916
|
"kind": "field",
|
5953
|
-
"name": "
|
5917
|
+
"name": "indeterminate",
|
5954
5918
|
"type": {
|
5955
|
-
"text": "
|
5919
|
+
"text": "boolean"
|
5956
5920
|
},
|
5957
|
-
"default": "
|
5958
|
-
"description": "
|
5959
|
-
"attribute": "
|
5921
|
+
"default": "false",
|
5922
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
5923
|
+
"attribute": "indeterminate",
|
5924
|
+
"reflects": true
|
5925
|
+
},
|
5926
|
+
{
|
5927
|
+
"kind": "field",
|
5928
|
+
"name": "autofocus",
|
5929
|
+
"type": {
|
5930
|
+
"text": "boolean"
|
5931
|
+
},
|
5932
|
+
"default": "false",
|
5933
|
+
"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)",
|
5934
|
+
"attribute": "autofocus",
|
5935
|
+
"reflects": true
|
5960
5936
|
},
|
5961
5937
|
{
|
5962
5938
|
"kind": "method",
|
5963
|
-
"name": "
|
5939
|
+
"name": "setFormValue",
|
5964
5940
|
"privacy": "private",
|
5965
|
-
"
|
5966
|
-
"type": {
|
5967
|
-
"text": "CardRadio[]"
|
5968
|
-
}
|
5969
|
-
},
|
5970
|
-
"description": "Returns all cards within the same group (name)."
|
5941
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
5971
5942
|
},
|
5972
5943
|
{
|
5973
5944
|
"kind": "method",
|
5974
|
-
"name": "
|
5945
|
+
"name": "manageRequired",
|
5975
5946
|
"privacy": "private",
|
5976
|
-
"
|
5977
|
-
"type": {
|
5978
|
-
"text": "void"
|
5979
|
-
}
|
5980
|
-
},
|
5981
|
-
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
5947
|
+
"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."
|
5982
5948
|
},
|
5983
5949
|
{
|
5984
5950
|
"kind": "method",
|
5985
|
-
"name": "
|
5951
|
+
"name": "toggleState",
|
5952
|
+
"privacy": "private",
|
5986
5953
|
"return": {
|
5987
5954
|
"type": {
|
5988
5955
|
"text": "void"
|
5989
5956
|
}
|
5990
5957
|
},
|
5991
|
-
"
|
5992
|
-
{
|
5993
|
-
"name": "disabled",
|
5994
|
-
"type": {
|
5995
|
-
"text": "boolean"
|
5996
|
-
}
|
5997
|
-
}
|
5998
|
-
]
|
5958
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
5999
5959
|
},
|
6000
5960
|
{
|
6001
5961
|
"kind": "method",
|
6002
|
-
"name": "
|
5962
|
+
"name": "handleKeyDown",
|
6003
5963
|
"privacy": "private",
|
6004
5964
|
"return": {
|
6005
5965
|
"type": {
|
6006
5966
|
"text": "void"
|
6007
5967
|
}
|
6008
5968
|
},
|
6009
|
-
"parameters": [
|
6010
|
-
{
|
6011
|
-
"name": "cards",
|
6012
|
-
"type": {
|
6013
|
-
"text": "CardRadio[]"
|
6014
|
-
}
|
6015
|
-
},
|
6016
|
-
{
|
6017
|
-
"name": "index",
|
6018
|
-
"type": {
|
6019
|
-
"text": "number"
|
6020
|
-
}
|
6021
|
-
}
|
6022
|
-
]
|
6023
|
-
},
|
6024
|
-
{
|
6025
|
-
"kind": "method",
|
6026
|
-
"name": "toggleOnEnter",
|
6027
|
-
"privacy": "private",
|
6028
5969
|
"parameters": [
|
6029
5970
|
{
|
6030
5971
|
"name": "event",
|
6031
5972
|
"type": {
|
6032
5973
|
"text": "KeyboardEvent"
|
6033
5974
|
},
|
6034
|
-
"description": "The keyboard event"
|
5975
|
+
"description": "The keyboard event."
|
6035
5976
|
}
|
6036
5977
|
],
|
6037
|
-
"description": "
|
5978
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
6038
5979
|
},
|
6039
5980
|
{
|
6040
5981
|
"kind": "method",
|
6041
|
-
"name": "
|
6042
|
-
"privacy": "
|
5982
|
+
"name": "handleChange",
|
5983
|
+
"privacy": "public",
|
5984
|
+
"return": {
|
5985
|
+
"type": {
|
5986
|
+
"text": "void"
|
5987
|
+
}
|
5988
|
+
},
|
6043
5989
|
"parameters": [
|
6044
5990
|
{
|
6045
5991
|
"name": "event",
|
6046
5992
|
"type": {
|
6047
|
-
"text": "
|
6048
|
-
}
|
6049
|
-
"description": "The keyboard event"
|
5993
|
+
"text": "Event"
|
5994
|
+
}
|
6050
5995
|
}
|
6051
5996
|
],
|
6052
|
-
"description": "Toggles the
|
6053
|
-
},
|
6054
|
-
{
|
6055
|
-
"kind": "method",
|
6056
|
-
"name": "renderHeader",
|
6057
|
-
"privacy": "protected",
|
6058
|
-
"description": "Renders the header of the card",
|
6059
|
-
"return": {
|
6060
|
-
"type": {
|
6061
|
-
"text": ""
|
6062
|
-
}
|
6063
|
-
},
|
6064
|
-
"inheritedFrom": {
|
6065
|
-
"name": "Card",
|
6066
|
-
"module": "components/card/card.component.js"
|
6067
|
-
}
|
5997
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
6068
5998
|
},
|
6069
5999
|
{
|
6070
6000
|
"kind": "field",
|
6071
|
-
"name": "
|
6072
|
-
"
|
6073
|
-
"text": "boolean | undefined"
|
6074
|
-
},
|
6075
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
6076
|
-
"default": "undefined",
|
6077
|
-
"attribute": "disabled",
|
6078
|
-
"reflects": true,
|
6079
|
-
"inheritedFrom": {
|
6080
|
-
"name": "DisabledMixin",
|
6081
|
-
"module": "utils/mixins/DisabledMixin.js"
|
6082
|
-
}
|
6001
|
+
"name": "renderLabelAndHelperText",
|
6002
|
+
"privacy": "private"
|
6083
6003
|
},
|
6084
6004
|
{
|
6085
6005
|
"kind": "field",
|
6086
|
-
"name": "
|
6006
|
+
"name": "name",
|
6087
6007
|
"type": {
|
6088
|
-
"text": "
|
6008
|
+
"text": "string"
|
6089
6009
|
},
|
6090
|
-
"default": "
|
6091
|
-
"description": "
|
6092
|
-
"attribute": "
|
6010
|
+
"default": "''",
|
6011
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
6012
|
+
"attribute": "name",
|
6093
6013
|
"reflects": true,
|
6094
6014
|
"inheritedFrom": {
|
6095
|
-
"name": "
|
6096
|
-
"module": "utils/mixins/
|
6015
|
+
"name": "FormInternalsMixin",
|
6016
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6097
6017
|
}
|
6098
6018
|
},
|
6099
6019
|
{
|
6100
6020
|
"kind": "field",
|
6101
|
-
"name": "
|
6021
|
+
"name": "value",
|
6102
6022
|
"type": {
|
6103
6023
|
"text": "string"
|
6104
6024
|
},
|
6105
6025
|
"default": "''",
|
6106
|
-
"description": "
|
6107
|
-
"attribute": "
|
6026
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
6027
|
+
"attribute": "value",
|
6108
6028
|
"reflects": true,
|
6109
6029
|
"inheritedFrom": {
|
6110
|
-
"name": "
|
6111
|
-
"module": "
|
6030
|
+
"name": "FormInternalsMixin",
|
6031
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6112
6032
|
}
|
6113
6033
|
},
|
6114
6034
|
{
|
6115
6035
|
"kind": "field",
|
6116
|
-
"name": "
|
6036
|
+
"name": "validationMessage",
|
6117
6037
|
"type": {
|
6118
|
-
"text": "string"
|
6038
|
+
"text": "string | undefined"
|
6119
6039
|
},
|
6120
|
-
"
|
6121
|
-
"
|
6122
|
-
"attribute": "subtitle",
|
6040
|
+
"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.",
|
6041
|
+
"attribute": "validation-message",
|
6123
6042
|
"reflects": true,
|
6124
6043
|
"inheritedFrom": {
|
6125
|
-
"name": "
|
6126
|
-
"module": "
|
6044
|
+
"name": "FormInternalsMixin",
|
6045
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6127
6046
|
}
|
6128
6047
|
},
|
6129
6048
|
{
|
6130
6049
|
"kind": "field",
|
6131
|
-
"name": "
|
6050
|
+
"name": "validity",
|
6132
6051
|
"type": {
|
6133
|
-
"text": "
|
6052
|
+
"text": "ValidityState"
|
6134
6053
|
},
|
6135
|
-
"
|
6136
|
-
"description": "The image source URL to render on the card",
|
6137
|
-
"attribute": "image-src",
|
6138
|
-
"reflects": true,
|
6054
|
+
"readonly": true,
|
6139
6055
|
"inheritedFrom": {
|
6140
|
-
"name": "
|
6141
|
-
"module": "
|
6056
|
+
"name": "FormInternalsMixin",
|
6057
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6142
6058
|
}
|
6143
6059
|
},
|
6144
6060
|
{
|
6145
6061
|
"kind": "field",
|
6146
|
-
"name": "
|
6147
|
-
"
|
6148
|
-
"text": "string"
|
6149
|
-
},
|
6150
|
-
"default": "''",
|
6151
|
-
"description": "The image alt for accessibility support",
|
6152
|
-
"attribute": "image-alt",
|
6153
|
-
"reflects": true,
|
6062
|
+
"name": "willValidate",
|
6063
|
+
"readonly": true,
|
6154
6064
|
"inheritedFrom": {
|
6155
|
-
"name": "
|
6156
|
-
"module": "
|
6065
|
+
"name": "FormInternalsMixin",
|
6066
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6157
6067
|
}
|
6158
6068
|
},
|
6159
6069
|
{
|
6160
|
-
"kind": "
|
6161
|
-
"name": "
|
6162
|
-
"
|
6163
|
-
|
6070
|
+
"kind": "method",
|
6071
|
+
"name": "setValidity",
|
6072
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
6073
|
+
"return": {
|
6074
|
+
"type": {
|
6075
|
+
"text": ""
|
6076
|
+
}
|
6164
6077
|
},
|
6165
|
-
"
|
6166
|
-
|
6167
|
-
|
6078
|
+
"inheritedFrom": {
|
6079
|
+
"name": "FormInternalsMixin",
|
6080
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6081
|
+
}
|
6082
|
+
},
|
6083
|
+
{
|
6084
|
+
"kind": "method",
|
6085
|
+
"name": "checkValidity",
|
6086
|
+
"return": {
|
6087
|
+
"type": {
|
6088
|
+
"text": "boolean"
|
6089
|
+
}
|
6090
|
+
},
|
6091
|
+
"inheritedFrom": {
|
6092
|
+
"name": "FormInternalsMixin",
|
6093
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6094
|
+
}
|
6095
|
+
},
|
6096
|
+
{
|
6097
|
+
"kind": "method",
|
6098
|
+
"name": "reportValidity",
|
6099
|
+
"inheritedFrom": {
|
6100
|
+
"name": "FormInternalsMixin",
|
6101
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
6102
|
+
}
|
6103
|
+
},
|
6104
|
+
{
|
6105
|
+
"kind": "field",
|
6106
|
+
"name": "dataAriaLabel",
|
6107
|
+
"type": {
|
6108
|
+
"text": "string | null"
|
6109
|
+
},
|
6110
|
+
"default": "null",
|
6111
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
6112
|
+
"attribute": "data-aria-label",
|
6168
6113
|
"reflects": true,
|
6169
6114
|
"inheritedFrom": {
|
6170
|
-
"name": "
|
6171
|
-
"module": "
|
6115
|
+
"name": "DataAriaLabelMixin",
|
6116
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
6172
6117
|
}
|
6173
6118
|
},
|
6174
6119
|
{
|
6175
6120
|
"kind": "field",
|
6176
|
-
"name": "
|
6121
|
+
"name": "disabled",
|
6177
6122
|
"type": {
|
6178
|
-
"text": "
|
6123
|
+
"text": "boolean | undefined"
|
6179
6124
|
},
|
6180
|
-
"description": "
|
6181
|
-
"default": "
|
6182
|
-
"attribute": "
|
6125
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
6126
|
+
"default": "undefined",
|
6127
|
+
"attribute": "disabled",
|
6183
6128
|
"reflects": true,
|
6184
6129
|
"inheritedFrom": {
|
6185
|
-
"name": "
|
6186
|
-
"module": "
|
6130
|
+
"name": "DisabledMixin",
|
6131
|
+
"module": "utils/mixins/DisabledMixin.js"
|
6187
6132
|
}
|
6188
6133
|
},
|
6189
6134
|
{
|
6190
6135
|
"kind": "field",
|
6191
|
-
"name": "
|
6136
|
+
"name": "label",
|
6192
6137
|
"type": {
|
6193
|
-
"text": "
|
6138
|
+
"text": "string | undefined"
|
6194
6139
|
},
|
6195
|
-
"description": "The
|
6196
|
-
"
|
6197
|
-
"attribute": "title-tag-name",
|
6140
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
6141
|
+
"attribute": "label",
|
6198
6142
|
"reflects": true,
|
6199
6143
|
"inheritedFrom": {
|
6200
|
-
"name": "
|
6201
|
-
"module": "components/
|
6144
|
+
"name": "FormfieldWrapper",
|
6145
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6202
6146
|
}
|
6203
6147
|
},
|
6204
6148
|
{
|
6205
6149
|
"kind": "field",
|
6206
|
-
"name": "
|
6150
|
+
"name": "required",
|
6207
6151
|
"type": {
|
6208
|
-
"text": "
|
6152
|
+
"text": "boolean"
|
6209
6153
|
},
|
6210
|
-
"
|
6211
|
-
"
|
6212
|
-
"attribute": "
|
6154
|
+
"default": "false",
|
6155
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
6156
|
+
"attribute": "required",
|
6213
6157
|
"reflects": true,
|
6214
6158
|
"inheritedFrom": {
|
6215
|
-
"name": "
|
6216
|
-
"module": "components/
|
6159
|
+
"name": "FormfieldWrapper",
|
6160
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6217
6161
|
}
|
6218
6162
|
},
|
6219
6163
|
{
|
6220
6164
|
"kind": "field",
|
6221
|
-
"name": "
|
6165
|
+
"name": "id",
|
6222
6166
|
"type": {
|
6223
|
-
"text": "
|
6167
|
+
"text": "string"
|
6224
6168
|
},
|
6225
|
-
"
|
6226
|
-
"
|
6169
|
+
"default": "''",
|
6170
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
6171
|
+
"attribute": "id",
|
6172
|
+
"inheritedFrom": {
|
6173
|
+
"name": "FormfieldWrapper",
|
6174
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6175
|
+
}
|
6176
|
+
},
|
6177
|
+
{
|
6178
|
+
"kind": "field",
|
6179
|
+
"name": "helpTextType",
|
6180
|
+
"type": {
|
6181
|
+
"text": "ValidationType"
|
6182
|
+
},
|
6183
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
6184
|
+
"attribute": "help-text-type",
|
6227
6185
|
"reflects": true,
|
6228
6186
|
"inheritedFrom": {
|
6229
|
-
"name": "
|
6230
|
-
"module": "components/
|
6187
|
+
"name": "FormfieldWrapper",
|
6188
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6189
|
+
}
|
6190
|
+
},
|
6191
|
+
{
|
6192
|
+
"kind": "field",
|
6193
|
+
"name": "helpText",
|
6194
|
+
"type": {
|
6195
|
+
"text": "string | undefined"
|
6196
|
+
},
|
6197
|
+
"description": "The help text that is displayed below the input field.",
|
6198
|
+
"attribute": "help-text",
|
6199
|
+
"reflects": true,
|
6200
|
+
"inheritedFrom": {
|
6201
|
+
"name": "FormfieldWrapper",
|
6202
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6203
|
+
}
|
6204
|
+
},
|
6205
|
+
{
|
6206
|
+
"kind": "field",
|
6207
|
+
"name": "toggletipText",
|
6208
|
+
"type": {
|
6209
|
+
"text": "string | undefined"
|
6210
|
+
},
|
6211
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
6212
|
+
"attribute": "toggletip-text",
|
6213
|
+
"reflects": true,
|
6214
|
+
"inheritedFrom": {
|
6215
|
+
"name": "FormfieldWrapper",
|
6216
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6217
|
+
}
|
6218
|
+
},
|
6219
|
+
{
|
6220
|
+
"kind": "field",
|
6221
|
+
"name": "toggletipPlacement",
|
6222
|
+
"type": {
|
6223
|
+
"text": "PopoverPlacement"
|
6224
|
+
},
|
6225
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
6226
|
+
"default": "'top'",
|
6227
|
+
"attribute": "toggletip-placement",
|
6228
|
+
"reflects": true,
|
6229
|
+
"inheritedFrom": {
|
6230
|
+
"name": "FormfieldWrapper",
|
6231
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6232
|
+
}
|
6233
|
+
},
|
6234
|
+
{
|
6235
|
+
"kind": "field",
|
6236
|
+
"name": "infoIconAriaLabel",
|
6237
|
+
"type": {
|
6238
|
+
"text": "string | undefined"
|
6239
|
+
},
|
6240
|
+
"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.",
|
6241
|
+
"attribute": "info-icon-aria-label",
|
6242
|
+
"reflects": true,
|
6243
|
+
"inheritedFrom": {
|
6244
|
+
"name": "FormfieldWrapper",
|
6245
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6231
6246
|
}
|
6232
6247
|
},
|
6233
6248
|
{
|
6234
6249
|
"kind": "method",
|
6235
|
-
"name": "
|
6250
|
+
"name": "renderLabelElement",
|
6236
6251
|
"privacy": "protected",
|
6237
|
-
"description": "
|
6252
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
6238
6253
|
"return": {
|
6239
6254
|
"type": {
|
6240
6255
|
"text": ""
|
6241
6256
|
}
|
6242
6257
|
},
|
6243
6258
|
"inheritedFrom": {
|
6244
|
-
"name": "
|
6245
|
-
"module": "components/
|
6259
|
+
"name": "FormfieldWrapper",
|
6260
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6246
6261
|
}
|
6247
6262
|
},
|
6248
6263
|
{
|
6249
6264
|
"kind": "method",
|
6250
|
-
"name": "
|
6265
|
+
"name": "renderHelpTextIcon",
|
6251
6266
|
"privacy": "protected",
|
6252
|
-
"description": "
|
6267
|
+
"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.",
|
6253
6268
|
"return": {
|
6254
6269
|
"type": {
|
6255
6270
|
"text": ""
|
6256
6271
|
}
|
6257
6272
|
},
|
6258
6273
|
"inheritedFrom": {
|
6259
|
-
"name": "
|
6260
|
-
"module": "components/
|
6274
|
+
"name": "FormfieldWrapper",
|
6275
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6261
6276
|
}
|
6262
6277
|
},
|
6263
6278
|
{
|
6264
6279
|
"kind": "method",
|
6265
|
-
"name": "
|
6280
|
+
"name": "renderHelpText",
|
6266
6281
|
"privacy": "protected",
|
6267
|
-
"description": "
|
6282
|
+
"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.",
|
6268
6283
|
"return": {
|
6269
6284
|
"type": {
|
6270
6285
|
"text": ""
|
6271
6286
|
}
|
6272
6287
|
},
|
6273
6288
|
"inheritedFrom": {
|
6274
|
-
"name": "
|
6275
|
-
"module": "components/
|
6289
|
+
"name": "FormfieldWrapper",
|
6290
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6276
6291
|
}
|
6277
6292
|
},
|
6278
6293
|
{
|
6279
6294
|
"kind": "method",
|
6280
|
-
"name": "
|
6295
|
+
"name": "renderLabel",
|
6281
6296
|
"privacy": "protected",
|
6282
|
-
"description": "
|
6297
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
6283
6298
|
"return": {
|
6284
6299
|
"type": {
|
6285
6300
|
"text": ""
|
6286
6301
|
}
|
6287
6302
|
},
|
6288
6303
|
"inheritedFrom": {
|
6289
|
-
"name": "
|
6290
|
-
"module": "components/
|
6304
|
+
"name": "FormfieldWrapper",
|
6305
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6306
|
+
}
|
6307
|
+
},
|
6308
|
+
{
|
6309
|
+
"kind": "method",
|
6310
|
+
"name": "renderHelperText",
|
6311
|
+
"privacy": "protected",
|
6312
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
6313
|
+
"return": {
|
6314
|
+
"type": {
|
6315
|
+
"text": ""
|
6316
|
+
}
|
6317
|
+
},
|
6318
|
+
"inheritedFrom": {
|
6319
|
+
"name": "FormfieldWrapper",
|
6320
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
6291
6321
|
}
|
6292
6322
|
}
|
6293
6323
|
],
|
6294
6324
|
"events": [
|
6295
6325
|
{
|
6296
|
-
"
|
6297
|
-
|
6298
|
-
|
6299
|
-
},
|
6300
|
-
{
|
6301
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
|
6302
|
-
"name": "keydown",
|
6303
|
-
"reactName": "onKeyDown"
|
6304
|
-
},
|
6305
|
-
{
|
6306
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
|
6307
|
-
"name": "keyup",
|
6308
|
-
"reactName": "onKeyUp"
|
6326
|
+
"type": {
|
6327
|
+
"text": "EventConstructor"
|
6328
|
+
}
|
6309
6329
|
},
|
6310
6330
|
{
|
6311
|
-
"description": "(React: onChange) Event that gets dispatched when the
|
6331
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
6312
6332
|
"name": "change",
|
6313
6333
|
"reactName": "onChange"
|
6314
6334
|
},
|
6315
6335
|
{
|
6316
|
-
"description": "(React: onFocus) Event that gets dispatched when the
|
6336
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
6317
6337
|
"name": "focus",
|
6318
6338
|
"reactName": "onFocus"
|
6319
6339
|
}
|
@@ -6325,177 +6345,207 @@
|
|
6325
6345
|
"text": "boolean"
|
6326
6346
|
},
|
6327
6347
|
"default": "false",
|
6328
|
-
"description": "
|
6348
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
6329
6349
|
"fieldName": "checked"
|
6330
6350
|
},
|
6331
6351
|
{
|
6332
|
-
"name": "
|
6352
|
+
"name": "indeterminate",
|
6333
6353
|
"type": {
|
6334
|
-
"text": "
|
6354
|
+
"text": "boolean"
|
6335
6355
|
},
|
6336
|
-
"default": "
|
6337
|
-
"description": "
|
6338
|
-
"fieldName": "
|
6356
|
+
"default": "false",
|
6357
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
6358
|
+
"fieldName": "indeterminate"
|
6339
6359
|
},
|
6340
6360
|
{
|
6341
|
-
"name": "
|
6361
|
+
"name": "autofocus",
|
6342
6362
|
"type": {
|
6343
|
-
"text": "boolean
|
6363
|
+
"text": "boolean"
|
6344
6364
|
},
|
6345
|
-
"
|
6346
|
-
"
|
6347
|
-
"fieldName": "
|
6348
|
-
"inheritedFrom": {
|
6349
|
-
"name": "DisabledMixin",
|
6350
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
6351
|
-
}
|
6365
|
+
"default": "false",
|
6366
|
+
"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)",
|
6367
|
+
"fieldName": "autofocus"
|
6352
6368
|
},
|
6353
6369
|
{
|
6354
|
-
"name": "
|
6370
|
+
"name": "name",
|
6355
6371
|
"type": {
|
6356
|
-
"text": "
|
6372
|
+
"text": "string"
|
6357
6373
|
},
|
6358
|
-
"default": "
|
6359
|
-
"description": "
|
6360
|
-
"fieldName": "
|
6374
|
+
"default": "''",
|
6375
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
6376
|
+
"fieldName": "name",
|
6361
6377
|
"inheritedFrom": {
|
6362
|
-
"name": "
|
6363
|
-
"module": "src/utils/mixins/
|
6378
|
+
"name": "FormInternalsMixin",
|
6379
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6364
6380
|
}
|
6365
6381
|
},
|
6366
6382
|
{
|
6367
|
-
"name": "
|
6383
|
+
"name": "value",
|
6368
6384
|
"type": {
|
6369
6385
|
"text": "string"
|
6370
6386
|
},
|
6371
6387
|
"default": "''",
|
6372
|
-
"description": "
|
6373
|
-
"fieldName": "
|
6388
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
6389
|
+
"fieldName": "value",
|
6374
6390
|
"inheritedFrom": {
|
6375
|
-
"name": "
|
6376
|
-
"module": "src/
|
6391
|
+
"name": "FormInternalsMixin",
|
6392
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6377
6393
|
}
|
6378
6394
|
},
|
6379
6395
|
{
|
6380
|
-
"name": "
|
6396
|
+
"name": "validation-message",
|
6381
6397
|
"type": {
|
6382
|
-
"text": "string"
|
6398
|
+
"text": "string | undefined"
|
6383
6399
|
},
|
6384
|
-
"
|
6385
|
-
"
|
6386
|
-
"fieldName": "subtitle",
|
6400
|
+
"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.",
|
6401
|
+
"fieldName": "validationMessage",
|
6387
6402
|
"inheritedFrom": {
|
6388
|
-
"name": "
|
6389
|
-
"module": "src/
|
6403
|
+
"name": "FormInternalsMixin",
|
6404
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
6390
6405
|
}
|
6391
6406
|
},
|
6392
6407
|
{
|
6393
|
-
"name": "
|
6408
|
+
"name": "data-aria-label",
|
6394
6409
|
"type": {
|
6395
|
-
"text": "string"
|
6410
|
+
"text": "string | null"
|
6396
6411
|
},
|
6397
|
-
"default": "
|
6398
|
-
"description": "
|
6399
|
-
"fieldName": "
|
6412
|
+
"default": "null",
|
6413
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
6414
|
+
"fieldName": "dataAriaLabel",
|
6400
6415
|
"inheritedFrom": {
|
6401
|
-
"name": "
|
6402
|
-
"module": "src/
|
6416
|
+
"name": "DataAriaLabelMixin",
|
6417
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
6403
6418
|
}
|
6404
6419
|
},
|
6405
6420
|
{
|
6406
|
-
"name": "
|
6421
|
+
"name": "disabled",
|
6422
|
+
"type": {
|
6423
|
+
"text": "boolean | undefined"
|
6424
|
+
},
|
6425
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
6426
|
+
"default": "undefined",
|
6427
|
+
"fieldName": "disabled",
|
6428
|
+
"inheritedFrom": {
|
6429
|
+
"name": "DisabledMixin",
|
6430
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
6431
|
+
}
|
6432
|
+
},
|
6433
|
+
{
|
6434
|
+
"name": "label",
|
6435
|
+
"type": {
|
6436
|
+
"text": "string | undefined"
|
6437
|
+
},
|
6438
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
6439
|
+
"fieldName": "label",
|
6440
|
+
"inheritedFrom": {
|
6441
|
+
"name": "FormfieldWrapper",
|
6442
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6443
|
+
}
|
6444
|
+
},
|
6445
|
+
{
|
6446
|
+
"name": "required",
|
6447
|
+
"type": {
|
6448
|
+
"text": "boolean"
|
6449
|
+
},
|
6450
|
+
"default": "false",
|
6451
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
6452
|
+
"fieldName": "required",
|
6453
|
+
"inheritedFrom": {
|
6454
|
+
"name": "FormfieldWrapper",
|
6455
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6456
|
+
}
|
6457
|
+
},
|
6458
|
+
{
|
6459
|
+
"name": "id",
|
6407
6460
|
"type": {
|
6408
6461
|
"text": "string"
|
6409
6462
|
},
|
6410
6463
|
"default": "''",
|
6411
|
-
"description": "The
|
6412
|
-
"fieldName": "
|
6464
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
6465
|
+
"fieldName": "id",
|
6413
6466
|
"inheritedFrom": {
|
6414
|
-
"name": "
|
6415
|
-
"module": "src/components/
|
6467
|
+
"name": "FormfieldWrapper",
|
6468
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6416
6469
|
}
|
6417
6470
|
},
|
6418
6471
|
{
|
6419
|
-
"name": "
|
6472
|
+
"name": "help-text-type",
|
6420
6473
|
"type": {
|
6421
|
-
"text": "
|
6474
|
+
"text": "ValidationType"
|
6422
6475
|
},
|
6423
|
-
"description": "The
|
6424
|
-
"
|
6425
|
-
"fieldName": "variant",
|
6476
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
6477
|
+
"fieldName": "helpTextType",
|
6426
6478
|
"inheritedFrom": {
|
6427
|
-
"name": "
|
6428
|
-
"module": "src/components/
|
6479
|
+
"name": "FormfieldWrapper",
|
6480
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6429
6481
|
}
|
6430
6482
|
},
|
6431
6483
|
{
|
6432
|
-
"name": "
|
6484
|
+
"name": "help-text",
|
6433
6485
|
"type": {
|
6434
|
-
"text": "
|
6486
|
+
"text": "string | undefined"
|
6435
6487
|
},
|
6436
|
-
"description": "The
|
6437
|
-
"
|
6438
|
-
"fieldName": "orientation",
|
6488
|
+
"description": "The help text that is displayed below the input field.",
|
6489
|
+
"fieldName": "helpText",
|
6439
6490
|
"inheritedFrom": {
|
6440
|
-
"name": "
|
6441
|
-
"module": "src/components/
|
6491
|
+
"name": "FormfieldWrapper",
|
6492
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6442
6493
|
}
|
6443
6494
|
},
|
6444
6495
|
{
|
6445
|
-
"name": "
|
6496
|
+
"name": "toggletip-text",
|
6446
6497
|
"type": {
|
6447
|
-
"text": "
|
6498
|
+
"text": "string | undefined"
|
6448
6499
|
},
|
6449
|
-
"description": "The
|
6450
|
-
"
|
6451
|
-
"fieldName": "titleTagName",
|
6500
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
6501
|
+
"fieldName": "toggletipText",
|
6452
6502
|
"inheritedFrom": {
|
6453
|
-
"name": "
|
6454
|
-
"module": "src/components/
|
6503
|
+
"name": "FormfieldWrapper",
|
6504
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6455
6505
|
}
|
6456
6506
|
},
|
6457
6507
|
{
|
6458
|
-
"name": "
|
6508
|
+
"name": "toggletip-placement",
|
6459
6509
|
"type": {
|
6460
|
-
"text": "
|
6510
|
+
"text": "PopoverPlacement"
|
6461
6511
|
},
|
6462
|
-
"description": "The
|
6463
|
-
"default": "'
|
6464
|
-
"fieldName": "
|
6512
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
6513
|
+
"default": "'top'",
|
6514
|
+
"fieldName": "toggletipPlacement",
|
6465
6515
|
"inheritedFrom": {
|
6466
|
-
"name": "
|
6467
|
-
"module": "src/components/
|
6516
|
+
"name": "FormfieldWrapper",
|
6517
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6468
6518
|
}
|
6469
6519
|
},
|
6470
6520
|
{
|
6471
|
-
"name": "icon-
|
6521
|
+
"name": "info-icon-aria-label",
|
6472
6522
|
"type": {
|
6473
|
-
"text": "
|
6523
|
+
"text": "string | undefined"
|
6474
6524
|
},
|
6475
|
-
"description": "
|
6476
|
-
"fieldName": "
|
6525
|
+
"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.",
|
6526
|
+
"fieldName": "infoIconAriaLabel",
|
6477
6527
|
"inheritedFrom": {
|
6478
|
-
"name": "
|
6479
|
-
"module": "src/components/
|
6528
|
+
"name": "FormfieldWrapper",
|
6529
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
6480
6530
|
}
|
6481
6531
|
}
|
6482
6532
|
],
|
6483
6533
|
"mixins": [
|
6484
6534
|
{
|
6485
|
-
"name": "
|
6486
|
-
"module": "/src/utils/mixins/
|
6535
|
+
"name": "FormInternalsMixin",
|
6536
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
6487
6537
|
},
|
6488
6538
|
{
|
6489
|
-
"name": "
|
6490
|
-
"module": "/src/utils/mixins/
|
6539
|
+
"name": "DataAriaLabelMixin",
|
6540
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
6491
6541
|
}
|
6492
6542
|
],
|
6493
6543
|
"superclass": {
|
6494
|
-
"name": "
|
6495
|
-
"module": "/src/components/
|
6544
|
+
"name": "FormfieldWrapper",
|
6545
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
6496
6546
|
},
|
6497
|
-
"tagName": "mdc-
|
6498
|
-
"jsDoc": "/**\n *
|
6547
|
+
"tagName": "mdc-checkbox",
|
6548
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
6499
6549
|
"customElement": true
|
6500
6550
|
}
|
6501
6551
|
],
|
@@ -6504,40 +6554,76 @@
|
|
6504
6554
|
"kind": "js",
|
6505
6555
|
"name": "default",
|
6506
6556
|
"declaration": {
|
6507
|
-
"name": "
|
6508
|
-
"module": "components/
|
6557
|
+
"name": "Checkbox",
|
6558
|
+
"module": "components/checkbox/checkbox.component.js"
|
6509
6559
|
}
|
6510
6560
|
}
|
6511
6561
|
]
|
6512
6562
|
},
|
6513
6563
|
{
|
6514
6564
|
"kind": "javascript-module",
|
6515
|
-
"path": "components/
|
6565
|
+
"path": "components/cardradio/cardradio.component.js",
|
6516
6566
|
"declarations": [
|
6517
6567
|
{
|
6518
6568
|
"kind": "class",
|
6519
|
-
"description": "
|
6520
|
-
"name": "
|
6521
|
-
"
|
6569
|
+
"description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
|
6570
|
+
"name": "CardRadio",
|
6571
|
+
"slots": [
|
6522
6572
|
{
|
6523
|
-
"description": "
|
6524
|
-
"name": "
|
6573
|
+
"description": "This slot is for passing the content before the body",
|
6574
|
+
"name": "before-body",
|
6575
|
+
"inheritedFrom": {
|
6576
|
+
"name": "Card",
|
6577
|
+
"module": "src/components/card/card.component.ts"
|
6578
|
+
}
|
6525
6579
|
},
|
6526
6580
|
{
|
6527
|
-
"description": "
|
6528
|
-
"name": "
|
6581
|
+
"description": "This slot is for passing the text content for the card",
|
6582
|
+
"name": "body",
|
6583
|
+
"inheritedFrom": {
|
6584
|
+
"name": "Card",
|
6585
|
+
"module": "src/components/card/card.component.ts"
|
6586
|
+
}
|
6529
6587
|
},
|
6530
6588
|
{
|
6531
|
-
"description": "
|
6532
|
-
"name": "
|
6589
|
+
"description": "This slot is for passing the content after the body",
|
6590
|
+
"name": "after-body",
|
6591
|
+
"inheritedFrom": {
|
6592
|
+
"name": "Card",
|
6593
|
+
"module": "src/components/card/card.component.ts"
|
6594
|
+
}
|
6533
6595
|
},
|
6534
6596
|
{
|
6535
|
-
"description": "
|
6536
|
-
"name": "
|
6597
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
6598
|
+
"name": "footer-link",
|
6599
|
+
"inheritedFrom": {
|
6600
|
+
"name": "Card",
|
6601
|
+
"module": "src/components/card/card.component.ts"
|
6602
|
+
}
|
6537
6603
|
},
|
6538
6604
|
{
|
6539
|
-
"description": "
|
6540
|
-
"name": "
|
6605
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
6606
|
+
"name": "footer-button-primary",
|
6607
|
+
"inheritedFrom": {
|
6608
|
+
"name": "Card",
|
6609
|
+
"module": "src/components/card/card.component.ts"
|
6610
|
+
}
|
6611
|
+
},
|
6612
|
+
{
|
6613
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
6614
|
+
"name": "footer-button-secondary",
|
6615
|
+
"inheritedFrom": {
|
6616
|
+
"name": "Card",
|
6617
|
+
"module": "src/components/card/card.component.ts"
|
6618
|
+
}
|
6619
|
+
},
|
6620
|
+
{
|
6621
|
+
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
|
6622
|
+
"name": "footer",
|
6623
|
+
"inheritedFrom": {
|
6624
|
+
"name": "Card",
|
6625
|
+
"module": "src/components/card/card.component.ts"
|
6626
|
+
}
|
6541
6627
|
}
|
6542
6628
|
],
|
6543
6629
|
"members": [
|
@@ -6548,59 +6634,45 @@
|
|
6548
6634
|
"text": "boolean"
|
6549
6635
|
},
|
6550
6636
|
"default": "false",
|
6551
|
-
"description": "
|
6637
|
+
"description": "The checked state of the card",
|
6552
6638
|
"attribute": "checked",
|
6553
6639
|
"reflects": true
|
6554
6640
|
},
|
6555
6641
|
{
|
6556
6642
|
"kind": "field",
|
6557
|
-
"name": "
|
6558
|
-
"type": {
|
6559
|
-
"text": "boolean"
|
6560
|
-
},
|
6561
|
-
"default": "false",
|
6562
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
6563
|
-
"attribute": "indeterminate",
|
6564
|
-
"reflects": true
|
6565
|
-
},
|
6566
|
-
{
|
6567
|
-
"kind": "field",
|
6568
|
-
"name": "autofocus",
|
6643
|
+
"name": "name",
|
6569
6644
|
"type": {
|
6570
|
-
"text": "
|
6645
|
+
"text": "string"
|
6571
6646
|
},
|
6572
|
-
"default": "
|
6573
|
-
"description": "
|
6574
|
-
"attribute": "
|
6575
|
-
"reflects": true
|
6576
|
-
},
|
6577
|
-
{
|
6578
|
-
"kind": "method",
|
6579
|
-
"name": "setFormValue",
|
6580
|
-
"privacy": "private",
|
6581
|
-
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
6647
|
+
"default": "''",
|
6648
|
+
"description": "The name of the radio.",
|
6649
|
+
"attribute": "name"
|
6582
6650
|
},
|
6583
6651
|
{
|
6584
6652
|
"kind": "method",
|
6585
|
-
"name": "
|
6653
|
+
"name": "getAllCardsWithinSameGroup",
|
6586
6654
|
"privacy": "private",
|
6587
|
-
"
|
6655
|
+
"return": {
|
6656
|
+
"type": {
|
6657
|
+
"text": "CardRadio[]"
|
6658
|
+
}
|
6659
|
+
},
|
6660
|
+
"description": "Returns all cards within the same group (name)."
|
6588
6661
|
},
|
6589
6662
|
{
|
6590
6663
|
"kind": "method",
|
6591
|
-
"name": "
|
6664
|
+
"name": "toggleChecked",
|
6592
6665
|
"privacy": "private",
|
6593
6666
|
"return": {
|
6594
6667
|
"type": {
|
6595
6668
|
"text": "void"
|
6596
6669
|
}
|
6597
6670
|
},
|
6598
|
-
"description": "
|
6671
|
+
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
6599
6672
|
},
|
6600
6673
|
{
|
6601
6674
|
"kind": "method",
|
6602
|
-
"name": "
|
6603
|
-
"privacy": "private",
|
6675
|
+
"name": "setDisabled",
|
6604
6676
|
"return": {
|
6605
6677
|
"type": {
|
6606
6678
|
"text": "void"
|
@@ -6608,19 +6680,17 @@
|
|
6608
6680
|
},
|
6609
6681
|
"parameters": [
|
6610
6682
|
{
|
6611
|
-
"name": "
|
6683
|
+
"name": "disabled",
|
6612
6684
|
"type": {
|
6613
|
-
"text": "
|
6614
|
-
}
|
6615
|
-
"description": "The keyboard event."
|
6685
|
+
"text": "boolean"
|
6686
|
+
}
|
6616
6687
|
}
|
6617
|
-
]
|
6618
|
-
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
6688
|
+
]
|
6619
6689
|
},
|
6620
6690
|
{
|
6621
6691
|
"kind": "method",
|
6622
|
-
"name": "
|
6623
|
-
"privacy": "
|
6692
|
+
"name": "updateCardRadio",
|
6693
|
+
"privacy": "private",
|
6624
6694
|
"return": {
|
6625
6695
|
"type": {
|
6626
6696
|
"text": "void"
|
@@ -6628,352 +6698,312 @@
|
|
6628
6698
|
},
|
6629
6699
|
"parameters": [
|
6630
6700
|
{
|
6631
|
-
"name": "
|
6701
|
+
"name": "cards",
|
6632
6702
|
"type": {
|
6633
|
-
"text": "
|
6703
|
+
"text": "CardRadio[]"
|
6704
|
+
}
|
6705
|
+
},
|
6706
|
+
{
|
6707
|
+
"name": "index",
|
6708
|
+
"type": {
|
6709
|
+
"text": "number"
|
6634
6710
|
}
|
6635
6711
|
}
|
6636
|
-
]
|
6637
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
6638
|
-
},
|
6639
|
-
{
|
6640
|
-
"kind": "field",
|
6641
|
-
"name": "renderLabelAndHelperText",
|
6642
|
-
"privacy": "private"
|
6643
|
-
},
|
6644
|
-
{
|
6645
|
-
"kind": "field",
|
6646
|
-
"name": "name",
|
6647
|
-
"type": {
|
6648
|
-
"text": "string"
|
6649
|
-
},
|
6650
|
-
"default": "''",
|
6651
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
6652
|
-
"attribute": "name",
|
6653
|
-
"reflects": true,
|
6654
|
-
"inheritedFrom": {
|
6655
|
-
"name": "FormInternalsMixin",
|
6656
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6657
|
-
}
|
6658
|
-
},
|
6659
|
-
{
|
6660
|
-
"kind": "field",
|
6661
|
-
"name": "value",
|
6662
|
-
"type": {
|
6663
|
-
"text": "string"
|
6664
|
-
},
|
6665
|
-
"default": "''",
|
6666
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
6667
|
-
"attribute": "value",
|
6668
|
-
"reflects": true,
|
6669
|
-
"inheritedFrom": {
|
6670
|
-
"name": "FormInternalsMixin",
|
6671
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6672
|
-
}
|
6673
|
-
},
|
6674
|
-
{
|
6675
|
-
"kind": "field",
|
6676
|
-
"name": "validationMessage",
|
6677
|
-
"type": {
|
6678
|
-
"text": "string | undefined"
|
6679
|
-
},
|
6680
|
-
"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.",
|
6681
|
-
"attribute": "validation-message",
|
6682
|
-
"reflects": true,
|
6683
|
-
"inheritedFrom": {
|
6684
|
-
"name": "FormInternalsMixin",
|
6685
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6686
|
-
}
|
6687
|
-
},
|
6688
|
-
{
|
6689
|
-
"kind": "field",
|
6690
|
-
"name": "validity",
|
6691
|
-
"type": {
|
6692
|
-
"text": "ValidityState"
|
6693
|
-
},
|
6694
|
-
"readonly": true,
|
6695
|
-
"inheritedFrom": {
|
6696
|
-
"name": "FormInternalsMixin",
|
6697
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6698
|
-
}
|
6712
|
+
]
|
6699
6713
|
},
|
6700
6714
|
{
|
6701
|
-
"kind": "
|
6702
|
-
"name": "
|
6703
|
-
"
|
6704
|
-
"
|
6705
|
-
|
6706
|
-
|
6707
|
-
|
6715
|
+
"kind": "method",
|
6716
|
+
"name": "toggleOnEnter",
|
6717
|
+
"privacy": "private",
|
6718
|
+
"parameters": [
|
6719
|
+
{
|
6720
|
+
"name": "event",
|
6721
|
+
"type": {
|
6722
|
+
"text": "KeyboardEvent"
|
6723
|
+
},
|
6724
|
+
"description": "The keyboard event"
|
6725
|
+
}
|
6726
|
+
],
|
6727
|
+
"description": "Toggles the checked state when enter key is used"
|
6708
6728
|
},
|
6709
6729
|
{
|
6710
6730
|
"kind": "method",
|
6711
|
-
"name": "
|
6712
|
-
"
|
6713
|
-
"
|
6714
|
-
|
6715
|
-
"
|
6731
|
+
"name": "toggleOnSpace",
|
6732
|
+
"privacy": "private",
|
6733
|
+
"parameters": [
|
6734
|
+
{
|
6735
|
+
"name": "event",
|
6736
|
+
"type": {
|
6737
|
+
"text": "KeyboardEvent"
|
6738
|
+
},
|
6739
|
+
"description": "The keyboard event"
|
6716
6740
|
}
|
6717
|
-
|
6718
|
-
"
|
6719
|
-
"name": "FormInternalsMixin",
|
6720
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6721
|
-
}
|
6741
|
+
],
|
6742
|
+
"description": "Toggles the checked state when space key is used"
|
6722
6743
|
},
|
6723
6744
|
{
|
6724
6745
|
"kind": "method",
|
6725
|
-
"name": "
|
6746
|
+
"name": "renderHeader",
|
6747
|
+
"privacy": "protected",
|
6748
|
+
"description": "Renders the header of the card",
|
6726
6749
|
"return": {
|
6727
6750
|
"type": {
|
6728
|
-
"text": "
|
6751
|
+
"text": ""
|
6729
6752
|
}
|
6730
6753
|
},
|
6731
6754
|
"inheritedFrom": {
|
6732
|
-
"name": "
|
6733
|
-
"module": "
|
6734
|
-
}
|
6735
|
-
},
|
6736
|
-
{
|
6737
|
-
"kind": "method",
|
6738
|
-
"name": "reportValidity",
|
6739
|
-
"inheritedFrom": {
|
6740
|
-
"name": "FormInternalsMixin",
|
6741
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
6755
|
+
"name": "Card",
|
6756
|
+
"module": "components/card/card.component.js"
|
6742
6757
|
}
|
6743
6758
|
},
|
6744
6759
|
{
|
6745
6760
|
"kind": "field",
|
6746
|
-
"name": "
|
6761
|
+
"name": "disabled",
|
6747
6762
|
"type": {
|
6748
|
-
"text": "
|
6763
|
+
"text": "boolean | undefined"
|
6749
6764
|
},
|
6750
|
-
"
|
6751
|
-
"
|
6752
|
-
"attribute": "
|
6765
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
6766
|
+
"default": "undefined",
|
6767
|
+
"attribute": "disabled",
|
6753
6768
|
"reflects": true,
|
6754
6769
|
"inheritedFrom": {
|
6755
|
-
"name": "
|
6756
|
-
"module": "utils/mixins/
|
6770
|
+
"name": "DisabledMixin",
|
6771
|
+
"module": "utils/mixins/DisabledMixin.js"
|
6757
6772
|
}
|
6758
6773
|
},
|
6759
6774
|
{
|
6760
6775
|
"kind": "field",
|
6761
|
-
"name": "
|
6776
|
+
"name": "tabIndex",
|
6762
6777
|
"type": {
|
6763
|
-
"text": "
|
6778
|
+
"text": "number"
|
6764
6779
|
},
|
6765
|
-
"
|
6766
|
-
"
|
6767
|
-
"attribute": "
|
6780
|
+
"default": "0",
|
6781
|
+
"description": "This property specifies the tab order of the element.",
|
6782
|
+
"attribute": "tabIndex",
|
6768
6783
|
"reflects": true,
|
6769
6784
|
"inheritedFrom": {
|
6770
|
-
"name": "
|
6771
|
-
"module": "utils/mixins/
|
6785
|
+
"name": "TabIndexMixin",
|
6786
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
6772
6787
|
}
|
6773
6788
|
},
|
6774
6789
|
{
|
6775
6790
|
"kind": "field",
|
6776
|
-
"name": "
|
6791
|
+
"name": "cardTitle",
|
6777
6792
|
"type": {
|
6778
|
-
"text": "string
|
6793
|
+
"text": "string"
|
6779
6794
|
},
|
6780
|
-
"
|
6781
|
-
"
|
6795
|
+
"default": "''",
|
6796
|
+
"description": "The title of the card - part of header section",
|
6797
|
+
"attribute": "card-title",
|
6782
6798
|
"reflects": true,
|
6783
6799
|
"inheritedFrom": {
|
6784
|
-
"name": "
|
6785
|
-
"module": "components/
|
6800
|
+
"name": "Card",
|
6801
|
+
"module": "components/card/card.component.js"
|
6786
6802
|
}
|
6787
6803
|
},
|
6788
6804
|
{
|
6789
6805
|
"kind": "field",
|
6790
|
-
"name": "
|
6806
|
+
"name": "subtitle",
|
6791
6807
|
"type": {
|
6792
|
-
"text": "
|
6808
|
+
"text": "string"
|
6793
6809
|
},
|
6794
|
-
"default": "
|
6795
|
-
"description": "The
|
6796
|
-
"attribute": "
|
6810
|
+
"default": "''",
|
6811
|
+
"description": "The subtitle of the card - part of header section",
|
6812
|
+
"attribute": "subtitle",
|
6797
6813
|
"reflects": true,
|
6798
6814
|
"inheritedFrom": {
|
6799
|
-
"name": "
|
6800
|
-
"module": "components/
|
6815
|
+
"name": "Card",
|
6816
|
+
"module": "components/card/card.component.js"
|
6801
6817
|
}
|
6802
6818
|
},
|
6803
6819
|
{
|
6804
6820
|
"kind": "field",
|
6805
|
-
"name": "
|
6821
|
+
"name": "imageSrc",
|
6806
6822
|
"type": {
|
6807
6823
|
"text": "string"
|
6808
6824
|
},
|
6809
6825
|
"default": "''",
|
6810
|
-
"description": "The
|
6811
|
-
"attribute": "
|
6826
|
+
"description": "The image source URL to render on the card",
|
6827
|
+
"attribute": "image-src",
|
6828
|
+
"reflects": true,
|
6812
6829
|
"inheritedFrom": {
|
6813
|
-
"name": "
|
6814
|
-
"module": "components/
|
6830
|
+
"name": "Card",
|
6831
|
+
"module": "components/card/card.component.js"
|
6815
6832
|
}
|
6816
6833
|
},
|
6817
6834
|
{
|
6818
6835
|
"kind": "field",
|
6819
|
-
"name": "
|
6836
|
+
"name": "imageAlt",
|
6820
6837
|
"type": {
|
6821
|
-
"text": "
|
6838
|
+
"text": "string"
|
6822
6839
|
},
|
6823
|
-
"
|
6824
|
-
"
|
6840
|
+
"default": "''",
|
6841
|
+
"description": "The image alt for accessibility support",
|
6842
|
+
"attribute": "image-alt",
|
6825
6843
|
"reflects": true,
|
6826
6844
|
"inheritedFrom": {
|
6827
|
-
"name": "
|
6828
|
-
"module": "components/
|
6845
|
+
"name": "Card",
|
6846
|
+
"module": "components/card/card.component.js"
|
6829
6847
|
}
|
6830
6848
|
},
|
6831
6849
|
{
|
6832
6850
|
"kind": "field",
|
6833
|
-
"name": "
|
6851
|
+
"name": "variant",
|
6834
6852
|
"type": {
|
6835
|
-
"text": "
|
6853
|
+
"text": "CardVariant"
|
6836
6854
|
},
|
6837
|
-
"description": "The
|
6838
|
-
"
|
6855
|
+
"description": "The variant of the card. It can either be set to 'border' or 'ghost'",
|
6856
|
+
"default": "'border'",
|
6857
|
+
"attribute": "variant",
|
6839
6858
|
"reflects": true,
|
6840
6859
|
"inheritedFrom": {
|
6841
|
-
"name": "
|
6842
|
-
"module": "components/
|
6860
|
+
"name": "Card",
|
6861
|
+
"module": "components/card/card.component.js"
|
6843
6862
|
}
|
6844
6863
|
},
|
6845
6864
|
{
|
6846
6865
|
"kind": "field",
|
6847
|
-
"name": "
|
6866
|
+
"name": "orientation",
|
6848
6867
|
"type": {
|
6849
|
-
"text": "
|
6868
|
+
"text": "CardOrientation"
|
6850
6869
|
},
|
6851
|
-
"description": "The
|
6852
|
-
"
|
6870
|
+
"description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
|
6871
|
+
"default": "'vertical'",
|
6872
|
+
"attribute": "orientation",
|
6853
6873
|
"reflects": true,
|
6854
6874
|
"inheritedFrom": {
|
6855
|
-
"name": "
|
6856
|
-
"module": "components/
|
6875
|
+
"name": "Card",
|
6876
|
+
"module": "components/card/card.component.js"
|
6857
6877
|
}
|
6858
6878
|
},
|
6859
6879
|
{
|
6860
6880
|
"kind": "field",
|
6861
|
-
"name": "
|
6881
|
+
"name": "titleTagName",
|
6862
6882
|
"type": {
|
6863
|
-
"text": "
|
6883
|
+
"text": "TagNameType"
|
6864
6884
|
},
|
6865
|
-
"description": "The
|
6866
|
-
"default": "'
|
6867
|
-
"attribute": "
|
6885
|
+
"description": "The tag name for the card title. It supports all the types that `msc-text` supports",
|
6886
|
+
"default": "'span'",
|
6887
|
+
"attribute": "title-tag-name",
|
6868
6888
|
"reflects": true,
|
6869
6889
|
"inheritedFrom": {
|
6870
|
-
"name": "
|
6871
|
-
"module": "components/
|
6890
|
+
"name": "Card",
|
6891
|
+
"module": "components/card/card.component.js"
|
6872
6892
|
}
|
6873
6893
|
},
|
6874
6894
|
{
|
6875
6895
|
"kind": "field",
|
6876
|
-
"name": "
|
6896
|
+
"name": "subtitleTagName",
|
6877
6897
|
"type": {
|
6878
|
-
"text": "
|
6898
|
+
"text": "TagNameType"
|
6879
6899
|
},
|
6880
|
-
"description": "
|
6881
|
-
"
|
6900
|
+
"description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
|
6901
|
+
"default": "'span'",
|
6902
|
+
"attribute": "subtitle-tag-name",
|
6882
6903
|
"reflects": true,
|
6883
6904
|
"inheritedFrom": {
|
6884
|
-
"name": "
|
6885
|
-
"module": "components/
|
6905
|
+
"name": "Card",
|
6906
|
+
"module": "components/card/card.component.js"
|
6886
6907
|
}
|
6887
6908
|
},
|
6888
6909
|
{
|
6889
|
-
"kind": "
|
6890
|
-
"name": "
|
6891
|
-
"
|
6892
|
-
|
6893
|
-
"return": {
|
6894
|
-
"type": {
|
6895
|
-
"text": ""
|
6896
|
-
}
|
6910
|
+
"kind": "field",
|
6911
|
+
"name": "iconName",
|
6912
|
+
"type": {
|
6913
|
+
"text": "IconNames | undefined"
|
6897
6914
|
},
|
6915
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
6916
|
+
"attribute": "icon-name",
|
6917
|
+
"reflects": true,
|
6898
6918
|
"inheritedFrom": {
|
6899
|
-
"name": "
|
6900
|
-
"module": "components/
|
6919
|
+
"name": "Card",
|
6920
|
+
"module": "components/card/card.component.js"
|
6901
6921
|
}
|
6902
6922
|
},
|
6903
6923
|
{
|
6904
6924
|
"kind": "method",
|
6905
|
-
"name": "
|
6925
|
+
"name": "renderImage",
|
6906
6926
|
"privacy": "protected",
|
6907
|
-
"description": "
|
6927
|
+
"description": "Renders the image on the card if image source is provided",
|
6908
6928
|
"return": {
|
6909
6929
|
"type": {
|
6910
6930
|
"text": ""
|
6911
6931
|
}
|
6912
6932
|
},
|
6913
6933
|
"inheritedFrom": {
|
6914
|
-
"name": "
|
6915
|
-
"module": "components/
|
6934
|
+
"name": "Card",
|
6935
|
+
"module": "components/card/card.component.js"
|
6916
6936
|
}
|
6917
6937
|
},
|
6918
6938
|
{
|
6919
6939
|
"kind": "method",
|
6920
|
-
"name": "
|
6940
|
+
"name": "renderIcon",
|
6921
6941
|
"privacy": "protected",
|
6922
|
-
"description": "
|
6942
|
+
"description": "Renders the icon on the card if icon name is provided",
|
6923
6943
|
"return": {
|
6924
6944
|
"type": {
|
6925
6945
|
"text": ""
|
6926
6946
|
}
|
6927
6947
|
},
|
6928
6948
|
"inheritedFrom": {
|
6929
|
-
"name": "
|
6930
|
-
"module": "components/
|
6949
|
+
"name": "Card",
|
6950
|
+
"module": "components/card/card.component.js"
|
6931
6951
|
}
|
6932
6952
|
},
|
6933
6953
|
{
|
6934
6954
|
"kind": "method",
|
6935
|
-
"name": "
|
6955
|
+
"name": "renderTitle",
|
6936
6956
|
"privacy": "protected",
|
6937
|
-
"description": "
|
6957
|
+
"description": "Renders the title and subtitle on the card",
|
6938
6958
|
"return": {
|
6939
6959
|
"type": {
|
6940
6960
|
"text": ""
|
6941
6961
|
}
|
6942
6962
|
},
|
6943
6963
|
"inheritedFrom": {
|
6944
|
-
"name": "
|
6945
|
-
"module": "components/
|
6964
|
+
"name": "Card",
|
6965
|
+
"module": "components/card/card.component.js"
|
6946
6966
|
}
|
6947
6967
|
},
|
6948
6968
|
{
|
6949
6969
|
"kind": "method",
|
6950
|
-
"name": "
|
6970
|
+
"name": "renderFooter",
|
6951
6971
|
"privacy": "protected",
|
6952
|
-
"description": "
|
6972
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
6953
6973
|
"return": {
|
6954
6974
|
"type": {
|
6955
6975
|
"text": ""
|
6956
6976
|
}
|
6957
6977
|
},
|
6958
6978
|
"inheritedFrom": {
|
6959
|
-
"name": "
|
6960
|
-
"module": "components/
|
6979
|
+
"name": "Card",
|
6980
|
+
"module": "components/card/card.component.js"
|
6961
6981
|
}
|
6962
6982
|
}
|
6963
6983
|
],
|
6964
6984
|
"events": [
|
6965
6985
|
{
|
6966
|
-
"
|
6967
|
-
|
6968
|
-
|
6986
|
+
"description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
|
6987
|
+
"name": "click",
|
6988
|
+
"reactName": "onClick"
|
6969
6989
|
},
|
6970
6990
|
{
|
6971
|
-
"description": "(React:
|
6991
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
|
6992
|
+
"name": "keydown",
|
6993
|
+
"reactName": "onKeyDown"
|
6994
|
+
},
|
6995
|
+
{
|
6996
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
|
6997
|
+
"name": "keyup",
|
6998
|
+
"reactName": "onKeyUp"
|
6999
|
+
},
|
7000
|
+
{
|
7001
|
+
"description": "(React: onChange) Event that gets dispatched when the card state changes.",
|
6972
7002
|
"name": "change",
|
6973
7003
|
"reactName": "onChange"
|
6974
7004
|
},
|
6975
7005
|
{
|
6976
|
-
"description": "(React: onFocus) Event that gets dispatched when the
|
7006
|
+
"description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
|
6977
7007
|
"name": "focus",
|
6978
7008
|
"reactName": "onFocus"
|
6979
7009
|
}
|
@@ -6985,207 +7015,177 @@
|
|
6985
7015
|
"text": "boolean"
|
6986
7016
|
},
|
6987
7017
|
"default": "false",
|
6988
|
-
"description": "
|
7018
|
+
"description": "The checked state of the card",
|
6989
7019
|
"fieldName": "checked"
|
6990
7020
|
},
|
6991
|
-
{
|
6992
|
-
"name": "indeterminate",
|
6993
|
-
"type": {
|
6994
|
-
"text": "boolean"
|
6995
|
-
},
|
6996
|
-
"default": "false",
|
6997
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
6998
|
-
"fieldName": "indeterminate"
|
6999
|
-
},
|
7000
|
-
{
|
7001
|
-
"name": "autofocus",
|
7002
|
-
"type": {
|
7003
|
-
"text": "boolean"
|
7004
|
-
},
|
7005
|
-
"default": "false",
|
7006
|
-
"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)",
|
7007
|
-
"fieldName": "autofocus"
|
7008
|
-
},
|
7009
7021
|
{
|
7010
7022
|
"name": "name",
|
7011
7023
|
"type": {
|
7012
7024
|
"text": "string"
|
7013
7025
|
},
|
7014
7026
|
"default": "''",
|
7015
|
-
"description": "
|
7016
|
-
"fieldName": "name"
|
7017
|
-
"inheritedFrom": {
|
7018
|
-
"name": "FormInternalsMixin",
|
7019
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7020
|
-
}
|
7021
|
-
},
|
7022
|
-
{
|
7023
|
-
"name": "value",
|
7024
|
-
"type": {
|
7025
|
-
"text": "string"
|
7026
|
-
},
|
7027
|
-
"default": "''",
|
7028
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7029
|
-
"fieldName": "value",
|
7030
|
-
"inheritedFrom": {
|
7031
|
-
"name": "FormInternalsMixin",
|
7032
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7033
|
-
}
|
7027
|
+
"description": "The name of the radio.",
|
7028
|
+
"fieldName": "name"
|
7034
7029
|
},
|
7035
7030
|
{
|
7036
|
-
"name": "
|
7031
|
+
"name": "disabled",
|
7037
7032
|
"type": {
|
7038
|
-
"text": "
|
7033
|
+
"text": "boolean | undefined"
|
7039
7034
|
},
|
7040
|
-
"description": "
|
7041
|
-
"
|
7035
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7036
|
+
"default": "undefined",
|
7037
|
+
"fieldName": "disabled",
|
7042
7038
|
"inheritedFrom": {
|
7043
|
-
"name": "
|
7044
|
-
"module": "src/utils/mixins/
|
7039
|
+
"name": "DisabledMixin",
|
7040
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
7045
7041
|
}
|
7046
7042
|
},
|
7047
7043
|
{
|
7048
|
-
"name": "
|
7044
|
+
"name": "tabIndex",
|
7049
7045
|
"type": {
|
7050
|
-
"text": "
|
7046
|
+
"text": "number"
|
7051
7047
|
},
|
7052
|
-
"default": "
|
7053
|
-
"description": "
|
7054
|
-
"fieldName": "
|
7048
|
+
"default": "0",
|
7049
|
+
"description": "This property specifies the tab order of the element.",
|
7050
|
+
"fieldName": "tabIndex",
|
7055
7051
|
"inheritedFrom": {
|
7056
|
-
"name": "
|
7057
|
-
"module": "src/utils/mixins/
|
7052
|
+
"name": "TabIndexMixin",
|
7053
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
7058
7054
|
}
|
7059
7055
|
},
|
7060
7056
|
{
|
7061
|
-
"name": "
|
7057
|
+
"name": "card-title",
|
7062
7058
|
"type": {
|
7063
|
-
"text": "
|
7059
|
+
"text": "string"
|
7064
7060
|
},
|
7065
|
-
"
|
7066
|
-
"
|
7067
|
-
"fieldName": "
|
7061
|
+
"default": "''",
|
7062
|
+
"description": "The title of the card - part of header section",
|
7063
|
+
"fieldName": "cardTitle",
|
7068
7064
|
"inheritedFrom": {
|
7069
|
-
"name": "
|
7070
|
-
"module": "src/
|
7065
|
+
"name": "Card",
|
7066
|
+
"module": "src/components/card/card.component.ts"
|
7071
7067
|
}
|
7072
7068
|
},
|
7073
7069
|
{
|
7074
|
-
"name": "
|
7070
|
+
"name": "subtitle",
|
7075
7071
|
"type": {
|
7076
|
-
"text": "string
|
7072
|
+
"text": "string"
|
7077
7073
|
},
|
7078
|
-
"
|
7079
|
-
"
|
7074
|
+
"default": "''",
|
7075
|
+
"description": "The subtitle of the card - part of header section",
|
7076
|
+
"fieldName": "subtitle",
|
7080
7077
|
"inheritedFrom": {
|
7081
|
-
"name": "
|
7082
|
-
"module": "src/components/
|
7078
|
+
"name": "Card",
|
7079
|
+
"module": "src/components/card/card.component.ts"
|
7083
7080
|
}
|
7084
7081
|
},
|
7085
7082
|
{
|
7086
|
-
"name": "
|
7083
|
+
"name": "image-src",
|
7087
7084
|
"type": {
|
7088
|
-
"text": "
|
7085
|
+
"text": "string"
|
7089
7086
|
},
|
7090
|
-
"default": "
|
7091
|
-
"description": "The
|
7092
|
-
"fieldName": "
|
7087
|
+
"default": "''",
|
7088
|
+
"description": "The image source URL to render on the card",
|
7089
|
+
"fieldName": "imageSrc",
|
7093
7090
|
"inheritedFrom": {
|
7094
|
-
"name": "
|
7095
|
-
"module": "src/components/
|
7091
|
+
"name": "Card",
|
7092
|
+
"module": "src/components/card/card.component.ts"
|
7096
7093
|
}
|
7097
7094
|
},
|
7098
7095
|
{
|
7099
|
-
"name": "
|
7096
|
+
"name": "image-alt",
|
7100
7097
|
"type": {
|
7101
7098
|
"text": "string"
|
7102
7099
|
},
|
7103
7100
|
"default": "''",
|
7104
|
-
"description": "The
|
7105
|
-
"fieldName": "
|
7101
|
+
"description": "The image alt for accessibility support",
|
7102
|
+
"fieldName": "imageAlt",
|
7106
7103
|
"inheritedFrom": {
|
7107
|
-
"name": "
|
7108
|
-
"module": "src/components/
|
7104
|
+
"name": "Card",
|
7105
|
+
"module": "src/components/card/card.component.ts"
|
7109
7106
|
}
|
7110
7107
|
},
|
7111
7108
|
{
|
7112
|
-
"name": "
|
7109
|
+
"name": "variant",
|
7113
7110
|
"type": {
|
7114
|
-
"text": "
|
7111
|
+
"text": "CardVariant"
|
7115
7112
|
},
|
7116
|
-
"description": "The
|
7117
|
-
"
|
7113
|
+
"description": "The variant of the card. It can either be set to 'border' or 'ghost'",
|
7114
|
+
"default": "'border'",
|
7115
|
+
"fieldName": "variant",
|
7118
7116
|
"inheritedFrom": {
|
7119
|
-
"name": "
|
7120
|
-
"module": "src/components/
|
7117
|
+
"name": "Card",
|
7118
|
+
"module": "src/components/card/card.component.ts"
|
7121
7119
|
}
|
7122
7120
|
},
|
7123
7121
|
{
|
7124
|
-
"name": "
|
7122
|
+
"name": "orientation",
|
7125
7123
|
"type": {
|
7126
|
-
"text": "
|
7124
|
+
"text": "CardOrientation"
|
7127
7125
|
},
|
7128
|
-
"description": "The
|
7129
|
-
"
|
7126
|
+
"description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
|
7127
|
+
"default": "'vertical'",
|
7128
|
+
"fieldName": "orientation",
|
7130
7129
|
"inheritedFrom": {
|
7131
|
-
"name": "
|
7132
|
-
"module": "src/components/
|
7130
|
+
"name": "Card",
|
7131
|
+
"module": "src/components/card/card.component.ts"
|
7133
7132
|
}
|
7134
7133
|
},
|
7135
7134
|
{
|
7136
|
-
"name": "
|
7135
|
+
"name": "title-tag-name",
|
7137
7136
|
"type": {
|
7138
|
-
"text": "
|
7137
|
+
"text": "TagNameType"
|
7139
7138
|
},
|
7140
|
-
"description": "The
|
7141
|
-
"
|
7139
|
+
"description": "The tag name for the card title. It supports all the types that `msc-text` supports",
|
7140
|
+
"default": "'span'",
|
7141
|
+
"fieldName": "titleTagName",
|
7142
7142
|
"inheritedFrom": {
|
7143
|
-
"name": "
|
7144
|
-
"module": "src/components/
|
7143
|
+
"name": "Card",
|
7144
|
+
"module": "src/components/card/card.component.ts"
|
7145
7145
|
}
|
7146
7146
|
},
|
7147
7147
|
{
|
7148
|
-
"name": "
|
7148
|
+
"name": "subtitle-tag-name",
|
7149
7149
|
"type": {
|
7150
|
-
"text": "
|
7150
|
+
"text": "TagNameType"
|
7151
7151
|
},
|
7152
|
-
"description": "The
|
7153
|
-
"default": "'
|
7154
|
-
"fieldName": "
|
7152
|
+
"description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
|
7153
|
+
"default": "'span'",
|
7154
|
+
"fieldName": "subtitleTagName",
|
7155
7155
|
"inheritedFrom": {
|
7156
|
-
"name": "
|
7157
|
-
"module": "src/components/
|
7156
|
+
"name": "Card",
|
7157
|
+
"module": "src/components/card/card.component.ts"
|
7158
7158
|
}
|
7159
7159
|
},
|
7160
7160
|
{
|
7161
|
-
"name": "
|
7161
|
+
"name": "icon-name",
|
7162
7162
|
"type": {
|
7163
|
-
"text": "
|
7163
|
+
"text": "IconNames | undefined"
|
7164
7164
|
},
|
7165
|
-
"description": "
|
7166
|
-
"fieldName": "
|
7165
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
7166
|
+
"fieldName": "iconName",
|
7167
7167
|
"inheritedFrom": {
|
7168
|
-
"name": "
|
7169
|
-
"module": "src/components/
|
7168
|
+
"name": "Card",
|
7169
|
+
"module": "src/components/card/card.component.ts"
|
7170
7170
|
}
|
7171
7171
|
}
|
7172
7172
|
],
|
7173
7173
|
"mixins": [
|
7174
7174
|
{
|
7175
|
-
"name": "
|
7176
|
-
"module": "/src/utils/mixins/
|
7175
|
+
"name": "DisabledMixin",
|
7176
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
7177
7177
|
},
|
7178
7178
|
{
|
7179
|
-
"name": "
|
7180
|
-
"module": "/src/utils/mixins/
|
7179
|
+
"name": "TabIndexMixin",
|
7180
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
7181
7181
|
}
|
7182
7182
|
],
|
7183
7183
|
"superclass": {
|
7184
|
-
"name": "
|
7185
|
-
"module": "/src/components/
|
7184
|
+
"name": "Card",
|
7185
|
+
"module": "/src/components/card/card.component"
|
7186
7186
|
},
|
7187
|
-
"tagName": "mdc-
|
7188
|
-
"jsDoc": "/**\n *
|
7187
|
+
"tagName": "mdc-cardradio",
|
7188
|
+
"jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
|
7189
7189
|
"customElement": true
|
7190
7190
|
}
|
7191
7191
|
],
|
@@ -7194,8 +7194,8 @@
|
|
7194
7194
|
"kind": "js",
|
7195
7195
|
"name": "default",
|
7196
7196
|
"declaration": {
|
7197
|
-
"name": "
|
7198
|
-
"module": "components/
|
7197
|
+
"name": "CardRadio",
|
7198
|
+
"module": "components/cardradio/cardradio.component.js"
|
7199
7199
|
}
|
7200
7200
|
}
|
7201
7201
|
]
|
@@ -8906,7 +8906,7 @@
|
|
8906
8906
|
{
|
8907
8907
|
"kind": "method",
|
8908
8908
|
"name": "isOpenUpdated",
|
8909
|
-
"privacy": "
|
8909
|
+
"privacy": "protected",
|
8910
8910
|
"parameters": [
|
8911
8911
|
{
|
8912
8912
|
"name": "oldValue",
|
@@ -9019,6 +9019,30 @@
|
|
9019
9019
|
"module": "components/popover/popover.component.js"
|
9020
9020
|
}
|
9021
9021
|
},
|
9022
|
+
{
|
9023
|
+
"kind": "method",
|
9024
|
+
"name": "findClosestPopover",
|
9025
|
+
"privacy": "protected",
|
9026
|
+
"return": {
|
9027
|
+
"type": {
|
9028
|
+
"text": "Popover | null"
|
9029
|
+
}
|
9030
|
+
},
|
9031
|
+
"parameters": [
|
9032
|
+
{
|
9033
|
+
"name": "element",
|
9034
|
+
"type": {
|
9035
|
+
"text": "Element"
|
9036
|
+
},
|
9037
|
+
"description": "The element to start searching from."
|
9038
|
+
}
|
9039
|
+
],
|
9040
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
9041
|
+
"inheritedFrom": {
|
9042
|
+
"name": "Popover",
|
9043
|
+
"module": "components/popover/popover.component.js"
|
9044
|
+
}
|
9045
|
+
},
|
9022
9046
|
{
|
9023
9047
|
"kind": "field",
|
9024
9048
|
"name": "utils",
|
@@ -18153,6 +18177,35 @@
|
|
18153
18177
|
"module": "components/popover/popover.component.js"
|
18154
18178
|
}
|
18155
18179
|
},
|
18180
|
+
{
|
18181
|
+
"kind": "method",
|
18182
|
+
"name": "isOpenUpdated",
|
18183
|
+
"privacy": "protected",
|
18184
|
+
"parameters": [
|
18185
|
+
{
|
18186
|
+
"name": "oldValue",
|
18187
|
+
"type": {
|
18188
|
+
"text": "boolean"
|
18189
|
+
}
|
18190
|
+
},
|
18191
|
+
{
|
18192
|
+
"name": "newValue",
|
18193
|
+
"type": {
|
18194
|
+
"text": "boolean"
|
18195
|
+
}
|
18196
|
+
}
|
18197
|
+
],
|
18198
|
+
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
18199
|
+
"return": {
|
18200
|
+
"type": {
|
18201
|
+
"text": "Promise<void>"
|
18202
|
+
}
|
18203
|
+
},
|
18204
|
+
"inheritedFrom": {
|
18205
|
+
"name": "Popover",
|
18206
|
+
"module": "components/popover/popover.component.js"
|
18207
|
+
}
|
18208
|
+
},
|
18156
18209
|
{
|
18157
18210
|
"kind": "method",
|
18158
18211
|
"name": "getCurrentIndex",
|
@@ -19348,32 +19401,6 @@
|
|
19348
19401
|
"module": "components/popover/popover.component.js"
|
19349
19402
|
}
|
19350
19403
|
},
|
19351
|
-
{
|
19352
|
-
"kind": "method",
|
19353
|
-
"name": "isOpenUpdated",
|
19354
|
-
"privacy": "private",
|
19355
|
-
"parameters": [
|
19356
|
-
{
|
19357
|
-
"name": "oldValue",
|
19358
|
-
"type": {
|
19359
|
-
"text": "boolean"
|
19360
|
-
},
|
19361
|
-
"description": "The old value of the visible property."
|
19362
|
-
},
|
19363
|
-
{
|
19364
|
-
"name": "newValue",
|
19365
|
-
"type": {
|
19366
|
-
"text": "boolean"
|
19367
|
-
},
|
19368
|
-
"description": "The new value of the visible property."
|
19369
|
-
}
|
19370
|
-
],
|
19371
|
-
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
19372
|
-
"inheritedFrom": {
|
19373
|
-
"name": "Popover",
|
19374
|
-
"module": "components/popover/popover.component.js"
|
19375
|
-
}
|
19376
|
-
},
|
19377
19404
|
{
|
19378
19405
|
"kind": "field",
|
19379
19406
|
"name": "handleMouseEnter",
|
@@ -19454,6 +19481,30 @@
|
|
19454
19481
|
"module": "components/popover/popover.component.js"
|
19455
19482
|
}
|
19456
19483
|
},
|
19484
|
+
{
|
19485
|
+
"kind": "method",
|
19486
|
+
"name": "findClosestPopover",
|
19487
|
+
"privacy": "protected",
|
19488
|
+
"return": {
|
19489
|
+
"type": {
|
19490
|
+
"text": "Popover | null"
|
19491
|
+
}
|
19492
|
+
},
|
19493
|
+
"parameters": [
|
19494
|
+
{
|
19495
|
+
"name": "element",
|
19496
|
+
"type": {
|
19497
|
+
"text": "Element"
|
19498
|
+
},
|
19499
|
+
"description": "The element to start searching from."
|
19500
|
+
}
|
19501
|
+
],
|
19502
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
19503
|
+
"inheritedFrom": {
|
19504
|
+
"name": "Popover",
|
19505
|
+
"module": "components/popover/popover.component.js"
|
19506
|
+
}
|
19507
|
+
},
|
19457
19508
|
{
|
19458
19509
|
"kind": "field",
|
19459
19510
|
"name": "utils",
|
@@ -24371,7 +24422,7 @@
|
|
24371
24422
|
{
|
24372
24423
|
"kind": "method",
|
24373
24424
|
"name": "isOpenUpdated",
|
24374
|
-
"privacy": "
|
24425
|
+
"privacy": "protected",
|
24375
24426
|
"parameters": [
|
24376
24427
|
{
|
24377
24428
|
"name": "oldValue",
|
@@ -24444,6 +24495,26 @@
|
|
24444
24495
|
"privacy": "private",
|
24445
24496
|
"description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position."
|
24446
24497
|
},
|
24498
|
+
{
|
24499
|
+
"kind": "method",
|
24500
|
+
"name": "findClosestPopover",
|
24501
|
+
"privacy": "protected",
|
24502
|
+
"return": {
|
24503
|
+
"type": {
|
24504
|
+
"text": "Popover | null"
|
24505
|
+
}
|
24506
|
+
},
|
24507
|
+
"parameters": [
|
24508
|
+
{
|
24509
|
+
"name": "element",
|
24510
|
+
"type": {
|
24511
|
+
"text": "Element"
|
24512
|
+
},
|
24513
|
+
"description": "The element to start searching from."
|
24514
|
+
}
|
24515
|
+
],
|
24516
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario."
|
24517
|
+
},
|
24447
24518
|
{
|
24448
24519
|
"kind": "field",
|
24449
24520
|
"name": "utils",
|
@@ -25464,59 +25535,165 @@
|
|
25464
25535
|
},
|
25465
25536
|
{
|
25466
25537
|
"kind": "javascript-module",
|
25467
|
-
"path": "components/
|
25538
|
+
"path": "components/progressspinner/progressspinner.component.js",
|
25468
25539
|
"declarations": [
|
25469
25540
|
{
|
25470
25541
|
"kind": "class",
|
25471
|
-
"description": "mdc-
|
25472
|
-
"name": "
|
25542
|
+
"description": "`mdc-progressspinner` is a customizable, circular progress indicator component.\nIt visually represents the current completion state of a process, such as loading,\nsyncing, uploading, or any ongoing task that has a measurable percentage.\n\nThe spinner is built using SVG with two concentric `<circle>` elements:\n- The `progress` arc represents the portion of work completed.\n- The `track` arc represents the remaining part.\n\nA visual gap is maintained between the progress and track arcs to clearly\ndistinguish the two segments. The component smoothly animates arc length\nand respects accessibility best practices with ARIA attributes.\n\nThe component supports different states:\n- **Default**: Circular spinner shows the progress.\n- **Success**: Displays a checkmark icon when progress reaches 100%.\n- **Error**: Displays an error icon when in an error state.",
|
25543
|
+
"name": "Progressspinner",
|
25473
25544
|
"cssProperties": [
|
25545
|
+
{
|
25546
|
+
"description": "The size of the spinner.",
|
25547
|
+
"name": "--mdc-spinner-size"
|
25548
|
+
},
|
25549
|
+
{
|
25550
|
+
"description": "The color of the spinner track.",
|
25551
|
+
"name": "--mdc-track-color"
|
25552
|
+
},
|
25553
|
+
{
|
25554
|
+
"description": "The color of the spinner progress.",
|
25555
|
+
"name": "--mdc-progress-color"
|
25556
|
+
},
|
25557
|
+
{
|
25558
|
+
"description": "The color of the spinner when in success state.",
|
25559
|
+
"name": "--mdc-progress-success-color"
|
25560
|
+
},
|
25561
|
+
{
|
25562
|
+
"description": "The color of the spinner when in error state.",
|
25563
|
+
"name": "--mdc-progress-error-color"
|
25564
|
+
},
|
25474
25565
|
{
|
25475
25566
|
"description": "Background color of the progressbar when inactive.",
|
25476
|
-
"name": "--mdc-progressbar-default-background-color"
|
25567
|
+
"name": "--mdc-progressbar-default-background-color",
|
25568
|
+
"inheritedFrom": {
|
25569
|
+
"name": "Progressbar",
|
25570
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25571
|
+
}
|
25477
25572
|
},
|
25478
25573
|
{
|
25479
25574
|
"description": "Background color of the progressbar when active.",
|
25480
|
-
"name": "--mdc-progressbar-default-active-background-color"
|
25575
|
+
"name": "--mdc-progressbar-default-active-background-color",
|
25576
|
+
"inheritedFrom": {
|
25577
|
+
"name": "Progressbar",
|
25578
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25579
|
+
}
|
25481
25580
|
},
|
25482
25581
|
{
|
25483
25582
|
"description": "Background color of the progressbar when in success state.",
|
25484
|
-
"name": "--mdc-progressbar-success-background-color"
|
25583
|
+
"name": "--mdc-progressbar-success-background-color",
|
25584
|
+
"inheritedFrom": {
|
25585
|
+
"name": "Progressbar",
|
25586
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25587
|
+
}
|
25485
25588
|
},
|
25486
25589
|
{
|
25487
25590
|
"description": "Background color of the progressbar when in error state.",
|
25488
|
-
"name": "--mdc-progressbar-error-background-color"
|
25591
|
+
"name": "--mdc-progressbar-error-background-color",
|
25592
|
+
"inheritedFrom": {
|
25593
|
+
"name": "Progressbar",
|
25594
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25595
|
+
}
|
25489
25596
|
},
|
25490
25597
|
{
|
25491
25598
|
"description": "The height of the progressbar.",
|
25492
|
-
"name": "--mdc-progressbar-height"
|
25599
|
+
"name": "--mdc-progressbar-height",
|
25600
|
+
"inheritedFrom": {
|
25601
|
+
"name": "Progressbar",
|
25602
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25603
|
+
}
|
25493
25604
|
},
|
25494
25605
|
{
|
25495
25606
|
"description": "The border radius of the progressbar.",
|
25496
|
-
"name": "--mdc-progressbar-border-radius"
|
25607
|
+
"name": "--mdc-progressbar-border-radius",
|
25608
|
+
"inheritedFrom": {
|
25609
|
+
"name": "Progressbar",
|
25610
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25611
|
+
}
|
25497
25612
|
},
|
25498
25613
|
{
|
25499
25614
|
"description": "Color of the progressbar label text.",
|
25500
|
-
"name": "--mdc-progressbar-label-color"
|
25615
|
+
"name": "--mdc-progressbar-label-color",
|
25616
|
+
"inheritedFrom": {
|
25617
|
+
"name": "Progressbar",
|
25618
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25619
|
+
}
|
25501
25620
|
},
|
25502
25621
|
{
|
25503
25622
|
"description": "Line height of the label text.",
|
25504
|
-
"name": "--mdc-progressbar-label-lineheight"
|
25623
|
+
"name": "--mdc-progressbar-label-lineheight",
|
25624
|
+
"inheritedFrom": {
|
25625
|
+
"name": "Progressbar",
|
25626
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25627
|
+
}
|
25505
25628
|
},
|
25506
25629
|
{
|
25507
25630
|
"description": "Font size of the label text.",
|
25508
|
-
"name": "--mdc-progressbar-label-fontsize"
|
25631
|
+
"name": "--mdc-progressbar-label-fontsize",
|
25632
|
+
"inheritedFrom": {
|
25633
|
+
"name": "Progressbar",
|
25634
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25635
|
+
}
|
25509
25636
|
},
|
25510
25637
|
{
|
25511
25638
|
"description": "Font weight of the label text.",
|
25512
|
-
"name": "--mdc-progressbar-label-fontweight"
|
25639
|
+
"name": "--mdc-progressbar-label-fontweight",
|
25640
|
+
"inheritedFrom": {
|
25641
|
+
"name": "Progressbar",
|
25642
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25643
|
+
}
|
25513
25644
|
},
|
25514
25645
|
{
|
25515
25646
|
"description": "Color of the help text.",
|
25516
|
-
"name": "--mdc-progressbar-help-text-color"
|
25647
|
+
"name": "--mdc-progressbar-help-text-color",
|
25648
|
+
"inheritedFrom": {
|
25649
|
+
"name": "Progressbar",
|
25650
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25651
|
+
}
|
25517
25652
|
}
|
25518
25653
|
],
|
25519
25654
|
"members": [
|
25655
|
+
{
|
25656
|
+
"kind": "method",
|
25657
|
+
"name": "renderProgressSpinner",
|
25658
|
+
"privacy": "private"
|
25659
|
+
},
|
25660
|
+
{
|
25661
|
+
"kind": "method",
|
25662
|
+
"name": "renderErrorState",
|
25663
|
+
"privacy": "private",
|
25664
|
+
"description": "Renders the error state of the progress spinner.",
|
25665
|
+
"return": {
|
25666
|
+
"type": {
|
25667
|
+
"text": ""
|
25668
|
+
}
|
25669
|
+
}
|
25670
|
+
},
|
25671
|
+
{
|
25672
|
+
"kind": "method",
|
25673
|
+
"name": "renderSuccessState",
|
25674
|
+
"privacy": "private",
|
25675
|
+
"description": "Renders the success state of the progress spinner.",
|
25676
|
+
"return": {
|
25677
|
+
"type": {
|
25678
|
+
"text": ""
|
25679
|
+
}
|
25680
|
+
}
|
25681
|
+
},
|
25682
|
+
{
|
25683
|
+
"kind": "field",
|
25684
|
+
"name": "dataAriaLabel",
|
25685
|
+
"type": {
|
25686
|
+
"text": "string | null"
|
25687
|
+
},
|
25688
|
+
"default": "null",
|
25689
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
25690
|
+
"attribute": "data-aria-label",
|
25691
|
+
"reflects": true,
|
25692
|
+
"inheritedFrom": {
|
25693
|
+
"name": "DataAriaLabelMixin",
|
25694
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
25695
|
+
}
|
25696
|
+
},
|
25520
25697
|
{
|
25521
25698
|
"kind": "field",
|
25522
25699
|
"name": "variant",
|
@@ -25526,7 +25703,11 @@
|
|
25526
25703
|
"description": "Types of the progressbar\n- **Default**\n- **Inline**",
|
25527
25704
|
"default": "default",
|
25528
25705
|
"attribute": "variant",
|
25529
|
-
"reflects": true
|
25706
|
+
"reflects": true,
|
25707
|
+
"inheritedFrom": {
|
25708
|
+
"name": "Progressbar",
|
25709
|
+
"module": "components/progressbar/progressbar.component.js"
|
25710
|
+
}
|
25530
25711
|
},
|
25531
25712
|
{
|
25532
25713
|
"kind": "field",
|
@@ -25537,7 +25718,11 @@
|
|
25537
25718
|
"default": "'0'",
|
25538
25719
|
"description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
|
25539
25720
|
"attribute": "value",
|
25540
|
-
"reflects": true
|
25721
|
+
"reflects": true,
|
25722
|
+
"inheritedFrom": {
|
25723
|
+
"name": "Progressbar",
|
25724
|
+
"module": "components/progressbar/progressbar.component.js"
|
25725
|
+
}
|
25541
25726
|
},
|
25542
25727
|
{
|
25543
25728
|
"kind": "field",
|
@@ -25547,7 +25732,11 @@
|
|
25547
25732
|
},
|
25548
25733
|
"default": "false",
|
25549
25734
|
"description": "Define error state of the progressbar\n- **true**\n- **false**",
|
25550
|
-
"attribute": "error"
|
25735
|
+
"attribute": "error",
|
25736
|
+
"inheritedFrom": {
|
25737
|
+
"name": "Progressbar",
|
25738
|
+
"module": "components/progressbar/progressbar.component.js"
|
25739
|
+
}
|
25551
25740
|
},
|
25552
25741
|
{
|
25553
25742
|
"kind": "method",
|
@@ -25558,21 +25747,10 @@
|
|
25558
25747
|
"type": {
|
25559
25748
|
"text": ""
|
25560
25749
|
}
|
25561
|
-
}
|
25562
|
-
},
|
25563
|
-
{
|
25564
|
-
"kind": "field",
|
25565
|
-
"name": "dataAriaLabel",
|
25566
|
-
"type": {
|
25567
|
-
"text": "string | null"
|
25568
25750
|
},
|
25569
|
-
"default": "null",
|
25570
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
25571
|
-
"attribute": "data-aria-label",
|
25572
|
-
"reflects": true,
|
25573
25751
|
"inheritedFrom": {
|
25574
|
-
"name": "
|
25575
|
-
"module": "
|
25752
|
+
"name": "Progressbar",
|
25753
|
+
"module": "components/progressbar/progressbar.component.js"
|
25576
25754
|
}
|
25577
25755
|
},
|
25578
25756
|
{
|
@@ -25780,7 +25958,27 @@
|
|
25780
25958
|
}
|
25781
25959
|
}
|
25782
25960
|
],
|
25961
|
+
"superclass": {
|
25962
|
+
"name": "Progressbar",
|
25963
|
+
"module": "/src/components/progressbar/progressbar.component"
|
25964
|
+
},
|
25965
|
+
"tagName": "mdc-progressspinner",
|
25966
|
+
"jsDoc": "/**\n * `mdc-progressspinner` is a customizable, circular progress indicator component.\n * It visually represents the current completion state of a process, such as loading,\n * syncing, uploading, or any ongoing task that has a measurable percentage.\n *\n * The spinner is built using SVG with two concentric `<circle>` elements:\n * - The `progress` arc represents the portion of work completed.\n * - The `track` arc represents the remaining part.\n *\n * A visual gap is maintained between the progress and track arcs to clearly\n * distinguish the two segments. The component smoothly animates arc length\n * and respects accessibility best practices with ARIA attributes.\n *\n * The component supports different states:\n * - **Default**: Circular spinner shows the progress.\n * - **Success**: Displays a checkmark icon when progress reaches 100%.\n * - **Error**: Displays an error icon when in an error state.\n *\n * @tagname mdc-progressspinner\n *\n * @cssproperty --mdc-spinner-size - The size of the spinner.\n * @cssproperty --mdc-track-color - The color of the spinner track.\n * @cssproperty --mdc-progress-color - The color of the spinner progress.\n * @cssproperty --mdc-progress-success-color - The color of the spinner when in success state.\n * @cssproperty --mdc-progress-error-color - The color of the spinner when in error state.\n *\n */",
|
25967
|
+
"customElement": true,
|
25783
25968
|
"attributes": [
|
25969
|
+
{
|
25970
|
+
"name": "data-aria-label",
|
25971
|
+
"type": {
|
25972
|
+
"text": "string | null"
|
25973
|
+
},
|
25974
|
+
"default": "null",
|
25975
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
25976
|
+
"fieldName": "dataAriaLabel",
|
25977
|
+
"inheritedFrom": {
|
25978
|
+
"name": "DataAriaLabelMixin",
|
25979
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
25980
|
+
}
|
25981
|
+
},
|
25784
25982
|
{
|
25785
25983
|
"name": "variant",
|
25786
25984
|
"type": {
|
@@ -25788,7 +25986,11 @@
|
|
25788
25986
|
},
|
25789
25987
|
"description": "Types of the progressbar\n- **Default**\n- **Inline**",
|
25790
25988
|
"default": "default",
|
25791
|
-
"fieldName": "variant"
|
25989
|
+
"fieldName": "variant",
|
25990
|
+
"inheritedFrom": {
|
25991
|
+
"name": "Progressbar",
|
25992
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25993
|
+
}
|
25792
25994
|
},
|
25793
25995
|
{
|
25794
25996
|
"name": "value",
|
@@ -25797,7 +25999,11 @@
|
|
25797
25999
|
},
|
25798
26000
|
"default": "'0'",
|
25799
26001
|
"description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
|
25800
|
-
"fieldName": "value"
|
26002
|
+
"fieldName": "value",
|
26003
|
+
"inheritedFrom": {
|
26004
|
+
"name": "Progressbar",
|
26005
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
26006
|
+
}
|
25801
26007
|
},
|
25802
26008
|
{
|
25803
26009
|
"name": "error",
|
@@ -25806,19 +26012,10 @@
|
|
25806
26012
|
},
|
25807
26013
|
"default": "false",
|
25808
26014
|
"description": "Define error state of the progressbar\n- **true**\n- **false**",
|
25809
|
-
"fieldName": "error"
|
25810
|
-
},
|
25811
|
-
{
|
25812
|
-
"name": "data-aria-label",
|
25813
|
-
"type": {
|
25814
|
-
"text": "string | null"
|
25815
|
-
},
|
25816
|
-
"default": "null",
|
25817
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
25818
|
-
"fieldName": "dataAriaLabel",
|
26015
|
+
"fieldName": "error",
|
25819
26016
|
"inheritedFrom": {
|
25820
|
-
"name": "
|
25821
|
-
"module": "src/
|
26017
|
+
"name": "Progressbar",
|
26018
|
+
"module": "src/components/progressbar/progressbar.component.ts"
|
25822
26019
|
}
|
25823
26020
|
},
|
25824
26021
|
{
|
@@ -25933,20 +26130,7 @@
|
|
25933
26130
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
25934
26131
|
}
|
25935
26132
|
}
|
25936
|
-
]
|
25937
|
-
"mixins": [
|
25938
|
-
{
|
25939
|
-
"name": "DataAriaLabelMixin",
|
25940
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
25941
|
-
}
|
25942
|
-
],
|
25943
|
-
"superclass": {
|
25944
|
-
"name": "FormfieldWrapper",
|
25945
|
-
"module": "/src/components/formfieldwrapper"
|
25946
|
-
},
|
25947
|
-
"tagName": "mdc-progressbar",
|
25948
|
-
"jsDoc": "/**\n * mdc-progressbar component visually represents a progress indicator, typically used to show\n * the completion state of an ongoing process (e.g., loading, file upload, etc.).\n * It contains an optional label and an optional helper text.\n *\n * - It supports mainly two types: Default and Inline\n * - It supports three validation variants: Default, Success and Error.\n *\n * This component is created by extending FormfieldWrapper.\n *\n * @tagname mdc-progressbar\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-progressbar-default-background-color - Background color of the progressbar when inactive.\n * @cssproperty --mdc-progressbar-default-active-background-color - Background color of the progressbar when active.\n * @cssproperty --mdc-progressbar-success-background-color - Background color of the progressbar when in success state.\n * @cssproperty --mdc-progressbar-error-background-color - Background color of the progressbar when in error state.\n * @cssproperty --mdc-progressbar-height - The height of the progressbar.\n * @cssproperty --mdc-progressbar-border-radius - The border radius of the progressbar.\n * @cssproperty --mdc-progressbar-label-color - Color of the progressbar label text.\n * @cssproperty --mdc-progressbar-label-lineheight - Line height of the label text.\n * @cssproperty --mdc-progressbar-label-fontsize - Font size of the label text.\n * @cssproperty --mdc-progressbar-label-fontweight - Font weight of the label text.\n * @cssproperty --mdc-progressbar-help-text-color - Color of the help text.\n */",
|
25949
|
-
"customElement": true
|
26133
|
+
]
|
25950
26134
|
}
|
25951
26135
|
],
|
25952
26136
|
"exports": [
|
@@ -25954,173 +26138,67 @@
|
|
25954
26138
|
"kind": "js",
|
25955
26139
|
"name": "default",
|
25956
26140
|
"declaration": {
|
25957
|
-
"name": "
|
25958
|
-
"module": "components/
|
26141
|
+
"name": "Progressspinner",
|
26142
|
+
"module": "components/progressspinner/progressspinner.component.js"
|
25959
26143
|
}
|
25960
26144
|
}
|
25961
26145
|
]
|
25962
26146
|
},
|
25963
26147
|
{
|
25964
26148
|
"kind": "javascript-module",
|
25965
|
-
"path": "components/
|
26149
|
+
"path": "components/progressbar/progressbar.component.js",
|
25966
26150
|
"declarations": [
|
25967
|
-
{
|
25968
|
-
"kind": "class",
|
25969
|
-
"description": "
|
25970
|
-
"name": "
|
25971
|
-
"cssProperties": [
|
25972
|
-
{
|
25973
|
-
"description": "The size of the spinner.",
|
25974
|
-
"name": "--mdc-spinner-size"
|
25975
|
-
},
|
25976
|
-
{
|
25977
|
-
"description": "The color of the spinner track.",
|
25978
|
-
"name": "--mdc-track-color"
|
25979
|
-
},
|
25980
|
-
{
|
25981
|
-
"description": "The color of the spinner progress.",
|
25982
|
-
"name": "--mdc-progress-color"
|
25983
|
-
},
|
25984
|
-
{
|
25985
|
-
"description": "The color of the spinner when in success state.",
|
25986
|
-
"name": "--mdc-progress-success-color"
|
25987
|
-
},
|
25988
|
-
{
|
25989
|
-
"description": "The color of the spinner when in error state.",
|
25990
|
-
"name": "--mdc-progress-error-color"
|
25991
|
-
},
|
26151
|
+
{
|
26152
|
+
"kind": "class",
|
26153
|
+
"description": "mdc-progressbar component visually represents a progress indicator, typically used to show\nthe completion state of an ongoing process (e.g., loading, file upload, etc.).\nIt contains an optional label and an optional helper text.\n\n- It supports mainly two types: Default and Inline\n- It supports three validation variants: Default, Success and Error.\n\nThis component is created by extending FormfieldWrapper.",
|
26154
|
+
"name": "Progressbar",
|
26155
|
+
"cssProperties": [
|
25992
26156
|
{
|
25993
26157
|
"description": "Background color of the progressbar when inactive.",
|
25994
|
-
"name": "--mdc-progressbar-default-background-color"
|
25995
|
-
"inheritedFrom": {
|
25996
|
-
"name": "Progressbar",
|
25997
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
25998
|
-
}
|
26158
|
+
"name": "--mdc-progressbar-default-background-color"
|
25999
26159
|
},
|
26000
26160
|
{
|
26001
26161
|
"description": "Background color of the progressbar when active.",
|
26002
|
-
"name": "--mdc-progressbar-default-active-background-color"
|
26003
|
-
"inheritedFrom": {
|
26004
|
-
"name": "Progressbar",
|
26005
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26006
|
-
}
|
26162
|
+
"name": "--mdc-progressbar-default-active-background-color"
|
26007
26163
|
},
|
26008
26164
|
{
|
26009
26165
|
"description": "Background color of the progressbar when in success state.",
|
26010
|
-
"name": "--mdc-progressbar-success-background-color"
|
26011
|
-
"inheritedFrom": {
|
26012
|
-
"name": "Progressbar",
|
26013
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26014
|
-
}
|
26166
|
+
"name": "--mdc-progressbar-success-background-color"
|
26015
26167
|
},
|
26016
26168
|
{
|
26017
26169
|
"description": "Background color of the progressbar when in error state.",
|
26018
|
-
"name": "--mdc-progressbar-error-background-color"
|
26019
|
-
"inheritedFrom": {
|
26020
|
-
"name": "Progressbar",
|
26021
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26022
|
-
}
|
26170
|
+
"name": "--mdc-progressbar-error-background-color"
|
26023
26171
|
},
|
26024
26172
|
{
|
26025
26173
|
"description": "The height of the progressbar.",
|
26026
|
-
"name": "--mdc-progressbar-height"
|
26027
|
-
"inheritedFrom": {
|
26028
|
-
"name": "Progressbar",
|
26029
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26030
|
-
}
|
26174
|
+
"name": "--mdc-progressbar-height"
|
26031
26175
|
},
|
26032
26176
|
{
|
26033
26177
|
"description": "The border radius of the progressbar.",
|
26034
|
-
"name": "--mdc-progressbar-border-radius"
|
26035
|
-
"inheritedFrom": {
|
26036
|
-
"name": "Progressbar",
|
26037
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26038
|
-
}
|
26178
|
+
"name": "--mdc-progressbar-border-radius"
|
26039
26179
|
},
|
26040
26180
|
{
|
26041
26181
|
"description": "Color of the progressbar label text.",
|
26042
|
-
"name": "--mdc-progressbar-label-color"
|
26043
|
-
"inheritedFrom": {
|
26044
|
-
"name": "Progressbar",
|
26045
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26046
|
-
}
|
26182
|
+
"name": "--mdc-progressbar-label-color"
|
26047
26183
|
},
|
26048
26184
|
{
|
26049
26185
|
"description": "Line height of the label text.",
|
26050
|
-
"name": "--mdc-progressbar-label-lineheight"
|
26051
|
-
"inheritedFrom": {
|
26052
|
-
"name": "Progressbar",
|
26053
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26054
|
-
}
|
26186
|
+
"name": "--mdc-progressbar-label-lineheight"
|
26055
26187
|
},
|
26056
26188
|
{
|
26057
26189
|
"description": "Font size of the label text.",
|
26058
|
-
"name": "--mdc-progressbar-label-fontsize"
|
26059
|
-
"inheritedFrom": {
|
26060
|
-
"name": "Progressbar",
|
26061
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26062
|
-
}
|
26190
|
+
"name": "--mdc-progressbar-label-fontsize"
|
26063
26191
|
},
|
26064
26192
|
{
|
26065
26193
|
"description": "Font weight of the label text.",
|
26066
|
-
"name": "--mdc-progressbar-label-fontweight"
|
26067
|
-
"inheritedFrom": {
|
26068
|
-
"name": "Progressbar",
|
26069
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26070
|
-
}
|
26194
|
+
"name": "--mdc-progressbar-label-fontweight"
|
26071
26195
|
},
|
26072
26196
|
{
|
26073
26197
|
"description": "Color of the help text.",
|
26074
|
-
"name": "--mdc-progressbar-help-text-color"
|
26075
|
-
"inheritedFrom": {
|
26076
|
-
"name": "Progressbar",
|
26077
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26078
|
-
}
|
26198
|
+
"name": "--mdc-progressbar-help-text-color"
|
26079
26199
|
}
|
26080
26200
|
],
|
26081
26201
|
"members": [
|
26082
|
-
{
|
26083
|
-
"kind": "method",
|
26084
|
-
"name": "renderProgressSpinner",
|
26085
|
-
"privacy": "private"
|
26086
|
-
},
|
26087
|
-
{
|
26088
|
-
"kind": "method",
|
26089
|
-
"name": "renderErrorState",
|
26090
|
-
"privacy": "private",
|
26091
|
-
"description": "Renders the error state of the progress spinner.",
|
26092
|
-
"return": {
|
26093
|
-
"type": {
|
26094
|
-
"text": ""
|
26095
|
-
}
|
26096
|
-
}
|
26097
|
-
},
|
26098
|
-
{
|
26099
|
-
"kind": "method",
|
26100
|
-
"name": "renderSuccessState",
|
26101
|
-
"privacy": "private",
|
26102
|
-
"description": "Renders the success state of the progress spinner.",
|
26103
|
-
"return": {
|
26104
|
-
"type": {
|
26105
|
-
"text": ""
|
26106
|
-
}
|
26107
|
-
}
|
26108
|
-
},
|
26109
|
-
{
|
26110
|
-
"kind": "field",
|
26111
|
-
"name": "dataAriaLabel",
|
26112
|
-
"type": {
|
26113
|
-
"text": "string | null"
|
26114
|
-
},
|
26115
|
-
"default": "null",
|
26116
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
26117
|
-
"attribute": "data-aria-label",
|
26118
|
-
"reflects": true,
|
26119
|
-
"inheritedFrom": {
|
26120
|
-
"name": "DataAriaLabelMixin",
|
26121
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
26122
|
-
}
|
26123
|
-
},
|
26124
26202
|
{
|
26125
26203
|
"kind": "field",
|
26126
26204
|
"name": "variant",
|
@@ -26130,11 +26208,7 @@
|
|
26130
26208
|
"description": "Types of the progressbar\n- **Default**\n- **Inline**",
|
26131
26209
|
"default": "default",
|
26132
26210
|
"attribute": "variant",
|
26133
|
-
"reflects": true
|
26134
|
-
"inheritedFrom": {
|
26135
|
-
"name": "Progressbar",
|
26136
|
-
"module": "components/progressbar/progressbar.component.js"
|
26137
|
-
}
|
26211
|
+
"reflects": true
|
26138
26212
|
},
|
26139
26213
|
{
|
26140
26214
|
"kind": "field",
|
@@ -26145,11 +26219,7 @@
|
|
26145
26219
|
"default": "'0'",
|
26146
26220
|
"description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
|
26147
26221
|
"attribute": "value",
|
26148
|
-
"reflects": true
|
26149
|
-
"inheritedFrom": {
|
26150
|
-
"name": "Progressbar",
|
26151
|
-
"module": "components/progressbar/progressbar.component.js"
|
26152
|
-
}
|
26222
|
+
"reflects": true
|
26153
26223
|
},
|
26154
26224
|
{
|
26155
26225
|
"kind": "field",
|
@@ -26159,11 +26229,7 @@
|
|
26159
26229
|
},
|
26160
26230
|
"default": "false",
|
26161
26231
|
"description": "Define error state of the progressbar\n- **true**\n- **false**",
|
26162
|
-
"attribute": "error"
|
26163
|
-
"inheritedFrom": {
|
26164
|
-
"name": "Progressbar",
|
26165
|
-
"module": "components/progressbar/progressbar.component.js"
|
26166
|
-
}
|
26232
|
+
"attribute": "error"
|
26167
26233
|
},
|
26168
26234
|
{
|
26169
26235
|
"kind": "method",
|
@@ -26174,10 +26240,21 @@
|
|
26174
26240
|
"type": {
|
26175
26241
|
"text": ""
|
26176
26242
|
}
|
26243
|
+
}
|
26244
|
+
},
|
26245
|
+
{
|
26246
|
+
"kind": "field",
|
26247
|
+
"name": "dataAriaLabel",
|
26248
|
+
"type": {
|
26249
|
+
"text": "string | null"
|
26177
26250
|
},
|
26251
|
+
"default": "null",
|
26252
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
26253
|
+
"attribute": "data-aria-label",
|
26254
|
+
"reflects": true,
|
26178
26255
|
"inheritedFrom": {
|
26179
|
-
"name": "
|
26180
|
-
"module": "
|
26256
|
+
"name": "DataAriaLabelMixin",
|
26257
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
26181
26258
|
}
|
26182
26259
|
},
|
26183
26260
|
{
|
@@ -26385,27 +26462,7 @@
|
|
26385
26462
|
}
|
26386
26463
|
}
|
26387
26464
|
],
|
26388
|
-
"superclass": {
|
26389
|
-
"name": "Progressbar",
|
26390
|
-
"module": "/src/components/progressbar/progressbar.component"
|
26391
|
-
},
|
26392
|
-
"tagName": "mdc-progressspinner",
|
26393
|
-
"jsDoc": "/**\n * `mdc-progressspinner` is a customizable, circular progress indicator component.\n * It visually represents the current completion state of a process, such as loading,\n * syncing, uploading, or any ongoing task that has a measurable percentage.\n *\n * The spinner is built using SVG with two concentric `<circle>` elements:\n * - The `progress` arc represents the portion of work completed.\n * - The `track` arc represents the remaining part.\n *\n * A visual gap is maintained between the progress and track arcs to clearly\n * distinguish the two segments. The component smoothly animates arc length\n * and respects accessibility best practices with ARIA attributes.\n *\n * The component supports different states:\n * - **Default**: Circular spinner shows the progress.\n * - **Success**: Displays a checkmark icon when progress reaches 100%.\n * - **Error**: Displays an error icon when in an error state.\n *\n * @tagname mdc-progressspinner\n *\n * @cssproperty --mdc-spinner-size - The size of the spinner.\n * @cssproperty --mdc-track-color - The color of the spinner track.\n * @cssproperty --mdc-progress-color - The color of the spinner progress.\n * @cssproperty --mdc-progress-success-color - The color of the spinner when in success state.\n * @cssproperty --mdc-progress-error-color - The color of the spinner when in error state.\n *\n */",
|
26394
|
-
"customElement": true,
|
26395
26465
|
"attributes": [
|
26396
|
-
{
|
26397
|
-
"name": "data-aria-label",
|
26398
|
-
"type": {
|
26399
|
-
"text": "string | null"
|
26400
|
-
},
|
26401
|
-
"default": "null",
|
26402
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
26403
|
-
"fieldName": "dataAriaLabel",
|
26404
|
-
"inheritedFrom": {
|
26405
|
-
"name": "DataAriaLabelMixin",
|
26406
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
26407
|
-
}
|
26408
|
-
},
|
26409
26466
|
{
|
26410
26467
|
"name": "variant",
|
26411
26468
|
"type": {
|
@@ -26413,11 +26470,7 @@
|
|
26413
26470
|
},
|
26414
26471
|
"description": "Types of the progressbar\n- **Default**\n- **Inline**",
|
26415
26472
|
"default": "default",
|
26416
|
-
"fieldName": "variant"
|
26417
|
-
"inheritedFrom": {
|
26418
|
-
"name": "Progressbar",
|
26419
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26420
|
-
}
|
26473
|
+
"fieldName": "variant"
|
26421
26474
|
},
|
26422
26475
|
{
|
26423
26476
|
"name": "value",
|
@@ -26426,11 +26479,7 @@
|
|
26426
26479
|
},
|
26427
26480
|
"default": "'0'",
|
26428
26481
|
"description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
|
26429
|
-
"fieldName": "value"
|
26430
|
-
"inheritedFrom": {
|
26431
|
-
"name": "Progressbar",
|
26432
|
-
"module": "src/components/progressbar/progressbar.component.ts"
|
26433
|
-
}
|
26482
|
+
"fieldName": "value"
|
26434
26483
|
},
|
26435
26484
|
{
|
26436
26485
|
"name": "error",
|
@@ -26439,10 +26488,19 @@
|
|
26439
26488
|
},
|
26440
26489
|
"default": "false",
|
26441
26490
|
"description": "Define error state of the progressbar\n- **true**\n- **false**",
|
26442
|
-
"fieldName": "error"
|
26491
|
+
"fieldName": "error"
|
26492
|
+
},
|
26493
|
+
{
|
26494
|
+
"name": "data-aria-label",
|
26495
|
+
"type": {
|
26496
|
+
"text": "string | null"
|
26497
|
+
},
|
26498
|
+
"default": "null",
|
26499
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
26500
|
+
"fieldName": "dataAriaLabel",
|
26443
26501
|
"inheritedFrom": {
|
26444
|
-
"name": "
|
26445
|
-
"module": "src/
|
26502
|
+
"name": "DataAriaLabelMixin",
|
26503
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
26446
26504
|
}
|
26447
26505
|
},
|
26448
26506
|
{
|
@@ -26557,7 +26615,20 @@
|
|
26557
26615
|
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
26558
26616
|
}
|
26559
26617
|
}
|
26560
|
-
]
|
26618
|
+
],
|
26619
|
+
"mixins": [
|
26620
|
+
{
|
26621
|
+
"name": "DataAriaLabelMixin",
|
26622
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
26623
|
+
}
|
26624
|
+
],
|
26625
|
+
"superclass": {
|
26626
|
+
"name": "FormfieldWrapper",
|
26627
|
+
"module": "/src/components/formfieldwrapper"
|
26628
|
+
},
|
26629
|
+
"tagName": "mdc-progressbar",
|
26630
|
+
"jsDoc": "/**\n * mdc-progressbar component visually represents a progress indicator, typically used to show\n * the completion state of an ongoing process (e.g., loading, file upload, etc.).\n * It contains an optional label and an optional helper text.\n *\n * - It supports mainly two types: Default and Inline\n * - It supports three validation variants: Default, Success and Error.\n *\n * This component is created by extending FormfieldWrapper.\n *\n * @tagname mdc-progressbar\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-progressbar-default-background-color - Background color of the progressbar when inactive.\n * @cssproperty --mdc-progressbar-default-active-background-color - Background color of the progressbar when active.\n * @cssproperty --mdc-progressbar-success-background-color - Background color of the progressbar when in success state.\n * @cssproperty --mdc-progressbar-error-background-color - Background color of the progressbar when in error state.\n * @cssproperty --mdc-progressbar-height - The height of the progressbar.\n * @cssproperty --mdc-progressbar-border-radius - The border radius of the progressbar.\n * @cssproperty --mdc-progressbar-label-color - Color of the progressbar label text.\n * @cssproperty --mdc-progressbar-label-lineheight - Line height of the label text.\n * @cssproperty --mdc-progressbar-label-fontsize - Font size of the label text.\n * @cssproperty --mdc-progressbar-label-fontweight - Font weight of the label text.\n * @cssproperty --mdc-progressbar-help-text-color - Color of the help text.\n */",
|
26631
|
+
"customElement": true
|
26561
26632
|
}
|
26562
26633
|
],
|
26563
26634
|
"exports": [
|
@@ -26565,8 +26636,8 @@
|
|
26565
26636
|
"kind": "js",
|
26566
26637
|
"name": "default",
|
26567
26638
|
"declaration": {
|
26568
|
-
"name": "
|
26569
|
-
"module": "components/
|
26639
|
+
"name": "Progressbar",
|
26640
|
+
"module": "components/progressbar/progressbar.component.js"
|
26570
26641
|
}
|
26571
26642
|
}
|
26572
26643
|
]
|
@@ -34913,7 +34984,7 @@
|
|
34913
34984
|
{
|
34914
34985
|
"kind": "method",
|
34915
34986
|
"name": "isOpenUpdated",
|
34916
|
-
"privacy": "
|
34987
|
+
"privacy": "protected",
|
34917
34988
|
"parameters": [
|
34918
34989
|
{
|
34919
34990
|
"name": "oldValue",
|
@@ -35026,6 +35097,30 @@
|
|
35026
35097
|
"module": "components/popover/popover.component.js"
|
35027
35098
|
}
|
35028
35099
|
},
|
35100
|
+
{
|
35101
|
+
"kind": "method",
|
35102
|
+
"name": "findClosestPopover",
|
35103
|
+
"privacy": "protected",
|
35104
|
+
"return": {
|
35105
|
+
"type": {
|
35106
|
+
"text": "Popover | null"
|
35107
|
+
}
|
35108
|
+
},
|
35109
|
+
"parameters": [
|
35110
|
+
{
|
35111
|
+
"name": "element",
|
35112
|
+
"type": {
|
35113
|
+
"text": "Element"
|
35114
|
+
},
|
35115
|
+
"description": "The element to start searching from."
|
35116
|
+
}
|
35117
|
+
],
|
35118
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
35119
|
+
"inheritedFrom": {
|
35120
|
+
"name": "Popover",
|
35121
|
+
"module": "components/popover/popover.component.js"
|
35122
|
+
}
|
35123
|
+
},
|
35029
35124
|
{
|
35030
35125
|
"kind": "field",
|
35031
35126
|
"name": "utils",
|
@@ -36740,7 +36835,7 @@
|
|
36740
36835
|
{
|
36741
36836
|
"kind": "method",
|
36742
36837
|
"name": "isOpenUpdated",
|
36743
|
-
"privacy": "
|
36838
|
+
"privacy": "protected",
|
36744
36839
|
"parameters": [
|
36745
36840
|
{
|
36746
36841
|
"name": "oldValue",
|
@@ -36853,6 +36948,30 @@
|
|
36853
36948
|
"module": "components/popover/popover.component.js"
|
36854
36949
|
}
|
36855
36950
|
},
|
36951
|
+
{
|
36952
|
+
"kind": "method",
|
36953
|
+
"name": "findClosestPopover",
|
36954
|
+
"privacy": "protected",
|
36955
|
+
"return": {
|
36956
|
+
"type": {
|
36957
|
+
"text": "Popover | null"
|
36958
|
+
}
|
36959
|
+
},
|
36960
|
+
"parameters": [
|
36961
|
+
{
|
36962
|
+
"name": "element",
|
36963
|
+
"type": {
|
36964
|
+
"text": "Element"
|
36965
|
+
},
|
36966
|
+
"description": "The element to start searching from."
|
36967
|
+
}
|
36968
|
+
],
|
36969
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
36970
|
+
"inheritedFrom": {
|
36971
|
+
"name": "Popover",
|
36972
|
+
"module": "components/popover/popover.component.js"
|
36973
|
+
}
|
36974
|
+
},
|
36856
36975
|
{
|
36857
36976
|
"kind": "field",
|
36858
36977
|
"name": "utils",
|