@momentum-design/components 0.71.2 → 0.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +350 -339
- package/dist/browser/index.js.map +4 -4
- package/dist/components/animation/animation.component.d.ts +77 -0
- package/dist/components/animation/animation.component.js +171 -0
- package/dist/components/animation/animation.constants.d.ts +7 -0
- package/dist/components/animation/animation.constants.js +8 -0
- package/dist/components/animation/animation.styles.d.ts +2 -0
- package/dist/components/animation/animation.styles.js +3 -0
- package/dist/components/animation/animation.types.d.ts +12 -0
- package/dist/components/animation/animation.types.js +1 -0
- package/dist/components/animation/index.d.ts +7 -0
- package/dist/components/animation/index.js +4 -0
- package/dist/custom-elements.json +814 -602
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/animation/index.d.ts +20 -0
- package/dist/react/animation/index.js +28 -0
- package/dist/react/index.d.ts +3 -2
- package/dist/react/index.js +3 -2
- package/package.json +3 -1
@@ -492,6 +492,279 @@
|
|
492
492
|
}
|
493
493
|
]
|
494
494
|
},
|
495
|
+
{
|
496
|
+
"kind": "javascript-module",
|
497
|
+
"path": "components/animation/animation.component.js",
|
498
|
+
"declarations": [
|
499
|
+
{
|
500
|
+
"kind": "class",
|
501
|
+
"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.",
|
502
|
+
"name": "Animation",
|
503
|
+
"members": [
|
504
|
+
{
|
505
|
+
"kind": "field",
|
506
|
+
"name": "name",
|
507
|
+
"type": {
|
508
|
+
"text": "AnimationNames | undefined"
|
509
|
+
},
|
510
|
+
"description": "Name of the animation (= filename)",
|
511
|
+
"attribute": "name",
|
512
|
+
"reflects": true
|
513
|
+
},
|
514
|
+
{
|
515
|
+
"kind": "field",
|
516
|
+
"name": "loop",
|
517
|
+
"type": {
|
518
|
+
"text": "LoopType | undefined"
|
519
|
+
},
|
520
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
521
|
+
"attribute": "loop",
|
522
|
+
"reflects": true
|
523
|
+
},
|
524
|
+
{
|
525
|
+
"kind": "field",
|
526
|
+
"name": "autoplay",
|
527
|
+
"type": {
|
528
|
+
"text": "boolean | undefined"
|
529
|
+
},
|
530
|
+
"description": "Weather start the animation automatically",
|
531
|
+
"attribute": "autoplay",
|
532
|
+
"reflects": true
|
533
|
+
},
|
534
|
+
{
|
535
|
+
"kind": "field",
|
536
|
+
"name": "ariaLabel",
|
537
|
+
"type": {
|
538
|
+
"text": "string | null"
|
539
|
+
},
|
540
|
+
"default": "null",
|
541
|
+
"description": "Aria-label attribute to be set for accessibility",
|
542
|
+
"attribute": "aria-label"
|
543
|
+
},
|
544
|
+
{
|
545
|
+
"kind": "field",
|
546
|
+
"name": "ariaLabelledBy",
|
547
|
+
"type": {
|
548
|
+
"text": "string | null"
|
549
|
+
},
|
550
|
+
"default": "null",
|
551
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
552
|
+
"attribute": "aria-labelledby"
|
553
|
+
},
|
554
|
+
{
|
555
|
+
"kind": "field",
|
556
|
+
"name": "lottieInstance",
|
557
|
+
"type": {
|
558
|
+
"text": "AnimationItem | undefined"
|
559
|
+
},
|
560
|
+
"privacy": "private",
|
561
|
+
"description": "Lottie animation instance"
|
562
|
+
},
|
563
|
+
{
|
564
|
+
"kind": "field",
|
565
|
+
"name": "containerRef",
|
566
|
+
"type": {
|
567
|
+
"text": "Ref<HTMLDivElement>"
|
568
|
+
},
|
569
|
+
"privacy": "private",
|
570
|
+
"description": "Container for the animation"
|
571
|
+
},
|
572
|
+
{
|
573
|
+
"kind": "field",
|
574
|
+
"name": "animation",
|
575
|
+
"description": "Exposed API of the animation library (lottie)",
|
576
|
+
"readonly": true
|
577
|
+
},
|
578
|
+
{
|
579
|
+
"kind": "method",
|
580
|
+
"name": "getLoopValue",
|
581
|
+
"privacy": "private"
|
582
|
+
},
|
583
|
+
{
|
584
|
+
"kind": "method",
|
585
|
+
"name": "onLoadSuccessHandler",
|
586
|
+
"privacy": "private",
|
587
|
+
"parameters": [
|
588
|
+
{
|
589
|
+
"name": "animationData",
|
590
|
+
"type": {
|
591
|
+
"text": "any"
|
592
|
+
}
|
593
|
+
}
|
594
|
+
],
|
595
|
+
"description": "Create new lotty instance for the loaded data"
|
596
|
+
},
|
597
|
+
{
|
598
|
+
"kind": "method",
|
599
|
+
"name": "onLoadFailHandler",
|
600
|
+
"privacy": "private",
|
601
|
+
"parameters": [
|
602
|
+
{
|
603
|
+
"name": "error",
|
604
|
+
"type": {
|
605
|
+
"text": "Error"
|
606
|
+
}
|
607
|
+
}
|
608
|
+
],
|
609
|
+
"description": "Error handler for animation loading"
|
610
|
+
},
|
611
|
+
{
|
612
|
+
"kind": "method",
|
613
|
+
"name": "getAnimationData",
|
614
|
+
"privacy": "private",
|
615
|
+
"description": "Import animation data dynamically"
|
616
|
+
},
|
617
|
+
{
|
618
|
+
"kind": "field",
|
619
|
+
"name": "onCompleteHandler",
|
620
|
+
"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."
|
621
|
+
}
|
622
|
+
],
|
623
|
+
"events": [
|
624
|
+
{
|
625
|
+
"name": "load",
|
626
|
+
"type": {
|
627
|
+
"text": "CustomEvent"
|
628
|
+
},
|
629
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
630
|
+
"reactName": "onLoad"
|
631
|
+
},
|
632
|
+
{
|
633
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
634
|
+
"name": "complete",
|
635
|
+
"reactName": "onComplete"
|
636
|
+
},
|
637
|
+
{
|
638
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
639
|
+
"name": "error",
|
640
|
+
"reactName": "onError"
|
641
|
+
}
|
642
|
+
],
|
643
|
+
"attributes": [
|
644
|
+
{
|
645
|
+
"name": "name",
|
646
|
+
"type": {
|
647
|
+
"text": "AnimationNames | undefined"
|
648
|
+
},
|
649
|
+
"description": "Name of the animation (= filename)",
|
650
|
+
"fieldName": "name"
|
651
|
+
},
|
652
|
+
{
|
653
|
+
"name": "loop",
|
654
|
+
"type": {
|
655
|
+
"text": "LoopType | undefined"
|
656
|
+
},
|
657
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
658
|
+
"fieldName": "loop"
|
659
|
+
},
|
660
|
+
{
|
661
|
+
"name": "autoplay",
|
662
|
+
"type": {
|
663
|
+
"text": "boolean | undefined"
|
664
|
+
},
|
665
|
+
"description": "Weather start the animation automatically",
|
666
|
+
"fieldName": "autoplay"
|
667
|
+
},
|
668
|
+
{
|
669
|
+
"name": "aria-label",
|
670
|
+
"type": {
|
671
|
+
"text": "string | null"
|
672
|
+
},
|
673
|
+
"default": "null",
|
674
|
+
"description": "Aria-label attribute to be set for accessibility",
|
675
|
+
"fieldName": "ariaLabel"
|
676
|
+
},
|
677
|
+
{
|
678
|
+
"name": "aria-labelledby",
|
679
|
+
"type": {
|
680
|
+
"text": "string | null"
|
681
|
+
},
|
682
|
+
"default": "null",
|
683
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
684
|
+
"fieldName": "ariaLabelledBy"
|
685
|
+
}
|
686
|
+
],
|
687
|
+
"superclass": {
|
688
|
+
"name": "Component",
|
689
|
+
"module": "/src/models"
|
690
|
+
},
|
691
|
+
"tagName": "mdc-animation",
|
692
|
+
"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 */",
|
693
|
+
"customElement": true
|
694
|
+
}
|
695
|
+
],
|
696
|
+
"exports": [
|
697
|
+
{
|
698
|
+
"kind": "js",
|
699
|
+
"name": "default",
|
700
|
+
"declaration": {
|
701
|
+
"name": "Animation",
|
702
|
+
"module": "components/animation/animation.component.js"
|
703
|
+
}
|
704
|
+
}
|
705
|
+
]
|
706
|
+
},
|
707
|
+
{
|
708
|
+
"kind": "javascript-module",
|
709
|
+
"path": "components/appheader/appheader.component.js",
|
710
|
+
"declarations": [
|
711
|
+
{
|
712
|
+
"kind": "class",
|
713
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
714
|
+
"name": "Appheader",
|
715
|
+
"cssParts": [
|
716
|
+
{
|
717
|
+
"description": "The main container for styling the header.",
|
718
|
+
"name": "container"
|
719
|
+
},
|
720
|
+
{
|
721
|
+
"description": "The leading section of the header.",
|
722
|
+
"name": "leading-section"
|
723
|
+
},
|
724
|
+
{
|
725
|
+
"description": "The center section of the header.",
|
726
|
+
"name": "center-section"
|
727
|
+
},
|
728
|
+
{
|
729
|
+
"description": "The trailing section of the header.",
|
730
|
+
"name": "trailing-section"
|
731
|
+
}
|
732
|
+
],
|
733
|
+
"slots": [
|
734
|
+
{
|
735
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
736
|
+
"name": "leading"
|
737
|
+
},
|
738
|
+
{
|
739
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
740
|
+
"name": "center"
|
741
|
+
},
|
742
|
+
{
|
743
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
744
|
+
"name": "trailing"
|
745
|
+
}
|
746
|
+
],
|
747
|
+
"members": [],
|
748
|
+
"superclass": {
|
749
|
+
"name": "Component",
|
750
|
+
"module": "/src/models"
|
751
|
+
},
|
752
|
+
"tagName": "mdc-appheader",
|
753
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
754
|
+
"customElement": true
|
755
|
+
}
|
756
|
+
],
|
757
|
+
"exports": [
|
758
|
+
{
|
759
|
+
"kind": "js",
|
760
|
+
"name": "default",
|
761
|
+
"declaration": {
|
762
|
+
"name": "Appheader",
|
763
|
+
"module": "components/appheader/appheader.component.js"
|
764
|
+
}
|
765
|
+
}
|
766
|
+
]
|
767
|
+
},
|
495
768
|
{
|
496
769
|
"kind": "javascript-module",
|
497
770
|
"path": "components/avatar/avatar.component.js",
|
@@ -738,88 +1011,27 @@
|
|
738
1011
|
},
|
739
1012
|
{
|
740
1013
|
"kind": "javascript-module",
|
741
|
-
"path": "components/
|
1014
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
742
1015
|
"declarations": [
|
743
1016
|
{
|
744
1017
|
"kind": "class",
|
745
|
-
"description": "The `mdc-
|
746
|
-
"name": "
|
747
|
-
"
|
748
|
-
{
|
749
|
-
"description": "The main container for styling the header.",
|
750
|
-
"name": "container"
|
751
|
-
},
|
1018
|
+
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
1019
|
+
"name": "AvatarButton",
|
1020
|
+
"cssProperties": [
|
752
1021
|
{
|
753
|
-
"description": "
|
754
|
-
"name": "
|
1022
|
+
"description": "Background color of the overlay in rest state",
|
1023
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
755
1024
|
},
|
756
1025
|
{
|
757
|
-
"description": "
|
758
|
-
"name": "
|
1026
|
+
"description": "Background color of the overlay in hover state",
|
1027
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
759
1028
|
},
|
760
1029
|
{
|
761
|
-
"description": "
|
762
|
-
"name": "
|
1030
|
+
"description": "Background color of the overlay in active state",
|
1031
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
763
1032
|
}
|
764
1033
|
],
|
765
|
-
"
|
766
|
-
{
|
767
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
768
|
-
"name": "leading"
|
769
|
-
},
|
770
|
-
{
|
771
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
772
|
-
"name": "center"
|
773
|
-
},
|
774
|
-
{
|
775
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
776
|
-
"name": "trailing"
|
777
|
-
}
|
778
|
-
],
|
779
|
-
"members": [],
|
780
|
-
"superclass": {
|
781
|
-
"name": "Component",
|
782
|
-
"module": "/src/models"
|
783
|
-
},
|
784
|
-
"tagName": "mdc-appheader",
|
785
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
786
|
-
"customElement": true
|
787
|
-
}
|
788
|
-
],
|
789
|
-
"exports": [
|
790
|
-
{
|
791
|
-
"kind": "js",
|
792
|
-
"name": "default",
|
793
|
-
"declaration": {
|
794
|
-
"name": "Appheader",
|
795
|
-
"module": "components/appheader/appheader.component.js"
|
796
|
-
}
|
797
|
-
}
|
798
|
-
]
|
799
|
-
},
|
800
|
-
{
|
801
|
-
"kind": "javascript-module",
|
802
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
803
|
-
"declarations": [
|
804
|
-
{
|
805
|
-
"kind": "class",
|
806
|
-
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
807
|
-
"name": "AvatarButton",
|
808
|
-
"cssProperties": [
|
809
|
-
{
|
810
|
-
"description": "Background color of the overlay in rest state",
|
811
|
-
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
812
|
-
},
|
813
|
-
{
|
814
|
-
"description": "Background color of the overlay in hover state",
|
815
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
816
|
-
},
|
817
|
-
{
|
818
|
-
"description": "Background color of the overlay in active state",
|
819
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
820
|
-
}
|
821
|
-
],
|
822
|
-
"members": [
|
1034
|
+
"members": [
|
823
1035
|
{
|
824
1036
|
"kind": "field",
|
825
1037
|
"name": "ariaLabel",
|
@@ -1937,57 +2149,75 @@
|
|
1937
2149
|
},
|
1938
2150
|
{
|
1939
2151
|
"kind": "javascript-module",
|
1940
|
-
"path": "components/
|
2152
|
+
"path": "components/button/button.component.js",
|
1941
2153
|
"declarations": [
|
1942
2154
|
{
|
1943
2155
|
"kind": "class",
|
1944
|
-
"description": "`mdc-
|
1945
|
-
"name": "
|
2156
|
+
"description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
|
2157
|
+
"name": "Button",
|
2158
|
+
"slots": [
|
2159
|
+
{
|
2160
|
+
"description": "Text label of the button.",
|
2161
|
+
"name": ""
|
2162
|
+
}
|
2163
|
+
],
|
1946
2164
|
"members": [
|
1947
2165
|
{
|
1948
2166
|
"kind": "field",
|
1949
2167
|
"name": "size",
|
1950
2168
|
"type": {
|
1951
|
-
"text": "
|
2169
|
+
"text": "ButtonSize"
|
1952
2170
|
},
|
1953
|
-
"description": "
|
2171
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1954
2172
|
"default": "32",
|
1955
2173
|
"attribute": "size",
|
1956
|
-
"reflects": true
|
2174
|
+
"reflects": true,
|
2175
|
+
"inheritedFrom": {
|
2176
|
+
"name": "Buttonsimple",
|
2177
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2178
|
+
}
|
1957
2179
|
},
|
1958
2180
|
{
|
1959
2181
|
"kind": "field",
|
1960
|
-
"name": "
|
2182
|
+
"name": "inverted",
|
1961
2183
|
"type": {
|
1962
|
-
"text": "boolean
|
2184
|
+
"text": "boolean"
|
1963
2185
|
},
|
1964
|
-
"description": "
|
1965
|
-
"default": "
|
1966
|
-
"attribute": "
|
2186
|
+
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
2187
|
+
"default": "false",
|
2188
|
+
"attribute": "inverted",
|
1967
2189
|
"reflects": true
|
1968
2190
|
},
|
2191
|
+
{
|
2192
|
+
"kind": "field",
|
2193
|
+
"name": "role",
|
2194
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2195
|
+
"default": "'button'",
|
2196
|
+
"attribute": "role",
|
2197
|
+
"reflects": true,
|
2198
|
+
"type": {
|
2199
|
+
"text": "string"
|
2200
|
+
},
|
2201
|
+
"inheritedFrom": {
|
2202
|
+
"name": "Buttonsimple",
|
2203
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2204
|
+
}
|
2205
|
+
},
|
1969
2206
|
{
|
1970
2207
|
"kind": "method",
|
1971
|
-
"name": "
|
2208
|
+
"name": "inferFilledIconName",
|
1972
2209
|
"privacy": "private",
|
1973
2210
|
"parameters": [
|
1974
2211
|
{
|
1975
|
-
"name": "
|
1976
|
-
"type": {
|
1977
|
-
"text": "HTMLElement"
|
1978
|
-
},
|
1979
|
-
"description": "The buttonlink element."
|
1980
|
-
},
|
1981
|
-
{
|
1982
|
-
"name": "softDisabled",
|
2212
|
+
"name": "active",
|
1983
2213
|
"optional": true,
|
1984
2214
|
"type": {
|
1985
2215
|
"text": "boolean"
|
1986
2216
|
},
|
1987
|
-
"description": "The
|
2217
|
+
"description": "The active state."
|
1988
2218
|
}
|
1989
2219
|
],
|
1990
|
-
"description": "
|
2220
|
+
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
1991
2221
|
},
|
1992
2222
|
{
|
1993
2223
|
"kind": "field",
|
@@ -2118,21 +2348,6 @@
|
|
2118
2348
|
"module": "utils/mixins/ButtonComponentMixin.js"
|
2119
2349
|
}
|
2120
2350
|
},
|
2121
|
-
{
|
2122
|
-
"kind": "field",
|
2123
|
-
"name": "disabled",
|
2124
|
-
"type": {
|
2125
|
-
"text": "boolean | undefined"
|
2126
|
-
},
|
2127
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2128
|
-
"default": "undefined",
|
2129
|
-
"attribute": "disabled",
|
2130
|
-
"reflects": true,
|
2131
|
-
"inheritedFrom": {
|
2132
|
-
"name": "DisabledMixin",
|
2133
|
-
"module": "utils/mixins/DisabledMixin.js"
|
2134
|
-
}
|
2135
|
-
},
|
2136
2351
|
{
|
2137
2352
|
"kind": "field",
|
2138
2353
|
"name": "tabIndex",
|
@@ -2150,142 +2365,223 @@
|
|
2150
2365
|
},
|
2151
2366
|
{
|
2152
2367
|
"kind": "field",
|
2153
|
-
"name": "
|
2368
|
+
"name": "disabled",
|
2154
2369
|
"type": {
|
2155
|
-
"text": "boolean"
|
2370
|
+
"text": "boolean | undefined"
|
2156
2371
|
},
|
2157
|
-
"description": "
|
2158
|
-
"default": "
|
2159
|
-
"attribute": "
|
2372
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2373
|
+
"default": "undefined",
|
2374
|
+
"attribute": "disabled",
|
2160
2375
|
"reflects": true,
|
2161
2376
|
"inheritedFrom": {
|
2162
|
-
"name": "
|
2163
|
-
"module": "
|
2377
|
+
"name": "DisabledMixin",
|
2378
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2164
2379
|
}
|
2165
2380
|
},
|
2166
2381
|
{
|
2167
2382
|
"kind": "field",
|
2168
|
-
"name": "
|
2383
|
+
"name": "active",
|
2169
2384
|
"type": {
|
2170
|
-
"text": "boolean"
|
2385
|
+
"text": "boolean | undefined"
|
2171
2386
|
},
|
2172
|
-
"description": "The
|
2173
|
-
"default": "
|
2174
|
-
"attribute": "
|
2387
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2388
|
+
"default": "undefined",
|
2389
|
+
"attribute": "active",
|
2175
2390
|
"reflects": true,
|
2176
2391
|
"inheritedFrom": {
|
2177
|
-
"name": "
|
2178
|
-
"module": "components/
|
2392
|
+
"name": "Buttonsimple",
|
2393
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2179
2394
|
}
|
2180
2395
|
},
|
2181
2396
|
{
|
2182
2397
|
"kind": "field",
|
2183
|
-
"name": "
|
2398
|
+
"name": "softDisabled",
|
2184
2399
|
"type": {
|
2185
|
-
"text": "
|
2400
|
+
"text": "boolean | undefined"
|
2186
2401
|
},
|
2187
|
-
"
|
2188
|
-
"
|
2189
|
-
"attribute": "
|
2402
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2403
|
+
"default": "undefined",
|
2404
|
+
"attribute": "soft-disabled",
|
2190
2405
|
"reflects": true,
|
2191
2406
|
"inheritedFrom": {
|
2192
|
-
"name": "
|
2193
|
-
"module": "components/
|
2407
|
+
"name": "Buttonsimple",
|
2408
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2194
2409
|
}
|
2195
2410
|
},
|
2196
2411
|
{
|
2197
2412
|
"kind": "field",
|
2198
|
-
"name": "
|
2413
|
+
"name": "ariaStateKey",
|
2199
2414
|
"type": {
|
2200
|
-
"text": "string"
|
2415
|
+
"text": "string | undefined"
|
2201
2416
|
},
|
2202
|
-
"
|
2203
|
-
"
|
2204
|
-
"attribute": "
|
2417
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2418
|
+
"default": "'aria-pressed' (when)",
|
2419
|
+
"attribute": "ariaStateKey",
|
2205
2420
|
"reflects": true,
|
2206
2421
|
"inheritedFrom": {
|
2207
|
-
"name": "
|
2208
|
-
"module": "components/
|
2422
|
+
"name": "Buttonsimple",
|
2423
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2209
2424
|
}
|
2210
2425
|
},
|
2211
2426
|
{
|
2212
2427
|
"kind": "field",
|
2213
|
-
"name": "
|
2428
|
+
"name": "type",
|
2214
2429
|
"type": {
|
2215
|
-
"text": "
|
2430
|
+
"text": "ButtonType"
|
2216
2431
|
},
|
2217
|
-
"description": "
|
2218
|
-
"
|
2432
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2433
|
+
"default": "button",
|
2434
|
+
"attribute": "type",
|
2219
2435
|
"reflects": true,
|
2220
2436
|
"inheritedFrom": {
|
2221
|
-
"name": "
|
2222
|
-
"module": "components/
|
2437
|
+
"name": "Buttonsimple",
|
2438
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2223
2439
|
}
|
2224
2440
|
},
|
2225
2441
|
{
|
2226
|
-
"kind": "
|
2227
|
-
"name": "
|
2228
|
-
"privacy": "
|
2442
|
+
"kind": "method",
|
2443
|
+
"name": "executeAction",
|
2444
|
+
"privacy": "protected",
|
2229
2445
|
"inheritedFrom": {
|
2230
|
-
"name": "
|
2231
|
-
"module": "components/
|
2446
|
+
"name": "Buttonsimple",
|
2447
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2232
2448
|
}
|
2233
2449
|
},
|
2234
2450
|
{
|
2235
2451
|
"kind": "method",
|
2236
|
-
"name": "
|
2237
|
-
"privacy": "
|
2452
|
+
"name": "setActive",
|
2453
|
+
"privacy": "protected",
|
2238
2454
|
"parameters": [
|
2239
2455
|
{
|
2240
|
-
"name": "
|
2456
|
+
"name": "element",
|
2457
|
+
"type": {
|
2458
|
+
"text": "HTMLElement"
|
2459
|
+
},
|
2460
|
+
"description": "The button element"
|
2461
|
+
},
|
2462
|
+
{
|
2463
|
+
"name": "active",
|
2464
|
+
"optional": true,
|
2241
2465
|
"type": {
|
2242
2466
|
"text": "boolean"
|
2243
2467
|
},
|
2244
|
-
"description": "
|
2468
|
+
"description": "The active state of the element"
|
2245
2469
|
}
|
2246
2470
|
],
|
2247
|
-
"description": "Sets
|
2248
|
-
"inheritedFrom": {
|
2249
|
-
"name": "Linksimple",
|
2250
|
-
"module": "components/linksimple/linksimple.component.js"
|
2251
|
-
}
|
2252
|
-
}
|
2253
|
-
],
|
2254
|
-
"events": [
|
2255
|
-
{
|
2256
|
-
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
2257
|
-
"name": "click",
|
2258
|
-
"reactName": "onClick",
|
2259
|
-
"inheritedFrom": {
|
2260
|
-
"name": "Linksimple",
|
2261
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
2262
|
-
}
|
2263
|
-
},
|
2264
|
-
{
|
2265
|
-
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
2266
|
-
"name": "keydown",
|
2267
|
-
"reactName": "onKeyDown",
|
2471
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2268
2472
|
"inheritedFrom": {
|
2269
|
-
"name": "
|
2270
|
-
"module": "
|
2473
|
+
"name": "Buttonsimple",
|
2474
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2271
2475
|
}
|
2272
2476
|
},
|
2273
2477
|
{
|
2274
|
-
"
|
2275
|
-
"name": "
|
2276
|
-
"
|
2277
|
-
"
|
2278
|
-
|
2279
|
-
|
2280
|
-
|
2478
|
+
"kind": "method",
|
2479
|
+
"name": "setSoftDisabled",
|
2480
|
+
"privacy": "private",
|
2481
|
+
"parameters": [
|
2482
|
+
{
|
2483
|
+
"name": "element",
|
2484
|
+
"type": {
|
2485
|
+
"text": "HTMLElement"
|
2486
|
+
},
|
2487
|
+
"description": "The button element."
|
2488
|
+
},
|
2489
|
+
{
|
2490
|
+
"name": "softDisabled",
|
2491
|
+
"optional": true,
|
2492
|
+
"type": {
|
2493
|
+
"text": "boolean"
|
2494
|
+
},
|
2495
|
+
"description": "The soft-disabled state."
|
2496
|
+
}
|
2497
|
+
],
|
2498
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
2499
|
+
"inheritedFrom": {
|
2500
|
+
"name": "Buttonsimple",
|
2501
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2502
|
+
}
|
2281
2503
|
},
|
2282
2504
|
{
|
2283
|
-
"
|
2284
|
-
"name": "
|
2285
|
-
"
|
2505
|
+
"kind": "method",
|
2506
|
+
"name": "setDisabled",
|
2507
|
+
"privacy": "private",
|
2508
|
+
"parameters": [
|
2509
|
+
{
|
2510
|
+
"name": "element",
|
2511
|
+
"type": {
|
2512
|
+
"text": "HTMLElement"
|
2513
|
+
},
|
2514
|
+
"description": "The button element."
|
2515
|
+
},
|
2516
|
+
{
|
2517
|
+
"name": "disabled",
|
2518
|
+
"type": {
|
2519
|
+
"text": "boolean"
|
2520
|
+
},
|
2521
|
+
"description": "The disabled state."
|
2522
|
+
}
|
2523
|
+
],
|
2524
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
2286
2525
|
"inheritedFrom": {
|
2287
|
-
"name": "
|
2288
|
-
"module": "
|
2526
|
+
"name": "Buttonsimple",
|
2527
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2528
|
+
}
|
2529
|
+
},
|
2530
|
+
{
|
2531
|
+
"kind": "method",
|
2532
|
+
"name": "triggerClickEvent",
|
2533
|
+
"privacy": "private",
|
2534
|
+
"inheritedFrom": {
|
2535
|
+
"name": "Buttonsimple",
|
2536
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2537
|
+
}
|
2538
|
+
},
|
2539
|
+
{
|
2540
|
+
"kind": "method",
|
2541
|
+
"name": "handleBlur",
|
2542
|
+
"privacy": "private",
|
2543
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
2544
|
+
"inheritedFrom": {
|
2545
|
+
"name": "Buttonsimple",
|
2546
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2547
|
+
}
|
2548
|
+
},
|
2549
|
+
{
|
2550
|
+
"kind": "method",
|
2551
|
+
"name": "handleKeyDown",
|
2552
|
+
"privacy": "private",
|
2553
|
+
"parameters": [
|
2554
|
+
{
|
2555
|
+
"name": "event",
|
2556
|
+
"type": {
|
2557
|
+
"text": "KeyboardEvent"
|
2558
|
+
},
|
2559
|
+
"description": "The keyboard event."
|
2560
|
+
}
|
2561
|
+
],
|
2562
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
2563
|
+
"inheritedFrom": {
|
2564
|
+
"name": "Buttonsimple",
|
2565
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2566
|
+
}
|
2567
|
+
},
|
2568
|
+
{
|
2569
|
+
"kind": "method",
|
2570
|
+
"name": "handleKeyUp",
|
2571
|
+
"privacy": "private",
|
2572
|
+
"parameters": [
|
2573
|
+
{
|
2574
|
+
"name": "event",
|
2575
|
+
"type": {
|
2576
|
+
"text": "KeyboardEvent"
|
2577
|
+
},
|
2578
|
+
"description": "The keyboard event."
|
2579
|
+
}
|
2580
|
+
],
|
2581
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
2582
|
+
"inheritedFrom": {
|
2583
|
+
"name": "Buttonsimple",
|
2584
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2289
2585
|
}
|
2290
2586
|
}
|
2291
2587
|
],
|
@@ -2293,20 +2589,37 @@
|
|
2293
2589
|
{
|
2294
2590
|
"name": "size",
|
2295
2591
|
"type": {
|
2296
|
-
"text": "
|
2592
|
+
"text": "ButtonSize"
|
2297
2593
|
},
|
2298
|
-
"description": "
|
2594
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2299
2595
|
"default": "32",
|
2300
|
-
"fieldName": "size"
|
2596
|
+
"fieldName": "size",
|
2597
|
+
"inheritedFrom": {
|
2598
|
+
"name": "Buttonsimple",
|
2599
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2600
|
+
}
|
2301
2601
|
},
|
2302
2602
|
{
|
2303
|
-
"name": "
|
2603
|
+
"name": "inverted",
|
2304
2604
|
"type": {
|
2305
|
-
"text": "boolean
|
2605
|
+
"text": "boolean"
|
2306
2606
|
},
|
2307
|
-
"description": "
|
2308
|
-
"default": "
|
2309
|
-
"fieldName": "
|
2607
|
+
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
2608
|
+
"default": "false",
|
2609
|
+
"fieldName": "inverted"
|
2610
|
+
},
|
2611
|
+
{
|
2612
|
+
"name": "role",
|
2613
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2614
|
+
"default": "'button'",
|
2615
|
+
"fieldName": "role",
|
2616
|
+
"type": {
|
2617
|
+
"text": "string"
|
2618
|
+
},
|
2619
|
+
"inheritedFrom": {
|
2620
|
+
"name": "Buttonsimple",
|
2621
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2622
|
+
}
|
2310
2623
|
},
|
2311
2624
|
{
|
2312
2625
|
"name": "prefix-icon",
|
@@ -2358,19 +2671,6 @@
|
|
2358
2671
|
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2359
2672
|
}
|
2360
2673
|
},
|
2361
|
-
{
|
2362
|
-
"name": "disabled",
|
2363
|
-
"type": {
|
2364
|
-
"text": "boolean | undefined"
|
2365
|
-
},
|
2366
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2367
|
-
"default": "undefined",
|
2368
|
-
"fieldName": "disabled",
|
2369
|
-
"inheritedFrom": {
|
2370
|
-
"name": "DisabledMixin",
|
2371
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
2372
|
-
}
|
2373
|
-
},
|
2374
2674
|
{
|
2375
2675
|
"name": "tabIndex",
|
2376
2676
|
"type": {
|
@@ -2385,67 +2685,68 @@
|
|
2385
2685
|
}
|
2386
2686
|
},
|
2387
2687
|
{
|
2388
|
-
"name": "
|
2688
|
+
"name": "disabled",
|
2389
2689
|
"type": {
|
2390
|
-
"text": "boolean"
|
2690
|
+
"text": "boolean | undefined"
|
2391
2691
|
},
|
2392
|
-
"description": "
|
2393
|
-
"default": "
|
2394
|
-
"fieldName": "
|
2692
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2693
|
+
"default": "undefined",
|
2694
|
+
"fieldName": "disabled",
|
2395
2695
|
"inheritedFrom": {
|
2396
|
-
"name": "
|
2397
|
-
"module": "src/
|
2696
|
+
"name": "DisabledMixin",
|
2697
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2398
2698
|
}
|
2399
2699
|
},
|
2400
2700
|
{
|
2401
|
-
"name": "
|
2701
|
+
"name": "active",
|
2402
2702
|
"type": {
|
2403
|
-
"text": "boolean"
|
2703
|
+
"text": "boolean | undefined"
|
2404
2704
|
},
|
2405
|
-
"description": "The
|
2406
|
-
"default": "
|
2407
|
-
"fieldName": "
|
2705
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2706
|
+
"default": "undefined",
|
2707
|
+
"fieldName": "active",
|
2408
2708
|
"inheritedFrom": {
|
2409
|
-
"name": "
|
2410
|
-
"module": "src/components/
|
2709
|
+
"name": "Buttonsimple",
|
2710
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2411
2711
|
}
|
2412
2712
|
},
|
2413
2713
|
{
|
2414
|
-
"name": "
|
2714
|
+
"name": "soft-disabled",
|
2415
2715
|
"type": {
|
2416
|
-
"text": "
|
2716
|
+
"text": "boolean | undefined"
|
2417
2717
|
},
|
2418
|
-
"
|
2419
|
-
"
|
2420
|
-
"fieldName": "
|
2718
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2719
|
+
"default": "undefined",
|
2720
|
+
"fieldName": "softDisabled",
|
2421
2721
|
"inheritedFrom": {
|
2422
|
-
"name": "
|
2423
|
-
"module": "src/components/
|
2722
|
+
"name": "Buttonsimple",
|
2723
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2424
2724
|
}
|
2425
2725
|
},
|
2426
2726
|
{
|
2427
|
-
"name": "
|
2727
|
+
"name": "ariaStateKey",
|
2428
2728
|
"type": {
|
2429
|
-
"text": "string"
|
2729
|
+
"text": "string | undefined"
|
2430
2730
|
},
|
2431
|
-
"
|
2432
|
-
"
|
2433
|
-
"fieldName": "
|
2731
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2732
|
+
"default": "'aria-pressed' (when)",
|
2733
|
+
"fieldName": "ariaStateKey",
|
2434
2734
|
"inheritedFrom": {
|
2435
|
-
"name": "
|
2436
|
-
"module": "src/components/
|
2735
|
+
"name": "Buttonsimple",
|
2736
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2437
2737
|
}
|
2438
2738
|
},
|
2439
2739
|
{
|
2440
|
-
"name": "
|
2740
|
+
"name": "type",
|
2441
2741
|
"type": {
|
2442
|
-
"text": "
|
2742
|
+
"text": "ButtonType"
|
2443
2743
|
},
|
2444
|
-
"description": "
|
2445
|
-
"
|
2744
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2745
|
+
"default": "button",
|
2746
|
+
"fieldName": "type",
|
2446
2747
|
"inheritedFrom": {
|
2447
|
-
"name": "
|
2448
|
-
"module": "src/components/
|
2748
|
+
"name": "Buttonsimple",
|
2749
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2449
2750
|
}
|
2450
2751
|
}
|
2451
2752
|
],
|
@@ -2456,83 +2757,47 @@
|
|
2456
2757
|
}
|
2457
2758
|
],
|
2458
2759
|
"superclass": {
|
2459
|
-
"name": "
|
2460
|
-
"module": "/src/components/
|
2760
|
+
"name": "Buttonsimple",
|
2761
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2461
2762
|
},
|
2462
|
-
"tagName": "mdc-
|
2463
|
-
"jsDoc": "/**\n * `mdc-
|
2763
|
+
"tagName": "mdc-button",
|
2764
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2464
2765
|
"customElement": true,
|
2465
|
-
"
|
2466
|
-
{
|
2467
|
-
"description": "Border radius of the link.",
|
2468
|
-
"name": "--mdc-link-border-radius",
|
2469
|
-
"inheritedFrom": {
|
2470
|
-
"name": "Linksimple",
|
2471
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
2472
|
-
}
|
2473
|
-
},
|
2474
|
-
{
|
2475
|
-
"description": "Color of the link’s child content in the active state.",
|
2476
|
-
"name": "--mdc-link-color-active",
|
2477
|
-
"inheritedFrom": {
|
2478
|
-
"name": "Linksimple",
|
2479
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
2480
|
-
}
|
2481
|
-
},
|
2482
|
-
{
|
2483
|
-
"description": "Color of the link’s child content in the disabled state.",
|
2484
|
-
"name": "--mdc-link-color-disabled",
|
2485
|
-
"inheritedFrom": {
|
2486
|
-
"name": "Linksimple",
|
2487
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
2488
|
-
}
|
2489
|
-
},
|
2490
|
-
{
|
2491
|
-
"description": "Color of the link’s child content in the hover state.",
|
2492
|
-
"name": "--mdc-link-color-hover",
|
2493
|
-
"inheritedFrom": {
|
2494
|
-
"name": "Linksimple",
|
2495
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
2496
|
-
}
|
2497
|
-
},
|
2498
|
-
{
|
2499
|
-
"description": "Color of the link’s child content in the normal state.",
|
2500
|
-
"name": "--mdc-link-color-normal",
|
2501
|
-
"inheritedFrom": {
|
2502
|
-
"name": "Linksimple",
|
2503
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
2504
|
-
}
|
2505
|
-
},
|
2766
|
+
"events": [
|
2506
2767
|
{
|
2507
|
-
"description": "
|
2508
|
-
"name": "
|
2768
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2769
|
+
"name": "click",
|
2770
|
+
"reactName": "onClick",
|
2509
2771
|
"inheritedFrom": {
|
2510
|
-
"name": "
|
2511
|
-
"module": "src/components/
|
2772
|
+
"name": "Buttonsimple",
|
2773
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2512
2774
|
}
|
2513
2775
|
},
|
2514
2776
|
{
|
2515
|
-
"description": "
|
2516
|
-
"name": "
|
2777
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2778
|
+
"name": "keydown",
|
2779
|
+
"reactName": "onKeyDown",
|
2517
2780
|
"inheritedFrom": {
|
2518
|
-
"name": "
|
2519
|
-
"module": "src/components/
|
2781
|
+
"name": "Buttonsimple",
|
2782
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2520
2783
|
}
|
2521
2784
|
},
|
2522
2785
|
{
|
2523
|
-
"description": "
|
2524
|
-
"name": "
|
2786
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2787
|
+
"name": "keyup",
|
2788
|
+
"reactName": "onKeyUp",
|
2525
2789
|
"inheritedFrom": {
|
2526
|
-
"name": "
|
2527
|
-
"module": "src/components/
|
2790
|
+
"name": "Buttonsimple",
|
2791
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2528
2792
|
}
|
2529
2793
|
},
|
2530
2794
|
{
|
2531
|
-
"description": "
|
2532
|
-
"name": "
|
2795
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2796
|
+
"name": "focus",
|
2797
|
+
"reactName": "onFocus",
|
2533
2798
|
"inheritedFrom": {
|
2534
|
-
"name": "
|
2535
|
-
"module": "src/components/
|
2799
|
+
"name": "Buttonsimple",
|
2800
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2536
2801
|
}
|
2537
2802
|
}
|
2538
2803
|
]
|
@@ -2543,83 +2808,65 @@
|
|
2543
2808
|
"kind": "js",
|
2544
2809
|
"name": "default",
|
2545
2810
|
"declaration": {
|
2546
|
-
"name": "
|
2547
|
-
"module": "components/
|
2811
|
+
"name": "Button",
|
2812
|
+
"module": "components/button/button.component.js"
|
2548
2813
|
}
|
2549
2814
|
}
|
2550
2815
|
]
|
2551
2816
|
},
|
2552
2817
|
{
|
2553
2818
|
"kind": "javascript-module",
|
2554
|
-
"path": "components/
|
2555
|
-
"declarations": [
|
2556
|
-
{
|
2557
|
-
"kind": "class",
|
2558
|
-
"description": "`mdc-
|
2559
|
-
"name": "
|
2560
|
-
"
|
2561
|
-
{
|
2562
|
-
"description": "Text label of the button.",
|
2563
|
-
"name": ""
|
2564
|
-
}
|
2565
|
-
],
|
2566
|
-
"members": [
|
2567
|
-
{
|
2568
|
-
"kind": "field",
|
2569
|
-
"name": "size",
|
2570
|
-
"type": {
|
2571
|
-
"text": "ButtonSize"
|
2572
|
-
},
|
2573
|
-
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2574
|
-
"default": "32",
|
2575
|
-
"attribute": "size",
|
2576
|
-
"reflects": true,
|
2577
|
-
"inheritedFrom": {
|
2578
|
-
"name": "Buttonsimple",
|
2579
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2580
|
-
}
|
2581
|
-
},
|
2819
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
2820
|
+
"declarations": [
|
2821
|
+
{
|
2822
|
+
"kind": "class",
|
2823
|
+
"description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
|
2824
|
+
"name": "ButtonLink",
|
2825
|
+
"members": [
|
2582
2826
|
{
|
2583
2827
|
"kind": "field",
|
2584
|
-
"name": "
|
2828
|
+
"name": "size",
|
2585
2829
|
"type": {
|
2586
|
-
"text": "
|
2830
|
+
"text": "PillButtonSize | IconButtonSize"
|
2587
2831
|
},
|
2588
|
-
"description": "
|
2589
|
-
"default": "
|
2590
|
-
"attribute": "
|
2832
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n - **Pill buttonlink**: 40, 32, 28, 24.\n - **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n - Tertiary icon buttonlink can also be 20.",
|
2833
|
+
"default": "32",
|
2834
|
+
"attribute": "size",
|
2591
2835
|
"reflects": true
|
2592
2836
|
},
|
2593
2837
|
{
|
2594
2838
|
"kind": "field",
|
2595
|
-
"name": "
|
2596
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2597
|
-
"default": "'button'",
|
2598
|
-
"attribute": "role",
|
2599
|
-
"reflects": true,
|
2839
|
+
"name": "softDisabled",
|
2600
2840
|
"type": {
|
2601
|
-
"text": "
|
2841
|
+
"text": "boolean | undefined"
|
2602
2842
|
},
|
2603
|
-
"
|
2604
|
-
|
2605
|
-
|
2606
|
-
|
2843
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2844
|
+
"default": "undefined",
|
2845
|
+
"attribute": "soft-disabled",
|
2846
|
+
"reflects": true
|
2607
2847
|
},
|
2608
2848
|
{
|
2609
2849
|
"kind": "method",
|
2610
|
-
"name": "
|
2850
|
+
"name": "setSoftDisabled",
|
2611
2851
|
"privacy": "private",
|
2612
2852
|
"parameters": [
|
2613
2853
|
{
|
2614
|
-
"name": "
|
2854
|
+
"name": "element",
|
2855
|
+
"type": {
|
2856
|
+
"text": "HTMLElement"
|
2857
|
+
},
|
2858
|
+
"description": "The buttonlink element."
|
2859
|
+
},
|
2860
|
+
{
|
2861
|
+
"name": "softDisabled",
|
2615
2862
|
"optional": true,
|
2616
2863
|
"type": {
|
2617
2864
|
"text": "boolean"
|
2618
2865
|
},
|
2619
|
-
"description": "The
|
2866
|
+
"description": "The soft-disabled state."
|
2620
2867
|
}
|
2621
2868
|
],
|
2622
|
-
"description": "
|
2869
|
+
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
2623
2870
|
},
|
2624
2871
|
{
|
2625
2872
|
"kind": "field",
|
@@ -2750,21 +2997,6 @@
|
|
2750
2997
|
"module": "utils/mixins/ButtonComponentMixin.js"
|
2751
2998
|
}
|
2752
2999
|
},
|
2753
|
-
{
|
2754
|
-
"kind": "field",
|
2755
|
-
"name": "tabIndex",
|
2756
|
-
"type": {
|
2757
|
-
"text": "number"
|
2758
|
-
},
|
2759
|
-
"default": "0",
|
2760
|
-
"description": "This property specifies the tab order of the element.",
|
2761
|
-
"attribute": "tabIndex",
|
2762
|
-
"reflects": true,
|
2763
|
-
"inheritedFrom": {
|
2764
|
-
"name": "TabIndexMixin",
|
2765
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
2766
|
-
}
|
2767
|
-
},
|
2768
3000
|
{
|
2769
3001
|
"kind": "field",
|
2770
3002
|
"name": "disabled",
|
@@ -2782,246 +3014,178 @@
|
|
2782
3014
|
},
|
2783
3015
|
{
|
2784
3016
|
"kind": "field",
|
2785
|
-
"name": "
|
3017
|
+
"name": "tabIndex",
|
2786
3018
|
"type": {
|
2787
|
-
"text": "
|
3019
|
+
"text": "number"
|
2788
3020
|
},
|
2789
|
-
"
|
2790
|
-
"
|
2791
|
-
"attribute": "
|
3021
|
+
"default": "0",
|
3022
|
+
"description": "This property specifies the tab order of the element.",
|
3023
|
+
"attribute": "tabIndex",
|
2792
3024
|
"reflects": true,
|
2793
3025
|
"inheritedFrom": {
|
2794
|
-
"name": "
|
2795
|
-
"module": "
|
3026
|
+
"name": "TabIndexMixin",
|
3027
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2796
3028
|
}
|
2797
3029
|
},
|
2798
3030
|
{
|
2799
3031
|
"kind": "field",
|
2800
|
-
"name": "
|
3032
|
+
"name": "inline",
|
2801
3033
|
"type": {
|
2802
|
-
"text": "boolean
|
3034
|
+
"text": "boolean"
|
2803
3035
|
},
|
2804
|
-
"description": "
|
2805
|
-
"default": "
|
2806
|
-
"attribute": "
|
3036
|
+
"description": "The link can be inline or standalone.",
|
3037
|
+
"default": "false",
|
3038
|
+
"attribute": "inline",
|
2807
3039
|
"reflects": true,
|
2808
3040
|
"inheritedFrom": {
|
2809
|
-
"name": "
|
2810
|
-
"module": "components/
|
3041
|
+
"name": "Linksimple",
|
3042
|
+
"module": "components/linksimple/linksimple.component.js"
|
2811
3043
|
}
|
2812
3044
|
},
|
2813
3045
|
{
|
2814
3046
|
"kind": "field",
|
2815
|
-
"name": "
|
3047
|
+
"name": "inverted",
|
2816
3048
|
"type": {
|
2817
|
-
"text": "
|
3049
|
+
"text": "boolean"
|
2818
3050
|
},
|
2819
|
-
"description": "
|
2820
|
-
"default": "
|
2821
|
-
"attribute": "
|
3051
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3052
|
+
"default": "false",
|
3053
|
+
"attribute": "inverted",
|
2822
3054
|
"reflects": true,
|
2823
3055
|
"inheritedFrom": {
|
2824
|
-
"name": "
|
2825
|
-
"module": "components/
|
3056
|
+
"name": "Linksimple",
|
3057
|
+
"module": "components/linksimple/linksimple.component.js"
|
2826
3058
|
}
|
2827
3059
|
},
|
2828
3060
|
{
|
2829
3061
|
"kind": "field",
|
2830
|
-
"name": "
|
3062
|
+
"name": "href",
|
2831
3063
|
"type": {
|
2832
|
-
"text": "
|
3064
|
+
"text": "string"
|
2833
3065
|
},
|
2834
|
-
"
|
2835
|
-
"
|
2836
|
-
"attribute": "
|
3066
|
+
"default": "'#'",
|
3067
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
3068
|
+
"attribute": "href",
|
2837
3069
|
"reflects": true,
|
2838
3070
|
"inheritedFrom": {
|
2839
|
-
"name": "
|
2840
|
-
"module": "components/
|
2841
|
-
}
|
2842
|
-
},
|
2843
|
-
{
|
2844
|
-
"kind": "method",
|
2845
|
-
"name": "executeAction",
|
2846
|
-
"privacy": "protected",
|
2847
|
-
"inheritedFrom": {
|
2848
|
-
"name": "Buttonsimple",
|
2849
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2850
|
-
}
|
2851
|
-
},
|
2852
|
-
{
|
2853
|
-
"kind": "method",
|
2854
|
-
"name": "setActive",
|
2855
|
-
"privacy": "protected",
|
2856
|
-
"parameters": [
|
2857
|
-
{
|
2858
|
-
"name": "element",
|
2859
|
-
"type": {
|
2860
|
-
"text": "HTMLElement"
|
2861
|
-
},
|
2862
|
-
"description": "The button element"
|
2863
|
-
},
|
2864
|
-
{
|
2865
|
-
"name": "active",
|
2866
|
-
"optional": true,
|
2867
|
-
"type": {
|
2868
|
-
"text": "boolean"
|
2869
|
-
},
|
2870
|
-
"description": "The active state of the element"
|
2871
|
-
}
|
2872
|
-
],
|
2873
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2874
|
-
"inheritedFrom": {
|
2875
|
-
"name": "Buttonsimple",
|
2876
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2877
|
-
}
|
2878
|
-
},
|
2879
|
-
{
|
2880
|
-
"kind": "method",
|
2881
|
-
"name": "setSoftDisabled",
|
2882
|
-
"privacy": "private",
|
2883
|
-
"parameters": [
|
2884
|
-
{
|
2885
|
-
"name": "element",
|
2886
|
-
"type": {
|
2887
|
-
"text": "HTMLElement"
|
2888
|
-
},
|
2889
|
-
"description": "The button element."
|
2890
|
-
},
|
2891
|
-
{
|
2892
|
-
"name": "softDisabled",
|
2893
|
-
"optional": true,
|
2894
|
-
"type": {
|
2895
|
-
"text": "boolean"
|
2896
|
-
},
|
2897
|
-
"description": "The soft-disabled state."
|
2898
|
-
}
|
2899
|
-
],
|
2900
|
-
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
2901
|
-
"inheritedFrom": {
|
2902
|
-
"name": "Buttonsimple",
|
2903
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2904
|
-
}
|
2905
|
-
},
|
2906
|
-
{
|
2907
|
-
"kind": "method",
|
2908
|
-
"name": "setDisabled",
|
2909
|
-
"privacy": "private",
|
2910
|
-
"parameters": [
|
2911
|
-
{
|
2912
|
-
"name": "element",
|
2913
|
-
"type": {
|
2914
|
-
"text": "HTMLElement"
|
2915
|
-
},
|
2916
|
-
"description": "The button element."
|
2917
|
-
},
|
2918
|
-
{
|
2919
|
-
"name": "disabled",
|
2920
|
-
"type": {
|
2921
|
-
"text": "boolean"
|
2922
|
-
},
|
2923
|
-
"description": "The disabled state."
|
2924
|
-
}
|
2925
|
-
],
|
2926
|
-
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
2927
|
-
"inheritedFrom": {
|
2928
|
-
"name": "Buttonsimple",
|
2929
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
3071
|
+
"name": "Linksimple",
|
3072
|
+
"module": "components/linksimple/linksimple.component.js"
|
2930
3073
|
}
|
2931
3074
|
},
|
2932
3075
|
{
|
2933
|
-
"kind": "
|
2934
|
-
"name": "
|
2935
|
-
"
|
3076
|
+
"kind": "field",
|
3077
|
+
"name": "target",
|
3078
|
+
"type": {
|
3079
|
+
"text": "string"
|
3080
|
+
},
|
3081
|
+
"default": "'_self'",
|
3082
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
3083
|
+
"attribute": "target",
|
3084
|
+
"reflects": true,
|
2936
3085
|
"inheritedFrom": {
|
2937
|
-
"name": "
|
2938
|
-
"module": "components/
|
3086
|
+
"name": "Linksimple",
|
3087
|
+
"module": "components/linksimple/linksimple.component.js"
|
2939
3088
|
}
|
2940
3089
|
},
|
2941
3090
|
{
|
2942
|
-
"kind": "
|
2943
|
-
"name": "
|
2944
|
-
"
|
2945
|
-
|
3091
|
+
"kind": "field",
|
3092
|
+
"name": "rel",
|
3093
|
+
"type": {
|
3094
|
+
"text": "string | undefined"
|
3095
|
+
},
|
3096
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
3097
|
+
"attribute": "rel",
|
3098
|
+
"reflects": true,
|
2946
3099
|
"inheritedFrom": {
|
2947
|
-
"name": "
|
2948
|
-
"module": "components/
|
3100
|
+
"name": "Linksimple",
|
3101
|
+
"module": "components/linksimple/linksimple.component.js"
|
2949
3102
|
}
|
2950
3103
|
},
|
2951
3104
|
{
|
2952
|
-
"kind": "
|
2953
|
-
"name": "
|
3105
|
+
"kind": "field",
|
3106
|
+
"name": "handleNavigation",
|
2954
3107
|
"privacy": "private",
|
2955
|
-
"parameters": [
|
2956
|
-
{
|
2957
|
-
"name": "event",
|
2958
|
-
"type": {
|
2959
|
-
"text": "KeyboardEvent"
|
2960
|
-
},
|
2961
|
-
"description": "The keyboard event."
|
2962
|
-
}
|
2963
|
-
],
|
2964
|
-
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
2965
3108
|
"inheritedFrom": {
|
2966
|
-
"name": "
|
2967
|
-
"module": "components/
|
3109
|
+
"name": "Linksimple",
|
3110
|
+
"module": "components/linksimple/linksimple.component.js"
|
2968
3111
|
}
|
2969
3112
|
},
|
2970
3113
|
{
|
2971
3114
|
"kind": "method",
|
2972
|
-
"name": "
|
3115
|
+
"name": "setDisabled",
|
2973
3116
|
"privacy": "private",
|
2974
3117
|
"parameters": [
|
2975
3118
|
{
|
2976
|
-
"name": "
|
3119
|
+
"name": "disabled",
|
2977
3120
|
"type": {
|
2978
|
-
"text": "
|
3121
|
+
"text": "boolean"
|
2979
3122
|
},
|
2980
|
-
"description": "
|
3123
|
+
"description": "Whether the element should be disabled"
|
2981
3124
|
}
|
2982
3125
|
],
|
2983
|
-
"description": "
|
3126
|
+
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored.",
|
2984
3127
|
"inheritedFrom": {
|
2985
|
-
"name": "
|
2986
|
-
"module": "components/
|
3128
|
+
"name": "Linksimple",
|
3129
|
+
"module": "components/linksimple/linksimple.component.js"
|
2987
3130
|
}
|
2988
3131
|
}
|
2989
3132
|
],
|
2990
|
-
"
|
3133
|
+
"events": [
|
2991
3134
|
{
|
2992
|
-
"
|
2993
|
-
"
|
2994
|
-
|
2995
|
-
},
|
2996
|
-
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2997
|
-
"default": "32",
|
2998
|
-
"fieldName": "size",
|
3135
|
+
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
3136
|
+
"name": "click",
|
3137
|
+
"reactName": "onClick",
|
2999
3138
|
"inheritedFrom": {
|
3000
|
-
"name": "
|
3001
|
-
"module": "src/components/
|
3139
|
+
"name": "Linksimple",
|
3140
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3002
3141
|
}
|
3003
3142
|
},
|
3004
3143
|
{
|
3005
|
-
"
|
3144
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
3145
|
+
"name": "keydown",
|
3146
|
+
"reactName": "onKeyDown",
|
3147
|
+
"inheritedFrom": {
|
3148
|
+
"name": "Linksimple",
|
3149
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3150
|
+
}
|
3151
|
+
},
|
3152
|
+
{
|
3153
|
+
"description": "(React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.",
|
3154
|
+
"name": "focus",
|
3155
|
+
"reactName": "onFocus",
|
3156
|
+
"inheritedFrom": {
|
3157
|
+
"name": "Linksimple",
|
3158
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3159
|
+
}
|
3160
|
+
},
|
3161
|
+
{
|
3162
|
+
"description": "(React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.",
|
3163
|
+
"name": "blur",
|
3164
|
+
"reactName": "onBlur",
|
3165
|
+
"inheritedFrom": {
|
3166
|
+
"name": "Linksimple",
|
3167
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3168
|
+
}
|
3169
|
+
}
|
3170
|
+
],
|
3171
|
+
"attributes": [
|
3172
|
+
{
|
3173
|
+
"name": "size",
|
3006
3174
|
"type": {
|
3007
|
-
"text": "
|
3175
|
+
"text": "PillButtonSize | IconButtonSize"
|
3008
3176
|
},
|
3009
|
-
"description": "
|
3010
|
-
"default": "
|
3011
|
-
"fieldName": "
|
3177
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n - **Pill buttonlink**: 40, 32, 28, 24.\n - **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n - Tertiary icon buttonlink can also be 20.",
|
3178
|
+
"default": "32",
|
3179
|
+
"fieldName": "size"
|
3012
3180
|
},
|
3013
3181
|
{
|
3014
|
-
"name": "
|
3015
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
3016
|
-
"default": "'button'",
|
3017
|
-
"fieldName": "role",
|
3182
|
+
"name": "soft-disabled",
|
3018
3183
|
"type": {
|
3019
|
-
"text": "
|
3184
|
+
"text": "boolean | undefined"
|
3020
3185
|
},
|
3021
|
-
"
|
3022
|
-
|
3023
|
-
|
3024
|
-
}
|
3186
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
3187
|
+
"default": "undefined",
|
3188
|
+
"fieldName": "softDisabled"
|
3025
3189
|
},
|
3026
3190
|
{
|
3027
3191
|
"name": "prefix-icon",
|
@@ -3073,6 +3237,19 @@
|
|
3073
3237
|
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
3074
3238
|
}
|
3075
3239
|
},
|
3240
|
+
{
|
3241
|
+
"name": "disabled",
|
3242
|
+
"type": {
|
3243
|
+
"text": "boolean | undefined"
|
3244
|
+
},
|
3245
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3246
|
+
"default": "undefined",
|
3247
|
+
"fieldName": "disabled",
|
3248
|
+
"inheritedFrom": {
|
3249
|
+
"name": "DisabledMixin",
|
3250
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
3251
|
+
}
|
3252
|
+
},
|
3076
3253
|
{
|
3077
3254
|
"name": "tabIndex",
|
3078
3255
|
"type": {
|
@@ -3087,68 +3264,67 @@
|
|
3087
3264
|
}
|
3088
3265
|
},
|
3089
3266
|
{
|
3090
|
-
"name": "
|
3267
|
+
"name": "inline",
|
3091
3268
|
"type": {
|
3092
|
-
"text": "boolean
|
3269
|
+
"text": "boolean"
|
3093
3270
|
},
|
3094
|
-
"description": "
|
3095
|
-
"default": "
|
3096
|
-
"fieldName": "
|
3271
|
+
"description": "The link can be inline or standalone.",
|
3272
|
+
"default": "false",
|
3273
|
+
"fieldName": "inline",
|
3097
3274
|
"inheritedFrom": {
|
3098
|
-
"name": "
|
3099
|
-
"module": "src/
|
3275
|
+
"name": "Linksimple",
|
3276
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3100
3277
|
}
|
3101
3278
|
},
|
3102
3279
|
{
|
3103
|
-
"name": "
|
3280
|
+
"name": "inverted",
|
3104
3281
|
"type": {
|
3105
|
-
"text": "boolean
|
3282
|
+
"text": "boolean"
|
3106
3283
|
},
|
3107
|
-
"description": "The
|
3108
|
-
"default": "
|
3109
|
-
"fieldName": "
|
3284
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3285
|
+
"default": "false",
|
3286
|
+
"fieldName": "inverted",
|
3110
3287
|
"inheritedFrom": {
|
3111
|
-
"name": "
|
3112
|
-
"module": "src/components/
|
3288
|
+
"name": "Linksimple",
|
3289
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3113
3290
|
}
|
3114
3291
|
},
|
3115
3292
|
{
|
3116
|
-
"name": "
|
3293
|
+
"name": "href",
|
3117
3294
|
"type": {
|
3118
|
-
"text": "
|
3295
|
+
"text": "string"
|
3119
3296
|
},
|
3120
|
-
"
|
3121
|
-
"
|
3122
|
-
"fieldName": "
|
3297
|
+
"default": "'#'",
|
3298
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
3299
|
+
"fieldName": "href",
|
3123
3300
|
"inheritedFrom": {
|
3124
|
-
"name": "
|
3125
|
-
"module": "src/components/
|
3301
|
+
"name": "Linksimple",
|
3302
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3126
3303
|
}
|
3127
3304
|
},
|
3128
3305
|
{
|
3129
|
-
"name": "
|
3306
|
+
"name": "target",
|
3130
3307
|
"type": {
|
3131
|
-
"text": "string
|
3308
|
+
"text": "string"
|
3132
3309
|
},
|
3133
|
-
"
|
3134
|
-
"
|
3135
|
-
"fieldName": "
|
3310
|
+
"default": "'_self'",
|
3311
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
3312
|
+
"fieldName": "target",
|
3136
3313
|
"inheritedFrom": {
|
3137
|
-
"name": "
|
3138
|
-
"module": "src/components/
|
3314
|
+
"name": "Linksimple",
|
3315
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3139
3316
|
}
|
3140
3317
|
},
|
3141
3318
|
{
|
3142
|
-
"name": "
|
3319
|
+
"name": "rel",
|
3143
3320
|
"type": {
|
3144
|
-
"text": "
|
3321
|
+
"text": "string | undefined"
|
3145
3322
|
},
|
3146
|
-
"description": "
|
3147
|
-
"
|
3148
|
-
"fieldName": "type",
|
3323
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
3324
|
+
"fieldName": "rel",
|
3149
3325
|
"inheritedFrom": {
|
3150
|
-
"name": "
|
3151
|
-
"module": "src/components/
|
3326
|
+
"name": "Linksimple",
|
3327
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3152
3328
|
}
|
3153
3329
|
}
|
3154
3330
|
],
|
@@ -3159,47 +3335,83 @@
|
|
3159
3335
|
}
|
3160
3336
|
],
|
3161
3337
|
"superclass": {
|
3162
|
-
"name": "
|
3163
|
-
"module": "/src/components/
|
3338
|
+
"name": "Linksimple",
|
3339
|
+
"module": "/src/components/linksimple/linksimple.component"
|
3164
3340
|
},
|
3165
|
-
"tagName": "mdc-
|
3166
|
-
"jsDoc": "/**\n * `mdc-
|
3341
|
+
"tagName": "mdc-buttonlink",
|
3342
|
+
"jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n */",
|
3167
3343
|
"customElement": true,
|
3168
|
-
"
|
3344
|
+
"cssProperties": [
|
3169
3345
|
{
|
3170
|
-
"description": "
|
3171
|
-
"name": "
|
3172
|
-
"reactName": "onClick",
|
3346
|
+
"description": "Border radius of the link.",
|
3347
|
+
"name": "--mdc-link-border-radius",
|
3173
3348
|
"inheritedFrom": {
|
3174
|
-
"name": "
|
3175
|
-
"module": "src/components/
|
3349
|
+
"name": "Linksimple",
|
3350
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3176
3351
|
}
|
3177
3352
|
},
|
3178
3353
|
{
|
3179
|
-
"description": "
|
3180
|
-
"name": "
|
3181
|
-
"reactName": "onKeyDown",
|
3354
|
+
"description": "Color of the link’s child content in the active state.",
|
3355
|
+
"name": "--mdc-link-color-active",
|
3182
3356
|
"inheritedFrom": {
|
3183
|
-
"name": "
|
3184
|
-
"module": "src/components/
|
3357
|
+
"name": "Linksimple",
|
3358
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3185
3359
|
}
|
3186
3360
|
},
|
3187
3361
|
{
|
3188
|
-
"description": "
|
3189
|
-
"name": "
|
3190
|
-
"reactName": "onKeyUp",
|
3362
|
+
"description": "Color of the link’s child content in the disabled state.",
|
3363
|
+
"name": "--mdc-link-color-disabled",
|
3191
3364
|
"inheritedFrom": {
|
3192
|
-
"name": "
|
3193
|
-
"module": "src/components/
|
3365
|
+
"name": "Linksimple",
|
3366
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3194
3367
|
}
|
3195
3368
|
},
|
3196
3369
|
{
|
3197
|
-
"description": "
|
3198
|
-
"name": "
|
3199
|
-
"reactName": "onFocus",
|
3370
|
+
"description": "Color of the link’s child content in the hover state.",
|
3371
|
+
"name": "--mdc-link-color-hover",
|
3200
3372
|
"inheritedFrom": {
|
3201
|
-
"name": "
|
3202
|
-
"module": "src/components/
|
3373
|
+
"name": "Linksimple",
|
3374
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3375
|
+
}
|
3376
|
+
},
|
3377
|
+
{
|
3378
|
+
"description": "Color of the link’s child content in the normal state.",
|
3379
|
+
"name": "--mdc-link-color-normal",
|
3380
|
+
"inheritedFrom": {
|
3381
|
+
"name": "Linksimple",
|
3382
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3383
|
+
}
|
3384
|
+
},
|
3385
|
+
{
|
3386
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
3387
|
+
"name": "--mdc-link-inverted-color-active",
|
3388
|
+
"inheritedFrom": {
|
3389
|
+
"name": "Linksimple",
|
3390
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3391
|
+
}
|
3392
|
+
},
|
3393
|
+
{
|
3394
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
3395
|
+
"name": "--mdc-link-inverted-color-disabled",
|
3396
|
+
"inheritedFrom": {
|
3397
|
+
"name": "Linksimple",
|
3398
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3399
|
+
}
|
3400
|
+
},
|
3401
|
+
{
|
3402
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
3403
|
+
"name": "--mdc-link-inverted-color-hover",
|
3404
|
+
"inheritedFrom": {
|
3405
|
+
"name": "Linksimple",
|
3406
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3407
|
+
}
|
3408
|
+
},
|
3409
|
+
{
|
3410
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
3411
|
+
"name": "--mdc-link-inverted-color-normal",
|
3412
|
+
"inheritedFrom": {
|
3413
|
+
"name": "Linksimple",
|
3414
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3203
3415
|
}
|
3204
3416
|
}
|
3205
3417
|
]
|
@@ -3210,8 +3422,8 @@
|
|
3210
3422
|
"kind": "js",
|
3211
3423
|
"name": "default",
|
3212
3424
|
"declaration": {
|
3213
|
-
"name": "
|
3214
|
-
"module": "components/
|
3425
|
+
"name": "ButtonLink",
|
3426
|
+
"module": "components/buttonlink/buttonlink.component.js"
|
3215
3427
|
}
|
3216
3428
|
}
|
3217
3429
|
]
|