@momentum-design/components 0.125.0 → 0.125.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +161 -161
- package/dist/browser/index.js.map +3 -3
- package/dist/custom-elements.json +510 -510
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/dist/utils/controllers/ElementStore.d.ts +10 -0
- package/dist/utils/controllers/ElementStore.js +30 -2
- package/dist/utils/dom.d.ts +13 -0
- package/dist/utils/dom.js +13 -0
- package/package.json +1 -1
|
@@ -1654,6 +1654,218 @@
|
|
|
1654
1654
|
}
|
|
1655
1655
|
]
|
|
1656
1656
|
},
|
|
1657
|
+
{
|
|
1658
|
+
"kind": "javascript-module",
|
|
1659
|
+
"path": "components/animation/animation.component.js",
|
|
1660
|
+
"declarations": [
|
|
1661
|
+
{
|
|
1662
|
+
"kind": "class",
|
|
1663
|
+
"description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
|
|
1664
|
+
"name": "Animation",
|
|
1665
|
+
"members": [
|
|
1666
|
+
{
|
|
1667
|
+
"kind": "field",
|
|
1668
|
+
"name": "name",
|
|
1669
|
+
"type": {
|
|
1670
|
+
"text": "AnimationNames | undefined"
|
|
1671
|
+
},
|
|
1672
|
+
"description": "Name of the animation (= filename)",
|
|
1673
|
+
"attribute": "name",
|
|
1674
|
+
"reflects": true
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
"kind": "field",
|
|
1678
|
+
"name": "loop",
|
|
1679
|
+
"type": {
|
|
1680
|
+
"text": "LoopType | undefined"
|
|
1681
|
+
},
|
|
1682
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
|
1683
|
+
"attribute": "loop",
|
|
1684
|
+
"reflects": true
|
|
1685
|
+
},
|
|
1686
|
+
{
|
|
1687
|
+
"kind": "field",
|
|
1688
|
+
"name": "autoplay",
|
|
1689
|
+
"type": {
|
|
1690
|
+
"text": "boolean | undefined"
|
|
1691
|
+
},
|
|
1692
|
+
"description": "Weather start the animation automatically",
|
|
1693
|
+
"attribute": "autoplay",
|
|
1694
|
+
"reflects": true
|
|
1695
|
+
},
|
|
1696
|
+
{
|
|
1697
|
+
"kind": "field",
|
|
1698
|
+
"name": "ariaLabel",
|
|
1699
|
+
"type": {
|
|
1700
|
+
"text": "string | null"
|
|
1701
|
+
},
|
|
1702
|
+
"default": "null",
|
|
1703
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
1704
|
+
"attribute": "aria-label"
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"kind": "field",
|
|
1708
|
+
"name": "ariaLabelledby",
|
|
1709
|
+
"type": {
|
|
1710
|
+
"text": "string | null"
|
|
1711
|
+
},
|
|
1712
|
+
"default": "null",
|
|
1713
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
|
1714
|
+
"attribute": "aria-labelledby"
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
"kind": "field",
|
|
1718
|
+
"name": "lottieInstance",
|
|
1719
|
+
"type": {
|
|
1720
|
+
"text": "AnimationItem | undefined"
|
|
1721
|
+
},
|
|
1722
|
+
"privacy": "private",
|
|
1723
|
+
"description": "Lottie animation instance"
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"kind": "field",
|
|
1727
|
+
"name": "containerRef",
|
|
1728
|
+
"type": {
|
|
1729
|
+
"text": "Ref<HTMLDivElement>"
|
|
1730
|
+
},
|
|
1731
|
+
"privacy": "private",
|
|
1732
|
+
"description": "Container for the animation"
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"kind": "field",
|
|
1736
|
+
"name": "animation",
|
|
1737
|
+
"description": "Exposed API of the animation library (lottie)",
|
|
1738
|
+
"readonly": true
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"kind": "method",
|
|
1742
|
+
"name": "getLoopValue",
|
|
1743
|
+
"privacy": "private"
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"kind": "method",
|
|
1747
|
+
"name": "onLoadSuccessHandler",
|
|
1748
|
+
"privacy": "private",
|
|
1749
|
+
"parameters": [
|
|
1750
|
+
{
|
|
1751
|
+
"name": "animationData",
|
|
1752
|
+
"type": {
|
|
1753
|
+
"text": "any"
|
|
1754
|
+
}
|
|
1755
|
+
}
|
|
1756
|
+
],
|
|
1757
|
+
"description": "Create new lotty instance for the loaded data"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"kind": "method",
|
|
1761
|
+
"name": "onLoadFailHandler",
|
|
1762
|
+
"privacy": "private",
|
|
1763
|
+
"parameters": [
|
|
1764
|
+
{
|
|
1765
|
+
"name": "error",
|
|
1766
|
+
"type": {
|
|
1767
|
+
"text": "Error"
|
|
1768
|
+
}
|
|
1769
|
+
}
|
|
1770
|
+
],
|
|
1771
|
+
"description": "Error handler for animation loading"
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"kind": "method",
|
|
1775
|
+
"name": "getAnimationData",
|
|
1776
|
+
"privacy": "private",
|
|
1777
|
+
"description": "Import animation data dynamically"
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
"kind": "field",
|
|
1781
|
+
"name": "onCompleteHandler",
|
|
1782
|
+
"description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
|
|
1783
|
+
}
|
|
1784
|
+
],
|
|
1785
|
+
"events": [
|
|
1786
|
+
{
|
|
1787
|
+
"name": "load",
|
|
1788
|
+
"type": {
|
|
1789
|
+
"text": "CustomEvent"
|
|
1790
|
+
},
|
|
1791
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
|
1792
|
+
"reactName": "onLoad"
|
|
1793
|
+
},
|
|
1794
|
+
{
|
|
1795
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
|
1796
|
+
"name": "complete",
|
|
1797
|
+
"reactName": "onComplete"
|
|
1798
|
+
},
|
|
1799
|
+
{
|
|
1800
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
|
1801
|
+
"name": "error",
|
|
1802
|
+
"reactName": "onError"
|
|
1803
|
+
}
|
|
1804
|
+
],
|
|
1805
|
+
"attributes": [
|
|
1806
|
+
{
|
|
1807
|
+
"name": "name",
|
|
1808
|
+
"type": {
|
|
1809
|
+
"text": "AnimationNames | undefined"
|
|
1810
|
+
},
|
|
1811
|
+
"description": "Name of the animation (= filename)",
|
|
1812
|
+
"fieldName": "name"
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"name": "loop",
|
|
1816
|
+
"type": {
|
|
1817
|
+
"text": "LoopType | undefined"
|
|
1818
|
+
},
|
|
1819
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
|
1820
|
+
"fieldName": "loop"
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"name": "autoplay",
|
|
1824
|
+
"type": {
|
|
1825
|
+
"text": "boolean | undefined"
|
|
1826
|
+
},
|
|
1827
|
+
"description": "Weather start the animation automatically",
|
|
1828
|
+
"fieldName": "autoplay"
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"name": "aria-label",
|
|
1832
|
+
"type": {
|
|
1833
|
+
"text": "string | null"
|
|
1834
|
+
},
|
|
1835
|
+
"default": "null",
|
|
1836
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
1837
|
+
"fieldName": "ariaLabel"
|
|
1838
|
+
},
|
|
1839
|
+
{
|
|
1840
|
+
"name": "aria-labelledby",
|
|
1841
|
+
"type": {
|
|
1842
|
+
"text": "string | null"
|
|
1843
|
+
},
|
|
1844
|
+
"default": "null",
|
|
1845
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
|
1846
|
+
"fieldName": "ariaLabelledby"
|
|
1847
|
+
}
|
|
1848
|
+
],
|
|
1849
|
+
"superclass": {
|
|
1850
|
+
"name": "Component",
|
|
1851
|
+
"module": "/src/models"
|
|
1852
|
+
},
|
|
1853
|
+
"tagName": "mdc-animation",
|
|
1854
|
+
"jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
|
|
1855
|
+
"customElement": true
|
|
1856
|
+
}
|
|
1857
|
+
],
|
|
1858
|
+
"exports": [
|
|
1859
|
+
{
|
|
1860
|
+
"kind": "js",
|
|
1861
|
+
"name": "default",
|
|
1862
|
+
"declaration": {
|
|
1863
|
+
"name": "Animation",
|
|
1864
|
+
"module": "components/animation/animation.component.js"
|
|
1865
|
+
}
|
|
1866
|
+
}
|
|
1867
|
+
]
|
|
1868
|
+
},
|
|
1657
1869
|
{
|
|
1658
1870
|
"kind": "javascript-module",
|
|
1659
1871
|
"path": "components/announcementdialog/announcementdialog.component.js",
|
|
@@ -3078,218 +3290,6 @@
|
|
|
3078
3290
|
}
|
|
3079
3291
|
]
|
|
3080
3292
|
},
|
|
3081
|
-
{
|
|
3082
|
-
"kind": "javascript-module",
|
|
3083
|
-
"path": "components/animation/animation.component.js",
|
|
3084
|
-
"declarations": [
|
|
3085
|
-
{
|
|
3086
|
-
"kind": "class",
|
|
3087
|
-
"description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
|
|
3088
|
-
"name": "Animation",
|
|
3089
|
-
"members": [
|
|
3090
|
-
{
|
|
3091
|
-
"kind": "field",
|
|
3092
|
-
"name": "name",
|
|
3093
|
-
"type": {
|
|
3094
|
-
"text": "AnimationNames | undefined"
|
|
3095
|
-
},
|
|
3096
|
-
"description": "Name of the animation (= filename)",
|
|
3097
|
-
"attribute": "name",
|
|
3098
|
-
"reflects": true
|
|
3099
|
-
},
|
|
3100
|
-
{
|
|
3101
|
-
"kind": "field",
|
|
3102
|
-
"name": "loop",
|
|
3103
|
-
"type": {
|
|
3104
|
-
"text": "LoopType | undefined"
|
|
3105
|
-
},
|
|
3106
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
|
3107
|
-
"attribute": "loop",
|
|
3108
|
-
"reflects": true
|
|
3109
|
-
},
|
|
3110
|
-
{
|
|
3111
|
-
"kind": "field",
|
|
3112
|
-
"name": "autoplay",
|
|
3113
|
-
"type": {
|
|
3114
|
-
"text": "boolean | undefined"
|
|
3115
|
-
},
|
|
3116
|
-
"description": "Weather start the animation automatically",
|
|
3117
|
-
"attribute": "autoplay",
|
|
3118
|
-
"reflects": true
|
|
3119
|
-
},
|
|
3120
|
-
{
|
|
3121
|
-
"kind": "field",
|
|
3122
|
-
"name": "ariaLabel",
|
|
3123
|
-
"type": {
|
|
3124
|
-
"text": "string | null"
|
|
3125
|
-
},
|
|
3126
|
-
"default": "null",
|
|
3127
|
-
"description": "Aria-label attribute to be set for accessibility",
|
|
3128
|
-
"attribute": "aria-label"
|
|
3129
|
-
},
|
|
3130
|
-
{
|
|
3131
|
-
"kind": "field",
|
|
3132
|
-
"name": "ariaLabelledby",
|
|
3133
|
-
"type": {
|
|
3134
|
-
"text": "string | null"
|
|
3135
|
-
},
|
|
3136
|
-
"default": "null",
|
|
3137
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
|
3138
|
-
"attribute": "aria-labelledby"
|
|
3139
|
-
},
|
|
3140
|
-
{
|
|
3141
|
-
"kind": "field",
|
|
3142
|
-
"name": "lottieInstance",
|
|
3143
|
-
"type": {
|
|
3144
|
-
"text": "AnimationItem | undefined"
|
|
3145
|
-
},
|
|
3146
|
-
"privacy": "private",
|
|
3147
|
-
"description": "Lottie animation instance"
|
|
3148
|
-
},
|
|
3149
|
-
{
|
|
3150
|
-
"kind": "field",
|
|
3151
|
-
"name": "containerRef",
|
|
3152
|
-
"type": {
|
|
3153
|
-
"text": "Ref<HTMLDivElement>"
|
|
3154
|
-
},
|
|
3155
|
-
"privacy": "private",
|
|
3156
|
-
"description": "Container for the animation"
|
|
3157
|
-
},
|
|
3158
|
-
{
|
|
3159
|
-
"kind": "field",
|
|
3160
|
-
"name": "animation",
|
|
3161
|
-
"description": "Exposed API of the animation library (lottie)",
|
|
3162
|
-
"readonly": true
|
|
3163
|
-
},
|
|
3164
|
-
{
|
|
3165
|
-
"kind": "method",
|
|
3166
|
-
"name": "getLoopValue",
|
|
3167
|
-
"privacy": "private"
|
|
3168
|
-
},
|
|
3169
|
-
{
|
|
3170
|
-
"kind": "method",
|
|
3171
|
-
"name": "onLoadSuccessHandler",
|
|
3172
|
-
"privacy": "private",
|
|
3173
|
-
"parameters": [
|
|
3174
|
-
{
|
|
3175
|
-
"name": "animationData",
|
|
3176
|
-
"type": {
|
|
3177
|
-
"text": "any"
|
|
3178
|
-
}
|
|
3179
|
-
}
|
|
3180
|
-
],
|
|
3181
|
-
"description": "Create new lotty instance for the loaded data"
|
|
3182
|
-
},
|
|
3183
|
-
{
|
|
3184
|
-
"kind": "method",
|
|
3185
|
-
"name": "onLoadFailHandler",
|
|
3186
|
-
"privacy": "private",
|
|
3187
|
-
"parameters": [
|
|
3188
|
-
{
|
|
3189
|
-
"name": "error",
|
|
3190
|
-
"type": {
|
|
3191
|
-
"text": "Error"
|
|
3192
|
-
}
|
|
3193
|
-
}
|
|
3194
|
-
],
|
|
3195
|
-
"description": "Error handler for animation loading"
|
|
3196
|
-
},
|
|
3197
|
-
{
|
|
3198
|
-
"kind": "method",
|
|
3199
|
-
"name": "getAnimationData",
|
|
3200
|
-
"privacy": "private",
|
|
3201
|
-
"description": "Import animation data dynamically"
|
|
3202
|
-
},
|
|
3203
|
-
{
|
|
3204
|
-
"kind": "field",
|
|
3205
|
-
"name": "onCompleteHandler",
|
|
3206
|
-
"description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
|
|
3207
|
-
}
|
|
3208
|
-
],
|
|
3209
|
-
"events": [
|
|
3210
|
-
{
|
|
3211
|
-
"name": "load",
|
|
3212
|
-
"type": {
|
|
3213
|
-
"text": "CustomEvent"
|
|
3214
|
-
},
|
|
3215
|
-
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
|
3216
|
-
"reactName": "onLoad"
|
|
3217
|
-
},
|
|
3218
|
-
{
|
|
3219
|
-
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
|
3220
|
-
"name": "complete",
|
|
3221
|
-
"reactName": "onComplete"
|
|
3222
|
-
},
|
|
3223
|
-
{
|
|
3224
|
-
"description": "(React: onError) This event is dispatched when animation loading failed",
|
|
3225
|
-
"name": "error",
|
|
3226
|
-
"reactName": "onError"
|
|
3227
|
-
}
|
|
3228
|
-
],
|
|
3229
|
-
"attributes": [
|
|
3230
|
-
{
|
|
3231
|
-
"name": "name",
|
|
3232
|
-
"type": {
|
|
3233
|
-
"text": "AnimationNames | undefined"
|
|
3234
|
-
},
|
|
3235
|
-
"description": "Name of the animation (= filename)",
|
|
3236
|
-
"fieldName": "name"
|
|
3237
|
-
},
|
|
3238
|
-
{
|
|
3239
|
-
"name": "loop",
|
|
3240
|
-
"type": {
|
|
3241
|
-
"text": "LoopType | undefined"
|
|
3242
|
-
},
|
|
3243
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
|
3244
|
-
"fieldName": "loop"
|
|
3245
|
-
},
|
|
3246
|
-
{
|
|
3247
|
-
"name": "autoplay",
|
|
3248
|
-
"type": {
|
|
3249
|
-
"text": "boolean | undefined"
|
|
3250
|
-
},
|
|
3251
|
-
"description": "Weather start the animation automatically",
|
|
3252
|
-
"fieldName": "autoplay"
|
|
3253
|
-
},
|
|
3254
|
-
{
|
|
3255
|
-
"name": "aria-label",
|
|
3256
|
-
"type": {
|
|
3257
|
-
"text": "string | null"
|
|
3258
|
-
},
|
|
3259
|
-
"default": "null",
|
|
3260
|
-
"description": "Aria-label attribute to be set for accessibility",
|
|
3261
|
-
"fieldName": "ariaLabel"
|
|
3262
|
-
},
|
|
3263
|
-
{
|
|
3264
|
-
"name": "aria-labelledby",
|
|
3265
|
-
"type": {
|
|
3266
|
-
"text": "string | null"
|
|
3267
|
-
},
|
|
3268
|
-
"default": "null",
|
|
3269
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
|
3270
|
-
"fieldName": "ariaLabelledby"
|
|
3271
|
-
}
|
|
3272
|
-
],
|
|
3273
|
-
"superclass": {
|
|
3274
|
-
"name": "Component",
|
|
3275
|
-
"module": "/src/models"
|
|
3276
|
-
},
|
|
3277
|
-
"tagName": "mdc-animation",
|
|
3278
|
-
"jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
|
|
3279
|
-
"customElement": true
|
|
3280
|
-
}
|
|
3281
|
-
],
|
|
3282
|
-
"exports": [
|
|
3283
|
-
{
|
|
3284
|
-
"kind": "js",
|
|
3285
|
-
"name": "default",
|
|
3286
|
-
"declaration": {
|
|
3287
|
-
"name": "Animation",
|
|
3288
|
-
"module": "components/animation/animation.component.js"
|
|
3289
|
-
}
|
|
3290
|
-
}
|
|
3291
|
-
]
|
|
3292
|
-
},
|
|
3293
3293
|
{
|
|
3294
3294
|
"kind": "javascript-module",
|
|
3295
3295
|
"path": "components/avatar/avatar.component.js",
|
|
@@ -31034,7 +31034,7 @@
|
|
|
31034
31034
|
{
|
|
31035
31035
|
"name": "iconName",
|
|
31036
31036
|
"type": {
|
|
31037
|
-
"text": "
|
|
31037
|
+
"text": "IconNames"
|
|
31038
31038
|
}
|
|
31039
31039
|
}
|
|
31040
31040
|
]
|
|
@@ -45160,303 +45160,6 @@
|
|
|
45160
45160
|
}
|
|
45161
45161
|
]
|
|
45162
45162
|
},
|
|
45163
|
-
{
|
|
45164
|
-
"kind": "javascript-module",
|
|
45165
|
-
"path": "components/stepperitem/stepperitem.component.js",
|
|
45166
|
-
"declarations": [
|
|
45167
|
-
{
|
|
45168
|
-
"kind": "class",
|
|
45169
|
-
"description": "stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\nIt can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\nThe component supports various visual styles and can be customized with labels, help text, and step numbers.\n\nThis is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\nMake sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n\nAdditionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.",
|
|
45170
|
-
"name": "StepperItem",
|
|
45171
|
-
"cssProperties": [
|
|
45172
|
-
{
|
|
45173
|
-
"description": "The background color of the status container.",
|
|
45174
|
-
"name": "--mdc-stepperitem-status-container-background"
|
|
45175
|
-
},
|
|
45176
|
-
{
|
|
45177
|
-
"description": "The border color of the status container.",
|
|
45178
|
-
"name": "--mdc-stepperitem-status-container-border-color"
|
|
45179
|
-
},
|
|
45180
|
-
{
|
|
45181
|
-
"description": "The color of the label text.",
|
|
45182
|
-
"name": "--mdc-stepperitem-label-color"
|
|
45183
|
-
},
|
|
45184
|
-
{
|
|
45185
|
-
"description": "The color of the optional label text.",
|
|
45186
|
-
"name": "--mdc-stepperitem-help-text-color"
|
|
45187
|
-
},
|
|
45188
|
-
{
|
|
45189
|
-
"description": "The background color of the label container.",
|
|
45190
|
-
"name": "--mdc-stepperitem-label-container-background"
|
|
45191
|
-
}
|
|
45192
|
-
],
|
|
45193
|
-
"cssParts": [
|
|
45194
|
-
{
|
|
45195
|
-
"description": "The container for the status icon or step number.",
|
|
45196
|
-
"name": "status-container"
|
|
45197
|
-
},
|
|
45198
|
-
{
|
|
45199
|
-
"description": "The container for the label and help text.",
|
|
45200
|
-
"name": "label-container"
|
|
45201
|
-
},
|
|
45202
|
-
{
|
|
45203
|
-
"description": "The container for the help text and error icon when applicable.",
|
|
45204
|
-
"name": "help-text-container"
|
|
45205
|
-
},
|
|
45206
|
-
{
|
|
45207
|
-
"description": "The icon representing the status of the stepper item.",
|
|
45208
|
-
"name": "status-icon"
|
|
45209
|
-
},
|
|
45210
|
-
{
|
|
45211
|
-
"description": "The text representing the step number.",
|
|
45212
|
-
"name": "step-number"
|
|
45213
|
-
},
|
|
45214
|
-
{
|
|
45215
|
-
"description": "The text representing the label of the stepper item.",
|
|
45216
|
-
"name": "label"
|
|
45217
|
-
},
|
|
45218
|
-
{
|
|
45219
|
-
"description": "The text providing additional information about the stepper item.",
|
|
45220
|
-
"name": "help-text"
|
|
45221
|
-
},
|
|
45222
|
-
{
|
|
45223
|
-
"description": "The icon representing an error in the stepper item.",
|
|
45224
|
-
"name": "help-icon"
|
|
45225
|
-
}
|
|
45226
|
-
],
|
|
45227
|
-
"members": [
|
|
45228
|
-
{
|
|
45229
|
-
"kind": "field",
|
|
45230
|
-
"name": "variant",
|
|
45231
|
-
"type": {
|
|
45232
|
-
"text": "VariantType"
|
|
45233
|
-
},
|
|
45234
|
-
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
45235
|
-
"default": "'inline'",
|
|
45236
|
-
"attribute": "variant",
|
|
45237
|
-
"reflects": true
|
|
45238
|
-
},
|
|
45239
|
-
{
|
|
45240
|
-
"kind": "field",
|
|
45241
|
-
"name": "status",
|
|
45242
|
-
"type": {
|
|
45243
|
-
"text": "StatusType"
|
|
45244
|
-
},
|
|
45245
|
-
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
45246
|
-
"default": "'not-started'",
|
|
45247
|
-
"attribute": "status",
|
|
45248
|
-
"reflects": true
|
|
45249
|
-
},
|
|
45250
|
-
{
|
|
45251
|
-
"kind": "field",
|
|
45252
|
-
"name": "label",
|
|
45253
|
-
"type": {
|
|
45254
|
-
"text": "string"
|
|
45255
|
-
},
|
|
45256
|
-
"default": "''",
|
|
45257
|
-
"description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
|
|
45258
|
-
"attribute": "label",
|
|
45259
|
-
"reflects": true
|
|
45260
|
-
},
|
|
45261
|
-
{
|
|
45262
|
-
"kind": "field",
|
|
45263
|
-
"name": "helpText",
|
|
45264
|
-
"type": {
|
|
45265
|
-
"text": "string | undefined"
|
|
45266
|
-
},
|
|
45267
|
-
"description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
|
|
45268
|
-
"default": "''",
|
|
45269
|
-
"attribute": "help-text",
|
|
45270
|
-
"reflects": true
|
|
45271
|
-
},
|
|
45272
|
-
{
|
|
45273
|
-
"kind": "field",
|
|
45274
|
-
"name": "stepNumber",
|
|
45275
|
-
"type": {
|
|
45276
|
-
"text": "number | undefined"
|
|
45277
|
-
},
|
|
45278
|
-
"description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
|
|
45279
|
-
"default": "''",
|
|
45280
|
-
"attribute": "step-number",
|
|
45281
|
-
"reflects": true
|
|
45282
|
-
},
|
|
45283
|
-
{
|
|
45284
|
-
"kind": "method",
|
|
45285
|
-
"name": "handleKeyDown",
|
|
45286
|
-
"privacy": "private",
|
|
45287
|
-
"parameters": [
|
|
45288
|
-
{
|
|
45289
|
-
"name": "event",
|
|
45290
|
-
"type": {
|
|
45291
|
-
"text": "KeyboardEvent"
|
|
45292
|
-
},
|
|
45293
|
-
"description": "The keyboard event."
|
|
45294
|
-
}
|
|
45295
|
-
],
|
|
45296
|
-
"description": "Handles the keydown event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is pressed.\nIf the key is 'Enter', the stepperitem is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the stepperitem's default is prevent to avoid scrolling etc in the host application."
|
|
45297
|
-
},
|
|
45298
|
-
{
|
|
45299
|
-
"kind": "method",
|
|
45300
|
-
"name": "triggerClickEvent",
|
|
45301
|
-
"privacy": "private",
|
|
45302
|
-
"description": "Triggers a click event on the stepper item."
|
|
45303
|
-
},
|
|
45304
|
-
{
|
|
45305
|
-
"kind": "method",
|
|
45306
|
-
"name": "handleKeyUp",
|
|
45307
|
-
"privacy": "private",
|
|
45308
|
-
"parameters": [
|
|
45309
|
-
{
|
|
45310
|
-
"name": "event",
|
|
45311
|
-
"type": {
|
|
45312
|
-
"text": "KeyboardEvent"
|
|
45313
|
-
},
|
|
45314
|
-
"description": "The keyboard event."
|
|
45315
|
-
}
|
|
45316
|
-
],
|
|
45317
|
-
"description": "Handles the keyup event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is clicked.\nIf the key is 'Space', the stepperitem is pressed. The native HTML button works in the same way."
|
|
45318
|
-
},
|
|
45319
|
-
{
|
|
45320
|
-
"kind": "method",
|
|
45321
|
-
"name": "renderStatusIcon",
|
|
45322
|
-
"privacy": "private",
|
|
45323
|
-
"description": "Renders the status icon based on the current status of the stepper item.\n- If the status is `completed`, it renders a check icon.\n- If the status is `current` or `error-current`, it renders a pencil icon.\n- If the status is `not-started` or `error-incomplete`, it renders the step number.\n- If the status is anything else, it renders nothing.",
|
|
45324
|
-
"return": {
|
|
45325
|
-
"type": {
|
|
45326
|
-
"text": ""
|
|
45327
|
-
}
|
|
45328
|
-
}
|
|
45329
|
-
},
|
|
45330
|
-
{
|
|
45331
|
-
"kind": "method",
|
|
45332
|
-
"name": "renderHelpText",
|
|
45333
|
-
"privacy": "private",
|
|
45334
|
-
"description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
|
|
45335
|
-
"return": {
|
|
45336
|
-
"type": {
|
|
45337
|
-
"text": ""
|
|
45338
|
-
}
|
|
45339
|
-
}
|
|
45340
|
-
},
|
|
45341
|
-
{
|
|
45342
|
-
"kind": "field",
|
|
45343
|
-
"name": "tabIndex",
|
|
45344
|
-
"type": {
|
|
45345
|
-
"text": "number"
|
|
45346
|
-
},
|
|
45347
|
-
"default": "0",
|
|
45348
|
-
"description": "This property specifies the tab order of the element.",
|
|
45349
|
-
"attribute": "tabIndex",
|
|
45350
|
-
"reflects": true,
|
|
45351
|
-
"inheritedFrom": {
|
|
45352
|
-
"name": "TabIndexMixin",
|
|
45353
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
|
45354
|
-
}
|
|
45355
|
-
}
|
|
45356
|
-
],
|
|
45357
|
-
"events": [
|
|
45358
|
-
{
|
|
45359
|
-
"description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
|
|
45360
|
-
"name": "click",
|
|
45361
|
-
"reactName": "onClick"
|
|
45362
|
-
},
|
|
45363
|
-
{
|
|
45364
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
|
|
45365
|
-
"name": "keydown",
|
|
45366
|
-
"reactName": "onKeyDown"
|
|
45367
|
-
},
|
|
45368
|
-
{
|
|
45369
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
|
|
45370
|
-
"name": "keyup",
|
|
45371
|
-
"reactName": "onKeyUp"
|
|
45372
|
-
}
|
|
45373
|
-
],
|
|
45374
|
-
"attributes": [
|
|
45375
|
-
{
|
|
45376
|
-
"name": "variant",
|
|
45377
|
-
"type": {
|
|
45378
|
-
"text": "VariantType"
|
|
45379
|
-
},
|
|
45380
|
-
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
45381
|
-
"default": "'inline'",
|
|
45382
|
-
"fieldName": "variant"
|
|
45383
|
-
},
|
|
45384
|
-
{
|
|
45385
|
-
"name": "status",
|
|
45386
|
-
"type": {
|
|
45387
|
-
"text": "StatusType"
|
|
45388
|
-
},
|
|
45389
|
-
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
45390
|
-
"default": "'not-started'",
|
|
45391
|
-
"fieldName": "status"
|
|
45392
|
-
},
|
|
45393
|
-
{
|
|
45394
|
-
"name": "label",
|
|
45395
|
-
"type": {
|
|
45396
|
-
"text": "string"
|
|
45397
|
-
},
|
|
45398
|
-
"default": "''",
|
|
45399
|
-
"description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
|
|
45400
|
-
"fieldName": "label"
|
|
45401
|
-
},
|
|
45402
|
-
{
|
|
45403
|
-
"name": "help-text",
|
|
45404
|
-
"type": {
|
|
45405
|
-
"text": "string | undefined"
|
|
45406
|
-
},
|
|
45407
|
-
"description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
|
|
45408
|
-
"default": "''",
|
|
45409
|
-
"fieldName": "helpText"
|
|
45410
|
-
},
|
|
45411
|
-
{
|
|
45412
|
-
"name": "step-number",
|
|
45413
|
-
"type": {
|
|
45414
|
-
"text": "number | undefined"
|
|
45415
|
-
},
|
|
45416
|
-
"description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
|
|
45417
|
-
"default": "''",
|
|
45418
|
-
"fieldName": "stepNumber"
|
|
45419
|
-
},
|
|
45420
|
-
{
|
|
45421
|
-
"name": "tabIndex",
|
|
45422
|
-
"type": {
|
|
45423
|
-
"text": "number"
|
|
45424
|
-
},
|
|
45425
|
-
"default": "0",
|
|
45426
|
-
"description": "This property specifies the tab order of the element.",
|
|
45427
|
-
"fieldName": "tabIndex",
|
|
45428
|
-
"inheritedFrom": {
|
|
45429
|
-
"name": "TabIndexMixin",
|
|
45430
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
45431
|
-
}
|
|
45432
|
-
}
|
|
45433
|
-
],
|
|
45434
|
-
"mixins": [
|
|
45435
|
-
{
|
|
45436
|
-
"name": "TabIndexMixin",
|
|
45437
|
-
"module": "/src/utils/mixins/TabIndexMixin"
|
|
45438
|
-
}
|
|
45439
|
-
],
|
|
45440
|
-
"superclass": {
|
|
45441
|
-
"name": "Component",
|
|
45442
|
-
"module": "/src/models"
|
|
45443
|
-
},
|
|
45444
|
-
"tagName": "mdc-stepperitem",
|
|
45445
|
-
"jsDoc": "/**\n * stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\n * It can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\n * The component supports various visual styles and can be customized with labels, help text, and step numbers.\n *\n * This is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\n * Make sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n *\n * Additionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-stepperitem\n *\n * @event click - (React: onClick) This event is dispatched when the stepperitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the stepperitem.\n *\n * @csspart status-container - The container for the status icon or step number.\n * @csspart label-container - The container for the label and help text.\n * @csspart help-text-container - The container for the help text and error icon when applicable.\n * @csspart status-icon - The icon representing the status of the stepper item.\n * @csspart step-number - The text representing the step number.\n * @csspart label - The text representing the label of the stepper item.\n * @csspart help-text - The text providing additional information about the stepper item.\n * @csspart help-icon - The icon representing an error in the stepper item.\n *\n * @cssproperty --mdc-stepperitem-status-container-background - The background color of the status container.\n * @cssproperty --mdc-stepperitem-status-container-border-color - The border color of the status container.\n * @cssproperty --mdc-stepperitem-label-color - The color of the label text.\n * @cssproperty --mdc-stepperitem-help-text-color - The color of the optional label text.\n * @cssproperty --mdc-stepperitem-label-container-background - The background color of the label container.\n */",
|
|
45446
|
-
"customElement": true
|
|
45447
|
-
}
|
|
45448
|
-
],
|
|
45449
|
-
"exports": [
|
|
45450
|
-
{
|
|
45451
|
-
"kind": "js",
|
|
45452
|
-
"name": "default",
|
|
45453
|
-
"declaration": {
|
|
45454
|
-
"name": "StepperItem",
|
|
45455
|
-
"module": "components/stepperitem/stepperitem.component.js"
|
|
45456
|
-
}
|
|
45457
|
-
}
|
|
45458
|
-
]
|
|
45459
|
-
},
|
|
45460
45163
|
{
|
|
45461
45164
|
"kind": "javascript-module",
|
|
45462
45165
|
"path": "components/tab/tab.component.js",
|
|
@@ -46474,6 +46177,303 @@
|
|
|
46474
46177
|
}
|
|
46475
46178
|
]
|
|
46476
46179
|
},
|
|
46180
|
+
{
|
|
46181
|
+
"kind": "javascript-module",
|
|
46182
|
+
"path": "components/stepperitem/stepperitem.component.js",
|
|
46183
|
+
"declarations": [
|
|
46184
|
+
{
|
|
46185
|
+
"kind": "class",
|
|
46186
|
+
"description": "stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\nIt can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\nThe component supports various visual styles and can be customized with labels, help text, and step numbers.\n\nThis is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\nMake sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n\nAdditionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.",
|
|
46187
|
+
"name": "StepperItem",
|
|
46188
|
+
"cssProperties": [
|
|
46189
|
+
{
|
|
46190
|
+
"description": "The background color of the status container.",
|
|
46191
|
+
"name": "--mdc-stepperitem-status-container-background"
|
|
46192
|
+
},
|
|
46193
|
+
{
|
|
46194
|
+
"description": "The border color of the status container.",
|
|
46195
|
+
"name": "--mdc-stepperitem-status-container-border-color"
|
|
46196
|
+
},
|
|
46197
|
+
{
|
|
46198
|
+
"description": "The color of the label text.",
|
|
46199
|
+
"name": "--mdc-stepperitem-label-color"
|
|
46200
|
+
},
|
|
46201
|
+
{
|
|
46202
|
+
"description": "The color of the optional label text.",
|
|
46203
|
+
"name": "--mdc-stepperitem-help-text-color"
|
|
46204
|
+
},
|
|
46205
|
+
{
|
|
46206
|
+
"description": "The background color of the label container.",
|
|
46207
|
+
"name": "--mdc-stepperitem-label-container-background"
|
|
46208
|
+
}
|
|
46209
|
+
],
|
|
46210
|
+
"cssParts": [
|
|
46211
|
+
{
|
|
46212
|
+
"description": "The container for the status icon or step number.",
|
|
46213
|
+
"name": "status-container"
|
|
46214
|
+
},
|
|
46215
|
+
{
|
|
46216
|
+
"description": "The container for the label and help text.",
|
|
46217
|
+
"name": "label-container"
|
|
46218
|
+
},
|
|
46219
|
+
{
|
|
46220
|
+
"description": "The container for the help text and error icon when applicable.",
|
|
46221
|
+
"name": "help-text-container"
|
|
46222
|
+
},
|
|
46223
|
+
{
|
|
46224
|
+
"description": "The icon representing the status of the stepper item.",
|
|
46225
|
+
"name": "status-icon"
|
|
46226
|
+
},
|
|
46227
|
+
{
|
|
46228
|
+
"description": "The text representing the step number.",
|
|
46229
|
+
"name": "step-number"
|
|
46230
|
+
},
|
|
46231
|
+
{
|
|
46232
|
+
"description": "The text representing the label of the stepper item.",
|
|
46233
|
+
"name": "label"
|
|
46234
|
+
},
|
|
46235
|
+
{
|
|
46236
|
+
"description": "The text providing additional information about the stepper item.",
|
|
46237
|
+
"name": "help-text"
|
|
46238
|
+
},
|
|
46239
|
+
{
|
|
46240
|
+
"description": "The icon representing an error in the stepper item.",
|
|
46241
|
+
"name": "help-icon"
|
|
46242
|
+
}
|
|
46243
|
+
],
|
|
46244
|
+
"members": [
|
|
46245
|
+
{
|
|
46246
|
+
"kind": "field",
|
|
46247
|
+
"name": "variant",
|
|
46248
|
+
"type": {
|
|
46249
|
+
"text": "VariantType"
|
|
46250
|
+
},
|
|
46251
|
+
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
46252
|
+
"default": "'inline'",
|
|
46253
|
+
"attribute": "variant",
|
|
46254
|
+
"reflects": true
|
|
46255
|
+
},
|
|
46256
|
+
{
|
|
46257
|
+
"kind": "field",
|
|
46258
|
+
"name": "status",
|
|
46259
|
+
"type": {
|
|
46260
|
+
"text": "StatusType"
|
|
46261
|
+
},
|
|
46262
|
+
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
46263
|
+
"default": "'not-started'",
|
|
46264
|
+
"attribute": "status",
|
|
46265
|
+
"reflects": true
|
|
46266
|
+
},
|
|
46267
|
+
{
|
|
46268
|
+
"kind": "field",
|
|
46269
|
+
"name": "label",
|
|
46270
|
+
"type": {
|
|
46271
|
+
"text": "string"
|
|
46272
|
+
},
|
|
46273
|
+
"default": "''",
|
|
46274
|
+
"description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
|
|
46275
|
+
"attribute": "label",
|
|
46276
|
+
"reflects": true
|
|
46277
|
+
},
|
|
46278
|
+
{
|
|
46279
|
+
"kind": "field",
|
|
46280
|
+
"name": "helpText",
|
|
46281
|
+
"type": {
|
|
46282
|
+
"text": "string | undefined"
|
|
46283
|
+
},
|
|
46284
|
+
"description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
|
|
46285
|
+
"default": "''",
|
|
46286
|
+
"attribute": "help-text",
|
|
46287
|
+
"reflects": true
|
|
46288
|
+
},
|
|
46289
|
+
{
|
|
46290
|
+
"kind": "field",
|
|
46291
|
+
"name": "stepNumber",
|
|
46292
|
+
"type": {
|
|
46293
|
+
"text": "number | undefined"
|
|
46294
|
+
},
|
|
46295
|
+
"description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
|
|
46296
|
+
"default": "''",
|
|
46297
|
+
"attribute": "step-number",
|
|
46298
|
+
"reflects": true
|
|
46299
|
+
},
|
|
46300
|
+
{
|
|
46301
|
+
"kind": "method",
|
|
46302
|
+
"name": "handleKeyDown",
|
|
46303
|
+
"privacy": "private",
|
|
46304
|
+
"parameters": [
|
|
46305
|
+
{
|
|
46306
|
+
"name": "event",
|
|
46307
|
+
"type": {
|
|
46308
|
+
"text": "KeyboardEvent"
|
|
46309
|
+
},
|
|
46310
|
+
"description": "The keyboard event."
|
|
46311
|
+
}
|
|
46312
|
+
],
|
|
46313
|
+
"description": "Handles the keydown event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is pressed.\nIf the key is 'Enter', the stepperitem is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the stepperitem's default is prevent to avoid scrolling etc in the host application."
|
|
46314
|
+
},
|
|
46315
|
+
{
|
|
46316
|
+
"kind": "method",
|
|
46317
|
+
"name": "triggerClickEvent",
|
|
46318
|
+
"privacy": "private",
|
|
46319
|
+
"description": "Triggers a click event on the stepper item."
|
|
46320
|
+
},
|
|
46321
|
+
{
|
|
46322
|
+
"kind": "method",
|
|
46323
|
+
"name": "handleKeyUp",
|
|
46324
|
+
"privacy": "private",
|
|
46325
|
+
"parameters": [
|
|
46326
|
+
{
|
|
46327
|
+
"name": "event",
|
|
46328
|
+
"type": {
|
|
46329
|
+
"text": "KeyboardEvent"
|
|
46330
|
+
},
|
|
46331
|
+
"description": "The keyboard event."
|
|
46332
|
+
}
|
|
46333
|
+
],
|
|
46334
|
+
"description": "Handles the keyup event on the stepperitem.\nIf the key is 'Enter' or 'Space', the stepperitem is clicked.\nIf the key is 'Space', the stepperitem is pressed. The native HTML button works in the same way."
|
|
46335
|
+
},
|
|
46336
|
+
{
|
|
46337
|
+
"kind": "method",
|
|
46338
|
+
"name": "renderStatusIcon",
|
|
46339
|
+
"privacy": "private",
|
|
46340
|
+
"description": "Renders the status icon based on the current status of the stepper item.\n- If the status is `completed`, it renders a check icon.\n- If the status is `current` or `error-current`, it renders a pencil icon.\n- If the status is `not-started` or `error-incomplete`, it renders the step number.\n- If the status is anything else, it renders nothing.",
|
|
46341
|
+
"return": {
|
|
46342
|
+
"type": {
|
|
46343
|
+
"text": ""
|
|
46344
|
+
}
|
|
46345
|
+
}
|
|
46346
|
+
},
|
|
46347
|
+
{
|
|
46348
|
+
"kind": "method",
|
|
46349
|
+
"name": "renderHelpText",
|
|
46350
|
+
"privacy": "private",
|
|
46351
|
+
"description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
|
|
46352
|
+
"return": {
|
|
46353
|
+
"type": {
|
|
46354
|
+
"text": ""
|
|
46355
|
+
}
|
|
46356
|
+
}
|
|
46357
|
+
},
|
|
46358
|
+
{
|
|
46359
|
+
"kind": "field",
|
|
46360
|
+
"name": "tabIndex",
|
|
46361
|
+
"type": {
|
|
46362
|
+
"text": "number"
|
|
46363
|
+
},
|
|
46364
|
+
"default": "0",
|
|
46365
|
+
"description": "This property specifies the tab order of the element.",
|
|
46366
|
+
"attribute": "tabIndex",
|
|
46367
|
+
"reflects": true,
|
|
46368
|
+
"inheritedFrom": {
|
|
46369
|
+
"name": "TabIndexMixin",
|
|
46370
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
46371
|
+
}
|
|
46372
|
+
}
|
|
46373
|
+
],
|
|
46374
|
+
"events": [
|
|
46375
|
+
{
|
|
46376
|
+
"description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
|
|
46377
|
+
"name": "click",
|
|
46378
|
+
"reactName": "onClick"
|
|
46379
|
+
},
|
|
46380
|
+
{
|
|
46381
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
|
|
46382
|
+
"name": "keydown",
|
|
46383
|
+
"reactName": "onKeyDown"
|
|
46384
|
+
},
|
|
46385
|
+
{
|
|
46386
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
|
|
46387
|
+
"name": "keyup",
|
|
46388
|
+
"reactName": "onKeyUp"
|
|
46389
|
+
}
|
|
46390
|
+
],
|
|
46391
|
+
"attributes": [
|
|
46392
|
+
{
|
|
46393
|
+
"name": "variant",
|
|
46394
|
+
"type": {
|
|
46395
|
+
"text": "VariantType"
|
|
46396
|
+
},
|
|
46397
|
+
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
46398
|
+
"default": "'inline'",
|
|
46399
|
+
"fieldName": "variant"
|
|
46400
|
+
},
|
|
46401
|
+
{
|
|
46402
|
+
"name": "status",
|
|
46403
|
+
"type": {
|
|
46404
|
+
"text": "StatusType"
|
|
46405
|
+
},
|
|
46406
|
+
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
46407
|
+
"default": "'not-started'",
|
|
46408
|
+
"fieldName": "status"
|
|
46409
|
+
},
|
|
46410
|
+
{
|
|
46411
|
+
"name": "label",
|
|
46412
|
+
"type": {
|
|
46413
|
+
"text": "string"
|
|
46414
|
+
},
|
|
46415
|
+
"default": "''",
|
|
46416
|
+
"description": "The label for the stepper item, which is displayed as the main text of the step.\nThis label is typically used to describe the step or action that the step represents.",
|
|
46417
|
+
"fieldName": "label"
|
|
46418
|
+
},
|
|
46419
|
+
{
|
|
46420
|
+
"name": "help-text",
|
|
46421
|
+
"type": {
|
|
46422
|
+
"text": "string | undefined"
|
|
46423
|
+
},
|
|
46424
|
+
"description": "Additional informational text that appears below the label\nThis text is optional and can be used to provide more context or instructions for the step.",
|
|
46425
|
+
"default": "''",
|
|
46426
|
+
"fieldName": "helpText"
|
|
46427
|
+
},
|
|
46428
|
+
{
|
|
46429
|
+
"name": "step-number",
|
|
46430
|
+
"type": {
|
|
46431
|
+
"text": "number | undefined"
|
|
46432
|
+
},
|
|
46433
|
+
"description": "The step number for the stepper item, which is displayed as a numeric indicator of the step's position in the sequence.\nThis is useful for indicating the order of steps in a process.",
|
|
46434
|
+
"default": "''",
|
|
46435
|
+
"fieldName": "stepNumber"
|
|
46436
|
+
},
|
|
46437
|
+
{
|
|
46438
|
+
"name": "tabIndex",
|
|
46439
|
+
"type": {
|
|
46440
|
+
"text": "number"
|
|
46441
|
+
},
|
|
46442
|
+
"default": "0",
|
|
46443
|
+
"description": "This property specifies the tab order of the element.",
|
|
46444
|
+
"fieldName": "tabIndex",
|
|
46445
|
+
"inheritedFrom": {
|
|
46446
|
+
"name": "TabIndexMixin",
|
|
46447
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
46448
|
+
}
|
|
46449
|
+
}
|
|
46450
|
+
],
|
|
46451
|
+
"mixins": [
|
|
46452
|
+
{
|
|
46453
|
+
"name": "TabIndexMixin",
|
|
46454
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
|
46455
|
+
}
|
|
46456
|
+
],
|
|
46457
|
+
"superclass": {
|
|
46458
|
+
"name": "Component",
|
|
46459
|
+
"module": "/src/models"
|
|
46460
|
+
},
|
|
46461
|
+
"tagName": "mdc-stepperitem",
|
|
46462
|
+
"jsDoc": "/**\n * stepperitem component is used to represent a single step in a stepper component. It is used within a `mdc-stepper` component to indicate the current step in a process.\n * It can have different statuses such as `completed`, `current`, `incomplete`, `error-current`, and `error-incomplete`.\n * The component supports various visual styles and can be customized with labels, help text, and step numbers.\n *\n * This is an uncontrolled component, meaning it does not manage its own state. Instead, it relies on the consumer's to manage the state of each step.\n * Make sure to set `aria-current=\"step\"` on the current stepper item. It is applicable only when status is `current` or `error-current`. This ensures accessibility for the stepper component. Only one stepper item should have this attribute at a time.\n *\n * Additionally, make use of `aria-label` to provide a descriptive detail about the stepper item, especially for screen readers. If this aria-label is not set, it would read out only the label text and doesn't provide enough context for the user.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-stepperitem\n *\n * @event click - (React: onClick) This event is dispatched when the stepperitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the stepperitem.\n *\n * @csspart status-container - The container for the status icon or step number.\n * @csspart label-container - The container for the label and help text.\n * @csspart help-text-container - The container for the help text and error icon when applicable.\n * @csspart status-icon - The icon representing the status of the stepper item.\n * @csspart step-number - The text representing the step number.\n * @csspart label - The text representing the label of the stepper item.\n * @csspart help-text - The text providing additional information about the stepper item.\n * @csspart help-icon - The icon representing an error in the stepper item.\n *\n * @cssproperty --mdc-stepperitem-status-container-background - The background color of the status container.\n * @cssproperty --mdc-stepperitem-status-container-border-color - The border color of the status container.\n * @cssproperty --mdc-stepperitem-label-color - The color of the label text.\n * @cssproperty --mdc-stepperitem-help-text-color - The color of the optional label text.\n * @cssproperty --mdc-stepperitem-label-container-background - The background color of the label container.\n */",
|
|
46463
|
+
"customElement": true
|
|
46464
|
+
}
|
|
46465
|
+
],
|
|
46466
|
+
"exports": [
|
|
46467
|
+
{
|
|
46468
|
+
"kind": "js",
|
|
46469
|
+
"name": "default",
|
|
46470
|
+
"declaration": {
|
|
46471
|
+
"name": "StepperItem",
|
|
46472
|
+
"module": "components/stepperitem/stepperitem.component.js"
|
|
46473
|
+
}
|
|
46474
|
+
}
|
|
46475
|
+
]
|
|
46476
|
+
},
|
|
46477
46477
|
{
|
|
46478
46478
|
"kind": "javascript-module",
|
|
46479
46479
|
"path": "components/text/text.component.js",
|