@momentum-design/components 0.93.0 → 0.94.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/custom-elements.json +1919 -1919
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
@@ -530,6 +530,218 @@
|
|
530
530
|
}
|
531
531
|
]
|
532
532
|
},
|
533
|
+
{
|
534
|
+
"kind": "javascript-module",
|
535
|
+
"path": "components/animation/animation.component.js",
|
536
|
+
"declarations": [
|
537
|
+
{
|
538
|
+
"kind": "class",
|
539
|
+
"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.",
|
540
|
+
"name": "Animation",
|
541
|
+
"members": [
|
542
|
+
{
|
543
|
+
"kind": "field",
|
544
|
+
"name": "name",
|
545
|
+
"type": {
|
546
|
+
"text": "AnimationNames | undefined"
|
547
|
+
},
|
548
|
+
"description": "Name of the animation (= filename)",
|
549
|
+
"attribute": "name",
|
550
|
+
"reflects": true
|
551
|
+
},
|
552
|
+
{
|
553
|
+
"kind": "field",
|
554
|
+
"name": "loop",
|
555
|
+
"type": {
|
556
|
+
"text": "LoopType | undefined"
|
557
|
+
},
|
558
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
559
|
+
"attribute": "loop",
|
560
|
+
"reflects": true
|
561
|
+
},
|
562
|
+
{
|
563
|
+
"kind": "field",
|
564
|
+
"name": "autoplay",
|
565
|
+
"type": {
|
566
|
+
"text": "boolean | undefined"
|
567
|
+
},
|
568
|
+
"description": "Weather start the animation automatically",
|
569
|
+
"attribute": "autoplay",
|
570
|
+
"reflects": true
|
571
|
+
},
|
572
|
+
{
|
573
|
+
"kind": "field",
|
574
|
+
"name": "ariaLabel",
|
575
|
+
"type": {
|
576
|
+
"text": "string | null"
|
577
|
+
},
|
578
|
+
"default": "null",
|
579
|
+
"description": "Aria-label attribute to be set for accessibility",
|
580
|
+
"attribute": "aria-label"
|
581
|
+
},
|
582
|
+
{
|
583
|
+
"kind": "field",
|
584
|
+
"name": "ariaLabelledBy",
|
585
|
+
"type": {
|
586
|
+
"text": "string | null"
|
587
|
+
},
|
588
|
+
"default": "null",
|
589
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
590
|
+
"attribute": "aria-labelledby"
|
591
|
+
},
|
592
|
+
{
|
593
|
+
"kind": "field",
|
594
|
+
"name": "lottieInstance",
|
595
|
+
"type": {
|
596
|
+
"text": "AnimationItem | undefined"
|
597
|
+
},
|
598
|
+
"privacy": "private",
|
599
|
+
"description": "Lottie animation instance"
|
600
|
+
},
|
601
|
+
{
|
602
|
+
"kind": "field",
|
603
|
+
"name": "containerRef",
|
604
|
+
"type": {
|
605
|
+
"text": "Ref<HTMLDivElement>"
|
606
|
+
},
|
607
|
+
"privacy": "private",
|
608
|
+
"description": "Container for the animation"
|
609
|
+
},
|
610
|
+
{
|
611
|
+
"kind": "field",
|
612
|
+
"name": "animation",
|
613
|
+
"description": "Exposed API of the animation library (lottie)",
|
614
|
+
"readonly": true
|
615
|
+
},
|
616
|
+
{
|
617
|
+
"kind": "method",
|
618
|
+
"name": "getLoopValue",
|
619
|
+
"privacy": "private"
|
620
|
+
},
|
621
|
+
{
|
622
|
+
"kind": "method",
|
623
|
+
"name": "onLoadSuccessHandler",
|
624
|
+
"privacy": "private",
|
625
|
+
"parameters": [
|
626
|
+
{
|
627
|
+
"name": "animationData",
|
628
|
+
"type": {
|
629
|
+
"text": "any"
|
630
|
+
}
|
631
|
+
}
|
632
|
+
],
|
633
|
+
"description": "Create new lotty instance for the loaded data"
|
634
|
+
},
|
635
|
+
{
|
636
|
+
"kind": "method",
|
637
|
+
"name": "onLoadFailHandler",
|
638
|
+
"privacy": "private",
|
639
|
+
"parameters": [
|
640
|
+
{
|
641
|
+
"name": "error",
|
642
|
+
"type": {
|
643
|
+
"text": "Error"
|
644
|
+
}
|
645
|
+
}
|
646
|
+
],
|
647
|
+
"description": "Error handler for animation loading"
|
648
|
+
},
|
649
|
+
{
|
650
|
+
"kind": "method",
|
651
|
+
"name": "getAnimationData",
|
652
|
+
"privacy": "private",
|
653
|
+
"description": "Import animation data dynamically"
|
654
|
+
},
|
655
|
+
{
|
656
|
+
"kind": "field",
|
657
|
+
"name": "onCompleteHandler",
|
658
|
+
"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."
|
659
|
+
}
|
660
|
+
],
|
661
|
+
"events": [
|
662
|
+
{
|
663
|
+
"name": "load",
|
664
|
+
"type": {
|
665
|
+
"text": "CustomEvent"
|
666
|
+
},
|
667
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
668
|
+
"reactName": "onLoad"
|
669
|
+
},
|
670
|
+
{
|
671
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
672
|
+
"name": "complete",
|
673
|
+
"reactName": "onComplete"
|
674
|
+
},
|
675
|
+
{
|
676
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
677
|
+
"name": "error",
|
678
|
+
"reactName": "onError"
|
679
|
+
}
|
680
|
+
],
|
681
|
+
"attributes": [
|
682
|
+
{
|
683
|
+
"name": "name",
|
684
|
+
"type": {
|
685
|
+
"text": "AnimationNames | undefined"
|
686
|
+
},
|
687
|
+
"description": "Name of the animation (= filename)",
|
688
|
+
"fieldName": "name"
|
689
|
+
},
|
690
|
+
{
|
691
|
+
"name": "loop",
|
692
|
+
"type": {
|
693
|
+
"text": "LoopType | undefined"
|
694
|
+
},
|
695
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
696
|
+
"fieldName": "loop"
|
697
|
+
},
|
698
|
+
{
|
699
|
+
"name": "autoplay",
|
700
|
+
"type": {
|
701
|
+
"text": "boolean | undefined"
|
702
|
+
},
|
703
|
+
"description": "Weather start the animation automatically",
|
704
|
+
"fieldName": "autoplay"
|
705
|
+
},
|
706
|
+
{
|
707
|
+
"name": "aria-label",
|
708
|
+
"type": {
|
709
|
+
"text": "string | null"
|
710
|
+
},
|
711
|
+
"default": "null",
|
712
|
+
"description": "Aria-label attribute to be set for accessibility",
|
713
|
+
"fieldName": "ariaLabel"
|
714
|
+
},
|
715
|
+
{
|
716
|
+
"name": "aria-labelledby",
|
717
|
+
"type": {
|
718
|
+
"text": "string | null"
|
719
|
+
},
|
720
|
+
"default": "null",
|
721
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
722
|
+
"fieldName": "ariaLabelledBy"
|
723
|
+
}
|
724
|
+
],
|
725
|
+
"superclass": {
|
726
|
+
"name": "Component",
|
727
|
+
"module": "/src/models"
|
728
|
+
},
|
729
|
+
"tagName": "mdc-animation",
|
730
|
+
"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 */",
|
731
|
+
"customElement": true
|
732
|
+
}
|
733
|
+
],
|
734
|
+
"exports": [
|
735
|
+
{
|
736
|
+
"kind": "js",
|
737
|
+
"name": "default",
|
738
|
+
"declaration": {
|
739
|
+
"name": "Animation",
|
740
|
+
"module": "components/animation/animation.component.js"
|
741
|
+
}
|
742
|
+
}
|
743
|
+
]
|
744
|
+
},
|
533
745
|
{
|
534
746
|
"kind": "javascript-module",
|
535
747
|
"path": "components/appheader/appheader.component.js",
|
@@ -859,242 +1071,30 @@
|
|
859
1071
|
},
|
860
1072
|
{
|
861
1073
|
"kind": "javascript-module",
|
862
|
-
"path": "components/
|
1074
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
863
1075
|
"declarations": [
|
864
1076
|
{
|
865
1077
|
"kind": "class",
|
866
|
-
"description": "The `mdc-
|
867
|
-
"name": "
|
868
|
-
"
|
1078
|
+
"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.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
1079
|
+
"name": "AvatarButton",
|
1080
|
+
"cssProperties": [
|
869
1081
|
{
|
870
|
-
"
|
871
|
-
"name": "
|
872
|
-
"type": {
|
873
|
-
"text": "AnimationNames | undefined"
|
874
|
-
},
|
875
|
-
"description": "Name of the animation (= filename)",
|
876
|
-
"attribute": "name",
|
877
|
-
"reflects": true
|
1082
|
+
"description": "Background color of the overlay in rest state",
|
1083
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
878
1084
|
},
|
879
1085
|
{
|
880
|
-
"
|
881
|
-
"name": "
|
882
|
-
"type": {
|
883
|
-
"text": "LoopType | undefined"
|
884
|
-
},
|
885
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
886
|
-
"attribute": "loop",
|
887
|
-
"reflects": true
|
1086
|
+
"description": "Background color of the overlay in hover state",
|
1087
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
888
1088
|
},
|
889
1089
|
{
|
890
|
-
"
|
891
|
-
"name": "
|
892
|
-
|
893
|
-
|
894
|
-
|
895
|
-
|
896
|
-
"
|
897
|
-
"
|
898
|
-
},
|
899
|
-
{
|
900
|
-
"kind": "field",
|
901
|
-
"name": "ariaLabel",
|
902
|
-
"type": {
|
903
|
-
"text": "string | null"
|
904
|
-
},
|
905
|
-
"default": "null",
|
906
|
-
"description": "Aria-label attribute to be set for accessibility",
|
907
|
-
"attribute": "aria-label"
|
908
|
-
},
|
909
|
-
{
|
910
|
-
"kind": "field",
|
911
|
-
"name": "ariaLabelledBy",
|
912
|
-
"type": {
|
913
|
-
"text": "string | null"
|
914
|
-
},
|
915
|
-
"default": "null",
|
916
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
917
|
-
"attribute": "aria-labelledby"
|
918
|
-
},
|
919
|
-
{
|
920
|
-
"kind": "field",
|
921
|
-
"name": "lottieInstance",
|
922
|
-
"type": {
|
923
|
-
"text": "AnimationItem | undefined"
|
924
|
-
},
|
925
|
-
"privacy": "private",
|
926
|
-
"description": "Lottie animation instance"
|
927
|
-
},
|
928
|
-
{
|
929
|
-
"kind": "field",
|
930
|
-
"name": "containerRef",
|
931
|
-
"type": {
|
932
|
-
"text": "Ref<HTMLDivElement>"
|
933
|
-
},
|
934
|
-
"privacy": "private",
|
935
|
-
"description": "Container for the animation"
|
936
|
-
},
|
937
|
-
{
|
938
|
-
"kind": "field",
|
939
|
-
"name": "animation",
|
940
|
-
"description": "Exposed API of the animation library (lottie)",
|
941
|
-
"readonly": true
|
942
|
-
},
|
943
|
-
{
|
944
|
-
"kind": "method",
|
945
|
-
"name": "getLoopValue",
|
946
|
-
"privacy": "private"
|
947
|
-
},
|
948
|
-
{
|
949
|
-
"kind": "method",
|
950
|
-
"name": "onLoadSuccessHandler",
|
951
|
-
"privacy": "private",
|
952
|
-
"parameters": [
|
953
|
-
{
|
954
|
-
"name": "animationData",
|
955
|
-
"type": {
|
956
|
-
"text": "any"
|
957
|
-
}
|
958
|
-
}
|
959
|
-
],
|
960
|
-
"description": "Create new lotty instance for the loaded data"
|
961
|
-
},
|
962
|
-
{
|
963
|
-
"kind": "method",
|
964
|
-
"name": "onLoadFailHandler",
|
965
|
-
"privacy": "private",
|
966
|
-
"parameters": [
|
967
|
-
{
|
968
|
-
"name": "error",
|
969
|
-
"type": {
|
970
|
-
"text": "Error"
|
971
|
-
}
|
972
|
-
}
|
973
|
-
],
|
974
|
-
"description": "Error handler for animation loading"
|
975
|
-
},
|
976
|
-
{
|
977
|
-
"kind": "method",
|
978
|
-
"name": "getAnimationData",
|
979
|
-
"privacy": "private",
|
980
|
-
"description": "Import animation data dynamically"
|
981
|
-
},
|
982
|
-
{
|
983
|
-
"kind": "field",
|
984
|
-
"name": "onCompleteHandler",
|
985
|
-
"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."
|
986
|
-
}
|
987
|
-
],
|
988
|
-
"events": [
|
989
|
-
{
|
990
|
-
"name": "load",
|
991
|
-
"type": {
|
992
|
-
"text": "CustomEvent"
|
993
|
-
},
|
994
|
-
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
995
|
-
"reactName": "onLoad"
|
996
|
-
},
|
997
|
-
{
|
998
|
-
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
999
|
-
"name": "complete",
|
1000
|
-
"reactName": "onComplete"
|
1001
|
-
},
|
1002
|
-
{
|
1003
|
-
"description": "(React: onError) This event is dispatched when animation loading failed",
|
1004
|
-
"name": "error",
|
1005
|
-
"reactName": "onError"
|
1006
|
-
}
|
1007
|
-
],
|
1008
|
-
"attributes": [
|
1009
|
-
{
|
1010
|
-
"name": "name",
|
1011
|
-
"type": {
|
1012
|
-
"text": "AnimationNames | undefined"
|
1013
|
-
},
|
1014
|
-
"description": "Name of the animation (= filename)",
|
1015
|
-
"fieldName": "name"
|
1016
|
-
},
|
1017
|
-
{
|
1018
|
-
"name": "loop",
|
1019
|
-
"type": {
|
1020
|
-
"text": "LoopType | undefined"
|
1021
|
-
},
|
1022
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
1023
|
-
"fieldName": "loop"
|
1024
|
-
},
|
1025
|
-
{
|
1026
|
-
"name": "autoplay",
|
1027
|
-
"type": {
|
1028
|
-
"text": "boolean | undefined"
|
1029
|
-
},
|
1030
|
-
"description": "Weather start the animation automatically",
|
1031
|
-
"fieldName": "autoplay"
|
1032
|
-
},
|
1033
|
-
{
|
1034
|
-
"name": "aria-label",
|
1035
|
-
"type": {
|
1036
|
-
"text": "string | null"
|
1037
|
-
},
|
1038
|
-
"default": "null",
|
1039
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1040
|
-
"fieldName": "ariaLabel"
|
1041
|
-
},
|
1042
|
-
{
|
1043
|
-
"name": "aria-labelledby",
|
1044
|
-
"type": {
|
1045
|
-
"text": "string | null"
|
1046
|
-
},
|
1047
|
-
"default": "null",
|
1048
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
1049
|
-
"fieldName": "ariaLabelledBy"
|
1050
|
-
}
|
1051
|
-
],
|
1052
|
-
"superclass": {
|
1053
|
-
"name": "Component",
|
1054
|
-
"module": "/src/models"
|
1055
|
-
},
|
1056
|
-
"tagName": "mdc-animation",
|
1057
|
-
"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 */",
|
1058
|
-
"customElement": true
|
1059
|
-
}
|
1060
|
-
],
|
1061
|
-
"exports": [
|
1062
|
-
{
|
1063
|
-
"kind": "js",
|
1064
|
-
"name": "default",
|
1065
|
-
"declaration": {
|
1066
|
-
"name": "Animation",
|
1067
|
-
"module": "components/animation/animation.component.js"
|
1068
|
-
}
|
1069
|
-
}
|
1070
|
-
]
|
1071
|
-
},
|
1072
|
-
{
|
1073
|
-
"kind": "javascript-module",
|
1074
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
1075
|
-
"declarations": [
|
1076
|
-
{
|
1077
|
-
"kind": "class",
|
1078
|
-
"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.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
1079
|
-
"name": "AvatarButton",
|
1080
|
-
"cssProperties": [
|
1081
|
-
{
|
1082
|
-
"description": "Background color of the overlay in rest state",
|
1083
|
-
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
1084
|
-
},
|
1085
|
-
{
|
1086
|
-
"description": "Background color of the overlay in hover state",
|
1087
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
1088
|
-
},
|
1089
|
-
{
|
1090
|
-
"description": "Background color of the overlay in active state",
|
1091
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
1092
|
-
}
|
1093
|
-
],
|
1094
|
-
"cssParts": [
|
1095
|
-
{
|
1096
|
-
"description": "The overlay part of the avatar button.",
|
1097
|
-
"name": "overlay"
|
1090
|
+
"description": "Background color of the overlay in active state",
|
1091
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
1092
|
+
}
|
1093
|
+
],
|
1094
|
+
"cssParts": [
|
1095
|
+
{
|
1096
|
+
"description": "The overlay part of the avatar button.",
|
1097
|
+
"name": "overlay"
|
1098
1098
|
},
|
1099
1099
|
{
|
1100
1100
|
"description": "The main content of the avatar.",
|
@@ -7759,272 +7759,379 @@
|
|
7759
7759
|
},
|
7760
7760
|
{
|
7761
7761
|
"kind": "javascript-module",
|
7762
|
-
"path": "components/
|
7762
|
+
"path": "components/dialog/dialog.component.js",
|
7763
7763
|
"declarations": [
|
7764
7764
|
{
|
7765
7765
|
"kind": "class",
|
7766
|
-
"description": "
|
7767
|
-
"name": "
|
7766
|
+
"description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
7767
|
+
"name": "Dialog",
|
7768
7768
|
"cssProperties": [
|
7769
7769
|
{
|
7770
|
-
"description": "
|
7771
|
-
"name": "--mdc-
|
7772
|
-
"inheritedFrom": {
|
7773
|
-
"name": "Popover",
|
7774
|
-
"module": "src/components/popover/popover.component.ts"
|
7775
|
-
}
|
7776
|
-
},
|
7777
|
-
{
|
7778
|
-
"description": "border of the arrow",
|
7779
|
-
"name": "--mdc-popover-arrow-border",
|
7780
|
-
"inheritedFrom": {
|
7781
|
-
"name": "Popover",
|
7782
|
-
"module": "src/components/popover/popover.component.ts"
|
7783
|
-
}
|
7770
|
+
"description": "primary background color of the dialog",
|
7771
|
+
"name": "--mdc-dialog-primary-background-color"
|
7784
7772
|
},
|
7785
7773
|
{
|
7786
|
-
"description": "
|
7787
|
-
"name": "--mdc-
|
7788
|
-
"inheritedFrom": {
|
7789
|
-
"name": "Popover",
|
7790
|
-
"module": "src/components/popover/popover.component.ts"
|
7791
|
-
}
|
7774
|
+
"description": "border color of the dialog",
|
7775
|
+
"name": "--mdc-dialog-border-color"
|
7792
7776
|
},
|
7793
7777
|
{
|
7794
|
-
"description": "
|
7795
|
-
"name": "--mdc-
|
7796
|
-
"inheritedFrom": {
|
7797
|
-
"name": "Popover",
|
7798
|
-
"module": "src/components/popover/popover.component.ts"
|
7799
|
-
}
|
7778
|
+
"description": "text color of the header/title of the dialog",
|
7779
|
+
"name": "--mdc-dialog-header-text-color"
|
7800
7780
|
},
|
7801
7781
|
{
|
7802
|
-
"description": "
|
7803
|
-
"name": "--mdc-
|
7804
|
-
"inheritedFrom": {
|
7805
|
-
"name": "Popover",
|
7806
|
-
"module": "src/components/popover/popover.component.ts"
|
7807
|
-
}
|
7782
|
+
"description": "text color of the below header description of the dialog",
|
7783
|
+
"name": "--mdc-dialog-description-text-color"
|
7808
7784
|
},
|
7809
7785
|
{
|
7810
|
-
"description": "
|
7811
|
-
"name": "--mdc-
|
7812
|
-
"inheritedFrom": {
|
7813
|
-
"name": "Popover",
|
7814
|
-
"module": "src/components/popover/popover.component.ts"
|
7815
|
-
}
|
7786
|
+
"description": "elevation of the dialog",
|
7787
|
+
"name": "--mdc-dialog-elevation-3"
|
7816
7788
|
},
|
7817
7789
|
{
|
7818
|
-
"description": "
|
7819
|
-
"name": "--mdc-
|
7820
|
-
|
7821
|
-
|
7822
|
-
|
7823
|
-
|
7790
|
+
"description": "width of the dialog",
|
7791
|
+
"name": "--mdc-dialog-width"
|
7792
|
+
}
|
7793
|
+
],
|
7794
|
+
"slots": [
|
7795
|
+
{
|
7796
|
+
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
7797
|
+
"name": "header-prefix"
|
7824
7798
|
},
|
7825
7799
|
{
|
7826
|
-
"description": "
|
7827
|
-
"name": "
|
7828
|
-
"inheritedFrom": {
|
7829
|
-
"name": "Popover",
|
7830
|
-
"module": "src/components/popover/popover.component.ts"
|
7831
|
-
}
|
7800
|
+
"description": "Slot for the dialog body content",
|
7801
|
+
"name": "dialog-body"
|
7832
7802
|
},
|
7833
7803
|
{
|
7834
|
-
"description": "
|
7835
|
-
"name": "
|
7836
|
-
"inheritedFrom": {
|
7837
|
-
"name": "Popover",
|
7838
|
-
"module": "src/components/popover/popover.component.ts"
|
7839
|
-
}
|
7804
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
7805
|
+
"name": "footer-link"
|
7840
7806
|
},
|
7841
7807
|
{
|
7842
|
-
"description": "
|
7843
|
-
"name": "
|
7844
|
-
|
7845
|
-
"name": "Popover",
|
7846
|
-
"module": "src/components/popover/popover.component.ts"
|
7847
|
-
}
|
7848
|
-
}
|
7849
|
-
],
|
7850
|
-
"slots": [
|
7808
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
7809
|
+
"name": "footer-button-secondary"
|
7810
|
+
},
|
7851
7811
|
{
|
7852
|
-
"description": "
|
7853
|
-
"name": ""
|
7854
|
-
|
7855
|
-
|
7856
|
-
|
7857
|
-
|
7812
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
7813
|
+
"name": "footer-button-primary"
|
7814
|
+
},
|
7815
|
+
{
|
7816
|
+
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
|
7817
|
+
"name": "footer"
|
7858
7818
|
}
|
7859
7819
|
],
|
7860
7820
|
"members": [
|
7861
7821
|
{
|
7862
7822
|
"kind": "field",
|
7863
|
-
"name": "
|
7823
|
+
"name": "id",
|
7864
7824
|
"type": {
|
7865
|
-
"text": "
|
7825
|
+
"text": "string"
|
7866
7826
|
},
|
7867
|
-
"
|
7868
|
-
"
|
7869
|
-
"attribute": "
|
7870
|
-
"reflects": true
|
7871
|
-
"inheritedFrom": {
|
7872
|
-
"name": "Popover",
|
7873
|
-
"module": "components/popover/popover.component.js"
|
7874
|
-
}
|
7827
|
+
"default": "''",
|
7828
|
+
"description": "The unique ID of the dialog",
|
7829
|
+
"attribute": "id",
|
7830
|
+
"reflects": true
|
7875
7831
|
},
|
7876
7832
|
{
|
7877
7833
|
"kind": "field",
|
7878
|
-
"name": "
|
7834
|
+
"name": "triggerId",
|
7879
7835
|
"type": {
|
7880
|
-
"text": "
|
7836
|
+
"text": "string | undefined"
|
7881
7837
|
},
|
7882
|
-
"description": "The
|
7883
|
-
"default": "
|
7884
|
-
"attribute": "
|
7885
|
-
"reflects": true
|
7886
|
-
"inheritedFrom": {
|
7887
|
-
"name": "Popover",
|
7888
|
-
"module": "components/popover/popover.component.js"
|
7889
|
-
}
|
7838
|
+
"description": "The ID of the element that triggers the dialog",
|
7839
|
+
"default": "undefined",
|
7840
|
+
"attribute": "triggerId",
|
7841
|
+
"reflects": true
|
7890
7842
|
},
|
7891
7843
|
{
|
7892
7844
|
"kind": "field",
|
7893
|
-
"name": "
|
7845
|
+
"name": "visible",
|
7894
7846
|
"type": {
|
7895
7847
|
"text": "boolean"
|
7896
7848
|
},
|
7897
|
-
"description": "The
|
7898
|
-
"default": "
|
7899
|
-
"attribute": "
|
7900
|
-
"reflects": true
|
7901
|
-
"inheritedFrom": {
|
7902
|
-
"name": "Popover",
|
7903
|
-
"module": "components/popover/popover.component.js"
|
7904
|
-
}
|
7849
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
7850
|
+
"default": "false",
|
7851
|
+
"attribute": "visible",
|
7852
|
+
"reflects": true
|
7905
7853
|
},
|
7906
7854
|
{
|
7907
7855
|
"kind": "field",
|
7908
|
-
"name": "
|
7856
|
+
"name": "zIndex",
|
7909
7857
|
"type": {
|
7910
|
-
"text": "
|
7858
|
+
"text": "number"
|
7911
7859
|
},
|
7912
|
-
"description": "
|
7913
|
-
"default": "
|
7914
|
-
"attribute": "
|
7915
|
-
"reflects": true
|
7916
|
-
"inheritedFrom": {
|
7917
|
-
"name": "Popover",
|
7918
|
-
"module": "components/popover/popover.component.js"
|
7919
|
-
}
|
7860
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
7861
|
+
"default": "1000",
|
7862
|
+
"attribute": "z-index",
|
7863
|
+
"reflects": true
|
7920
7864
|
},
|
7921
7865
|
{
|
7922
7866
|
"kind": "field",
|
7923
|
-
"name": "
|
7867
|
+
"name": "size",
|
7924
7868
|
"type": {
|
7925
|
-
"text": "
|
7869
|
+
"text": "DialogSize"
|
7926
7870
|
},
|
7927
|
-
"description": "
|
7928
|
-
"default": "
|
7929
|
-
"attribute": "
|
7930
|
-
"reflects": true
|
7931
|
-
"privacy": "protected",
|
7932
|
-
"inheritedFrom": {
|
7933
|
-
"name": "Popover",
|
7934
|
-
"module": "components/popover/popover.component.js"
|
7935
|
-
}
|
7871
|
+
"description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
7872
|
+
"default": "small",
|
7873
|
+
"attribute": "size",
|
7874
|
+
"reflects": true
|
7936
7875
|
},
|
7937
7876
|
{
|
7938
|
-
"kind": "
|
7939
|
-
"name": "
|
7940
|
-
"
|
7941
|
-
|
7942
|
-
|
7943
|
-
|
7944
|
-
|
7877
|
+
"kind": "field",
|
7878
|
+
"name": "variant",
|
7879
|
+
"type": {
|
7880
|
+
"text": "DialogVariant"
|
7881
|
+
},
|
7882
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
7883
|
+
"default": "default",
|
7884
|
+
"attribute": "variant",
|
7885
|
+
"reflects": true
|
7945
7886
|
},
|
7946
7887
|
{
|
7947
|
-
"kind": "
|
7948
|
-
"name": "
|
7949
|
-
"
|
7950
|
-
|
7951
|
-
|
7952
|
-
|
7953
|
-
|
7888
|
+
"kind": "field",
|
7889
|
+
"name": "closeButtonAriaLabel",
|
7890
|
+
"type": {
|
7891
|
+
"text": "string | null"
|
7892
|
+
},
|
7893
|
+
"default": "null",
|
7894
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
7895
|
+
"attribute": "close-button-aria-label"
|
7954
7896
|
},
|
7955
7897
|
{
|
7956
7898
|
"kind": "field",
|
7957
|
-
"name": "
|
7899
|
+
"name": "ariaLabel",
|
7958
7900
|
"type": {
|
7959
|
-
"text": "
|
7901
|
+
"text": "string | null"
|
7960
7902
|
},
|
7961
|
-
"
|
7962
|
-
"
|
7963
|
-
"attribute": "
|
7964
|
-
"reflects": true
|
7965
|
-
"privacy": "protected",
|
7966
|
-
"inheritedFrom": {
|
7967
|
-
"name": "Popover",
|
7968
|
-
"module": "components/popover/popover.component.js"
|
7969
|
-
}
|
7903
|
+
"default": "null",
|
7904
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
7905
|
+
"attribute": "aria-label",
|
7906
|
+
"reflects": true
|
7970
7907
|
},
|
7971
7908
|
{
|
7972
7909
|
"kind": "field",
|
7973
|
-
"name": "
|
7910
|
+
"name": "ariaLabelledby",
|
7974
7911
|
"type": {
|
7975
|
-
"text": "
|
7912
|
+
"text": "string | null"
|
7976
7913
|
},
|
7977
|
-
"default": "
|
7978
|
-
"description": "
|
7979
|
-
"attribute": "
|
7980
|
-
"reflects": true
|
7981
|
-
"inheritedFrom": {
|
7982
|
-
"name": "FocusTrapMixin",
|
7983
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
7984
|
-
}
|
7914
|
+
"default": "null",
|
7915
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
7916
|
+
"attribute": "aria-labelledby",
|
7917
|
+
"reflects": true
|
7985
7918
|
},
|
7986
7919
|
{
|
7987
|
-
"kind": "
|
7988
|
-
"name": "
|
7989
|
-
"
|
7990
|
-
|
7991
|
-
|
7992
|
-
|
7993
|
-
|
7994
|
-
|
7995
|
-
|
7996
|
-
}
|
7997
|
-
],
|
7998
|
-
"inheritedFrom": {
|
7999
|
-
"name": "FocusTrapMixin",
|
8000
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
8001
|
-
}
|
7920
|
+
"kind": "field",
|
7921
|
+
"name": "ariaDescribedBy",
|
7922
|
+
"type": {
|
7923
|
+
"text": "string | null"
|
7924
|
+
},
|
7925
|
+
"default": "null",
|
7926
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
7927
|
+
"attribute": "aria-describedby",
|
7928
|
+
"reflects": true
|
8002
7929
|
},
|
8003
7930
|
{
|
8004
|
-
"kind": "
|
8005
|
-
"name": "
|
8006
|
-
"
|
8007
|
-
|
8008
|
-
|
8009
|
-
|
8010
|
-
|
8011
|
-
|
7931
|
+
"kind": "field",
|
7932
|
+
"name": "ariaDescription",
|
7933
|
+
"type": {
|
7934
|
+
"text": "string | null"
|
7935
|
+
},
|
7936
|
+
"default": "null",
|
7937
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
7938
|
+
"attribute": "aria-description",
|
7939
|
+
"reflects": true
|
8012
7940
|
},
|
8013
7941
|
{
|
8014
|
-
"kind": "
|
8015
|
-
"name": "
|
8016
|
-
"
|
8017
|
-
|
8018
|
-
|
8019
|
-
|
8020
|
-
|
8021
|
-
|
7942
|
+
"kind": "field",
|
7943
|
+
"name": "headerText",
|
7944
|
+
"type": {
|
7945
|
+
"text": "string | undefined"
|
7946
|
+
},
|
7947
|
+
"description": "Defines a string value to display as the title of the dialog",
|
7948
|
+
"attribute": "header-text",
|
7949
|
+
"reflects": true
|
8022
7950
|
},
|
8023
7951
|
{
|
8024
|
-
"kind": "
|
8025
|
-
"name": "
|
8026
|
-
"
|
8027
|
-
|
7952
|
+
"kind": "field",
|
7953
|
+
"name": "descriptionText",
|
7954
|
+
"type": {
|
7955
|
+
"text": "string | undefined"
|
7956
|
+
},
|
7957
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
7958
|
+
"attribute": "description-text",
|
7959
|
+
"reflects": true
|
7960
|
+
},
|
7961
|
+
{
|
7962
|
+
"kind": "field",
|
7963
|
+
"name": "headerTagName",
|
7964
|
+
"type": {
|
7965
|
+
"text": "string"
|
7966
|
+
},
|
7967
|
+
"description": "The html tag to be used for the header text",
|
7968
|
+
"attribute": "header-tag-name",
|
7969
|
+
"reflects": true
|
7970
|
+
},
|
7971
|
+
{
|
7972
|
+
"kind": "field",
|
7973
|
+
"name": "descriptionTagName",
|
7974
|
+
"type": {
|
7975
|
+
"text": "string"
|
7976
|
+
},
|
7977
|
+
"description": "The html tag to be used for the below-header description text",
|
7978
|
+
"attribute": "description-tag-name",
|
7979
|
+
"reflects": true
|
7980
|
+
},
|
7981
|
+
{
|
7982
|
+
"kind": "field",
|
7983
|
+
"name": "role",
|
7984
|
+
"type": {
|
7985
|
+
"text": "DialogRole"
|
7986
|
+
},
|
7987
|
+
"description": "Role of the dialog",
|
7988
|
+
"default": "dialog",
|
7989
|
+
"attribute": "role",
|
7990
|
+
"reflects": true
|
7991
|
+
},
|
7992
|
+
{
|
7993
|
+
"kind": "field",
|
7994
|
+
"name": "disableAriaHasPopup",
|
7995
|
+
"type": {
|
7996
|
+
"text": "boolean"
|
7997
|
+
},
|
7998
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
7999
|
+
"default": "false",
|
8000
|
+
"attribute": "disable-aria-haspopup",
|
8001
|
+
"reflects": true
|
8002
|
+
},
|
8003
|
+
{
|
8004
|
+
"kind": "field",
|
8005
|
+
"name": "focusTrap",
|
8006
|
+
"type": {
|
8007
|
+
"text": "boolean"
|
8008
|
+
},
|
8009
|
+
"privacy": "protected",
|
8010
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
|
8011
|
+
"default": "true",
|
8012
|
+
"attribute": "focus-trap",
|
8013
|
+
"reflects": true,
|
8014
|
+
"inheritedFrom": {
|
8015
|
+
"name": "FocusTrapMixin",
|
8016
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8017
|
+
}
|
8018
|
+
},
|
8019
|
+
{
|
8020
|
+
"kind": "method",
|
8021
|
+
"name": "closeDialog",
|
8022
|
+
"privacy": "private",
|
8023
|
+
"description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component."
|
8024
|
+
},
|
8025
|
+
{
|
8026
|
+
"kind": "method",
|
8027
|
+
"name": "isOpenUpdated",
|
8028
|
+
"privacy": "private",
|
8029
|
+
"parameters": [
|
8030
|
+
{
|
8031
|
+
"name": "oldValue",
|
8032
|
+
"type": {
|
8033
|
+
"text": "boolean | undefined"
|
8034
|
+
},
|
8035
|
+
"description": "The old value of the visible property."
|
8036
|
+
},
|
8037
|
+
{
|
8038
|
+
"name": "newValue",
|
8039
|
+
"type": {
|
8040
|
+
"text": "boolean"
|
8041
|
+
},
|
8042
|
+
"description": "The new value of the visible property."
|
8043
|
+
}
|
8044
|
+
],
|
8045
|
+
"description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
|
8046
|
+
},
|
8047
|
+
{
|
8048
|
+
"kind": "field",
|
8049
|
+
"name": "preventScroll",
|
8050
|
+
"type": {
|
8051
|
+
"text": "boolean"
|
8052
|
+
},
|
8053
|
+
"privacy": "protected",
|
8054
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
8055
|
+
"inheritedFrom": {
|
8056
|
+
"name": "PreventScrollMixin",
|
8057
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8058
|
+
}
|
8059
|
+
},
|
8060
|
+
{
|
8061
|
+
"kind": "method",
|
8062
|
+
"name": "activatePreventScroll",
|
8063
|
+
"privacy": "protected",
|
8064
|
+
"inheritedFrom": {
|
8065
|
+
"name": "PreventScrollMixin",
|
8066
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8067
|
+
}
|
8068
|
+
},
|
8069
|
+
{
|
8070
|
+
"kind": "method",
|
8071
|
+
"name": "deactivatePreventScroll",
|
8072
|
+
"privacy": "protected",
|
8073
|
+
"inheritedFrom": {
|
8074
|
+
"name": "PreventScrollMixin",
|
8075
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8076
|
+
}
|
8077
|
+
},
|
8078
|
+
{
|
8079
|
+
"kind": "field",
|
8080
|
+
"name": "shouldFocusTrapWrap",
|
8081
|
+
"type": {
|
8082
|
+
"text": "boolean"
|
8083
|
+
},
|
8084
|
+
"default": "true",
|
8085
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
8086
|
+
"attribute": "should-focus-trap-wrap",
|
8087
|
+
"reflects": true,
|
8088
|
+
"inheritedFrom": {
|
8089
|
+
"name": "FocusTrapMixin",
|
8090
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8091
|
+
}
|
8092
|
+
},
|
8093
|
+
{
|
8094
|
+
"kind": "method",
|
8095
|
+
"name": "setIsFocusTrapActivated",
|
8096
|
+
"privacy": "private",
|
8097
|
+
"parameters": [
|
8098
|
+
{
|
8099
|
+
"name": "isActivated",
|
8100
|
+
"type": {
|
8101
|
+
"text": "boolean"
|
8102
|
+
}
|
8103
|
+
}
|
8104
|
+
],
|
8105
|
+
"inheritedFrom": {
|
8106
|
+
"name": "FocusTrapMixin",
|
8107
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8108
|
+
}
|
8109
|
+
},
|
8110
|
+
{
|
8111
|
+
"kind": "method",
|
8112
|
+
"name": "activateFocusTrap",
|
8113
|
+
"privacy": "public",
|
8114
|
+
"description": "Activate the focus trap",
|
8115
|
+
"inheritedFrom": {
|
8116
|
+
"name": "FocusTrapMixin",
|
8117
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8118
|
+
}
|
8119
|
+
},
|
8120
|
+
{
|
8121
|
+
"kind": "method",
|
8122
|
+
"name": "deactivateFocusTrap",
|
8123
|
+
"privacy": "public",
|
8124
|
+
"description": "Deactivate the focus trap.",
|
8125
|
+
"inheritedFrom": {
|
8126
|
+
"name": "FocusTrapMixin",
|
8127
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8128
|
+
}
|
8129
|
+
},
|
8130
|
+
{
|
8131
|
+
"kind": "method",
|
8132
|
+
"name": "hasNoClientRects",
|
8133
|
+
"privacy": "private",
|
8134
|
+
"parameters": [
|
8028
8135
|
{
|
8029
8136
|
"name": "element",
|
8030
8137
|
"type": {
|
@@ -8465,374 +8572,365 @@
|
|
8465
8572
|
}
|
8466
8573
|
},
|
8467
8574
|
{
|
8468
|
-
"kind": "
|
8469
|
-
"name": "
|
8470
|
-
"
|
8471
|
-
|
8575
|
+
"kind": "method",
|
8576
|
+
"name": "renderFooter",
|
8577
|
+
"privacy": "protected",
|
8578
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
8579
|
+
"return": {
|
8580
|
+
"type": {
|
8581
|
+
"text": ""
|
8582
|
+
}
|
8472
8583
|
},
|
8473
|
-
"default": "''",
|
8474
|
-
"description": "The unique ID of the popover.",
|
8475
|
-
"attribute": "id",
|
8476
|
-
"reflects": true,
|
8477
8584
|
"inheritedFrom": {
|
8478
|
-
"name": "
|
8479
|
-
"module": "
|
8585
|
+
"name": "CardAndDialogFooterMixin",
|
8586
|
+
"module": "utils/mixins/CardAndDialogFooterMixin.js"
|
8480
8587
|
}
|
8588
|
+
}
|
8589
|
+
],
|
8590
|
+
"events": [
|
8591
|
+
{
|
8592
|
+
"description": "(React: onShown) Dispatched when the dialog is shown",
|
8593
|
+
"name": "shown",
|
8594
|
+
"reactName": "onShown"
|
8481
8595
|
},
|
8482
8596
|
{
|
8483
|
-
"
|
8484
|
-
"name": "
|
8597
|
+
"description": "(React: onHidden) Dispatched when the dialog is hidden",
|
8598
|
+
"name": "hidden",
|
8599
|
+
"reactName": "onHidden"
|
8600
|
+
},
|
8601
|
+
{
|
8602
|
+
"description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
|
8603
|
+
"name": "created",
|
8604
|
+
"reactName": "onCreated"
|
8605
|
+
},
|
8606
|
+
{
|
8607
|
+
"description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
|
8608
|
+
"name": "destroyed",
|
8609
|
+
"reactName": "onDestroyed"
|
8610
|
+
},
|
8611
|
+
{
|
8612
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
|
8613
|
+
"name": "close",
|
8614
|
+
"reactName": "onClose"
|
8615
|
+
}
|
8616
|
+
],
|
8617
|
+
"attributes": [
|
8618
|
+
{
|
8619
|
+
"name": "id",
|
8485
8620
|
"type": {
|
8486
8621
|
"text": "string"
|
8487
8622
|
},
|
8488
8623
|
"default": "''",
|
8489
|
-
"description": "The ID of the
|
8490
|
-
"
|
8491
|
-
"reflects": true,
|
8492
|
-
"inheritedFrom": {
|
8493
|
-
"name": "Popover",
|
8494
|
-
"module": "components/popover/popover.component.js"
|
8495
|
-
}
|
8624
|
+
"description": "The unique ID of the dialog",
|
8625
|
+
"fieldName": "id"
|
8496
8626
|
},
|
8497
8627
|
{
|
8498
|
-
"
|
8499
|
-
"name": "placement",
|
8628
|
+
"name": "triggerId",
|
8500
8629
|
"type": {
|
8501
|
-
"text": "
|
8630
|
+
"text": "string | undefined"
|
8502
8631
|
},
|
8503
|
-
"description": "The
|
8504
|
-
"default": "
|
8505
|
-
"
|
8506
|
-
"reflects": true,
|
8507
|
-
"inheritedFrom": {
|
8508
|
-
"name": "Popover",
|
8509
|
-
"module": "components/popover/popover.component.js"
|
8510
|
-
}
|
8511
|
-
},
|
8512
|
-
{
|
8513
|
-
"kind": "field",
|
8514
|
-
"name": "color",
|
8515
|
-
"type": {
|
8516
|
-
"text": "PopoverColor"
|
8517
|
-
},
|
8518
|
-
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
8519
|
-
"default": "tonal",
|
8520
|
-
"attribute": "color",
|
8521
|
-
"reflects": true,
|
8522
|
-
"inheritedFrom": {
|
8523
|
-
"name": "Popover",
|
8524
|
-
"module": "components/popover/popover.component.js"
|
8525
|
-
}
|
8632
|
+
"description": "The ID of the element that triggers the dialog",
|
8633
|
+
"default": "undefined",
|
8634
|
+
"fieldName": "triggerId"
|
8526
8635
|
},
|
8527
8636
|
{
|
8528
|
-
"kind": "field",
|
8529
8637
|
"name": "visible",
|
8530
8638
|
"type": {
|
8531
8639
|
"text": "boolean"
|
8532
8640
|
},
|
8533
|
-
"description": "The visibility of the
|
8641
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
8534
8642
|
"default": "false",
|
8535
|
-
"
|
8536
|
-
"reflects": true,
|
8537
|
-
"inheritedFrom": {
|
8538
|
-
"name": "Popover",
|
8539
|
-
"module": "components/popover/popover.component.js"
|
8540
|
-
}
|
8643
|
+
"fieldName": "visible"
|
8541
8644
|
},
|
8542
8645
|
{
|
8543
|
-
"
|
8544
|
-
"name": "offset",
|
8646
|
+
"name": "z-index",
|
8545
8647
|
"type": {
|
8546
8648
|
"text": "number"
|
8547
8649
|
},
|
8548
|
-
"description": "The
|
8549
|
-
"default": "
|
8550
|
-
"
|
8551
|
-
"reflects": true,
|
8552
|
-
"inheritedFrom": {
|
8553
|
-
"name": "Popover",
|
8554
|
-
"module": "components/popover/popover.component.js"
|
8555
|
-
}
|
8650
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
8651
|
+
"default": "1000",
|
8652
|
+
"fieldName": "zIndex"
|
8556
8653
|
},
|
8557
8654
|
{
|
8558
|
-
"
|
8559
|
-
"name": "boundary",
|
8655
|
+
"name": "size",
|
8560
8656
|
"type": {
|
8561
|
-
"text": "
|
8657
|
+
"text": "DialogSize"
|
8562
8658
|
},
|
8563
|
-
"description": "
|
8564
|
-
"default": "
|
8565
|
-
"
|
8566
|
-
"reflects": true,
|
8567
|
-
"inheritedFrom": {
|
8568
|
-
"name": "Popover",
|
8569
|
-
"module": "components/popover/popover.component.js"
|
8570
|
-
}
|
8659
|
+
"description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
8660
|
+
"default": "small",
|
8661
|
+
"fieldName": "size"
|
8571
8662
|
},
|
8572
8663
|
{
|
8573
|
-
"
|
8574
|
-
"name": "boundaryRoot",
|
8664
|
+
"name": "variant",
|
8575
8665
|
"type": {
|
8576
|
-
"text": "
|
8666
|
+
"text": "DialogVariant"
|
8577
8667
|
},
|
8578
|
-
"description": "
|
8579
|
-
"default": "
|
8580
|
-
"
|
8581
|
-
"reflects": true,
|
8582
|
-
"inheritedFrom": {
|
8583
|
-
"name": "Popover",
|
8584
|
-
"module": "components/popover/popover.component.js"
|
8585
|
-
}
|
8668
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
8669
|
+
"default": "default",
|
8670
|
+
"fieldName": "variant"
|
8586
8671
|
},
|
8587
8672
|
{
|
8588
|
-
"
|
8589
|
-
"name": "boundaryPadding",
|
8673
|
+
"name": "close-button-aria-label",
|
8590
8674
|
"type": {
|
8591
|
-
"text": "
|
8675
|
+
"text": "string | null"
|
8592
8676
|
},
|
8593
|
-
"
|
8594
|
-
"
|
8595
|
-
"
|
8596
|
-
"reflects": true,
|
8597
|
-
"inheritedFrom": {
|
8598
|
-
"name": "Popover",
|
8599
|
-
"module": "components/popover/popover.component.js"
|
8600
|
-
}
|
8677
|
+
"default": "null",
|
8678
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
8679
|
+
"fieldName": "closeButtonAriaLabel"
|
8601
8680
|
},
|
8602
8681
|
{
|
8603
|
-
"
|
8604
|
-
"name": "interactive",
|
8682
|
+
"name": "aria-label",
|
8605
8683
|
"type": {
|
8606
|
-
"text": "
|
8684
|
+
"text": "string | null"
|
8607
8685
|
},
|
8608
|
-
"
|
8609
|
-
"
|
8610
|
-
"
|
8611
|
-
"reflects": true,
|
8612
|
-
"inheritedFrom": {
|
8613
|
-
"name": "Popover",
|
8614
|
-
"module": "components/popover/popover.component.js"
|
8615
|
-
}
|
8686
|
+
"default": "null",
|
8687
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
8688
|
+
"fieldName": "ariaLabel"
|
8616
8689
|
},
|
8617
8690
|
{
|
8618
|
-
"
|
8619
|
-
"name": "delay",
|
8691
|
+
"name": "aria-labelledby",
|
8620
8692
|
"type": {
|
8621
|
-
"text": "string"
|
8693
|
+
"text": "string | null"
|
8622
8694
|
},
|
8623
|
-
"
|
8624
|
-
"
|
8625
|
-
"
|
8626
|
-
"reflects": true,
|
8627
|
-
"inheritedFrom": {
|
8628
|
-
"name": "Popover",
|
8629
|
-
"module": "components/popover/popover.component.js"
|
8630
|
-
}
|
8695
|
+
"default": "null",
|
8696
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
8697
|
+
"fieldName": "ariaLabelledby"
|
8631
8698
|
},
|
8632
8699
|
{
|
8633
|
-
"
|
8634
|
-
"name": "hideOnEscape",
|
8700
|
+
"name": "aria-describedby",
|
8635
8701
|
"type": {
|
8636
|
-
"text": "
|
8702
|
+
"text": "string | null"
|
8637
8703
|
},
|
8638
|
-
"
|
8639
|
-
"
|
8640
|
-
"
|
8641
|
-
"reflects": true,
|
8642
|
-
"inheritedFrom": {
|
8643
|
-
"name": "Popover",
|
8644
|
-
"module": "components/popover/popover.component.js"
|
8645
|
-
}
|
8704
|
+
"default": "null",
|
8705
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
8706
|
+
"fieldName": "ariaDescribedBy"
|
8646
8707
|
},
|
8647
8708
|
{
|
8648
|
-
"
|
8649
|
-
"name": "propagateEventOnEscape",
|
8709
|
+
"name": "aria-description",
|
8650
8710
|
"type": {
|
8651
|
-
"text": "
|
8711
|
+
"text": "string | null"
|
8652
8712
|
},
|
8653
|
-
"
|
8654
|
-
"
|
8655
|
-
"
|
8656
|
-
"reflects": true,
|
8657
|
-
"inheritedFrom": {
|
8658
|
-
"name": "Popover",
|
8659
|
-
"module": "components/popover/popover.component.js"
|
8660
|
-
}
|
8713
|
+
"default": "null",
|
8714
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
8715
|
+
"fieldName": "ariaDescription"
|
8661
8716
|
},
|
8662
8717
|
{
|
8663
|
-
"
|
8664
|
-
"name": "hideOnBlur",
|
8718
|
+
"name": "header-text",
|
8665
8719
|
"type": {
|
8666
|
-
"text": "
|
8720
|
+
"text": "string | undefined"
|
8667
8721
|
},
|
8668
|
-
"description": "
|
8669
|
-
"
|
8670
|
-
"attribute": "hide-on-blur",
|
8671
|
-
"reflects": true,
|
8672
|
-
"inheritedFrom": {
|
8673
|
-
"name": "Popover",
|
8674
|
-
"module": "components/popover/popover.component.js"
|
8675
|
-
}
|
8722
|
+
"description": "Defines a string value to display as the title of the dialog",
|
8723
|
+
"fieldName": "headerText"
|
8676
8724
|
},
|
8677
8725
|
{
|
8678
|
-
"
|
8679
|
-
"name": "hideOnOutsideClick",
|
8726
|
+
"name": "description-text",
|
8680
8727
|
"type": {
|
8681
|
-
"text": "
|
8728
|
+
"text": "string | undefined"
|
8682
8729
|
},
|
8683
|
-
"description": "
|
8684
|
-
"
|
8685
|
-
"attribute": "hide-on-outside-click",
|
8686
|
-
"reflects": true,
|
8687
|
-
"inheritedFrom": {
|
8688
|
-
"name": "Popover",
|
8689
|
-
"module": "components/popover/popover.component.js"
|
8690
|
-
}
|
8730
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
8731
|
+
"fieldName": "descriptionText"
|
8691
8732
|
},
|
8692
8733
|
{
|
8693
|
-
"
|
8694
|
-
"name": "focusBackToTrigger",
|
8734
|
+
"name": "header-tag-name",
|
8695
8735
|
"type": {
|
8696
|
-
"text": "
|
8736
|
+
"text": "string"
|
8697
8737
|
},
|
8698
|
-
"description": "The
|
8699
|
-
"
|
8700
|
-
"attribute": "focus-back-to-trigger",
|
8701
|
-
"reflects": true,
|
8702
|
-
"inheritedFrom": {
|
8703
|
-
"name": "Popover",
|
8704
|
-
"module": "components/popover/popover.component.js"
|
8705
|
-
}
|
8738
|
+
"description": "The html tag to be used for the header text",
|
8739
|
+
"fieldName": "headerTagName"
|
8706
8740
|
},
|
8707
8741
|
{
|
8708
|
-
"
|
8709
|
-
"
|
8742
|
+
"name": "description-tag-name",
|
8743
|
+
"type": {
|
8744
|
+
"text": "string"
|
8745
|
+
},
|
8746
|
+
"description": "The html tag to be used for the below-header description text",
|
8747
|
+
"fieldName": "descriptionTagName"
|
8748
|
+
},
|
8749
|
+
{
|
8750
|
+
"name": "role",
|
8751
|
+
"type": {
|
8752
|
+
"text": "DialogRole"
|
8753
|
+
},
|
8754
|
+
"description": "Role of the dialog",
|
8755
|
+
"default": "dialog",
|
8756
|
+
"fieldName": "role"
|
8757
|
+
},
|
8758
|
+
{
|
8759
|
+
"name": "disable-aria-haspopup",
|
8710
8760
|
"type": {
|
8711
8761
|
"text": "boolean"
|
8712
8762
|
},
|
8713
|
-
"description": "
|
8763
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
8714
8764
|
"default": "false",
|
8715
|
-
"
|
8716
|
-
"reflects": true,
|
8717
|
-
"inheritedFrom": {
|
8718
|
-
"name": "Popover",
|
8719
|
-
"module": "components/popover/popover.component.js"
|
8720
|
-
}
|
8765
|
+
"fieldName": "disableAriaHasPopup"
|
8721
8766
|
},
|
8722
8767
|
{
|
8723
|
-
"
|
8724
|
-
"name": "flip",
|
8768
|
+
"name": "focus-trap",
|
8725
8769
|
"type": {
|
8726
8770
|
"text": "boolean"
|
8727
8771
|
},
|
8728
|
-
"description": "
|
8772
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
|
8729
8773
|
"default": "true",
|
8730
|
-
"
|
8731
|
-
"reflects": true,
|
8732
|
-
"inheritedFrom": {
|
8733
|
-
"name": "Popover",
|
8734
|
-
"module": "components/popover/popover.component.js"
|
8735
|
-
}
|
8774
|
+
"fieldName": "focusTrap"
|
8736
8775
|
},
|
8737
8776
|
{
|
8738
|
-
"
|
8739
|
-
"name": "size",
|
8777
|
+
"name": "should-focus-trap-wrap",
|
8740
8778
|
"type": {
|
8741
8779
|
"text": "boolean"
|
8742
8780
|
},
|
8743
|
-
"
|
8744
|
-
"
|
8745
|
-
"
|
8746
|
-
"reflects": true,
|
8781
|
+
"default": "true",
|
8782
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
8783
|
+
"fieldName": "shouldFocusTrapWrap",
|
8747
8784
|
"inheritedFrom": {
|
8748
|
-
"name": "
|
8749
|
-
"module": "
|
8785
|
+
"name": "FocusTrapMixin",
|
8786
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
8750
8787
|
}
|
8751
|
-
}
|
8788
|
+
}
|
8789
|
+
],
|
8790
|
+
"mixins": [
|
8752
8791
|
{
|
8753
|
-
"
|
8754
|
-
"
|
8755
|
-
|
8756
|
-
|
8757
|
-
|
8758
|
-
"
|
8759
|
-
|
8760
|
-
|
8761
|
-
"
|
8792
|
+
"name": "PreventScrollMixin",
|
8793
|
+
"module": "/src/utils/mixins/PreventScrollMixin"
|
8794
|
+
},
|
8795
|
+
{
|
8796
|
+
"name": "FocusTrapMixin",
|
8797
|
+
"module": "/src/utils/mixins/FocusTrapMixin"
|
8798
|
+
},
|
8799
|
+
{
|
8800
|
+
"name": "CardAndDialogFooterMixin",
|
8801
|
+
"module": "/src/utils/mixins/CardAndDialogFooterMixin"
|
8802
|
+
}
|
8803
|
+
],
|
8804
|
+
"superclass": {
|
8805
|
+
"name": "Component",
|
8806
|
+
"module": "/src/models"
|
8807
|
+
},
|
8808
|
+
"tagName": "mdc-dialog",
|
8809
|
+
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
8810
|
+
"customElement": true
|
8811
|
+
}
|
8812
|
+
],
|
8813
|
+
"exports": [
|
8814
|
+
{
|
8815
|
+
"kind": "js",
|
8816
|
+
"name": "default",
|
8817
|
+
"declaration": {
|
8818
|
+
"name": "Dialog",
|
8819
|
+
"module": "components/dialog/dialog.component.js"
|
8820
|
+
}
|
8821
|
+
}
|
8822
|
+
]
|
8823
|
+
},
|
8824
|
+
{
|
8825
|
+
"kind": "javascript-module",
|
8826
|
+
"path": "components/coachmark/coachmark.component.js",
|
8827
|
+
"declarations": [
|
8828
|
+
{
|
8829
|
+
"kind": "class",
|
8830
|
+
"description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
|
8831
|
+
"name": "Coachmark",
|
8832
|
+
"cssProperties": [
|
8833
|
+
{
|
8834
|
+
"description": "radius of the arrow border",
|
8835
|
+
"name": "--mdc-popover-arrow-border-radius",
|
8762
8836
|
"inheritedFrom": {
|
8763
8837
|
"name": "Popover",
|
8764
|
-
"module": "components/popover/popover.component.
|
8838
|
+
"module": "src/components/popover/popover.component.ts"
|
8765
8839
|
}
|
8766
8840
|
},
|
8767
8841
|
{
|
8768
|
-
"
|
8769
|
-
"name": "
|
8770
|
-
"type": {
|
8771
|
-
"text": "string | undefined"
|
8772
|
-
},
|
8773
|
-
"description": "Element ID that the popover append to.",
|
8774
|
-
"default": "''",
|
8775
|
-
"attribute": "append-to",
|
8776
|
-
"reflects": true,
|
8842
|
+
"description": "border of the arrow",
|
8843
|
+
"name": "--mdc-popover-arrow-border",
|
8777
8844
|
"inheritedFrom": {
|
8778
8845
|
"name": "Popover",
|
8779
|
-
"module": "components/popover/popover.component.
|
8846
|
+
"module": "src/components/popover/popover.component.ts"
|
8780
8847
|
}
|
8781
8848
|
},
|
8782
8849
|
{
|
8783
|
-
"
|
8784
|
-
"name": "
|
8785
|
-
"type": {
|
8786
|
-
"text": "string | null"
|
8787
|
-
},
|
8788
|
-
"default": "null",
|
8789
|
-
"description": "aria-label attribute to be set for close button accessibility.",
|
8790
|
-
"attribute": "close-button-aria-label",
|
8791
|
-
"reflects": true,
|
8850
|
+
"description": "primary background color of the popover",
|
8851
|
+
"name": "--mdc-popover-primary-background-color",
|
8792
8852
|
"inheritedFrom": {
|
8793
8853
|
"name": "Popover",
|
8794
|
-
"module": "components/popover/popover.component.
|
8854
|
+
"module": "src/components/popover/popover.component.ts"
|
8795
8855
|
}
|
8796
8856
|
},
|
8797
8857
|
{
|
8798
|
-
"
|
8799
|
-
"name": "
|
8800
|
-
"type": {
|
8801
|
-
"text": "HTMLElement['role']"
|
8802
|
-
},
|
8803
|
-
"description": "Role of the popover",
|
8804
|
-
"default": "dialog",
|
8805
|
-
"attribute": "role",
|
8806
|
-
"reflects": true,
|
8858
|
+
"description": "border color of the popover",
|
8859
|
+
"name": "--mdc-popover-border-color",
|
8807
8860
|
"inheritedFrom": {
|
8808
8861
|
"name": "Popover",
|
8809
|
-
"module": "components/popover/popover.component.
|
8862
|
+
"module": "src/components/popover/popover.component.ts"
|
8810
8863
|
}
|
8811
8864
|
},
|
8812
8865
|
{
|
8813
|
-
"
|
8814
|
-
"name": "
|
8815
|
-
"type": {
|
8816
|
-
"text": "string | null"
|
8817
|
-
},
|
8818
|
-
"default": "null",
|
8819
|
-
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
8820
|
-
"attribute": "aria-labelledby",
|
8821
|
-
"reflects": true,
|
8866
|
+
"description": "inverted background color of the popover",
|
8867
|
+
"name": "--mdc-popover-inverted-background-color",
|
8822
8868
|
"inheritedFrom": {
|
8823
8869
|
"name": "Popover",
|
8824
|
-
"module": "components/popover/popover.component.
|
8870
|
+
"module": "src/components/popover/popover.component.ts"
|
8871
|
+
}
|
8872
|
+
},
|
8873
|
+
{
|
8874
|
+
"description": "inverted border color of the popover",
|
8875
|
+
"name": "--mdc-popover-inverted-border-color",
|
8876
|
+
"inheritedFrom": {
|
8877
|
+
"name": "Popover",
|
8878
|
+
"module": "src/components/popover/popover.component.ts"
|
8879
|
+
}
|
8880
|
+
},
|
8881
|
+
{
|
8882
|
+
"description": "inverted text color of the popover",
|
8883
|
+
"name": "--mdc-popover-inverted-text-color",
|
8884
|
+
"inheritedFrom": {
|
8885
|
+
"name": "Popover",
|
8886
|
+
"module": "src/components/popover/popover.component.ts"
|
8887
|
+
}
|
8888
|
+
},
|
8889
|
+
{
|
8890
|
+
"description": "elevation of the popover",
|
8891
|
+
"name": "--mdc-popover-elevation-3",
|
8892
|
+
"inheritedFrom": {
|
8893
|
+
"name": "Popover",
|
8894
|
+
"module": "src/components/popover/popover.component.ts"
|
8895
|
+
}
|
8896
|
+
},
|
8897
|
+
{
|
8898
|
+
"description": "max width of the popover",
|
8899
|
+
"name": "--mdc-popover-max-width",
|
8900
|
+
"inheritedFrom": {
|
8901
|
+
"name": "Popover",
|
8902
|
+
"module": "src/components/popover/popover.component.ts"
|
8825
8903
|
}
|
8826
8904
|
},
|
8905
|
+
{
|
8906
|
+
"description": "max height of the popover",
|
8907
|
+
"name": "--mdc-popover-max-height",
|
8908
|
+
"inheritedFrom": {
|
8909
|
+
"name": "Popover",
|
8910
|
+
"module": "src/components/popover/popover.component.ts"
|
8911
|
+
}
|
8912
|
+
}
|
8913
|
+
],
|
8914
|
+
"slots": [
|
8915
|
+
{
|
8916
|
+
"description": "Default slot for modal container",
|
8917
|
+
"name": "",
|
8918
|
+
"inheritedFrom": {
|
8919
|
+
"name": "Popover",
|
8920
|
+
"module": "src/components/popover/popover.component.ts"
|
8921
|
+
}
|
8922
|
+
}
|
8923
|
+
],
|
8924
|
+
"members": [
|
8827
8925
|
{
|
8828
8926
|
"kind": "field",
|
8829
|
-
"name": "
|
8927
|
+
"name": "trigger",
|
8830
8928
|
"type": {
|
8831
|
-
"text": "
|
8929
|
+
"text": "PopoverTrigger"
|
8832
8930
|
},
|
8833
|
-
"
|
8834
|
-
"
|
8835
|
-
"attribute": "
|
8931
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
8932
|
+
"default": "manual",
|
8933
|
+
"attribute": "trigger",
|
8836
8934
|
"reflects": true,
|
8837
8935
|
"inheritedFrom": {
|
8838
8936
|
"name": "Popover",
|
@@ -8841,13 +8939,13 @@
|
|
8841
8939
|
},
|
8842
8940
|
{
|
8843
8941
|
"kind": "field",
|
8844
|
-
"name": "
|
8942
|
+
"name": "showArrow",
|
8845
8943
|
"type": {
|
8846
8944
|
"text": "boolean"
|
8847
8945
|
},
|
8848
|
-
"description": "
|
8849
|
-
"default": "
|
8850
|
-
"attribute": "
|
8946
|
+
"description": "The arrow visibility of the Coachmark.",
|
8947
|
+
"default": "true",
|
8948
|
+
"attribute": "show-arrow",
|
8851
8949
|
"reflects": true,
|
8852
8950
|
"inheritedFrom": {
|
8853
8951
|
"name": "Popover",
|
@@ -8856,12 +8954,14 @@
|
|
8856
8954
|
},
|
8857
8955
|
{
|
8858
8956
|
"kind": "field",
|
8859
|
-
"name": "
|
8957
|
+
"name": "closeButton",
|
8860
8958
|
"type": {
|
8861
|
-
"text": "
|
8959
|
+
"text": "boolean"
|
8862
8960
|
},
|
8863
|
-
"
|
8864
|
-
"default": "
|
8961
|
+
"description": "The close button visibility of the Coachmark.",
|
8962
|
+
"default": "true",
|
8963
|
+
"attribute": "close-button",
|
8964
|
+
"reflects": true,
|
8865
8965
|
"inheritedFrom": {
|
8866
8966
|
"name": "Popover",
|
8867
8967
|
"module": "components/popover/popover.component.js"
|
@@ -8869,22 +8969,30 @@
|
|
8869
8969
|
},
|
8870
8970
|
{
|
8871
8971
|
"kind": "field",
|
8872
|
-
"name": "
|
8972
|
+
"name": "disableAriaExpanded",
|
8873
8973
|
"type": {
|
8874
|
-
"text": "
|
8974
|
+
"text": "boolean"
|
8875
8975
|
},
|
8876
|
-
"
|
8877
|
-
"default": "
|
8976
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
8977
|
+
"default": "true",
|
8978
|
+
"attribute": "disable-aria-expanded",
|
8979
|
+
"reflects": true,
|
8878
8980
|
"inheritedFrom": {
|
8879
8981
|
"name": "Popover",
|
8880
8982
|
"module": "components/popover/popover.component.js"
|
8881
8983
|
}
|
8882
8984
|
},
|
8883
8985
|
{
|
8884
|
-
"kind": "
|
8885
|
-
"name": "
|
8886
|
-
"
|
8887
|
-
|
8986
|
+
"kind": "field",
|
8987
|
+
"name": "preventScroll",
|
8988
|
+
"type": {
|
8989
|
+
"text": "boolean"
|
8990
|
+
},
|
8991
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
8992
|
+
"default": "false",
|
8993
|
+
"attribute": "prevent-scroll",
|
8994
|
+
"reflects": true,
|
8995
|
+
"privacy": "protected",
|
8888
8996
|
"inheritedFrom": {
|
8889
8997
|
"name": "Popover",
|
8890
8998
|
"module": "components/popover/popover.component.js"
|
@@ -8892,41 +9000,33 @@
|
|
8892
9000
|
},
|
8893
9001
|
{
|
8894
9002
|
"kind": "method",
|
8895
|
-
"name": "
|
8896
|
-
"privacy": "
|
8897
|
-
"description": "Removes the trigger event listeners.",
|
9003
|
+
"name": "activatePreventScroll",
|
9004
|
+
"privacy": "protected",
|
8898
9005
|
"inheritedFrom": {
|
8899
|
-
"name": "
|
8900
|
-
"module": "
|
9006
|
+
"name": "PreventScrollMixin",
|
9007
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8901
9008
|
}
|
8902
9009
|
},
|
8903
9010
|
{
|
8904
|
-
"kind": "
|
8905
|
-
"name": "
|
9011
|
+
"kind": "method",
|
9012
|
+
"name": "deactivatePreventScroll",
|
8906
9013
|
"privacy": "protected",
|
8907
|
-
"description": "Handles the outside click event to close the popover.",
|
8908
|
-
"parameters": [
|
8909
|
-
{
|
8910
|
-
"description": "The mouse event.",
|
8911
|
-
"name": "event"
|
8912
|
-
}
|
8913
|
-
],
|
8914
9014
|
"inheritedFrom": {
|
8915
|
-
"name": "
|
8916
|
-
"module": "
|
9015
|
+
"name": "PreventScrollMixin",
|
9016
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8917
9017
|
}
|
8918
9018
|
},
|
8919
9019
|
{
|
8920
9020
|
"kind": "field",
|
8921
|
-
"name": "
|
8922
|
-
"
|
8923
|
-
|
8924
|
-
|
8925
|
-
|
8926
|
-
|
8927
|
-
|
8928
|
-
|
8929
|
-
|
9021
|
+
"name": "focusTrap",
|
9022
|
+
"type": {
|
9023
|
+
"text": "boolean"
|
9024
|
+
},
|
9025
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
9026
|
+
"default": "false",
|
9027
|
+
"attribute": "focus-trap",
|
9028
|
+
"reflects": true,
|
9029
|
+
"privacy": "protected",
|
8930
9030
|
"inheritedFrom": {
|
8931
9031
|
"name": "Popover",
|
8932
9032
|
"module": "components/popover/popover.component.js"
|
@@ -8934,1709 +9034,1609 @@
|
|
8934
9034
|
},
|
8935
9035
|
{
|
8936
9036
|
"kind": "field",
|
8937
|
-
"name": "
|
8938
|
-
"
|
8939
|
-
|
8940
|
-
|
8941
|
-
|
8942
|
-
|
8943
|
-
|
8944
|
-
|
8945
|
-
],
|
9037
|
+
"name": "shouldFocusTrapWrap",
|
9038
|
+
"type": {
|
9039
|
+
"text": "boolean"
|
9040
|
+
},
|
9041
|
+
"default": "true",
|
9042
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
9043
|
+
"attribute": "should-focus-trap-wrap",
|
9044
|
+
"reflects": true,
|
8946
9045
|
"inheritedFrom": {
|
8947
|
-
"name": "
|
8948
|
-
"module": "
|
9046
|
+
"name": "FocusTrapMixin",
|
9047
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8949
9048
|
}
|
8950
9049
|
},
|
8951
9050
|
{
|
8952
9051
|
"kind": "method",
|
8953
|
-
"name": "
|
8954
|
-
"privacy": "
|
9052
|
+
"name": "setIsFocusTrapActivated",
|
9053
|
+
"privacy": "private",
|
8955
9054
|
"parameters": [
|
8956
9055
|
{
|
8957
|
-
"name": "
|
8958
|
-
"type": {
|
8959
|
-
"text": "boolean"
|
8960
|
-
},
|
8961
|
-
"description": "The old value of the visible property."
|
8962
|
-
},
|
8963
|
-
{
|
8964
|
-
"name": "newValue",
|
9056
|
+
"name": "isActivated",
|
8965
9057
|
"type": {
|
8966
9058
|
"text": "boolean"
|
8967
|
-
}
|
8968
|
-
"description": "The new value of the visible property."
|
9059
|
+
}
|
8969
9060
|
}
|
8970
9061
|
],
|
8971
|
-
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
8972
9062
|
"inheritedFrom": {
|
8973
|
-
"name": "
|
8974
|
-
"module": "
|
9063
|
+
"name": "FocusTrapMixin",
|
9064
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8975
9065
|
}
|
8976
9066
|
},
|
8977
9067
|
{
|
8978
|
-
"kind": "
|
8979
|
-
"name": "
|
8980
|
-
"privacy": "
|
8981
|
-
"description": "
|
9068
|
+
"kind": "method",
|
9069
|
+
"name": "activateFocusTrap",
|
9070
|
+
"privacy": "public",
|
9071
|
+
"description": "Activate the focus trap",
|
8982
9072
|
"inheritedFrom": {
|
8983
|
-
"name": "
|
8984
|
-
"module": "
|
9073
|
+
"name": "FocusTrapMixin",
|
9074
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8985
9075
|
}
|
8986
9076
|
},
|
8987
9077
|
{
|
8988
|
-
"kind": "
|
8989
|
-
"name": "
|
8990
|
-
"privacy": "
|
8991
|
-
"description": "
|
9078
|
+
"kind": "method",
|
9079
|
+
"name": "deactivateFocusTrap",
|
9080
|
+
"privacy": "public",
|
9081
|
+
"description": "Deactivate the focus trap.",
|
8992
9082
|
"inheritedFrom": {
|
8993
|
-
"name": "
|
8994
|
-
"module": "
|
9083
|
+
"name": "FocusTrapMixin",
|
9084
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8995
9085
|
}
|
8996
9086
|
},
|
8997
9087
|
{
|
8998
|
-
"kind": "
|
8999
|
-
"name": "
|
9088
|
+
"kind": "method",
|
9089
|
+
"name": "hasNoClientRects",
|
9000
9090
|
"privacy": "private",
|
9001
|
-
"
|
9091
|
+
"parameters": [
|
9092
|
+
{
|
9093
|
+
"name": "element",
|
9094
|
+
"type": {
|
9095
|
+
"text": "HTMLElement"
|
9096
|
+
},
|
9097
|
+
"description": "The element to check."
|
9098
|
+
}
|
9099
|
+
],
|
9100
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
9101
|
+
"return": {
|
9102
|
+
"type": {
|
9103
|
+
"text": ""
|
9104
|
+
}
|
9105
|
+
},
|
9002
9106
|
"inheritedFrom": {
|
9003
|
-
"name": "
|
9004
|
-
"module": "
|
9107
|
+
"name": "FocusTrapMixin",
|
9108
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9005
9109
|
}
|
9006
9110
|
},
|
9007
9111
|
{
|
9008
|
-
"kind": "
|
9009
|
-
"name": "
|
9112
|
+
"kind": "method",
|
9113
|
+
"name": "hasZeroDimensions",
|
9010
9114
|
"privacy": "private",
|
9011
|
-
"
|
9115
|
+
"parameters": [
|
9116
|
+
{
|
9117
|
+
"name": "element",
|
9118
|
+
"type": {
|
9119
|
+
"text": "HTMLElement"
|
9120
|
+
},
|
9121
|
+
"description": "The element to check."
|
9122
|
+
}
|
9123
|
+
],
|
9124
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
9125
|
+
"return": {
|
9126
|
+
"type": {
|
9127
|
+
"text": ""
|
9128
|
+
}
|
9129
|
+
},
|
9012
9130
|
"inheritedFrom": {
|
9013
|
-
"name": "
|
9014
|
-
"module": "
|
9131
|
+
"name": "FocusTrapMixin",
|
9132
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9015
9133
|
}
|
9016
9134
|
},
|
9017
9135
|
{
|
9018
|
-
"kind": "
|
9019
|
-
"name": "
|
9136
|
+
"kind": "method",
|
9137
|
+
"name": "isNotVisible",
|
9020
9138
|
"privacy": "private",
|
9021
|
-
"
|
9022
|
-
|
9023
|
-
|
9024
|
-
|
9025
|
-
|
9026
|
-
|
9027
|
-
|
9028
|
-
|
9029
|
-
|
9030
|
-
"
|
9031
|
-
"
|
9032
|
-
|
9033
|
-
|
9034
|
-
|
9035
|
-
}
|
9036
|
-
},
|
9037
|
-
{
|
9038
|
-
"kind": "field",
|
9039
|
-
"name": "hidePopover",
|
9040
|
-
"privacy": "public",
|
9041
|
-
"description": "Hides the popover.",
|
9139
|
+
"parameters": [
|
9140
|
+
{
|
9141
|
+
"name": "element",
|
9142
|
+
"type": {
|
9143
|
+
"text": "HTMLElement"
|
9144
|
+
},
|
9145
|
+
"description": "The element to check."
|
9146
|
+
}
|
9147
|
+
],
|
9148
|
+
"description": "Determines if the element is not visible in the DOM.",
|
9149
|
+
"return": {
|
9150
|
+
"type": {
|
9151
|
+
"text": ""
|
9152
|
+
}
|
9153
|
+
},
|
9042
9154
|
"inheritedFrom": {
|
9043
|
-
"name": "
|
9044
|
-
"module": "
|
9155
|
+
"name": "FocusTrapMixin",
|
9156
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9045
9157
|
}
|
9046
9158
|
},
|
9047
9159
|
{
|
9048
|
-
"kind": "
|
9049
|
-
"name": "
|
9050
|
-
"privacy": "
|
9051
|
-
"
|
9160
|
+
"kind": "method",
|
9161
|
+
"name": "hasHiddenStyle",
|
9162
|
+
"privacy": "private",
|
9163
|
+
"parameters": [
|
9164
|
+
{
|
9165
|
+
"name": "element",
|
9166
|
+
"type": {
|
9167
|
+
"text": "HTMLElement"
|
9168
|
+
},
|
9169
|
+
"description": "The element to check."
|
9170
|
+
}
|
9171
|
+
],
|
9172
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
9173
|
+
"return": {
|
9174
|
+
"type": {
|
9175
|
+
"text": ""
|
9176
|
+
}
|
9177
|
+
},
|
9052
9178
|
"inheritedFrom": {
|
9053
|
-
"name": "
|
9054
|
-
"module": "
|
9179
|
+
"name": "FocusTrapMixin",
|
9180
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9055
9181
|
}
|
9056
9182
|
},
|
9057
9183
|
{
|
9058
9184
|
"kind": "method",
|
9059
|
-
"name": "
|
9185
|
+
"name": "hasComputedHidden",
|
9060
9186
|
"privacy": "private",
|
9061
|
-
"
|
9187
|
+
"parameters": [
|
9188
|
+
{
|
9189
|
+
"name": "element",
|
9190
|
+
"type": {
|
9191
|
+
"text": "HTMLElement"
|
9192
|
+
},
|
9193
|
+
"description": "The element to check."
|
9194
|
+
}
|
9195
|
+
],
|
9196
|
+
"description": "Checks if the element is hidden by a computed style.",
|
9197
|
+
"return": {
|
9198
|
+
"type": {
|
9199
|
+
"text": ""
|
9200
|
+
}
|
9201
|
+
},
|
9062
9202
|
"inheritedFrom": {
|
9063
|
-
"name": "
|
9064
|
-
"module": "
|
9203
|
+
"name": "FocusTrapMixin",
|
9204
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9065
9205
|
}
|
9066
9206
|
},
|
9067
9207
|
{
|
9068
9208
|
"kind": "method",
|
9069
|
-
"name": "
|
9070
|
-
"privacy": "
|
9209
|
+
"name": "isHidden",
|
9210
|
+
"privacy": "private",
|
9211
|
+
"parameters": [
|
9212
|
+
{
|
9213
|
+
"name": "element",
|
9214
|
+
"type": {
|
9215
|
+
"text": "HTMLElement"
|
9216
|
+
},
|
9217
|
+
"description": "The element to check."
|
9218
|
+
}
|
9219
|
+
],
|
9220
|
+
"description": "Checks if the element is hidden from the user.",
|
9071
9221
|
"return": {
|
9072
9222
|
"type": {
|
9073
|
-
"text": "
|
9223
|
+
"text": ""
|
9074
9224
|
}
|
9075
9225
|
},
|
9226
|
+
"inheritedFrom": {
|
9227
|
+
"name": "FocusTrapMixin",
|
9228
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9229
|
+
}
|
9230
|
+
},
|
9231
|
+
{
|
9232
|
+
"kind": "method",
|
9233
|
+
"name": "isDisabled",
|
9234
|
+
"privacy": "private",
|
9076
9235
|
"parameters": [
|
9077
9236
|
{
|
9078
9237
|
"name": "element",
|
9079
9238
|
"type": {
|
9080
|
-
"text": "
|
9239
|
+
"text": "any"
|
9081
9240
|
},
|
9082
|
-
"description": "The element to
|
9241
|
+
"description": "The element to check."
|
9083
9242
|
}
|
9084
9243
|
],
|
9085
|
-
"description": "
|
9244
|
+
"description": "Checks if the element is disabled.",
|
9245
|
+
"return": {
|
9246
|
+
"type": {
|
9247
|
+
"text": ""
|
9248
|
+
}
|
9249
|
+
},
|
9086
9250
|
"inheritedFrom": {
|
9087
|
-
"name": "
|
9088
|
-
"module": "
|
9251
|
+
"name": "FocusTrapMixin",
|
9252
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9089
9253
|
}
|
9090
9254
|
},
|
9091
9255
|
{
|
9092
|
-
"kind": "
|
9093
|
-
"name": "
|
9094
|
-
"
|
9095
|
-
"
|
9096
|
-
|
9097
|
-
|
9098
|
-
|
9099
|
-
|
9100
|
-
|
9101
|
-
|
9102
|
-
|
9103
|
-
|
9104
|
-
"
|
9105
|
-
"
|
9106
|
-
|
9107
|
-
|
9108
|
-
|
9109
|
-
}
|
9110
|
-
},
|
9111
|
-
{
|
9112
|
-
"description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
|
9113
|
-
"name": "hidden",
|
9114
|
-
"reactName": "onHidden",
|
9115
|
-
"inheritedFrom": {
|
9116
|
-
"name": "Popover",
|
9117
|
-
"module": "src/components/popover/popover.component.ts"
|
9118
|
-
}
|
9119
|
-
},
|
9120
|
-
{
|
9121
|
-
"description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
|
9122
|
-
"name": "created",
|
9123
|
-
"reactName": "onCreated",
|
9124
|
-
"inheritedFrom": {
|
9125
|
-
"name": "Popover",
|
9126
|
-
"module": "src/components/popover/popover.component.ts"
|
9127
|
-
}
|
9128
|
-
},
|
9129
|
-
{
|
9130
|
-
"description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
|
9131
|
-
"name": "destroyed",
|
9132
|
-
"reactName": "onDestroyed",
|
9133
|
-
"inheritedFrom": {
|
9134
|
-
"name": "Popover",
|
9135
|
-
"module": "src/components/popover/popover.component.ts"
|
9136
|
-
}
|
9137
|
-
}
|
9138
|
-
],
|
9139
|
-
"attributes": [
|
9140
|
-
{
|
9141
|
-
"name": "trigger",
|
9142
|
-
"type": {
|
9143
|
-
"text": "PopoverTrigger"
|
9144
|
-
},
|
9145
|
-
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
9146
|
-
"default": "manual",
|
9147
|
-
"fieldName": "trigger",
|
9148
|
-
"inheritedFrom": {
|
9149
|
-
"name": "Popover",
|
9150
|
-
"module": "src/components/popover/popover.component.ts"
|
9151
|
-
}
|
9152
|
-
},
|
9153
|
-
{
|
9154
|
-
"name": "show-arrow",
|
9155
|
-
"type": {
|
9156
|
-
"text": "boolean"
|
9157
|
-
},
|
9158
|
-
"description": "The arrow visibility of the Coachmark.",
|
9159
|
-
"default": "true",
|
9160
|
-
"fieldName": "showArrow",
|
9161
|
-
"inheritedFrom": {
|
9162
|
-
"name": "Popover",
|
9163
|
-
"module": "src/components/popover/popover.component.ts"
|
9164
|
-
}
|
9165
|
-
},
|
9166
|
-
{
|
9167
|
-
"name": "close-button",
|
9168
|
-
"type": {
|
9169
|
-
"text": "boolean"
|
9170
|
-
},
|
9171
|
-
"description": "The close button visibility of the Coachmark.",
|
9172
|
-
"default": "true",
|
9173
|
-
"fieldName": "closeButton",
|
9174
|
-
"inheritedFrom": {
|
9175
|
-
"name": "Popover",
|
9176
|
-
"module": "src/components/popover/popover.component.ts"
|
9177
|
-
}
|
9178
|
-
},
|
9179
|
-
{
|
9180
|
-
"name": "disable-aria-expanded",
|
9181
|
-
"type": {
|
9182
|
-
"text": "boolean"
|
9183
|
-
},
|
9184
|
-
"description": "Disable aria-expanded attribute on trigger element.",
|
9185
|
-
"default": "true",
|
9186
|
-
"fieldName": "disableAriaExpanded",
|
9187
|
-
"inheritedFrom": {
|
9188
|
-
"name": "Popover",
|
9189
|
-
"module": "src/components/popover/popover.component.ts"
|
9190
|
-
}
|
9191
|
-
},
|
9192
|
-
{
|
9193
|
-
"name": "should-focus-trap-wrap",
|
9194
|
-
"type": {
|
9195
|
-
"text": "boolean"
|
9256
|
+
"kind": "method",
|
9257
|
+
"name": "isNotTabbable",
|
9258
|
+
"privacy": "private",
|
9259
|
+
"parameters": [
|
9260
|
+
{
|
9261
|
+
"name": "element",
|
9262
|
+
"type": {
|
9263
|
+
"text": "HTMLElement"
|
9264
|
+
},
|
9265
|
+
"description": "The element to check."
|
9266
|
+
}
|
9267
|
+
],
|
9268
|
+
"description": "Checks if the element is not tabbable.",
|
9269
|
+
"return": {
|
9270
|
+
"type": {
|
9271
|
+
"text": ""
|
9272
|
+
}
|
9196
9273
|
},
|
9197
|
-
"default": "true",
|
9198
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
9199
|
-
"fieldName": "shouldFocusTrapWrap",
|
9200
9274
|
"inheritedFrom": {
|
9201
9275
|
"name": "FocusTrapMixin",
|
9202
|
-
"module": "
|
9203
|
-
}
|
9204
|
-
},
|
9205
|
-
{
|
9206
|
-
"name": "id",
|
9207
|
-
"type": {
|
9208
|
-
"text": "string"
|
9209
|
-
},
|
9210
|
-
"default": "''",
|
9211
|
-
"description": "The unique ID of the popover.",
|
9212
|
-
"fieldName": "id",
|
9213
|
-
"inheritedFrom": {
|
9214
|
-
"name": "Popover",
|
9215
|
-
"module": "src/components/popover/popover.component.ts"
|
9216
|
-
}
|
9217
|
-
},
|
9218
|
-
{
|
9219
|
-
"name": "triggerID",
|
9220
|
-
"type": {
|
9221
|
-
"text": "string"
|
9222
|
-
},
|
9223
|
-
"default": "''",
|
9224
|
-
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
9225
|
-
"fieldName": "triggerID",
|
9226
|
-
"inheritedFrom": {
|
9227
|
-
"name": "Popover",
|
9228
|
-
"module": "src/components/popover/popover.component.ts"
|
9229
|
-
}
|
9230
|
-
},
|
9231
|
-
{
|
9232
|
-
"name": "placement",
|
9233
|
-
"type": {
|
9234
|
-
"text": "PopoverPlacement"
|
9235
|
-
},
|
9236
|
-
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
9237
|
-
"default": "bottom",
|
9238
|
-
"fieldName": "placement",
|
9239
|
-
"inheritedFrom": {
|
9240
|
-
"name": "Popover",
|
9241
|
-
"module": "src/components/popover/popover.component.ts"
|
9242
|
-
}
|
9243
|
-
},
|
9244
|
-
{
|
9245
|
-
"name": "color",
|
9246
|
-
"type": {
|
9247
|
-
"text": "PopoverColor"
|
9248
|
-
},
|
9249
|
-
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
9250
|
-
"default": "tonal",
|
9251
|
-
"fieldName": "color",
|
9252
|
-
"inheritedFrom": {
|
9253
|
-
"name": "Popover",
|
9254
|
-
"module": "src/components/popover/popover.component.ts"
|
9255
|
-
}
|
9256
|
-
},
|
9257
|
-
{
|
9258
|
-
"name": "visible",
|
9259
|
-
"type": {
|
9260
|
-
"text": "boolean"
|
9261
|
-
},
|
9262
|
-
"description": "The visibility of the popover.",
|
9263
|
-
"default": "false",
|
9264
|
-
"fieldName": "visible",
|
9265
|
-
"inheritedFrom": {
|
9266
|
-
"name": "Popover",
|
9267
|
-
"module": "src/components/popover/popover.component.ts"
|
9268
|
-
}
|
9269
|
-
},
|
9270
|
-
{
|
9271
|
-
"name": "offset",
|
9272
|
-
"type": {
|
9273
|
-
"text": "number"
|
9274
|
-
},
|
9275
|
-
"description": "The offset of the popover.",
|
9276
|
-
"default": "4",
|
9277
|
-
"fieldName": "offset",
|
9278
|
-
"inheritedFrom": {
|
9279
|
-
"name": "Popover",
|
9280
|
-
"module": "src/components/popover/popover.component.ts"
|
9281
|
-
}
|
9282
|
-
},
|
9283
|
-
{
|
9284
|
-
"name": "boundary",
|
9285
|
-
"type": {
|
9286
|
-
"text": "'clippingAncestors' | string"
|
9287
|
-
},
|
9288
|
-
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
9289
|
-
"default": "'clippingAncestors'",
|
9290
|
-
"fieldName": "boundary",
|
9291
|
-
"inheritedFrom": {
|
9292
|
-
"name": "Popover",
|
9293
|
-
"module": "src/components/popover/popover.component.ts"
|
9294
|
-
}
|
9295
|
-
},
|
9296
|
-
{
|
9297
|
-
"name": "boundary-root",
|
9298
|
-
"type": {
|
9299
|
-
"text": "'viewport' | 'document'"
|
9300
|
-
},
|
9301
|
-
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
9302
|
-
"default": "'viewport'",
|
9303
|
-
"fieldName": "boundaryRoot",
|
9304
|
-
"inheritedFrom": {
|
9305
|
-
"name": "Popover",
|
9306
|
-
"module": "src/components/popover/popover.component.ts"
|
9307
|
-
}
|
9308
|
-
},
|
9309
|
-
{
|
9310
|
-
"name": "boundary-padding",
|
9311
|
-
"type": {
|
9312
|
-
"text": "undefined | number"
|
9313
|
-
},
|
9314
|
-
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
9315
|
-
"default": "undefined",
|
9316
|
-
"fieldName": "boundaryPadding",
|
9317
|
-
"inheritedFrom": {
|
9318
|
-
"name": "Popover",
|
9319
|
-
"module": "src/components/popover/popover.component.ts"
|
9320
|
-
}
|
9321
|
-
},
|
9322
|
-
{
|
9323
|
-
"name": "focus-trap",
|
9324
|
-
"type": {
|
9325
|
-
"text": "boolean"
|
9326
|
-
},
|
9327
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
9328
|
-
"default": "false",
|
9329
|
-
"fieldName": "focusTrap",
|
9330
|
-
"inheritedFrom": {
|
9331
|
-
"name": "Popover",
|
9332
|
-
"module": "src/components/popover/popover.component.ts"
|
9276
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9333
9277
|
}
|
9334
9278
|
},
|
9335
9279
|
{
|
9336
|
-
"
|
9337
|
-
"
|
9338
|
-
|
9280
|
+
"kind": "method",
|
9281
|
+
"name": "isInteractiveElement",
|
9282
|
+
"privacy": "private",
|
9283
|
+
"return": {
|
9284
|
+
"type": {
|
9285
|
+
"text": ""
|
9286
|
+
}
|
9339
9287
|
},
|
9340
|
-
"
|
9341
|
-
|
9342
|
-
|
9288
|
+
"parameters": [
|
9289
|
+
{
|
9290
|
+
"name": "element",
|
9291
|
+
"type": {
|
9292
|
+
"text": "HTMLElement"
|
9293
|
+
},
|
9294
|
+
"description": "The element to check."
|
9295
|
+
}
|
9296
|
+
],
|
9297
|
+
"description": "Checks if the element is interactive.",
|
9343
9298
|
"inheritedFrom": {
|
9344
|
-
"name": "
|
9345
|
-
"module": "
|
9299
|
+
"name": "FocusTrapMixin",
|
9300
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9346
9301
|
}
|
9347
9302
|
},
|
9348
9303
|
{
|
9349
|
-
"
|
9350
|
-
"
|
9351
|
-
|
9304
|
+
"kind": "method",
|
9305
|
+
"name": "isFocusable",
|
9306
|
+
"privacy": "private",
|
9307
|
+
"parameters": [
|
9308
|
+
{
|
9309
|
+
"name": "element",
|
9310
|
+
"type": {
|
9311
|
+
"text": "HTMLElement"
|
9312
|
+
},
|
9313
|
+
"description": "The element to check."
|
9314
|
+
}
|
9315
|
+
],
|
9316
|
+
"description": "Checks if the element is focusable.",
|
9317
|
+
"return": {
|
9318
|
+
"type": {
|
9319
|
+
"text": ""
|
9320
|
+
}
|
9352
9321
|
},
|
9353
|
-
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
9354
|
-
"default": "false",
|
9355
|
-
"fieldName": "interactive",
|
9356
9322
|
"inheritedFrom": {
|
9357
|
-
"name": "
|
9358
|
-
"module": "
|
9323
|
+
"name": "FocusTrapMixin",
|
9324
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9359
9325
|
}
|
9360
9326
|
},
|
9361
9327
|
{
|
9362
|
-
"
|
9363
|
-
"
|
9364
|
-
|
9328
|
+
"kind": "method",
|
9329
|
+
"name": "findFocusable",
|
9330
|
+
"privacy": "private",
|
9331
|
+
"return": {
|
9332
|
+
"type": {
|
9333
|
+
"text": ""
|
9334
|
+
}
|
9365
9335
|
},
|
9366
|
-
"
|
9367
|
-
|
9368
|
-
|
9336
|
+
"parameters": [
|
9337
|
+
{
|
9338
|
+
"name": "root",
|
9339
|
+
"type": {
|
9340
|
+
"text": "ShadowRoot | HTMLElement"
|
9341
|
+
},
|
9342
|
+
"description": "The root element to search for focusable elements."
|
9343
|
+
},
|
9344
|
+
{
|
9345
|
+
"name": "matches",
|
9346
|
+
"default": "new Set()",
|
9347
|
+
"type": {
|
9348
|
+
"text": "Set<HTMLElement>"
|
9349
|
+
},
|
9350
|
+
"description": "The set of focusable elements."
|
9351
|
+
}
|
9352
|
+
],
|
9353
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
9369
9354
|
"inheritedFrom": {
|
9370
|
-
"name": "
|
9371
|
-
"module": "
|
9355
|
+
"name": "FocusTrapMixin",
|
9356
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9372
9357
|
}
|
9373
9358
|
},
|
9374
9359
|
{
|
9375
|
-
"
|
9376
|
-
"
|
9377
|
-
|
9378
|
-
|
9379
|
-
"description": "Hide popover on escape key press.",
|
9380
|
-
"default": "false",
|
9381
|
-
"fieldName": "hideOnEscape",
|
9360
|
+
"kind": "method",
|
9361
|
+
"name": "setFocusableElements",
|
9362
|
+
"privacy": "private",
|
9363
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
9382
9364
|
"inheritedFrom": {
|
9383
|
-
"name": "
|
9384
|
-
"module": "
|
9365
|
+
"name": "FocusTrapMixin",
|
9366
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9385
9367
|
}
|
9386
9368
|
},
|
9387
9369
|
{
|
9388
|
-
"
|
9389
|
-
"
|
9390
|
-
|
9391
|
-
|
9392
|
-
|
9393
|
-
|
9394
|
-
|
9370
|
+
"kind": "method",
|
9371
|
+
"name": "setInitialFocus",
|
9372
|
+
"privacy": "public",
|
9373
|
+
"parameters": [
|
9374
|
+
{
|
9375
|
+
"name": "elementIndexToReceiveFocus",
|
9376
|
+
"default": "0",
|
9377
|
+
"type": {
|
9378
|
+
"text": "number"
|
9379
|
+
},
|
9380
|
+
"description": "The index of the preferable element to focus."
|
9381
|
+
}
|
9382
|
+
],
|
9383
|
+
"description": "Sets the initial focus within the container.",
|
9395
9384
|
"inheritedFrom": {
|
9396
|
-
"name": "
|
9397
|
-
"module": "
|
9385
|
+
"name": "FocusTrapMixin",
|
9386
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9398
9387
|
}
|
9399
9388
|
},
|
9400
9389
|
{
|
9401
|
-
"
|
9402
|
-
"
|
9403
|
-
|
9390
|
+
"kind": "method",
|
9391
|
+
"name": "calculateNextIndex",
|
9392
|
+
"privacy": "private",
|
9393
|
+
"parameters": [
|
9394
|
+
{
|
9395
|
+
"name": "currentIndex",
|
9396
|
+
"type": {
|
9397
|
+
"text": "number"
|
9398
|
+
},
|
9399
|
+
"description": "The current index."
|
9400
|
+
},
|
9401
|
+
{
|
9402
|
+
"name": "step",
|
9403
|
+
"type": {
|
9404
|
+
"text": "number"
|
9405
|
+
},
|
9406
|
+
"description": "The step to calculate the next index."
|
9407
|
+
}
|
9408
|
+
],
|
9409
|
+
"description": "Calculates the next index for the focus trap.",
|
9410
|
+
"return": {
|
9411
|
+
"type": {
|
9412
|
+
"text": ""
|
9413
|
+
}
|
9404
9414
|
},
|
9405
|
-
"description": "Hide popover on blur.",
|
9406
|
-
"default": "false",
|
9407
|
-
"fieldName": "hideOnBlur",
|
9408
9415
|
"inheritedFrom": {
|
9409
|
-
"name": "
|
9410
|
-
"module": "
|
9416
|
+
"name": "FocusTrapMixin",
|
9417
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9411
9418
|
}
|
9412
9419
|
},
|
9413
9420
|
{
|
9414
|
-
"
|
9415
|
-
"
|
9416
|
-
|
9421
|
+
"kind": "method",
|
9422
|
+
"name": "getDeepActiveElement",
|
9423
|
+
"privacy": "private",
|
9424
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
9425
|
+
"return": {
|
9426
|
+
"type": {
|
9427
|
+
"text": ""
|
9428
|
+
}
|
9417
9429
|
},
|
9418
|
-
"description": "Hide on outside click of the popover.",
|
9419
|
-
"default": "false",
|
9420
|
-
"fieldName": "hideOnOutsideClick",
|
9421
9430
|
"inheritedFrom": {
|
9422
|
-
"name": "
|
9423
|
-
"module": "
|
9431
|
+
"name": "FocusTrapMixin",
|
9432
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9424
9433
|
}
|
9425
9434
|
},
|
9426
9435
|
{
|
9427
|
-
"
|
9428
|
-
"
|
9429
|
-
|
9436
|
+
"kind": "method",
|
9437
|
+
"name": "findElement",
|
9438
|
+
"privacy": "private",
|
9439
|
+
"parameters": [
|
9440
|
+
{
|
9441
|
+
"name": "activeElement",
|
9442
|
+
"type": {
|
9443
|
+
"text": "HTMLElement"
|
9444
|
+
},
|
9445
|
+
"description": "The active element."
|
9446
|
+
}
|
9447
|
+
],
|
9448
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
9449
|
+
"return": {
|
9450
|
+
"type": {
|
9451
|
+
"text": ""
|
9452
|
+
}
|
9430
9453
|
},
|
9431
|
-
"description": "The focus back to trigger after the popover hide.",
|
9432
|
-
"default": "false",
|
9433
|
-
"fieldName": "focusBackToTrigger",
|
9434
9454
|
"inheritedFrom": {
|
9435
|
-
"name": "
|
9436
|
-
"module": "
|
9455
|
+
"name": "FocusTrapMixin",
|
9456
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9437
9457
|
}
|
9438
9458
|
},
|
9439
9459
|
{
|
9440
|
-
"
|
9441
|
-
"
|
9442
|
-
|
9460
|
+
"kind": "method",
|
9461
|
+
"name": "isEqualFocusNode",
|
9462
|
+
"privacy": "private",
|
9463
|
+
"parameters": [
|
9464
|
+
{
|
9465
|
+
"name": "activeElement",
|
9466
|
+
"type": {
|
9467
|
+
"text": "HTMLElement"
|
9468
|
+
},
|
9469
|
+
"description": "The active element."
|
9470
|
+
},
|
9471
|
+
{
|
9472
|
+
"name": "element",
|
9473
|
+
"type": {
|
9474
|
+
"text": "HTMLElement"
|
9475
|
+
},
|
9476
|
+
"description": "The element to compare."
|
9477
|
+
}
|
9478
|
+
],
|
9479
|
+
"description": "Checks if the active element is equal to the given element.",
|
9480
|
+
"return": {
|
9481
|
+
"type": {
|
9482
|
+
"text": ""
|
9483
|
+
}
|
9443
9484
|
},
|
9444
|
-
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
9445
|
-
"default": "false",
|
9446
|
-
"fieldName": "backdrop",
|
9447
9485
|
"inheritedFrom": {
|
9448
|
-
"name": "
|
9449
|
-
"module": "
|
9486
|
+
"name": "FocusTrapMixin",
|
9487
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9450
9488
|
}
|
9451
9489
|
},
|
9452
9490
|
{
|
9453
|
-
"
|
9454
|
-
"
|
9455
|
-
|
9456
|
-
|
9457
|
-
|
9458
|
-
|
9459
|
-
|
9491
|
+
"kind": "method",
|
9492
|
+
"name": "trapFocus",
|
9493
|
+
"privacy": "private",
|
9494
|
+
"parameters": [
|
9495
|
+
{
|
9496
|
+
"name": "event",
|
9497
|
+
"type": {
|
9498
|
+
"text": "KeyboardEvent"
|
9499
|
+
}
|
9500
|
+
},
|
9501
|
+
{
|
9502
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
9503
|
+
"name": "direction"
|
9504
|
+
}
|
9505
|
+
],
|
9506
|
+
"description": "Traps focus within the container.",
|
9460
9507
|
"inheritedFrom": {
|
9461
|
-
"name": "
|
9462
|
-
"module": "
|
9508
|
+
"name": "FocusTrapMixin",
|
9509
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9463
9510
|
}
|
9464
9511
|
},
|
9465
9512
|
{
|
9466
|
-
"
|
9467
|
-
"
|
9468
|
-
|
9469
|
-
|
9470
|
-
|
9471
|
-
|
9472
|
-
|
9513
|
+
"kind": "method",
|
9514
|
+
"name": "handleTabKeydown",
|
9515
|
+
"privacy": "private",
|
9516
|
+
"parameters": [
|
9517
|
+
{
|
9518
|
+
"name": "event",
|
9519
|
+
"type": {
|
9520
|
+
"text": "KeyboardEvent"
|
9521
|
+
},
|
9522
|
+
"description": "The keyboard event."
|
9523
|
+
}
|
9524
|
+
],
|
9525
|
+
"description": "Traps focus within the container.",
|
9473
9526
|
"inheritedFrom": {
|
9474
|
-
"name": "
|
9475
|
-
"module": "
|
9527
|
+
"name": "FocusTrapMixin",
|
9528
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9476
9529
|
}
|
9477
9530
|
},
|
9478
9531
|
{
|
9479
|
-
"
|
9532
|
+
"kind": "field",
|
9533
|
+
"name": "id",
|
9480
9534
|
"type": {
|
9481
|
-
"text": "
|
9535
|
+
"text": "string"
|
9482
9536
|
},
|
9483
|
-
"
|
9484
|
-
"
|
9485
|
-
"
|
9537
|
+
"default": "''",
|
9538
|
+
"description": "The unique ID of the popover.",
|
9539
|
+
"attribute": "id",
|
9540
|
+
"reflects": true,
|
9486
9541
|
"inheritedFrom": {
|
9487
9542
|
"name": "Popover",
|
9488
|
-
"module": "
|
9543
|
+
"module": "components/popover/popover.component.js"
|
9489
9544
|
}
|
9490
9545
|
},
|
9491
9546
|
{
|
9492
|
-
"
|
9547
|
+
"kind": "field",
|
9548
|
+
"name": "triggerID",
|
9493
9549
|
"type": {
|
9494
|
-
"text": "string
|
9550
|
+
"text": "string"
|
9495
9551
|
},
|
9496
|
-
"description": "Element ID that the popover append to.",
|
9497
9552
|
"default": "''",
|
9498
|
-
"
|
9553
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
9554
|
+
"attribute": "triggerID",
|
9555
|
+
"reflects": true,
|
9499
9556
|
"inheritedFrom": {
|
9500
9557
|
"name": "Popover",
|
9501
|
-
"module": "
|
9558
|
+
"module": "components/popover/popover.component.js"
|
9502
9559
|
}
|
9503
9560
|
},
|
9504
9561
|
{
|
9505
|
-
"
|
9562
|
+
"kind": "field",
|
9563
|
+
"name": "placement",
|
9506
9564
|
"type": {
|
9507
|
-
"text": "
|
9565
|
+
"text": "PopoverPlacement"
|
9508
9566
|
},
|
9509
|
-
"
|
9510
|
-
"
|
9511
|
-
"
|
9567
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
9568
|
+
"default": "bottom",
|
9569
|
+
"attribute": "placement",
|
9570
|
+
"reflects": true,
|
9512
9571
|
"inheritedFrom": {
|
9513
9572
|
"name": "Popover",
|
9514
|
-
"module": "
|
9573
|
+
"module": "components/popover/popover.component.js"
|
9515
9574
|
}
|
9516
9575
|
},
|
9517
9576
|
{
|
9518
|
-
"
|
9577
|
+
"kind": "field",
|
9578
|
+
"name": "color",
|
9519
9579
|
"type": {
|
9520
|
-
"text": "
|
9580
|
+
"text": "PopoverColor"
|
9521
9581
|
},
|
9522
|
-
"description": "
|
9523
|
-
"default": "
|
9524
|
-
"
|
9582
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
9583
|
+
"default": "tonal",
|
9584
|
+
"attribute": "color",
|
9585
|
+
"reflects": true,
|
9525
9586
|
"inheritedFrom": {
|
9526
9587
|
"name": "Popover",
|
9527
|
-
"module": "
|
9588
|
+
"module": "components/popover/popover.component.js"
|
9528
9589
|
}
|
9529
9590
|
},
|
9530
9591
|
{
|
9531
|
-
"
|
9592
|
+
"kind": "field",
|
9593
|
+
"name": "visible",
|
9532
9594
|
"type": {
|
9533
|
-
"text": "
|
9595
|
+
"text": "boolean"
|
9534
9596
|
},
|
9535
|
-
"
|
9536
|
-
"
|
9537
|
-
"
|
9597
|
+
"description": "The visibility of the popover.",
|
9598
|
+
"default": "false",
|
9599
|
+
"attribute": "visible",
|
9600
|
+
"reflects": true,
|
9538
9601
|
"inheritedFrom": {
|
9539
9602
|
"name": "Popover",
|
9540
|
-
"module": "
|
9603
|
+
"module": "components/popover/popover.component.js"
|
9541
9604
|
}
|
9542
9605
|
},
|
9543
9606
|
{
|
9544
|
-
"
|
9607
|
+
"kind": "field",
|
9608
|
+
"name": "offset",
|
9545
9609
|
"type": {
|
9546
|
-
"text": "
|
9610
|
+
"text": "number"
|
9547
9611
|
},
|
9548
|
-
"
|
9549
|
-
"
|
9550
|
-
"
|
9612
|
+
"description": "The offset of the popover.",
|
9613
|
+
"default": "4",
|
9614
|
+
"attribute": "offset",
|
9615
|
+
"reflects": true,
|
9551
9616
|
"inheritedFrom": {
|
9552
9617
|
"name": "Popover",
|
9553
|
-
"module": "
|
9618
|
+
"module": "components/popover/popover.component.js"
|
9554
9619
|
}
|
9555
9620
|
},
|
9556
9621
|
{
|
9557
|
-
"
|
9622
|
+
"kind": "field",
|
9623
|
+
"name": "boundary",
|
9558
9624
|
"type": {
|
9559
|
-
"text": "
|
9625
|
+
"text": "'clippingAncestors' | string"
|
9560
9626
|
},
|
9561
|
-
"description": "
|
9562
|
-
"default": "
|
9563
|
-
"
|
9627
|
+
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
9628
|
+
"default": "'clippingAncestors'",
|
9629
|
+
"attribute": "boundary",
|
9630
|
+
"reflects": true,
|
9564
9631
|
"inheritedFrom": {
|
9565
9632
|
"name": "Popover",
|
9566
|
-
"module": "
|
9633
|
+
"module": "components/popover/popover.component.js"
|
9567
9634
|
}
|
9568
|
-
}
|
9569
|
-
],
|
9570
|
-
"superclass": {
|
9571
|
-
"name": "Popover",
|
9572
|
-
"module": "/src/components/popover/popover.component"
|
9573
|
-
},
|
9574
|
-
"tagName": "mdc-coachmark",
|
9575
|
-
"jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
|
9576
|
-
"customElement": true
|
9577
|
-
}
|
9578
|
-
],
|
9579
|
-
"exports": [
|
9580
|
-
{
|
9581
|
-
"kind": "js",
|
9582
|
-
"name": "default",
|
9583
|
-
"declaration": {
|
9584
|
-
"name": "Coachmark",
|
9585
|
-
"module": "components/coachmark/coachmark.component.js"
|
9586
|
-
}
|
9587
|
-
}
|
9588
|
-
]
|
9589
|
-
},
|
9590
|
-
{
|
9591
|
-
"kind": "javascript-module",
|
9592
|
-
"path": "components/dialog/dialog.component.js",
|
9593
|
-
"declarations": [
|
9594
|
-
{
|
9595
|
-
"kind": "class",
|
9596
|
-
"description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
9597
|
-
"name": "Dialog",
|
9598
|
-
"cssProperties": [
|
9599
|
-
{
|
9600
|
-
"description": "primary background color of the dialog",
|
9601
|
-
"name": "--mdc-dialog-primary-background-color"
|
9602
|
-
},
|
9603
|
-
{
|
9604
|
-
"description": "border color of the dialog",
|
9605
|
-
"name": "--mdc-dialog-border-color"
|
9606
|
-
},
|
9607
|
-
{
|
9608
|
-
"description": "text color of the header/title of the dialog",
|
9609
|
-
"name": "--mdc-dialog-header-text-color"
|
9610
|
-
},
|
9611
|
-
{
|
9612
|
-
"description": "text color of the below header description of the dialog",
|
9613
|
-
"name": "--mdc-dialog-description-text-color"
|
9614
|
-
},
|
9615
|
-
{
|
9616
|
-
"description": "elevation of the dialog",
|
9617
|
-
"name": "--mdc-dialog-elevation-3"
|
9618
|
-
},
|
9619
|
-
{
|
9620
|
-
"description": "width of the dialog",
|
9621
|
-
"name": "--mdc-dialog-width"
|
9622
|
-
}
|
9623
|
-
],
|
9624
|
-
"slots": [
|
9625
|
-
{
|
9626
|
-
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
9627
|
-
"name": "header-prefix"
|
9628
|
-
},
|
9629
|
-
{
|
9630
|
-
"description": "Slot for the dialog body content",
|
9631
|
-
"name": "dialog-body"
|
9632
|
-
},
|
9633
|
-
{
|
9634
|
-
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
9635
|
-
"name": "footer-link"
|
9636
|
-
},
|
9637
|
-
{
|
9638
|
-
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
9639
|
-
"name": "footer-button-secondary"
|
9640
|
-
},
|
9641
|
-
{
|
9642
|
-
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
9643
|
-
"name": "footer-button-primary"
|
9644
|
-
},
|
9645
|
-
{
|
9646
|
-
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
|
9647
|
-
"name": "footer"
|
9648
|
-
}
|
9649
|
-
],
|
9650
|
-
"members": [
|
9651
|
-
{
|
9652
|
-
"kind": "field",
|
9653
|
-
"name": "id",
|
9654
|
-
"type": {
|
9655
|
-
"text": "string"
|
9656
|
-
},
|
9657
|
-
"default": "''",
|
9658
|
-
"description": "The unique ID of the dialog",
|
9659
|
-
"attribute": "id",
|
9660
|
-
"reflects": true
|
9661
|
-
},
|
9662
|
-
{
|
9663
|
-
"kind": "field",
|
9664
|
-
"name": "triggerId",
|
9665
|
-
"type": {
|
9666
|
-
"text": "string | undefined"
|
9667
|
-
},
|
9668
|
-
"description": "The ID of the element that triggers the dialog",
|
9669
|
-
"default": "undefined",
|
9670
|
-
"attribute": "triggerId",
|
9671
|
-
"reflects": true
|
9672
|
-
},
|
9673
|
-
{
|
9674
|
-
"kind": "field",
|
9675
|
-
"name": "visible",
|
9676
|
-
"type": {
|
9677
|
-
"text": "boolean"
|
9678
|
-
},
|
9679
|
-
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
9680
|
-
"default": "false",
|
9681
|
-
"attribute": "visible",
|
9682
|
-
"reflects": true
|
9683
9635
|
},
|
9684
9636
|
{
|
9685
9637
|
"kind": "field",
|
9686
|
-
"name": "
|
9638
|
+
"name": "boundaryRoot",
|
9687
9639
|
"type": {
|
9688
|
-
"text": "
|
9640
|
+
"text": "'viewport' | 'document'"
|
9689
9641
|
},
|
9690
|
-
"description": "
|
9691
|
-
"default": "
|
9692
|
-
"attribute": "
|
9693
|
-
"reflects": true
|
9642
|
+
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
9643
|
+
"default": "'viewport'",
|
9644
|
+
"attribute": "boundary-root",
|
9645
|
+
"reflects": true,
|
9646
|
+
"inheritedFrom": {
|
9647
|
+
"name": "Popover",
|
9648
|
+
"module": "components/popover/popover.component.js"
|
9649
|
+
}
|
9694
9650
|
},
|
9695
9651
|
{
|
9696
9652
|
"kind": "field",
|
9697
|
-
"name": "
|
9653
|
+
"name": "boundaryPadding",
|
9698
9654
|
"type": {
|
9699
|
-
"text": "
|
9655
|
+
"text": "undefined | number"
|
9700
9656
|
},
|
9701
|
-
"description": "
|
9702
|
-
"default": "
|
9703
|
-
"attribute": "
|
9704
|
-
"reflects": true
|
9657
|
+
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
9658
|
+
"default": "undefined",
|
9659
|
+
"attribute": "boundary-padding",
|
9660
|
+
"reflects": true,
|
9661
|
+
"inheritedFrom": {
|
9662
|
+
"name": "Popover",
|
9663
|
+
"module": "components/popover/popover.component.js"
|
9664
|
+
}
|
9705
9665
|
},
|
9706
9666
|
{
|
9707
9667
|
"kind": "field",
|
9708
|
-
"name": "
|
9668
|
+
"name": "interactive",
|
9709
9669
|
"type": {
|
9710
|
-
"text": "
|
9670
|
+
"text": "boolean"
|
9711
9671
|
},
|
9712
|
-
"description": "
|
9713
|
-
"default": "
|
9714
|
-
"attribute": "
|
9715
|
-
"reflects": true
|
9672
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
9673
|
+
"default": "false",
|
9674
|
+
"attribute": "interactive",
|
9675
|
+
"reflects": true,
|
9676
|
+
"inheritedFrom": {
|
9677
|
+
"name": "Popover",
|
9678
|
+
"module": "components/popover/popover.component.js"
|
9679
|
+
}
|
9716
9680
|
},
|
9717
9681
|
{
|
9718
9682
|
"kind": "field",
|
9719
|
-
"name": "
|
9683
|
+
"name": "delay",
|
9720
9684
|
"type": {
|
9721
|
-
"text": "string
|
9685
|
+
"text": "string"
|
9722
9686
|
},
|
9723
|
-
"
|
9724
|
-
"
|
9725
|
-
"attribute": "
|
9687
|
+
"description": "The delay of the show/hide popover.",
|
9688
|
+
"default": "0,0",
|
9689
|
+
"attribute": "delay",
|
9690
|
+
"reflects": true,
|
9691
|
+
"inheritedFrom": {
|
9692
|
+
"name": "Popover",
|
9693
|
+
"module": "components/popover/popover.component.js"
|
9694
|
+
}
|
9726
9695
|
},
|
9727
9696
|
{
|
9728
9697
|
"kind": "field",
|
9729
|
-
"name": "
|
9698
|
+
"name": "hideOnEscape",
|
9730
9699
|
"type": {
|
9731
|
-
"text": "
|
9700
|
+
"text": "boolean"
|
9732
9701
|
},
|
9733
|
-
"
|
9734
|
-
"
|
9735
|
-
"attribute": "
|
9736
|
-
"reflects": true
|
9702
|
+
"description": "Hide popover on escape key press.",
|
9703
|
+
"default": "false",
|
9704
|
+
"attribute": "hide-on-escape",
|
9705
|
+
"reflects": true,
|
9706
|
+
"inheritedFrom": {
|
9707
|
+
"name": "Popover",
|
9708
|
+
"module": "components/popover/popover.component.js"
|
9709
|
+
}
|
9737
9710
|
},
|
9738
9711
|
{
|
9739
9712
|
"kind": "field",
|
9740
|
-
"name": "
|
9713
|
+
"name": "propagateEventOnEscape",
|
9741
9714
|
"type": {
|
9742
|
-
"text": "
|
9715
|
+
"text": "boolean"
|
9743
9716
|
},
|
9744
|
-
"
|
9745
|
-
"
|
9746
|
-
"attribute": "
|
9747
|
-
"reflects": true
|
9717
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
9718
|
+
"default": "false",
|
9719
|
+
"attribute": "propagate-event-on-escape",
|
9720
|
+
"reflects": true,
|
9721
|
+
"inheritedFrom": {
|
9722
|
+
"name": "Popover",
|
9723
|
+
"module": "components/popover/popover.component.js"
|
9724
|
+
}
|
9748
9725
|
},
|
9749
9726
|
{
|
9750
9727
|
"kind": "field",
|
9751
|
-
"name": "
|
9728
|
+
"name": "hideOnBlur",
|
9752
9729
|
"type": {
|
9753
|
-
"text": "
|
9730
|
+
"text": "boolean"
|
9754
9731
|
},
|
9755
|
-
"
|
9756
|
-
"
|
9757
|
-
"attribute": "
|
9758
|
-
"reflects": true
|
9732
|
+
"description": "Hide popover on blur.",
|
9733
|
+
"default": "false",
|
9734
|
+
"attribute": "hide-on-blur",
|
9735
|
+
"reflects": true,
|
9736
|
+
"inheritedFrom": {
|
9737
|
+
"name": "Popover",
|
9738
|
+
"module": "components/popover/popover.component.js"
|
9739
|
+
}
|
9759
9740
|
},
|
9760
9741
|
{
|
9761
9742
|
"kind": "field",
|
9762
|
-
"name": "
|
9743
|
+
"name": "hideOnOutsideClick",
|
9763
9744
|
"type": {
|
9764
|
-
"text": "
|
9745
|
+
"text": "boolean"
|
9765
9746
|
},
|
9766
|
-
"
|
9767
|
-
"
|
9768
|
-
"attribute": "
|
9769
|
-
"reflects": true
|
9747
|
+
"description": "Hide on outside click of the popover.",
|
9748
|
+
"default": "false",
|
9749
|
+
"attribute": "hide-on-outside-click",
|
9750
|
+
"reflects": true,
|
9751
|
+
"inheritedFrom": {
|
9752
|
+
"name": "Popover",
|
9753
|
+
"module": "components/popover/popover.component.js"
|
9754
|
+
}
|
9770
9755
|
},
|
9771
9756
|
{
|
9772
9757
|
"kind": "field",
|
9773
|
-
"name": "
|
9758
|
+
"name": "focusBackToTrigger",
|
9774
9759
|
"type": {
|
9775
|
-
"text": "
|
9760
|
+
"text": "boolean"
|
9776
9761
|
},
|
9777
|
-
"description": "
|
9778
|
-
"
|
9779
|
-
"
|
9762
|
+
"description": "The focus back to trigger after the popover hide.",
|
9763
|
+
"default": "false",
|
9764
|
+
"attribute": "focus-back-to-trigger",
|
9765
|
+
"reflects": true,
|
9766
|
+
"inheritedFrom": {
|
9767
|
+
"name": "Popover",
|
9768
|
+
"module": "components/popover/popover.component.js"
|
9769
|
+
}
|
9780
9770
|
},
|
9781
9771
|
{
|
9782
9772
|
"kind": "field",
|
9783
|
-
"name": "
|
9773
|
+
"name": "backdrop",
|
9784
9774
|
"type": {
|
9785
|
-
"text": "
|
9775
|
+
"text": "boolean"
|
9786
9776
|
},
|
9787
|
-
"description": "
|
9788
|
-
"
|
9789
|
-
"
|
9777
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
9778
|
+
"default": "false",
|
9779
|
+
"attribute": "backdrop",
|
9780
|
+
"reflects": true,
|
9781
|
+
"inheritedFrom": {
|
9782
|
+
"name": "Popover",
|
9783
|
+
"module": "components/popover/popover.component.js"
|
9784
|
+
}
|
9790
9785
|
},
|
9791
9786
|
{
|
9792
9787
|
"kind": "field",
|
9793
|
-
"name": "
|
9788
|
+
"name": "flip",
|
9794
9789
|
"type": {
|
9795
|
-
"text": "
|
9790
|
+
"text": "boolean"
|
9796
9791
|
},
|
9797
|
-
"description": "
|
9798
|
-
"
|
9799
|
-
"
|
9792
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
9793
|
+
"default": "true",
|
9794
|
+
"attribute": "flip",
|
9795
|
+
"reflects": true,
|
9796
|
+
"inheritedFrom": {
|
9797
|
+
"name": "Popover",
|
9798
|
+
"module": "components/popover/popover.component.js"
|
9799
|
+
}
|
9800
9800
|
},
|
9801
9801
|
{
|
9802
9802
|
"kind": "field",
|
9803
|
-
"name": "
|
9803
|
+
"name": "size",
|
9804
9804
|
"type": {
|
9805
|
-
"text": "
|
9805
|
+
"text": "boolean"
|
9806
9806
|
},
|
9807
|
-
"description": "
|
9808
|
-
"
|
9809
|
-
"
|
9807
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
9808
|
+
"default": "false",
|
9809
|
+
"attribute": "size",
|
9810
|
+
"reflects": true,
|
9811
|
+
"inheritedFrom": {
|
9812
|
+
"name": "Popover",
|
9813
|
+
"module": "components/popover/popover.component.js"
|
9814
|
+
}
|
9810
9815
|
},
|
9811
9816
|
{
|
9812
9817
|
"kind": "field",
|
9813
|
-
"name": "
|
9818
|
+
"name": "zIndex",
|
9814
9819
|
"type": {
|
9815
|
-
"text": "
|
9820
|
+
"text": "number"
|
9816
9821
|
},
|
9817
|
-
"description": "
|
9818
|
-
"default": "
|
9819
|
-
"attribute": "
|
9820
|
-
"reflects": true
|
9822
|
+
"description": "The z-index of the popover.",
|
9823
|
+
"default": "1000",
|
9824
|
+
"attribute": "z-index",
|
9825
|
+
"reflects": true,
|
9826
|
+
"inheritedFrom": {
|
9827
|
+
"name": "Popover",
|
9828
|
+
"module": "components/popover/popover.component.js"
|
9829
|
+
}
|
9821
9830
|
},
|
9822
9831
|
{
|
9823
9832
|
"kind": "field",
|
9824
|
-
"name": "
|
9833
|
+
"name": "appendTo",
|
9825
9834
|
"type": {
|
9826
|
-
"text": "
|
9835
|
+
"text": "string | undefined"
|
9827
9836
|
},
|
9828
|
-
"description": "
|
9829
|
-
"default": "
|
9830
|
-
"attribute": "
|
9831
|
-
"reflects": true
|
9837
|
+
"description": "Element ID that the popover append to.",
|
9838
|
+
"default": "''",
|
9839
|
+
"attribute": "append-to",
|
9840
|
+
"reflects": true,
|
9841
|
+
"inheritedFrom": {
|
9842
|
+
"name": "Popover",
|
9843
|
+
"module": "components/popover/popover.component.js"
|
9844
|
+
}
|
9832
9845
|
},
|
9833
9846
|
{
|
9834
9847
|
"kind": "field",
|
9835
|
-
"name": "
|
9848
|
+
"name": "closeButtonAriaLabel",
|
9836
9849
|
"type": {
|
9837
|
-
"text": "
|
9850
|
+
"text": "string | null"
|
9838
9851
|
},
|
9839
|
-
"
|
9840
|
-
"description": "
|
9841
|
-
"
|
9842
|
-
"attribute": "focus-trap",
|
9852
|
+
"default": "null",
|
9853
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
9854
|
+
"attribute": "close-button-aria-label",
|
9843
9855
|
"reflects": true,
|
9844
9856
|
"inheritedFrom": {
|
9845
|
-
"name": "
|
9846
|
-
"module": "
|
9857
|
+
"name": "Popover",
|
9858
|
+
"module": "components/popover/popover.component.js"
|
9847
9859
|
}
|
9848
9860
|
},
|
9849
|
-
{
|
9850
|
-
"kind": "method",
|
9851
|
-
"name": "closeDialog",
|
9852
|
-
"privacy": "private",
|
9853
|
-
"description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component."
|
9854
|
-
},
|
9855
|
-
{
|
9856
|
-
"kind": "method",
|
9857
|
-
"name": "isOpenUpdated",
|
9858
|
-
"privacy": "private",
|
9859
|
-
"parameters": [
|
9860
|
-
{
|
9861
|
-
"name": "oldValue",
|
9862
|
-
"type": {
|
9863
|
-
"text": "boolean | undefined"
|
9864
|
-
},
|
9865
|
-
"description": "The old value of the visible property."
|
9866
|
-
},
|
9867
|
-
{
|
9868
|
-
"name": "newValue",
|
9869
|
-
"type": {
|
9870
|
-
"text": "boolean"
|
9871
|
-
},
|
9872
|
-
"description": "The new value of the visible property."
|
9873
|
-
}
|
9874
|
-
],
|
9875
|
-
"description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
|
9876
|
-
},
|
9877
9861
|
{
|
9878
9862
|
"kind": "field",
|
9879
|
-
"name": "
|
9863
|
+
"name": "role",
|
9880
9864
|
"type": {
|
9881
|
-
"text": "
|
9865
|
+
"text": "HTMLElement['role']"
|
9882
9866
|
},
|
9883
|
-
"
|
9884
|
-
"
|
9867
|
+
"description": "Role of the popover",
|
9868
|
+
"default": "dialog",
|
9869
|
+
"attribute": "role",
|
9870
|
+
"reflects": true,
|
9885
9871
|
"inheritedFrom": {
|
9886
|
-
"name": "
|
9887
|
-
"module": "
|
9872
|
+
"name": "Popover",
|
9873
|
+
"module": "components/popover/popover.component.js"
|
9888
9874
|
}
|
9889
9875
|
},
|
9890
9876
|
{
|
9891
|
-
"kind": "
|
9892
|
-
"name": "
|
9893
|
-
"
|
9877
|
+
"kind": "field",
|
9878
|
+
"name": "ariaLabelledby",
|
9879
|
+
"type": {
|
9880
|
+
"text": "string | null"
|
9881
|
+
},
|
9882
|
+
"default": "null",
|
9883
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
9884
|
+
"attribute": "aria-labelledby",
|
9885
|
+
"reflects": true,
|
9894
9886
|
"inheritedFrom": {
|
9895
|
-
"name": "
|
9896
|
-
"module": "
|
9887
|
+
"name": "Popover",
|
9888
|
+
"module": "components/popover/popover.component.js"
|
9897
9889
|
}
|
9898
9890
|
},
|
9899
9891
|
{
|
9900
|
-
"kind": "
|
9901
|
-
"name": "
|
9902
|
-
"
|
9892
|
+
"kind": "field",
|
9893
|
+
"name": "ariaDescribedby",
|
9894
|
+
"type": {
|
9895
|
+
"text": "string | null"
|
9896
|
+
},
|
9897
|
+
"default": "null",
|
9898
|
+
"description": "aria-describedby of the popover.",
|
9899
|
+
"attribute": "aria-describedby",
|
9900
|
+
"reflects": true,
|
9903
9901
|
"inheritedFrom": {
|
9904
|
-
"name": "
|
9905
|
-
"module": "
|
9902
|
+
"name": "Popover",
|
9903
|
+
"module": "components/popover/popover.component.js"
|
9906
9904
|
}
|
9907
9905
|
},
|
9908
9906
|
{
|
9909
9907
|
"kind": "field",
|
9910
|
-
"name": "
|
9908
|
+
"name": "disableAriaHasPopup",
|
9911
9909
|
"type": {
|
9912
9910
|
"text": "boolean"
|
9913
9911
|
},
|
9914
|
-
"
|
9915
|
-
"
|
9916
|
-
"attribute": "
|
9912
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
9913
|
+
"default": "false",
|
9914
|
+
"attribute": "disable-aria-haspopup",
|
9917
9915
|
"reflects": true,
|
9918
9916
|
"inheritedFrom": {
|
9919
|
-
"name": "
|
9920
|
-
"module": "
|
9917
|
+
"name": "Popover",
|
9918
|
+
"module": "components/popover/popover.component.js"
|
9921
9919
|
}
|
9922
9920
|
},
|
9923
9921
|
{
|
9924
|
-
"kind": "
|
9925
|
-
"name": "
|
9926
|
-
"
|
9927
|
-
|
9928
|
-
|
9929
|
-
|
9930
|
-
|
9931
|
-
"text": "boolean"
|
9932
|
-
}
|
9933
|
-
}
|
9934
|
-
],
|
9922
|
+
"kind": "field",
|
9923
|
+
"name": "arrowElement",
|
9924
|
+
"type": {
|
9925
|
+
"text": "HTMLElement | null"
|
9926
|
+
},
|
9927
|
+
"privacy": "public",
|
9928
|
+
"default": "null",
|
9935
9929
|
"inheritedFrom": {
|
9936
|
-
"name": "
|
9937
|
-
"module": "
|
9930
|
+
"name": "Popover",
|
9931
|
+
"module": "components/popover/popover.component.js"
|
9938
9932
|
}
|
9939
9933
|
},
|
9940
9934
|
{
|
9941
|
-
"kind": "
|
9942
|
-
"name": "
|
9935
|
+
"kind": "field",
|
9936
|
+
"name": "triggerElement",
|
9937
|
+
"type": {
|
9938
|
+
"text": "HTMLElement | null"
|
9939
|
+
},
|
9943
9940
|
"privacy": "public",
|
9944
|
-
"
|
9941
|
+
"default": "null",
|
9945
9942
|
"inheritedFrom": {
|
9946
|
-
"name": "
|
9947
|
-
"module": "
|
9943
|
+
"name": "Popover",
|
9944
|
+
"module": "components/popover/popover.component.js"
|
9948
9945
|
}
|
9949
9946
|
},
|
9950
9947
|
{
|
9951
9948
|
"kind": "method",
|
9952
|
-
"name": "
|
9953
|
-
"privacy": "
|
9954
|
-
"description": "
|
9949
|
+
"name": "setupTriggerListener",
|
9950
|
+
"privacy": "private",
|
9951
|
+
"description": "Sets up the trigger event listeners based on the trigger type.",
|
9955
9952
|
"inheritedFrom": {
|
9956
|
-
"name": "
|
9957
|
-
"module": "
|
9953
|
+
"name": "Popover",
|
9954
|
+
"module": "components/popover/popover.component.js"
|
9958
9955
|
}
|
9959
9956
|
},
|
9960
9957
|
{
|
9961
9958
|
"kind": "method",
|
9962
|
-
"name": "
|
9959
|
+
"name": "removeEventListeners",
|
9963
9960
|
"privacy": "private",
|
9961
|
+
"description": "Removes the trigger event listeners.",
|
9962
|
+
"inheritedFrom": {
|
9963
|
+
"name": "Popover",
|
9964
|
+
"module": "components/popover/popover.component.js"
|
9965
|
+
}
|
9966
|
+
},
|
9967
|
+
{
|
9968
|
+
"kind": "field",
|
9969
|
+
"name": "onOutsidePopoverClick",
|
9970
|
+
"privacy": "protected",
|
9971
|
+
"description": "Handles the outside click event to close the popover.",
|
9964
9972
|
"parameters": [
|
9965
9973
|
{
|
9966
|
-
"
|
9967
|
-
"
|
9968
|
-
"text": "HTMLElement"
|
9969
|
-
},
|
9970
|
-
"description": "The element to check."
|
9974
|
+
"description": "The mouse event.",
|
9975
|
+
"name": "event"
|
9971
9976
|
}
|
9972
9977
|
],
|
9973
|
-
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
9974
|
-
"return": {
|
9975
|
-
"type": {
|
9976
|
-
"text": ""
|
9977
|
-
}
|
9978
|
-
},
|
9979
9978
|
"inheritedFrom": {
|
9980
|
-
"name": "
|
9981
|
-
"module": "
|
9979
|
+
"name": "Popover",
|
9980
|
+
"module": "components/popover/popover.component.js"
|
9982
9981
|
}
|
9983
9982
|
},
|
9984
9983
|
{
|
9985
|
-
"kind": "
|
9986
|
-
"name": "
|
9984
|
+
"kind": "field",
|
9985
|
+
"name": "onEscapeKeydown",
|
9987
9986
|
"privacy": "private",
|
9987
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
9988
9988
|
"parameters": [
|
9989
9989
|
{
|
9990
|
-
"
|
9991
|
-
"
|
9992
|
-
"text": "HTMLElement"
|
9993
|
-
},
|
9994
|
-
"description": "The element to check."
|
9990
|
+
"description": "The keyboard event.",
|
9991
|
+
"name": "event"
|
9995
9992
|
}
|
9996
9993
|
],
|
9997
|
-
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
9998
|
-
"return": {
|
9999
|
-
"type": {
|
10000
|
-
"text": ""
|
10001
|
-
}
|
10002
|
-
},
|
10003
9994
|
"inheritedFrom": {
|
10004
|
-
"name": "
|
10005
|
-
"module": "
|
9995
|
+
"name": "Popover",
|
9996
|
+
"module": "components/popover/popover.component.js"
|
10006
9997
|
}
|
10007
9998
|
},
|
10008
9999
|
{
|
10009
|
-
"kind": "
|
10010
|
-
"name": "
|
10000
|
+
"kind": "field",
|
10001
|
+
"name": "onPopoverFocusOut",
|
10011
10002
|
"privacy": "private",
|
10003
|
+
"description": "Handles the popover focus out event.",
|
10012
10004
|
"parameters": [
|
10013
10005
|
{
|
10014
|
-
"
|
10015
|
-
"
|
10016
|
-
"text": "HTMLElement"
|
10017
|
-
},
|
10018
|
-
"description": "The element to check."
|
10006
|
+
"description": "The focus event.",
|
10007
|
+
"name": "event"
|
10019
10008
|
}
|
10020
10009
|
],
|
10021
|
-
"description": "Determines if the element is not visible in the DOM.",
|
10022
|
-
"return": {
|
10023
|
-
"type": {
|
10024
|
-
"text": ""
|
10025
|
-
}
|
10026
|
-
},
|
10027
10010
|
"inheritedFrom": {
|
10028
|
-
"name": "
|
10029
|
-
"module": "
|
10011
|
+
"name": "Popover",
|
10012
|
+
"module": "components/popover/popover.component.js"
|
10030
10013
|
}
|
10031
10014
|
},
|
10032
10015
|
{
|
10033
10016
|
"kind": "method",
|
10034
|
-
"name": "
|
10035
|
-
"privacy": "
|
10017
|
+
"name": "isOpenUpdated",
|
10018
|
+
"privacy": "protected",
|
10036
10019
|
"parameters": [
|
10037
10020
|
{
|
10038
|
-
"name": "
|
10021
|
+
"name": "oldValue",
|
10039
10022
|
"type": {
|
10040
|
-
"text": "
|
10023
|
+
"text": "boolean"
|
10041
10024
|
},
|
10042
|
-
"description": "The
|
10025
|
+
"description": "The old value of the visible property."
|
10026
|
+
},
|
10027
|
+
{
|
10028
|
+
"name": "newValue",
|
10029
|
+
"type": {
|
10030
|
+
"text": "boolean"
|
10031
|
+
},
|
10032
|
+
"description": "The new value of the visible property."
|
10043
10033
|
}
|
10044
10034
|
],
|
10045
|
-
"description": "
|
10046
|
-
"return": {
|
10047
|
-
"type": {
|
10048
|
-
"text": ""
|
10049
|
-
}
|
10050
|
-
},
|
10035
|
+
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
10051
10036
|
"inheritedFrom": {
|
10052
|
-
"name": "
|
10053
|
-
"module": "
|
10037
|
+
"name": "Popover",
|
10038
|
+
"module": "components/popover/popover.component.js"
|
10054
10039
|
}
|
10055
10040
|
},
|
10056
10041
|
{
|
10057
|
-
"kind": "
|
10058
|
-
"name": "
|
10042
|
+
"kind": "field",
|
10043
|
+
"name": "handleMouseEnter",
|
10059
10044
|
"privacy": "private",
|
10060
|
-
"
|
10061
|
-
|
10062
|
-
|
10063
|
-
|
10064
|
-
|
10065
|
-
|
10066
|
-
|
10067
|
-
|
10068
|
-
|
10069
|
-
"
|
10070
|
-
"
|
10071
|
-
|
10072
|
-
|
10073
|
-
|
10074
|
-
}
|
10045
|
+
"description": "Handles mouse enter event on the trigger element.\nThis method sets the `isHovered` flag to true and shows the popover",
|
10046
|
+
"inheritedFrom": {
|
10047
|
+
"name": "Popover",
|
10048
|
+
"module": "components/popover/popover.component.js"
|
10049
|
+
}
|
10050
|
+
},
|
10051
|
+
{
|
10052
|
+
"kind": "field",
|
10053
|
+
"name": "handleMouseLeave",
|
10054
|
+
"privacy": "private",
|
10055
|
+
"description": "Handles mouse leave event on the trigger element.\nThis method sets the `isHovered` flag to false and starts the close delay\ntimer to hide the popover.",
|
10056
|
+
"inheritedFrom": {
|
10057
|
+
"name": "Popover",
|
10058
|
+
"module": "components/popover/popover.component.js"
|
10059
|
+
}
|
10060
|
+
},
|
10061
|
+
{
|
10062
|
+
"kind": "field",
|
10063
|
+
"name": "handleFocusOut",
|
10064
|
+
"privacy": "private",
|
10065
|
+
"description": "Handles focus out event on the trigger element.\nThis method checks if the popover is not hovered and hides the popover.\nIf the popover is hovered, it will not hide the popover.",
|
10066
|
+
"inheritedFrom": {
|
10067
|
+
"name": "Popover",
|
10068
|
+
"module": "components/popover/popover.component.js"
|
10069
|
+
}
|
10070
|
+
},
|
10071
|
+
{
|
10072
|
+
"kind": "field",
|
10073
|
+
"name": "startCloseDelay",
|
10074
|
+
"privacy": "private",
|
10075
|
+
"description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
|
10076
|
+
"inheritedFrom": {
|
10077
|
+
"name": "Popover",
|
10078
|
+
"module": "components/popover/popover.component.js"
|
10079
|
+
}
|
10080
|
+
},
|
10081
|
+
{
|
10082
|
+
"kind": "field",
|
10083
|
+
"name": "cancelCloseDelay",
|
10084
|
+
"privacy": "private",
|
10085
|
+
"description": "Cancels the close delay timer.",
|
10086
|
+
"inheritedFrom": {
|
10087
|
+
"name": "Popover",
|
10088
|
+
"module": "components/popover/popover.component.js"
|
10089
|
+
}
|
10090
|
+
},
|
10091
|
+
{
|
10092
|
+
"kind": "field",
|
10093
|
+
"name": "showPopover",
|
10094
|
+
"privacy": "public",
|
10095
|
+
"description": "Shows the popover.",
|
10075
10096
|
"inheritedFrom": {
|
10076
|
-
"name": "
|
10077
|
-
"module": "
|
10097
|
+
"name": "Popover",
|
10098
|
+
"module": "components/popover/popover.component.js"
|
10078
10099
|
}
|
10079
10100
|
},
|
10080
10101
|
{
|
10081
|
-
"kind": "
|
10082
|
-
"name": "
|
10083
|
-
"privacy": "
|
10084
|
-
"
|
10085
|
-
{
|
10086
|
-
"name": "element",
|
10087
|
-
"type": {
|
10088
|
-
"text": "HTMLElement"
|
10089
|
-
},
|
10090
|
-
"description": "The element to check."
|
10091
|
-
}
|
10092
|
-
],
|
10093
|
-
"description": "Checks if the element is hidden from the user.",
|
10094
|
-
"return": {
|
10095
|
-
"type": {
|
10096
|
-
"text": ""
|
10097
|
-
}
|
10098
|
-
},
|
10102
|
+
"kind": "field",
|
10103
|
+
"name": "hidePopover",
|
10104
|
+
"privacy": "public",
|
10105
|
+
"description": "Hides the popover.",
|
10099
10106
|
"inheritedFrom": {
|
10100
|
-
"name": "
|
10101
|
-
"module": "
|
10107
|
+
"name": "Popover",
|
10108
|
+
"module": "components/popover/popover.component.js"
|
10102
10109
|
}
|
10103
10110
|
},
|
10104
10111
|
{
|
10105
|
-
"kind": "
|
10106
|
-
"name": "
|
10107
|
-
"privacy": "
|
10108
|
-
"
|
10109
|
-
{
|
10110
|
-
"name": "element",
|
10111
|
-
"type": {
|
10112
|
-
"text": "any"
|
10113
|
-
},
|
10114
|
-
"description": "The element to check."
|
10115
|
-
}
|
10116
|
-
],
|
10117
|
-
"description": "Checks if the element is disabled.",
|
10118
|
-
"return": {
|
10119
|
-
"type": {
|
10120
|
-
"text": ""
|
10121
|
-
}
|
10122
|
-
},
|
10112
|
+
"kind": "field",
|
10113
|
+
"name": "togglePopoverVisible",
|
10114
|
+
"privacy": "public",
|
10115
|
+
"description": "Toggles the popover visibility.",
|
10123
10116
|
"inheritedFrom": {
|
10124
|
-
"name": "
|
10125
|
-
"module": "
|
10117
|
+
"name": "Popover",
|
10118
|
+
"module": "components/popover/popover.component.js"
|
10126
10119
|
}
|
10127
10120
|
},
|
10128
10121
|
{
|
10129
10122
|
"kind": "method",
|
10130
|
-
"name": "
|
10123
|
+
"name": "positionPopover",
|
10131
10124
|
"privacy": "private",
|
10132
|
-
"
|
10133
|
-
{
|
10134
|
-
"name": "element",
|
10135
|
-
"type": {
|
10136
|
-
"text": "HTMLElement"
|
10137
|
-
},
|
10138
|
-
"description": "The element to check."
|
10139
|
-
}
|
10140
|
-
],
|
10141
|
-
"description": "Checks if the element is not tabbable.",
|
10142
|
-
"return": {
|
10143
|
-
"type": {
|
10144
|
-
"text": ""
|
10145
|
-
}
|
10146
|
-
},
|
10125
|
+
"description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
|
10147
10126
|
"inheritedFrom": {
|
10148
|
-
"name": "
|
10149
|
-
"module": "
|
10127
|
+
"name": "Popover",
|
10128
|
+
"module": "components/popover/popover.component.js"
|
10150
10129
|
}
|
10151
10130
|
},
|
10152
10131
|
{
|
10153
10132
|
"kind": "method",
|
10154
|
-
"name": "
|
10155
|
-
"privacy": "
|
10133
|
+
"name": "findClosestPopover",
|
10134
|
+
"privacy": "protected",
|
10156
10135
|
"return": {
|
10157
10136
|
"type": {
|
10158
|
-
"text": ""
|
10137
|
+
"text": "Popover | null"
|
10159
10138
|
}
|
10160
10139
|
},
|
10161
10140
|
"parameters": [
|
10162
10141
|
{
|
10163
10142
|
"name": "element",
|
10164
10143
|
"type": {
|
10165
|
-
"text": "
|
10144
|
+
"text": "Element"
|
10166
10145
|
},
|
10167
|
-
"description": "The element to
|
10146
|
+
"description": "The element to start searching from."
|
10168
10147
|
}
|
10169
10148
|
],
|
10170
|
-
"description": "
|
10149
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
10171
10150
|
"inheritedFrom": {
|
10172
|
-
"name": "
|
10173
|
-
"module": "
|
10151
|
+
"name": "Popover",
|
10152
|
+
"module": "components/popover/popover.component.js"
|
10174
10153
|
}
|
10175
10154
|
},
|
10176
10155
|
{
|
10177
|
-
"kind": "
|
10178
|
-
"name": "
|
10179
|
-
"
|
10180
|
-
"parameters": [
|
10181
|
-
{
|
10182
|
-
"name": "element",
|
10183
|
-
"type": {
|
10184
|
-
"text": "HTMLElement"
|
10185
|
-
},
|
10186
|
-
"description": "The element to check."
|
10187
|
-
}
|
10188
|
-
],
|
10189
|
-
"description": "Checks if the element is focusable.",
|
10190
|
-
"return": {
|
10191
|
-
"type": {
|
10192
|
-
"text": ""
|
10193
|
-
}
|
10194
|
-
},
|
10156
|
+
"kind": "field",
|
10157
|
+
"name": "utils",
|
10158
|
+
"default": "new PopoverUtils(this)",
|
10195
10159
|
"inheritedFrom": {
|
10196
|
-
"name": "
|
10197
|
-
"module": "
|
10160
|
+
"name": "Popover",
|
10161
|
+
"module": "components/popover/popover.component.js"
|
10162
|
+
}
|
10163
|
+
}
|
10164
|
+
],
|
10165
|
+
"events": [
|
10166
|
+
{
|
10167
|
+
"description": "(React: onShown) This event is dispatched when the coachmark is shown",
|
10168
|
+
"name": "shown",
|
10169
|
+
"reactName": "onShown",
|
10170
|
+
"inheritedFrom": {
|
10171
|
+
"name": "Popover",
|
10172
|
+
"module": "src/components/popover/popover.component.ts"
|
10198
10173
|
}
|
10199
10174
|
},
|
10200
10175
|
{
|
10201
|
-
"
|
10202
|
-
"name": "
|
10203
|
-
"
|
10204
|
-
"return": {
|
10205
|
-
"type": {
|
10206
|
-
"text": ""
|
10207
|
-
}
|
10208
|
-
},
|
10209
|
-
"parameters": [
|
10210
|
-
{
|
10211
|
-
"name": "root",
|
10212
|
-
"type": {
|
10213
|
-
"text": "ShadowRoot | HTMLElement"
|
10214
|
-
},
|
10215
|
-
"description": "The root element to search for focusable elements."
|
10216
|
-
},
|
10217
|
-
{
|
10218
|
-
"name": "matches",
|
10219
|
-
"default": "new Set()",
|
10220
|
-
"type": {
|
10221
|
-
"text": "Set<HTMLElement>"
|
10222
|
-
},
|
10223
|
-
"description": "The set of focusable elements."
|
10224
|
-
}
|
10225
|
-
],
|
10226
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
10176
|
+
"description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
|
10177
|
+
"name": "hidden",
|
10178
|
+
"reactName": "onHidden",
|
10227
10179
|
"inheritedFrom": {
|
10228
|
-
"name": "
|
10229
|
-
"module": "
|
10180
|
+
"name": "Popover",
|
10181
|
+
"module": "src/components/popover/popover.component.ts"
|
10230
10182
|
}
|
10231
10183
|
},
|
10232
10184
|
{
|
10233
|
-
"
|
10234
|
-
"name": "
|
10235
|
-
"
|
10236
|
-
"description": "Updates the list of focusable elements within the component's shadow root.",
|
10185
|
+
"description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
|
10186
|
+
"name": "created",
|
10187
|
+
"reactName": "onCreated",
|
10237
10188
|
"inheritedFrom": {
|
10238
|
-
"name": "
|
10239
|
-
"module": "
|
10189
|
+
"name": "Popover",
|
10190
|
+
"module": "src/components/popover/popover.component.ts"
|
10240
10191
|
}
|
10241
10192
|
},
|
10242
10193
|
{
|
10243
|
-
"
|
10244
|
-
"name": "
|
10245
|
-
"
|
10246
|
-
"parameters": [
|
10247
|
-
{
|
10248
|
-
"name": "elementIndexToReceiveFocus",
|
10249
|
-
"default": "0",
|
10250
|
-
"type": {
|
10251
|
-
"text": "number"
|
10252
|
-
},
|
10253
|
-
"description": "The index of the preferable element to focus."
|
10254
|
-
}
|
10255
|
-
],
|
10256
|
-
"description": "Sets the initial focus within the container.",
|
10194
|
+
"description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
|
10195
|
+
"name": "destroyed",
|
10196
|
+
"reactName": "onDestroyed",
|
10257
10197
|
"inheritedFrom": {
|
10258
|
-
"name": "
|
10259
|
-
"module": "
|
10198
|
+
"name": "Popover",
|
10199
|
+
"module": "src/components/popover/popover.component.ts"
|
10200
|
+
}
|
10201
|
+
}
|
10202
|
+
],
|
10203
|
+
"attributes": [
|
10204
|
+
{
|
10205
|
+
"name": "trigger",
|
10206
|
+
"type": {
|
10207
|
+
"text": "PopoverTrigger"
|
10208
|
+
},
|
10209
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
10210
|
+
"default": "manual",
|
10211
|
+
"fieldName": "trigger",
|
10212
|
+
"inheritedFrom": {
|
10213
|
+
"name": "Popover",
|
10214
|
+
"module": "src/components/popover/popover.component.ts"
|
10260
10215
|
}
|
10261
10216
|
},
|
10262
10217
|
{
|
10263
|
-
"
|
10264
|
-
"
|
10265
|
-
|
10266
|
-
|
10267
|
-
|
10268
|
-
|
10269
|
-
|
10270
|
-
|
10271
|
-
|
10272
|
-
|
10273
|
-
|
10274
|
-
|
10275
|
-
|
10276
|
-
|
10277
|
-
|
10278
|
-
|
10279
|
-
"description": "The step to calculate the next index."
|
10280
|
-
}
|
10281
|
-
],
|
10282
|
-
"description": "Calculates the next index for the focus trap.",
|
10283
|
-
"return": {
|
10284
|
-
"type": {
|
10285
|
-
"text": ""
|
10286
|
-
}
|
10218
|
+
"name": "show-arrow",
|
10219
|
+
"type": {
|
10220
|
+
"text": "boolean"
|
10221
|
+
},
|
10222
|
+
"description": "The arrow visibility of the Coachmark.",
|
10223
|
+
"default": "true",
|
10224
|
+
"fieldName": "showArrow",
|
10225
|
+
"inheritedFrom": {
|
10226
|
+
"name": "Popover",
|
10227
|
+
"module": "src/components/popover/popover.component.ts"
|
10228
|
+
}
|
10229
|
+
},
|
10230
|
+
{
|
10231
|
+
"name": "close-button",
|
10232
|
+
"type": {
|
10233
|
+
"text": "boolean"
|
10287
10234
|
},
|
10235
|
+
"description": "The close button visibility of the Coachmark.",
|
10236
|
+
"default": "true",
|
10237
|
+
"fieldName": "closeButton",
|
10288
10238
|
"inheritedFrom": {
|
10289
|
-
"name": "
|
10290
|
-
"module": "
|
10239
|
+
"name": "Popover",
|
10240
|
+
"module": "src/components/popover/popover.component.ts"
|
10291
10241
|
}
|
10292
10242
|
},
|
10293
10243
|
{
|
10294
|
-
"
|
10295
|
-
"
|
10296
|
-
|
10297
|
-
"description": "Returns the deepest active element in the shadow DOM.",
|
10298
|
-
"return": {
|
10299
|
-
"type": {
|
10300
|
-
"text": ""
|
10301
|
-
}
|
10244
|
+
"name": "disable-aria-expanded",
|
10245
|
+
"type": {
|
10246
|
+
"text": "boolean"
|
10302
10247
|
},
|
10248
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
10249
|
+
"default": "true",
|
10250
|
+
"fieldName": "disableAriaExpanded",
|
10303
10251
|
"inheritedFrom": {
|
10304
|
-
"name": "
|
10305
|
-
"module": "
|
10252
|
+
"name": "Popover",
|
10253
|
+
"module": "src/components/popover/popover.component.ts"
|
10306
10254
|
}
|
10307
10255
|
},
|
10308
10256
|
{
|
10309
|
-
"
|
10310
|
-
"
|
10311
|
-
|
10312
|
-
"parameters": [
|
10313
|
-
{
|
10314
|
-
"name": "activeElement",
|
10315
|
-
"type": {
|
10316
|
-
"text": "HTMLElement"
|
10317
|
-
},
|
10318
|
-
"description": "The active element."
|
10319
|
-
}
|
10320
|
-
],
|
10321
|
-
"description": "Finds the index of the active element within the focusable elements.",
|
10322
|
-
"return": {
|
10323
|
-
"type": {
|
10324
|
-
"text": ""
|
10325
|
-
}
|
10257
|
+
"name": "should-focus-trap-wrap",
|
10258
|
+
"type": {
|
10259
|
+
"text": "boolean"
|
10326
10260
|
},
|
10261
|
+
"default": "true",
|
10262
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
10263
|
+
"fieldName": "shouldFocusTrapWrap",
|
10327
10264
|
"inheritedFrom": {
|
10328
10265
|
"name": "FocusTrapMixin",
|
10329
|
-
"module": "utils/mixins/FocusTrapMixin.
|
10266
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
10330
10267
|
}
|
10331
10268
|
},
|
10332
10269
|
{
|
10333
|
-
"
|
10334
|
-
"
|
10335
|
-
|
10336
|
-
"parameters": [
|
10337
|
-
{
|
10338
|
-
"name": "activeElement",
|
10339
|
-
"type": {
|
10340
|
-
"text": "HTMLElement"
|
10341
|
-
},
|
10342
|
-
"description": "The active element."
|
10343
|
-
},
|
10344
|
-
{
|
10345
|
-
"name": "element",
|
10346
|
-
"type": {
|
10347
|
-
"text": "HTMLElement"
|
10348
|
-
},
|
10349
|
-
"description": "The element to compare."
|
10350
|
-
}
|
10351
|
-
],
|
10352
|
-
"description": "Checks if the active element is equal to the given element.",
|
10353
|
-
"return": {
|
10354
|
-
"type": {
|
10355
|
-
"text": ""
|
10356
|
-
}
|
10270
|
+
"name": "id",
|
10271
|
+
"type": {
|
10272
|
+
"text": "string"
|
10357
10273
|
},
|
10274
|
+
"default": "''",
|
10275
|
+
"description": "The unique ID of the popover.",
|
10276
|
+
"fieldName": "id",
|
10358
10277
|
"inheritedFrom": {
|
10359
|
-
"name": "
|
10360
|
-
"module": "
|
10278
|
+
"name": "Popover",
|
10279
|
+
"module": "src/components/popover/popover.component.ts"
|
10361
10280
|
}
|
10362
10281
|
},
|
10363
10282
|
{
|
10364
|
-
"
|
10365
|
-
"
|
10366
|
-
|
10367
|
-
|
10368
|
-
|
10369
|
-
|
10370
|
-
|
10371
|
-
"text": "KeyboardEvent"
|
10372
|
-
}
|
10373
|
-
},
|
10374
|
-
{
|
10375
|
-
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
10376
|
-
"name": "direction"
|
10377
|
-
}
|
10378
|
-
],
|
10379
|
-
"description": "Traps focus within the container.",
|
10283
|
+
"name": "triggerID",
|
10284
|
+
"type": {
|
10285
|
+
"text": "string"
|
10286
|
+
},
|
10287
|
+
"default": "''",
|
10288
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
10289
|
+
"fieldName": "triggerID",
|
10380
10290
|
"inheritedFrom": {
|
10381
|
-
"name": "
|
10382
|
-
"module": "
|
10291
|
+
"name": "Popover",
|
10292
|
+
"module": "src/components/popover/popover.component.ts"
|
10383
10293
|
}
|
10384
10294
|
},
|
10385
10295
|
{
|
10386
|
-
"
|
10387
|
-
"
|
10388
|
-
|
10389
|
-
|
10390
|
-
|
10391
|
-
|
10392
|
-
|
10393
|
-
"text": "KeyboardEvent"
|
10394
|
-
},
|
10395
|
-
"description": "The keyboard event."
|
10396
|
-
}
|
10397
|
-
],
|
10398
|
-
"description": "Traps focus within the container.",
|
10296
|
+
"name": "placement",
|
10297
|
+
"type": {
|
10298
|
+
"text": "PopoverPlacement"
|
10299
|
+
},
|
10300
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
10301
|
+
"default": "bottom",
|
10302
|
+
"fieldName": "placement",
|
10399
10303
|
"inheritedFrom": {
|
10400
|
-
"name": "
|
10401
|
-
"module": "
|
10304
|
+
"name": "Popover",
|
10305
|
+
"module": "src/components/popover/popover.component.ts"
|
10402
10306
|
}
|
10403
10307
|
},
|
10404
10308
|
{
|
10405
|
-
"
|
10406
|
-
"
|
10407
|
-
|
10408
|
-
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
10409
|
-
"return": {
|
10410
|
-
"type": {
|
10411
|
-
"text": ""
|
10412
|
-
}
|
10309
|
+
"name": "color",
|
10310
|
+
"type": {
|
10311
|
+
"text": "PopoverColor"
|
10413
10312
|
},
|
10313
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
10314
|
+
"default": "tonal",
|
10315
|
+
"fieldName": "color",
|
10414
10316
|
"inheritedFrom": {
|
10415
|
-
"name": "
|
10416
|
-
"module": "
|
10317
|
+
"name": "Popover",
|
10318
|
+
"module": "src/components/popover/popover.component.ts"
|
10417
10319
|
}
|
10418
|
-
}
|
10419
|
-
],
|
10420
|
-
"events": [
|
10320
|
+
},
|
10421
10321
|
{
|
10422
|
-
"
|
10423
|
-
"
|
10424
|
-
|
10322
|
+
"name": "visible",
|
10323
|
+
"type": {
|
10324
|
+
"text": "boolean"
|
10325
|
+
},
|
10326
|
+
"description": "The visibility of the popover.",
|
10327
|
+
"default": "false",
|
10328
|
+
"fieldName": "visible",
|
10329
|
+
"inheritedFrom": {
|
10330
|
+
"name": "Popover",
|
10331
|
+
"module": "src/components/popover/popover.component.ts"
|
10332
|
+
}
|
10425
10333
|
},
|
10426
10334
|
{
|
10427
|
-
"
|
10428
|
-
"
|
10429
|
-
|
10335
|
+
"name": "offset",
|
10336
|
+
"type": {
|
10337
|
+
"text": "number"
|
10338
|
+
},
|
10339
|
+
"description": "The offset of the popover.",
|
10340
|
+
"default": "4",
|
10341
|
+
"fieldName": "offset",
|
10342
|
+
"inheritedFrom": {
|
10343
|
+
"name": "Popover",
|
10344
|
+
"module": "src/components/popover/popover.component.ts"
|
10345
|
+
}
|
10430
10346
|
},
|
10431
10347
|
{
|
10432
|
-
"
|
10433
|
-
"
|
10434
|
-
|
10348
|
+
"name": "boundary",
|
10349
|
+
"type": {
|
10350
|
+
"text": "'clippingAncestors' | string"
|
10351
|
+
},
|
10352
|
+
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
10353
|
+
"default": "'clippingAncestors'",
|
10354
|
+
"fieldName": "boundary",
|
10355
|
+
"inheritedFrom": {
|
10356
|
+
"name": "Popover",
|
10357
|
+
"module": "src/components/popover/popover.component.ts"
|
10358
|
+
}
|
10435
10359
|
},
|
10436
10360
|
{
|
10437
|
-
"
|
10438
|
-
"
|
10439
|
-
|
10361
|
+
"name": "boundary-root",
|
10362
|
+
"type": {
|
10363
|
+
"text": "'viewport' | 'document'"
|
10364
|
+
},
|
10365
|
+
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
10366
|
+
"default": "'viewport'",
|
10367
|
+
"fieldName": "boundaryRoot",
|
10368
|
+
"inheritedFrom": {
|
10369
|
+
"name": "Popover",
|
10370
|
+
"module": "src/components/popover/popover.component.ts"
|
10371
|
+
}
|
10440
10372
|
},
|
10441
10373
|
{
|
10442
|
-
"
|
10443
|
-
"
|
10444
|
-
|
10445
|
-
|
10446
|
-
|
10447
|
-
|
10374
|
+
"name": "boundary-padding",
|
10375
|
+
"type": {
|
10376
|
+
"text": "undefined | number"
|
10377
|
+
},
|
10378
|
+
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
10379
|
+
"default": "undefined",
|
10380
|
+
"fieldName": "boundaryPadding",
|
10381
|
+
"inheritedFrom": {
|
10382
|
+
"name": "Popover",
|
10383
|
+
"module": "src/components/popover/popover.component.ts"
|
10384
|
+
}
|
10385
|
+
},
|
10448
10386
|
{
|
10449
|
-
"name": "
|
10387
|
+
"name": "focus-trap",
|
10450
10388
|
"type": {
|
10451
|
-
"text": "
|
10389
|
+
"text": "boolean"
|
10452
10390
|
},
|
10453
|
-
"
|
10454
|
-
"
|
10455
|
-
"fieldName": "
|
10391
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
10392
|
+
"default": "false",
|
10393
|
+
"fieldName": "focusTrap",
|
10394
|
+
"inheritedFrom": {
|
10395
|
+
"name": "Popover",
|
10396
|
+
"module": "src/components/popover/popover.component.ts"
|
10397
|
+
}
|
10456
10398
|
},
|
10457
10399
|
{
|
10458
|
-
"name": "
|
10400
|
+
"name": "prevent-scroll",
|
10459
10401
|
"type": {
|
10460
|
-
"text": "
|
10402
|
+
"text": "boolean"
|
10461
10403
|
},
|
10462
|
-
"description": "
|
10463
|
-
"default": "
|
10464
|
-
"fieldName": "
|
10404
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
10405
|
+
"default": "false",
|
10406
|
+
"fieldName": "preventScroll",
|
10407
|
+
"inheritedFrom": {
|
10408
|
+
"name": "Popover",
|
10409
|
+
"module": "src/components/popover/popover.component.ts"
|
10410
|
+
}
|
10465
10411
|
},
|
10466
10412
|
{
|
10467
|
-
"name": "
|
10413
|
+
"name": "interactive",
|
10468
10414
|
"type": {
|
10469
10415
|
"text": "boolean"
|
10470
10416
|
},
|
10471
|
-
"description": "
|
10417
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
10472
10418
|
"default": "false",
|
10473
|
-
"fieldName": "
|
10419
|
+
"fieldName": "interactive",
|
10420
|
+
"inheritedFrom": {
|
10421
|
+
"name": "Popover",
|
10422
|
+
"module": "src/components/popover/popover.component.ts"
|
10423
|
+
}
|
10474
10424
|
},
|
10475
10425
|
{
|
10476
|
-
"name": "
|
10426
|
+
"name": "delay",
|
10477
10427
|
"type": {
|
10478
|
-
"text": "
|
10428
|
+
"text": "string"
|
10479
10429
|
},
|
10480
|
-
"description": "The
|
10481
|
-
"default": "
|
10482
|
-
"fieldName": "
|
10430
|
+
"description": "The delay of the show/hide popover.",
|
10431
|
+
"default": "0,0",
|
10432
|
+
"fieldName": "delay",
|
10433
|
+
"inheritedFrom": {
|
10434
|
+
"name": "Popover",
|
10435
|
+
"module": "src/components/popover/popover.component.ts"
|
10436
|
+
}
|
10483
10437
|
},
|
10484
10438
|
{
|
10485
|
-
"name": "
|
10439
|
+
"name": "hide-on-escape",
|
10486
10440
|
"type": {
|
10487
|
-
"text": "
|
10441
|
+
"text": "boolean"
|
10488
10442
|
},
|
10489
|
-
"description": "
|
10490
|
-
"default": "
|
10491
|
-
"fieldName": "
|
10443
|
+
"description": "Hide popover on escape key press.",
|
10444
|
+
"default": "false",
|
10445
|
+
"fieldName": "hideOnEscape",
|
10446
|
+
"inheritedFrom": {
|
10447
|
+
"name": "Popover",
|
10448
|
+
"module": "src/components/popover/popover.component.ts"
|
10449
|
+
}
|
10492
10450
|
},
|
10493
10451
|
{
|
10494
|
-
"name": "
|
10452
|
+
"name": "propagate-event-on-escape",
|
10495
10453
|
"type": {
|
10496
|
-
"text": "
|
10454
|
+
"text": "boolean"
|
10497
10455
|
},
|
10498
|
-
"description": "
|
10499
|
-
"default": "
|
10500
|
-
"fieldName": "
|
10456
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
10457
|
+
"default": "false",
|
10458
|
+
"fieldName": "propagateEventOnEscape",
|
10459
|
+
"inheritedFrom": {
|
10460
|
+
"name": "Popover",
|
10461
|
+
"module": "src/components/popover/popover.component.ts"
|
10462
|
+
}
|
10501
10463
|
},
|
10502
10464
|
{
|
10503
|
-
"name": "
|
10465
|
+
"name": "hide-on-blur",
|
10504
10466
|
"type": {
|
10505
|
-
"text": "
|
10467
|
+
"text": "boolean"
|
10506
10468
|
},
|
10507
|
-
"
|
10508
|
-
"
|
10509
|
-
"fieldName": "
|
10469
|
+
"description": "Hide popover on blur.",
|
10470
|
+
"default": "false",
|
10471
|
+
"fieldName": "hideOnBlur",
|
10472
|
+
"inheritedFrom": {
|
10473
|
+
"name": "Popover",
|
10474
|
+
"module": "src/components/popover/popover.component.ts"
|
10475
|
+
}
|
10510
10476
|
},
|
10511
10477
|
{
|
10512
|
-
"name": "
|
10478
|
+
"name": "hide-on-outside-click",
|
10513
10479
|
"type": {
|
10514
|
-
"text": "
|
10480
|
+
"text": "boolean"
|
10515
10481
|
},
|
10516
|
-
"
|
10517
|
-
"
|
10518
|
-
"fieldName": "
|
10482
|
+
"description": "Hide on outside click of the popover.",
|
10483
|
+
"default": "false",
|
10484
|
+
"fieldName": "hideOnOutsideClick",
|
10485
|
+
"inheritedFrom": {
|
10486
|
+
"name": "Popover",
|
10487
|
+
"module": "src/components/popover/popover.component.ts"
|
10488
|
+
}
|
10519
10489
|
},
|
10520
10490
|
{
|
10521
|
-
"name": "
|
10491
|
+
"name": "focus-back-to-trigger",
|
10522
10492
|
"type": {
|
10523
|
-
"text": "
|
10493
|
+
"text": "boolean"
|
10524
10494
|
},
|
10525
|
-
"
|
10526
|
-
"
|
10527
|
-
"fieldName": "
|
10495
|
+
"description": "The focus back to trigger after the popover hide.",
|
10496
|
+
"default": "false",
|
10497
|
+
"fieldName": "focusBackToTrigger",
|
10498
|
+
"inheritedFrom": {
|
10499
|
+
"name": "Popover",
|
10500
|
+
"module": "src/components/popover/popover.component.ts"
|
10501
|
+
}
|
10528
10502
|
},
|
10529
10503
|
{
|
10530
|
-
"name": "
|
10504
|
+
"name": "backdrop",
|
10531
10505
|
"type": {
|
10532
|
-
"text": "
|
10506
|
+
"text": "boolean"
|
10533
10507
|
},
|
10534
|
-
"
|
10535
|
-
"
|
10536
|
-
"fieldName": "
|
10508
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
10509
|
+
"default": "false",
|
10510
|
+
"fieldName": "backdrop",
|
10511
|
+
"inheritedFrom": {
|
10512
|
+
"name": "Popover",
|
10513
|
+
"module": "src/components/popover/popover.component.ts"
|
10514
|
+
}
|
10537
10515
|
},
|
10538
10516
|
{
|
10539
|
-
"name": "
|
10517
|
+
"name": "flip",
|
10540
10518
|
"type": {
|
10541
|
-
"text": "
|
10519
|
+
"text": "boolean"
|
10542
10520
|
},
|
10543
|
-
"
|
10544
|
-
"
|
10545
|
-
"fieldName": "
|
10521
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
10522
|
+
"default": "true",
|
10523
|
+
"fieldName": "flip",
|
10524
|
+
"inheritedFrom": {
|
10525
|
+
"name": "Popover",
|
10526
|
+
"module": "src/components/popover/popover.component.ts"
|
10527
|
+
}
|
10546
10528
|
},
|
10547
10529
|
{
|
10548
|
-
"name": "
|
10530
|
+
"name": "size",
|
10549
10531
|
"type": {
|
10550
|
-
"text": "
|
10532
|
+
"text": "boolean"
|
10551
10533
|
},
|
10552
|
-
"description": "
|
10553
|
-
"
|
10534
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
10535
|
+
"default": "false",
|
10536
|
+
"fieldName": "size",
|
10537
|
+
"inheritedFrom": {
|
10538
|
+
"name": "Popover",
|
10539
|
+
"module": "src/components/popover/popover.component.ts"
|
10540
|
+
}
|
10554
10541
|
},
|
10555
10542
|
{
|
10556
|
-
"name": "
|
10543
|
+
"name": "z-index",
|
10557
10544
|
"type": {
|
10558
|
-
"text": "
|
10545
|
+
"text": "number"
|
10559
10546
|
},
|
10560
|
-
"description": "
|
10561
|
-
"
|
10547
|
+
"description": "The z-index of the popover.",
|
10548
|
+
"default": "1000",
|
10549
|
+
"fieldName": "zIndex",
|
10550
|
+
"inheritedFrom": {
|
10551
|
+
"name": "Popover",
|
10552
|
+
"module": "src/components/popover/popover.component.ts"
|
10553
|
+
}
|
10562
10554
|
},
|
10563
10555
|
{
|
10564
|
-
"name": "
|
10556
|
+
"name": "append-to",
|
10565
10557
|
"type": {
|
10566
|
-
"text": "string"
|
10558
|
+
"text": "string | undefined"
|
10567
10559
|
},
|
10568
|
-
"description": "
|
10569
|
-
"
|
10560
|
+
"description": "Element ID that the popover append to.",
|
10561
|
+
"default": "''",
|
10562
|
+
"fieldName": "appendTo",
|
10563
|
+
"inheritedFrom": {
|
10564
|
+
"name": "Popover",
|
10565
|
+
"module": "src/components/popover/popover.component.ts"
|
10566
|
+
}
|
10570
10567
|
},
|
10571
10568
|
{
|
10572
|
-
"name": "
|
10569
|
+
"name": "close-button-aria-label",
|
10573
10570
|
"type": {
|
10574
|
-
"text": "string"
|
10571
|
+
"text": "string | null"
|
10575
10572
|
},
|
10576
|
-
"
|
10577
|
-
"
|
10573
|
+
"default": "null",
|
10574
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
10575
|
+
"fieldName": "closeButtonAriaLabel",
|
10576
|
+
"inheritedFrom": {
|
10577
|
+
"name": "Popover",
|
10578
|
+
"module": "src/components/popover/popover.component.ts"
|
10579
|
+
}
|
10578
10580
|
},
|
10579
10581
|
{
|
10580
10582
|
"name": "role",
|
10581
10583
|
"type": {
|
10582
|
-
"text": "
|
10584
|
+
"text": "HTMLElement['role']"
|
10583
10585
|
},
|
10584
|
-
"description": "Role of the
|
10586
|
+
"description": "Role of the popover",
|
10585
10587
|
"default": "dialog",
|
10586
|
-
"fieldName": "role"
|
10588
|
+
"fieldName": "role",
|
10589
|
+
"inheritedFrom": {
|
10590
|
+
"name": "Popover",
|
10591
|
+
"module": "src/components/popover/popover.component.ts"
|
10592
|
+
}
|
10587
10593
|
},
|
10588
10594
|
{
|
10589
|
-
"name": "
|
10595
|
+
"name": "aria-labelledby",
|
10590
10596
|
"type": {
|
10591
|
-
"text": "
|
10597
|
+
"text": "string | null"
|
10592
10598
|
},
|
10593
|
-
"
|
10594
|
-
"
|
10595
|
-
"fieldName": "
|
10599
|
+
"default": "null",
|
10600
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
10601
|
+
"fieldName": "ariaLabelledby",
|
10602
|
+
"inheritedFrom": {
|
10603
|
+
"name": "Popover",
|
10604
|
+
"module": "src/components/popover/popover.component.ts"
|
10605
|
+
}
|
10596
10606
|
},
|
10597
10607
|
{
|
10598
|
-
"name": "
|
10608
|
+
"name": "aria-describedby",
|
10599
10609
|
"type": {
|
10600
|
-
"text": "
|
10610
|
+
"text": "string | null"
|
10601
10611
|
},
|
10602
|
-
"
|
10603
|
-
"
|
10604
|
-
"fieldName": "
|
10612
|
+
"default": "null",
|
10613
|
+
"description": "aria-describedby of the popover.",
|
10614
|
+
"fieldName": "ariaDescribedby",
|
10615
|
+
"inheritedFrom": {
|
10616
|
+
"name": "Popover",
|
10617
|
+
"module": "src/components/popover/popover.component.ts"
|
10618
|
+
}
|
10605
10619
|
},
|
10606
10620
|
{
|
10607
|
-
"name": "
|
10621
|
+
"name": "disable-aria-haspopup",
|
10608
10622
|
"type": {
|
10609
10623
|
"text": "boolean"
|
10610
10624
|
},
|
10611
|
-
"
|
10612
|
-
"
|
10613
|
-
"fieldName": "
|
10625
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
10626
|
+
"default": "false",
|
10627
|
+
"fieldName": "disableAriaHasPopup",
|
10614
10628
|
"inheritedFrom": {
|
10615
|
-
"name": "
|
10616
|
-
"module": "src/
|
10629
|
+
"name": "Popover",
|
10630
|
+
"module": "src/components/popover/popover.component.ts"
|
10617
10631
|
}
|
10618
10632
|
}
|
10619
10633
|
],
|
10620
|
-
"mixins": [
|
10621
|
-
{
|
10622
|
-
"name": "PreventScrollMixin",
|
10623
|
-
"module": "/src/utils/mixins/PreventScrollMixin"
|
10624
|
-
},
|
10625
|
-
{
|
10626
|
-
"name": "FocusTrapMixin",
|
10627
|
-
"module": "/src/utils/mixins/FocusTrapMixin"
|
10628
|
-
},
|
10629
|
-
{
|
10630
|
-
"name": "CardAndDialogFooterMixin",
|
10631
|
-
"module": "/src/utils/mixins/CardAndDialogFooterMixin"
|
10632
|
-
}
|
10633
|
-
],
|
10634
10634
|
"superclass": {
|
10635
|
-
"name": "
|
10636
|
-
"module": "/src/
|
10635
|
+
"name": "Popover",
|
10636
|
+
"module": "/src/components/popover/popover.component"
|
10637
10637
|
},
|
10638
|
-
"tagName": "mdc-
|
10639
|
-
"jsDoc": "/**\n *
|
10638
|
+
"tagName": "mdc-coachmark",
|
10639
|
+
"jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
|
10640
10640
|
"customElement": true
|
10641
10641
|
}
|
10642
10642
|
],
|
@@ -10645,8 +10645,8 @@
|
|
10645
10645
|
"kind": "js",
|
10646
10646
|
"name": "default",
|
10647
10647
|
"declaration": {
|
10648
|
-
"name": "
|
10649
|
-
"module": "components/
|
10648
|
+
"name": "Coachmark",
|
10649
|
+
"module": "components/coachmark/coachmark.component.js"
|
10650
10650
|
}
|
10651
10651
|
}
|
10652
10652
|
]
|