@momentum-design/components 0.53.8 → 0.54.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 +433 -406
- package/dist/browser/index.js.map +4 -4
- package/dist/components/checkbox/checkbox.component.d.ts +1 -9
- package/dist/components/checkbox/checkbox.component.js +7 -21
- package/dist/components/checkbox/checkbox.styles.js +30 -67
- package/dist/components/checkbox/index.d.ts +1 -0
- package/dist/components/checkbox/index.js +1 -0
- package/dist/components/link/link.component.d.ts +29 -18
- package/dist/components/link/link.component.js +67 -39
- package/dist/components/link/link.styles.js +34 -48
- package/dist/components/link/link.types.d.ts +7 -1
- package/dist/components/radio/index.d.ts +1 -0
- package/dist/components/radio/index.js +1 -0
- package/dist/components/radio/radio.component.d.ts +3 -11
- package/dist/components/radio/radio.component.js +10 -16
- package/dist/components/radio/radio.styles.js +36 -111
- package/dist/components/staticcheckbox/index.d.ts +8 -0
- package/dist/components/staticcheckbox/index.js +5 -0
- package/dist/components/staticcheckbox/staticcheckbox.component.d.ts +42 -0
- package/dist/components/staticcheckbox/staticcheckbox.component.js +76 -0
- package/dist/components/staticcheckbox/staticcheckbox.constants.d.ts +3 -0
- package/dist/components/staticcheckbox/staticcheckbox.constants.js +4 -0
- package/dist/components/staticcheckbox/staticcheckbox.styles.d.ts +2 -0
- package/dist/components/staticcheckbox/staticcheckbox.styles.js +60 -0
- package/dist/components/staticradio/index.d.ts +7 -0
- package/dist/components/staticradio/index.js +4 -0
- package/dist/components/staticradio/staticradio.component.d.ts +41 -0
- package/dist/components/staticradio/staticradio.component.js +67 -0
- package/dist/components/staticradio/staticradio.constants.d.ts +2 -0
- package/dist/components/staticradio/staticradio.constants.js +3 -0
- package/dist/components/staticradio/staticradio.styles.d.ts +2 -0
- package/dist/components/staticradio/staticradio.styles.js +86 -0
- package/dist/custom-elements.json +1838 -1491
- package/dist/index.d.ts +3 -1
- package/dist/index.js +3 -1
- package/dist/react/checkbox/index.d.ts +1 -9
- package/dist/react/checkbox/index.js +1 -9
- package/dist/react/index.d.ts +4 -2
- package/dist/react/index.js +4 -2
- package/dist/react/link/index.d.ts +13 -3
- package/dist/react/link/index.js +12 -3
- package/dist/react/radio/index.d.ts +3 -11
- package/dist/react/radio/index.js +3 -11
- package/dist/react/staticcheckbox/index.d.ts +25 -0
- package/dist/react/staticcheckbox/index.js +34 -0
- package/dist/react/staticradio/index.d.ts +24 -0
- package/dist/react/staticradio/index.js +33 -0
- package/package.json +1 -1
@@ -491,6 +491,67 @@
|
|
491
491
|
}
|
492
492
|
]
|
493
493
|
},
|
494
|
+
{
|
495
|
+
"kind": "javascript-module",
|
496
|
+
"path": "components/appheader/appheader.component.js",
|
497
|
+
"declarations": [
|
498
|
+
{
|
499
|
+
"kind": "class",
|
500
|
+
"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**.",
|
501
|
+
"name": "Appheader",
|
502
|
+
"cssParts": [
|
503
|
+
{
|
504
|
+
"description": "The main container for styling the header.",
|
505
|
+
"name": "container"
|
506
|
+
},
|
507
|
+
{
|
508
|
+
"description": "The leading section of the header.",
|
509
|
+
"name": "leading-section"
|
510
|
+
},
|
511
|
+
{
|
512
|
+
"description": "The center section of the header.",
|
513
|
+
"name": "center-section"
|
514
|
+
},
|
515
|
+
{
|
516
|
+
"description": "The trailing section of the header.",
|
517
|
+
"name": "trailing-section"
|
518
|
+
}
|
519
|
+
],
|
520
|
+
"slots": [
|
521
|
+
{
|
522
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
523
|
+
"name": "leading"
|
524
|
+
},
|
525
|
+
{
|
526
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
527
|
+
"name": "center"
|
528
|
+
},
|
529
|
+
{
|
530
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
531
|
+
"name": "trailing"
|
532
|
+
}
|
533
|
+
],
|
534
|
+
"members": [],
|
535
|
+
"superclass": {
|
536
|
+
"name": "Component",
|
537
|
+
"module": "/src/models"
|
538
|
+
},
|
539
|
+
"tagName": "mdc-appheader",
|
540
|
+
"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 */",
|
541
|
+
"customElement": true
|
542
|
+
}
|
543
|
+
],
|
544
|
+
"exports": [
|
545
|
+
{
|
546
|
+
"kind": "js",
|
547
|
+
"name": "default",
|
548
|
+
"declaration": {
|
549
|
+
"name": "Appheader",
|
550
|
+
"module": "components/appheader/appheader.component.js"
|
551
|
+
}
|
552
|
+
}
|
553
|
+
]
|
554
|
+
},
|
494
555
|
{
|
495
556
|
"kind": "javascript-module",
|
496
557
|
"path": "components/avatar/avatar.component.js",
|
@@ -1697,67 +1758,6 @@
|
|
1697
1758
|
}
|
1698
1759
|
]
|
1699
1760
|
},
|
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
|
-
},
|
1761
1761
|
{
|
1762
1762
|
"kind": "javascript-module",
|
1763
1763
|
"path": "components/brandvisual/brandvisual.component.js",
|
@@ -2527,132 +2527,163 @@
|
|
2527
2527
|
},
|
2528
2528
|
{
|
2529
2529
|
"kind": "javascript-module",
|
2530
|
-
"path": "components/
|
2530
|
+
"path": "components/buttonsimple/buttonsimple.component.js",
|
2531
2531
|
"declarations": [
|
2532
2532
|
{
|
2533
2533
|
"kind": "class",
|
2534
|
-
"description": "
|
2535
|
-
"name": "
|
2536
|
-
"
|
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
|
-
},
|
2534
|
+
"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.",
|
2535
|
+
"name": "Buttonsimple",
|
2536
|
+
"members": [
|
2577
2537
|
{
|
2578
|
-
"
|
2579
|
-
"name": "
|
2538
|
+
"kind": "field",
|
2539
|
+
"name": "active",
|
2540
|
+
"type": {
|
2541
|
+
"text": "boolean | undefined"
|
2542
|
+
},
|
2543
|
+
"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.",
|
2544
|
+
"default": "undefined",
|
2545
|
+
"attribute": "active",
|
2546
|
+
"reflects": true
|
2580
2547
|
},
|
2581
2548
|
{
|
2582
|
-
"
|
2583
|
-
"name": "
|
2549
|
+
"kind": "field",
|
2550
|
+
"name": "softDisabled",
|
2551
|
+
"type": {
|
2552
|
+
"text": "boolean | undefined"
|
2553
|
+
},
|
2554
|
+
"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.",
|
2555
|
+
"default": "undefined",
|
2556
|
+
"attribute": "soft-disabled"
|
2584
2557
|
},
|
2585
|
-
{
|
2586
|
-
"description": "Background color for a selected checkbox when pressed.",
|
2587
|
-
"name": "--mdc-checkbox-pressed-icon-color"
|
2588
|
-
}
|
2589
|
-
],
|
2590
|
-
"members": [
|
2591
2558
|
{
|
2592
2559
|
"kind": "field",
|
2593
|
-
"name": "
|
2560
|
+
"name": "size",
|
2594
2561
|
"type": {
|
2595
|
-
"text": "
|
2562
|
+
"text": "ButtonSize"
|
2596
2563
|
},
|
2597
|
-
"
|
2598
|
-
"
|
2599
|
-
"attribute": "
|
2564
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2565
|
+
"default": "32",
|
2566
|
+
"attribute": "size",
|
2600
2567
|
"reflects": true
|
2601
2568
|
},
|
2602
2569
|
{
|
2603
2570
|
"kind": "field",
|
2604
|
-
"name": "
|
2571
|
+
"name": "role",
|
2572
|
+
"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.",
|
2573
|
+
"default": "button",
|
2574
|
+
"attribute": "role",
|
2575
|
+
"reflects": true
|
2576
|
+
},
|
2577
|
+
{
|
2578
|
+
"kind": "field",
|
2579
|
+
"name": "ariaStateKey",
|
2605
2580
|
"type": {
|
2606
|
-
"text": "
|
2581
|
+
"text": "string | undefined"
|
2607
2582
|
},
|
2608
|
-
"
|
2609
|
-
"
|
2610
|
-
"attribute": "
|
2583
|
+
"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`",
|
2584
|
+
"default": "'aria-pressed' (when)",
|
2585
|
+
"attribute": "ariaStateKey",
|
2611
2586
|
"reflects": true
|
2612
2587
|
},
|
2613
2588
|
{
|
2614
2589
|
"kind": "field",
|
2615
|
-
"name": "
|
2590
|
+
"name": "type",
|
2616
2591
|
"type": {
|
2617
|
-
"text": "
|
2592
|
+
"text": "ButtonType"
|
2618
2593
|
},
|
2619
|
-
"
|
2620
|
-
"
|
2621
|
-
"attribute": "
|
2594
|
+
"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.",
|
2595
|
+
"default": "button",
|
2596
|
+
"attribute": "type",
|
2622
2597
|
"reflects": true
|
2623
2598
|
},
|
2624
2599
|
{
|
2625
2600
|
"kind": "method",
|
2626
|
-
"name": "
|
2627
|
-
"privacy": "
|
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."
|
2601
|
+
"name": "executeAction",
|
2602
|
+
"privacy": "protected"
|
2629
2603
|
},
|
2630
2604
|
{
|
2631
2605
|
"kind": "method",
|
2632
|
-
"name": "
|
2633
|
-
"privacy": "
|
2634
|
-
"
|
2606
|
+
"name": "setActive",
|
2607
|
+
"privacy": "protected",
|
2608
|
+
"parameters": [
|
2609
|
+
{
|
2610
|
+
"name": "element",
|
2611
|
+
"type": {
|
2612
|
+
"text": "HTMLElement"
|
2613
|
+
},
|
2614
|
+
"description": "The button element"
|
2615
|
+
},
|
2616
|
+
{
|
2617
|
+
"name": "active",
|
2618
|
+
"optional": true,
|
2619
|
+
"type": {
|
2620
|
+
"text": "boolean"
|
2621
|
+
},
|
2622
|
+
"description": "The active state of the element"
|
2623
|
+
}
|
2624
|
+
],
|
2625
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button."
|
2635
2626
|
},
|
2636
2627
|
{
|
2637
2628
|
"kind": "method",
|
2638
|
-
"name": "
|
2629
|
+
"name": "setSoftDisabled",
|
2639
2630
|
"privacy": "private",
|
2640
|
-
"
|
2641
|
-
|
2642
|
-
"
|
2631
|
+
"parameters": [
|
2632
|
+
{
|
2633
|
+
"name": "element",
|
2634
|
+
"type": {
|
2635
|
+
"text": "HTMLElement"
|
2636
|
+
},
|
2637
|
+
"description": "The button element."
|
2638
|
+
},
|
2639
|
+
{
|
2640
|
+
"name": "softDisabled",
|
2641
|
+
"optional": true,
|
2642
|
+
"type": {
|
2643
|
+
"text": "boolean"
|
2644
|
+
},
|
2645
|
+
"description": "The soft-disabled state."
|
2643
2646
|
}
|
2644
|
-
|
2645
|
-
"description": "
|
2647
|
+
],
|
2648
|
+
"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."
|
2646
2649
|
},
|
2647
2650
|
{
|
2648
2651
|
"kind": "method",
|
2649
|
-
"name": "
|
2652
|
+
"name": "setDisabled",
|
2650
2653
|
"privacy": "private",
|
2651
|
-
"
|
2652
|
-
|
2653
|
-
"
|
2654
|
+
"parameters": [
|
2655
|
+
{
|
2656
|
+
"name": "element",
|
2657
|
+
"type": {
|
2658
|
+
"text": "HTMLElement"
|
2659
|
+
},
|
2660
|
+
"description": "The button element."
|
2661
|
+
},
|
2662
|
+
{
|
2663
|
+
"name": "disabled",
|
2664
|
+
"type": {
|
2665
|
+
"text": "boolean"
|
2666
|
+
},
|
2667
|
+
"description": "The disabled state."
|
2654
2668
|
}
|
2655
|
-
|
2669
|
+
],
|
2670
|
+
"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."
|
2671
|
+
},
|
2672
|
+
{
|
2673
|
+
"kind": "method",
|
2674
|
+
"name": "triggerClickEvent",
|
2675
|
+
"privacy": "private"
|
2676
|
+
},
|
2677
|
+
{
|
2678
|
+
"kind": "method",
|
2679
|
+
"name": "handleBlur",
|
2680
|
+
"privacy": "private",
|
2681
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
2682
|
+
},
|
2683
|
+
{
|
2684
|
+
"kind": "method",
|
2685
|
+
"name": "handleKeyDown",
|
2686
|
+
"privacy": "private",
|
2656
2687
|
"parameters": [
|
2657
2688
|
{
|
2658
2689
|
"name": "event",
|
@@ -2662,299 +2693,583 @@
|
|
2662
2693
|
"description": "The keyboard event."
|
2663
2694
|
}
|
2664
2695
|
],
|
2665
|
-
"description": "Handles the keydown event on the
|
2696
|
+
"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."
|
2666
2697
|
},
|
2667
2698
|
{
|
2668
2699
|
"kind": "method",
|
2669
|
-
"name": "
|
2670
|
-
"privacy": "
|
2671
|
-
"return": {
|
2672
|
-
"type": {
|
2673
|
-
"text": "void"
|
2674
|
-
}
|
2675
|
-
},
|
2700
|
+
"name": "handleKeyUp",
|
2701
|
+
"privacy": "private",
|
2676
2702
|
"parameters": [
|
2677
2703
|
{
|
2678
2704
|
"name": "event",
|
2679
2705
|
"type": {
|
2680
|
-
"text": "
|
2681
|
-
}
|
2706
|
+
"text": "KeyboardEvent"
|
2707
|
+
},
|
2708
|
+
"description": "The keyboard event."
|
2682
2709
|
}
|
2683
2710
|
],
|
2684
|
-
"description": "
|
2685
|
-
},
|
2686
|
-
{
|
2687
|
-
"kind": "field",
|
2688
|
-
"name": "renderLabelAndHelperText",
|
2689
|
-
"privacy": "private"
|
2711
|
+
"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."
|
2690
2712
|
},
|
2691
2713
|
{
|
2692
2714
|
"kind": "field",
|
2693
|
-
"name": "
|
2715
|
+
"name": "tabIndex",
|
2694
2716
|
"type": {
|
2695
|
-
"text": "
|
2717
|
+
"text": "number"
|
2696
2718
|
},
|
2697
|
-
"default": "
|
2698
|
-
"description": "
|
2699
|
-
"attribute": "
|
2719
|
+
"default": "0",
|
2720
|
+
"description": "This property specifies the tab order of the element.",
|
2721
|
+
"attribute": "tabIndex",
|
2700
2722
|
"reflects": true,
|
2701
2723
|
"inheritedFrom": {
|
2702
|
-
"name": "
|
2703
|
-
"module": "utils/mixins/
|
2724
|
+
"name": "TabIndexMixin",
|
2725
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2704
2726
|
}
|
2705
2727
|
},
|
2706
2728
|
{
|
2707
2729
|
"kind": "field",
|
2708
|
-
"name": "
|
2730
|
+
"name": "disabled",
|
2709
2731
|
"type": {
|
2710
|
-
"text": "
|
2732
|
+
"text": "boolean | undefined"
|
2711
2733
|
},
|
2712
|
-
"
|
2713
|
-
"
|
2714
|
-
"attribute": "
|
2734
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2735
|
+
"default": "undefined",
|
2736
|
+
"attribute": "disabled",
|
2715
2737
|
"reflects": true,
|
2716
2738
|
"inheritedFrom": {
|
2717
|
-
"name": "
|
2718
|
-
"module": "utils/mixins/
|
2739
|
+
"name": "DisabledMixin",
|
2740
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2719
2741
|
}
|
2742
|
+
}
|
2743
|
+
],
|
2744
|
+
"events": [
|
2745
|
+
{
|
2746
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2747
|
+
"name": "click",
|
2748
|
+
"reactName": "onClick"
|
2720
2749
|
},
|
2721
2750
|
{
|
2722
|
-
"
|
2723
|
-
"name": "
|
2751
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2752
|
+
"name": "keydown",
|
2753
|
+
"reactName": "onKeyDown"
|
2754
|
+
},
|
2755
|
+
{
|
2756
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2757
|
+
"name": "keyup",
|
2758
|
+
"reactName": "onKeyUp"
|
2759
|
+
},
|
2760
|
+
{
|
2761
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2762
|
+
"name": "focus",
|
2763
|
+
"reactName": "onFocus"
|
2764
|
+
}
|
2765
|
+
],
|
2766
|
+
"attributes": [
|
2767
|
+
{
|
2768
|
+
"name": "active",
|
2724
2769
|
"type": {
|
2725
|
-
"text": "
|
2770
|
+
"text": "boolean | undefined"
|
2726
2771
|
},
|
2727
|
-
"description": "
|
2728
|
-
"
|
2729
|
-
"
|
2730
|
-
"inheritedFrom": {
|
2731
|
-
"name": "FormInternalsMixin",
|
2732
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2733
|
-
}
|
2772
|
+
"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.",
|
2773
|
+
"default": "undefined",
|
2774
|
+
"fieldName": "active"
|
2734
2775
|
},
|
2735
2776
|
{
|
2736
|
-
"
|
2737
|
-
"name": "validity",
|
2777
|
+
"name": "soft-disabled",
|
2738
2778
|
"type": {
|
2739
|
-
"text": "
|
2779
|
+
"text": "boolean | undefined"
|
2740
2780
|
},
|
2741
|
-
"
|
2742
|
-
"
|
2743
|
-
|
2744
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2745
|
-
}
|
2781
|
+
"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.",
|
2782
|
+
"default": "undefined",
|
2783
|
+
"fieldName": "softDisabled"
|
2746
2784
|
},
|
2747
2785
|
{
|
2748
|
-
"
|
2749
|
-
"
|
2750
|
-
|
2751
|
-
|
2752
|
-
|
2753
|
-
|
2754
|
-
|
2786
|
+
"name": "size",
|
2787
|
+
"type": {
|
2788
|
+
"text": "ButtonSize"
|
2789
|
+
},
|
2790
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2791
|
+
"default": "32",
|
2792
|
+
"fieldName": "size"
|
2755
2793
|
},
|
2756
2794
|
{
|
2757
|
-
"
|
2758
|
-
"
|
2759
|
-
"
|
2760
|
-
"
|
2761
|
-
"type": {
|
2762
|
-
"text": ""
|
2763
|
-
}
|
2764
|
-
},
|
2765
|
-
"inheritedFrom": {
|
2766
|
-
"name": "FormInternalsMixin",
|
2767
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
2768
|
-
}
|
2795
|
+
"name": "role",
|
2796
|
+
"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.",
|
2797
|
+
"default": "button",
|
2798
|
+
"fieldName": "role"
|
2769
2799
|
},
|
2770
2800
|
{
|
2771
|
-
"
|
2772
|
-
"
|
2773
|
-
|
2774
|
-
"type": {
|
2775
|
-
"text": "boolean"
|
2776
|
-
}
|
2801
|
+
"name": "ariaStateKey",
|
2802
|
+
"type": {
|
2803
|
+
"text": "string | undefined"
|
2777
2804
|
},
|
2778
|
-
"
|
2779
|
-
|
2780
|
-
|
2781
|
-
}
|
2805
|
+
"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`",
|
2806
|
+
"default": "'aria-pressed' (when)",
|
2807
|
+
"fieldName": "ariaStateKey"
|
2782
2808
|
},
|
2783
2809
|
{
|
2784
|
-
"
|
2785
|
-
"
|
2786
|
-
|
2787
|
-
|
2788
|
-
|
2789
|
-
|
2810
|
+
"name": "type",
|
2811
|
+
"type": {
|
2812
|
+
"text": "ButtonType"
|
2813
|
+
},
|
2814
|
+
"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.",
|
2815
|
+
"default": "button",
|
2816
|
+
"fieldName": "type"
|
2790
2817
|
},
|
2791
2818
|
{
|
2792
|
-
"
|
2793
|
-
"name": "dataAriaLabel",
|
2819
|
+
"name": "tabIndex",
|
2794
2820
|
"type": {
|
2795
|
-
"text": "
|
2821
|
+
"text": "number"
|
2796
2822
|
},
|
2797
|
-
"default": "
|
2798
|
-
"description": "
|
2799
|
-
"
|
2800
|
-
"reflects": true,
|
2823
|
+
"default": "0",
|
2824
|
+
"description": "This property specifies the tab order of the element.",
|
2825
|
+
"fieldName": "tabIndex",
|
2801
2826
|
"inheritedFrom": {
|
2802
|
-
"name": "
|
2803
|
-
"module": "utils/mixins/
|
2827
|
+
"name": "TabIndexMixin",
|
2828
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2804
2829
|
}
|
2805
2830
|
},
|
2806
2831
|
{
|
2807
|
-
"kind": "field",
|
2808
2832
|
"name": "disabled",
|
2809
2833
|
"type": {
|
2810
2834
|
"text": "boolean | undefined"
|
2811
2835
|
},
|
2812
2836
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2813
2837
|
"default": "undefined",
|
2814
|
-
"
|
2815
|
-
"reflects": true,
|
2838
|
+
"fieldName": "disabled",
|
2816
2839
|
"inheritedFrom": {
|
2817
2840
|
"name": "DisabledMixin",
|
2818
|
-
"module": "utils/mixins/DisabledMixin.
|
2841
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2819
2842
|
}
|
2843
|
+
}
|
2844
|
+
],
|
2845
|
+
"mixins": [
|
2846
|
+
{
|
2847
|
+
"name": "TabIndexMixin",
|
2848
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
2820
2849
|
},
|
2821
2850
|
{
|
2822
|
-
"
|
2823
|
-
"
|
2824
|
-
|
2825
|
-
|
2851
|
+
"name": "DisabledMixin",
|
2852
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
2853
|
+
}
|
2854
|
+
],
|
2855
|
+
"superclass": {
|
2856
|
+
"name": "Component",
|
2857
|
+
"module": "/src/models"
|
2858
|
+
},
|
2859
|
+
"tagName": "mdc-buttonsimple",
|
2860
|
+
"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 */",
|
2861
|
+
"customElement": true
|
2862
|
+
}
|
2863
|
+
],
|
2864
|
+
"exports": [
|
2865
|
+
{
|
2866
|
+
"kind": "js",
|
2867
|
+
"name": "default",
|
2868
|
+
"declaration": {
|
2869
|
+
"name": "Buttonsimple",
|
2870
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2871
|
+
}
|
2872
|
+
}
|
2873
|
+
]
|
2874
|
+
},
|
2875
|
+
{
|
2876
|
+
"kind": "javascript-module",
|
2877
|
+
"path": "components/checkbox/checkbox.component.js",
|
2878
|
+
"declarations": [
|
2879
|
+
{
|
2880
|
+
"kind": "class",
|
2881
|
+
"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.",
|
2882
|
+
"name": "Checkbox",
|
2883
|
+
"cssProperties": [
|
2884
|
+
{
|
2885
|
+
"description": "Allows customization of the background color on hover.",
|
2886
|
+
"name": "--mdc-checkbox-background-color-hover"
|
2887
|
+
},
|
2888
|
+
{
|
2889
|
+
"description": "Background color for a selected checkbox when hovered.",
|
2890
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
2891
|
+
},
|
2892
|
+
{
|
2893
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2894
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
2895
|
+
},
|
2896
|
+
{
|
2897
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2898
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
2899
|
+
},
|
2900
|
+
{
|
2901
|
+
"description": "Background color for a selected checkbox when disabled.",
|
2902
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
2903
|
+
}
|
2904
|
+
],
|
2905
|
+
"members": [
|
2906
|
+
{
|
2907
|
+
"kind": "field",
|
2908
|
+
"name": "checked",
|
2909
|
+
"type": {
|
2910
|
+
"text": "boolean"
|
2826
2911
|
},
|
2827
|
-
"
|
2828
|
-
"
|
2829
|
-
"
|
2830
|
-
"
|
2831
|
-
"name": "FormfieldWrapper",
|
2832
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2833
|
-
}
|
2912
|
+
"default": "false",
|
2913
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2914
|
+
"attribute": "checked",
|
2915
|
+
"reflects": true
|
2834
2916
|
},
|
2835
2917
|
{
|
2836
2918
|
"kind": "field",
|
2837
|
-
"name": "
|
2919
|
+
"name": "indeterminate",
|
2838
2920
|
"type": {
|
2839
|
-
"text": "
|
2921
|
+
"text": "boolean"
|
2840
2922
|
},
|
2841
|
-
"
|
2842
|
-
"
|
2843
|
-
"
|
2844
|
-
"
|
2845
|
-
"name": "FormfieldWrapper",
|
2846
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2847
|
-
}
|
2923
|
+
"default": "false",
|
2924
|
+
"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.",
|
2925
|
+
"attribute": "indeterminate",
|
2926
|
+
"reflects": true
|
2848
2927
|
},
|
2849
2928
|
{
|
2850
2929
|
"kind": "field",
|
2851
|
-
"name": "
|
2930
|
+
"name": "autofocus",
|
2931
|
+
"type": {
|
2932
|
+
"text": "boolean"
|
2933
|
+
},
|
2934
|
+
"default": "false",
|
2935
|
+
"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)",
|
2936
|
+
"attribute": "autofocus",
|
2937
|
+
"reflects": true
|
2938
|
+
},
|
2939
|
+
{
|
2940
|
+
"kind": "method",
|
2941
|
+
"name": "setFormValue",
|
2942
|
+
"privacy": "private",
|
2943
|
+
"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."
|
2944
|
+
},
|
2945
|
+
{
|
2946
|
+
"kind": "method",
|
2947
|
+
"name": "manageRequired",
|
2948
|
+
"privacy": "private",
|
2949
|
+
"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."
|
2950
|
+
},
|
2951
|
+
{
|
2952
|
+
"kind": "method",
|
2953
|
+
"name": "toggleState",
|
2954
|
+
"privacy": "private",
|
2955
|
+
"return": {
|
2956
|
+
"type": {
|
2957
|
+
"text": "void"
|
2958
|
+
}
|
2959
|
+
},
|
2960
|
+
"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."
|
2961
|
+
},
|
2962
|
+
{
|
2963
|
+
"kind": "method",
|
2964
|
+
"name": "handleKeyDown",
|
2965
|
+
"privacy": "private",
|
2966
|
+
"return": {
|
2967
|
+
"type": {
|
2968
|
+
"text": "void"
|
2969
|
+
}
|
2970
|
+
},
|
2971
|
+
"parameters": [
|
2972
|
+
{
|
2973
|
+
"name": "event",
|
2974
|
+
"type": {
|
2975
|
+
"text": "KeyboardEvent"
|
2976
|
+
},
|
2977
|
+
"description": "The keyboard event."
|
2978
|
+
}
|
2979
|
+
],
|
2980
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
2981
|
+
},
|
2982
|
+
{
|
2983
|
+
"kind": "method",
|
2984
|
+
"name": "handleChange",
|
2985
|
+
"privacy": "public",
|
2986
|
+
"return": {
|
2987
|
+
"type": {
|
2988
|
+
"text": "void"
|
2989
|
+
}
|
2990
|
+
},
|
2991
|
+
"parameters": [
|
2992
|
+
{
|
2993
|
+
"name": "event",
|
2994
|
+
"type": {
|
2995
|
+
"text": "Event"
|
2996
|
+
}
|
2997
|
+
}
|
2998
|
+
],
|
2999
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
3000
|
+
},
|
3001
|
+
{
|
3002
|
+
"kind": "field",
|
3003
|
+
"name": "renderLabelAndHelperText",
|
3004
|
+
"privacy": "private"
|
3005
|
+
},
|
3006
|
+
{
|
3007
|
+
"kind": "field",
|
3008
|
+
"name": "name",
|
2852
3009
|
"type": {
|
2853
3010
|
"text": "string"
|
2854
3011
|
},
|
2855
3012
|
"default": "''",
|
2856
|
-
"description": "
|
2857
|
-
"attribute": "
|
3013
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
3014
|
+
"attribute": "name",
|
3015
|
+
"reflects": true,
|
2858
3016
|
"inheritedFrom": {
|
2859
|
-
"name": "
|
2860
|
-
"module": "
|
3017
|
+
"name": "FormInternalsMixin",
|
3018
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2861
3019
|
}
|
2862
3020
|
},
|
2863
3021
|
{
|
2864
3022
|
"kind": "field",
|
2865
|
-
"name": "
|
3023
|
+
"name": "value",
|
2866
3024
|
"type": {
|
2867
|
-
"text": "
|
3025
|
+
"text": "string"
|
2868
3026
|
},
|
2869
|
-
"
|
2870
|
-
"
|
3027
|
+
"default": "''",
|
3028
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
3029
|
+
"attribute": "value",
|
2871
3030
|
"reflects": true,
|
2872
3031
|
"inheritedFrom": {
|
2873
|
-
"name": "
|
2874
|
-
"module": "
|
3032
|
+
"name": "FormInternalsMixin",
|
3033
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2875
3034
|
}
|
2876
3035
|
},
|
2877
3036
|
{
|
2878
3037
|
"kind": "field",
|
2879
|
-
"name": "
|
3038
|
+
"name": "validationMessage",
|
2880
3039
|
"type": {
|
2881
3040
|
"text": "string | undefined"
|
2882
3041
|
},
|
2883
|
-
"description": "
|
2884
|
-
"attribute": "
|
3042
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
3043
|
+
"attribute": "validation-message",
|
2885
3044
|
"reflects": true,
|
2886
3045
|
"inheritedFrom": {
|
2887
|
-
"name": "
|
2888
|
-
"module": "
|
3046
|
+
"name": "FormInternalsMixin",
|
3047
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2889
3048
|
}
|
2890
3049
|
},
|
2891
3050
|
{
|
2892
|
-
"kind": "
|
2893
|
-
"name": "
|
2894
|
-
"
|
2895
|
-
|
2896
|
-
"return": {
|
2897
|
-
"type": {
|
2898
|
-
"text": ""
|
2899
|
-
}
|
3051
|
+
"kind": "field",
|
3052
|
+
"name": "validity",
|
3053
|
+
"type": {
|
3054
|
+
"text": "ValidityState"
|
2900
3055
|
},
|
3056
|
+
"readonly": true,
|
2901
3057
|
"inheritedFrom": {
|
2902
|
-
"name": "
|
2903
|
-
"module": "
|
3058
|
+
"name": "FormInternalsMixin",
|
3059
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2904
3060
|
}
|
2905
3061
|
},
|
2906
3062
|
{
|
2907
|
-
"kind": "
|
2908
|
-
"name": "
|
2909
|
-
"
|
3063
|
+
"kind": "field",
|
3064
|
+
"name": "willValidate",
|
3065
|
+
"readonly": true,
|
2910
3066
|
"inheritedFrom": {
|
2911
|
-
"name": "
|
2912
|
-
"module": "
|
3067
|
+
"name": "FormInternalsMixin",
|
3068
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2913
3069
|
}
|
2914
3070
|
},
|
2915
3071
|
{
|
2916
3072
|
"kind": "method",
|
2917
|
-
"name": "
|
2918
|
-
"
|
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.",
|
3073
|
+
"name": "setValidity",
|
3074
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
2920
3075
|
"return": {
|
2921
3076
|
"type": {
|
2922
3077
|
"text": ""
|
2923
3078
|
}
|
2924
3079
|
},
|
2925
3080
|
"inheritedFrom": {
|
2926
|
-
"name": "
|
2927
|
-
"module": "
|
3081
|
+
"name": "FormInternalsMixin",
|
3082
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2928
3083
|
}
|
2929
3084
|
},
|
2930
3085
|
{
|
2931
3086
|
"kind": "method",
|
2932
|
-
"name": "
|
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.",
|
3087
|
+
"name": "checkValidity",
|
2935
3088
|
"return": {
|
2936
3089
|
"type": {
|
2937
|
-
"text": ""
|
3090
|
+
"text": "boolean"
|
2938
3091
|
}
|
2939
3092
|
},
|
2940
3093
|
"inheritedFrom": {
|
2941
|
-
"name": "
|
2942
|
-
"module": "
|
3094
|
+
"name": "FormInternalsMixin",
|
3095
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2943
3096
|
}
|
2944
3097
|
},
|
2945
3098
|
{
|
2946
3099
|
"kind": "method",
|
2947
|
-
"name": "
|
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
|
-
},
|
3100
|
+
"name": "reportValidity",
|
2955
3101
|
"inheritedFrom": {
|
2956
|
-
"name": "
|
2957
|
-
"module": "
|
3102
|
+
"name": "FormInternalsMixin",
|
3103
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
3104
|
+
}
|
3105
|
+
},
|
3106
|
+
{
|
3107
|
+
"kind": "field",
|
3108
|
+
"name": "dataAriaLabel",
|
3109
|
+
"type": {
|
3110
|
+
"text": "string | null"
|
3111
|
+
},
|
3112
|
+
"default": "null",
|
3113
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
3114
|
+
"attribute": "data-aria-label",
|
3115
|
+
"reflects": true,
|
3116
|
+
"inheritedFrom": {
|
3117
|
+
"name": "DataAriaLabelMixin",
|
3118
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
3119
|
+
}
|
3120
|
+
},
|
3121
|
+
{
|
3122
|
+
"kind": "field",
|
3123
|
+
"name": "disabled",
|
3124
|
+
"type": {
|
3125
|
+
"text": "boolean | undefined"
|
3126
|
+
},
|
3127
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3128
|
+
"default": "undefined",
|
3129
|
+
"attribute": "disabled",
|
3130
|
+
"reflects": true,
|
3131
|
+
"inheritedFrom": {
|
3132
|
+
"name": "DisabledMixin",
|
3133
|
+
"module": "utils/mixins/DisabledMixin.js"
|
3134
|
+
}
|
3135
|
+
},
|
3136
|
+
{
|
3137
|
+
"kind": "field",
|
3138
|
+
"name": "label",
|
3139
|
+
"type": {
|
3140
|
+
"text": "string | undefined"
|
3141
|
+
},
|
3142
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3143
|
+
"attribute": "label",
|
3144
|
+
"reflects": true,
|
3145
|
+
"inheritedFrom": {
|
3146
|
+
"name": "FormfieldWrapper",
|
3147
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3148
|
+
}
|
3149
|
+
},
|
3150
|
+
{
|
3151
|
+
"kind": "field",
|
3152
|
+
"name": "requiredLabel",
|
3153
|
+
"type": {
|
3154
|
+
"text": "string | undefined"
|
3155
|
+
},
|
3156
|
+
"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.",
|
3157
|
+
"attribute": "required-label",
|
3158
|
+
"reflects": true,
|
3159
|
+
"inheritedFrom": {
|
3160
|
+
"name": "FormfieldWrapper",
|
3161
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3162
|
+
}
|
3163
|
+
},
|
3164
|
+
{
|
3165
|
+
"kind": "field",
|
3166
|
+
"name": "id",
|
3167
|
+
"type": {
|
3168
|
+
"text": "string"
|
3169
|
+
},
|
3170
|
+
"default": "''",
|
3171
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3172
|
+
"attribute": "id",
|
3173
|
+
"inheritedFrom": {
|
3174
|
+
"name": "FormfieldWrapper",
|
3175
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3176
|
+
}
|
3177
|
+
},
|
3178
|
+
{
|
3179
|
+
"kind": "field",
|
3180
|
+
"name": "helpTextType",
|
3181
|
+
"type": {
|
3182
|
+
"text": "ValidationType"
|
3183
|
+
},
|
3184
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3185
|
+
"attribute": "help-text-type",
|
3186
|
+
"reflects": true,
|
3187
|
+
"inheritedFrom": {
|
3188
|
+
"name": "FormfieldWrapper",
|
3189
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3190
|
+
}
|
3191
|
+
},
|
3192
|
+
{
|
3193
|
+
"kind": "field",
|
3194
|
+
"name": "helpText",
|
3195
|
+
"type": {
|
3196
|
+
"text": "string | undefined"
|
3197
|
+
},
|
3198
|
+
"description": "The help text that is displayed below the input field.",
|
3199
|
+
"attribute": "help-text",
|
3200
|
+
"reflects": true,
|
3201
|
+
"inheritedFrom": {
|
3202
|
+
"name": "FormfieldWrapper",
|
3203
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3204
|
+
}
|
3205
|
+
},
|
3206
|
+
{
|
3207
|
+
"kind": "method",
|
3208
|
+
"name": "renderLabelElement",
|
3209
|
+
"privacy": "protected",
|
3210
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
3211
|
+
"return": {
|
3212
|
+
"type": {
|
3213
|
+
"text": ""
|
3214
|
+
}
|
3215
|
+
},
|
3216
|
+
"inheritedFrom": {
|
3217
|
+
"name": "FormfieldWrapper",
|
3218
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3219
|
+
}
|
3220
|
+
},
|
3221
|
+
{
|
3222
|
+
"kind": "method",
|
3223
|
+
"name": "renderRequiredLabel",
|
3224
|
+
"privacy": "protected",
|
3225
|
+
"inheritedFrom": {
|
3226
|
+
"name": "FormfieldWrapper",
|
3227
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3228
|
+
}
|
3229
|
+
},
|
3230
|
+
{
|
3231
|
+
"kind": "method",
|
3232
|
+
"name": "renderHelpTextIcon",
|
3233
|
+
"privacy": "protected",
|
3234
|
+
"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.",
|
3235
|
+
"return": {
|
3236
|
+
"type": {
|
3237
|
+
"text": ""
|
3238
|
+
}
|
3239
|
+
},
|
3240
|
+
"inheritedFrom": {
|
3241
|
+
"name": "FormfieldWrapper",
|
3242
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3243
|
+
}
|
3244
|
+
},
|
3245
|
+
{
|
3246
|
+
"kind": "method",
|
3247
|
+
"name": "renderHelpText",
|
3248
|
+
"privacy": "protected",
|
3249
|
+
"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.",
|
3250
|
+
"return": {
|
3251
|
+
"type": {
|
3252
|
+
"text": ""
|
3253
|
+
}
|
3254
|
+
},
|
3255
|
+
"inheritedFrom": {
|
3256
|
+
"name": "FormfieldWrapper",
|
3257
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3258
|
+
}
|
3259
|
+
},
|
3260
|
+
{
|
3261
|
+
"kind": "method",
|
3262
|
+
"name": "renderLabel",
|
3263
|
+
"privacy": "protected",
|
3264
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
3265
|
+
"return": {
|
3266
|
+
"type": {
|
3267
|
+
"text": ""
|
3268
|
+
}
|
3269
|
+
},
|
3270
|
+
"inheritedFrom": {
|
3271
|
+
"name": "FormfieldWrapper",
|
3272
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2958
3273
|
}
|
2959
3274
|
},
|
2960
3275
|
{
|
@@ -3159,7 +3474,7 @@
|
|
3159
3474
|
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
3160
3475
|
},
|
3161
3476
|
"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-
|
3477
|
+
"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-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
3163
3478
|
"customElement": true,
|
3164
3479
|
"slots": [
|
3165
3480
|
{
|
@@ -3186,63 +3501,172 @@
|
|
3186
3501
|
},
|
3187
3502
|
{
|
3188
3503
|
"kind": "javascript-module",
|
3189
|
-
"path": "components/
|
3504
|
+
"path": "components/chip/chip.component.js",
|
3190
3505
|
"declarations": [
|
3191
3506
|
{
|
3192
3507
|
"kind": "class",
|
3193
|
-
"description": "
|
3194
|
-
"name": "
|
3508
|
+
"description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
|
3509
|
+
"name": "Chip",
|
3510
|
+
"cssProperties": [
|
3511
|
+
{
|
3512
|
+
"description": "The color of the chip.",
|
3513
|
+
"name": "--mdc-chip-color"
|
3514
|
+
},
|
3515
|
+
{
|
3516
|
+
"description": "The border color of the chip.",
|
3517
|
+
"name": "--mdc-chip-border-color"
|
3518
|
+
},
|
3519
|
+
{
|
3520
|
+
"description": "The background color of the chip.",
|
3521
|
+
"name": "--mdc-chip-background-color"
|
3522
|
+
}
|
3523
|
+
],
|
3195
3524
|
"members": [
|
3196
3525
|
{
|
3197
3526
|
"kind": "field",
|
3198
|
-
"name": "
|
3527
|
+
"name": "color",
|
3199
3528
|
"type": {
|
3200
|
-
"text": "
|
3529
|
+
"text": "ColorType"
|
3201
3530
|
},
|
3202
|
-
"description": "The
|
3203
|
-
"default": "
|
3204
|
-
"attribute": "
|
3531
|
+
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
|
3532
|
+
"default": "default",
|
3533
|
+
"attribute": "color",
|
3205
3534
|
"reflects": true
|
3206
3535
|
},
|
3207
3536
|
{
|
3208
3537
|
"kind": "field",
|
3209
|
-
"name": "
|
3538
|
+
"name": "label",
|
3210
3539
|
"type": {
|
3211
|
-
"text": "
|
3540
|
+
"text": "string"
|
3212
3541
|
},
|
3213
|
-
"
|
3214
|
-
"
|
3215
|
-
"attribute": "
|
3542
|
+
"default": "''",
|
3543
|
+
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
3544
|
+
"attribute": "label"
|
3545
|
+
},
|
3546
|
+
{
|
3547
|
+
"kind": "method",
|
3548
|
+
"name": "renderIcon",
|
3549
|
+
"privacy": "private",
|
3550
|
+
"description": "Renders the icon element if available.",
|
3551
|
+
"return": {
|
3552
|
+
"type": {
|
3553
|
+
"text": ""
|
3554
|
+
}
|
3555
|
+
}
|
3216
3556
|
},
|
3217
3557
|
{
|
3218
3558
|
"kind": "field",
|
3219
|
-
"name": "
|
3559
|
+
"name": "iconName",
|
3220
3560
|
"type": {
|
3221
|
-
"text": "
|
3561
|
+
"text": "IconNames | undefined"
|
3222
3562
|
},
|
3223
|
-
"description": "
|
3224
|
-
"
|
3225
|
-
"
|
3226
|
-
|
3563
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3564
|
+
"attribute": "icon-name",
|
3565
|
+
"inheritedFrom": {
|
3566
|
+
"name": "IconNameMixin",
|
3567
|
+
"module": "utils/mixins/IconNameMixin.js"
|
3568
|
+
}
|
3227
3569
|
},
|
3228
3570
|
{
|
3229
3571
|
"kind": "field",
|
3230
|
-
"name": "
|
3231
|
-
"
|
3232
|
-
|
3233
|
-
|
3234
|
-
"
|
3572
|
+
"name": "tabIndex",
|
3573
|
+
"type": {
|
3574
|
+
"text": "number"
|
3575
|
+
},
|
3576
|
+
"default": "0",
|
3577
|
+
"description": "This property specifies the tab order of the element.",
|
3578
|
+
"attribute": "tabIndex",
|
3579
|
+
"reflects": true,
|
3580
|
+
"inheritedFrom": {
|
3581
|
+
"name": "Buttonsimple",
|
3582
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3583
|
+
}
|
3235
3584
|
},
|
3236
3585
|
{
|
3237
3586
|
"kind": "field",
|
3238
|
-
"name": "
|
3587
|
+
"name": "disabled",
|
3239
3588
|
"type": {
|
3240
|
-
"text": "
|
3589
|
+
"text": "boolean | undefined"
|
3241
3590
|
},
|
3242
|
-
"description": "
|
3591
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3592
|
+
"default": "undefined",
|
3593
|
+
"attribute": "disabled",
|
3594
|
+
"reflects": true,
|
3595
|
+
"inheritedFrom": {
|
3596
|
+
"name": "Buttonsimple",
|
3597
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3598
|
+
}
|
3599
|
+
},
|
3600
|
+
{
|
3601
|
+
"kind": "field",
|
3602
|
+
"name": "active",
|
3603
|
+
"type": {
|
3604
|
+
"text": "boolean | undefined"
|
3605
|
+
},
|
3606
|
+
"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.",
|
3607
|
+
"default": "undefined",
|
3608
|
+
"attribute": "active",
|
3609
|
+
"reflects": true,
|
3610
|
+
"inheritedFrom": {
|
3611
|
+
"name": "Buttonsimple",
|
3612
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3613
|
+
}
|
3614
|
+
},
|
3615
|
+
{
|
3616
|
+
"kind": "field",
|
3617
|
+
"name": "softDisabled",
|
3618
|
+
"type": {
|
3619
|
+
"text": "boolean | undefined"
|
3620
|
+
},
|
3621
|
+
"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.",
|
3622
|
+
"default": "undefined",
|
3623
|
+
"attribute": "soft-disabled",
|
3624
|
+
"inheritedFrom": {
|
3625
|
+
"name": "Buttonsimple",
|
3626
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3627
|
+
}
|
3628
|
+
},
|
3629
|
+
{
|
3630
|
+
"kind": "field",
|
3631
|
+
"name": "size",
|
3632
|
+
"type": {
|
3633
|
+
"text": "ButtonSize"
|
3634
|
+
},
|
3635
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
3636
|
+
"default": "32",
|
3637
|
+
"attribute": "size",
|
3638
|
+
"reflects": true,
|
3639
|
+
"inheritedFrom": {
|
3640
|
+
"name": "Buttonsimple",
|
3641
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3642
|
+
}
|
3643
|
+
},
|
3644
|
+
{
|
3645
|
+
"kind": "field",
|
3646
|
+
"name": "role",
|
3647
|
+
"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.",
|
3648
|
+
"default": "button",
|
3649
|
+
"attribute": "role",
|
3650
|
+
"reflects": true,
|
3651
|
+
"inheritedFrom": {
|
3652
|
+
"name": "Buttonsimple",
|
3653
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3654
|
+
}
|
3655
|
+
},
|
3656
|
+
{
|
3657
|
+
"kind": "field",
|
3658
|
+
"name": "ariaStateKey",
|
3659
|
+
"type": {
|
3660
|
+
"text": "string | undefined"
|
3661
|
+
},
|
3662
|
+
"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
3663
|
"default": "'aria-pressed' (when)",
|
3244
3664
|
"attribute": "ariaStateKey",
|
3245
|
-
"reflects": true
|
3665
|
+
"reflects": true,
|
3666
|
+
"inheritedFrom": {
|
3667
|
+
"name": "Buttonsimple",
|
3668
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3669
|
+
}
|
3246
3670
|
},
|
3247
3671
|
{
|
3248
3672
|
"kind": "field",
|
@@ -3253,12 +3677,20 @@
|
|
3253
3677
|
"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
3678
|
"default": "button",
|
3255
3679
|
"attribute": "type",
|
3256
|
-
"reflects": true
|
3680
|
+
"reflects": true,
|
3681
|
+
"inheritedFrom": {
|
3682
|
+
"name": "Buttonsimple",
|
3683
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3684
|
+
}
|
3257
3685
|
},
|
3258
3686
|
{
|
3259
3687
|
"kind": "method",
|
3260
3688
|
"name": "executeAction",
|
3261
|
-
"privacy": "protected"
|
3689
|
+
"privacy": "protected",
|
3690
|
+
"inheritedFrom": {
|
3691
|
+
"name": "Buttonsimple",
|
3692
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3693
|
+
}
|
3262
3694
|
},
|
3263
3695
|
{
|
3264
3696
|
"kind": "method",
|
@@ -3281,7 +3713,11 @@
|
|
3281
3713
|
"description": "The active state of the element"
|
3282
3714
|
}
|
3283
3715
|
],
|
3284
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button."
|
3716
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
3717
|
+
"inheritedFrom": {
|
3718
|
+
"name": "Buttonsimple",
|
3719
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3720
|
+
}
|
3285
3721
|
},
|
3286
3722
|
{
|
3287
3723
|
"kind": "method",
|
@@ -3304,7 +3740,11 @@
|
|
3304
3740
|
"description": "The soft-disabled state."
|
3305
3741
|
}
|
3306
3742
|
],
|
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."
|
3743
|
+
"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.",
|
3744
|
+
"inheritedFrom": {
|
3745
|
+
"name": "Buttonsimple",
|
3746
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3747
|
+
}
|
3308
3748
|
},
|
3309
3749
|
{
|
3310
3750
|
"kind": "method",
|
@@ -3326,18 +3766,30 @@
|
|
3326
3766
|
"description": "The disabled state."
|
3327
3767
|
}
|
3328
3768
|
],
|
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."
|
3769
|
+
"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.",
|
3770
|
+
"inheritedFrom": {
|
3771
|
+
"name": "Buttonsimple",
|
3772
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3773
|
+
}
|
3330
3774
|
},
|
3331
3775
|
{
|
3332
3776
|
"kind": "method",
|
3333
3777
|
"name": "triggerClickEvent",
|
3334
|
-
"privacy": "private"
|
3778
|
+
"privacy": "private",
|
3779
|
+
"inheritedFrom": {
|
3780
|
+
"name": "Buttonsimple",
|
3781
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3782
|
+
}
|
3335
3783
|
},
|
3336
3784
|
{
|
3337
3785
|
"kind": "method",
|
3338
3786
|
"name": "handleBlur",
|
3339
3787
|
"privacy": "private",
|
3340
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
3788
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
3789
|
+
"inheritedFrom": {
|
3790
|
+
"name": "Buttonsimple",
|
3791
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3792
|
+
}
|
3341
3793
|
},
|
3342
3794
|
{
|
3343
3795
|
"kind": "method",
|
@@ -3352,7 +3804,11 @@
|
|
3352
3804
|
"description": "The keyboard event."
|
3353
3805
|
}
|
3354
3806
|
],
|
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."
|
3807
|
+
"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.",
|
3808
|
+
"inheritedFrom": {
|
3809
|
+
"name": "Buttonsimple",
|
3810
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3811
|
+
}
|
3356
3812
|
},
|
3357
3813
|
{
|
3358
3814
|
"kind": "method",
|
@@ -3367,62 +3823,70 @@
|
|
3367
3823
|
"description": "The keyboard event."
|
3368
3824
|
}
|
3369
3825
|
],
|
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."
|
3826
|
+
"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.",
|
3827
|
+
"inheritedFrom": {
|
3828
|
+
"name": "Buttonsimple",
|
3829
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3830
|
+
}
|
3831
|
+
}
|
3832
|
+
],
|
3833
|
+
"attributes": [
|
3834
|
+
{
|
3835
|
+
"name": "color",
|
3836
|
+
"type": {
|
3837
|
+
"text": "ColorType"
|
3838
|
+
},
|
3839
|
+
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
|
3840
|
+
"default": "default",
|
3841
|
+
"fieldName": "color"
|
3842
|
+
},
|
3843
|
+
{
|
3844
|
+
"name": "label",
|
3845
|
+
"type": {
|
3846
|
+
"text": "string"
|
3847
|
+
},
|
3848
|
+
"default": "''",
|
3849
|
+
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
3850
|
+
"fieldName": "label"
|
3851
|
+
},
|
3852
|
+
{
|
3853
|
+
"name": "icon-name",
|
3854
|
+
"type": {
|
3855
|
+
"text": "IconNames | undefined"
|
3856
|
+
},
|
3857
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3858
|
+
"fieldName": "iconName",
|
3859
|
+
"inheritedFrom": {
|
3860
|
+
"name": "IconNameMixin",
|
3861
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
3862
|
+
}
|
3371
3863
|
},
|
3372
3864
|
{
|
3373
|
-
"kind": "field",
|
3374
3865
|
"name": "tabIndex",
|
3375
3866
|
"type": {
|
3376
3867
|
"text": "number"
|
3377
3868
|
},
|
3378
3869
|
"default": "0",
|
3379
3870
|
"description": "This property specifies the tab order of the element.",
|
3380
|
-
"
|
3381
|
-
"reflects": true,
|
3871
|
+
"fieldName": "tabIndex",
|
3382
3872
|
"inheritedFrom": {
|
3383
|
-
"name": "
|
3384
|
-
"module": "
|
3873
|
+
"name": "Buttonsimple",
|
3874
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3385
3875
|
}
|
3386
3876
|
},
|
3387
3877
|
{
|
3388
|
-
"kind": "field",
|
3389
3878
|
"name": "disabled",
|
3390
3879
|
"type": {
|
3391
3880
|
"text": "boolean | undefined"
|
3392
3881
|
},
|
3393
3882
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3394
3883
|
"default": "undefined",
|
3395
|
-
"
|
3396
|
-
"reflects": true,
|
3884
|
+
"fieldName": "disabled",
|
3397
3885
|
"inheritedFrom": {
|
3398
|
-
"name": "
|
3399
|
-
"module": "
|
3886
|
+
"name": "Buttonsimple",
|
3887
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3400
3888
|
}
|
3401
|
-
}
|
3402
|
-
],
|
3403
|
-
"events": [
|
3404
|
-
{
|
3405
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
3406
|
-
"name": "click",
|
3407
|
-
"reactName": "onClick"
|
3408
|
-
},
|
3409
|
-
{
|
3410
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
3411
|
-
"name": "keydown",
|
3412
|
-
"reactName": "onKeyDown"
|
3413
3889
|
},
|
3414
|
-
{
|
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.",
|
3421
|
-
"name": "focus",
|
3422
|
-
"reactName": "onFocus"
|
3423
|
-
}
|
3424
|
-
],
|
3425
|
-
"attributes": [
|
3426
3890
|
{
|
3427
3891
|
"name": "active",
|
3428
3892
|
"type": {
|
@@ -3430,7 +3894,11 @@
|
|
3430
3894
|
},
|
3431
3895
|
"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
3896
|
"default": "undefined",
|
3433
|
-
"fieldName": "active"
|
3897
|
+
"fieldName": "active",
|
3898
|
+
"inheritedFrom": {
|
3899
|
+
"name": "Buttonsimple",
|
3900
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3901
|
+
}
|
3434
3902
|
},
|
3435
3903
|
{
|
3436
3904
|
"name": "soft-disabled",
|
@@ -3439,7 +3907,11 @@
|
|
3439
3907
|
},
|
3440
3908
|
"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
3909
|
"default": "undefined",
|
3442
|
-
"fieldName": "softDisabled"
|
3910
|
+
"fieldName": "softDisabled",
|
3911
|
+
"inheritedFrom": {
|
3912
|
+
"name": "Buttonsimple",
|
3913
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3914
|
+
}
|
3443
3915
|
},
|
3444
3916
|
{
|
3445
3917
|
"name": "size",
|
@@ -3448,13 +3920,21 @@
|
|
3448
3920
|
},
|
3449
3921
|
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
3450
3922
|
"default": "32",
|
3451
|
-
"fieldName": "size"
|
3923
|
+
"fieldName": "size",
|
3924
|
+
"inheritedFrom": {
|
3925
|
+
"name": "Buttonsimple",
|
3926
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3927
|
+
}
|
3452
3928
|
},
|
3453
3929
|
{
|
3454
3930
|
"name": "role",
|
3455
3931
|
"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
3932
|
"default": "button",
|
3457
|
-
"fieldName": "role"
|
3933
|
+
"fieldName": "role",
|
3934
|
+
"inheritedFrom": {
|
3935
|
+
"name": "Buttonsimple",
|
3936
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3937
|
+
}
|
3458
3938
|
},
|
3459
3939
|
{
|
3460
3940
|
"name": "ariaStateKey",
|
@@ -3463,7 +3943,11 @@
|
|
3463
3943
|
},
|
3464
3944
|
"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
3945
|
"default": "'aria-pressed' (when)",
|
3466
|
-
"fieldName": "ariaStateKey"
|
3946
|
+
"fieldName": "ariaStateKey",
|
3947
|
+
"inheritedFrom": {
|
3948
|
+
"name": "Buttonsimple",
|
3949
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3950
|
+
}
|
3467
3951
|
},
|
3468
3952
|
{
|
3469
3953
|
"name": "type",
|
@@ -3472,52 +3956,64 @@
|
|
3472
3956
|
},
|
3473
3957
|
"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
3958
|
"default": "button",
|
3475
|
-
"fieldName": "type"
|
3476
|
-
},
|
3477
|
-
{
|
3478
|
-
"name": "tabIndex",
|
3479
|
-
"type": {
|
3480
|
-
"text": "number"
|
3481
|
-
},
|
3482
|
-
"default": "0",
|
3483
|
-
"description": "This property specifies the tab order of the element.",
|
3484
|
-
"fieldName": "tabIndex",
|
3959
|
+
"fieldName": "type",
|
3485
3960
|
"inheritedFrom": {
|
3486
|
-
"name": "
|
3487
|
-
"module": "src/
|
3961
|
+
"name": "Buttonsimple",
|
3962
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3488
3963
|
}
|
3489
|
-
}
|
3964
|
+
}
|
3965
|
+
],
|
3966
|
+
"mixins": [
|
3490
3967
|
{
|
3491
|
-
"name": "
|
3492
|
-
"
|
3493
|
-
"text": "boolean | undefined"
|
3494
|
-
},
|
3495
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3496
|
-
"default": "undefined",
|
3497
|
-
"fieldName": "disabled",
|
3498
|
-
"inheritedFrom": {
|
3499
|
-
"name": "DisabledMixin",
|
3500
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
3501
|
-
}
|
3968
|
+
"name": "IconNameMixin",
|
3969
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
3502
3970
|
}
|
3503
3971
|
],
|
3504
|
-
"
|
3972
|
+
"superclass": {
|
3973
|
+
"name": "Buttonsimple",
|
3974
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
3975
|
+
},
|
3976
|
+
"tagName": "mdc-chip",
|
3977
|
+
"jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
3978
|
+
"customElement": true,
|
3979
|
+
"events": [
|
3505
3980
|
{
|
3506
|
-
"
|
3507
|
-
"
|
3981
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
3982
|
+
"name": "click",
|
3983
|
+
"reactName": "onClick",
|
3984
|
+
"inheritedFrom": {
|
3985
|
+
"name": "Buttonsimple",
|
3986
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3987
|
+
}
|
3508
3988
|
},
|
3509
3989
|
{
|
3510
|
-
"
|
3511
|
-
"
|
3990
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
3991
|
+
"name": "keydown",
|
3992
|
+
"reactName": "onKeyDown",
|
3993
|
+
"inheritedFrom": {
|
3994
|
+
"name": "Buttonsimple",
|
3995
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3996
|
+
}
|
3997
|
+
},
|
3998
|
+
{
|
3999
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
4000
|
+
"name": "keyup",
|
4001
|
+
"reactName": "onKeyUp",
|
4002
|
+
"inheritedFrom": {
|
4003
|
+
"name": "Buttonsimple",
|
4004
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4005
|
+
}
|
4006
|
+
},
|
4007
|
+
{
|
4008
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
4009
|
+
"name": "focus",
|
4010
|
+
"reactName": "onFocus",
|
4011
|
+
"inheritedFrom": {
|
4012
|
+
"name": "Buttonsimple",
|
4013
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4014
|
+
}
|
3512
4015
|
}
|
3513
|
-
]
|
3514
|
-
"superclass": {
|
3515
|
-
"name": "Component",
|
3516
|
-
"module": "/src/models"
|
3517
|
-
},
|
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
|
4016
|
+
]
|
3521
4017
|
}
|
3522
4018
|
],
|
3523
4019
|
"exports": [
|
@@ -3525,235 +4021,248 @@
|
|
3525
4021
|
"kind": "js",
|
3526
4022
|
"name": "default",
|
3527
4023
|
"declaration": {
|
3528
|
-
"name": "
|
3529
|
-
"module": "components/
|
4024
|
+
"name": "Chip",
|
4025
|
+
"module": "components/chip/chip.component.js"
|
3530
4026
|
}
|
3531
4027
|
}
|
3532
4028
|
]
|
3533
4029
|
},
|
3534
4030
|
{
|
3535
4031
|
"kind": "javascript-module",
|
3536
|
-
"path": "components/
|
4032
|
+
"path": "components/coachmark/coachmark.component.js",
|
3537
4033
|
"declarations": [
|
3538
4034
|
{
|
3539
4035
|
"kind": "class",
|
3540
|
-
"description": "
|
3541
|
-
"name": "
|
4036
|
+
"description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
|
4037
|
+
"name": "Coachmark",
|
3542
4038
|
"cssProperties": [
|
3543
4039
|
{
|
3544
|
-
"description": "
|
3545
|
-
"name": "--mdc-
|
4040
|
+
"description": "radius of the arrow border",
|
4041
|
+
"name": "--mdc-popover-arrow-border-radius",
|
4042
|
+
"inheritedFrom": {
|
4043
|
+
"name": "Popover",
|
4044
|
+
"module": "src/components/popover/popover.component.ts"
|
4045
|
+
}
|
3546
4046
|
},
|
3547
4047
|
{
|
3548
|
-
"description": "
|
3549
|
-
"name": "--mdc-
|
4048
|
+
"description": "border of the arrow",
|
4049
|
+
"name": "--mdc-popover-arrow-border",
|
4050
|
+
"inheritedFrom": {
|
4051
|
+
"name": "Popover",
|
4052
|
+
"module": "src/components/popover/popover.component.ts"
|
4053
|
+
}
|
3550
4054
|
},
|
3551
4055
|
{
|
3552
|
-
"description": "
|
3553
|
-
"name": "--mdc-
|
3554
|
-
|
3555
|
-
|
3556
|
-
|
4056
|
+
"description": "primary background color of the popover",
|
4057
|
+
"name": "--mdc-popover-primary-background-color",
|
4058
|
+
"inheritedFrom": {
|
4059
|
+
"name": "Popover",
|
4060
|
+
"module": "src/components/popover/popover.component.ts"
|
4061
|
+
}
|
4062
|
+
},
|
3557
4063
|
{
|
3558
|
-
"
|
3559
|
-
"name": "color",
|
3560
|
-
"
|
3561
|
-
"
|
3562
|
-
|
3563
|
-
|
3564
|
-
"default": "default",
|
3565
|
-
"attribute": "color",
|
3566
|
-
"reflects": true
|
4064
|
+
"description": "border color of the popover",
|
4065
|
+
"name": "--mdc-popover-border-color",
|
4066
|
+
"inheritedFrom": {
|
4067
|
+
"name": "Popover",
|
4068
|
+
"module": "src/components/popover/popover.component.ts"
|
4069
|
+
}
|
3567
4070
|
},
|
3568
4071
|
{
|
3569
|
-
"
|
3570
|
-
"name": "
|
3571
|
-
"
|
3572
|
-
"
|
3573
|
-
|
3574
|
-
|
3575
|
-
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
3576
|
-
"attribute": "label"
|
4072
|
+
"description": "inverted background color of the popover",
|
4073
|
+
"name": "--mdc-popover-inverted-background-color",
|
4074
|
+
"inheritedFrom": {
|
4075
|
+
"name": "Popover",
|
4076
|
+
"module": "src/components/popover/popover.component.ts"
|
4077
|
+
}
|
3577
4078
|
},
|
3578
4079
|
{
|
3579
|
-
"
|
3580
|
-
"name": "
|
3581
|
-
"
|
3582
|
-
|
3583
|
-
|
3584
|
-
"type": {
|
3585
|
-
"text": ""
|
3586
|
-
}
|
4080
|
+
"description": "inverted border color of the popover",
|
4081
|
+
"name": "--mdc-popover-inverted-border-color",
|
4082
|
+
"inheritedFrom": {
|
4083
|
+
"name": "Popover",
|
4084
|
+
"module": "src/components/popover/popover.component.ts"
|
3587
4085
|
}
|
3588
4086
|
},
|
3589
4087
|
{
|
3590
|
-
"
|
3591
|
-
"name": "
|
3592
|
-
"type": {
|
3593
|
-
"text": "IconNames | undefined"
|
3594
|
-
},
|
3595
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3596
|
-
"attribute": "icon-name",
|
4088
|
+
"description": "inverted text color of the popover",
|
4089
|
+
"name": "--mdc-popover-inverted-text-color",
|
3597
4090
|
"inheritedFrom": {
|
3598
|
-
"name": "
|
3599
|
-
"module": "
|
4091
|
+
"name": "Popover",
|
4092
|
+
"module": "src/components/popover/popover.component.ts"
|
4093
|
+
}
|
4094
|
+
},
|
4095
|
+
{
|
4096
|
+
"description": "elevation of the popover",
|
4097
|
+
"name": "--mdc-popover-elevation-3",
|
4098
|
+
"inheritedFrom": {
|
4099
|
+
"name": "Popover",
|
4100
|
+
"module": "src/components/popover/popover.component.ts"
|
4101
|
+
}
|
4102
|
+
},
|
4103
|
+
{
|
4104
|
+
"description": "max width of the popover",
|
4105
|
+
"name": "--mdc-popover-max-width",
|
4106
|
+
"inheritedFrom": {
|
4107
|
+
"name": "Popover",
|
4108
|
+
"module": "src/components/popover/popover.component.ts"
|
3600
4109
|
}
|
3601
4110
|
},
|
4111
|
+
{
|
4112
|
+
"description": "max height of the popover",
|
4113
|
+
"name": "--mdc-popover-max-height",
|
4114
|
+
"inheritedFrom": {
|
4115
|
+
"name": "Popover",
|
4116
|
+
"module": "src/components/popover/popover.component.ts"
|
4117
|
+
}
|
4118
|
+
}
|
4119
|
+
],
|
4120
|
+
"slots": [
|
4121
|
+
{
|
4122
|
+
"description": "Default slot for modal container",
|
4123
|
+
"name": "",
|
4124
|
+
"inheritedFrom": {
|
4125
|
+
"name": "Popover",
|
4126
|
+
"module": "src/components/popover/popover.component.ts"
|
4127
|
+
}
|
4128
|
+
}
|
4129
|
+
],
|
4130
|
+
"members": [
|
3602
4131
|
{
|
3603
4132
|
"kind": "field",
|
3604
|
-
"name": "
|
4133
|
+
"name": "trigger",
|
3605
4134
|
"type": {
|
3606
|
-
"text": "
|
4135
|
+
"text": "PopoverTrigger"
|
3607
4136
|
},
|
3608
|
-
"
|
3609
|
-
"
|
3610
|
-
"attribute": "
|
4137
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
4138
|
+
"default": "manual",
|
4139
|
+
"attribute": "trigger",
|
3611
4140
|
"reflects": true,
|
3612
4141
|
"inheritedFrom": {
|
3613
|
-
"name": "
|
3614
|
-
"module": "components/
|
4142
|
+
"name": "Popover",
|
4143
|
+
"module": "components/popover/popover.component.js"
|
3615
4144
|
}
|
3616
4145
|
},
|
3617
4146
|
{
|
3618
4147
|
"kind": "field",
|
3619
|
-
"name": "
|
4148
|
+
"name": "showArrow",
|
3620
4149
|
"type": {
|
3621
|
-
"text": "boolean
|
4150
|
+
"text": "boolean"
|
3622
4151
|
},
|
3623
|
-
"description": "
|
3624
|
-
"default": "
|
3625
|
-
"attribute": "
|
4152
|
+
"description": "The arrow visibility of the Coachmark.",
|
4153
|
+
"default": "true",
|
4154
|
+
"attribute": "show-arrow",
|
3626
4155
|
"reflects": true,
|
3627
4156
|
"inheritedFrom": {
|
3628
|
-
"name": "
|
3629
|
-
"module": "components/
|
4157
|
+
"name": "Popover",
|
4158
|
+
"module": "components/popover/popover.component.js"
|
3630
4159
|
}
|
3631
4160
|
},
|
3632
4161
|
{
|
3633
4162
|
"kind": "field",
|
3634
|
-
"name": "
|
4163
|
+
"name": "closeButton",
|
3635
4164
|
"type": {
|
3636
|
-
"text": "boolean
|
4165
|
+
"text": "boolean"
|
3637
4166
|
},
|
3638
|
-
"description": "The
|
3639
|
-
"default": "
|
3640
|
-
"attribute": "
|
4167
|
+
"description": "The close button visibility of the Coachmark.",
|
4168
|
+
"default": "true",
|
4169
|
+
"attribute": "close-button",
|
3641
4170
|
"reflects": true,
|
3642
4171
|
"inheritedFrom": {
|
3643
|
-
"name": "
|
3644
|
-
"module": "components/
|
4172
|
+
"name": "Popover",
|
4173
|
+
"module": "components/popover/popover.component.js"
|
3645
4174
|
}
|
3646
4175
|
},
|
3647
4176
|
{
|
3648
4177
|
"kind": "field",
|
3649
|
-
"name": "
|
4178
|
+
"name": "disableAriaExpanded",
|
3650
4179
|
"type": {
|
3651
|
-
"text": "boolean
|
4180
|
+
"text": "boolean"
|
3652
4181
|
},
|
3653
|
-
"description": "
|
3654
|
-
"default": "
|
3655
|
-
"attribute": "
|
4182
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
4183
|
+
"default": "true",
|
4184
|
+
"attribute": "disable-aria-expanded",
|
4185
|
+
"reflects": true,
|
3656
4186
|
"inheritedFrom": {
|
3657
|
-
"name": "
|
3658
|
-
"module": "components/
|
4187
|
+
"name": "Popover",
|
4188
|
+
"module": "components/popover/popover.component.js"
|
3659
4189
|
}
|
3660
4190
|
},
|
3661
4191
|
{
|
3662
4192
|
"kind": "field",
|
3663
|
-
"name": "
|
4193
|
+
"name": "enabledFocusTrap",
|
3664
4194
|
"type": {
|
3665
|
-
"text": "
|
4195
|
+
"text": "boolean"
|
3666
4196
|
},
|
3667
|
-
"description": "
|
3668
|
-
"default": "
|
3669
|
-
"attribute": "
|
3670
|
-
"reflects": true,
|
3671
|
-
"inheritedFrom": {
|
3672
|
-
"name": "Buttonsimple",
|
3673
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
3674
|
-
}
|
3675
|
-
},
|
3676
|
-
{
|
3677
|
-
"kind": "field",
|
3678
|
-
"name": "role",
|
3679
|
-
"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.",
|
3680
|
-
"default": "button",
|
3681
|
-
"attribute": "role",
|
3682
|
-
"reflects": true,
|
4197
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
4198
|
+
"default": "false",
|
4199
|
+
"attribute": "enabledFocusTrap",
|
3683
4200
|
"inheritedFrom": {
|
3684
|
-
"name": "
|
3685
|
-
"module": "
|
4201
|
+
"name": "FocusTrapMixin",
|
4202
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3686
4203
|
}
|
3687
4204
|
},
|
3688
4205
|
{
|
3689
4206
|
"kind": "field",
|
3690
|
-
"name": "
|
4207
|
+
"name": "enabledPreventScroll",
|
3691
4208
|
"type": {
|
3692
|
-
"text": "
|
4209
|
+
"text": "boolean"
|
3693
4210
|
},
|
3694
|
-
"description": "
|
3695
|
-
"default": "
|
3696
|
-
"attribute": "
|
3697
|
-
"reflects": true,
|
4211
|
+
"description": "Prevent outside scrolling when popover show.",
|
4212
|
+
"default": "false",
|
4213
|
+
"attribute": "enabledPreventScroll",
|
3698
4214
|
"inheritedFrom": {
|
3699
|
-
"name": "
|
3700
|
-
"module": "
|
4215
|
+
"name": "FocusTrapMixin",
|
4216
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3701
4217
|
}
|
3702
4218
|
},
|
3703
4219
|
{
|
3704
4220
|
"kind": "field",
|
3705
|
-
"name": "
|
4221
|
+
"name": "shouldWrapFocus",
|
3706
4222
|
"type": {
|
3707
|
-
"text": "
|
4223
|
+
"text": "() => boolean"
|
3708
4224
|
},
|
3709
|
-
"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.",
|
3710
|
-
"default": "button",
|
3711
|
-
"attribute": "type",
|
3712
|
-
"reflects": true,
|
3713
4225
|
"inheritedFrom": {
|
3714
|
-
"name": "
|
3715
|
-
"module": "
|
4226
|
+
"name": "FocusTrapMixin",
|
4227
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3716
4228
|
}
|
3717
4229
|
},
|
3718
4230
|
{
|
3719
4231
|
"kind": "method",
|
3720
|
-
"name": "
|
3721
|
-
"
|
4232
|
+
"name": "deactivateFocusTrap",
|
4233
|
+
"description": "Deactivate the focus trap.",
|
3722
4234
|
"inheritedFrom": {
|
3723
|
-
"name": "
|
3724
|
-
"module": "
|
4235
|
+
"name": "FocusTrapMixin",
|
4236
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3725
4237
|
}
|
3726
4238
|
},
|
3727
4239
|
{
|
3728
4240
|
"kind": "method",
|
3729
|
-
"name": "
|
3730
|
-
"privacy": "
|
4241
|
+
"name": "hasNoClientRects",
|
4242
|
+
"privacy": "private",
|
3731
4243
|
"parameters": [
|
3732
4244
|
{
|
3733
4245
|
"name": "element",
|
3734
4246
|
"type": {
|
3735
4247
|
"text": "HTMLElement"
|
3736
4248
|
},
|
3737
|
-
"description": "The
|
3738
|
-
},
|
3739
|
-
{
|
3740
|
-
"name": "active",
|
3741
|
-
"optional": true,
|
3742
|
-
"type": {
|
3743
|
-
"text": "boolean"
|
3744
|
-
},
|
3745
|
-
"description": "The active state of the element"
|
4249
|
+
"description": "The element to check."
|
3746
4250
|
}
|
3747
4251
|
],
|
3748
|
-
"description": "
|
4252
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
4253
|
+
"return": {
|
4254
|
+
"type": {
|
4255
|
+
"text": ""
|
4256
|
+
}
|
4257
|
+
},
|
3749
4258
|
"inheritedFrom": {
|
3750
|
-
"name": "
|
3751
|
-
"module": "
|
4259
|
+
"name": "FocusTrapMixin",
|
4260
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3752
4261
|
}
|
3753
4262
|
},
|
3754
4263
|
{
|
3755
4264
|
"kind": "method",
|
3756
|
-
"name": "
|
4265
|
+
"name": "hasZeroDimensions",
|
3757
4266
|
"privacy": "private",
|
3758
4267
|
"parameters": [
|
3759
4268
|
{
|
@@ -3761,26 +4270,47 @@
|
|
3761
4270
|
"type": {
|
3762
4271
|
"text": "HTMLElement"
|
3763
4272
|
},
|
3764
|
-
"description": "The
|
3765
|
-
}
|
4273
|
+
"description": "The element to check."
|
4274
|
+
}
|
4275
|
+
],
|
4276
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
4277
|
+
"return": {
|
4278
|
+
"type": {
|
4279
|
+
"text": ""
|
4280
|
+
}
|
4281
|
+
},
|
4282
|
+
"inheritedFrom": {
|
4283
|
+
"name": "FocusTrapMixin",
|
4284
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
4285
|
+
}
|
4286
|
+
},
|
4287
|
+
{
|
4288
|
+
"kind": "method",
|
4289
|
+
"name": "isNotVisible",
|
4290
|
+
"privacy": "private",
|
4291
|
+
"parameters": [
|
3766
4292
|
{
|
3767
|
-
"name": "
|
3768
|
-
"optional": true,
|
4293
|
+
"name": "element",
|
3769
4294
|
"type": {
|
3770
|
-
"text": "
|
4295
|
+
"text": "HTMLElement"
|
3771
4296
|
},
|
3772
|
-
"description": "The
|
4297
|
+
"description": "The element to check."
|
3773
4298
|
}
|
3774
4299
|
],
|
3775
|
-
"description": "
|
4300
|
+
"description": "Determines if the element is not visible in the DOM.",
|
4301
|
+
"return": {
|
4302
|
+
"type": {
|
4303
|
+
"text": ""
|
4304
|
+
}
|
4305
|
+
},
|
3776
4306
|
"inheritedFrom": {
|
3777
|
-
"name": "
|
3778
|
-
"module": "
|
4307
|
+
"name": "FocusTrapMixin",
|
4308
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3779
4309
|
}
|
3780
4310
|
},
|
3781
4311
|
{
|
3782
4312
|
"kind": "method",
|
3783
|
-
"name": "
|
4313
|
+
"name": "hasHiddenStyle",
|
3784
4314
|
"privacy": "private",
|
3785
4315
|
"parameters": [
|
3786
4316
|
{
|
@@ -3788,700 +4318,138 @@
|
|
3788
4318
|
"type": {
|
3789
4319
|
"text": "HTMLElement"
|
3790
4320
|
},
|
3791
|
-
"description": "The
|
3792
|
-
}
|
4321
|
+
"description": "The element to check."
|
4322
|
+
}
|
4323
|
+
],
|
4324
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
4325
|
+
"return": {
|
4326
|
+
"type": {
|
4327
|
+
"text": ""
|
4328
|
+
}
|
4329
|
+
},
|
4330
|
+
"inheritedFrom": {
|
4331
|
+
"name": "FocusTrapMixin",
|
4332
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
4333
|
+
}
|
4334
|
+
},
|
4335
|
+
{
|
4336
|
+
"kind": "method",
|
4337
|
+
"name": "hasComputedHidden",
|
4338
|
+
"privacy": "private",
|
4339
|
+
"parameters": [
|
3793
4340
|
{
|
3794
|
-
"name": "
|
4341
|
+
"name": "element",
|
3795
4342
|
"type": {
|
3796
|
-
"text": "
|
4343
|
+
"text": "HTMLElement"
|
3797
4344
|
},
|
3798
|
-
"description": "The
|
4345
|
+
"description": "The element to check."
|
3799
4346
|
}
|
3800
4347
|
],
|
3801
|
-
"description": "
|
4348
|
+
"description": "Checks if the element is hidden by a computed style.",
|
4349
|
+
"return": {
|
4350
|
+
"type": {
|
4351
|
+
"text": ""
|
4352
|
+
}
|
4353
|
+
},
|
3802
4354
|
"inheritedFrom": {
|
3803
|
-
"name": "
|
3804
|
-
"module": "
|
4355
|
+
"name": "FocusTrapMixin",
|
4356
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3805
4357
|
}
|
3806
4358
|
},
|
3807
4359
|
{
|
3808
4360
|
"kind": "method",
|
3809
|
-
"name": "
|
4361
|
+
"name": "isHidden",
|
3810
4362
|
"privacy": "private",
|
4363
|
+
"parameters": [
|
4364
|
+
{
|
4365
|
+
"name": "element",
|
4366
|
+
"type": {
|
4367
|
+
"text": "HTMLElement"
|
4368
|
+
},
|
4369
|
+
"description": "The element to check."
|
4370
|
+
}
|
4371
|
+
],
|
4372
|
+
"description": "Checks if the element is hidden from the user.",
|
4373
|
+
"return": {
|
4374
|
+
"type": {
|
4375
|
+
"text": ""
|
4376
|
+
}
|
4377
|
+
},
|
3811
4378
|
"inheritedFrom": {
|
3812
|
-
"name": "
|
3813
|
-
"module": "
|
4379
|
+
"name": "FocusTrapMixin",
|
4380
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3814
4381
|
}
|
3815
4382
|
},
|
3816
4383
|
{
|
3817
4384
|
"kind": "method",
|
3818
|
-
"name": "
|
4385
|
+
"name": "isNotTabbable",
|
3819
4386
|
"privacy": "private",
|
3820
|
-
"
|
4387
|
+
"parameters": [
|
4388
|
+
{
|
4389
|
+
"name": "element",
|
4390
|
+
"type": {
|
4391
|
+
"text": "HTMLElement"
|
4392
|
+
},
|
4393
|
+
"description": "The element to check."
|
4394
|
+
}
|
4395
|
+
],
|
4396
|
+
"description": "Checks if the element is not tabbable.",
|
4397
|
+
"return": {
|
4398
|
+
"type": {
|
4399
|
+
"text": ""
|
4400
|
+
}
|
4401
|
+
},
|
3821
4402
|
"inheritedFrom": {
|
3822
|
-
"name": "
|
3823
|
-
"module": "
|
4403
|
+
"name": "FocusTrapMixin",
|
4404
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3824
4405
|
}
|
3825
4406
|
},
|
3826
4407
|
{
|
3827
4408
|
"kind": "method",
|
3828
|
-
"name": "
|
4409
|
+
"name": "isInteractiveElement",
|
3829
4410
|
"privacy": "private",
|
4411
|
+
"return": {
|
4412
|
+
"type": {
|
4413
|
+
"text": ""
|
4414
|
+
}
|
4415
|
+
},
|
3830
4416
|
"parameters": [
|
3831
4417
|
{
|
3832
|
-
"name": "
|
4418
|
+
"name": "element",
|
3833
4419
|
"type": {
|
3834
|
-
"text": "
|
4420
|
+
"text": "HTMLElement"
|
3835
4421
|
},
|
3836
|
-
"description": "The
|
4422
|
+
"description": "The element to check."
|
3837
4423
|
}
|
3838
4424
|
],
|
3839
|
-
"description": "
|
4425
|
+
"description": "Checks if the element is interactive.",
|
3840
4426
|
"inheritedFrom": {
|
3841
|
-
"name": "
|
3842
|
-
"module": "
|
4427
|
+
"name": "FocusTrapMixin",
|
4428
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3843
4429
|
}
|
3844
4430
|
},
|
3845
4431
|
{
|
3846
4432
|
"kind": "method",
|
3847
|
-
"name": "
|
4433
|
+
"name": "isFocusable",
|
3848
4434
|
"privacy": "private",
|
3849
4435
|
"parameters": [
|
3850
4436
|
{
|
3851
|
-
"name": "
|
4437
|
+
"name": "element",
|
3852
4438
|
"type": {
|
3853
|
-
"text": "
|
4439
|
+
"text": "HTMLElement"
|
3854
4440
|
},
|
3855
|
-
"description": "The
|
4441
|
+
"description": "The element to check."
|
3856
4442
|
}
|
3857
4443
|
],
|
3858
|
-
"description": "
|
4444
|
+
"description": "Checks if the element is focusable.",
|
4445
|
+
"return": {
|
4446
|
+
"type": {
|
4447
|
+
"text": ""
|
4448
|
+
}
|
4449
|
+
},
|
3859
4450
|
"inheritedFrom": {
|
3860
|
-
"name": "
|
3861
|
-
"module": "
|
3862
|
-
}
|
3863
|
-
}
|
3864
|
-
],
|
3865
|
-
"attributes": [
|
3866
|
-
{
|
3867
|
-
"name": "color",
|
3868
|
-
"type": {
|
3869
|
-
"text": "ColorType"
|
3870
|
-
},
|
3871
|
-
"description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
|
3872
|
-
"default": "default",
|
3873
|
-
"fieldName": "color"
|
3874
|
-
},
|
3875
|
-
{
|
3876
|
-
"name": "label",
|
3877
|
-
"type": {
|
3878
|
-
"text": "string"
|
3879
|
-
},
|
3880
|
-
"default": "''",
|
3881
|
-
"description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
3882
|
-
"fieldName": "label"
|
3883
|
-
},
|
3884
|
-
{
|
3885
|
-
"name": "icon-name",
|
3886
|
-
"type": {
|
3887
|
-
"text": "IconNames | undefined"
|
3888
|
-
},
|
3889
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3890
|
-
"fieldName": "iconName",
|
3891
|
-
"inheritedFrom": {
|
3892
|
-
"name": "IconNameMixin",
|
3893
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
3894
|
-
}
|
3895
|
-
},
|
3896
|
-
{
|
3897
|
-
"name": "tabIndex",
|
3898
|
-
"type": {
|
3899
|
-
"text": "number"
|
3900
|
-
},
|
3901
|
-
"default": "0",
|
3902
|
-
"description": "This property specifies the tab order of the element.",
|
3903
|
-
"fieldName": "tabIndex",
|
3904
|
-
"inheritedFrom": {
|
3905
|
-
"name": "Buttonsimple",
|
3906
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3907
|
-
}
|
3908
|
-
},
|
3909
|
-
{
|
3910
|
-
"name": "disabled",
|
3911
|
-
"type": {
|
3912
|
-
"text": "boolean | undefined"
|
3913
|
-
},
|
3914
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3915
|
-
"default": "undefined",
|
3916
|
-
"fieldName": "disabled",
|
3917
|
-
"inheritedFrom": {
|
3918
|
-
"name": "Buttonsimple",
|
3919
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3920
|
-
}
|
3921
|
-
},
|
3922
|
-
{
|
3923
|
-
"name": "active",
|
3924
|
-
"type": {
|
3925
|
-
"text": "boolean | undefined"
|
3926
|
-
},
|
3927
|
-
"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.",
|
3928
|
-
"default": "undefined",
|
3929
|
-
"fieldName": "active",
|
3930
|
-
"inheritedFrom": {
|
3931
|
-
"name": "Buttonsimple",
|
3932
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3933
|
-
}
|
3934
|
-
},
|
3935
|
-
{
|
3936
|
-
"name": "soft-disabled",
|
3937
|
-
"type": {
|
3938
|
-
"text": "boolean | undefined"
|
3939
|
-
},
|
3940
|
-
"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.",
|
3941
|
-
"default": "undefined",
|
3942
|
-
"fieldName": "softDisabled",
|
3943
|
-
"inheritedFrom": {
|
3944
|
-
"name": "Buttonsimple",
|
3945
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3946
|
-
}
|
3947
|
-
},
|
3948
|
-
{
|
3949
|
-
"name": "size",
|
3950
|
-
"type": {
|
3951
|
-
"text": "ButtonSize"
|
3952
|
-
},
|
3953
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
3954
|
-
"default": "32",
|
3955
|
-
"fieldName": "size",
|
3956
|
-
"inheritedFrom": {
|
3957
|
-
"name": "Buttonsimple",
|
3958
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3959
|
-
}
|
3960
|
-
},
|
3961
|
-
{
|
3962
|
-
"name": "role",
|
3963
|
-
"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.",
|
3964
|
-
"default": "button",
|
3965
|
-
"fieldName": "role",
|
3966
|
-
"inheritedFrom": {
|
3967
|
-
"name": "Buttonsimple",
|
3968
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3969
|
-
}
|
3970
|
-
},
|
3971
|
-
{
|
3972
|
-
"name": "ariaStateKey",
|
3973
|
-
"type": {
|
3974
|
-
"text": "string | undefined"
|
3975
|
-
},
|
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`",
|
3977
|
-
"default": "'aria-pressed' (when)",
|
3978
|
-
"fieldName": "ariaStateKey",
|
3979
|
-
"inheritedFrom": {
|
3980
|
-
"name": "Buttonsimple",
|
3981
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3982
|
-
}
|
3983
|
-
},
|
3984
|
-
{
|
3985
|
-
"name": "type",
|
3986
|
-
"type": {
|
3987
|
-
"text": "ButtonType"
|
3988
|
-
},
|
3989
|
-
"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.",
|
3990
|
-
"default": "button",
|
3991
|
-
"fieldName": "type",
|
3992
|
-
"inheritedFrom": {
|
3993
|
-
"name": "Buttonsimple",
|
3994
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3995
|
-
}
|
3996
|
-
}
|
3997
|
-
],
|
3998
|
-
"mixins": [
|
3999
|
-
{
|
4000
|
-
"name": "IconNameMixin",
|
4001
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
4002
|
-
}
|
4003
|
-
],
|
4004
|
-
"superclass": {
|
4005
|
-
"name": "Buttonsimple",
|
4006
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
4007
|
-
},
|
4008
|
-
"tagName": "mdc-chip",
|
4009
|
-
"jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
4010
|
-
"customElement": true,
|
4011
|
-
"events": [
|
4012
|
-
{
|
4013
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
4014
|
-
"name": "click",
|
4015
|
-
"reactName": "onClick",
|
4016
|
-
"inheritedFrom": {
|
4017
|
-
"name": "Buttonsimple",
|
4018
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4019
|
-
}
|
4020
|
-
},
|
4021
|
-
{
|
4022
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
4023
|
-
"name": "keydown",
|
4024
|
-
"reactName": "onKeyDown",
|
4025
|
-
"inheritedFrom": {
|
4026
|
-
"name": "Buttonsimple",
|
4027
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4028
|
-
}
|
4029
|
-
},
|
4030
|
-
{
|
4031
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
4032
|
-
"name": "keyup",
|
4033
|
-
"reactName": "onKeyUp",
|
4034
|
-
"inheritedFrom": {
|
4035
|
-
"name": "Buttonsimple",
|
4036
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4037
|
-
}
|
4038
|
-
},
|
4039
|
-
{
|
4040
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
4041
|
-
"name": "focus",
|
4042
|
-
"reactName": "onFocus",
|
4043
|
-
"inheritedFrom": {
|
4044
|
-
"name": "Buttonsimple",
|
4045
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4046
|
-
}
|
4047
|
-
}
|
4048
|
-
]
|
4049
|
-
}
|
4050
|
-
],
|
4051
|
-
"exports": [
|
4052
|
-
{
|
4053
|
-
"kind": "js",
|
4054
|
-
"name": "default",
|
4055
|
-
"declaration": {
|
4056
|
-
"name": "Chip",
|
4057
|
-
"module": "components/chip/chip.component.js"
|
4058
|
-
}
|
4059
|
-
}
|
4060
|
-
]
|
4061
|
-
},
|
4062
|
-
{
|
4063
|
-
"kind": "javascript-module",
|
4064
|
-
"path": "components/coachmark/coachmark.component.js",
|
4065
|
-
"declarations": [
|
4066
|
-
{
|
4067
|
-
"kind": "class",
|
4068
|
-
"description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
|
4069
|
-
"name": "Coachmark",
|
4070
|
-
"cssProperties": [
|
4071
|
-
{
|
4072
|
-
"description": "radius of the arrow border",
|
4073
|
-
"name": "--mdc-popover-arrow-border-radius",
|
4074
|
-
"inheritedFrom": {
|
4075
|
-
"name": "Popover",
|
4076
|
-
"module": "src/components/popover/popover.component.ts"
|
4077
|
-
}
|
4078
|
-
},
|
4079
|
-
{
|
4080
|
-
"description": "border of the arrow",
|
4081
|
-
"name": "--mdc-popover-arrow-border",
|
4082
|
-
"inheritedFrom": {
|
4083
|
-
"name": "Popover",
|
4084
|
-
"module": "src/components/popover/popover.component.ts"
|
4085
|
-
}
|
4086
|
-
},
|
4087
|
-
{
|
4088
|
-
"description": "primary background color of the popover",
|
4089
|
-
"name": "--mdc-popover-primary-background-color",
|
4090
|
-
"inheritedFrom": {
|
4091
|
-
"name": "Popover",
|
4092
|
-
"module": "src/components/popover/popover.component.ts"
|
4093
|
-
}
|
4094
|
-
},
|
4095
|
-
{
|
4096
|
-
"description": "border color of the popover",
|
4097
|
-
"name": "--mdc-popover-border-color",
|
4098
|
-
"inheritedFrom": {
|
4099
|
-
"name": "Popover",
|
4100
|
-
"module": "src/components/popover/popover.component.ts"
|
4101
|
-
}
|
4102
|
-
},
|
4103
|
-
{
|
4104
|
-
"description": "inverted background color of the popover",
|
4105
|
-
"name": "--mdc-popover-inverted-background-color",
|
4106
|
-
"inheritedFrom": {
|
4107
|
-
"name": "Popover",
|
4108
|
-
"module": "src/components/popover/popover.component.ts"
|
4109
|
-
}
|
4110
|
-
},
|
4111
|
-
{
|
4112
|
-
"description": "inverted border color of the popover",
|
4113
|
-
"name": "--mdc-popover-inverted-border-color",
|
4114
|
-
"inheritedFrom": {
|
4115
|
-
"name": "Popover",
|
4116
|
-
"module": "src/components/popover/popover.component.ts"
|
4117
|
-
}
|
4118
|
-
},
|
4119
|
-
{
|
4120
|
-
"description": "inverted text color of the popover",
|
4121
|
-
"name": "--mdc-popover-inverted-text-color",
|
4122
|
-
"inheritedFrom": {
|
4123
|
-
"name": "Popover",
|
4124
|
-
"module": "src/components/popover/popover.component.ts"
|
4125
|
-
}
|
4126
|
-
},
|
4127
|
-
{
|
4128
|
-
"description": "elevation of the popover",
|
4129
|
-
"name": "--mdc-popover-elevation-3",
|
4130
|
-
"inheritedFrom": {
|
4131
|
-
"name": "Popover",
|
4132
|
-
"module": "src/components/popover/popover.component.ts"
|
4133
|
-
}
|
4134
|
-
},
|
4135
|
-
{
|
4136
|
-
"description": "max width of the popover",
|
4137
|
-
"name": "--mdc-popover-max-width",
|
4138
|
-
"inheritedFrom": {
|
4139
|
-
"name": "Popover",
|
4140
|
-
"module": "src/components/popover/popover.component.ts"
|
4141
|
-
}
|
4142
|
-
},
|
4143
|
-
{
|
4144
|
-
"description": "max height of the popover",
|
4145
|
-
"name": "--mdc-popover-max-height",
|
4146
|
-
"inheritedFrom": {
|
4147
|
-
"name": "Popover",
|
4148
|
-
"module": "src/components/popover/popover.component.ts"
|
4149
|
-
}
|
4150
|
-
}
|
4151
|
-
],
|
4152
|
-
"slots": [
|
4153
|
-
{
|
4154
|
-
"description": "Default slot for modal container",
|
4155
|
-
"name": "",
|
4156
|
-
"inheritedFrom": {
|
4157
|
-
"name": "Popover",
|
4158
|
-
"module": "src/components/popover/popover.component.ts"
|
4159
|
-
}
|
4160
|
-
}
|
4161
|
-
],
|
4162
|
-
"members": [
|
4163
|
-
{
|
4164
|
-
"kind": "field",
|
4165
|
-
"name": "trigger",
|
4166
|
-
"type": {
|
4167
|
-
"text": "PopoverTrigger"
|
4168
|
-
},
|
4169
|
-
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
4170
|
-
"default": "manual",
|
4171
|
-
"attribute": "trigger",
|
4172
|
-
"reflects": true,
|
4173
|
-
"inheritedFrom": {
|
4174
|
-
"name": "Popover",
|
4175
|
-
"module": "components/popover/popover.component.js"
|
4176
|
-
}
|
4177
|
-
},
|
4178
|
-
{
|
4179
|
-
"kind": "field",
|
4180
|
-
"name": "showArrow",
|
4181
|
-
"type": {
|
4182
|
-
"text": "boolean"
|
4183
|
-
},
|
4184
|
-
"description": "The arrow visibility of the Coachmark.",
|
4185
|
-
"default": "true",
|
4186
|
-
"attribute": "show-arrow",
|
4187
|
-
"reflects": true,
|
4188
|
-
"inheritedFrom": {
|
4189
|
-
"name": "Popover",
|
4190
|
-
"module": "components/popover/popover.component.js"
|
4191
|
-
}
|
4192
|
-
},
|
4193
|
-
{
|
4194
|
-
"kind": "field",
|
4195
|
-
"name": "closeButton",
|
4196
|
-
"type": {
|
4197
|
-
"text": "boolean"
|
4198
|
-
},
|
4199
|
-
"description": "The close button visibility of the Coachmark.",
|
4200
|
-
"default": "true",
|
4201
|
-
"attribute": "close-button",
|
4202
|
-
"reflects": true,
|
4203
|
-
"inheritedFrom": {
|
4204
|
-
"name": "Popover",
|
4205
|
-
"module": "components/popover/popover.component.js"
|
4206
|
-
}
|
4207
|
-
},
|
4208
|
-
{
|
4209
|
-
"kind": "field",
|
4210
|
-
"name": "disableAriaExpanded",
|
4211
|
-
"type": {
|
4212
|
-
"text": "boolean"
|
4213
|
-
},
|
4214
|
-
"description": "Disable aria-expanded attribute on trigger element.",
|
4215
|
-
"default": "true",
|
4216
|
-
"attribute": "disable-aria-expanded",
|
4217
|
-
"reflects": true,
|
4218
|
-
"inheritedFrom": {
|
4219
|
-
"name": "Popover",
|
4220
|
-
"module": "components/popover/popover.component.js"
|
4221
|
-
}
|
4222
|
-
},
|
4223
|
-
{
|
4224
|
-
"kind": "field",
|
4225
|
-
"name": "enabledFocusTrap",
|
4226
|
-
"type": {
|
4227
|
-
"text": "boolean"
|
4228
|
-
},
|
4229
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
4230
|
-
"default": "false",
|
4231
|
-
"attribute": "enabledFocusTrap",
|
4232
|
-
"inheritedFrom": {
|
4233
|
-
"name": "FocusTrapMixin",
|
4234
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4235
|
-
}
|
4236
|
-
},
|
4237
|
-
{
|
4238
|
-
"kind": "field",
|
4239
|
-
"name": "enabledPreventScroll",
|
4240
|
-
"type": {
|
4241
|
-
"text": "boolean"
|
4242
|
-
},
|
4243
|
-
"description": "Prevent outside scrolling when popover show.",
|
4244
|
-
"default": "false",
|
4245
|
-
"attribute": "enabledPreventScroll",
|
4246
|
-
"inheritedFrom": {
|
4247
|
-
"name": "FocusTrapMixin",
|
4248
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4249
|
-
}
|
4250
|
-
},
|
4251
|
-
{
|
4252
|
-
"kind": "field",
|
4253
|
-
"name": "shouldWrapFocus",
|
4254
|
-
"type": {
|
4255
|
-
"text": "() => boolean"
|
4256
|
-
},
|
4257
|
-
"inheritedFrom": {
|
4258
|
-
"name": "FocusTrapMixin",
|
4259
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4260
|
-
}
|
4261
|
-
},
|
4262
|
-
{
|
4263
|
-
"kind": "method",
|
4264
|
-
"name": "deactivateFocusTrap",
|
4265
|
-
"description": "Deactivate the focus trap.",
|
4266
|
-
"inheritedFrom": {
|
4267
|
-
"name": "FocusTrapMixin",
|
4268
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4269
|
-
}
|
4270
|
-
},
|
4271
|
-
{
|
4272
|
-
"kind": "method",
|
4273
|
-
"name": "hasNoClientRects",
|
4274
|
-
"privacy": "private",
|
4275
|
-
"parameters": [
|
4276
|
-
{
|
4277
|
-
"name": "element",
|
4278
|
-
"type": {
|
4279
|
-
"text": "HTMLElement"
|
4280
|
-
},
|
4281
|
-
"description": "The element to check."
|
4282
|
-
}
|
4283
|
-
],
|
4284
|
-
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
4285
|
-
"return": {
|
4286
|
-
"type": {
|
4287
|
-
"text": ""
|
4288
|
-
}
|
4289
|
-
},
|
4290
|
-
"inheritedFrom": {
|
4291
|
-
"name": "FocusTrapMixin",
|
4292
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4293
|
-
}
|
4294
|
-
},
|
4295
|
-
{
|
4296
|
-
"kind": "method",
|
4297
|
-
"name": "hasZeroDimensions",
|
4298
|
-
"privacy": "private",
|
4299
|
-
"parameters": [
|
4300
|
-
{
|
4301
|
-
"name": "element",
|
4302
|
-
"type": {
|
4303
|
-
"text": "HTMLElement"
|
4304
|
-
},
|
4305
|
-
"description": "The element to check."
|
4306
|
-
}
|
4307
|
-
],
|
4308
|
-
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
4309
|
-
"return": {
|
4310
|
-
"type": {
|
4311
|
-
"text": ""
|
4312
|
-
}
|
4313
|
-
},
|
4314
|
-
"inheritedFrom": {
|
4315
|
-
"name": "FocusTrapMixin",
|
4316
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4317
|
-
}
|
4318
|
-
},
|
4319
|
-
{
|
4320
|
-
"kind": "method",
|
4321
|
-
"name": "isNotVisible",
|
4322
|
-
"privacy": "private",
|
4323
|
-
"parameters": [
|
4324
|
-
{
|
4325
|
-
"name": "element",
|
4326
|
-
"type": {
|
4327
|
-
"text": "HTMLElement"
|
4328
|
-
},
|
4329
|
-
"description": "The element to check."
|
4330
|
-
}
|
4331
|
-
],
|
4332
|
-
"description": "Determines if the element is not visible in the DOM.",
|
4333
|
-
"return": {
|
4334
|
-
"type": {
|
4335
|
-
"text": ""
|
4336
|
-
}
|
4337
|
-
},
|
4338
|
-
"inheritedFrom": {
|
4339
|
-
"name": "FocusTrapMixin",
|
4340
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4341
|
-
}
|
4342
|
-
},
|
4343
|
-
{
|
4344
|
-
"kind": "method",
|
4345
|
-
"name": "hasHiddenStyle",
|
4346
|
-
"privacy": "private",
|
4347
|
-
"parameters": [
|
4348
|
-
{
|
4349
|
-
"name": "element",
|
4350
|
-
"type": {
|
4351
|
-
"text": "HTMLElement"
|
4352
|
-
},
|
4353
|
-
"description": "The element to check."
|
4354
|
-
}
|
4355
|
-
],
|
4356
|
-
"description": "Checks if the element has inline styles that make it hidden.",
|
4357
|
-
"return": {
|
4358
|
-
"type": {
|
4359
|
-
"text": ""
|
4360
|
-
}
|
4361
|
-
},
|
4362
|
-
"inheritedFrom": {
|
4363
|
-
"name": "FocusTrapMixin",
|
4364
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4365
|
-
}
|
4366
|
-
},
|
4367
|
-
{
|
4368
|
-
"kind": "method",
|
4369
|
-
"name": "hasComputedHidden",
|
4370
|
-
"privacy": "private",
|
4371
|
-
"parameters": [
|
4372
|
-
{
|
4373
|
-
"name": "element",
|
4374
|
-
"type": {
|
4375
|
-
"text": "HTMLElement"
|
4376
|
-
},
|
4377
|
-
"description": "The element to check."
|
4378
|
-
}
|
4379
|
-
],
|
4380
|
-
"description": "Checks if the element is hidden by a computed style.",
|
4381
|
-
"return": {
|
4382
|
-
"type": {
|
4383
|
-
"text": ""
|
4384
|
-
}
|
4385
|
-
},
|
4386
|
-
"inheritedFrom": {
|
4387
|
-
"name": "FocusTrapMixin",
|
4388
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4389
|
-
}
|
4390
|
-
},
|
4391
|
-
{
|
4392
|
-
"kind": "method",
|
4393
|
-
"name": "isHidden",
|
4394
|
-
"privacy": "private",
|
4395
|
-
"parameters": [
|
4396
|
-
{
|
4397
|
-
"name": "element",
|
4398
|
-
"type": {
|
4399
|
-
"text": "HTMLElement"
|
4400
|
-
},
|
4401
|
-
"description": "The element to check."
|
4402
|
-
}
|
4403
|
-
],
|
4404
|
-
"description": "Checks if the element is hidden from the user.",
|
4405
|
-
"return": {
|
4406
|
-
"type": {
|
4407
|
-
"text": ""
|
4408
|
-
}
|
4409
|
-
},
|
4410
|
-
"inheritedFrom": {
|
4411
|
-
"name": "FocusTrapMixin",
|
4412
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4413
|
-
}
|
4414
|
-
},
|
4415
|
-
{
|
4416
|
-
"kind": "method",
|
4417
|
-
"name": "isNotTabbable",
|
4418
|
-
"privacy": "private",
|
4419
|
-
"parameters": [
|
4420
|
-
{
|
4421
|
-
"name": "element",
|
4422
|
-
"type": {
|
4423
|
-
"text": "HTMLElement"
|
4424
|
-
},
|
4425
|
-
"description": "The element to check."
|
4426
|
-
}
|
4427
|
-
],
|
4428
|
-
"description": "Checks if the element is not tabbable.",
|
4429
|
-
"return": {
|
4430
|
-
"type": {
|
4431
|
-
"text": ""
|
4432
|
-
}
|
4433
|
-
},
|
4434
|
-
"inheritedFrom": {
|
4435
|
-
"name": "FocusTrapMixin",
|
4436
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4437
|
-
}
|
4438
|
-
},
|
4439
|
-
{
|
4440
|
-
"kind": "method",
|
4441
|
-
"name": "isInteractiveElement",
|
4442
|
-
"privacy": "private",
|
4443
|
-
"return": {
|
4444
|
-
"type": {
|
4445
|
-
"text": ""
|
4446
|
-
}
|
4447
|
-
},
|
4448
|
-
"parameters": [
|
4449
|
-
{
|
4450
|
-
"name": "element",
|
4451
|
-
"type": {
|
4452
|
-
"text": "HTMLElement"
|
4453
|
-
},
|
4454
|
-
"description": "The element to check."
|
4455
|
-
}
|
4456
|
-
],
|
4457
|
-
"description": "Checks if the element is interactive.",
|
4458
|
-
"inheritedFrom": {
|
4459
|
-
"name": "FocusTrapMixin",
|
4460
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4461
|
-
}
|
4462
|
-
},
|
4463
|
-
{
|
4464
|
-
"kind": "method",
|
4465
|
-
"name": "isFocusable",
|
4466
|
-
"privacy": "private",
|
4467
|
-
"parameters": [
|
4468
|
-
{
|
4469
|
-
"name": "element",
|
4470
|
-
"type": {
|
4471
|
-
"text": "HTMLElement"
|
4472
|
-
},
|
4473
|
-
"description": "The element to check."
|
4474
|
-
}
|
4475
|
-
],
|
4476
|
-
"description": "Checks if the element is focusable.",
|
4477
|
-
"return": {
|
4478
|
-
"type": {
|
4479
|
-
"text": ""
|
4480
|
-
}
|
4481
|
-
},
|
4482
|
-
"inheritedFrom": {
|
4483
|
-
"name": "FocusTrapMixin",
|
4484
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
4451
|
+
"name": "FocusTrapMixin",
|
4452
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
4485
4453
|
}
|
4486
4454
|
},
|
4487
4455
|
{
|
@@ -8644,7 +8612,7 @@
|
|
8644
8612
|
"declarations": [
|
8645
8613
|
{
|
8646
8614
|
"kind": "class",
|
8647
|
-
"description": "`mdc-link` component can be used to navigate to a different page\nwithin the application or to an external site. It can be used to link to\nemails or phone numbers.\n\nThe `children` of the link component is expected to be
|
8615
|
+
"description": "`mdc-link` component can be used to navigate to a different page\nwithin the application or to an external site. It can be used to link to\nemails or phone numbers.\n\nThe `children` of the link component is expected to be the text content.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.",
|
8648
8616
|
"name": "Link",
|
8649
8617
|
"cssProperties": [
|
8650
8618
|
{
|
@@ -8726,6 +8694,43 @@
|
|
8726
8694
|
"attribute": "size",
|
8727
8695
|
"reflects": true
|
8728
8696
|
},
|
8697
|
+
{
|
8698
|
+
"kind": "field",
|
8699
|
+
"name": "href",
|
8700
|
+
"type": {
|
8701
|
+
"text": "string"
|
8702
|
+
},
|
8703
|
+
"default": "'#'",
|
8704
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
8705
|
+
"attribute": "href",
|
8706
|
+
"reflects": true
|
8707
|
+
},
|
8708
|
+
{
|
8709
|
+
"kind": "field",
|
8710
|
+
"name": "target",
|
8711
|
+
"type": {
|
8712
|
+
"text": "string"
|
8713
|
+
},
|
8714
|
+
"default": "'_self'",
|
8715
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
8716
|
+
"attribute": "target",
|
8717
|
+
"reflects": true
|
8718
|
+
},
|
8719
|
+
{
|
8720
|
+
"kind": "field",
|
8721
|
+
"name": "rel",
|
8722
|
+
"type": {
|
8723
|
+
"text": "string | undefined"
|
8724
|
+
},
|
8725
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
8726
|
+
"attribute": "rel",
|
8727
|
+
"reflects": true
|
8728
|
+
},
|
8729
|
+
{
|
8730
|
+
"kind": "field",
|
8731
|
+
"name": "handleNavigation",
|
8732
|
+
"privacy": "private"
|
8733
|
+
},
|
8729
8734
|
{
|
8730
8735
|
"kind": "method",
|
8731
8736
|
"name": "getIconSize",
|
@@ -8747,16 +8752,10 @@
|
|
8747
8752
|
"type": {
|
8748
8753
|
"text": "boolean"
|
8749
8754
|
},
|
8750
|
-
"description": "
|
8755
|
+
"description": "Whether the element should be disabled"
|
8751
8756
|
}
|
8752
8757
|
],
|
8753
|
-
"description": "
|
8754
|
-
},
|
8755
|
-
{
|
8756
|
-
"kind": "method",
|
8757
|
-
"name": "updateTrailingIcon",
|
8758
|
-
"privacy": "private",
|
8759
|
-
"description": "Method to create and append trailing icon to the first anchor element in the slot.\nIf no icon name is provided, no icon will be rendered."
|
8758
|
+
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored."
|
8760
8759
|
},
|
8761
8760
|
{
|
8762
8761
|
"kind": "field",
|
@@ -8774,17 +8773,54 @@
|
|
8774
8773
|
}
|
8775
8774
|
},
|
8776
8775
|
{
|
8777
|
-
"kind": "field",
|
8778
|
-
"name": "
|
8779
|
-
"type": {
|
8780
|
-
"text": "
|
8781
|
-
},
|
8782
|
-
"
|
8783
|
-
"
|
8784
|
-
"
|
8785
|
-
|
8786
|
-
|
8787
|
-
|
8776
|
+
"kind": "field",
|
8777
|
+
"name": "tabIndex",
|
8778
|
+
"type": {
|
8779
|
+
"text": "number"
|
8780
|
+
},
|
8781
|
+
"default": "0",
|
8782
|
+
"description": "This property specifies the tab order of the element.",
|
8783
|
+
"attribute": "tabIndex",
|
8784
|
+
"reflects": true,
|
8785
|
+
"inheritedFrom": {
|
8786
|
+
"name": "TabIndexMixin",
|
8787
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
8788
|
+
}
|
8789
|
+
},
|
8790
|
+
{
|
8791
|
+
"kind": "field",
|
8792
|
+
"name": "iconName",
|
8793
|
+
"type": {
|
8794
|
+
"text": "IconNames | undefined"
|
8795
|
+
},
|
8796
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8797
|
+
"attribute": "icon-name",
|
8798
|
+
"inheritedFrom": {
|
8799
|
+
"name": "IconNameMixin",
|
8800
|
+
"module": "utils/mixins/IconNameMixin.js"
|
8801
|
+
}
|
8802
|
+
}
|
8803
|
+
],
|
8804
|
+
"events": [
|
8805
|
+
{
|
8806
|
+
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
8807
|
+
"name": "click",
|
8808
|
+
"reactName": "onClick"
|
8809
|
+
},
|
8810
|
+
{
|
8811
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
8812
|
+
"name": "keydown",
|
8813
|
+
"reactName": "onKeyDown"
|
8814
|
+
},
|
8815
|
+
{
|
8816
|
+
"description": "(React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.",
|
8817
|
+
"name": "focus",
|
8818
|
+
"reactName": "onFocus"
|
8819
|
+
},
|
8820
|
+
{
|
8821
|
+
"description": "(React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.",
|
8822
|
+
"name": "blur",
|
8823
|
+
"reactName": "onBlur"
|
8788
8824
|
}
|
8789
8825
|
],
|
8790
8826
|
"attributes": [
|
@@ -8815,6 +8851,32 @@
|
|
8815
8851
|
"default": "large",
|
8816
8852
|
"fieldName": "size"
|
8817
8853
|
},
|
8854
|
+
{
|
8855
|
+
"name": "href",
|
8856
|
+
"type": {
|
8857
|
+
"text": "string"
|
8858
|
+
},
|
8859
|
+
"default": "'#'",
|
8860
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
8861
|
+
"fieldName": "href"
|
8862
|
+
},
|
8863
|
+
{
|
8864
|
+
"name": "target",
|
8865
|
+
"type": {
|
8866
|
+
"text": "string"
|
8867
|
+
},
|
8868
|
+
"default": "'_self'",
|
8869
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
8870
|
+
"fieldName": "target"
|
8871
|
+
},
|
8872
|
+
{
|
8873
|
+
"name": "rel",
|
8874
|
+
"type": {
|
8875
|
+
"text": "string | undefined"
|
8876
|
+
},
|
8877
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
8878
|
+
"fieldName": "rel"
|
8879
|
+
},
|
8818
8880
|
{
|
8819
8881
|
"name": "disabled",
|
8820
8882
|
"type": {
|
@@ -8828,6 +8890,19 @@
|
|
8828
8890
|
"module": "src/utils/mixins/DisabledMixin.ts"
|
8829
8891
|
}
|
8830
8892
|
},
|
8893
|
+
{
|
8894
|
+
"name": "tabIndex",
|
8895
|
+
"type": {
|
8896
|
+
"text": "number"
|
8897
|
+
},
|
8898
|
+
"default": "0",
|
8899
|
+
"description": "This property specifies the tab order of the element.",
|
8900
|
+
"fieldName": "tabIndex",
|
8901
|
+
"inheritedFrom": {
|
8902
|
+
"name": "TabIndexMixin",
|
8903
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
8904
|
+
}
|
8905
|
+
},
|
8831
8906
|
{
|
8832
8907
|
"name": "icon-name",
|
8833
8908
|
"type": {
|
@@ -8846,6 +8921,10 @@
|
|
8846
8921
|
"name": "DisabledMixin",
|
8847
8922
|
"module": "/src/utils/mixins/DisabledMixin"
|
8848
8923
|
},
|
8924
|
+
{
|
8925
|
+
"name": "TabIndexMixin",
|
8926
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
8927
|
+
},
|
8849
8928
|
{
|
8850
8929
|
"name": "IconNameMixin",
|
8851
8930
|
"module": "/src/utils/mixins/IconNameMixin"
|
@@ -8856,7 +8935,7 @@
|
|
8856
8935
|
"module": "/src/models"
|
8857
8936
|
},
|
8858
8937
|
"tagName": "mdc-link",
|
8859
|
-
"jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be
|
8938
|
+
"jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be the text content.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link\n * @cssproperty --mdc-link-color-active - Text and icon color of the link in active state\n * @cssproperty --mdc-link-color-disabled - Text and icon color of the link in disabled state\n * @cssproperty --mdc-link-color-hover - Text and icon color of the link in hover state\n * @cssproperty --mdc-link-color-normal - Text and icon color of the link in normal state\n * @cssproperty --mdc-link-icon-margin-left - Gap between the text and icon (only applicable when an icon is set)\n * @cssproperty --mdc-link-inverted-color-active - Text and icon color of the inverted link in active state\n * @cssproperty --mdc-link-inverted-color-disabled - Text and icon color of the inverted link in disabled state\n * @cssproperty --mdc-link-inverted-color-hover - Text and icon color of the inverted link in hover state\n * @cssproperty --mdc-link-inverted-color-normal - Text and icon color of the inverted link in normal state\n * @cssproperty --mdc-link-text-decoration-disabled - Text decoration of the link in disabled state for all variants\n */",
|
8860
8939
|
"customElement": true
|
8861
8940
|
}
|
8862
8941
|
],
|
@@ -12867,34 +12946,10 @@
|
|
12867
12946
|
"description": "Radio allow users to select single options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selection in lists.\n\nA radio component contains an optional label, optional info icon and an optional helper text.",
|
12868
12947
|
"name": "Radio",
|
12869
12948
|
"cssProperties": [
|
12870
|
-
{
|
12871
|
-
"description": "size of the inner circle",
|
12872
|
-
"name": "--mdc-radio-inner-circle-size"
|
12873
|
-
},
|
12874
12949
|
{
|
12875
12950
|
"description": "color of the label when disabled",
|
12876
12951
|
"name": "--mdc-radio-text-disabled-color"
|
12877
12952
|
},
|
12878
|
-
{
|
12879
|
-
"description": "color of the radio button border when disabled",
|
12880
|
-
"name": "--mdc-radio-disabled-border-color"
|
12881
|
-
},
|
12882
|
-
{
|
12883
|
-
"description": "color of the radio button border when normal",
|
12884
|
-
"name": "--mdc-radio-normal-border-color"
|
12885
|
-
},
|
12886
|
-
{
|
12887
|
-
"description": "background color of the inner circle when normal",
|
12888
|
-
"name": "--mdc-radio-inner-circle-normal-background"
|
12889
|
-
},
|
12890
|
-
{
|
12891
|
-
"description": "background color of the inner circle when disabled",
|
12892
|
-
"name": "--mdc-radio-inner-circle-disabled-background"
|
12893
|
-
},
|
12894
|
-
{
|
12895
|
-
"description": "color of the radio button when inactive",
|
12896
|
-
"name": "--mdc-radio-control-inactive-color"
|
12897
|
-
},
|
12898
12953
|
{
|
12899
12954
|
"description": "color of the radio button when inactive and hovered",
|
12900
12955
|
"name": "--mdc-radio-control-inactive-hover"
|
@@ -12903,14 +12958,6 @@
|
|
12903
12958
|
"description": "color of the radio button when inactive and pressed",
|
12904
12959
|
"name": "--mdc-radio-control-inactive-pressed-color"
|
12905
12960
|
},
|
12906
|
-
{
|
12907
|
-
"description": "background color of the radio button when inactive and disabled",
|
12908
|
-
"name": "--mdc-radio-control-inactive-disabled-background"
|
12909
|
-
},
|
12910
|
-
{
|
12911
|
-
"description": "color of the radio button when active",
|
12912
|
-
"name": "--mdc-radio-control-active-color"
|
12913
|
-
},
|
12914
12961
|
{
|
12915
12962
|
"description": "color of the radio button when active and hovered",
|
12916
12963
|
"name": "--mdc-radio-control-active-hover-color"
|
@@ -12920,8 +12967,16 @@
|
|
12920
12967
|
"name": "--mdc-radio-control-active-pressed-color"
|
12921
12968
|
},
|
12922
12969
|
{
|
12923
|
-
"description": "
|
12970
|
+
"description": "color of the radio button when disabled",
|
12971
|
+
"name": "--mdc-radio-disabled-border-color"
|
12972
|
+
},
|
12973
|
+
{
|
12974
|
+
"description": "color of the radio button when active and disabled",
|
12924
12975
|
"name": "--mdc-radio-control-active-disabled-background"
|
12976
|
+
},
|
12977
|
+
{
|
12978
|
+
"description": "color of the radio button when inactive and disabled",
|
12979
|
+
"name": "--mdc-radio-control-inactive-disabled-background"
|
12925
12980
|
}
|
12926
12981
|
],
|
12927
12982
|
"members": [
|
@@ -13570,7 +13625,7 @@
|
|
13570
13625
|
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
13571
13626
|
},
|
13572
13627
|
"tagName": "mdc-radio",
|
13573
|
-
"jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-
|
13628
|
+
"jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button when disabled\n * @cssproperty --mdc-radio-control-active-disabled-background - color of the radio button when active and disabled\n * @cssproperty --mdc-radio-control-inactive-disabled-background - color of the radio button when inactive and disabled\n *\n */",
|
13574
13629
|
"customElement": true,
|
13575
13630
|
"slots": [
|
13576
13631
|
{
|
@@ -15951,234 +16006,511 @@
|
|
15951
16006
|
},
|
15952
16007
|
"inheritedFrom": {
|
15953
16008
|
"name": "FormfieldWrapper",
|
15954
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
16009
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
16010
|
+
}
|
16011
|
+
},
|
16012
|
+
{
|
16013
|
+
"kind": "method",
|
16014
|
+
"name": "renderLabel",
|
16015
|
+
"privacy": "protected",
|
16016
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
16017
|
+
"return": {
|
16018
|
+
"type": {
|
16019
|
+
"text": ""
|
16020
|
+
}
|
16021
|
+
},
|
16022
|
+
"inheritedFrom": {
|
16023
|
+
"name": "FormfieldWrapper",
|
16024
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
16025
|
+
}
|
16026
|
+
},
|
16027
|
+
{
|
16028
|
+
"kind": "method",
|
16029
|
+
"name": "renderHelperText",
|
16030
|
+
"privacy": "protected",
|
16031
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
16032
|
+
"return": {
|
16033
|
+
"type": {
|
16034
|
+
"text": ""
|
16035
|
+
}
|
16036
|
+
},
|
16037
|
+
"inheritedFrom": {
|
16038
|
+
"name": "FormfieldWrapper",
|
16039
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
16040
|
+
}
|
16041
|
+
}
|
16042
|
+
],
|
16043
|
+
"events": [
|
16044
|
+
{
|
16045
|
+
"name": "change",
|
16046
|
+
"type": {
|
16047
|
+
"text": "CustomEvent"
|
16048
|
+
},
|
16049
|
+
"description": "(React: onChange) This event is dispatched when the select is changed.",
|
16050
|
+
"reactName": "onChange"
|
16051
|
+
},
|
16052
|
+
{
|
16053
|
+
"description": "(React: onClick) This event is dispatched when the select is clicked.",
|
16054
|
+
"name": "click",
|
16055
|
+
"reactName": "onClick"
|
16056
|
+
},
|
16057
|
+
{
|
16058
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the select.",
|
16059
|
+
"name": "keydown",
|
16060
|
+
"reactName": "onKeyDown"
|
16061
|
+
},
|
16062
|
+
{
|
16063
|
+
"description": "(React: onFocus) This event is dispatched when the select receives focus.",
|
16064
|
+
"name": "focus",
|
16065
|
+
"reactName": "onFocus"
|
16066
|
+
}
|
16067
|
+
],
|
16068
|
+
"attributes": [
|
16069
|
+
{
|
16070
|
+
"name": "placeholder",
|
16071
|
+
"type": {
|
16072
|
+
"text": "string | undefined"
|
16073
|
+
},
|
16074
|
+
"description": "The placeholder text which will be shown on the text if provided.",
|
16075
|
+
"fieldName": "placeholder"
|
16076
|
+
},
|
16077
|
+
{
|
16078
|
+
"name": "readonly",
|
16079
|
+
"type": {
|
16080
|
+
"text": "boolean"
|
16081
|
+
},
|
16082
|
+
"default": "false",
|
16083
|
+
"description": "readonly attribute of the select field. If true, the select is read-only.",
|
16084
|
+
"fieldName": "readonly"
|
16085
|
+
},
|
16086
|
+
{
|
16087
|
+
"name": "height",
|
16088
|
+
"type": {
|
16089
|
+
"text": "string"
|
16090
|
+
},
|
16091
|
+
"default": "'auto'",
|
16092
|
+
"description": "height attribute of the select field. If set,\nthen a scroll bar will be visible when there more options than the adjusted height.",
|
16093
|
+
"fieldName": "height"
|
16094
|
+
},
|
16095
|
+
{
|
16096
|
+
"name": "name",
|
16097
|
+
"type": {
|
16098
|
+
"text": "string"
|
16099
|
+
},
|
16100
|
+
"default": "''",
|
16101
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
16102
|
+
"fieldName": "name",
|
16103
|
+
"inheritedFrom": {
|
16104
|
+
"name": "FormInternalsMixin",
|
16105
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
16106
|
+
}
|
16107
|
+
},
|
16108
|
+
{
|
16109
|
+
"name": "value",
|
16110
|
+
"type": {
|
16111
|
+
"text": "string"
|
16112
|
+
},
|
16113
|
+
"default": "''",
|
16114
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
16115
|
+
"fieldName": "value",
|
16116
|
+
"inheritedFrom": {
|
16117
|
+
"name": "FormInternalsMixin",
|
16118
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
16119
|
+
}
|
16120
|
+
},
|
16121
|
+
{
|
16122
|
+
"name": "validation-message",
|
16123
|
+
"type": {
|
16124
|
+
"text": "string | undefined"
|
16125
|
+
},
|
16126
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
16127
|
+
"fieldName": "validationMessage",
|
16128
|
+
"inheritedFrom": {
|
16129
|
+
"name": "FormInternalsMixin",
|
16130
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
16131
|
+
}
|
16132
|
+
},
|
16133
|
+
{
|
16134
|
+
"name": "data-aria-label",
|
16135
|
+
"type": {
|
16136
|
+
"text": "string | null"
|
16137
|
+
},
|
16138
|
+
"default": "null",
|
16139
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
16140
|
+
"fieldName": "dataAriaLabel",
|
16141
|
+
"inheritedFrom": {
|
16142
|
+
"name": "DataAriaLabelMixin",
|
16143
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
16144
|
+
}
|
16145
|
+
},
|
16146
|
+
{
|
16147
|
+
"name": "disabled",
|
16148
|
+
"type": {
|
16149
|
+
"text": "boolean | undefined"
|
16150
|
+
},
|
16151
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16152
|
+
"default": "undefined",
|
16153
|
+
"fieldName": "disabled",
|
16154
|
+
"inheritedFrom": {
|
16155
|
+
"name": "FormfieldWrapper",
|
16156
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16157
|
+
}
|
16158
|
+
},
|
16159
|
+
{
|
16160
|
+
"name": "label",
|
16161
|
+
"type": {
|
16162
|
+
"text": "string | undefined"
|
16163
|
+
},
|
16164
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
16165
|
+
"fieldName": "label",
|
16166
|
+
"inheritedFrom": {
|
16167
|
+
"name": "FormfieldWrapper",
|
16168
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16169
|
+
}
|
16170
|
+
},
|
16171
|
+
{
|
16172
|
+
"name": "required-label",
|
16173
|
+
"type": {
|
16174
|
+
"text": "string | undefined"
|
16175
|
+
},
|
16176
|
+
"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.",
|
16177
|
+
"fieldName": "requiredLabel",
|
16178
|
+
"inheritedFrom": {
|
16179
|
+
"name": "FormfieldWrapper",
|
16180
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16181
|
+
}
|
16182
|
+
},
|
16183
|
+
{
|
16184
|
+
"name": "id",
|
16185
|
+
"type": {
|
16186
|
+
"text": "string"
|
16187
|
+
},
|
16188
|
+
"default": "''",
|
16189
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
16190
|
+
"fieldName": "id",
|
16191
|
+
"inheritedFrom": {
|
16192
|
+
"name": "FormfieldWrapper",
|
16193
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
15955
16194
|
}
|
15956
16195
|
},
|
15957
16196
|
{
|
15958
|
-
"
|
15959
|
-
"
|
15960
|
-
|
15961
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
15962
|
-
"return": {
|
15963
|
-
"type": {
|
15964
|
-
"text": ""
|
15965
|
-
}
|
16197
|
+
"name": "help-text-type",
|
16198
|
+
"type": {
|
16199
|
+
"text": "ValidationType"
|
15966
16200
|
},
|
16201
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
16202
|
+
"fieldName": "helpTextType",
|
15967
16203
|
"inheritedFrom": {
|
15968
16204
|
"name": "FormfieldWrapper",
|
15969
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
16205
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
15970
16206
|
}
|
15971
16207
|
},
|
15972
16208
|
{
|
15973
|
-
"
|
15974
|
-
"
|
15975
|
-
|
15976
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
15977
|
-
"return": {
|
15978
|
-
"type": {
|
15979
|
-
"text": ""
|
15980
|
-
}
|
16209
|
+
"name": "help-text",
|
16210
|
+
"type": {
|
16211
|
+
"text": "string | undefined"
|
15981
16212
|
},
|
16213
|
+
"description": "The help text that is displayed below the input field.",
|
16214
|
+
"fieldName": "helpText",
|
15982
16215
|
"inheritedFrom": {
|
15983
16216
|
"name": "FormfieldWrapper",
|
15984
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.
|
16217
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
15985
16218
|
}
|
15986
16219
|
}
|
15987
16220
|
],
|
15988
|
-
"
|
16221
|
+
"mixins": [
|
15989
16222
|
{
|
15990
|
-
"name": "
|
15991
|
-
"
|
15992
|
-
"text": "CustomEvent"
|
15993
|
-
},
|
15994
|
-
"description": "(React: onChange) This event is dispatched when the select is changed.",
|
15995
|
-
"reactName": "onChange"
|
16223
|
+
"name": "FormInternalsMixin",
|
16224
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
15996
16225
|
},
|
15997
16226
|
{
|
15998
|
-
"
|
15999
|
-
"
|
16000
|
-
|
16227
|
+
"name": "DataAriaLabelMixin",
|
16228
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
16229
|
+
}
|
16230
|
+
],
|
16231
|
+
"superclass": {
|
16232
|
+
"name": "FormfieldWrapper",
|
16233
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
16234
|
+
},
|
16235
|
+
"tagName": "mdc-select",
|
16236
|
+
"jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
|
16237
|
+
"customElement": true
|
16238
|
+
}
|
16239
|
+
],
|
16240
|
+
"exports": [
|
16241
|
+
{
|
16242
|
+
"kind": "js",
|
16243
|
+
"name": "default",
|
16244
|
+
"declaration": {
|
16245
|
+
"name": "Select",
|
16246
|
+
"module": "components/select/select.component.js"
|
16247
|
+
}
|
16248
|
+
}
|
16249
|
+
]
|
16250
|
+
},
|
16251
|
+
{
|
16252
|
+
"kind": "javascript-module",
|
16253
|
+
"path": "components/spinner/spinner.component.js",
|
16254
|
+
"declarations": [
|
16255
|
+
{
|
16256
|
+
"kind": "class",
|
16257
|
+
"description": "`mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\nit's best for cases where the progress or duration of a process is variable or unknown.\n\nSpinner Variants:\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\nicon or label text.\n\nSpinner Sizes:\n- **Large (96px)**: Use when replacing entire regions or pages that are still loading\n- **MidSize (48px) (Default)**: Use for most use cases.\n- **Small (24px)**: Use for inline with loading text.\n\nCustomisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\nCSS property.\n\nSpinner Colors:\n- **Default**: Use for most use cases.\n- **Inverted**: Only to be used within inverted components, such as coachmarks.\n\nRegarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\nwill be unset\nand aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.",
|
16258
|
+
"name": "Spinner",
|
16259
|
+
"cssProperties": [
|
16260
|
+
{
|
16261
|
+
"description": "Allows customization of the default spinner color.",
|
16262
|
+
"name": "--mdc-spinner-default-color"
|
16001
16263
|
},
|
16002
16264
|
{
|
16003
|
-
"description": "
|
16004
|
-
"name": "
|
16005
|
-
"reactName": "onKeyDown"
|
16265
|
+
"description": "Allows customization of the inverted spinner color.",
|
16266
|
+
"name": "--mdc-spinner-inverted-color"
|
16006
16267
|
},
|
16007
16268
|
{
|
16008
|
-
"description": "
|
16009
|
-
"name": "
|
16010
|
-
|
16269
|
+
"description": "Allows customization of the spinner Button variant color.",
|
16270
|
+
"name": "--mdc-spinner-button-variant-color"
|
16271
|
+
},
|
16272
|
+
{
|
16273
|
+
"description": "Allows customization of the spinner size.",
|
16274
|
+
"name": "--mdc-spinner-size"
|
16011
16275
|
}
|
16012
16276
|
],
|
16013
|
-
"
|
16277
|
+
"cssParts": [
|
16014
16278
|
{
|
16015
|
-
"
|
16279
|
+
"description": "The svg which contains the circle spinner.",
|
16280
|
+
"name": "container"
|
16281
|
+
},
|
16282
|
+
{
|
16283
|
+
"description": "The circle of the spinner.",
|
16284
|
+
"name": "circle"
|
16285
|
+
}
|
16286
|
+
],
|
16287
|
+
"members": [
|
16288
|
+
{
|
16289
|
+
"kind": "field",
|
16290
|
+
"name": "inverted",
|
16291
|
+
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
16292
|
+
"default": "false",
|
16293
|
+
"attribute": "inverted",
|
16294
|
+
"reflects": true
|
16295
|
+
},
|
16296
|
+
{
|
16297
|
+
"kind": "field",
|
16298
|
+
"name": "size",
|
16016
16299
|
"type": {
|
16017
|
-
"text": "
|
16300
|
+
"text": "SpinnerSize | undefined"
|
16018
16301
|
},
|
16019
|
-
"description": "
|
16020
|
-
"
|
16302
|
+
"description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
|
16303
|
+
"default": "midsize",
|
16304
|
+
"attribute": "size",
|
16305
|
+
"reflects": true
|
16021
16306
|
},
|
16022
16307
|
{
|
16023
|
-
"
|
16308
|
+
"kind": "field",
|
16309
|
+
"name": "ariaLabel",
|
16024
16310
|
"type": {
|
16025
|
-
"text": "
|
16311
|
+
"text": "string | null"
|
16312
|
+
},
|
16313
|
+
"default": "null",
|
16314
|
+
"description": "Aria-label attribute to be set for accessibility",
|
16315
|
+
"attribute": "aria-label"
|
16316
|
+
},
|
16317
|
+
{
|
16318
|
+
"kind": "field",
|
16319
|
+
"name": "variant",
|
16320
|
+
"type": {
|
16321
|
+
"text": "SpinnerVariant"
|
16026
16322
|
},
|
16323
|
+
"description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
|
16324
|
+
"default": "standalone",
|
16325
|
+
"attribute": "variant",
|
16326
|
+
"reflects": true
|
16327
|
+
}
|
16328
|
+
],
|
16329
|
+
"attributes": [
|
16330
|
+
{
|
16331
|
+
"name": "inverted",
|
16332
|
+
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
16027
16333
|
"default": "false",
|
16028
|
-
"
|
16029
|
-
"fieldName": "readonly"
|
16334
|
+
"fieldName": "inverted"
|
16030
16335
|
},
|
16031
16336
|
{
|
16032
|
-
"name": "
|
16337
|
+
"name": "size",
|
16033
16338
|
"type": {
|
16034
|
-
"text": "
|
16339
|
+
"text": "SpinnerSize | undefined"
|
16035
16340
|
},
|
16036
|
-
"
|
16037
|
-
"
|
16038
|
-
"fieldName": "
|
16341
|
+
"description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
|
16342
|
+
"default": "midsize",
|
16343
|
+
"fieldName": "size"
|
16039
16344
|
},
|
16040
16345
|
{
|
16041
|
-
"name": "
|
16346
|
+
"name": "aria-label",
|
16042
16347
|
"type": {
|
16043
|
-
"text": "string"
|
16348
|
+
"text": "string | null"
|
16044
16349
|
},
|
16045
|
-
"default": "
|
16046
|
-
"description": "
|
16047
|
-
"fieldName": "
|
16048
|
-
"inheritedFrom": {
|
16049
|
-
"name": "FormInternalsMixin",
|
16050
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
16051
|
-
}
|
16350
|
+
"default": "null",
|
16351
|
+
"description": "Aria-label attribute to be set for accessibility",
|
16352
|
+
"fieldName": "ariaLabel"
|
16052
16353
|
},
|
16053
16354
|
{
|
16054
|
-
"name": "
|
16355
|
+
"name": "variant",
|
16055
16356
|
"type": {
|
16056
|
-
"text": "
|
16357
|
+
"text": "SpinnerVariant"
|
16057
16358
|
},
|
16058
|
-
"
|
16059
|
-
"
|
16060
|
-
"fieldName": "
|
16061
|
-
|
16062
|
-
|
16063
|
-
|
16064
|
-
|
16359
|
+
"description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
|
16360
|
+
"default": "standalone",
|
16361
|
+
"fieldName": "variant"
|
16362
|
+
}
|
16363
|
+
],
|
16364
|
+
"superclass": {
|
16365
|
+
"name": "Component",
|
16366
|
+
"module": "/src/models"
|
16367
|
+
},
|
16368
|
+
"tagName": "mdc-spinner",
|
16369
|
+
"jsDoc": "/**\n * `mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\n * it's best for cases where the progress or duration of a process is variable or unknown.\n *\n * Spinner Variants:\n * - **Standalone (Default)**: Track has a blue color.\n * - **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\n * To ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\n * icon or label text.\n *\n * Spinner Sizes:\n * - **Large (96px)**: Use when replacing entire regions or pages that are still loading\n * - **MidSize (48px) (Default)**: Use for most use cases.\n * - **Small (24px)**: Use for inline with loading text.\n *\n * Customisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\n * CSS property.\n *\n * Spinner Colors:\n * - **Default**: Use for most use cases.\n * - **Inverted**: Only to be used within inverted components, such as coachmarks.\n *\n * Regarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\n * will be unset\n * and aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.\n *\n * @tagname mdc-spinner\n *\n * @cssproperty --mdc-spinner-default-color - Allows customization of the default spinner color.\n * @cssproperty --mdc-spinner-inverted-color - Allows customization of the inverted spinner color.\n * @cssproperty --mdc-spinner-button-variant-color - Allows customization of the spinner Button variant color.\n * @cssproperty --mdc-spinner-size - Allows customization of the spinner size.\n *\n * @csspart container - The svg which contains the circle spinner.\n * @csspart circle - The circle of the spinner.\n */",
|
16370
|
+
"customElement": true
|
16371
|
+
}
|
16372
|
+
],
|
16373
|
+
"exports": [
|
16374
|
+
{
|
16375
|
+
"kind": "js",
|
16376
|
+
"name": "default",
|
16377
|
+
"declaration": {
|
16378
|
+
"name": "Spinner",
|
16379
|
+
"module": "components/spinner/spinner.component.js"
|
16380
|
+
}
|
16381
|
+
}
|
16382
|
+
]
|
16383
|
+
},
|
16384
|
+
{
|
16385
|
+
"kind": "javascript-module",
|
16386
|
+
"path": "components/staticcheckbox/staticcheckbox.component.js",
|
16387
|
+
"declarations": [
|
16388
|
+
{
|
16389
|
+
"kind": "class",
|
16390
|
+
"description": "This is a decorative component that is styled to look as a checkbox.\n\nIt has 3 properties - checked, indeterminate and disabled.\n\nWe are using the same styling that has been created for the `mdc-checkbox` component.",
|
16391
|
+
"name": "StaticCheckbox",
|
16392
|
+
"cssProperties": [
|
16393
|
+
{
|
16394
|
+
"description": "Border color in high contrast.",
|
16395
|
+
"name": "--mdc-staticcheckbox-border-color"
|
16396
|
+
},
|
16397
|
+
{
|
16398
|
+
"description": "Background color for a selected checkbox.",
|
16399
|
+
"name": "--mdc-staticcheckbox-checked-background-color"
|
16400
|
+
},
|
16401
|
+
{
|
16402
|
+
"description": "Background color for a disabled checkbox.",
|
16403
|
+
"name": "--mdc-staticcheckbox-disabled-background-color"
|
16404
|
+
},
|
16405
|
+
{
|
16406
|
+
"description": "Border color for a disabled checkbox.",
|
16407
|
+
"name": "--mdc-checkbox-disabled-border-color"
|
16408
|
+
},
|
16409
|
+
{
|
16410
|
+
"description": "Background color for a disabled, selected checkbox.",
|
16411
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
16412
|
+
},
|
16413
|
+
{
|
16414
|
+
"description": "Icon color for a disabled checkbox.",
|
16415
|
+
"name": "--mdc-staticcheckbox-disabled-icon-color"
|
16065
16416
|
},
|
16066
16417
|
{
|
16067
|
-
"
|
16418
|
+
"description": "Background color for an unselected checkbox.",
|
16419
|
+
"name": "--mdc-staticcheckbox-icon-background-color"
|
16420
|
+
},
|
16421
|
+
{
|
16422
|
+
"description": "Default background color for an unselected checkbox.",
|
16423
|
+
"name": "--mdc-staticcheckbox-icon-border-color"
|
16424
|
+
},
|
16425
|
+
{
|
16426
|
+
"description": "Icon color for an unselected checkbox.",
|
16427
|
+
"name": "--mdc-staticcheckbox-icon-color"
|
16428
|
+
}
|
16429
|
+
],
|
16430
|
+
"members": [
|
16431
|
+
{
|
16432
|
+
"kind": "field",
|
16433
|
+
"name": "checked",
|
16068
16434
|
"type": {
|
16069
|
-
"text": "
|
16435
|
+
"text": "boolean"
|
16070
16436
|
},
|
16071
|
-
"
|
16072
|
-
"
|
16073
|
-
"
|
16074
|
-
|
16075
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
16076
|
-
}
|
16437
|
+
"default": "false",
|
16438
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
16439
|
+
"attribute": "checked",
|
16440
|
+
"reflects": true
|
16077
16441
|
},
|
16078
16442
|
{
|
16079
|
-
"
|
16443
|
+
"kind": "field",
|
16444
|
+
"name": "indeterminate",
|
16080
16445
|
"type": {
|
16081
|
-
"text": "
|
16446
|
+
"text": "boolean"
|
16082
16447
|
},
|
16083
|
-
"default": "
|
16084
|
-
"description": "
|
16085
|
-
"
|
16086
|
-
"
|
16087
|
-
"name": "DataAriaLabelMixin",
|
16088
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
16089
|
-
}
|
16448
|
+
"default": "false",
|
16449
|
+
"description": "Determines whether the checkbox is in an indeterminate state.",
|
16450
|
+
"attribute": "indeterminate",
|
16451
|
+
"reflects": true
|
16090
16452
|
},
|
16091
16453
|
{
|
16454
|
+
"kind": "field",
|
16092
16455
|
"name": "disabled",
|
16093
16456
|
"type": {
|
16094
16457
|
"text": "boolean | undefined"
|
16095
16458
|
},
|
16096
16459
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16097
16460
|
"default": "undefined",
|
16098
|
-
"
|
16099
|
-
"
|
16100
|
-
"name": "FormfieldWrapper",
|
16101
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16102
|
-
}
|
16103
|
-
},
|
16104
|
-
{
|
16105
|
-
"name": "label",
|
16106
|
-
"type": {
|
16107
|
-
"text": "string | undefined"
|
16108
|
-
},
|
16109
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
16110
|
-
"fieldName": "label",
|
16111
|
-
"inheritedFrom": {
|
16112
|
-
"name": "FormfieldWrapper",
|
16113
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16114
|
-
}
|
16115
|
-
},
|
16116
|
-
{
|
16117
|
-
"name": "required-label",
|
16118
|
-
"type": {
|
16119
|
-
"text": "string | undefined"
|
16120
|
-
},
|
16121
|
-
"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.",
|
16122
|
-
"fieldName": "requiredLabel",
|
16461
|
+
"attribute": "disabled",
|
16462
|
+
"reflects": true,
|
16123
16463
|
"inheritedFrom": {
|
16124
|
-
"name": "
|
16125
|
-
"module": "
|
16464
|
+
"name": "DisabledMixin",
|
16465
|
+
"module": "utils/mixins/DisabledMixin.js"
|
16126
16466
|
}
|
16127
|
-
}
|
16467
|
+
}
|
16468
|
+
],
|
16469
|
+
"attributes": [
|
16128
16470
|
{
|
16129
|
-
"name": "
|
16471
|
+
"name": "checked",
|
16130
16472
|
"type": {
|
16131
|
-
"text": "
|
16473
|
+
"text": "boolean"
|
16132
16474
|
},
|
16133
|
-
"default": "
|
16134
|
-
"description": "
|
16135
|
-
"fieldName": "
|
16136
|
-
"inheritedFrom": {
|
16137
|
-
"name": "FormfieldWrapper",
|
16138
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16139
|
-
}
|
16475
|
+
"default": "false",
|
16476
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
16477
|
+
"fieldName": "checked"
|
16140
16478
|
},
|
16141
16479
|
{
|
16142
|
-
"name": "
|
16480
|
+
"name": "indeterminate",
|
16143
16481
|
"type": {
|
16144
|
-
"text": "
|
16482
|
+
"text": "boolean"
|
16145
16483
|
},
|
16146
|
-
"
|
16147
|
-
"
|
16148
|
-
"
|
16149
|
-
"name": "FormfieldWrapper",
|
16150
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
16151
|
-
}
|
16484
|
+
"default": "false",
|
16485
|
+
"description": "Determines whether the checkbox is in an indeterminate state.",
|
16486
|
+
"fieldName": "indeterminate"
|
16152
16487
|
},
|
16153
16488
|
{
|
16154
|
-
"name": "
|
16489
|
+
"name": "disabled",
|
16155
16490
|
"type": {
|
16156
|
-
"text": "
|
16491
|
+
"text": "boolean | undefined"
|
16157
16492
|
},
|
16158
|
-
"description": "
|
16159
|
-
"
|
16493
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16494
|
+
"default": "undefined",
|
16495
|
+
"fieldName": "disabled",
|
16160
16496
|
"inheritedFrom": {
|
16161
|
-
"name": "
|
16162
|
-
"module": "src/
|
16497
|
+
"name": "DisabledMixin",
|
16498
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
16163
16499
|
}
|
16164
16500
|
}
|
16165
16501
|
],
|
16166
16502
|
"mixins": [
|
16167
16503
|
{
|
16168
|
-
"name": "
|
16169
|
-
"module": "/src/utils/mixins/
|
16170
|
-
},
|
16171
|
-
{
|
16172
|
-
"name": "DataAriaLabelMixin",
|
16173
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
16504
|
+
"name": "DisabledMixin",
|
16505
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
16174
16506
|
}
|
16175
16507
|
],
|
16176
16508
|
"superclass": {
|
16177
|
-
"name": "
|
16178
|
-
"module": "/src/
|
16509
|
+
"name": "Component",
|
16510
|
+
"module": "/src/models"
|
16179
16511
|
},
|
16180
|
-
"tagName": "mdc-
|
16181
|
-
"jsDoc": "/**\n *
|
16512
|
+
"tagName": "mdc-staticcheckbox",
|
16513
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a checkbox.\n *\n * It has 3 properties - checked, indeterminate and disabled.\n *\n * We are using the same styling that has been created for the `mdc-checkbox` component.\n *\n * @tagname mdc-staticcheckbox\n *\n * @dependency mdc-icon\n *\n * @cssproperty --mdc-staticcheckbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-staticcheckbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-staticcheckbox-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-staticcheckbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-staticcheckbox-icon-color - Icon color for an unselected checkbox.\n *\n */",
|
16182
16514
|
"customElement": true
|
16183
16515
|
}
|
16184
16516
|
],
|
@@ -16187,131 +16519,146 @@
|
|
16187
16519
|
"kind": "js",
|
16188
16520
|
"name": "default",
|
16189
16521
|
"declaration": {
|
16190
|
-
"name": "
|
16191
|
-
"module": "components/
|
16522
|
+
"name": "StaticCheckbox",
|
16523
|
+
"module": "components/staticcheckbox/staticcheckbox.component.js"
|
16192
16524
|
}
|
16193
16525
|
}
|
16194
16526
|
]
|
16195
16527
|
},
|
16196
16528
|
{
|
16197
16529
|
"kind": "javascript-module",
|
16198
|
-
"path": "components/
|
16530
|
+
"path": "components/staticradio/staticradio.component.js",
|
16199
16531
|
"declarations": [
|
16200
16532
|
{
|
16201
16533
|
"kind": "class",
|
16202
|
-
"description": "
|
16203
|
-
"name": "
|
16534
|
+
"description": "This is a decorative component that is styled to look as a radio.\nIt has 2 properties - checked and disabled.\n\nWe are using the same styling that has been created for the `mdc-radio` component.",
|
16535
|
+
"name": "StaticRadio",
|
16204
16536
|
"cssProperties": [
|
16205
16537
|
{
|
16206
|
-
"description": "
|
16207
|
-
"name": "--mdc-
|
16538
|
+
"description": "size of the inner circle",
|
16539
|
+
"name": "--mdc-staticradio-inner-circle-size"
|
16208
16540
|
},
|
16209
16541
|
{
|
16210
|
-
"description": "
|
16211
|
-
"name": "--mdc-
|
16542
|
+
"description": "color of the label when disabled",
|
16543
|
+
"name": "--mdc-staticradio-text-disabled-color"
|
16212
16544
|
},
|
16213
16545
|
{
|
16214
|
-
"description": "
|
16215
|
-
"name": "--mdc-
|
16546
|
+
"description": "color of the radio button border when normal",
|
16547
|
+
"name": "--mdc-staticradio-normal-border-color"
|
16216
16548
|
},
|
16217
16549
|
{
|
16218
|
-
"description": "
|
16219
|
-
"name": "--mdc-
|
16220
|
-
}
|
16221
|
-
],
|
16222
|
-
"cssParts": [
|
16550
|
+
"description": "color of the radio button border when disabled",
|
16551
|
+
"name": "--mdc-staticradio-disabled-border-color"
|
16552
|
+
},
|
16223
16553
|
{
|
16224
|
-
"description": "
|
16225
|
-
"name": "
|
16554
|
+
"description": "background color of the inner circle when normal",
|
16555
|
+
"name": "--mdc-staticradio-inner-circle-normal-background"
|
16226
16556
|
},
|
16227
16557
|
{
|
16228
|
-
"description": "
|
16229
|
-
"name": "circle"
|
16558
|
+
"description": "background color of the inner circle when disabled",
|
16559
|
+
"name": "--mdc-staticradio-inner-circle-disabled-background"
|
16560
|
+
},
|
16561
|
+
{
|
16562
|
+
"description": "color of the radio button when inactive",
|
16563
|
+
"name": "--mdc-staticradio-control-inactive-color"
|
16564
|
+
},
|
16565
|
+
{
|
16566
|
+
"description": "background color of the radio button when inactive and disabled",
|
16567
|
+
"name": "--mdc-staticradio-control-inactive-disabled-background"
|
16568
|
+
},
|
16569
|
+
{
|
16570
|
+
"description": "color of the radio button when active",
|
16571
|
+
"name": "--mdc-staticradio-control-active-color"
|
16572
|
+
},
|
16573
|
+
{
|
16574
|
+
"description": "background color of the radio button when active and disabled",
|
16575
|
+
"name": "--mdc-staticradio-control-active-disabled-background"
|
16230
16576
|
}
|
16231
16577
|
],
|
16232
16578
|
"members": [
|
16233
16579
|
{
|
16234
16580
|
"kind": "field",
|
16235
|
-
"name": "
|
16236
|
-
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
16237
|
-
"default": "false",
|
16238
|
-
"attribute": "inverted",
|
16239
|
-
"reflects": true
|
16240
|
-
},
|
16241
|
-
{
|
16242
|
-
"kind": "field",
|
16243
|
-
"name": "size",
|
16581
|
+
"name": "checked",
|
16244
16582
|
"type": {
|
16245
|
-
"text": "
|
16583
|
+
"text": "boolean"
|
16246
16584
|
},
|
16247
|
-
"
|
16248
|
-
"
|
16249
|
-
"attribute": "
|
16585
|
+
"default": "false",
|
16586
|
+
"description": "Determines whether the radio is selected or unselected.",
|
16587
|
+
"attribute": "checked",
|
16250
16588
|
"reflects": true
|
16251
16589
|
},
|
16252
16590
|
{
|
16253
16591
|
"kind": "field",
|
16254
|
-
"name": "
|
16592
|
+
"name": "readonly",
|
16255
16593
|
"type": {
|
16256
|
-
"text": "
|
16594
|
+
"text": "boolean"
|
16257
16595
|
},
|
16258
|
-
"default": "
|
16259
|
-
"description": "
|
16260
|
-
"attribute": "
|
16596
|
+
"default": "false",
|
16597
|
+
"description": "Determines whether the radio is read-only.",
|
16598
|
+
"attribute": "readonly",
|
16599
|
+
"reflects": true
|
16261
16600
|
},
|
16262
16601
|
{
|
16263
16602
|
"kind": "field",
|
16264
|
-
"name": "
|
16603
|
+
"name": "disabled",
|
16265
16604
|
"type": {
|
16266
|
-
"text": "
|
16605
|
+
"text": "boolean | undefined"
|
16267
16606
|
},
|
16268
|
-
"description": "
|
16269
|
-
"default": "
|
16270
|
-
"attribute": "
|
16271
|
-
"reflects": true
|
16607
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16608
|
+
"default": "undefined",
|
16609
|
+
"attribute": "disabled",
|
16610
|
+
"reflects": true,
|
16611
|
+
"inheritedFrom": {
|
16612
|
+
"name": "DisabledMixin",
|
16613
|
+
"module": "utils/mixins/DisabledMixin.js"
|
16614
|
+
}
|
16272
16615
|
}
|
16273
16616
|
],
|
16274
16617
|
"attributes": [
|
16275
16618
|
{
|
16276
|
-
"name": "
|
16277
|
-
"description": "The spinner color can be inverted by setting the inverted attribute to true.",
|
16278
|
-
"default": "false",
|
16279
|
-
"fieldName": "inverted"
|
16280
|
-
},
|
16281
|
-
{
|
16282
|
-
"name": "size",
|
16619
|
+
"name": "checked",
|
16283
16620
|
"type": {
|
16284
|
-
"text": "
|
16621
|
+
"text": "boolean"
|
16285
16622
|
},
|
16286
|
-
"
|
16287
|
-
"
|
16288
|
-
"fieldName": "
|
16623
|
+
"default": "false",
|
16624
|
+
"description": "Determines whether the radio is selected or unselected.",
|
16625
|
+
"fieldName": "checked"
|
16289
16626
|
},
|
16290
16627
|
{
|
16291
|
-
"name": "
|
16628
|
+
"name": "readonly",
|
16292
16629
|
"type": {
|
16293
|
-
"text": "
|
16630
|
+
"text": "boolean"
|
16294
16631
|
},
|
16295
|
-
"default": "
|
16296
|
-
"description": "
|
16297
|
-
"fieldName": "
|
16632
|
+
"default": "false",
|
16633
|
+
"description": "Determines whether the radio is read-only.",
|
16634
|
+
"fieldName": "readonly"
|
16298
16635
|
},
|
16299
16636
|
{
|
16300
|
-
"name": "
|
16637
|
+
"name": "disabled",
|
16301
16638
|
"type": {
|
16302
|
-
"text": "
|
16639
|
+
"text": "boolean | undefined"
|
16303
16640
|
},
|
16304
|
-
"description": "
|
16305
|
-
"default": "
|
16306
|
-
"fieldName": "
|
16641
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
16642
|
+
"default": "undefined",
|
16643
|
+
"fieldName": "disabled",
|
16644
|
+
"inheritedFrom": {
|
16645
|
+
"name": "DisabledMixin",
|
16646
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
16647
|
+
}
|
16648
|
+
}
|
16649
|
+
],
|
16650
|
+
"mixins": [
|
16651
|
+
{
|
16652
|
+
"name": "DisabledMixin",
|
16653
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
16307
16654
|
}
|
16308
16655
|
],
|
16309
16656
|
"superclass": {
|
16310
16657
|
"name": "Component",
|
16311
16658
|
"module": "/src/models"
|
16312
16659
|
},
|
16313
|
-
"tagName": "mdc-
|
16314
|
-
"jsDoc": "/**\n *
|
16660
|
+
"tagName": "mdc-staticradio",
|
16661
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a radio.\n * It has 2 properties - checked and disabled.\n *\n * We are using the same styling that has been created for the `mdc-radio` component.\n *\n * @tagname mdc-staticradio\n *\n * @cssproperty --mdc-staticradio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-staticradio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-staticradio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-staticradio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-staticradio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-staticradio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-staticradio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-staticradio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-staticradio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-staticradio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n */",
|
16315
16662
|
"customElement": true
|
16316
16663
|
}
|
16317
16664
|
],
|
@@ -16320,8 +16667,8 @@
|
|
16320
16667
|
"kind": "js",
|
16321
16668
|
"name": "default",
|
16322
16669
|
"declaration": {
|
16323
|
-
"name": "
|
16324
|
-
"module": "components/
|
16670
|
+
"name": "StaticRadio",
|
16671
|
+
"module": "components/staticradio/staticradio.component.js"
|
16325
16672
|
}
|
16326
16673
|
}
|
16327
16674
|
]
|