@momentum-design/components 0.133.39 → 0.134.0
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 +88 -88
- package/dist/browser/index.js.map +3 -3
- package/dist/components/animation/animation.component.d.ts +20 -1
- package/dist/components/animation/animation.component.js +40 -8
- package/dist/components/button/button.component.d.ts +2 -1
- package/dist/components/button/button.component.js +2 -1
- package/dist/components/checkbox/checkbox.component.d.ts +2 -0
- package/dist/components/checkbox/checkbox.component.js +8 -0
- package/dist/custom-elements.json +74 -4
- package/dist/react/button/index.d.ts +2 -1
- package/dist/react/button/index.js +2 -1
- package/dist/react/checkbox/index.d.ts +2 -0
- package/dist/react/checkbox/index.js +2 -0
- package/package.json +1 -1
|
@@ -20,6 +20,12 @@ declare class Animation extends Component {
|
|
|
20
20
|
* @default undefined
|
|
21
21
|
*/
|
|
22
22
|
name?: AnimationNames;
|
|
23
|
+
/**
|
|
24
|
+
* URL pointing to a Lottie JSON animation file.
|
|
25
|
+
* When provided, it takes precedence over the `name` property.
|
|
26
|
+
* @default undefined
|
|
27
|
+
*/
|
|
28
|
+
src?: string;
|
|
23
29
|
/**
|
|
24
30
|
* How many times to loop the animation
|
|
25
31
|
* - "true" - infinite
|
|
@@ -48,6 +54,11 @@ declare class Animation extends Component {
|
|
|
48
54
|
* @internal
|
|
49
55
|
*/
|
|
50
56
|
private lottieInstance?;
|
|
57
|
+
/**
|
|
58
|
+
* Cached animation data from the last successful fetch/import
|
|
59
|
+
* @internal
|
|
60
|
+
*/
|
|
61
|
+
private cachedAnimationData?;
|
|
51
62
|
/**
|
|
52
63
|
* Container for the animation
|
|
53
64
|
* @internal
|
|
@@ -60,9 +71,13 @@ declare class Animation extends Component {
|
|
|
60
71
|
get animation(): AnimationItem | undefined;
|
|
61
72
|
private getLoopValue;
|
|
62
73
|
/**
|
|
63
|
-
* Create new
|
|
74
|
+
* Create new lottie instance for the loaded data
|
|
64
75
|
*/
|
|
65
76
|
private onLoadSuccessHandler;
|
|
77
|
+
/**
|
|
78
|
+
* Create or re-create the lottie instance with the given animation data
|
|
79
|
+
*/
|
|
80
|
+
private createLottieInstance;
|
|
66
81
|
/**
|
|
67
82
|
* Error handler for animation loading
|
|
68
83
|
*/
|
|
@@ -71,6 +86,10 @@ declare class Animation extends Component {
|
|
|
71
86
|
* Import animation data dynamically
|
|
72
87
|
*/
|
|
73
88
|
private getAnimationData;
|
|
89
|
+
/**
|
|
90
|
+
* Fetch animation data from a URL
|
|
91
|
+
*/
|
|
92
|
+
private fetchAnimationFromUrl;
|
|
74
93
|
updated(changedProperties: PropertyValues): void;
|
|
75
94
|
disconnectedCallback(): void;
|
|
76
95
|
/**
|
|
@@ -91,9 +91,18 @@ class Animation extends Component {
|
|
|
91
91
|
return true;
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
* Create new
|
|
94
|
+
* Create new lottie instance for the loaded data
|
|
95
95
|
*/
|
|
96
96
|
onLoadSuccessHandler(animationData) {
|
|
97
|
+
this.cachedAnimationData = animationData;
|
|
98
|
+
this.createLottieInstance(animationData);
|
|
99
|
+
// Dispatch load event when animation ready to play
|
|
100
|
+
this.dispatchEvent(new CustomEvent('load', { bubbles: true, cancelable: true, detail: { name: this.name } }));
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Create or re-create the lottie instance with the given animation data
|
|
104
|
+
*/
|
|
105
|
+
createLottieInstance(animationData) {
|
|
97
106
|
if (this.lottieInstance) {
|
|
98
107
|
this.lottieInstance.removeEventListener('complete', this.onCompleteHandler);
|
|
99
108
|
this.lottieInstance.destroy();
|
|
@@ -109,8 +118,6 @@ class Animation extends Component {
|
|
|
109
118
|
});
|
|
110
119
|
this.lottieInstance.addEventListener('complete', this.onCompleteHandler);
|
|
111
120
|
}
|
|
112
|
-
// Dispatch load event when animation ready to play
|
|
113
|
-
this.dispatchEvent(new CustomEvent('load', { bubbles: true, cancelable: true, detail: { name: this.name } }));
|
|
114
121
|
}
|
|
115
122
|
/**
|
|
116
123
|
* Error handler for animation loading
|
|
@@ -127,7 +134,10 @@ class Animation extends Component {
|
|
|
127
134
|
* Import animation data dynamically
|
|
128
135
|
*/
|
|
129
136
|
getAnimationData() {
|
|
130
|
-
if (this.
|
|
137
|
+
if (this.src) {
|
|
138
|
+
this.fetchAnimationFromUrl(this.src);
|
|
139
|
+
}
|
|
140
|
+
else if (this.name && animationManifest[this.name]) {
|
|
131
141
|
// Make sure the path is point to a folder (and its sub-folders) that contains animation data only
|
|
132
142
|
// otherwise bundlers (eg. webpack) will try to process everything in this folder including the types.d.ts
|
|
133
143
|
const path = animationManifest[this.name].replace(/^\.\/lottie/, '');
|
|
@@ -139,14 +149,32 @@ class Animation extends Component {
|
|
|
139
149
|
this.onLoadFailHandler(new Error(`Invalid animation name: ${this.name}`));
|
|
140
150
|
}
|
|
141
151
|
}
|
|
152
|
+
/**
|
|
153
|
+
* Fetch animation data from a URL
|
|
154
|
+
*/
|
|
155
|
+
fetchAnimationFromUrl(url) {
|
|
156
|
+
fetch(url)
|
|
157
|
+
.then(response => {
|
|
158
|
+
if (!response.ok) {
|
|
159
|
+
throw new Error(`Failed to fetch animation from URL: ${url} (${response.status})`);
|
|
160
|
+
}
|
|
161
|
+
return response.json();
|
|
162
|
+
})
|
|
163
|
+
.then((animationData) => this.onLoadSuccessHandler(animationData))
|
|
164
|
+
.catch((error) => this.onLoadFailHandler(error));
|
|
165
|
+
}
|
|
142
166
|
updated(changedProperties) {
|
|
143
167
|
super.updated(changedProperties);
|
|
144
|
-
// fetch animation data when
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
if (changedProperties.has('name') || changedProperties.has('loop') || changedProperties.has('autoplay')) {
|
|
168
|
+
// fetch animation data when the animation source changes
|
|
169
|
+
if (changedProperties.has('name') || changedProperties.has('src')) {
|
|
170
|
+
this.cachedAnimationData = undefined;
|
|
148
171
|
this.getAnimationData();
|
|
149
172
|
}
|
|
173
|
+
else if ((changedProperties.has('loop') || changedProperties.has('autoplay')) && this.cachedAnimationData) {
|
|
174
|
+
// re-create the lottie instance from cache for parameter changes,
|
|
175
|
+
// because lottie does not have an API for changing them on the fly
|
|
176
|
+
this.createLottieInstance(this.cachedAnimationData);
|
|
177
|
+
}
|
|
150
178
|
if (changedProperties.has('ariaLabel') || changedProperties.has('ariaLabelledby')) {
|
|
151
179
|
this.role = this.ariaLabel || this.ariaLabelledby ? ROLE.IMG : null;
|
|
152
180
|
}
|
|
@@ -169,6 +197,10 @@ __decorate([
|
|
|
169
197
|
property({ type: String, reflect: true }),
|
|
170
198
|
__metadata("design:type", String)
|
|
171
199
|
], Animation.prototype, "name", void 0);
|
|
200
|
+
__decorate([
|
|
201
|
+
property({ type: String, reflect: true }),
|
|
202
|
+
__metadata("design:type", String)
|
|
203
|
+
], Animation.prototype, "src", void 0);
|
|
172
204
|
__decorate([
|
|
173
205
|
property({ type: String, reflect: true }),
|
|
174
206
|
__metadata("design:type", String)
|
|
@@ -61,11 +61,12 @@ declare const Button_base: import("../../utils/mixins/index.types").Constructor<
|
|
|
61
61
|
*
|
|
62
62
|
* @cssproperty --mdc-button-height - Height for button size
|
|
63
63
|
* @cssproperty --mdc-button-background - Background of the button
|
|
64
|
-
* @cssproperty --mdc-button-border-color -
|
|
64
|
+
* @cssproperty --mdc-button-border-color - Border color of the button
|
|
65
65
|
* @cssproperty --mdc-button-text-color - Text color of the button
|
|
66
66
|
* @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon
|
|
67
67
|
* @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon
|
|
68
68
|
* @cssproperty --mdc-button-line-height - Line height of the button text
|
|
69
|
+
*
|
|
69
70
|
*/
|
|
70
71
|
declare class Button extends Button_base {
|
|
71
72
|
/**
|
|
@@ -73,11 +73,12 @@ import { getIconNameWithoutStyle } from './button.utils';
|
|
|
73
73
|
*
|
|
74
74
|
* @cssproperty --mdc-button-height - Height for button size
|
|
75
75
|
* @cssproperty --mdc-button-background - Background of the button
|
|
76
|
-
* @cssproperty --mdc-button-border-color -
|
|
76
|
+
* @cssproperty --mdc-button-border-color - Border color of the button
|
|
77
77
|
* @cssproperty --mdc-button-text-color - Text color of the button
|
|
78
78
|
* @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon
|
|
79
79
|
* @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon
|
|
80
80
|
* @cssproperty --mdc-button-line-height - Line height of the button text
|
|
81
|
+
*
|
|
81
82
|
*/
|
|
82
83
|
class Button extends OverflowMixin(ButtonComponentMixin(Buttonsimple)) {
|
|
83
84
|
constructor() {
|
|
@@ -47,6 +47,8 @@ declare const Checkbox_base: import("../../utils/mixins/index.types").Constructo
|
|
|
47
47
|
* @csspart checkbox-input - The native checkbox input element that provides the interactive functionality.
|
|
48
48
|
* @csspart text-container - The container for the label and helper text elements.
|
|
49
49
|
* @csspart static-checkbox - The staticcheckbox that provides the visual checkbox appearance.
|
|
50
|
+
*
|
|
51
|
+
* @cssstate checked - Active when the checkbox is checked.
|
|
50
52
|
*/
|
|
51
53
|
declare class Checkbox extends Checkbox_base implements AssociatedFormControl {
|
|
52
54
|
/**
|
|
@@ -63,6 +63,8 @@ import { CHECKBOX_VALIDATION } from './checkbox.constants';
|
|
|
63
63
|
* @csspart checkbox-input - The native checkbox input element that provides the interactive functionality.
|
|
64
64
|
* @csspart text-container - The container for the label and helper text elements.
|
|
65
65
|
* @csspart static-checkbox - The staticcheckbox that provides the visual checkbox appearance.
|
|
66
|
+
*
|
|
67
|
+
* @cssstate checked - Active when the checkbox is checked.
|
|
66
68
|
*/
|
|
67
69
|
class Checkbox extends KeyDownHandledMixin(KeyToActionMixin(AutoFocusOnMountMixin(FormInternalsMixin(DataAriaLabelMixin(FormfieldWrapper))))) {
|
|
68
70
|
constructor() {
|
|
@@ -209,6 +211,12 @@ class Checkbox extends KeyDownHandledMixin(KeyToActionMixin(AutoFocusOnMountMixi
|
|
|
209
211
|
super.update(changedProperties);
|
|
210
212
|
if (changedProperties.has('checked')) {
|
|
211
213
|
this.setFormValue();
|
|
214
|
+
if (this.checked) {
|
|
215
|
+
this.internals.states.add('checked');
|
|
216
|
+
}
|
|
217
|
+
else {
|
|
218
|
+
this.internals.states.delete('checked');
|
|
219
|
+
}
|
|
212
220
|
}
|
|
213
221
|
}
|
|
214
222
|
render() {
|
|
@@ -1846,6 +1846,44 @@
|
|
|
1846
1846
|
"attribute": "autoplay",
|
|
1847
1847
|
"reflects": true
|
|
1848
1848
|
},
|
|
1849
|
+
{
|
|
1850
|
+
"kind": "method",
|
|
1851
|
+
"name": "createLottieInstance",
|
|
1852
|
+
"privacy": "private",
|
|
1853
|
+
"return": {
|
|
1854
|
+
"type": {
|
|
1855
|
+
"text": "void"
|
|
1856
|
+
}
|
|
1857
|
+
},
|
|
1858
|
+
"parameters": [
|
|
1859
|
+
{
|
|
1860
|
+
"name": "animationData",
|
|
1861
|
+
"type": {
|
|
1862
|
+
"text": "any"
|
|
1863
|
+
}
|
|
1864
|
+
}
|
|
1865
|
+
],
|
|
1866
|
+
"description": "Create or re-create the lottie instance with the given animation data"
|
|
1867
|
+
},
|
|
1868
|
+
{
|
|
1869
|
+
"kind": "method",
|
|
1870
|
+
"name": "fetchAnimationFromUrl",
|
|
1871
|
+
"privacy": "private",
|
|
1872
|
+
"return": {
|
|
1873
|
+
"type": {
|
|
1874
|
+
"text": "void"
|
|
1875
|
+
}
|
|
1876
|
+
},
|
|
1877
|
+
"parameters": [
|
|
1878
|
+
{
|
|
1879
|
+
"name": "url",
|
|
1880
|
+
"type": {
|
|
1881
|
+
"text": "string"
|
|
1882
|
+
}
|
|
1883
|
+
}
|
|
1884
|
+
],
|
|
1885
|
+
"description": "Fetch animation data from a URL"
|
|
1886
|
+
},
|
|
1849
1887
|
{
|
|
1850
1888
|
"kind": "method",
|
|
1851
1889
|
"name": "getAnimationData",
|
|
@@ -1925,7 +1963,18 @@
|
|
|
1925
1963
|
}
|
|
1926
1964
|
}
|
|
1927
1965
|
],
|
|
1928
|
-
"description": "Create new
|
|
1966
|
+
"description": "Create new lottie instance for the loaded data"
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"kind": "field",
|
|
1970
|
+
"name": "src",
|
|
1971
|
+
"type": {
|
|
1972
|
+
"text": "string | undefined"
|
|
1973
|
+
},
|
|
1974
|
+
"description": "URL pointing to a Lottie JSON animation file.\nWhen provided, it takes precedence over the `name` property.",
|
|
1975
|
+
"default": "undefined",
|
|
1976
|
+
"attribute": "src",
|
|
1977
|
+
"reflects": true
|
|
1929
1978
|
}
|
|
1930
1979
|
],
|
|
1931
1980
|
"events": [
|
|
@@ -1958,6 +2007,15 @@
|
|
|
1958
2007
|
"default": "undefined",
|
|
1959
2008
|
"fieldName": "name"
|
|
1960
2009
|
},
|
|
2010
|
+
{
|
|
2011
|
+
"name": "src",
|
|
2012
|
+
"type": {
|
|
2013
|
+
"text": "string | undefined"
|
|
2014
|
+
},
|
|
2015
|
+
"description": "URL pointing to a Lottie JSON animation file.\nWhen provided, it takes precedence over the `name` property.",
|
|
2016
|
+
"default": "undefined",
|
|
2017
|
+
"fieldName": "src"
|
|
2018
|
+
},
|
|
1961
2019
|
{
|
|
1962
2020
|
"name": "loop",
|
|
1963
2021
|
"type": {
|
|
@@ -4859,7 +4917,7 @@
|
|
|
4859
4917
|
}
|
|
4860
4918
|
},
|
|
4861
4919
|
{
|
|
4862
|
-
"description": "
|
|
4920
|
+
"description": "Border color of the button",
|
|
4863
4921
|
"name": "--mdc-button-border-color",
|
|
4864
4922
|
"inheritedFrom": {
|
|
4865
4923
|
"name": "Buttonsimple",
|
|
@@ -5626,7 +5684,7 @@
|
|
|
5626
5684
|
"module": "/src/components/buttonsimple/buttonsimple.component"
|
|
5627
5685
|
},
|
|
5628
5686
|
"tagName": "mdc-button",
|
|
5629
|
-
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * ## Button configuration\n *\n * The appearance of the button depends on combination of multiple attributes.\n *\n * ### Button Types\n *\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons/slots:\n *\n * - **Pill button**: Contains text value, commonly used for call to action, tags, or filters\n * - **Pill button with icons**: Contains an icon on the left or right side of the button\n * - **Icon button**: Represented by just an icon without any text\n *\n * ### Button Variants:\n *\n * Options for button backgrounds and borders:\n *\n * - **Primary**: Solid background color\n * - **Secondary**: Transparent background with solid border\n * - **Tertiary**: No background or border, text-only appearance\n *\n * ### Button Colors\n *\n * Color options for **Primary** and **Secondary** buttons:\n *\n * - **Default**: For standard actions\n * - **Positive**: For success or confirmation actions\n * - **Negative**: For destructive or error actions\n * - **Accent**: For informational actions\n * - **Promotional**: For promotional actions\n *\n * ### Button Sizes\n *\n * Size options for different button configurations in REM:\n *\n * - **Pill button**: 40, 32, 28, 24\n * - **Icon button**: 64, 52, 40, 32, 28, 24\n * - **Tertiary icon button**: 20\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n * @slot prefix - Content to be displayed before the text label.\n * @slot postfix - Content to be displayed after the text label.\n *\n * @csspart button-text - Text label of the button, passed in default slot\n * @csspart prefix - Content before the text label, passed in `prefix` slot\n * @csspart postfix - Content after the text label, passed in `postfix` slot\n * @csspart prefix-icon - Icon element displayed before the text label when `prefix-icon` attribute is set\n * @csspart postfix-icon - Icon element displayed after the text label when `postfix-icon` attribute is set\n *\n * @cssproperty --mdc-button-height - Height for button size\n * @cssproperty --mdc-button-background - Background of the button\n * @cssproperty --mdc-button-border-color -
|
|
5687
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * ## Button configuration\n *\n * The appearance of the button depends on combination of multiple attributes.\n *\n * ### Button Types\n *\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons/slots:\n *\n * - **Pill button**: Contains text value, commonly used for call to action, tags, or filters\n * - **Pill button with icons**: Contains an icon on the left or right side of the button\n * - **Icon button**: Represented by just an icon without any text\n *\n * ### Button Variants:\n *\n * Options for button backgrounds and borders:\n *\n * - **Primary**: Solid background color\n * - **Secondary**: Transparent background with solid border\n * - **Tertiary**: No background or border, text-only appearance\n *\n * ### Button Colors\n *\n * Color options for **Primary** and **Secondary** buttons:\n *\n * - **Default**: For standard actions\n * - **Positive**: For success or confirmation actions\n * - **Negative**: For destructive or error actions\n * - **Accent**: For informational actions\n * - **Promotional**: For promotional actions\n *\n * ### Button Sizes\n *\n * Size options for different button configurations in REM:\n *\n * - **Pill button**: 40, 32, 28, 24\n * - **Icon button**: 64, 52, 40, 32, 28, 24\n * - **Tertiary icon button**: 20\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n * @slot prefix - Content to be displayed before the text label.\n * @slot postfix - Content to be displayed after the text label.\n *\n * @csspart button-text - Text label of the button, passed in default slot\n * @csspart prefix - Content before the text label, passed in `prefix` slot\n * @csspart postfix - Content after the text label, passed in `postfix` slot\n * @csspart prefix-icon - Icon element displayed before the text label when `prefix-icon` attribute is set\n * @csspart postfix-icon - Icon element displayed after the text label when `postfix-icon` attribute is set\n *\n * @cssproperty --mdc-button-height - Height for button size\n * @cssproperty --mdc-button-background - Background of the button\n * @cssproperty --mdc-button-border-color - Border color of the button\n * @cssproperty --mdc-button-text-color - Text color of the button\n * @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon\n * @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon\n * @cssproperty --mdc-button-line-height - Line height of the button text\n *\n */",
|
|
5630
5688
|
"customElement": true,
|
|
5631
5689
|
"events": [
|
|
5632
5690
|
{
|
|
@@ -11373,6 +11431,12 @@
|
|
|
11373
11431
|
}
|
|
11374
11432
|
}
|
|
11375
11433
|
],
|
|
11434
|
+
"cssStates": [
|
|
11435
|
+
{
|
|
11436
|
+
"description": "Active when the checkbox is checked.",
|
|
11437
|
+
"name": "checked"
|
|
11438
|
+
}
|
|
11439
|
+
],
|
|
11376
11440
|
"mixins": [
|
|
11377
11441
|
{
|
|
11378
11442
|
"name": "KeyDownHandledMixin",
|
|
@@ -11400,7 +11464,13 @@
|
|
|
11400
11464
|
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
|
11401
11465
|
},
|
|
11402
11466
|
"tagName": "mdc-checkbox",
|
|
11403
|
-
"jsDoc": "/**\n * The Checkbox component allows users to select one or multiple options from a list, toggle features on/off,\n * or indicate agreement in forms and settings. These are commonly used in forms, lists, and settings panels\n * where users need to make selections or express preferences.\n *\n * To create a group of checkboxes, use the `mdc-formfieldgroup` component.\n *\n * **Note:** This component internally renders a native checkbox input element with custom styling.\n *\n * ## When to use\n *\n * Use checkboxes when users can select multiple options from a list, or when a single checkbox represents a binary choice (e.g., agreeing to terms).\n *\n * ## Accessibility\n * - Provide clear labels that describe what the checkbox controls\n * - Use `data-aria-label` when a visual label is not present\n * - Keyboard navigation: Space to toggle, Tab to navigate, Enter to submit form\n *\n * ## Styling\n * Use the `static-checkbox` part to apply custom styles to the checkbox visual element.\n * This part exposes the underlying [StaticCheckbox](?path=/docs/components-decorator-staticcheckbox--docs) component for advanced styling.\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 * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n * @csspart checkbox-input - The native checkbox input element that provides the interactive functionality.\n * @csspart text-container - The container for the label and helper text elements.\n * @csspart static-checkbox - The staticcheckbox that provides the visual checkbox appearance.\n */",
|
|
11467
|
+
"jsDoc": "/**\n * The Checkbox component allows users to select one or multiple options from a list, toggle features on/off,\n * or indicate agreement in forms and settings. These are commonly used in forms, lists, and settings panels\n * where users need to make selections or express preferences.\n *\n * To create a group of checkboxes, use the `mdc-formfieldgroup` component.\n *\n * **Note:** This component internally renders a native checkbox input element with custom styling.\n *\n * ## When to use\n *\n * Use checkboxes when users can select multiple options from a list, or when a single checkbox represents a binary choice (e.g., agreeing to terms).\n *\n * ## Accessibility\n * - Provide clear labels that describe what the checkbox controls\n * - Use `data-aria-label` when a visual label is not present\n * - Keyboard navigation: Space to toggle, Tab to navigate, Enter to submit form\n *\n * ## Styling\n * Use the `static-checkbox` part to apply custom styles to the checkbox visual element.\n * This part exposes the underlying [StaticCheckbox](?path=/docs/components-decorator-staticcheckbox--docs) component for advanced styling.\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 * @csspart label - The label element.\n * @csspart label-text - The container for the label and required indicator elements.\n * @csspart required-indicator - The required indicator element that is displayed next to the label when the `required` property is set to true.\n * @csspart info-icon-btn - The info icon button element that is displayed next to the label when the `toggletip-text` property is set.\n * @csspart label-toggletip - The toggletip element that is displayed when the info icon button is clicked.\n * @csspart help-text - The helper/validation text element.\n * @csspart helper-icon - The helper/validation icon element that is displayed next to the helper/validation text.\n * @csspart help-text-container - The container for the helper/validation icon and text elements.\n * @csspart checkbox-input - The native checkbox input element that provides the interactive functionality.\n * @csspart text-container - The container for the label and helper text elements.\n * @csspart static-checkbox - The staticcheckbox that provides the visual checkbox appearance.\n *\n * @cssstate checked - Active when the checkbox is checked.\n */",
|
|
11468
|
+
"cssCustomStates": [
|
|
11469
|
+
{
|
|
11470
|
+
"name": "checked",
|
|
11471
|
+
"description": "Active when the checkbox is checked."
|
|
11472
|
+
}
|
|
11473
|
+
],
|
|
11404
11474
|
"customElement": true,
|
|
11405
11475
|
"slots": [
|
|
11406
11476
|
{
|
|
@@ -58,11 +58,12 @@ import type { Events as EventsInherited } from '../../components/buttonsimple/bu
|
|
|
58
58
|
*
|
|
59
59
|
* @cssproperty --mdc-button-height - Height for button size
|
|
60
60
|
* @cssproperty --mdc-button-background - Background of the button
|
|
61
|
-
* @cssproperty --mdc-button-border-color -
|
|
61
|
+
* @cssproperty --mdc-button-border-color - Border color of the button
|
|
62
62
|
* @cssproperty --mdc-button-text-color - Text color of the button
|
|
63
63
|
* @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon
|
|
64
64
|
* @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon
|
|
65
65
|
* @cssproperty --mdc-button-line-height - Line height of the button text
|
|
66
|
+
*
|
|
66
67
|
*/
|
|
67
68
|
declare const reactWrapper: import("@lit/react").ReactWebComponent<Component, {
|
|
68
69
|
onClick: EventName<EventsInherited["onClickEvent"]>;
|
|
@@ -59,11 +59,12 @@ import { TAG_NAME } from '../../components/button/button.constants';
|
|
|
59
59
|
*
|
|
60
60
|
* @cssproperty --mdc-button-height - Height for button size
|
|
61
61
|
* @cssproperty --mdc-button-background - Background of the button
|
|
62
|
-
* @cssproperty --mdc-button-border-color -
|
|
62
|
+
* @cssproperty --mdc-button-border-color - Border color of the button
|
|
63
63
|
* @cssproperty --mdc-button-text-color - Text color of the button
|
|
64
64
|
* @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon
|
|
65
65
|
* @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon
|
|
66
66
|
* @cssproperty --mdc-button-line-height - Line height of the button text
|
|
67
|
+
*
|
|
67
68
|
*/
|
|
68
69
|
const reactWrapper = createComponent({
|
|
69
70
|
tagName: TAG_NAME,
|
|
@@ -45,6 +45,8 @@ import type { Events } from '../../components/checkbox/checkbox.types';
|
|
|
45
45
|
* @csspart checkbox-input - The native checkbox input element that provides the interactive functionality.
|
|
46
46
|
* @csspart text-container - The container for the label and helper text elements.
|
|
47
47
|
* @csspart static-checkbox - The staticcheckbox that provides the visual checkbox appearance.
|
|
48
|
+
*
|
|
49
|
+
* @cssstate checked - Active when the checkbox is checked.
|
|
48
50
|
*/
|
|
49
51
|
declare const reactWrapper: import("@lit/react").ReactWebComponent<Component, {
|
|
50
52
|
onChange: EventName<Events["onChangeEvent"]>;
|
|
@@ -46,6 +46,8 @@ import { TAG_NAME } from '../../components/checkbox/checkbox.constants';
|
|
|
46
46
|
* @csspart checkbox-input - The native checkbox input element that provides the interactive functionality.
|
|
47
47
|
* @csspart text-container - The container for the label and helper text elements.
|
|
48
48
|
* @csspart static-checkbox - The staticcheckbox that provides the visual checkbox appearance.
|
|
49
|
+
*
|
|
50
|
+
* @cssstate checked - Active when the checkbox is checked.
|
|
49
51
|
*/
|
|
50
52
|
const reactWrapper = createComponent({
|
|
51
53
|
tagName: TAG_NAME,
|