@momentum-design/components 0.121.4 → 0.121.6
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 +103 -99
- package/dist/browser/index.js.map +3 -3
- package/dist/components/accordion/accordion.component.d.ts +8 -0
- package/dist/components/accordion/accordion.component.js +10 -2
- package/dist/components/input/input.styles.js +8 -4
- package/dist/components/password/password.component.js +2 -2
- package/dist/components/textarea/textarea.types.d.ts +11 -6
- package/dist/custom-elements.json +685 -647
- package/dist/index.d.ts +2 -1
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
|
@@ -117,6 +117,26 @@
|
|
|
117
117
|
}
|
|
118
118
|
],
|
|
119
119
|
"members": [
|
|
120
|
+
{
|
|
121
|
+
"kind": "field",
|
|
122
|
+
"name": "openButtonAriaLabel",
|
|
123
|
+
"type": {
|
|
124
|
+
"text": "string | undefined"
|
|
125
|
+
},
|
|
126
|
+
"description": "Aria-label attribute for the trigger button when accordion is collapsed.",
|
|
127
|
+
"attribute": "open-button-aria-label",
|
|
128
|
+
"reflects": true
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"kind": "field",
|
|
132
|
+
"name": "closeButtonAriaLabel",
|
|
133
|
+
"type": {
|
|
134
|
+
"text": "string | undefined"
|
|
135
|
+
},
|
|
136
|
+
"description": "Aria-label attribute for the trigger button when accordion is expanded.",
|
|
137
|
+
"attribute": "close-button-aria-label",
|
|
138
|
+
"reflects": true
|
|
139
|
+
},
|
|
120
140
|
{
|
|
121
141
|
"kind": "method",
|
|
122
142
|
"name": "renderHeader",
|
|
@@ -366,14 +386,23 @@
|
|
|
366
386
|
}
|
|
367
387
|
}
|
|
368
388
|
],
|
|
369
|
-
"superclass": {
|
|
370
|
-
"name": "AccordionButton",
|
|
371
|
-
"module": "/src/components/accordionbutton/accordionbutton.component"
|
|
372
|
-
},
|
|
373
|
-
"tagName": "mdc-accordion",
|
|
374
|
-
"jsDoc": "/**\n * An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n * - Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n * - Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.\n *\n * @tagname mdc-accordion\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot leading-controls - The leading controls slot of the accordion on the header section.\n * @slot trailing-controls - The trailing controls slot of the accordion on the header section.\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion.\n *\n * @csspart body-section - The body section of the accordion.\n * @csspart header-section - The header section of the accordion.\n * @csspart leading-header - The leading header of the accordion.\n * @csspart trailing-header - The trailing header of the accordion.\n * @csspart trailing-header__button - The trailing header button of the accordion.\n */",
|
|
375
|
-
"customElement": true,
|
|
376
389
|
"attributes": [
|
|
390
|
+
{
|
|
391
|
+
"name": "open-button-aria-label",
|
|
392
|
+
"type": {
|
|
393
|
+
"text": "string | undefined"
|
|
394
|
+
},
|
|
395
|
+
"description": "Aria-label attribute for the trigger button when accordion is collapsed.",
|
|
396
|
+
"fieldName": "openButtonAriaLabel"
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "close-button-aria-label",
|
|
400
|
+
"type": {
|
|
401
|
+
"text": "string | undefined"
|
|
402
|
+
},
|
|
403
|
+
"description": "Aria-label attribute for the trigger button when accordion is expanded.",
|
|
404
|
+
"fieldName": "closeButtonAriaLabel"
|
|
405
|
+
},
|
|
377
406
|
{
|
|
378
407
|
"name": "disabled",
|
|
379
408
|
"type": {
|
|
@@ -463,7 +492,14 @@
|
|
|
463
492
|
"module": "src/components/accordionbutton/accordionbutton.component.ts"
|
|
464
493
|
}
|
|
465
494
|
}
|
|
466
|
-
]
|
|
495
|
+
],
|
|
496
|
+
"superclass": {
|
|
497
|
+
"name": "AccordionButton",
|
|
498
|
+
"module": "/src/components/accordionbutton/accordionbutton.component"
|
|
499
|
+
},
|
|
500
|
+
"tagName": "mdc-accordion",
|
|
501
|
+
"jsDoc": "/**\n * An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n * - Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n * - Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.\n *\n * @tagname mdc-accordion\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot leading-controls - The leading controls slot of the accordion on the header section.\n * @slot trailing-controls - The trailing controls slot of the accordion on the header section.\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion.\n *\n * @csspart body-section - The body section of the accordion.\n * @csspart header-section - The header section of the accordion.\n * @csspart leading-header - The leading header of the accordion.\n * @csspart trailing-header - The trailing header of the accordion.\n * @csspart trailing-header__button - The trailing header button of the accordion.\n */",
|
|
502
|
+
"customElement": true
|
|
467
503
|
}
|
|
468
504
|
],
|
|
469
505
|
"exports": [
|
|
@@ -477,6 +513,346 @@
|
|
|
477
513
|
}
|
|
478
514
|
]
|
|
479
515
|
},
|
|
516
|
+
{
|
|
517
|
+
"kind": "javascript-module",
|
|
518
|
+
"path": "components/accordionbutton/accordionbutton.component.js",
|
|
519
|
+
"declarations": [
|
|
520
|
+
{
|
|
521
|
+
"kind": "class",
|
|
522
|
+
"description": "An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n\nIf an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.",
|
|
523
|
+
"name": "AccordionButton",
|
|
524
|
+
"cssProperties": [
|
|
525
|
+
{
|
|
526
|
+
"description": "The border color of the accordion button.",
|
|
527
|
+
"name": "--mdc-accordionbutton-border-color"
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"description": "The hover color of the accordion button.",
|
|
531
|
+
"name": "--mdc-accordionbutton-hover-color"
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
"description": "The active color of the accordion button.",
|
|
535
|
+
"name": "--mdc-accordionbutton-active-color"
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"description": "The disabled color of the accordion button.",
|
|
539
|
+
"name": "--mdc-accordionbutton-disabled-color"
|
|
540
|
+
}
|
|
541
|
+
],
|
|
542
|
+
"cssParts": [
|
|
543
|
+
{
|
|
544
|
+
"description": "The body section of the accordion button.",
|
|
545
|
+
"name": "body-section"
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"description": "The header button section of the accordion button.",
|
|
549
|
+
"name": "header-button-section"
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"description": "The header section of the accordion button.",
|
|
553
|
+
"name": "header-section"
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"description": "The leading header of the accordion button.",
|
|
557
|
+
"name": "leading-header"
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"description": "The trailing header of the accordion button.",
|
|
561
|
+
"name": "trailing-header"
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"description": "The trailing header icon of the accordion button.",
|
|
565
|
+
"name": "trailing-header__icon"
|
|
566
|
+
}
|
|
567
|
+
],
|
|
568
|
+
"slots": [
|
|
569
|
+
{
|
|
570
|
+
"description": "The default slot contains the body section of the accordion. User can place anything inside this body slot.",
|
|
571
|
+
"name": "default"
|
|
572
|
+
}
|
|
573
|
+
],
|
|
574
|
+
"members": [
|
|
575
|
+
{
|
|
576
|
+
"kind": "field",
|
|
577
|
+
"name": "size",
|
|
578
|
+
"type": {
|
|
579
|
+
"text": "Size"
|
|
580
|
+
},
|
|
581
|
+
"description": "The size of the accordion item.",
|
|
582
|
+
"default": "'small'",
|
|
583
|
+
"attribute": "size",
|
|
584
|
+
"reflects": true
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"kind": "field",
|
|
588
|
+
"name": "variant",
|
|
589
|
+
"type": {
|
|
590
|
+
"text": "Variant"
|
|
591
|
+
},
|
|
592
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
593
|
+
"default": "'default'",
|
|
594
|
+
"attribute": "variant",
|
|
595
|
+
"reflects": true
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"kind": "field",
|
|
599
|
+
"name": "dataAriaLevel",
|
|
600
|
+
"type": {
|
|
601
|
+
"text": "number"
|
|
602
|
+
},
|
|
603
|
+
"description": "The aria level of the accordion component.",
|
|
604
|
+
"default": "3",
|
|
605
|
+
"attribute": "data-aria-level",
|
|
606
|
+
"reflects": true
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
"kind": "field",
|
|
610
|
+
"name": "expanded",
|
|
611
|
+
"type": {
|
|
612
|
+
"text": "boolean"
|
|
613
|
+
},
|
|
614
|
+
"description": "The visibility of the accordion button.",
|
|
615
|
+
"default": "false",
|
|
616
|
+
"attribute": "expanded",
|
|
617
|
+
"reflects": true
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"kind": "field",
|
|
621
|
+
"name": "headerText",
|
|
622
|
+
"type": {
|
|
623
|
+
"text": "string | undefined"
|
|
624
|
+
},
|
|
625
|
+
"description": "The header text of the accordion item.",
|
|
626
|
+
"attribute": "header-text",
|
|
627
|
+
"reflects": true
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"kind": "field",
|
|
631
|
+
"name": "prefixIcon",
|
|
632
|
+
"type": {
|
|
633
|
+
"text": "IconNames | undefined"
|
|
634
|
+
},
|
|
635
|
+
"description": "The leading icon that is displayed before the header text.",
|
|
636
|
+
"attribute": "prefix-icon"
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"kind": "method",
|
|
640
|
+
"name": "handleHeaderClick",
|
|
641
|
+
"privacy": "protected",
|
|
642
|
+
"return": {
|
|
643
|
+
"type": {
|
|
644
|
+
"text": "void"
|
|
645
|
+
}
|
|
646
|
+
},
|
|
647
|
+
"description": "Handles the click event of the header section.\nIf the accordion is disabled, it will not toggle the expanded state.\nIt will dispatch the `shown` event with the current expanded state."
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
"kind": "method",
|
|
651
|
+
"name": "dispatchHeaderClickEvent",
|
|
652
|
+
"privacy": "private",
|
|
653
|
+
"return": {
|
|
654
|
+
"type": {
|
|
655
|
+
"text": "void"
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
"description": "Dispatches the `shown` event with the current expanded state.\nThe event is cancelable and bubbles.\nThe event detail contains the current expanded state."
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
"kind": "method",
|
|
662
|
+
"name": "handleKeyDown",
|
|
663
|
+
"privacy": "private",
|
|
664
|
+
"return": {
|
|
665
|
+
"type": {
|
|
666
|
+
"text": "void"
|
|
667
|
+
}
|
|
668
|
+
},
|
|
669
|
+
"parameters": [
|
|
670
|
+
{
|
|
671
|
+
"name": "event",
|
|
672
|
+
"type": {
|
|
673
|
+
"text": "KeyboardEvent"
|
|
674
|
+
},
|
|
675
|
+
"description": "The KeyboardEvent fired."
|
|
676
|
+
}
|
|
677
|
+
],
|
|
678
|
+
"description": "Handles the keydown event of the component.\nIf the key pressed is either Enter or Space, it calls the handleHeaderClick method.\nThis allows keyboard users to toggle the accordion button using these keys."
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"kind": "method",
|
|
682
|
+
"name": "renderIcon",
|
|
683
|
+
"privacy": "protected",
|
|
684
|
+
"return": {
|
|
685
|
+
"type": {
|
|
686
|
+
"text": "TemplateResult | typeof nothing"
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
"parameters": [
|
|
690
|
+
{
|
|
691
|
+
"name": "iconName",
|
|
692
|
+
"optional": true,
|
|
693
|
+
"type": {
|
|
694
|
+
"text": "IconNames"
|
|
695
|
+
}
|
|
696
|
+
}
|
|
697
|
+
]
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
"kind": "method",
|
|
701
|
+
"name": "renderHeadingText",
|
|
702
|
+
"privacy": "protected",
|
|
703
|
+
"return": {
|
|
704
|
+
"type": {
|
|
705
|
+
"text": "TemplateResult | typeof nothing"
|
|
706
|
+
}
|
|
707
|
+
}
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"kind": "method",
|
|
711
|
+
"name": "renderHeader",
|
|
712
|
+
"privacy": "protected",
|
|
713
|
+
"return": {
|
|
714
|
+
"type": {
|
|
715
|
+
"text": "TemplateResult"
|
|
716
|
+
}
|
|
717
|
+
}
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
"kind": "method",
|
|
721
|
+
"name": "getArrowIconName",
|
|
722
|
+
"privacy": "protected",
|
|
723
|
+
"return": {
|
|
724
|
+
"type": {
|
|
725
|
+
"text": ""
|
|
726
|
+
}
|
|
727
|
+
},
|
|
728
|
+
"description": "Returns the icon name based on the expanded state.\nIf the accordion button is disabled, it always returns the arrow down icon.\nOtherwise, it returns the arrow up icon if the accordion button is expanded, otherwise the arrow down icon."
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"kind": "method",
|
|
732
|
+
"name": "renderBody",
|
|
733
|
+
"privacy": "protected",
|
|
734
|
+
"return": {
|
|
735
|
+
"type": {
|
|
736
|
+
"text": "TemplateResult | typeof nothing"
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
"kind": "field",
|
|
742
|
+
"name": "disabled",
|
|
743
|
+
"type": {
|
|
744
|
+
"text": "boolean | undefined"
|
|
745
|
+
},
|
|
746
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
747
|
+
"default": "undefined",
|
|
748
|
+
"attribute": "disabled",
|
|
749
|
+
"reflects": true,
|
|
750
|
+
"inheritedFrom": {
|
|
751
|
+
"name": "DisabledMixin",
|
|
752
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
],
|
|
756
|
+
"events": [
|
|
757
|
+
{
|
|
758
|
+
"description": "(React: onShown) This event is triggered when the accordion button is expanded.",
|
|
759
|
+
"name": "shown",
|
|
760
|
+
"reactName": "onShown"
|
|
761
|
+
}
|
|
762
|
+
],
|
|
763
|
+
"attributes": [
|
|
764
|
+
{
|
|
765
|
+
"name": "size",
|
|
766
|
+
"type": {
|
|
767
|
+
"text": "Size"
|
|
768
|
+
},
|
|
769
|
+
"description": "The size of the accordion item.",
|
|
770
|
+
"default": "'small'",
|
|
771
|
+
"fieldName": "size"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "variant",
|
|
775
|
+
"type": {
|
|
776
|
+
"text": "Variant"
|
|
777
|
+
},
|
|
778
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
779
|
+
"default": "'default'",
|
|
780
|
+
"fieldName": "variant"
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"name": "data-aria-level",
|
|
784
|
+
"type": {
|
|
785
|
+
"text": "number"
|
|
786
|
+
},
|
|
787
|
+
"description": "The aria level of the accordion component.",
|
|
788
|
+
"default": "3",
|
|
789
|
+
"fieldName": "dataAriaLevel"
|
|
790
|
+
},
|
|
791
|
+
{
|
|
792
|
+
"name": "expanded",
|
|
793
|
+
"type": {
|
|
794
|
+
"text": "boolean"
|
|
795
|
+
},
|
|
796
|
+
"description": "The visibility of the accordion button.",
|
|
797
|
+
"default": "false",
|
|
798
|
+
"fieldName": "expanded"
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "header-text",
|
|
802
|
+
"type": {
|
|
803
|
+
"text": "string | undefined"
|
|
804
|
+
},
|
|
805
|
+
"description": "The header text of the accordion item.",
|
|
806
|
+
"fieldName": "headerText"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "prefix-icon",
|
|
810
|
+
"type": {
|
|
811
|
+
"text": "IconNames | undefined"
|
|
812
|
+
},
|
|
813
|
+
"description": "The leading icon that is displayed before the header text.",
|
|
814
|
+
"fieldName": "prefixIcon"
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
"name": "disabled",
|
|
818
|
+
"type": {
|
|
819
|
+
"text": "boolean | undefined"
|
|
820
|
+
},
|
|
821
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
822
|
+
"default": "undefined",
|
|
823
|
+
"fieldName": "disabled",
|
|
824
|
+
"inheritedFrom": {
|
|
825
|
+
"name": "DisabledMixin",
|
|
826
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
827
|
+
}
|
|
828
|
+
}
|
|
829
|
+
],
|
|
830
|
+
"mixins": [
|
|
831
|
+
{
|
|
832
|
+
"name": "DisabledMixin",
|
|
833
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
|
834
|
+
}
|
|
835
|
+
],
|
|
836
|
+
"superclass": {
|
|
837
|
+
"name": "Component",
|
|
838
|
+
"module": "/src/models"
|
|
839
|
+
},
|
|
840
|
+
"tagName": "mdc-accordionbutton",
|
|
841
|
+
"jsDoc": "/**\n * An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n *\n * If an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.\n *\n * @tagname mdc-accordionbutton\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion button is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion button.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion button.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion button.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion button.\n *\n * @csspart body-section - The body section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart header-section - The header section of the accordion button.\n * @csspart leading-header - The leading header of the accordion button.\n * @csspart trailing-header - The trailing header of the accordion button.\n * @csspart trailing-header__icon - The trailing header icon of the accordion button.\n */",
|
|
842
|
+
"customElement": true
|
|
843
|
+
}
|
|
844
|
+
],
|
|
845
|
+
"exports": [
|
|
846
|
+
{
|
|
847
|
+
"kind": "js",
|
|
848
|
+
"name": "default",
|
|
849
|
+
"declaration": {
|
|
850
|
+
"name": "AccordionButton",
|
|
851
|
+
"module": "components/accordionbutton/accordionbutton.component.js"
|
|
852
|
+
}
|
|
853
|
+
}
|
|
854
|
+
]
|
|
855
|
+
},
|
|
480
856
|
{
|
|
481
857
|
"kind": "javascript-module",
|
|
482
858
|
"path": "components/accordiongroup/accordiongroup.component.js",
|
|
@@ -1246,346 +1622,6 @@
|
|
|
1246
1622
|
}
|
|
1247
1623
|
]
|
|
1248
1624
|
},
|
|
1249
|
-
{
|
|
1250
|
-
"kind": "javascript-module",
|
|
1251
|
-
"path": "components/accordionbutton/accordionbutton.component.js",
|
|
1252
|
-
"declarations": [
|
|
1253
|
-
{
|
|
1254
|
-
"kind": "class",
|
|
1255
|
-
"description": "An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n\nIf an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.",
|
|
1256
|
-
"name": "AccordionButton",
|
|
1257
|
-
"cssProperties": [
|
|
1258
|
-
{
|
|
1259
|
-
"description": "The border color of the accordion button.",
|
|
1260
|
-
"name": "--mdc-accordionbutton-border-color"
|
|
1261
|
-
},
|
|
1262
|
-
{
|
|
1263
|
-
"description": "The hover color of the accordion button.",
|
|
1264
|
-
"name": "--mdc-accordionbutton-hover-color"
|
|
1265
|
-
},
|
|
1266
|
-
{
|
|
1267
|
-
"description": "The active color of the accordion button.",
|
|
1268
|
-
"name": "--mdc-accordionbutton-active-color"
|
|
1269
|
-
},
|
|
1270
|
-
{
|
|
1271
|
-
"description": "The disabled color of the accordion button.",
|
|
1272
|
-
"name": "--mdc-accordionbutton-disabled-color"
|
|
1273
|
-
}
|
|
1274
|
-
],
|
|
1275
|
-
"cssParts": [
|
|
1276
|
-
{
|
|
1277
|
-
"description": "The body section of the accordion button.",
|
|
1278
|
-
"name": "body-section"
|
|
1279
|
-
},
|
|
1280
|
-
{
|
|
1281
|
-
"description": "The header button section of the accordion button.",
|
|
1282
|
-
"name": "header-button-section"
|
|
1283
|
-
},
|
|
1284
|
-
{
|
|
1285
|
-
"description": "The header section of the accordion button.",
|
|
1286
|
-
"name": "header-section"
|
|
1287
|
-
},
|
|
1288
|
-
{
|
|
1289
|
-
"description": "The leading header of the accordion button.",
|
|
1290
|
-
"name": "leading-header"
|
|
1291
|
-
},
|
|
1292
|
-
{
|
|
1293
|
-
"description": "The trailing header of the accordion button.",
|
|
1294
|
-
"name": "trailing-header"
|
|
1295
|
-
},
|
|
1296
|
-
{
|
|
1297
|
-
"description": "The trailing header icon of the accordion button.",
|
|
1298
|
-
"name": "trailing-header__icon"
|
|
1299
|
-
}
|
|
1300
|
-
],
|
|
1301
|
-
"slots": [
|
|
1302
|
-
{
|
|
1303
|
-
"description": "The default slot contains the body section of the accordion. User can place anything inside this body slot.",
|
|
1304
|
-
"name": "default"
|
|
1305
|
-
}
|
|
1306
|
-
],
|
|
1307
|
-
"members": [
|
|
1308
|
-
{
|
|
1309
|
-
"kind": "field",
|
|
1310
|
-
"name": "size",
|
|
1311
|
-
"type": {
|
|
1312
|
-
"text": "Size"
|
|
1313
|
-
},
|
|
1314
|
-
"description": "The size of the accordion item.",
|
|
1315
|
-
"default": "'small'",
|
|
1316
|
-
"attribute": "size",
|
|
1317
|
-
"reflects": true
|
|
1318
|
-
},
|
|
1319
|
-
{
|
|
1320
|
-
"kind": "field",
|
|
1321
|
-
"name": "variant",
|
|
1322
|
-
"type": {
|
|
1323
|
-
"text": "Variant"
|
|
1324
|
-
},
|
|
1325
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
1326
|
-
"default": "'default'",
|
|
1327
|
-
"attribute": "variant",
|
|
1328
|
-
"reflects": true
|
|
1329
|
-
},
|
|
1330
|
-
{
|
|
1331
|
-
"kind": "field",
|
|
1332
|
-
"name": "dataAriaLevel",
|
|
1333
|
-
"type": {
|
|
1334
|
-
"text": "number"
|
|
1335
|
-
},
|
|
1336
|
-
"description": "The aria level of the accordion component.",
|
|
1337
|
-
"default": "3",
|
|
1338
|
-
"attribute": "data-aria-level",
|
|
1339
|
-
"reflects": true
|
|
1340
|
-
},
|
|
1341
|
-
{
|
|
1342
|
-
"kind": "field",
|
|
1343
|
-
"name": "expanded",
|
|
1344
|
-
"type": {
|
|
1345
|
-
"text": "boolean"
|
|
1346
|
-
},
|
|
1347
|
-
"description": "The visibility of the accordion button.",
|
|
1348
|
-
"default": "false",
|
|
1349
|
-
"attribute": "expanded",
|
|
1350
|
-
"reflects": true
|
|
1351
|
-
},
|
|
1352
|
-
{
|
|
1353
|
-
"kind": "field",
|
|
1354
|
-
"name": "headerText",
|
|
1355
|
-
"type": {
|
|
1356
|
-
"text": "string | undefined"
|
|
1357
|
-
},
|
|
1358
|
-
"description": "The header text of the accordion item.",
|
|
1359
|
-
"attribute": "header-text",
|
|
1360
|
-
"reflects": true
|
|
1361
|
-
},
|
|
1362
|
-
{
|
|
1363
|
-
"kind": "field",
|
|
1364
|
-
"name": "prefixIcon",
|
|
1365
|
-
"type": {
|
|
1366
|
-
"text": "IconNames | undefined"
|
|
1367
|
-
},
|
|
1368
|
-
"description": "The leading icon that is displayed before the header text.",
|
|
1369
|
-
"attribute": "prefix-icon"
|
|
1370
|
-
},
|
|
1371
|
-
{
|
|
1372
|
-
"kind": "method",
|
|
1373
|
-
"name": "handleHeaderClick",
|
|
1374
|
-
"privacy": "protected",
|
|
1375
|
-
"return": {
|
|
1376
|
-
"type": {
|
|
1377
|
-
"text": "void"
|
|
1378
|
-
}
|
|
1379
|
-
},
|
|
1380
|
-
"description": "Handles the click event of the header section.\nIf the accordion is disabled, it will not toggle the expanded state.\nIt will dispatch the `shown` event with the current expanded state."
|
|
1381
|
-
},
|
|
1382
|
-
{
|
|
1383
|
-
"kind": "method",
|
|
1384
|
-
"name": "dispatchHeaderClickEvent",
|
|
1385
|
-
"privacy": "private",
|
|
1386
|
-
"return": {
|
|
1387
|
-
"type": {
|
|
1388
|
-
"text": "void"
|
|
1389
|
-
}
|
|
1390
|
-
},
|
|
1391
|
-
"description": "Dispatches the `shown` event with the current expanded state.\nThe event is cancelable and bubbles.\nThe event detail contains the current expanded state."
|
|
1392
|
-
},
|
|
1393
|
-
{
|
|
1394
|
-
"kind": "method",
|
|
1395
|
-
"name": "handleKeyDown",
|
|
1396
|
-
"privacy": "private",
|
|
1397
|
-
"return": {
|
|
1398
|
-
"type": {
|
|
1399
|
-
"text": "void"
|
|
1400
|
-
}
|
|
1401
|
-
},
|
|
1402
|
-
"parameters": [
|
|
1403
|
-
{
|
|
1404
|
-
"name": "event",
|
|
1405
|
-
"type": {
|
|
1406
|
-
"text": "KeyboardEvent"
|
|
1407
|
-
},
|
|
1408
|
-
"description": "The KeyboardEvent fired."
|
|
1409
|
-
}
|
|
1410
|
-
],
|
|
1411
|
-
"description": "Handles the keydown event of the component.\nIf the key pressed is either Enter or Space, it calls the handleHeaderClick method.\nThis allows keyboard users to toggle the accordion button using these keys."
|
|
1412
|
-
},
|
|
1413
|
-
{
|
|
1414
|
-
"kind": "method",
|
|
1415
|
-
"name": "renderIcon",
|
|
1416
|
-
"privacy": "protected",
|
|
1417
|
-
"return": {
|
|
1418
|
-
"type": {
|
|
1419
|
-
"text": "TemplateResult | typeof nothing"
|
|
1420
|
-
}
|
|
1421
|
-
},
|
|
1422
|
-
"parameters": [
|
|
1423
|
-
{
|
|
1424
|
-
"name": "iconName",
|
|
1425
|
-
"optional": true,
|
|
1426
|
-
"type": {
|
|
1427
|
-
"text": "IconNames"
|
|
1428
|
-
}
|
|
1429
|
-
}
|
|
1430
|
-
]
|
|
1431
|
-
},
|
|
1432
|
-
{
|
|
1433
|
-
"kind": "method",
|
|
1434
|
-
"name": "renderHeadingText",
|
|
1435
|
-
"privacy": "protected",
|
|
1436
|
-
"return": {
|
|
1437
|
-
"type": {
|
|
1438
|
-
"text": "TemplateResult | typeof nothing"
|
|
1439
|
-
}
|
|
1440
|
-
}
|
|
1441
|
-
},
|
|
1442
|
-
{
|
|
1443
|
-
"kind": "method",
|
|
1444
|
-
"name": "renderHeader",
|
|
1445
|
-
"privacy": "protected",
|
|
1446
|
-
"return": {
|
|
1447
|
-
"type": {
|
|
1448
|
-
"text": "TemplateResult"
|
|
1449
|
-
}
|
|
1450
|
-
}
|
|
1451
|
-
},
|
|
1452
|
-
{
|
|
1453
|
-
"kind": "method",
|
|
1454
|
-
"name": "getArrowIconName",
|
|
1455
|
-
"privacy": "protected",
|
|
1456
|
-
"return": {
|
|
1457
|
-
"type": {
|
|
1458
|
-
"text": ""
|
|
1459
|
-
}
|
|
1460
|
-
},
|
|
1461
|
-
"description": "Returns the icon name based on the expanded state.\nIf the accordion button is disabled, it always returns the arrow down icon.\nOtherwise, it returns the arrow up icon if the accordion button is expanded, otherwise the arrow down icon."
|
|
1462
|
-
},
|
|
1463
|
-
{
|
|
1464
|
-
"kind": "method",
|
|
1465
|
-
"name": "renderBody",
|
|
1466
|
-
"privacy": "protected",
|
|
1467
|
-
"return": {
|
|
1468
|
-
"type": {
|
|
1469
|
-
"text": "TemplateResult | typeof nothing"
|
|
1470
|
-
}
|
|
1471
|
-
}
|
|
1472
|
-
},
|
|
1473
|
-
{
|
|
1474
|
-
"kind": "field",
|
|
1475
|
-
"name": "disabled",
|
|
1476
|
-
"type": {
|
|
1477
|
-
"text": "boolean | undefined"
|
|
1478
|
-
},
|
|
1479
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
1480
|
-
"default": "undefined",
|
|
1481
|
-
"attribute": "disabled",
|
|
1482
|
-
"reflects": true,
|
|
1483
|
-
"inheritedFrom": {
|
|
1484
|
-
"name": "DisabledMixin",
|
|
1485
|
-
"module": "utils/mixins/DisabledMixin.js"
|
|
1486
|
-
}
|
|
1487
|
-
}
|
|
1488
|
-
],
|
|
1489
|
-
"events": [
|
|
1490
|
-
{
|
|
1491
|
-
"description": "(React: onShown) This event is triggered when the accordion button is expanded.",
|
|
1492
|
-
"name": "shown",
|
|
1493
|
-
"reactName": "onShown"
|
|
1494
|
-
}
|
|
1495
|
-
],
|
|
1496
|
-
"attributes": [
|
|
1497
|
-
{
|
|
1498
|
-
"name": "size",
|
|
1499
|
-
"type": {
|
|
1500
|
-
"text": "Size"
|
|
1501
|
-
},
|
|
1502
|
-
"description": "The size of the accordion item.",
|
|
1503
|
-
"default": "'small'",
|
|
1504
|
-
"fieldName": "size"
|
|
1505
|
-
},
|
|
1506
|
-
{
|
|
1507
|
-
"name": "variant",
|
|
1508
|
-
"type": {
|
|
1509
|
-
"text": "Variant"
|
|
1510
|
-
},
|
|
1511
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
1512
|
-
"default": "'default'",
|
|
1513
|
-
"fieldName": "variant"
|
|
1514
|
-
},
|
|
1515
|
-
{
|
|
1516
|
-
"name": "data-aria-level",
|
|
1517
|
-
"type": {
|
|
1518
|
-
"text": "number"
|
|
1519
|
-
},
|
|
1520
|
-
"description": "The aria level of the accordion component.",
|
|
1521
|
-
"default": "3",
|
|
1522
|
-
"fieldName": "dataAriaLevel"
|
|
1523
|
-
},
|
|
1524
|
-
{
|
|
1525
|
-
"name": "expanded",
|
|
1526
|
-
"type": {
|
|
1527
|
-
"text": "boolean"
|
|
1528
|
-
},
|
|
1529
|
-
"description": "The visibility of the accordion button.",
|
|
1530
|
-
"default": "false",
|
|
1531
|
-
"fieldName": "expanded"
|
|
1532
|
-
},
|
|
1533
|
-
{
|
|
1534
|
-
"name": "header-text",
|
|
1535
|
-
"type": {
|
|
1536
|
-
"text": "string | undefined"
|
|
1537
|
-
},
|
|
1538
|
-
"description": "The header text of the accordion item.",
|
|
1539
|
-
"fieldName": "headerText"
|
|
1540
|
-
},
|
|
1541
|
-
{
|
|
1542
|
-
"name": "prefix-icon",
|
|
1543
|
-
"type": {
|
|
1544
|
-
"text": "IconNames | undefined"
|
|
1545
|
-
},
|
|
1546
|
-
"description": "The leading icon that is displayed before the header text.",
|
|
1547
|
-
"fieldName": "prefixIcon"
|
|
1548
|
-
},
|
|
1549
|
-
{
|
|
1550
|
-
"name": "disabled",
|
|
1551
|
-
"type": {
|
|
1552
|
-
"text": "boolean | undefined"
|
|
1553
|
-
},
|
|
1554
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
1555
|
-
"default": "undefined",
|
|
1556
|
-
"fieldName": "disabled",
|
|
1557
|
-
"inheritedFrom": {
|
|
1558
|
-
"name": "DisabledMixin",
|
|
1559
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
1560
|
-
}
|
|
1561
|
-
}
|
|
1562
|
-
],
|
|
1563
|
-
"mixins": [
|
|
1564
|
-
{
|
|
1565
|
-
"name": "DisabledMixin",
|
|
1566
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
|
1567
|
-
}
|
|
1568
|
-
],
|
|
1569
|
-
"superclass": {
|
|
1570
|
-
"name": "Component",
|
|
1571
|
-
"module": "/src/models"
|
|
1572
|
-
},
|
|
1573
|
-
"tagName": "mdc-accordionbutton",
|
|
1574
|
-
"jsDoc": "/**\n * An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n *\n * If an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.\n *\n * @tagname mdc-accordionbutton\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion button is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion button.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion button.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion button.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion button.\n *\n * @csspart body-section - The body section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart header-section - The header section of the accordion button.\n * @csspart leading-header - The leading header of the accordion button.\n * @csspart trailing-header - The trailing header of the accordion button.\n * @csspart trailing-header__icon - The trailing header icon of the accordion button.\n */",
|
|
1575
|
-
"customElement": true
|
|
1576
|
-
}
|
|
1577
|
-
],
|
|
1578
|
-
"exports": [
|
|
1579
|
-
{
|
|
1580
|
-
"kind": "js",
|
|
1581
|
-
"name": "default",
|
|
1582
|
-
"declaration": {
|
|
1583
|
-
"name": "AccordionButton",
|
|
1584
|
-
"module": "components/accordionbutton/accordionbutton.component.js"
|
|
1585
|
-
}
|
|
1586
|
-
}
|
|
1587
|
-
]
|
|
1588
|
-
},
|
|
1589
1625
|
{
|
|
1590
1626
|
"kind": "javascript-module",
|
|
1591
1627
|
"path": "components/animation/animation.component.js",
|
|
@@ -31597,7 +31633,8 @@
|
|
|
31597
31633
|
},
|
|
31598
31634
|
"default": "''",
|
|
31599
31635
|
"description": "Aria label for the show password icon button.",
|
|
31600
|
-
"attribute": "show-button-aria-label"
|
|
31636
|
+
"attribute": "show-button-aria-label",
|
|
31637
|
+
"reflects": true
|
|
31601
31638
|
},
|
|
31602
31639
|
{
|
|
31603
31640
|
"kind": "field",
|
|
@@ -31607,7 +31644,8 @@
|
|
|
31607
31644
|
},
|
|
31608
31645
|
"default": "''",
|
|
31609
31646
|
"description": "Aria label for the hide password icon button.",
|
|
31610
|
-
"attribute": "hide-button-aria-label"
|
|
31647
|
+
"attribute": "hide-button-aria-label",
|
|
31648
|
+
"reflects": true
|
|
31611
31649
|
},
|
|
31612
31650
|
{
|
|
31613
31651
|
"kind": "field",
|
|
@@ -42787,6 +42825,303 @@
|
|
|
42787
42825
|
}
|
|
42788
42826
|
]
|
|
42789
42827
|
},
|
|
42828
|
+
{
|
|
42829
|
+
"kind": "javascript-module",
|
|
42830
|
+
"path": "components/stepperitem/stepperitem.component.js",
|
|
42831
|
+
"declarations": [
|
|
42832
|
+
{
|
|
42833
|
+
"kind": "class",
|
|
42834
|
+
"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.",
|
|
42835
|
+
"name": "StepperItem",
|
|
42836
|
+
"cssProperties": [
|
|
42837
|
+
{
|
|
42838
|
+
"description": "The background color of the status container.",
|
|
42839
|
+
"name": "--mdc-stepperitem-status-container-background"
|
|
42840
|
+
},
|
|
42841
|
+
{
|
|
42842
|
+
"description": "The border color of the status container.",
|
|
42843
|
+
"name": "--mdc-stepperitem-status-container-border-color"
|
|
42844
|
+
},
|
|
42845
|
+
{
|
|
42846
|
+
"description": "The color of the label text.",
|
|
42847
|
+
"name": "--mdc-stepperitem-label-color"
|
|
42848
|
+
},
|
|
42849
|
+
{
|
|
42850
|
+
"description": "The color of the optional label text.",
|
|
42851
|
+
"name": "--mdc-stepperitem-help-text-color"
|
|
42852
|
+
},
|
|
42853
|
+
{
|
|
42854
|
+
"description": "The background color of the label container.",
|
|
42855
|
+
"name": "--mdc-stepperitem-label-container-background"
|
|
42856
|
+
}
|
|
42857
|
+
],
|
|
42858
|
+
"cssParts": [
|
|
42859
|
+
{
|
|
42860
|
+
"description": "The container for the status icon or step number.",
|
|
42861
|
+
"name": "status-container"
|
|
42862
|
+
},
|
|
42863
|
+
{
|
|
42864
|
+
"description": "The container for the label and help text.",
|
|
42865
|
+
"name": "label-container"
|
|
42866
|
+
},
|
|
42867
|
+
{
|
|
42868
|
+
"description": "The container for the help text and error icon when applicable.",
|
|
42869
|
+
"name": "help-text-container"
|
|
42870
|
+
},
|
|
42871
|
+
{
|
|
42872
|
+
"description": "The icon representing the status of the stepper item.",
|
|
42873
|
+
"name": "status-icon"
|
|
42874
|
+
},
|
|
42875
|
+
{
|
|
42876
|
+
"description": "The text representing the step number.",
|
|
42877
|
+
"name": "step-number"
|
|
42878
|
+
},
|
|
42879
|
+
{
|
|
42880
|
+
"description": "The text representing the label of the stepper item.",
|
|
42881
|
+
"name": "label"
|
|
42882
|
+
},
|
|
42883
|
+
{
|
|
42884
|
+
"description": "The text providing additional information about the stepper item.",
|
|
42885
|
+
"name": "help-text"
|
|
42886
|
+
},
|
|
42887
|
+
{
|
|
42888
|
+
"description": "The icon representing an error in the stepper item.",
|
|
42889
|
+
"name": "help-icon"
|
|
42890
|
+
}
|
|
42891
|
+
],
|
|
42892
|
+
"members": [
|
|
42893
|
+
{
|
|
42894
|
+
"kind": "field",
|
|
42895
|
+
"name": "variant",
|
|
42896
|
+
"type": {
|
|
42897
|
+
"text": "VariantType"
|
|
42898
|
+
},
|
|
42899
|
+
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
42900
|
+
"default": "'inline'",
|
|
42901
|
+
"attribute": "variant",
|
|
42902
|
+
"reflects": true
|
|
42903
|
+
},
|
|
42904
|
+
{
|
|
42905
|
+
"kind": "field",
|
|
42906
|
+
"name": "status",
|
|
42907
|
+
"type": {
|
|
42908
|
+
"text": "StatusType"
|
|
42909
|
+
},
|
|
42910
|
+
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
42911
|
+
"default": "'not-started'",
|
|
42912
|
+
"attribute": "status",
|
|
42913
|
+
"reflects": true
|
|
42914
|
+
},
|
|
42915
|
+
{
|
|
42916
|
+
"kind": "field",
|
|
42917
|
+
"name": "label",
|
|
42918
|
+
"type": {
|
|
42919
|
+
"text": "string"
|
|
42920
|
+
},
|
|
42921
|
+
"default": "''",
|
|
42922
|
+
"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.",
|
|
42923
|
+
"attribute": "label",
|
|
42924
|
+
"reflects": true
|
|
42925
|
+
},
|
|
42926
|
+
{
|
|
42927
|
+
"kind": "field",
|
|
42928
|
+
"name": "helpText",
|
|
42929
|
+
"type": {
|
|
42930
|
+
"text": "string | undefined"
|
|
42931
|
+
},
|
|
42932
|
+
"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.",
|
|
42933
|
+
"default": "''",
|
|
42934
|
+
"attribute": "help-text",
|
|
42935
|
+
"reflects": true
|
|
42936
|
+
},
|
|
42937
|
+
{
|
|
42938
|
+
"kind": "field",
|
|
42939
|
+
"name": "stepNumber",
|
|
42940
|
+
"type": {
|
|
42941
|
+
"text": "number | undefined"
|
|
42942
|
+
},
|
|
42943
|
+
"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.",
|
|
42944
|
+
"default": "''",
|
|
42945
|
+
"attribute": "step-number",
|
|
42946
|
+
"reflects": true
|
|
42947
|
+
},
|
|
42948
|
+
{
|
|
42949
|
+
"kind": "method",
|
|
42950
|
+
"name": "handleKeyDown",
|
|
42951
|
+
"privacy": "private",
|
|
42952
|
+
"parameters": [
|
|
42953
|
+
{
|
|
42954
|
+
"name": "event",
|
|
42955
|
+
"type": {
|
|
42956
|
+
"text": "KeyboardEvent"
|
|
42957
|
+
},
|
|
42958
|
+
"description": "The keyboard event."
|
|
42959
|
+
}
|
|
42960
|
+
],
|
|
42961
|
+
"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."
|
|
42962
|
+
},
|
|
42963
|
+
{
|
|
42964
|
+
"kind": "method",
|
|
42965
|
+
"name": "triggerClickEvent",
|
|
42966
|
+
"privacy": "private",
|
|
42967
|
+
"description": "Triggers a click event on the stepper item."
|
|
42968
|
+
},
|
|
42969
|
+
{
|
|
42970
|
+
"kind": "method",
|
|
42971
|
+
"name": "handleKeyUp",
|
|
42972
|
+
"privacy": "private",
|
|
42973
|
+
"parameters": [
|
|
42974
|
+
{
|
|
42975
|
+
"name": "event",
|
|
42976
|
+
"type": {
|
|
42977
|
+
"text": "KeyboardEvent"
|
|
42978
|
+
},
|
|
42979
|
+
"description": "The keyboard event."
|
|
42980
|
+
}
|
|
42981
|
+
],
|
|
42982
|
+
"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."
|
|
42983
|
+
},
|
|
42984
|
+
{
|
|
42985
|
+
"kind": "method",
|
|
42986
|
+
"name": "renderStatusIcon",
|
|
42987
|
+
"privacy": "private",
|
|
42988
|
+
"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.",
|
|
42989
|
+
"return": {
|
|
42990
|
+
"type": {
|
|
42991
|
+
"text": ""
|
|
42992
|
+
}
|
|
42993
|
+
}
|
|
42994
|
+
},
|
|
42995
|
+
{
|
|
42996
|
+
"kind": "method",
|
|
42997
|
+
"name": "renderHelpText",
|
|
42998
|
+
"privacy": "private",
|
|
42999
|
+
"description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
|
|
43000
|
+
"return": {
|
|
43001
|
+
"type": {
|
|
43002
|
+
"text": ""
|
|
43003
|
+
}
|
|
43004
|
+
}
|
|
43005
|
+
},
|
|
43006
|
+
{
|
|
43007
|
+
"kind": "field",
|
|
43008
|
+
"name": "tabIndex",
|
|
43009
|
+
"type": {
|
|
43010
|
+
"text": "number"
|
|
43011
|
+
},
|
|
43012
|
+
"default": "0",
|
|
43013
|
+
"description": "This property specifies the tab order of the element.",
|
|
43014
|
+
"attribute": "tabIndex",
|
|
43015
|
+
"reflects": true,
|
|
43016
|
+
"inheritedFrom": {
|
|
43017
|
+
"name": "TabIndexMixin",
|
|
43018
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
43019
|
+
}
|
|
43020
|
+
}
|
|
43021
|
+
],
|
|
43022
|
+
"events": [
|
|
43023
|
+
{
|
|
43024
|
+
"description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
|
|
43025
|
+
"name": "click",
|
|
43026
|
+
"reactName": "onClick"
|
|
43027
|
+
},
|
|
43028
|
+
{
|
|
43029
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
|
|
43030
|
+
"name": "keydown",
|
|
43031
|
+
"reactName": "onKeyDown"
|
|
43032
|
+
},
|
|
43033
|
+
{
|
|
43034
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
|
|
43035
|
+
"name": "keyup",
|
|
43036
|
+
"reactName": "onKeyUp"
|
|
43037
|
+
}
|
|
43038
|
+
],
|
|
43039
|
+
"attributes": [
|
|
43040
|
+
{
|
|
43041
|
+
"name": "variant",
|
|
43042
|
+
"type": {
|
|
43043
|
+
"text": "VariantType"
|
|
43044
|
+
},
|
|
43045
|
+
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
43046
|
+
"default": "'inline'",
|
|
43047
|
+
"fieldName": "variant"
|
|
43048
|
+
},
|
|
43049
|
+
{
|
|
43050
|
+
"name": "status",
|
|
43051
|
+
"type": {
|
|
43052
|
+
"text": "StatusType"
|
|
43053
|
+
},
|
|
43054
|
+
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
43055
|
+
"default": "'not-started'",
|
|
43056
|
+
"fieldName": "status"
|
|
43057
|
+
},
|
|
43058
|
+
{
|
|
43059
|
+
"name": "label",
|
|
43060
|
+
"type": {
|
|
43061
|
+
"text": "string"
|
|
43062
|
+
},
|
|
43063
|
+
"default": "''",
|
|
43064
|
+
"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.",
|
|
43065
|
+
"fieldName": "label"
|
|
43066
|
+
},
|
|
43067
|
+
{
|
|
43068
|
+
"name": "help-text",
|
|
43069
|
+
"type": {
|
|
43070
|
+
"text": "string | undefined"
|
|
43071
|
+
},
|
|
43072
|
+
"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.",
|
|
43073
|
+
"default": "''",
|
|
43074
|
+
"fieldName": "helpText"
|
|
43075
|
+
},
|
|
43076
|
+
{
|
|
43077
|
+
"name": "step-number",
|
|
43078
|
+
"type": {
|
|
43079
|
+
"text": "number | undefined"
|
|
43080
|
+
},
|
|
43081
|
+
"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.",
|
|
43082
|
+
"default": "''",
|
|
43083
|
+
"fieldName": "stepNumber"
|
|
43084
|
+
},
|
|
43085
|
+
{
|
|
43086
|
+
"name": "tabIndex",
|
|
43087
|
+
"type": {
|
|
43088
|
+
"text": "number"
|
|
43089
|
+
},
|
|
43090
|
+
"default": "0",
|
|
43091
|
+
"description": "This property specifies the tab order of the element.",
|
|
43092
|
+
"fieldName": "tabIndex",
|
|
43093
|
+
"inheritedFrom": {
|
|
43094
|
+
"name": "TabIndexMixin",
|
|
43095
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
43096
|
+
}
|
|
43097
|
+
}
|
|
43098
|
+
],
|
|
43099
|
+
"mixins": [
|
|
43100
|
+
{
|
|
43101
|
+
"name": "TabIndexMixin",
|
|
43102
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
|
43103
|
+
}
|
|
43104
|
+
],
|
|
43105
|
+
"superclass": {
|
|
43106
|
+
"name": "Component",
|
|
43107
|
+
"module": "/src/models"
|
|
43108
|
+
},
|
|
43109
|
+
"tagName": "mdc-stepperitem",
|
|
43110
|
+
"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 */",
|
|
43111
|
+
"customElement": true
|
|
43112
|
+
}
|
|
43113
|
+
],
|
|
43114
|
+
"exports": [
|
|
43115
|
+
{
|
|
43116
|
+
"kind": "js",
|
|
43117
|
+
"name": "default",
|
|
43118
|
+
"declaration": {
|
|
43119
|
+
"name": "StepperItem",
|
|
43120
|
+
"module": "components/stepperitem/stepperitem.component.js"
|
|
43121
|
+
}
|
|
43122
|
+
}
|
|
43123
|
+
]
|
|
43124
|
+
},
|
|
42790
43125
|
{
|
|
42791
43126
|
"kind": "javascript-module",
|
|
42792
43127
|
"path": "components/tab/tab.component.js",
|
|
@@ -43704,303 +44039,6 @@
|
|
|
43704
44039
|
}
|
|
43705
44040
|
]
|
|
43706
44041
|
},
|
|
43707
|
-
{
|
|
43708
|
-
"kind": "javascript-module",
|
|
43709
|
-
"path": "components/stepperitem/stepperitem.component.js",
|
|
43710
|
-
"declarations": [
|
|
43711
|
-
{
|
|
43712
|
-
"kind": "class",
|
|
43713
|
-
"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.",
|
|
43714
|
-
"name": "StepperItem",
|
|
43715
|
-
"cssProperties": [
|
|
43716
|
-
{
|
|
43717
|
-
"description": "The background color of the status container.",
|
|
43718
|
-
"name": "--mdc-stepperitem-status-container-background"
|
|
43719
|
-
},
|
|
43720
|
-
{
|
|
43721
|
-
"description": "The border color of the status container.",
|
|
43722
|
-
"name": "--mdc-stepperitem-status-container-border-color"
|
|
43723
|
-
},
|
|
43724
|
-
{
|
|
43725
|
-
"description": "The color of the label text.",
|
|
43726
|
-
"name": "--mdc-stepperitem-label-color"
|
|
43727
|
-
},
|
|
43728
|
-
{
|
|
43729
|
-
"description": "The color of the optional label text.",
|
|
43730
|
-
"name": "--mdc-stepperitem-help-text-color"
|
|
43731
|
-
},
|
|
43732
|
-
{
|
|
43733
|
-
"description": "The background color of the label container.",
|
|
43734
|
-
"name": "--mdc-stepperitem-label-container-background"
|
|
43735
|
-
}
|
|
43736
|
-
],
|
|
43737
|
-
"cssParts": [
|
|
43738
|
-
{
|
|
43739
|
-
"description": "The container for the status icon or step number.",
|
|
43740
|
-
"name": "status-container"
|
|
43741
|
-
},
|
|
43742
|
-
{
|
|
43743
|
-
"description": "The container for the label and help text.",
|
|
43744
|
-
"name": "label-container"
|
|
43745
|
-
},
|
|
43746
|
-
{
|
|
43747
|
-
"description": "The container for the help text and error icon when applicable.",
|
|
43748
|
-
"name": "help-text-container"
|
|
43749
|
-
},
|
|
43750
|
-
{
|
|
43751
|
-
"description": "The icon representing the status of the stepper item.",
|
|
43752
|
-
"name": "status-icon"
|
|
43753
|
-
},
|
|
43754
|
-
{
|
|
43755
|
-
"description": "The text representing the step number.",
|
|
43756
|
-
"name": "step-number"
|
|
43757
|
-
},
|
|
43758
|
-
{
|
|
43759
|
-
"description": "The text representing the label of the stepper item.",
|
|
43760
|
-
"name": "label"
|
|
43761
|
-
},
|
|
43762
|
-
{
|
|
43763
|
-
"description": "The text providing additional information about the stepper item.",
|
|
43764
|
-
"name": "help-text"
|
|
43765
|
-
},
|
|
43766
|
-
{
|
|
43767
|
-
"description": "The icon representing an error in the stepper item.",
|
|
43768
|
-
"name": "help-icon"
|
|
43769
|
-
}
|
|
43770
|
-
],
|
|
43771
|
-
"members": [
|
|
43772
|
-
{
|
|
43773
|
-
"kind": "field",
|
|
43774
|
-
"name": "variant",
|
|
43775
|
-
"type": {
|
|
43776
|
-
"text": "VariantType"
|
|
43777
|
-
},
|
|
43778
|
-
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
43779
|
-
"default": "'inline'",
|
|
43780
|
-
"attribute": "variant",
|
|
43781
|
-
"reflects": true
|
|
43782
|
-
},
|
|
43783
|
-
{
|
|
43784
|
-
"kind": "field",
|
|
43785
|
-
"name": "status",
|
|
43786
|
-
"type": {
|
|
43787
|
-
"text": "StatusType"
|
|
43788
|
-
},
|
|
43789
|
-
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
43790
|
-
"default": "'not-started'",
|
|
43791
|
-
"attribute": "status",
|
|
43792
|
-
"reflects": true
|
|
43793
|
-
},
|
|
43794
|
-
{
|
|
43795
|
-
"kind": "field",
|
|
43796
|
-
"name": "label",
|
|
43797
|
-
"type": {
|
|
43798
|
-
"text": "string"
|
|
43799
|
-
},
|
|
43800
|
-
"default": "''",
|
|
43801
|
-
"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.",
|
|
43802
|
-
"attribute": "label",
|
|
43803
|
-
"reflects": true
|
|
43804
|
-
},
|
|
43805
|
-
{
|
|
43806
|
-
"kind": "field",
|
|
43807
|
-
"name": "helpText",
|
|
43808
|
-
"type": {
|
|
43809
|
-
"text": "string | undefined"
|
|
43810
|
-
},
|
|
43811
|
-
"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.",
|
|
43812
|
-
"default": "''",
|
|
43813
|
-
"attribute": "help-text",
|
|
43814
|
-
"reflects": true
|
|
43815
|
-
},
|
|
43816
|
-
{
|
|
43817
|
-
"kind": "field",
|
|
43818
|
-
"name": "stepNumber",
|
|
43819
|
-
"type": {
|
|
43820
|
-
"text": "number | undefined"
|
|
43821
|
-
},
|
|
43822
|
-
"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.",
|
|
43823
|
-
"default": "''",
|
|
43824
|
-
"attribute": "step-number",
|
|
43825
|
-
"reflects": true
|
|
43826
|
-
},
|
|
43827
|
-
{
|
|
43828
|
-
"kind": "method",
|
|
43829
|
-
"name": "handleKeyDown",
|
|
43830
|
-
"privacy": "private",
|
|
43831
|
-
"parameters": [
|
|
43832
|
-
{
|
|
43833
|
-
"name": "event",
|
|
43834
|
-
"type": {
|
|
43835
|
-
"text": "KeyboardEvent"
|
|
43836
|
-
},
|
|
43837
|
-
"description": "The keyboard event."
|
|
43838
|
-
}
|
|
43839
|
-
],
|
|
43840
|
-
"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."
|
|
43841
|
-
},
|
|
43842
|
-
{
|
|
43843
|
-
"kind": "method",
|
|
43844
|
-
"name": "triggerClickEvent",
|
|
43845
|
-
"privacy": "private",
|
|
43846
|
-
"description": "Triggers a click event on the stepper item."
|
|
43847
|
-
},
|
|
43848
|
-
{
|
|
43849
|
-
"kind": "method",
|
|
43850
|
-
"name": "handleKeyUp",
|
|
43851
|
-
"privacy": "private",
|
|
43852
|
-
"parameters": [
|
|
43853
|
-
{
|
|
43854
|
-
"name": "event",
|
|
43855
|
-
"type": {
|
|
43856
|
-
"text": "KeyboardEvent"
|
|
43857
|
-
},
|
|
43858
|
-
"description": "The keyboard event."
|
|
43859
|
-
}
|
|
43860
|
-
],
|
|
43861
|
-
"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."
|
|
43862
|
-
},
|
|
43863
|
-
{
|
|
43864
|
-
"kind": "method",
|
|
43865
|
-
"name": "renderStatusIcon",
|
|
43866
|
-
"privacy": "private",
|
|
43867
|
-
"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.",
|
|
43868
|
-
"return": {
|
|
43869
|
-
"type": {
|
|
43870
|
-
"text": ""
|
|
43871
|
-
}
|
|
43872
|
-
}
|
|
43873
|
-
},
|
|
43874
|
-
{
|
|
43875
|
-
"kind": "method",
|
|
43876
|
-
"name": "renderHelpText",
|
|
43877
|
-
"privacy": "private",
|
|
43878
|
-
"description": "Renders the help text for the stepper item.\nIf the `helpText` property is not set, it returns nothing.",
|
|
43879
|
-
"return": {
|
|
43880
|
-
"type": {
|
|
43881
|
-
"text": ""
|
|
43882
|
-
}
|
|
43883
|
-
}
|
|
43884
|
-
},
|
|
43885
|
-
{
|
|
43886
|
-
"kind": "field",
|
|
43887
|
-
"name": "tabIndex",
|
|
43888
|
-
"type": {
|
|
43889
|
-
"text": "number"
|
|
43890
|
-
},
|
|
43891
|
-
"default": "0",
|
|
43892
|
-
"description": "This property specifies the tab order of the element.",
|
|
43893
|
-
"attribute": "tabIndex",
|
|
43894
|
-
"reflects": true,
|
|
43895
|
-
"inheritedFrom": {
|
|
43896
|
-
"name": "TabIndexMixin",
|
|
43897
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
|
43898
|
-
}
|
|
43899
|
-
}
|
|
43900
|
-
],
|
|
43901
|
-
"events": [
|
|
43902
|
-
{
|
|
43903
|
-
"description": "(React: onClick) This event is dispatched when the stepperitem is clicked.",
|
|
43904
|
-
"name": "click",
|
|
43905
|
-
"reactName": "onClick"
|
|
43906
|
-
},
|
|
43907
|
-
{
|
|
43908
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the stepperitem.",
|
|
43909
|
-
"name": "keydown",
|
|
43910
|
-
"reactName": "onKeyDown"
|
|
43911
|
-
},
|
|
43912
|
-
{
|
|
43913
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the stepperitem.",
|
|
43914
|
-
"name": "keyup",
|
|
43915
|
-
"reactName": "onKeyUp"
|
|
43916
|
-
}
|
|
43917
|
-
],
|
|
43918
|
-
"attributes": [
|
|
43919
|
-
{
|
|
43920
|
-
"name": "variant",
|
|
43921
|
-
"type": {
|
|
43922
|
-
"text": "VariantType"
|
|
43923
|
-
},
|
|
43924
|
-
"description": "The variant of the stepper item, which can be `inline` or `stacked`.",
|
|
43925
|
-
"default": "'inline'",
|
|
43926
|
-
"fieldName": "variant"
|
|
43927
|
-
},
|
|
43928
|
-
{
|
|
43929
|
-
"name": "status",
|
|
43930
|
-
"type": {
|
|
43931
|
-
"text": "StatusType"
|
|
43932
|
-
},
|
|
43933
|
-
"description": "The status of the stepper item, which can be `completed`, `current`, `not-started`, `error-current`, or `error-incomplete`.",
|
|
43934
|
-
"default": "'not-started'",
|
|
43935
|
-
"fieldName": "status"
|
|
43936
|
-
},
|
|
43937
|
-
{
|
|
43938
|
-
"name": "label",
|
|
43939
|
-
"type": {
|
|
43940
|
-
"text": "string"
|
|
43941
|
-
},
|
|
43942
|
-
"default": "''",
|
|
43943
|
-
"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.",
|
|
43944
|
-
"fieldName": "label"
|
|
43945
|
-
},
|
|
43946
|
-
{
|
|
43947
|
-
"name": "help-text",
|
|
43948
|
-
"type": {
|
|
43949
|
-
"text": "string | undefined"
|
|
43950
|
-
},
|
|
43951
|
-
"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.",
|
|
43952
|
-
"default": "''",
|
|
43953
|
-
"fieldName": "helpText"
|
|
43954
|
-
},
|
|
43955
|
-
{
|
|
43956
|
-
"name": "step-number",
|
|
43957
|
-
"type": {
|
|
43958
|
-
"text": "number | undefined"
|
|
43959
|
-
},
|
|
43960
|
-
"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.",
|
|
43961
|
-
"default": "''",
|
|
43962
|
-
"fieldName": "stepNumber"
|
|
43963
|
-
},
|
|
43964
|
-
{
|
|
43965
|
-
"name": "tabIndex",
|
|
43966
|
-
"type": {
|
|
43967
|
-
"text": "number"
|
|
43968
|
-
},
|
|
43969
|
-
"default": "0",
|
|
43970
|
-
"description": "This property specifies the tab order of the element.",
|
|
43971
|
-
"fieldName": "tabIndex",
|
|
43972
|
-
"inheritedFrom": {
|
|
43973
|
-
"name": "TabIndexMixin",
|
|
43974
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
43975
|
-
}
|
|
43976
|
-
}
|
|
43977
|
-
],
|
|
43978
|
-
"mixins": [
|
|
43979
|
-
{
|
|
43980
|
-
"name": "TabIndexMixin",
|
|
43981
|
-
"module": "/src/utils/mixins/TabIndexMixin"
|
|
43982
|
-
}
|
|
43983
|
-
],
|
|
43984
|
-
"superclass": {
|
|
43985
|
-
"name": "Component",
|
|
43986
|
-
"module": "/src/models"
|
|
43987
|
-
},
|
|
43988
|
-
"tagName": "mdc-stepperitem",
|
|
43989
|
-
"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 */",
|
|
43990
|
-
"customElement": true
|
|
43991
|
-
}
|
|
43992
|
-
],
|
|
43993
|
-
"exports": [
|
|
43994
|
-
{
|
|
43995
|
-
"kind": "js",
|
|
43996
|
-
"name": "default",
|
|
43997
|
-
"declaration": {
|
|
43998
|
-
"name": "StepperItem",
|
|
43999
|
-
"module": "components/stepperitem/stepperitem.component.js"
|
|
44000
|
-
}
|
|
44001
|
-
}
|
|
44002
|
-
]
|
|
44003
|
-
},
|
|
44004
44042
|
{
|
|
44005
44043
|
"kind": "javascript-module",
|
|
44006
44044
|
"path": "components/tablist/tablist.component.js",
|