@momentum-design/components 0.53.7 → 0.53.8
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 +1 -1
- package/dist/browser/index.js.map +2 -2
- package/dist/components/buttonsimple/buttonsimple.component.d.ts +2 -2
- package/dist/components/buttonsimple/buttonsimple.component.js +5 -14
- package/dist/custom-elements.json +764 -722
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
@@ -138,8 +138,11 @@
|
|
138
138
|
{
|
139
139
|
"kind": "field",
|
140
140
|
"name": "ariaStateKey",
|
141
|
+
"type": {
|
142
|
+
"text": "string | undefined"
|
143
|
+
},
|
141
144
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
142
|
-
"default": "'aria-pressed'",
|
145
|
+
"default": "'aria-pressed' (when)",
|
143
146
|
"attribute": "ariaStateKey",
|
144
147
|
"reflects": true,
|
145
148
|
"inheritedFrom": {
|
@@ -405,8 +408,11 @@
|
|
405
408
|
},
|
406
409
|
{
|
407
410
|
"name": "ariaStateKey",
|
411
|
+
"type": {
|
412
|
+
"text": "string | undefined"
|
413
|
+
},
|
408
414
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
409
|
-
"default": "'aria-pressed'",
|
415
|
+
"default": "'aria-pressed' (when)",
|
410
416
|
"fieldName": "ariaStateKey",
|
411
417
|
"inheritedFrom": {
|
412
418
|
"name": "Buttonsimple",
|
@@ -485,67 +491,6 @@
|
|
485
491
|
}
|
486
492
|
]
|
487
493
|
},
|
488
|
-
{
|
489
|
-
"kind": "javascript-module",
|
490
|
-
"path": "components/appheader/appheader.component.js",
|
491
|
-
"declarations": [
|
492
|
-
{
|
493
|
-
"kind": "class",
|
494
|
-
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
495
|
-
"name": "Appheader",
|
496
|
-
"cssParts": [
|
497
|
-
{
|
498
|
-
"description": "The main container for styling the header.",
|
499
|
-
"name": "container"
|
500
|
-
},
|
501
|
-
{
|
502
|
-
"description": "The leading section of the header.",
|
503
|
-
"name": "leading-section"
|
504
|
-
},
|
505
|
-
{
|
506
|
-
"description": "The center section of the header.",
|
507
|
-
"name": "center-section"
|
508
|
-
},
|
509
|
-
{
|
510
|
-
"description": "The trailing section of the header.",
|
511
|
-
"name": "trailing-section"
|
512
|
-
}
|
513
|
-
],
|
514
|
-
"slots": [
|
515
|
-
{
|
516
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
517
|
-
"name": "leading"
|
518
|
-
},
|
519
|
-
{
|
520
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
521
|
-
"name": "center"
|
522
|
-
},
|
523
|
-
{
|
524
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
525
|
-
"name": "trailing"
|
526
|
-
}
|
527
|
-
],
|
528
|
-
"members": [],
|
529
|
-
"superclass": {
|
530
|
-
"name": "Component",
|
531
|
-
"module": "/src/models"
|
532
|
-
},
|
533
|
-
"tagName": "mdc-appheader",
|
534
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
535
|
-
"customElement": true
|
536
|
-
}
|
537
|
-
],
|
538
|
-
"exports": [
|
539
|
-
{
|
540
|
-
"kind": "js",
|
541
|
-
"name": "default",
|
542
|
-
"declaration": {
|
543
|
-
"name": "Appheader",
|
544
|
-
"module": "components/appheader/appheader.component.js"
|
545
|
-
}
|
546
|
-
}
|
547
|
-
]
|
548
|
-
},
|
549
494
|
{
|
550
495
|
"kind": "javascript-module",
|
551
496
|
"path": "components/avatar/avatar.component.js",
|
@@ -1004,8 +949,11 @@
|
|
1004
949
|
{
|
1005
950
|
"kind": "field",
|
1006
951
|
"name": "ariaStateKey",
|
952
|
+
"type": {
|
953
|
+
"text": "string | undefined"
|
954
|
+
},
|
1007
955
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
1008
|
-
"default": "'aria-pressed'",
|
956
|
+
"default": "'aria-pressed' (when)",
|
1009
957
|
"attribute": "ariaStateKey",
|
1010
958
|
"reflects": true,
|
1011
959
|
"inheritedFrom": {
|
@@ -1373,8 +1321,11 @@
|
|
1373
1321
|
},
|
1374
1322
|
{
|
1375
1323
|
"name": "ariaStateKey",
|
1324
|
+
"type": {
|
1325
|
+
"text": "string | undefined"
|
1326
|
+
},
|
1376
1327
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
1377
|
-
"default": "'aria-pressed'",
|
1328
|
+
"default": "'aria-pressed' (when)",
|
1378
1329
|
"fieldName": "ariaStateKey",
|
1379
1330
|
"inheritedFrom": {
|
1380
1331
|
"name": "Buttonsimple",
|
@@ -1746,6 +1697,67 @@
|
|
1746
1697
|
}
|
1747
1698
|
]
|
1748
1699
|
},
|
1700
|
+
{
|
1701
|
+
"kind": "javascript-module",
|
1702
|
+
"path": "components/appheader/appheader.component.js",
|
1703
|
+
"declarations": [
|
1704
|
+
{
|
1705
|
+
"kind": "class",
|
1706
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
1707
|
+
"name": "Appheader",
|
1708
|
+
"cssParts": [
|
1709
|
+
{
|
1710
|
+
"description": "The main container for styling the header.",
|
1711
|
+
"name": "container"
|
1712
|
+
},
|
1713
|
+
{
|
1714
|
+
"description": "The leading section of the header.",
|
1715
|
+
"name": "leading-section"
|
1716
|
+
},
|
1717
|
+
{
|
1718
|
+
"description": "The center section of the header.",
|
1719
|
+
"name": "center-section"
|
1720
|
+
},
|
1721
|
+
{
|
1722
|
+
"description": "The trailing section of the header.",
|
1723
|
+
"name": "trailing-section"
|
1724
|
+
}
|
1725
|
+
],
|
1726
|
+
"slots": [
|
1727
|
+
{
|
1728
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
1729
|
+
"name": "leading"
|
1730
|
+
},
|
1731
|
+
{
|
1732
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
1733
|
+
"name": "center"
|
1734
|
+
},
|
1735
|
+
{
|
1736
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
1737
|
+
"name": "trailing"
|
1738
|
+
}
|
1739
|
+
],
|
1740
|
+
"members": [],
|
1741
|
+
"superclass": {
|
1742
|
+
"name": "Component",
|
1743
|
+
"module": "/src/models"
|
1744
|
+
},
|
1745
|
+
"tagName": "mdc-appheader",
|
1746
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
1747
|
+
"customElement": true
|
1748
|
+
}
|
1749
|
+
],
|
1750
|
+
"exports": [
|
1751
|
+
{
|
1752
|
+
"kind": "js",
|
1753
|
+
"name": "default",
|
1754
|
+
"declaration": {
|
1755
|
+
"name": "Appheader",
|
1756
|
+
"module": "components/appheader/appheader.component.js"
|
1757
|
+
}
|
1758
|
+
}
|
1759
|
+
]
|
1760
|
+
},
|
1749
1761
|
{
|
1750
1762
|
"kind": "javascript-module",
|
1751
1763
|
"path": "components/brandvisual/brandvisual.component.js",
|
@@ -2141,8 +2153,11 @@
|
|
2141
2153
|
{
|
2142
2154
|
"kind": "field",
|
2143
2155
|
"name": "ariaStateKey",
|
2156
|
+
"type": {
|
2157
|
+
"text": "string | undefined"
|
2158
|
+
},
|
2144
2159
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2145
|
-
"default": "'aria-pressed'",
|
2160
|
+
"default": "'aria-pressed' (when)",
|
2146
2161
|
"attribute": "ariaStateKey",
|
2147
2162
|
"reflects": true,
|
2148
2163
|
"inheritedFrom": {
|
@@ -2427,8 +2442,11 @@
|
|
2427
2442
|
},
|
2428
2443
|
{
|
2429
2444
|
"name": "ariaStateKey",
|
2445
|
+
"type": {
|
2446
|
+
"text": "string | undefined"
|
2447
|
+
},
|
2430
2448
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2431
|
-
"default": "'aria-pressed'",
|
2449
|
+
"default": "'aria-pressed' (when)",
|
2432
2450
|
"fieldName": "ariaStateKey",
|
2433
2451
|
"inheritedFrom": {
|
2434
2452
|
"name": "Buttonsimple",
|
@@ -2509,160 +2527,132 @@
|
|
2509
2527
|
},
|
2510
2528
|
{
|
2511
2529
|
"kind": "javascript-module",
|
2512
|
-
"path": "components/
|
2530
|
+
"path": "components/checkbox/checkbox.component.js",
|
2513
2531
|
"declarations": [
|
2514
2532
|
{
|
2515
2533
|
"kind": "class",
|
2516
|
-
"description": "
|
2517
|
-
"name": "
|
2534
|
+
"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.",
|
2535
|
+
"name": "Checkbox",
|
2536
|
+
"cssProperties": [
|
2537
|
+
{
|
2538
|
+
"description": "Allows customization of the background color on hover.",
|
2539
|
+
"name": "--mdc-checkbox-background-color-hover"
|
2540
|
+
},
|
2541
|
+
{
|
2542
|
+
"description": "Border color in high contrast.",
|
2543
|
+
"name": "--mdc-checkbox-border-color"
|
2544
|
+
},
|
2545
|
+
{
|
2546
|
+
"description": "Background color for a selected checkbox.",
|
2547
|
+
"name": "--mdc-checkbox-checked-background-color"
|
2548
|
+
},
|
2549
|
+
{
|
2550
|
+
"description": "Background color for a selected checkbox when hovered.",
|
2551
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
2552
|
+
},
|
2553
|
+
{
|
2554
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2555
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
2556
|
+
},
|
2557
|
+
{
|
2558
|
+
"description": "Background color for a disabled checkbox.",
|
2559
|
+
"name": "--mdc-checkbox-disabled-background-color"
|
2560
|
+
},
|
2561
|
+
{
|
2562
|
+
"description": "Border color for a disabled checkbox.",
|
2563
|
+
"name": "--mdc-checkbox-disabled-border-color"
|
2564
|
+
},
|
2565
|
+
{
|
2566
|
+
"description": "Background color for a disabled, selected checkbox.",
|
2567
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
2568
|
+
},
|
2569
|
+
{
|
2570
|
+
"description": "Icon color for a disabled checkbox.",
|
2571
|
+
"name": "--mdc-checkbox-disabled-icon-color"
|
2572
|
+
},
|
2573
|
+
{
|
2574
|
+
"description": "Background color for an unselected checkbox.",
|
2575
|
+
"name": "--mdc-checkbox-icon-background-color"
|
2576
|
+
},
|
2577
|
+
{
|
2578
|
+
"description": "Default background color for an unselected checkbox.",
|
2579
|
+
"name": "--mdc-checkbox-icon-border-color"
|
2580
|
+
},
|
2581
|
+
{
|
2582
|
+
"description": "Icon color for an unselected checkbox.",
|
2583
|
+
"name": "--mdc-checkbox-icon-color"
|
2584
|
+
},
|
2585
|
+
{
|
2586
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2587
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
2588
|
+
}
|
2589
|
+
],
|
2518
2590
|
"members": [
|
2519
2591
|
{
|
2520
2592
|
"kind": "field",
|
2521
|
-
"name": "
|
2593
|
+
"name": "checked",
|
2522
2594
|
"type": {
|
2523
|
-
"text": "boolean
|
2595
|
+
"text": "boolean"
|
2524
2596
|
},
|
2525
|
-
"
|
2526
|
-
"
|
2527
|
-
"attribute": "
|
2597
|
+
"default": "false",
|
2598
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2599
|
+
"attribute": "checked",
|
2528
2600
|
"reflects": true
|
2529
2601
|
},
|
2530
2602
|
{
|
2531
2603
|
"kind": "field",
|
2532
|
-
"name": "
|
2604
|
+
"name": "indeterminate",
|
2533
2605
|
"type": {
|
2534
|
-
"text": "boolean
|
2606
|
+
"text": "boolean"
|
2535
2607
|
},
|
2536
|
-
"
|
2537
|
-
"
|
2538
|
-
"attribute": "
|
2608
|
+
"default": "false",
|
2609
|
+
"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.",
|
2610
|
+
"attribute": "indeterminate",
|
2611
|
+
"reflects": true
|
2539
2612
|
},
|
2540
2613
|
{
|
2541
2614
|
"kind": "field",
|
2542
|
-
"name": "
|
2615
|
+
"name": "autofocus",
|
2543
2616
|
"type": {
|
2544
|
-
"text": "
|
2617
|
+
"text": "boolean"
|
2545
2618
|
},
|
2546
|
-
"
|
2547
|
-
"
|
2548
|
-
"attribute": "
|
2619
|
+
"default": "false",
|
2620
|
+
"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)",
|
2621
|
+
"attribute": "autofocus",
|
2549
2622
|
"reflects": true
|
2550
2623
|
},
|
2551
2624
|
{
|
2552
|
-
"kind": "
|
2553
|
-
"name": "
|
2554
|
-
"
|
2555
|
-
"
|
2556
|
-
"attribute": "role",
|
2557
|
-
"reflects": true
|
2625
|
+
"kind": "method",
|
2626
|
+
"name": "setFormValue",
|
2627
|
+
"privacy": "private",
|
2628
|
+
"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."
|
2558
2629
|
},
|
2559
2630
|
{
|
2560
|
-
"kind": "
|
2561
|
-
"name": "
|
2562
|
-
"
|
2563
|
-
"
|
2564
|
-
"attribute": "ariaStateKey",
|
2565
|
-
"reflects": true
|
2566
|
-
},
|
2567
|
-
{
|
2568
|
-
"kind": "field",
|
2569
|
-
"name": "type",
|
2570
|
-
"type": {
|
2571
|
-
"text": "ButtonType"
|
2572
|
-
},
|
2573
|
-
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2574
|
-
"default": "button",
|
2575
|
-
"attribute": "type",
|
2576
|
-
"reflects": true
|
2577
|
-
},
|
2578
|
-
{
|
2579
|
-
"kind": "method",
|
2580
|
-
"name": "executeAction",
|
2581
|
-
"privacy": "protected"
|
2582
|
-
},
|
2583
|
-
{
|
2584
|
-
"kind": "method",
|
2585
|
-
"name": "setActive",
|
2586
|
-
"privacy": "protected",
|
2587
|
-
"parameters": [
|
2588
|
-
{
|
2589
|
-
"name": "element",
|
2590
|
-
"type": {
|
2591
|
-
"text": "HTMLElement"
|
2592
|
-
},
|
2593
|
-
"description": "The button element"
|
2594
|
-
},
|
2595
|
-
{
|
2596
|
-
"name": "active",
|
2597
|
-
"optional": true,
|
2598
|
-
"type": {
|
2599
|
-
"text": "boolean"
|
2600
|
-
},
|
2601
|
-
"description": "The active state of the element"
|
2602
|
-
}
|
2603
|
-
],
|
2604
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button."
|
2605
|
-
},
|
2606
|
-
{
|
2607
|
-
"kind": "method",
|
2608
|
-
"name": "setSoftDisabled",
|
2609
|
-
"privacy": "private",
|
2610
|
-
"parameters": [
|
2611
|
-
{
|
2612
|
-
"name": "element",
|
2613
|
-
"type": {
|
2614
|
-
"text": "HTMLElement"
|
2615
|
-
},
|
2616
|
-
"description": "The button element."
|
2617
|
-
},
|
2618
|
-
{
|
2619
|
-
"name": "softDisabled",
|
2620
|
-
"optional": true,
|
2621
|
-
"type": {
|
2622
|
-
"text": "boolean"
|
2623
|
-
},
|
2624
|
-
"description": "The soft-disabled state."
|
2625
|
-
}
|
2626
|
-
],
|
2627
|
-
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
2631
|
+
"kind": "method",
|
2632
|
+
"name": "manageRequired",
|
2633
|
+
"privacy": "private",
|
2634
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
|
2628
2635
|
},
|
2629
2636
|
{
|
2630
2637
|
"kind": "method",
|
2631
|
-
"name": "
|
2638
|
+
"name": "toggleState",
|
2632
2639
|
"privacy": "private",
|
2633
|
-
"
|
2634
|
-
{
|
2635
|
-
"
|
2636
|
-
"type": {
|
2637
|
-
"text": "HTMLElement"
|
2638
|
-
},
|
2639
|
-
"description": "The button element."
|
2640
|
-
},
|
2641
|
-
{
|
2642
|
-
"name": "disabled",
|
2643
|
-
"type": {
|
2644
|
-
"text": "boolean"
|
2645
|
-
},
|
2646
|
-
"description": "The disabled state."
|
2640
|
+
"return": {
|
2641
|
+
"type": {
|
2642
|
+
"text": "void"
|
2647
2643
|
}
|
2648
|
-
|
2649
|
-
"description": "
|
2650
|
-
},
|
2651
|
-
{
|
2652
|
-
"kind": "method",
|
2653
|
-
"name": "triggerClickEvent",
|
2654
|
-
"privacy": "private"
|
2655
|
-
},
|
2656
|
-
{
|
2657
|
-
"kind": "method",
|
2658
|
-
"name": "handleBlur",
|
2659
|
-
"privacy": "private",
|
2660
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
2644
|
+
},
|
2645
|
+
"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."
|
2661
2646
|
},
|
2662
2647
|
{
|
2663
2648
|
"kind": "method",
|
2664
2649
|
"name": "handleKeyDown",
|
2665
2650
|
"privacy": "private",
|
2651
|
+
"return": {
|
2652
|
+
"type": {
|
2653
|
+
"text": "void"
|
2654
|
+
}
|
2655
|
+
},
|
2666
2656
|
"parameters": [
|
2667
2657
|
{
|
2668
2658
|
"name": "event",
|
@@ -2672,724 +2662,829 @@
|
|
2672
2662
|
"description": "The keyboard event."
|
2673
2663
|
}
|
2674
2664
|
],
|
2675
|
-
"description": "Handles the keydown event on the
|
2665
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
2676
2666
|
},
|
2677
2667
|
{
|
2678
2668
|
"kind": "method",
|
2679
|
-
"name": "
|
2680
|
-
"privacy": "
|
2669
|
+
"name": "handleChange",
|
2670
|
+
"privacy": "public",
|
2671
|
+
"return": {
|
2672
|
+
"type": {
|
2673
|
+
"text": "void"
|
2674
|
+
}
|
2675
|
+
},
|
2681
2676
|
"parameters": [
|
2682
2677
|
{
|
2683
2678
|
"name": "event",
|
2684
2679
|
"type": {
|
2685
|
-
"text": "
|
2686
|
-
}
|
2687
|
-
"description": "The keyboard event."
|
2680
|
+
"text": "Event"
|
2681
|
+
}
|
2688
2682
|
}
|
2689
2683
|
],
|
2690
|
-
"description": "
|
2684
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
2691
2685
|
},
|
2692
2686
|
{
|
2693
2687
|
"kind": "field",
|
2694
|
-
"name": "
|
2688
|
+
"name": "renderLabelAndHelperText",
|
2689
|
+
"privacy": "private"
|
2690
|
+
},
|
2691
|
+
{
|
2692
|
+
"kind": "field",
|
2693
|
+
"name": "name",
|
2695
2694
|
"type": {
|
2696
|
-
"text": "
|
2695
|
+
"text": "string"
|
2697
2696
|
},
|
2698
|
-
"default": "
|
2699
|
-
"description": "
|
2700
|
-
"attribute": "
|
2697
|
+
"default": "''",
|
2698
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2699
|
+
"attribute": "name",
|
2701
2700
|
"reflects": true,
|
2702
2701
|
"inheritedFrom": {
|
2703
|
-
"name": "
|
2704
|
-
"module": "utils/mixins/
|
2702
|
+
"name": "FormInternalsMixin",
|
2703
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2705
2704
|
}
|
2706
2705
|
},
|
2707
2706
|
{
|
2708
2707
|
"kind": "field",
|
2709
|
-
"name": "
|
2708
|
+
"name": "value",
|
2710
2709
|
"type": {
|
2711
|
-
"text": "
|
2710
|
+
"text": "string"
|
2712
2711
|
},
|
2713
|
-
"
|
2714
|
-
"
|
2715
|
-
"attribute": "
|
2712
|
+
"default": "''",
|
2713
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2714
|
+
"attribute": "value",
|
2716
2715
|
"reflects": true,
|
2717
2716
|
"inheritedFrom": {
|
2718
|
-
"name": "
|
2719
|
-
"module": "utils/mixins/
|
2717
|
+
"name": "FormInternalsMixin",
|
2718
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2720
2719
|
}
|
2721
|
-
}
|
2722
|
-
],
|
2723
|
-
"events": [
|
2724
|
-
{
|
2725
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2726
|
-
"name": "click",
|
2727
|
-
"reactName": "onClick"
|
2728
|
-
},
|
2729
|
-
{
|
2730
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2731
|
-
"name": "keydown",
|
2732
|
-
"reactName": "onKeyDown"
|
2733
|
-
},
|
2734
|
-
{
|
2735
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2736
|
-
"name": "keyup",
|
2737
|
-
"reactName": "onKeyUp"
|
2738
|
-
},
|
2739
|
-
{
|
2740
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2741
|
-
"name": "focus",
|
2742
|
-
"reactName": "onFocus"
|
2743
|
-
}
|
2744
|
-
],
|
2745
|
-
"attributes": [
|
2746
|
-
{
|
2747
|
-
"name": "active",
|
2748
|
-
"type": {
|
2749
|
-
"text": "boolean | undefined"
|
2750
|
-
},
|
2751
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2752
|
-
"default": "undefined",
|
2753
|
-
"fieldName": "active"
|
2754
2720
|
},
|
2755
2721
|
{
|
2756
|
-
"
|
2722
|
+
"kind": "field",
|
2723
|
+
"name": "validationMessage",
|
2757
2724
|
"type": {
|
2758
|
-
"text": "
|
2725
|
+
"text": "string | undefined"
|
2759
2726
|
},
|
2760
|
-
"description": "
|
2761
|
-
"
|
2762
|
-
"
|
2727
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2728
|
+
"attribute": "validation-message",
|
2729
|
+
"reflects": true,
|
2730
|
+
"inheritedFrom": {
|
2731
|
+
"name": "FormInternalsMixin",
|
2732
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2733
|
+
}
|
2763
2734
|
},
|
2764
2735
|
{
|
2765
|
-
"
|
2736
|
+
"kind": "field",
|
2737
|
+
"name": "validity",
|
2766
2738
|
"type": {
|
2767
|
-
"text": "
|
2739
|
+
"text": "ValidityState"
|
2768
2740
|
},
|
2769
|
-
"
|
2770
|
-
"
|
2771
|
-
|
2772
|
-
|
2773
|
-
|
2774
|
-
"name": "role",
|
2775
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2776
|
-
"default": "button",
|
2777
|
-
"fieldName": "role"
|
2741
|
+
"readonly": true,
|
2742
|
+
"inheritedFrom": {
|
2743
|
+
"name": "FormInternalsMixin",
|
2744
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2745
|
+
}
|
2778
2746
|
},
|
2779
2747
|
{
|
2780
|
-
"
|
2781
|
-
"
|
2782
|
-
"
|
2783
|
-
"
|
2748
|
+
"kind": "field",
|
2749
|
+
"name": "willValidate",
|
2750
|
+
"readonly": true,
|
2751
|
+
"inheritedFrom": {
|
2752
|
+
"name": "FormInternalsMixin",
|
2753
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2754
|
+
}
|
2784
2755
|
},
|
2785
2756
|
{
|
2786
|
-
"
|
2787
|
-
"
|
2788
|
-
|
2757
|
+
"kind": "method",
|
2758
|
+
"name": "setValidity",
|
2759
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
2760
|
+
"return": {
|
2761
|
+
"type": {
|
2762
|
+
"text": ""
|
2763
|
+
}
|
2789
2764
|
},
|
2790
|
-
"
|
2791
|
-
|
2792
|
-
|
2765
|
+
"inheritedFrom": {
|
2766
|
+
"name": "FormInternalsMixin",
|
2767
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2768
|
+
}
|
2793
2769
|
},
|
2794
2770
|
{
|
2795
|
-
"
|
2796
|
-
"
|
2797
|
-
|
2771
|
+
"kind": "method",
|
2772
|
+
"name": "checkValidity",
|
2773
|
+
"return": {
|
2774
|
+
"type": {
|
2775
|
+
"text": "boolean"
|
2776
|
+
}
|
2798
2777
|
},
|
2799
|
-
"default": "0",
|
2800
|
-
"description": "This property specifies the tab order of the element.",
|
2801
|
-
"fieldName": "tabIndex",
|
2802
2778
|
"inheritedFrom": {
|
2803
|
-
"name": "
|
2804
|
-
"module": "
|
2779
|
+
"name": "FormInternalsMixin",
|
2780
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2805
2781
|
}
|
2806
2782
|
},
|
2807
2783
|
{
|
2784
|
+
"kind": "method",
|
2785
|
+
"name": "reportValidity",
|
2786
|
+
"inheritedFrom": {
|
2787
|
+
"name": "FormInternalsMixin",
|
2788
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2789
|
+
}
|
2790
|
+
},
|
2791
|
+
{
|
2792
|
+
"kind": "field",
|
2793
|
+
"name": "dataAriaLabel",
|
2794
|
+
"type": {
|
2795
|
+
"text": "string | null"
|
2796
|
+
},
|
2797
|
+
"default": "null",
|
2798
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2799
|
+
"attribute": "data-aria-label",
|
2800
|
+
"reflects": true,
|
2801
|
+
"inheritedFrom": {
|
2802
|
+
"name": "DataAriaLabelMixin",
|
2803
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
2804
|
+
}
|
2805
|
+
},
|
2806
|
+
{
|
2807
|
+
"kind": "field",
|
2808
2808
|
"name": "disabled",
|
2809
2809
|
"type": {
|
2810
2810
|
"text": "boolean | undefined"
|
2811
2811
|
},
|
2812
2812
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2813
2813
|
"default": "undefined",
|
2814
|
-
"
|
2814
|
+
"attribute": "disabled",
|
2815
|
+
"reflects": true,
|
2815
2816
|
"inheritedFrom": {
|
2816
2817
|
"name": "DisabledMixin",
|
2817
|
-
"module": "
|
2818
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2818
2819
|
}
|
2819
|
-
}
|
2820
|
-
],
|
2821
|
-
"mixins": [
|
2822
|
-
{
|
2823
|
-
"name": "TabIndexMixin",
|
2824
|
-
"module": "/src/utils/mixins/TabIndexMixin"
|
2825
2820
|
},
|
2826
2821
|
{
|
2827
|
-
"
|
2828
|
-
"
|
2829
|
-
|
2830
|
-
|
2831
|
-
|
2832
|
-
|
2833
|
-
|
2834
|
-
|
2835
|
-
|
2836
|
-
|
2837
|
-
|
2838
|
-
|
2839
|
-
],
|
2840
|
-
"exports": [
|
2841
|
-
{
|
2842
|
-
"kind": "js",
|
2843
|
-
"name": "default",
|
2844
|
-
"declaration": {
|
2845
|
-
"name": "Buttonsimple",
|
2846
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2847
|
-
}
|
2848
|
-
}
|
2849
|
-
]
|
2850
|
-
},
|
2851
|
-
{
|
2852
|
-
"kind": "javascript-module",
|
2853
|
-
"path": "components/checkbox/checkbox.component.js",
|
2854
|
-
"declarations": [
|
2855
|
-
{
|
2856
|
-
"kind": "class",
|
2857
|
-
"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.",
|
2858
|
-
"name": "Checkbox",
|
2859
|
-
"cssProperties": [
|
2860
|
-
{
|
2861
|
-
"description": "Allows customization of the background color on hover.",
|
2862
|
-
"name": "--mdc-checkbox-background-color-hover"
|
2822
|
+
"kind": "field",
|
2823
|
+
"name": "label",
|
2824
|
+
"type": {
|
2825
|
+
"text": "string | undefined"
|
2826
|
+
},
|
2827
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2828
|
+
"attribute": "label",
|
2829
|
+
"reflects": true,
|
2830
|
+
"inheritedFrom": {
|
2831
|
+
"name": "FormfieldWrapper",
|
2832
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2833
|
+
}
|
2863
2834
|
},
|
2864
2835
|
{
|
2865
|
-
"
|
2866
|
-
"name": "
|
2836
|
+
"kind": "field",
|
2837
|
+
"name": "requiredLabel",
|
2838
|
+
"type": {
|
2839
|
+
"text": "string | undefined"
|
2840
|
+
},
|
2841
|
+
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
2842
|
+
"attribute": "required-label",
|
2843
|
+
"reflects": true,
|
2844
|
+
"inheritedFrom": {
|
2845
|
+
"name": "FormfieldWrapper",
|
2846
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2847
|
+
}
|
2867
2848
|
},
|
2868
2849
|
{
|
2869
|
-
"
|
2870
|
-
"name": "
|
2850
|
+
"kind": "field",
|
2851
|
+
"name": "id",
|
2852
|
+
"type": {
|
2853
|
+
"text": "string"
|
2854
|
+
},
|
2855
|
+
"default": "''",
|
2856
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2857
|
+
"attribute": "id",
|
2858
|
+
"inheritedFrom": {
|
2859
|
+
"name": "FormfieldWrapper",
|
2860
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2861
|
+
}
|
2871
2862
|
},
|
2872
2863
|
{
|
2873
|
-
"
|
2874
|
-
"name": "
|
2864
|
+
"kind": "field",
|
2865
|
+
"name": "helpTextType",
|
2866
|
+
"type": {
|
2867
|
+
"text": "ValidationType"
|
2868
|
+
},
|
2869
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2870
|
+
"attribute": "help-text-type",
|
2871
|
+
"reflects": true,
|
2872
|
+
"inheritedFrom": {
|
2873
|
+
"name": "FormfieldWrapper",
|
2874
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2875
|
+
}
|
2875
2876
|
},
|
2876
2877
|
{
|
2877
|
-
"
|
2878
|
-
"name": "
|
2878
|
+
"kind": "field",
|
2879
|
+
"name": "helpText",
|
2880
|
+
"type": {
|
2881
|
+
"text": "string | undefined"
|
2882
|
+
},
|
2883
|
+
"description": "The help text that is displayed below the input field.",
|
2884
|
+
"attribute": "help-text",
|
2885
|
+
"reflects": true,
|
2886
|
+
"inheritedFrom": {
|
2887
|
+
"name": "FormfieldWrapper",
|
2888
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2889
|
+
}
|
2879
2890
|
},
|
2880
2891
|
{
|
2881
|
-
"
|
2882
|
-
"name": "
|
2892
|
+
"kind": "method",
|
2893
|
+
"name": "renderLabelElement",
|
2894
|
+
"privacy": "protected",
|
2895
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2896
|
+
"return": {
|
2897
|
+
"type": {
|
2898
|
+
"text": ""
|
2899
|
+
}
|
2900
|
+
},
|
2901
|
+
"inheritedFrom": {
|
2902
|
+
"name": "FormfieldWrapper",
|
2903
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2904
|
+
}
|
2883
2905
|
},
|
2884
2906
|
{
|
2885
|
-
"
|
2886
|
-
"name": "
|
2907
|
+
"kind": "method",
|
2908
|
+
"name": "renderRequiredLabel",
|
2909
|
+
"privacy": "protected",
|
2910
|
+
"inheritedFrom": {
|
2911
|
+
"name": "FormfieldWrapper",
|
2912
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2913
|
+
}
|
2887
2914
|
},
|
2888
2915
|
{
|
2889
|
-
"
|
2890
|
-
"name": "
|
2916
|
+
"kind": "method",
|
2917
|
+
"name": "renderHelpTextIcon",
|
2918
|
+
"privacy": "protected",
|
2919
|
+
"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.",
|
2920
|
+
"return": {
|
2921
|
+
"type": {
|
2922
|
+
"text": ""
|
2923
|
+
}
|
2924
|
+
},
|
2925
|
+
"inheritedFrom": {
|
2926
|
+
"name": "FormfieldWrapper",
|
2927
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2928
|
+
}
|
2891
2929
|
},
|
2892
2930
|
{
|
2893
|
-
"
|
2894
|
-
"name": "
|
2931
|
+
"kind": "method",
|
2932
|
+
"name": "renderHelpText",
|
2933
|
+
"privacy": "protected",
|
2934
|
+
"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.",
|
2935
|
+
"return": {
|
2936
|
+
"type": {
|
2937
|
+
"text": ""
|
2938
|
+
}
|
2939
|
+
},
|
2940
|
+
"inheritedFrom": {
|
2941
|
+
"name": "FormfieldWrapper",
|
2942
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2943
|
+
}
|
2895
2944
|
},
|
2896
2945
|
{
|
2897
|
-
"
|
2898
|
-
"name": "
|
2946
|
+
"kind": "method",
|
2947
|
+
"name": "renderLabel",
|
2948
|
+
"privacy": "protected",
|
2949
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2950
|
+
"return": {
|
2951
|
+
"type": {
|
2952
|
+
"text": ""
|
2953
|
+
}
|
2954
|
+
},
|
2955
|
+
"inheritedFrom": {
|
2956
|
+
"name": "FormfieldWrapper",
|
2957
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2958
|
+
}
|
2899
2959
|
},
|
2900
2960
|
{
|
2901
|
-
"
|
2902
|
-
"name": "
|
2961
|
+
"kind": "method",
|
2962
|
+
"name": "renderHelperText",
|
2963
|
+
"privacy": "protected",
|
2964
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2965
|
+
"return": {
|
2966
|
+
"type": {
|
2967
|
+
"text": ""
|
2968
|
+
}
|
2969
|
+
},
|
2970
|
+
"inheritedFrom": {
|
2971
|
+
"name": "FormfieldWrapper",
|
2972
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2973
|
+
}
|
2974
|
+
}
|
2975
|
+
],
|
2976
|
+
"events": [
|
2977
|
+
{
|
2978
|
+
"type": {
|
2979
|
+
"text": "EventConstructor"
|
2980
|
+
}
|
2903
2981
|
},
|
2904
2982
|
{
|
2905
|
-
"description": "
|
2906
|
-
"name": "
|
2983
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
2984
|
+
"name": "change",
|
2985
|
+
"reactName": "onChange"
|
2907
2986
|
},
|
2908
2987
|
{
|
2909
|
-
"description": "
|
2910
|
-
"name": "
|
2988
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
2989
|
+
"name": "focus",
|
2990
|
+
"reactName": "onFocus"
|
2911
2991
|
}
|
2912
2992
|
],
|
2913
|
-
"
|
2993
|
+
"attributes": [
|
2914
2994
|
{
|
2915
|
-
"kind": "field",
|
2916
2995
|
"name": "checked",
|
2917
2996
|
"type": {
|
2918
2997
|
"text": "boolean"
|
2919
2998
|
},
|
2920
2999
|
"default": "false",
|
2921
3000
|
"description": "Determines whether the checkbox is selected or unselected.",
|
2922
|
-
"
|
2923
|
-
"reflects": true
|
3001
|
+
"fieldName": "checked"
|
2924
3002
|
},
|
2925
3003
|
{
|
2926
|
-
"kind": "field",
|
2927
3004
|
"name": "indeterminate",
|
2928
3005
|
"type": {
|
2929
3006
|
"text": "boolean"
|
2930
3007
|
},
|
2931
3008
|
"default": "false",
|
2932
3009
|
"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.",
|
2933
|
-
"
|
2934
|
-
"reflects": true
|
3010
|
+
"fieldName": "indeterminate"
|
2935
3011
|
},
|
2936
3012
|
{
|
2937
|
-
"kind": "field",
|
2938
3013
|
"name": "autofocus",
|
2939
3014
|
"type": {
|
2940
3015
|
"text": "boolean"
|
2941
3016
|
},
|
2942
3017
|
"default": "false",
|
2943
3018
|
"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)",
|
2944
|
-
"
|
2945
|
-
"reflects": true
|
3019
|
+
"fieldName": "autofocus"
|
2946
3020
|
},
|
2947
3021
|
{
|
2948
|
-
"kind": "method",
|
2949
|
-
"name": "setFormValue",
|
2950
|
-
"privacy": "private",
|
2951
|
-
"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."
|
2952
|
-
},
|
2953
|
-
{
|
2954
|
-
"kind": "method",
|
2955
|
-
"name": "manageRequired",
|
2956
|
-
"privacy": "private",
|
2957
|
-
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
|
2958
|
-
},
|
2959
|
-
{
|
2960
|
-
"kind": "method",
|
2961
|
-
"name": "toggleState",
|
2962
|
-
"privacy": "private",
|
2963
|
-
"return": {
|
2964
|
-
"type": {
|
2965
|
-
"text": "void"
|
2966
|
-
}
|
2967
|
-
},
|
2968
|
-
"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."
|
2969
|
-
},
|
2970
|
-
{
|
2971
|
-
"kind": "method",
|
2972
|
-
"name": "handleKeyDown",
|
2973
|
-
"privacy": "private",
|
2974
|
-
"return": {
|
2975
|
-
"type": {
|
2976
|
-
"text": "void"
|
2977
|
-
}
|
2978
|
-
},
|
2979
|
-
"parameters": [
|
2980
|
-
{
|
2981
|
-
"name": "event",
|
2982
|
-
"type": {
|
2983
|
-
"text": "KeyboardEvent"
|
2984
|
-
},
|
2985
|
-
"description": "The keyboard event."
|
2986
|
-
}
|
2987
|
-
],
|
2988
|
-
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
2989
|
-
},
|
2990
|
-
{
|
2991
|
-
"kind": "method",
|
2992
|
-
"name": "handleChange",
|
2993
|
-
"privacy": "public",
|
2994
|
-
"return": {
|
2995
|
-
"type": {
|
2996
|
-
"text": "void"
|
2997
|
-
}
|
2998
|
-
},
|
2999
|
-
"parameters": [
|
3000
|
-
{
|
3001
|
-
"name": "event",
|
3002
|
-
"type": {
|
3003
|
-
"text": "Event"
|
3004
|
-
}
|
3005
|
-
}
|
3006
|
-
],
|
3007
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
3008
|
-
},
|
3009
|
-
{
|
3010
|
-
"kind": "field",
|
3011
|
-
"name": "renderLabelAndHelperText",
|
3012
|
-
"privacy": "private"
|
3013
|
-
},
|
3014
|
-
{
|
3015
|
-
"kind": "field",
|
3016
3022
|
"name": "name",
|
3017
3023
|
"type": {
|
3018
3024
|
"text": "string"
|
3019
3025
|
},
|
3020
3026
|
"default": "''",
|
3021
3027
|
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
3022
|
-
"
|
3023
|
-
"reflects": true,
|
3028
|
+
"fieldName": "name",
|
3024
3029
|
"inheritedFrom": {
|
3025
3030
|
"name": "FormInternalsMixin",
|
3026
|
-
"module": "utils/mixins/FormInternalsMixin.
|
3031
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
3027
3032
|
}
|
3028
3033
|
},
|
3029
3034
|
{
|
3030
|
-
"kind": "field",
|
3031
3035
|
"name": "value",
|
3032
3036
|
"type": {
|
3033
3037
|
"text": "string"
|
3034
3038
|
},
|
3035
3039
|
"default": "''",
|
3036
3040
|
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
3037
|
-
"
|
3038
|
-
"reflects": true,
|
3041
|
+
"fieldName": "value",
|
3039
3042
|
"inheritedFrom": {
|
3040
3043
|
"name": "FormInternalsMixin",
|
3041
|
-
"module": "utils/mixins/FormInternalsMixin.
|
3044
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
3042
3045
|
}
|
3043
3046
|
},
|
3044
3047
|
{
|
3045
|
-
"
|
3046
|
-
"name": "validationMessage",
|
3048
|
+
"name": "validation-message",
|
3047
3049
|
"type": {
|
3048
3050
|
"text": "string | undefined"
|
3049
3051
|
},
|
3050
3052
|
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
3051
|
-
"
|
3052
|
-
"reflects": true,
|
3053
|
-
"inheritedFrom": {
|
3054
|
-
"name": "FormInternalsMixin",
|
3055
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
3056
|
-
}
|
3057
|
-
},
|
3058
|
-
{
|
3059
|
-
"kind": "field",
|
3060
|
-
"name": "validity",
|
3061
|
-
"type": {
|
3062
|
-
"text": "ValidityState"
|
3063
|
-
},
|
3064
|
-
"readonly": true,
|
3065
|
-
"inheritedFrom": {
|
3066
|
-
"name": "FormInternalsMixin",
|
3067
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
3068
|
-
}
|
3069
|
-
},
|
3070
|
-
{
|
3071
|
-
"kind": "field",
|
3072
|
-
"name": "willValidate",
|
3073
|
-
"readonly": true,
|
3074
|
-
"inheritedFrom": {
|
3075
|
-
"name": "FormInternalsMixin",
|
3076
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
3077
|
-
}
|
3078
|
-
},
|
3079
|
-
{
|
3080
|
-
"kind": "method",
|
3081
|
-
"name": "setValidity",
|
3082
|
-
"description": "Sets the validity of the input field based on the input field's validity.",
|
3083
|
-
"return": {
|
3084
|
-
"type": {
|
3085
|
-
"text": ""
|
3086
|
-
}
|
3087
|
-
},
|
3088
|
-
"inheritedFrom": {
|
3089
|
-
"name": "FormInternalsMixin",
|
3090
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
3091
|
-
}
|
3092
|
-
},
|
3093
|
-
{
|
3094
|
-
"kind": "method",
|
3095
|
-
"name": "checkValidity",
|
3096
|
-
"return": {
|
3097
|
-
"type": {
|
3098
|
-
"text": "boolean"
|
3099
|
-
}
|
3100
|
-
},
|
3101
|
-
"inheritedFrom": {
|
3102
|
-
"name": "FormInternalsMixin",
|
3103
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
3104
|
-
}
|
3105
|
-
},
|
3106
|
-
{
|
3107
|
-
"kind": "method",
|
3108
|
-
"name": "reportValidity",
|
3053
|
+
"fieldName": "validationMessage",
|
3109
3054
|
"inheritedFrom": {
|
3110
3055
|
"name": "FormInternalsMixin",
|
3111
|
-
"module": "utils/mixins/FormInternalsMixin.
|
3056
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
3112
3057
|
}
|
3113
3058
|
},
|
3114
3059
|
{
|
3115
|
-
"
|
3116
|
-
"name": "dataAriaLabel",
|
3060
|
+
"name": "data-aria-label",
|
3117
3061
|
"type": {
|
3118
3062
|
"text": "string | null"
|
3119
3063
|
},
|
3120
3064
|
"default": "null",
|
3121
3065
|
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
3122
|
-
"
|
3123
|
-
"reflects": true,
|
3066
|
+
"fieldName": "dataAriaLabel",
|
3124
3067
|
"inheritedFrom": {
|
3125
3068
|
"name": "DataAriaLabelMixin",
|
3126
|
-
"module": "utils/mixins/DataAriaLabelMixin.
|
3069
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
3127
3070
|
}
|
3128
3071
|
},
|
3129
3072
|
{
|
3130
|
-
"kind": "field",
|
3131
3073
|
"name": "disabled",
|
3132
3074
|
"type": {
|
3133
3075
|
"text": "boolean | undefined"
|
3134
3076
|
},
|
3135
3077
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3136
3078
|
"default": "undefined",
|
3137
|
-
"
|
3138
|
-
"reflects": true,
|
3079
|
+
"fieldName": "disabled",
|
3139
3080
|
"inheritedFrom": {
|
3140
3081
|
"name": "DisabledMixin",
|
3141
|
-
"module": "utils/mixins/DisabledMixin.
|
3082
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
3142
3083
|
}
|
3143
3084
|
},
|
3144
3085
|
{
|
3145
|
-
"kind": "field",
|
3146
3086
|
"name": "label",
|
3147
3087
|
"type": {
|
3148
3088
|
"text": "string | undefined"
|
3149
3089
|
},
|
3150
3090
|
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3151
|
-
"
|
3152
|
-
"reflects": true,
|
3091
|
+
"fieldName": "label",
|
3153
3092
|
"inheritedFrom": {
|
3154
3093
|
"name": "FormfieldWrapper",
|
3155
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
3094
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3156
3095
|
}
|
3157
3096
|
},
|
3158
3097
|
{
|
3159
|
-
"
|
3160
|
-
"name": "requiredLabel",
|
3098
|
+
"name": "required-label",
|
3161
3099
|
"type": {
|
3162
3100
|
"text": "string | undefined"
|
3163
3101
|
},
|
3164
3102
|
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
3165
|
-
"
|
3166
|
-
"reflects": true,
|
3103
|
+
"fieldName": "requiredLabel",
|
3167
3104
|
"inheritedFrom": {
|
3168
3105
|
"name": "FormfieldWrapper",
|
3169
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
3106
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3170
3107
|
}
|
3171
3108
|
},
|
3172
3109
|
{
|
3173
|
-
"kind": "field",
|
3174
3110
|
"name": "id",
|
3175
3111
|
"type": {
|
3176
3112
|
"text": "string"
|
3177
3113
|
},
|
3178
3114
|
"default": "''",
|
3179
3115
|
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3180
|
-
"
|
3116
|
+
"fieldName": "id",
|
3181
3117
|
"inheritedFrom": {
|
3182
3118
|
"name": "FormfieldWrapper",
|
3183
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
3119
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3184
3120
|
}
|
3185
3121
|
},
|
3186
3122
|
{
|
3187
|
-
"
|
3188
|
-
"name": "helpTextType",
|
3123
|
+
"name": "help-text-type",
|
3189
3124
|
"type": {
|
3190
3125
|
"text": "ValidationType"
|
3191
3126
|
},
|
3192
3127
|
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3193
|
-
"
|
3194
|
-
"reflects": true,
|
3128
|
+
"fieldName": "helpTextType",
|
3195
3129
|
"inheritedFrom": {
|
3196
3130
|
"name": "FormfieldWrapper",
|
3197
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
3131
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3198
3132
|
}
|
3199
3133
|
},
|
3200
3134
|
{
|
3201
|
-
"
|
3202
|
-
"name": "helpText",
|
3135
|
+
"name": "help-text",
|
3203
3136
|
"type": {
|
3204
3137
|
"text": "string | undefined"
|
3205
3138
|
},
|
3206
3139
|
"description": "The help text that is displayed below the input field.",
|
3207
|
-
"
|
3208
|
-
"reflects": true,
|
3140
|
+
"fieldName": "helpText",
|
3209
3141
|
"inheritedFrom": {
|
3210
3142
|
"name": "FormfieldWrapper",
|
3211
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
3143
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3212
3144
|
}
|
3145
|
+
}
|
3146
|
+
],
|
3147
|
+
"mixins": [
|
3148
|
+
{
|
3149
|
+
"name": "FormInternalsMixin",
|
3150
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
3213
3151
|
},
|
3214
3152
|
{
|
3215
|
-
"
|
3216
|
-
"
|
3217
|
-
|
3218
|
-
|
3219
|
-
|
3220
|
-
|
3221
|
-
|
3222
|
-
|
3223
|
-
|
3153
|
+
"name": "DataAriaLabelMixin",
|
3154
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
3155
|
+
}
|
3156
|
+
],
|
3157
|
+
"superclass": {
|
3158
|
+
"name": "FormfieldWrapper",
|
3159
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
3160
|
+
},
|
3161
|
+
"tagName": "mdc-checkbox",
|
3162
|
+
"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-icon\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-border-color - Border color in high contrast.\n * @cssproperty --mdc-checkbox-checked-background-color - Background color for a selected checkbox.\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-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-checkbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-color - Icon color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n */",
|
3163
|
+
"customElement": true,
|
3164
|
+
"slots": [
|
3165
|
+
{
|
3166
|
+
"description": "slot to add the label info icon",
|
3167
|
+
"name": "label-info",
|
3224
3168
|
"inheritedFrom": {
|
3225
3169
|
"name": "FormfieldWrapper",
|
3226
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
3170
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3227
3171
|
}
|
3172
|
+
}
|
3173
|
+
]
|
3174
|
+
}
|
3175
|
+
],
|
3176
|
+
"exports": [
|
3177
|
+
{
|
3178
|
+
"kind": "js",
|
3179
|
+
"name": "default",
|
3180
|
+
"declaration": {
|
3181
|
+
"name": "Checkbox",
|
3182
|
+
"module": "components/checkbox/checkbox.component.js"
|
3183
|
+
}
|
3184
|
+
}
|
3185
|
+
]
|
3186
|
+
},
|
3187
|
+
{
|
3188
|
+
"kind": "javascript-module",
|
3189
|
+
"path": "components/buttonsimple/buttonsimple.component.js",
|
3190
|
+
"declarations": [
|
3191
|
+
{
|
3192
|
+
"kind": "class",
|
3193
|
+
"description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
|
3194
|
+
"name": "Buttonsimple",
|
3195
|
+
"members": [
|
3196
|
+
{
|
3197
|
+
"kind": "field",
|
3198
|
+
"name": "active",
|
3199
|
+
"type": {
|
3200
|
+
"text": "boolean | undefined"
|
3201
|
+
},
|
3202
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
3203
|
+
"default": "undefined",
|
3204
|
+
"attribute": "active",
|
3205
|
+
"reflects": true
|
3206
|
+
},
|
3207
|
+
{
|
3208
|
+
"kind": "field",
|
3209
|
+
"name": "softDisabled",
|
3210
|
+
"type": {
|
3211
|
+
"text": "boolean | undefined"
|
3212
|
+
},
|
3213
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
3214
|
+
"default": "undefined",
|
3215
|
+
"attribute": "soft-disabled"
|
3216
|
+
},
|
3217
|
+
{
|
3218
|
+
"kind": "field",
|
3219
|
+
"name": "size",
|
3220
|
+
"type": {
|
3221
|
+
"text": "ButtonSize"
|
3222
|
+
},
|
3223
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
3224
|
+
"default": "32",
|
3225
|
+
"attribute": "size",
|
3226
|
+
"reflects": true
|
3227
|
+
},
|
3228
|
+
{
|
3229
|
+
"kind": "field",
|
3230
|
+
"name": "role",
|
3231
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
3232
|
+
"default": "button",
|
3233
|
+
"attribute": "role",
|
3234
|
+
"reflects": true
|
3235
|
+
},
|
3236
|
+
{
|
3237
|
+
"kind": "field",
|
3238
|
+
"name": "ariaStateKey",
|
3239
|
+
"type": {
|
3240
|
+
"text": "string | undefined"
|
3241
|
+
},
|
3242
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
3243
|
+
"default": "'aria-pressed' (when)",
|
3244
|
+
"attribute": "ariaStateKey",
|
3245
|
+
"reflects": true
|
3246
|
+
},
|
3247
|
+
{
|
3248
|
+
"kind": "field",
|
3249
|
+
"name": "type",
|
3250
|
+
"type": {
|
3251
|
+
"text": "ButtonType"
|
3252
|
+
},
|
3253
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
3254
|
+
"default": "button",
|
3255
|
+
"attribute": "type",
|
3256
|
+
"reflects": true
|
3228
3257
|
},
|
3229
3258
|
{
|
3230
3259
|
"kind": "method",
|
3231
|
-
"name": "
|
3232
|
-
"privacy": "protected"
|
3233
|
-
"inheritedFrom": {
|
3234
|
-
"name": "FormfieldWrapper",
|
3235
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3236
|
-
}
|
3260
|
+
"name": "executeAction",
|
3261
|
+
"privacy": "protected"
|
3237
3262
|
},
|
3238
3263
|
{
|
3239
3264
|
"kind": "method",
|
3240
|
-
"name": "
|
3265
|
+
"name": "setActive",
|
3241
3266
|
"privacy": "protected",
|
3242
|
-
"
|
3243
|
-
|
3244
|
-
|
3245
|
-
"
|
3267
|
+
"parameters": [
|
3268
|
+
{
|
3269
|
+
"name": "element",
|
3270
|
+
"type": {
|
3271
|
+
"text": "HTMLElement"
|
3272
|
+
},
|
3273
|
+
"description": "The button element"
|
3274
|
+
},
|
3275
|
+
{
|
3276
|
+
"name": "active",
|
3277
|
+
"optional": true,
|
3278
|
+
"type": {
|
3279
|
+
"text": "boolean"
|
3280
|
+
},
|
3281
|
+
"description": "The active state of the element"
|
3246
3282
|
}
|
3247
|
-
|
3248
|
-
"
|
3249
|
-
"name": "FormfieldWrapper",
|
3250
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3251
|
-
}
|
3283
|
+
],
|
3284
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button."
|
3252
3285
|
},
|
3253
3286
|
{
|
3254
3287
|
"kind": "method",
|
3255
|
-
"name": "
|
3256
|
-
"privacy": "
|
3257
|
-
"
|
3258
|
-
|
3259
|
-
|
3260
|
-
"
|
3288
|
+
"name": "setSoftDisabled",
|
3289
|
+
"privacy": "private",
|
3290
|
+
"parameters": [
|
3291
|
+
{
|
3292
|
+
"name": "element",
|
3293
|
+
"type": {
|
3294
|
+
"text": "HTMLElement"
|
3295
|
+
},
|
3296
|
+
"description": "The button element."
|
3297
|
+
},
|
3298
|
+
{
|
3299
|
+
"name": "softDisabled",
|
3300
|
+
"optional": true,
|
3301
|
+
"type": {
|
3302
|
+
"text": "boolean"
|
3303
|
+
},
|
3304
|
+
"description": "The soft-disabled state."
|
3261
3305
|
}
|
3262
|
-
|
3263
|
-
"
|
3264
|
-
|
3265
|
-
|
3266
|
-
|
3306
|
+
],
|
3307
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
3308
|
+
},
|
3309
|
+
{
|
3310
|
+
"kind": "method",
|
3311
|
+
"name": "setDisabled",
|
3312
|
+
"privacy": "private",
|
3313
|
+
"parameters": [
|
3314
|
+
{
|
3315
|
+
"name": "element",
|
3316
|
+
"type": {
|
3317
|
+
"text": "HTMLElement"
|
3318
|
+
},
|
3319
|
+
"description": "The button element."
|
3320
|
+
},
|
3321
|
+
{
|
3322
|
+
"name": "disabled",
|
3323
|
+
"type": {
|
3324
|
+
"text": "boolean"
|
3325
|
+
},
|
3326
|
+
"description": "The disabled state."
|
3327
|
+
}
|
3328
|
+
],
|
3329
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute."
|
3330
|
+
},
|
3331
|
+
{
|
3332
|
+
"kind": "method",
|
3333
|
+
"name": "triggerClickEvent",
|
3334
|
+
"privacy": "private"
|
3335
|
+
},
|
3336
|
+
{
|
3337
|
+
"kind": "method",
|
3338
|
+
"name": "handleBlur",
|
3339
|
+
"privacy": "private",
|
3340
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
3341
|
+
},
|
3342
|
+
{
|
3343
|
+
"kind": "method",
|
3344
|
+
"name": "handleKeyDown",
|
3345
|
+
"privacy": "private",
|
3346
|
+
"parameters": [
|
3347
|
+
{
|
3348
|
+
"name": "event",
|
3349
|
+
"type": {
|
3350
|
+
"text": "KeyboardEvent"
|
3351
|
+
},
|
3352
|
+
"description": "The keyboard event."
|
3353
|
+
}
|
3354
|
+
],
|
3355
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application."
|
3356
|
+
},
|
3357
|
+
{
|
3358
|
+
"kind": "method",
|
3359
|
+
"name": "handleKeyUp",
|
3360
|
+
"privacy": "private",
|
3361
|
+
"parameters": [
|
3362
|
+
{
|
3363
|
+
"name": "event",
|
3364
|
+
"type": {
|
3365
|
+
"text": "KeyboardEvent"
|
3366
|
+
},
|
3367
|
+
"description": "The keyboard event."
|
3368
|
+
}
|
3369
|
+
],
|
3370
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
|
3267
3371
|
},
|
3268
3372
|
{
|
3269
|
-
"kind": "
|
3270
|
-
"name": "
|
3271
|
-
"
|
3272
|
-
|
3273
|
-
"return": {
|
3274
|
-
"type": {
|
3275
|
-
"text": ""
|
3276
|
-
}
|
3373
|
+
"kind": "field",
|
3374
|
+
"name": "tabIndex",
|
3375
|
+
"type": {
|
3376
|
+
"text": "number"
|
3277
3377
|
},
|
3378
|
+
"default": "0",
|
3379
|
+
"description": "This property specifies the tab order of the element.",
|
3380
|
+
"attribute": "tabIndex",
|
3381
|
+
"reflects": true,
|
3278
3382
|
"inheritedFrom": {
|
3279
|
-
"name": "
|
3280
|
-
"module": "
|
3383
|
+
"name": "TabIndexMixin",
|
3384
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
3281
3385
|
}
|
3282
3386
|
},
|
3283
3387
|
{
|
3284
|
-
"kind": "
|
3285
|
-
"name": "
|
3286
|
-
"
|
3287
|
-
|
3288
|
-
"return": {
|
3289
|
-
"type": {
|
3290
|
-
"text": ""
|
3291
|
-
}
|
3388
|
+
"kind": "field",
|
3389
|
+
"name": "disabled",
|
3390
|
+
"type": {
|
3391
|
+
"text": "boolean | undefined"
|
3292
3392
|
},
|
3393
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3394
|
+
"default": "undefined",
|
3395
|
+
"attribute": "disabled",
|
3396
|
+
"reflects": true,
|
3293
3397
|
"inheritedFrom": {
|
3294
|
-
"name": "
|
3295
|
-
"module": "
|
3398
|
+
"name": "DisabledMixin",
|
3399
|
+
"module": "utils/mixins/DisabledMixin.js"
|
3296
3400
|
}
|
3297
3401
|
}
|
3298
3402
|
],
|
3299
3403
|
"events": [
|
3300
3404
|
{
|
3301
|
-
"
|
3302
|
-
|
3303
|
-
|
3405
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
3406
|
+
"name": "click",
|
3407
|
+
"reactName": "onClick"
|
3304
3408
|
},
|
3305
3409
|
{
|
3306
|
-
"description": "(React:
|
3307
|
-
"name": "
|
3308
|
-
"reactName": "
|
3410
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
3411
|
+
"name": "keydown",
|
3412
|
+
"reactName": "onKeyDown"
|
3309
3413
|
},
|
3310
3414
|
{
|
3311
|
-
"description": "(React:
|
3415
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
3416
|
+
"name": "keyup",
|
3417
|
+
"reactName": "onKeyUp"
|
3418
|
+
},
|
3419
|
+
{
|
3420
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
3312
3421
|
"name": "focus",
|
3313
3422
|
"reactName": "onFocus"
|
3314
3423
|
}
|
3315
3424
|
],
|
3316
3425
|
"attributes": [
|
3317
3426
|
{
|
3318
|
-
"name": "
|
3427
|
+
"name": "active",
|
3319
3428
|
"type": {
|
3320
|
-
"text": "boolean"
|
3429
|
+
"text": "boolean | undefined"
|
3321
3430
|
},
|
3322
|
-
"
|
3323
|
-
"
|
3324
|
-
"fieldName": "
|
3431
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
3432
|
+
"default": "undefined",
|
3433
|
+
"fieldName": "active"
|
3325
3434
|
},
|
3326
3435
|
{
|
3327
|
-
"name": "
|
3436
|
+
"name": "soft-disabled",
|
3328
3437
|
"type": {
|
3329
|
-
"text": "boolean"
|
3438
|
+
"text": "boolean | undefined"
|
3330
3439
|
},
|
3331
|
-
"
|
3332
|
-
"
|
3333
|
-
"fieldName": "
|
3440
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
3441
|
+
"default": "undefined",
|
3442
|
+
"fieldName": "softDisabled"
|
3334
3443
|
},
|
3335
3444
|
{
|
3336
|
-
"name": "
|
3445
|
+
"name": "size",
|
3337
3446
|
"type": {
|
3338
|
-
"text": "
|
3447
|
+
"text": "ButtonSize"
|
3339
3448
|
},
|
3340
|
-
"
|
3341
|
-
"
|
3342
|
-
"fieldName": "
|
3449
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
3450
|
+
"default": "32",
|
3451
|
+
"fieldName": "size"
|
3343
3452
|
},
|
3344
3453
|
{
|
3345
|
-
"name": "
|
3346
|
-
"
|
3347
|
-
|
3348
|
-
|
3349
|
-
"default": "''",
|
3350
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
3351
|
-
"fieldName": "name",
|
3352
|
-
"inheritedFrom": {
|
3353
|
-
"name": "FormInternalsMixin",
|
3354
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
3355
|
-
}
|
3454
|
+
"name": "role",
|
3455
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
3456
|
+
"default": "button",
|
3457
|
+
"fieldName": "role"
|
3356
3458
|
},
|
3357
3459
|
{
|
3358
|
-
"name": "
|
3460
|
+
"name": "ariaStateKey",
|
3359
3461
|
"type": {
|
3360
|
-
"text": "string"
|
3462
|
+
"text": "string | undefined"
|
3361
3463
|
},
|
3362
|
-
"
|
3363
|
-
"
|
3364
|
-
"fieldName": "
|
3365
|
-
"inheritedFrom": {
|
3366
|
-
"name": "FormInternalsMixin",
|
3367
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
3368
|
-
}
|
3464
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
3465
|
+
"default": "'aria-pressed' (when)",
|
3466
|
+
"fieldName": "ariaStateKey"
|
3369
3467
|
},
|
3370
3468
|
{
|
3371
|
-
"name": "
|
3469
|
+
"name": "type",
|
3372
3470
|
"type": {
|
3373
|
-
"text": "
|
3471
|
+
"text": "ButtonType"
|
3374
3472
|
},
|
3375
|
-
"description": "
|
3376
|
-
"
|
3377
|
-
"
|
3378
|
-
"name": "FormInternalsMixin",
|
3379
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
3380
|
-
}
|
3473
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
3474
|
+
"default": "button",
|
3475
|
+
"fieldName": "type"
|
3381
3476
|
},
|
3382
3477
|
{
|
3383
|
-
"name": "
|
3478
|
+
"name": "tabIndex",
|
3384
3479
|
"type": {
|
3385
|
-
"text": "
|
3480
|
+
"text": "number"
|
3386
3481
|
},
|
3387
|
-
"default": "
|
3388
|
-
"description": "
|
3389
|
-
"fieldName": "
|
3482
|
+
"default": "0",
|
3483
|
+
"description": "This property specifies the tab order of the element.",
|
3484
|
+
"fieldName": "tabIndex",
|
3390
3485
|
"inheritedFrom": {
|
3391
|
-
"name": "
|
3392
|
-
"module": "src/utils/mixins/
|
3486
|
+
"name": "TabIndexMixin",
|
3487
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
3393
3488
|
}
|
3394
3489
|
},
|
3395
3490
|
{
|
@@ -3404,96 +3499,25 @@
|
|
3404
3499
|
"name": "DisabledMixin",
|
3405
3500
|
"module": "src/utils/mixins/DisabledMixin.ts"
|
3406
3501
|
}
|
3407
|
-
},
|
3408
|
-
{
|
3409
|
-
"name": "label",
|
3410
|
-
"type": {
|
3411
|
-
"text": "string | undefined"
|
3412
|
-
},
|
3413
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3414
|
-
"fieldName": "label",
|
3415
|
-
"inheritedFrom": {
|
3416
|
-
"name": "FormfieldWrapper",
|
3417
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3418
|
-
}
|
3419
|
-
},
|
3420
|
-
{
|
3421
|
-
"name": "required-label",
|
3422
|
-
"type": {
|
3423
|
-
"text": "string | undefined"
|
3424
|
-
},
|
3425
|
-
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
3426
|
-
"fieldName": "requiredLabel",
|
3427
|
-
"inheritedFrom": {
|
3428
|
-
"name": "FormfieldWrapper",
|
3429
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3430
|
-
}
|
3431
|
-
},
|
3432
|
-
{
|
3433
|
-
"name": "id",
|
3434
|
-
"type": {
|
3435
|
-
"text": "string"
|
3436
|
-
},
|
3437
|
-
"default": "''",
|
3438
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3439
|
-
"fieldName": "id",
|
3440
|
-
"inheritedFrom": {
|
3441
|
-
"name": "FormfieldWrapper",
|
3442
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3443
|
-
}
|
3444
|
-
},
|
3445
|
-
{
|
3446
|
-
"name": "help-text-type",
|
3447
|
-
"type": {
|
3448
|
-
"text": "ValidationType"
|
3449
|
-
},
|
3450
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3451
|
-
"fieldName": "helpTextType",
|
3452
|
-
"inheritedFrom": {
|
3453
|
-
"name": "FormfieldWrapper",
|
3454
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3455
|
-
}
|
3456
|
-
},
|
3457
|
-
{
|
3458
|
-
"name": "help-text",
|
3459
|
-
"type": {
|
3460
|
-
"text": "string | undefined"
|
3461
|
-
},
|
3462
|
-
"description": "The help text that is displayed below the input field.",
|
3463
|
-
"fieldName": "helpText",
|
3464
|
-
"inheritedFrom": {
|
3465
|
-
"name": "FormfieldWrapper",
|
3466
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3467
|
-
}
|
3468
3502
|
}
|
3469
3503
|
],
|
3470
3504
|
"mixins": [
|
3471
3505
|
{
|
3472
|
-
"name": "
|
3473
|
-
"module": "/src/utils/mixins/
|
3506
|
+
"name": "TabIndexMixin",
|
3507
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
3474
3508
|
},
|
3475
3509
|
{
|
3476
|
-
"name": "
|
3477
|
-
"module": "/src/utils/mixins/
|
3510
|
+
"name": "DisabledMixin",
|
3511
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
3478
3512
|
}
|
3479
3513
|
],
|
3480
3514
|
"superclass": {
|
3481
|
-
"name": "
|
3482
|
-
"module": "/src/
|
3515
|
+
"name": "Component",
|
3516
|
+
"module": "/src/models"
|
3483
3517
|
},
|
3484
|
-
"tagName": "mdc-
|
3485
|
-
"jsDoc": "/**\n *
|
3486
|
-
"customElement": true
|
3487
|
-
"slots": [
|
3488
|
-
{
|
3489
|
-
"description": "slot to add the label info icon",
|
3490
|
-
"name": "label-info",
|
3491
|
-
"inheritedFrom": {
|
3492
|
-
"name": "FormfieldWrapper",
|
3493
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3494
|
-
}
|
3495
|
-
}
|
3496
|
-
]
|
3518
|
+
"tagName": "mdc-buttonsimple",
|
3519
|
+
"jsDoc": "/**\n * `mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\n * It is used as an internal component and is not intended to be used directly by consumers.\n * Consumers should use the `mdc-button` component instead.\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-buttonsimple\n */",
|
3520
|
+
"customElement": true
|
3497
3521
|
}
|
3498
3522
|
],
|
3499
3523
|
"exports": [
|
@@ -3501,8 +3525,8 @@
|
|
3501
3525
|
"kind": "js",
|
3502
3526
|
"name": "default",
|
3503
3527
|
"declaration": {
|
3504
|
-
"name": "
|
3505
|
-
"module": "components/
|
3528
|
+
"name": "Buttonsimple",
|
3529
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3506
3530
|
}
|
3507
3531
|
}
|
3508
3532
|
]
|
@@ -3664,8 +3688,11 @@
|
|
3664
3688
|
{
|
3665
3689
|
"kind": "field",
|
3666
3690
|
"name": "ariaStateKey",
|
3691
|
+
"type": {
|
3692
|
+
"text": "string | undefined"
|
3693
|
+
},
|
3667
3694
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
3668
|
-
"default": "'aria-pressed'",
|
3695
|
+
"default": "'aria-pressed' (when)",
|
3669
3696
|
"attribute": "ariaStateKey",
|
3670
3697
|
"reflects": true,
|
3671
3698
|
"inheritedFrom": {
|
@@ -3943,8 +3970,11 @@
|
|
3943
3970
|
},
|
3944
3971
|
{
|
3945
3972
|
"name": "ariaStateKey",
|
3973
|
+
"type": {
|
3974
|
+
"text": "string | undefined"
|
3975
|
+
},
|
3946
3976
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
3947
|
-
"default": "'aria-pressed'",
|
3977
|
+
"default": "'aria-pressed' (when)",
|
3948
3978
|
"fieldName": "ariaStateKey",
|
3949
3979
|
"inheritedFrom": {
|
3950
3980
|
"name": "Buttonsimple",
|
@@ -6077,8 +6107,11 @@
|
|
6077
6107
|
{
|
6078
6108
|
"kind": "field",
|
6079
6109
|
"name": "ariaStateKey",
|
6110
|
+
"type": {
|
6111
|
+
"text": "string | undefined"
|
6112
|
+
},
|
6080
6113
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
6081
|
-
"default": "'aria-pressed'",
|
6114
|
+
"default": "'aria-pressed' (when)",
|
6082
6115
|
"attribute": "ariaStateKey",
|
6083
6116
|
"reflects": true,
|
6084
6117
|
"inheritedFrom": {
|
@@ -6364,8 +6397,11 @@
|
|
6364
6397
|
},
|
6365
6398
|
{
|
6366
6399
|
"name": "ariaStateKey",
|
6400
|
+
"type": {
|
6401
|
+
"text": "string | undefined"
|
6402
|
+
},
|
6367
6403
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
6368
|
-
"default": "'aria-pressed'",
|
6404
|
+
"default": "'aria-pressed' (when)",
|
6369
6405
|
"fieldName": "ariaStateKey",
|
6370
6406
|
"inheritedFrom": {
|
6371
6407
|
"name": "Buttonsimple",
|
@@ -16722,8 +16758,11 @@
|
|
16722
16758
|
{
|
16723
16759
|
"kind": "field",
|
16724
16760
|
"name": "ariaStateKey",
|
16761
|
+
"type": {
|
16762
|
+
"text": "string | undefined"
|
16763
|
+
},
|
16725
16764
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
16726
|
-
"default": "'aria-pressed'",
|
16765
|
+
"default": "'aria-pressed' (when)",
|
16727
16766
|
"attribute": "ariaStateKey",
|
16728
16767
|
"reflects": true,
|
16729
16768
|
"inheritedFrom": {
|
@@ -17016,8 +17055,11 @@
|
|
17016
17055
|
},
|
17017
17056
|
{
|
17018
17057
|
"name": "ariaStateKey",
|
17058
|
+
"type": {
|
17059
|
+
"text": "string | undefined"
|
17060
|
+
},
|
17019
17061
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
17020
|
-
"default": "'aria-pressed'",
|
17062
|
+
"default": "'aria-pressed' (when)",
|
17021
17063
|
"fieldName": "ariaStateKey",
|
17022
17064
|
"inheritedFrom": {
|
17023
17065
|
"name": "Buttonsimple",
|