@momentum-design/components 0.46.1 → 0.47.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 +156 -141
- package/dist/browser/index.js.map +4 -4
- package/dist/components/screenreaderannouncer/index.d.ts +7 -0
- package/dist/components/screenreaderannouncer/index.js +4 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.component.d.ts +110 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.component.js +212 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.constants.d.ts +13 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.constants.js +14 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.styles.d.ts +2 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.styles.js +8 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.types.d.ts +3 -0
- package/dist/components/screenreaderannouncer/screenreaderannouncer.types.js +1 -0
- package/dist/custom-elements.json +484 -305
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +4 -3
- package/dist/react/index.js +4 -3
- package/dist/react/screenreaderannouncer/index.d.ts +34 -0
- package/dist/react/screenreaderannouncer/index.js +43 -0
- package/package.json +1 -1
@@ -465,6 +465,67 @@
|
|
465
465
|
}
|
466
466
|
]
|
467
467
|
},
|
468
|
+
{
|
469
|
+
"kind": "javascript-module",
|
470
|
+
"path": "components/appheader/appheader.component.js",
|
471
|
+
"declarations": [
|
472
|
+
{
|
473
|
+
"kind": "class",
|
474
|
+
"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**.",
|
475
|
+
"name": "Appheader",
|
476
|
+
"cssParts": [
|
477
|
+
{
|
478
|
+
"description": "The main container for styling the header.",
|
479
|
+
"name": "container"
|
480
|
+
},
|
481
|
+
{
|
482
|
+
"description": "The leading section of the header.",
|
483
|
+
"name": "leading-section"
|
484
|
+
},
|
485
|
+
{
|
486
|
+
"description": "The center section of the header.",
|
487
|
+
"name": "center-section"
|
488
|
+
},
|
489
|
+
{
|
490
|
+
"description": "The trailing section of the header.",
|
491
|
+
"name": "trailing-section"
|
492
|
+
}
|
493
|
+
],
|
494
|
+
"slots": [
|
495
|
+
{
|
496
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
497
|
+
"name": "leading"
|
498
|
+
},
|
499
|
+
{
|
500
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
501
|
+
"name": "center"
|
502
|
+
},
|
503
|
+
{
|
504
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
505
|
+
"name": "trailing"
|
506
|
+
}
|
507
|
+
],
|
508
|
+
"members": [],
|
509
|
+
"superclass": {
|
510
|
+
"name": "Component",
|
511
|
+
"module": "/src/models"
|
512
|
+
},
|
513
|
+
"tagName": "mdc-appheader",
|
514
|
+
"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 */",
|
515
|
+
"customElement": true
|
516
|
+
}
|
517
|
+
],
|
518
|
+
"exports": [
|
519
|
+
{
|
520
|
+
"kind": "js",
|
521
|
+
"name": "default",
|
522
|
+
"declaration": {
|
523
|
+
"name": "Appheader",
|
524
|
+
"module": "components/appheader/appheader.component.js"
|
525
|
+
}
|
526
|
+
}
|
527
|
+
]
|
528
|
+
},
|
468
529
|
{
|
469
530
|
"kind": "javascript-module",
|
470
531
|
"path": "components/avatar/avatar.component.js",
|
@@ -709,67 +770,6 @@
|
|
709
770
|
}
|
710
771
|
]
|
711
772
|
},
|
712
|
-
{
|
713
|
-
"kind": "javascript-module",
|
714
|
-
"path": "components/appheader/appheader.component.js",
|
715
|
-
"declarations": [
|
716
|
-
{
|
717
|
-
"kind": "class",
|
718
|
-
"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**.",
|
719
|
-
"name": "Appheader",
|
720
|
-
"cssParts": [
|
721
|
-
{
|
722
|
-
"description": "The main container for styling the header.",
|
723
|
-
"name": "container"
|
724
|
-
},
|
725
|
-
{
|
726
|
-
"description": "The leading section of the header.",
|
727
|
-
"name": "leading-section"
|
728
|
-
},
|
729
|
-
{
|
730
|
-
"description": "The center section of the header.",
|
731
|
-
"name": "center-section"
|
732
|
-
},
|
733
|
-
{
|
734
|
-
"description": "The trailing section of the header.",
|
735
|
-
"name": "trailing-section"
|
736
|
-
}
|
737
|
-
],
|
738
|
-
"slots": [
|
739
|
-
{
|
740
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
741
|
-
"name": "leading"
|
742
|
-
},
|
743
|
-
{
|
744
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
745
|
-
"name": "center"
|
746
|
-
},
|
747
|
-
{
|
748
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
749
|
-
"name": "trailing"
|
750
|
-
}
|
751
|
-
],
|
752
|
-
"members": [],
|
753
|
-
"superclass": {
|
754
|
-
"name": "Component",
|
755
|
-
"module": "/src/models"
|
756
|
-
},
|
757
|
-
"tagName": "mdc-appheader",
|
758
|
-
"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 */",
|
759
|
-
"customElement": true
|
760
|
-
}
|
761
|
-
],
|
762
|
-
"exports": [
|
763
|
-
{
|
764
|
-
"kind": "js",
|
765
|
-
"name": "default",
|
766
|
-
"declaration": {
|
767
|
-
"name": "Appheader",
|
768
|
-
"module": "components/appheader/appheader.component.js"
|
769
|
-
}
|
770
|
-
}
|
771
|
-
]
|
772
|
-
},
|
773
773
|
{
|
774
774
|
"kind": "javascript-module",
|
775
775
|
"path": "components/avatarbutton/avatarbutton.component.js",
|
@@ -1692,6 +1692,183 @@
|
|
1692
1692
|
}
|
1693
1693
|
]
|
1694
1694
|
},
|
1695
|
+
{
|
1696
|
+
"kind": "javascript-module",
|
1697
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
1698
|
+
"declarations": [
|
1699
|
+
{
|
1700
|
+
"kind": "class",
|
1701
|
+
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
1702
|
+
"name": "Brandvisual",
|
1703
|
+
"members": [
|
1704
|
+
{
|
1705
|
+
"kind": "field",
|
1706
|
+
"name": "brandVisualData",
|
1707
|
+
"type": {
|
1708
|
+
"text": "HTMLElement | undefined"
|
1709
|
+
},
|
1710
|
+
"privacy": "private"
|
1711
|
+
},
|
1712
|
+
{
|
1713
|
+
"kind": "field",
|
1714
|
+
"name": "name",
|
1715
|
+
"type": {
|
1716
|
+
"text": "BrandVisualNames | undefined"
|
1717
|
+
},
|
1718
|
+
"description": "Name of the brandVisual (= filename)",
|
1719
|
+
"attribute": "name",
|
1720
|
+
"reflects": true
|
1721
|
+
},
|
1722
|
+
{
|
1723
|
+
"kind": "method",
|
1724
|
+
"name": "getBrandVisualData",
|
1725
|
+
"privacy": "private"
|
1726
|
+
},
|
1727
|
+
{
|
1728
|
+
"kind": "method",
|
1729
|
+
"name": "handleBrandVisualLoadedSuccess",
|
1730
|
+
"privacy": "private",
|
1731
|
+
"parameters": [
|
1732
|
+
{
|
1733
|
+
"name": "brandVisualHtml",
|
1734
|
+
"type": {
|
1735
|
+
"text": "HTMLElement"
|
1736
|
+
},
|
1737
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1738
|
+
}
|
1739
|
+
],
|
1740
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1741
|
+
},
|
1742
|
+
{
|
1743
|
+
"kind": "method",
|
1744
|
+
"name": "handleBrandVisualLoadedFailure",
|
1745
|
+
"privacy": "private",
|
1746
|
+
"parameters": [
|
1747
|
+
{
|
1748
|
+
"name": "error",
|
1749
|
+
"type": {
|
1750
|
+
"text": "unknown"
|
1751
|
+
}
|
1752
|
+
}
|
1753
|
+
],
|
1754
|
+
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
1755
|
+
}
|
1756
|
+
],
|
1757
|
+
"events": [
|
1758
|
+
{
|
1759
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
1760
|
+
"name": "load",
|
1761
|
+
"reactName": "onLoad",
|
1762
|
+
"eventName": "LoadEvent"
|
1763
|
+
},
|
1764
|
+
{
|
1765
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
1766
|
+
"name": "error",
|
1767
|
+
"reactName": "onError",
|
1768
|
+
"eventName": "ErrorEvent"
|
1769
|
+
}
|
1770
|
+
],
|
1771
|
+
"attributes": [
|
1772
|
+
{
|
1773
|
+
"name": "name",
|
1774
|
+
"type": {
|
1775
|
+
"text": "BrandVisualNames | undefined"
|
1776
|
+
},
|
1777
|
+
"description": "Name of the brandVisual (= filename)",
|
1778
|
+
"fieldName": "name"
|
1779
|
+
}
|
1780
|
+
],
|
1781
|
+
"superclass": {
|
1782
|
+
"name": "Component",
|
1783
|
+
"module": "/src/models"
|
1784
|
+
},
|
1785
|
+
"tagName": "mdc-brandvisual",
|
1786
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
1787
|
+
"customElement": true
|
1788
|
+
}
|
1789
|
+
],
|
1790
|
+
"exports": [
|
1791
|
+
{
|
1792
|
+
"kind": "js",
|
1793
|
+
"name": "default",
|
1794
|
+
"declaration": {
|
1795
|
+
"name": "Brandvisual",
|
1796
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
1797
|
+
}
|
1798
|
+
}
|
1799
|
+
]
|
1800
|
+
},
|
1801
|
+
{
|
1802
|
+
"kind": "javascript-module",
|
1803
|
+
"path": "components/bullet/bullet.component.js",
|
1804
|
+
"declarations": [
|
1805
|
+
{
|
1806
|
+
"kind": "class",
|
1807
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1808
|
+
"name": "Bullet",
|
1809
|
+
"cssProperties": [
|
1810
|
+
{
|
1811
|
+
"description": "background color of the bullet",
|
1812
|
+
"name": "--mdc-bullet-background-color"
|
1813
|
+
},
|
1814
|
+
{
|
1815
|
+
"description": "small size value of the bullet",
|
1816
|
+
"name": "--mdc-bullet-size-small"
|
1817
|
+
},
|
1818
|
+
{
|
1819
|
+
"description": "medium size value of the bullet",
|
1820
|
+
"name": "--mdc-bullet-size-medium"
|
1821
|
+
},
|
1822
|
+
{
|
1823
|
+
"description": "large size value of the bullet",
|
1824
|
+
"name": "--mdc-bullet-size-large"
|
1825
|
+
}
|
1826
|
+
],
|
1827
|
+
"members": [
|
1828
|
+
{
|
1829
|
+
"kind": "field",
|
1830
|
+
"name": "size",
|
1831
|
+
"type": {
|
1832
|
+
"text": "Size"
|
1833
|
+
},
|
1834
|
+
"privacy": "public",
|
1835
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1836
|
+
"default": "small",
|
1837
|
+
"attribute": "size",
|
1838
|
+
"reflects": true
|
1839
|
+
}
|
1840
|
+
],
|
1841
|
+
"attributes": [
|
1842
|
+
{
|
1843
|
+
"name": "size",
|
1844
|
+
"type": {
|
1845
|
+
"text": "Size"
|
1846
|
+
},
|
1847
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1848
|
+
"default": "small",
|
1849
|
+
"fieldName": "size"
|
1850
|
+
}
|
1851
|
+
],
|
1852
|
+
"superclass": {
|
1853
|
+
"name": "Component",
|
1854
|
+
"module": "/src/models"
|
1855
|
+
},
|
1856
|
+
"tagName": "mdc-bullet",
|
1857
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
1858
|
+
"customElement": true
|
1859
|
+
}
|
1860
|
+
],
|
1861
|
+
"exports": [
|
1862
|
+
{
|
1863
|
+
"kind": "js",
|
1864
|
+
"name": "default",
|
1865
|
+
"declaration": {
|
1866
|
+
"name": "Bullet",
|
1867
|
+
"module": "components/bullet/bullet.component.js"
|
1868
|
+
}
|
1869
|
+
}
|
1870
|
+
]
|
1871
|
+
},
|
1695
1872
|
{
|
1696
1873
|
"kind": "javascript-module",
|
1697
1874
|
"path": "components/button/button.component.js",
|
@@ -2482,273 +2659,96 @@
|
|
2482
2659
|
{
|
2483
2660
|
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2484
2661
|
"name": "focus",
|
2485
|
-
"reactName": "onFocus",
|
2486
|
-
"eventName": "FocusEvent"
|
2487
|
-
}
|
2488
|
-
],
|
2489
|
-
"attributes": [
|
2490
|
-
{
|
2491
|
-
"name": "active",
|
2492
|
-
"type": {
|
2493
|
-
"text": "boolean"
|
2494
|
-
},
|
2495
|
-
"default": "false",
|
2496
|
-
"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.",
|
2497
|
-
"fieldName": "active"
|
2498
|
-
},
|
2499
|
-
{
|
2500
|
-
"name": "soft-disabled",
|
2501
|
-
"type": {
|
2502
|
-
"text": "boolean"
|
2503
|
-
},
|
2504
|
-
"default": "false",
|
2505
|
-
"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.",
|
2506
|
-
"fieldName": "softDisabled"
|
2507
|
-
},
|
2508
|
-
{
|
2509
|
-
"name": "size",
|
2510
|
-
"type": {
|
2511
|
-
"text": "ButtonSize"
|
2512
|
-
},
|
2513
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2514
|
-
"default": "32",
|
2515
|
-
"fieldName": "size"
|
2516
|
-
},
|
2517
|
-
{
|
2518
|
-
"name": "role",
|
2519
|
-
"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.",
|
2520
|
-
"default": "button",
|
2521
|
-
"fieldName": "role"
|
2522
|
-
},
|
2523
|
-
{
|
2524
|
-
"name": "type",
|
2525
|
-
"type": {
|
2526
|
-
"text": "ButtonType"
|
2527
|
-
},
|
2528
|
-
"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.",
|
2529
|
-
"default": "button",
|
2530
|
-
"fieldName": "type"
|
2531
|
-
},
|
2532
|
-
{
|
2533
|
-
"name": "tabIndex",
|
2534
|
-
"type": {
|
2535
|
-
"text": "number"
|
2536
|
-
},
|
2537
|
-
"default": "0",
|
2538
|
-
"description": "This property specifies the tab order of the element.",
|
2539
|
-
"fieldName": "tabIndex",
|
2540
|
-
"inheritedFrom": {
|
2541
|
-
"name": "TabIndexMixin",
|
2542
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2543
|
-
}
|
2544
|
-
},
|
2545
|
-
{
|
2546
|
-
"name": "disabled",
|
2547
|
-
"type": {
|
2548
|
-
"text": "boolean | undefined"
|
2549
|
-
},
|
2550
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2551
|
-
"default": "undefined",
|
2552
|
-
"fieldName": "disabled",
|
2553
|
-
"inheritedFrom": {
|
2554
|
-
"name": "DisabledMixin",
|
2555
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
2556
|
-
}
|
2557
|
-
}
|
2558
|
-
],
|
2559
|
-
"mixins": [
|
2560
|
-
{
|
2561
|
-
"name": "TabIndexMixin",
|
2562
|
-
"module": "/src/utils/mixins/TabIndexMixin"
|
2563
|
-
},
|
2564
|
-
{
|
2565
|
-
"name": "DisabledMixin",
|
2566
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
2567
|
-
}
|
2568
|
-
],
|
2569
|
-
"superclass": {
|
2570
|
-
"name": "Component",
|
2571
|
-
"module": "/src/models"
|
2572
|
-
},
|
2573
|
-
"tagName": "mdc-buttonsimple",
|
2574
|
-
"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 */",
|
2575
|
-
"customElement": true
|
2576
|
-
}
|
2577
|
-
],
|
2578
|
-
"exports": [
|
2579
|
-
{
|
2580
|
-
"kind": "js",
|
2581
|
-
"name": "default",
|
2582
|
-
"declaration": {
|
2583
|
-
"name": "Buttonsimple",
|
2584
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2585
|
-
}
|
2586
|
-
}
|
2587
|
-
]
|
2588
|
-
},
|
2589
|
-
{
|
2590
|
-
"kind": "javascript-module",
|
2591
|
-
"path": "components/brandvisual/brandvisual.component.js",
|
2592
|
-
"declarations": [
|
2593
|
-
{
|
2594
|
-
"kind": "class",
|
2595
|
-
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
2596
|
-
"name": "Brandvisual",
|
2597
|
-
"members": [
|
2598
|
-
{
|
2599
|
-
"kind": "field",
|
2600
|
-
"name": "brandVisualData",
|
2601
|
-
"type": {
|
2602
|
-
"text": "HTMLElement | undefined"
|
2603
|
-
},
|
2604
|
-
"privacy": "private"
|
2605
|
-
},
|
2606
|
-
{
|
2607
|
-
"kind": "field",
|
2608
|
-
"name": "name",
|
2609
|
-
"type": {
|
2610
|
-
"text": "BrandVisualNames | undefined"
|
2611
|
-
},
|
2612
|
-
"description": "Name of the brandVisual (= filename)",
|
2613
|
-
"attribute": "name",
|
2614
|
-
"reflects": true
|
2615
|
-
},
|
2616
|
-
{
|
2617
|
-
"kind": "method",
|
2618
|
-
"name": "getBrandVisualData",
|
2619
|
-
"privacy": "private"
|
2620
|
-
},
|
2621
|
-
{
|
2622
|
-
"kind": "method",
|
2623
|
-
"name": "handleBrandVisualLoadedSuccess",
|
2624
|
-
"privacy": "private",
|
2625
|
-
"parameters": [
|
2626
|
-
{
|
2627
|
-
"name": "brandVisualHtml",
|
2628
|
-
"type": {
|
2629
|
-
"text": "HTMLElement"
|
2630
|
-
},
|
2631
|
-
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
2632
|
-
}
|
2633
|
-
],
|
2634
|
-
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
2635
|
-
},
|
2636
|
-
{
|
2637
|
-
"kind": "method",
|
2638
|
-
"name": "handleBrandVisualLoadedFailure",
|
2639
|
-
"privacy": "private",
|
2640
|
-
"parameters": [
|
2641
|
-
{
|
2642
|
-
"name": "error",
|
2643
|
-
"type": {
|
2644
|
-
"text": "unknown"
|
2645
|
-
}
|
2646
|
-
}
|
2647
|
-
],
|
2648
|
-
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
2649
|
-
}
|
2650
|
-
],
|
2651
|
-
"events": [
|
2652
|
-
{
|
2653
|
-
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
2654
|
-
"name": "load",
|
2655
|
-
"reactName": "onLoad",
|
2656
|
-
"eventName": "LoadEvent"
|
2657
|
-
},
|
2658
|
-
{
|
2659
|
-
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
2660
|
-
"name": "error",
|
2661
|
-
"reactName": "onError",
|
2662
|
-
"eventName": "ErrorEvent"
|
2662
|
+
"reactName": "onFocus",
|
2663
|
+
"eventName": "FocusEvent"
|
2663
2664
|
}
|
2664
2665
|
],
|
2665
2666
|
"attributes": [
|
2666
2667
|
{
|
2667
|
-
"name": "
|
2668
|
+
"name": "active",
|
2668
2669
|
"type": {
|
2669
|
-
"text": "
|
2670
|
+
"text": "boolean"
|
2670
2671
|
},
|
2671
|
-
"
|
2672
|
-
"
|
2673
|
-
|
2674
|
-
|
2675
|
-
"superclass": {
|
2676
|
-
"name": "Component",
|
2677
|
-
"module": "/src/models"
|
2678
|
-
},
|
2679
|
-
"tagName": "mdc-brandvisual",
|
2680
|
-
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
2681
|
-
"customElement": true
|
2682
|
-
}
|
2683
|
-
],
|
2684
|
-
"exports": [
|
2685
|
-
{
|
2686
|
-
"kind": "js",
|
2687
|
-
"name": "default",
|
2688
|
-
"declaration": {
|
2689
|
-
"name": "Brandvisual",
|
2690
|
-
"module": "components/brandvisual/brandvisual.component.js"
|
2691
|
-
}
|
2692
|
-
}
|
2693
|
-
]
|
2694
|
-
},
|
2695
|
-
{
|
2696
|
-
"kind": "javascript-module",
|
2697
|
-
"path": "components/bullet/bullet.component.js",
|
2698
|
-
"declarations": [
|
2699
|
-
{
|
2700
|
-
"kind": "class",
|
2701
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2702
|
-
"name": "Bullet",
|
2703
|
-
"cssProperties": [
|
2672
|
+
"default": "false",
|
2673
|
+
"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.",
|
2674
|
+
"fieldName": "active"
|
2675
|
+
},
|
2704
2676
|
{
|
2705
|
-
"
|
2706
|
-
"
|
2677
|
+
"name": "soft-disabled",
|
2678
|
+
"type": {
|
2679
|
+
"text": "boolean"
|
2680
|
+
},
|
2681
|
+
"default": "false",
|
2682
|
+
"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.",
|
2683
|
+
"fieldName": "softDisabled"
|
2707
2684
|
},
|
2708
2685
|
{
|
2709
|
-
"
|
2710
|
-
"
|
2686
|
+
"name": "size",
|
2687
|
+
"type": {
|
2688
|
+
"text": "ButtonSize"
|
2689
|
+
},
|
2690
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
2691
|
+
"default": "32",
|
2692
|
+
"fieldName": "size"
|
2711
2693
|
},
|
2712
2694
|
{
|
2713
|
-
"
|
2714
|
-
"
|
2695
|
+
"name": "role",
|
2696
|
+
"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.",
|
2697
|
+
"default": "button",
|
2698
|
+
"fieldName": "role"
|
2715
2699
|
},
|
2716
2700
|
{
|
2717
|
-
"
|
2718
|
-
"
|
2719
|
-
|
2720
|
-
|
2721
|
-
|
2701
|
+
"name": "type",
|
2702
|
+
"type": {
|
2703
|
+
"text": "ButtonType"
|
2704
|
+
},
|
2705
|
+
"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.",
|
2706
|
+
"default": "button",
|
2707
|
+
"fieldName": "type"
|
2708
|
+
},
|
2722
2709
|
{
|
2723
|
-
"
|
2724
|
-
"name": "size",
|
2710
|
+
"name": "tabIndex",
|
2725
2711
|
"type": {
|
2726
|
-
"text": "
|
2712
|
+
"text": "number"
|
2727
2713
|
},
|
2728
|
-
"
|
2729
|
-
"description": "
|
2730
|
-
"
|
2731
|
-
"
|
2732
|
-
|
2733
|
-
|
2734
|
-
|
2735
|
-
|
2714
|
+
"default": "0",
|
2715
|
+
"description": "This property specifies the tab order of the element.",
|
2716
|
+
"fieldName": "tabIndex",
|
2717
|
+
"inheritedFrom": {
|
2718
|
+
"name": "TabIndexMixin",
|
2719
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2720
|
+
}
|
2721
|
+
},
|
2736
2722
|
{
|
2737
|
-
"name": "
|
2723
|
+
"name": "disabled",
|
2738
2724
|
"type": {
|
2739
|
-
"text": "
|
2725
|
+
"text": "boolean | undefined"
|
2740
2726
|
},
|
2741
|
-
"description": "
|
2742
|
-
"default": "
|
2743
|
-
"fieldName": "
|
2727
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2728
|
+
"default": "undefined",
|
2729
|
+
"fieldName": "disabled",
|
2730
|
+
"inheritedFrom": {
|
2731
|
+
"name": "DisabledMixin",
|
2732
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2733
|
+
}
|
2734
|
+
}
|
2735
|
+
],
|
2736
|
+
"mixins": [
|
2737
|
+
{
|
2738
|
+
"name": "TabIndexMixin",
|
2739
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
2740
|
+
},
|
2741
|
+
{
|
2742
|
+
"name": "DisabledMixin",
|
2743
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
2744
2744
|
}
|
2745
2745
|
],
|
2746
2746
|
"superclass": {
|
2747
2747
|
"name": "Component",
|
2748
2748
|
"module": "/src/models"
|
2749
2749
|
},
|
2750
|
-
"tagName": "mdc-
|
2751
|
-
"jsDoc": "/**\n *
|
2750
|
+
"tagName": "mdc-buttonsimple",
|
2751
|
+
"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 */",
|
2752
2752
|
"customElement": true
|
2753
2753
|
}
|
2754
2754
|
],
|
@@ -2757,8 +2757,8 @@
|
|
2757
2757
|
"kind": "js",
|
2758
2758
|
"name": "default",
|
2759
2759
|
"declaration": {
|
2760
|
-
"name": "
|
2761
|
-
"module": "components/
|
2760
|
+
"name": "Buttonsimple",
|
2761
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2762
2762
|
}
|
2763
2763
|
}
|
2764
2764
|
]
|
@@ -13179,6 +13179,185 @@
|
|
13179
13179
|
}
|
13180
13180
|
]
|
13181
13181
|
},
|
13182
|
+
{
|
13183
|
+
"kind": "javascript-module",
|
13184
|
+
"path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
|
13185
|
+
"declarations": [
|
13186
|
+
{
|
13187
|
+
"kind": "class",
|
13188
|
+
"description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
|
13189
|
+
"name": "ScreenreaderAnnouncer",
|
13190
|
+
"members": [
|
13191
|
+
{
|
13192
|
+
"kind": "field",
|
13193
|
+
"name": "announcement",
|
13194
|
+
"type": {
|
13195
|
+
"text": "string"
|
13196
|
+
},
|
13197
|
+
"default": "''",
|
13198
|
+
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
13199
|
+
"attribute": "announcement",
|
13200
|
+
"reflects": true
|
13201
|
+
},
|
13202
|
+
{
|
13203
|
+
"kind": "field",
|
13204
|
+
"name": "identity",
|
13205
|
+
"type": {
|
13206
|
+
"text": "string"
|
13207
|
+
},
|
13208
|
+
"default": "''",
|
13209
|
+
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
13210
|
+
"attribute": "identity",
|
13211
|
+
"reflects": true
|
13212
|
+
},
|
13213
|
+
{
|
13214
|
+
"kind": "field",
|
13215
|
+
"name": "dataAriaLive",
|
13216
|
+
"type": {
|
13217
|
+
"text": "AriaLive"
|
13218
|
+
},
|
13219
|
+
"description": "Aria live value for announcement.",
|
13220
|
+
"default": "'polite'",
|
13221
|
+
"attribute": "data-aria-live",
|
13222
|
+
"reflects": true
|
13223
|
+
},
|
13224
|
+
{
|
13225
|
+
"kind": "field",
|
13226
|
+
"name": "delay",
|
13227
|
+
"type": {
|
13228
|
+
"text": "number"
|
13229
|
+
},
|
13230
|
+
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
13231
|
+
"default": "150",
|
13232
|
+
"attribute": "delay",
|
13233
|
+
"reflects": true
|
13234
|
+
},
|
13235
|
+
{
|
13236
|
+
"kind": "field",
|
13237
|
+
"name": "timeout",
|
13238
|
+
"type": {
|
13239
|
+
"text": "number"
|
13240
|
+
},
|
13241
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
13242
|
+
"default": "20_000",
|
13243
|
+
"attribute": "timeout",
|
13244
|
+
"reflects": true
|
13245
|
+
},
|
13246
|
+
{
|
13247
|
+
"kind": "method",
|
13248
|
+
"name": "announce",
|
13249
|
+
"parameters": [
|
13250
|
+
{
|
13251
|
+
"name": "announcement",
|
13252
|
+
"type": {
|
13253
|
+
"text": "string"
|
13254
|
+
},
|
13255
|
+
"description": "The announcement to be made."
|
13256
|
+
},
|
13257
|
+
{
|
13258
|
+
"name": "delay",
|
13259
|
+
"type": {
|
13260
|
+
"text": "number"
|
13261
|
+
},
|
13262
|
+
"description": "The delay in milliseconds before announcing the message."
|
13263
|
+
},
|
13264
|
+
{
|
13265
|
+
"name": "timeout",
|
13266
|
+
"type": {
|
13267
|
+
"text": "number"
|
13268
|
+
},
|
13269
|
+
"description": "The timeout in milliseconds before removing the announcement."
|
13270
|
+
},
|
13271
|
+
{
|
13272
|
+
"name": "ariaLive",
|
13273
|
+
"type": {
|
13274
|
+
"text": "AriaLive"
|
13275
|
+
},
|
13276
|
+
"description": "The aria live value for the announcement."
|
13277
|
+
}
|
13278
|
+
],
|
13279
|
+
"description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
|
13280
|
+
},
|
13281
|
+
{
|
13282
|
+
"kind": "method",
|
13283
|
+
"name": "clearTimeOutsAndAnnouncements",
|
13284
|
+
"privacy": "private",
|
13285
|
+
"description": "Clears all timeouts and removes all announcements from the screen reader."
|
13286
|
+
},
|
13287
|
+
{
|
13288
|
+
"kind": "method",
|
13289
|
+
"name": "createAnnouncementAriaLiveRegion",
|
13290
|
+
"privacy": "private",
|
13291
|
+
"description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
|
13292
|
+
}
|
13293
|
+
],
|
13294
|
+
"attributes": [
|
13295
|
+
{
|
13296
|
+
"name": "announcement",
|
13297
|
+
"type": {
|
13298
|
+
"text": "string"
|
13299
|
+
},
|
13300
|
+
"default": "''",
|
13301
|
+
"description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
|
13302
|
+
"fieldName": "announcement"
|
13303
|
+
},
|
13304
|
+
{
|
13305
|
+
"name": "identity",
|
13306
|
+
"type": {
|
13307
|
+
"text": "string"
|
13308
|
+
},
|
13309
|
+
"default": "''",
|
13310
|
+
"description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
|
13311
|
+
"fieldName": "identity"
|
13312
|
+
},
|
13313
|
+
{
|
13314
|
+
"name": "data-aria-live",
|
13315
|
+
"type": {
|
13316
|
+
"text": "AriaLive"
|
13317
|
+
},
|
13318
|
+
"description": "Aria live value for announcement.",
|
13319
|
+
"default": "'polite'",
|
13320
|
+
"fieldName": "dataAriaLive"
|
13321
|
+
},
|
13322
|
+
{
|
13323
|
+
"name": "delay",
|
13324
|
+
"type": {
|
13325
|
+
"text": "number"
|
13326
|
+
},
|
13327
|
+
"description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
|
13328
|
+
"default": "150",
|
13329
|
+
"fieldName": "delay"
|
13330
|
+
},
|
13331
|
+
{
|
13332
|
+
"name": "timeout",
|
13333
|
+
"type": {
|
13334
|
+
"text": "number"
|
13335
|
+
},
|
13336
|
+
"description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
|
13337
|
+
"default": "20_000",
|
13338
|
+
"fieldName": "timeout"
|
13339
|
+
}
|
13340
|
+
],
|
13341
|
+
"superclass": {
|
13342
|
+
"name": "Component",
|
13343
|
+
"module": "/src/models"
|
13344
|
+
},
|
13345
|
+
"tagName": "mdc-screenreaderannouncer",
|
13346
|
+
"jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
|
13347
|
+
"customElement": true
|
13348
|
+
}
|
13349
|
+
],
|
13350
|
+
"exports": [
|
13351
|
+
{
|
13352
|
+
"kind": "js",
|
13353
|
+
"name": "default",
|
13354
|
+
"declaration": {
|
13355
|
+
"name": "ScreenreaderAnnouncer",
|
13356
|
+
"module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
|
13357
|
+
}
|
13358
|
+
}
|
13359
|
+
]
|
13360
|
+
},
|
13182
13361
|
{
|
13183
13362
|
"kind": "javascript-module",
|
13184
13363
|
"path": "components/searchfield/searchfield.component.js",
|