@momentum-design/components 0.120.10 → 0.120.11
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 +1692 -1692
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/package.json +1 -1
@@ -477,6 +477,157 @@
|
|
477
477
|
}
|
478
478
|
]
|
479
479
|
},
|
480
|
+
{
|
481
|
+
"kind": "javascript-module",
|
482
|
+
"path": "components/accordiongroup/accordiongroup.component.js",
|
483
|
+
"declarations": [
|
484
|
+
{
|
485
|
+
"kind": "class",
|
486
|
+
"description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
|
487
|
+
"name": "AccordionGroup",
|
488
|
+
"cssProperties": [
|
489
|
+
{
|
490
|
+
"description": "The border color of the entire accordiongroup",
|
491
|
+
"name": "--mdc-accordiongroup-border-color"
|
492
|
+
}
|
493
|
+
],
|
494
|
+
"slots": [
|
495
|
+
{
|
496
|
+
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
497
|
+
"name": "default"
|
498
|
+
}
|
499
|
+
],
|
500
|
+
"members": [
|
501
|
+
{
|
502
|
+
"kind": "field",
|
503
|
+
"name": "size",
|
504
|
+
"type": {
|
505
|
+
"text": "Size"
|
506
|
+
},
|
507
|
+
"description": "The size of the accordion item.",
|
508
|
+
"default": "'small'",
|
509
|
+
"attribute": "size",
|
510
|
+
"reflects": true
|
511
|
+
},
|
512
|
+
{
|
513
|
+
"kind": "field",
|
514
|
+
"name": "variant",
|
515
|
+
"type": {
|
516
|
+
"text": "Variant"
|
517
|
+
},
|
518
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
519
|
+
"default": "'stacked'",
|
520
|
+
"attribute": "variant",
|
521
|
+
"reflects": true
|
522
|
+
},
|
523
|
+
{
|
524
|
+
"kind": "field",
|
525
|
+
"name": "allowMultiple",
|
526
|
+
"type": {
|
527
|
+
"text": "boolean"
|
528
|
+
},
|
529
|
+
"default": "false",
|
530
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
531
|
+
"attribute": "allow-multiple",
|
532
|
+
"reflects": true
|
533
|
+
},
|
534
|
+
{
|
535
|
+
"kind": "method",
|
536
|
+
"name": "handleAccordionExpanded",
|
537
|
+
"privacy": "private",
|
538
|
+
"return": {
|
539
|
+
"type": {
|
540
|
+
"text": "void"
|
541
|
+
}
|
542
|
+
},
|
543
|
+
"parameters": [
|
544
|
+
{
|
545
|
+
"name": "event",
|
546
|
+
"type": {
|
547
|
+
"text": "Event"
|
548
|
+
},
|
549
|
+
"description": "The event object from the 'shown' event."
|
550
|
+
}
|
551
|
+
],
|
552
|
+
"description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
|
553
|
+
},
|
554
|
+
{
|
555
|
+
"kind": "method",
|
556
|
+
"name": "setChildrenAccordionAttributes",
|
557
|
+
"privacy": "private",
|
558
|
+
"return": {
|
559
|
+
"type": {
|
560
|
+
"text": "void"
|
561
|
+
}
|
562
|
+
},
|
563
|
+
"parameters": [
|
564
|
+
{
|
565
|
+
"name": "attributeName",
|
566
|
+
"type": {
|
567
|
+
"text": "string"
|
568
|
+
},
|
569
|
+
"description": "The name of the attribute to set."
|
570
|
+
},
|
571
|
+
{
|
572
|
+
"name": "attributeValue",
|
573
|
+
"type": {
|
574
|
+
"text": "string"
|
575
|
+
},
|
576
|
+
"description": "The value to set the attribute to."
|
577
|
+
}
|
578
|
+
],
|
579
|
+
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
580
|
+
}
|
581
|
+
],
|
582
|
+
"attributes": [
|
583
|
+
{
|
584
|
+
"name": "size",
|
585
|
+
"type": {
|
586
|
+
"text": "Size"
|
587
|
+
},
|
588
|
+
"description": "The size of the accordion item.",
|
589
|
+
"default": "'small'",
|
590
|
+
"fieldName": "size"
|
591
|
+
},
|
592
|
+
{
|
593
|
+
"name": "variant",
|
594
|
+
"type": {
|
595
|
+
"text": "Variant"
|
596
|
+
},
|
597
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
598
|
+
"default": "'stacked'",
|
599
|
+
"fieldName": "variant"
|
600
|
+
},
|
601
|
+
{
|
602
|
+
"name": "allow-multiple",
|
603
|
+
"type": {
|
604
|
+
"text": "boolean"
|
605
|
+
},
|
606
|
+
"default": "false",
|
607
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
608
|
+
"fieldName": "allowMultiple"
|
609
|
+
}
|
610
|
+
],
|
611
|
+
"superclass": {
|
612
|
+
"name": "Component",
|
613
|
+
"module": "/src/models"
|
614
|
+
},
|
615
|
+
"tagName": "mdc-accordiongroup",
|
616
|
+
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
617
|
+
"customElement": true
|
618
|
+
}
|
619
|
+
],
|
620
|
+
"exports": [
|
621
|
+
{
|
622
|
+
"kind": "js",
|
623
|
+
"name": "default",
|
624
|
+
"declaration": {
|
625
|
+
"name": "AccordionGroup",
|
626
|
+
"module": "components/accordiongroup/accordiongroup.component.js"
|
627
|
+
}
|
628
|
+
}
|
629
|
+
]
|
630
|
+
},
|
480
631
|
{
|
481
632
|
"kind": "javascript-module",
|
482
633
|
"path": "components/accordionbutton/accordionbutton.component.js",
|
@@ -819,241 +970,90 @@
|
|
819
970
|
},
|
820
971
|
{
|
821
972
|
"kind": "javascript-module",
|
822
|
-
"path": "components/
|
973
|
+
"path": "components/alertchip/alertchip.component.js",
|
823
974
|
"declarations": [
|
824
975
|
{
|
825
976
|
"kind": "class",
|
826
|
-
"description": "
|
827
|
-
"name": "
|
977
|
+
"description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
|
978
|
+
"name": "AlertChip",
|
828
979
|
"cssProperties": [
|
829
980
|
{
|
830
|
-
"description": "The
|
831
|
-
"name": "--mdc-
|
981
|
+
"description": "The color of the label text",
|
982
|
+
"name": "--mdc-chip-color"
|
983
|
+
},
|
984
|
+
{
|
985
|
+
"description": "The color of the icon",
|
986
|
+
"name": "--mdc-chip-icon-color"
|
987
|
+
},
|
988
|
+
{
|
989
|
+
"description": "The border color of the alertchip",
|
990
|
+
"name": "--mdc-chip-border-color"
|
991
|
+
},
|
992
|
+
{
|
993
|
+
"description": "The background color of the alertchip",
|
994
|
+
"name": "--mdc-chip-background-color"
|
832
995
|
}
|
833
996
|
],
|
834
|
-
"
|
997
|
+
"cssParts": [
|
835
998
|
{
|
836
|
-
"description": "The
|
837
|
-
"name": "
|
999
|
+
"description": "The alert icon",
|
1000
|
+
"name": "icon"
|
1001
|
+
},
|
1002
|
+
{
|
1003
|
+
"description": "The text label of the alertchip",
|
1004
|
+
"name": "label"
|
838
1005
|
}
|
839
1006
|
],
|
840
1007
|
"members": [
|
841
1008
|
{
|
842
1009
|
"kind": "field",
|
843
|
-
"name": "
|
1010
|
+
"name": "variant",
|
844
1011
|
"type": {
|
845
|
-
"text": "
|
1012
|
+
"text": "VariantType"
|
846
1013
|
},
|
847
|
-
"description": "The
|
848
|
-
"default": "
|
849
|
-
"attribute": "
|
850
|
-
"reflects": true
|
1014
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
1015
|
+
"default": "neutral",
|
1016
|
+
"attribute": "variant"
|
851
1017
|
},
|
852
1018
|
{
|
853
1019
|
"kind": "field",
|
854
|
-
"name": "
|
1020
|
+
"name": "label",
|
855
1021
|
"type": {
|
856
|
-
"text": "
|
1022
|
+
"text": "string"
|
857
1023
|
},
|
858
|
-
"
|
859
|
-
"
|
860
|
-
"attribute": "
|
861
|
-
"reflects": true
|
1024
|
+
"default": "''",
|
1025
|
+
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
1026
|
+
"attribute": "label"
|
862
1027
|
},
|
863
1028
|
{
|
864
1029
|
"kind": "field",
|
865
|
-
"name": "
|
1030
|
+
"name": "autoFocusOnMount",
|
866
1031
|
"type": {
|
867
1032
|
"text": "boolean"
|
868
1033
|
},
|
869
1034
|
"default": "false",
|
870
|
-
"description": "
|
871
|
-
"attribute": "
|
872
|
-
"reflects": true
|
1035
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
1036
|
+
"attribute": "auto-focus-on-mount",
|
1037
|
+
"reflects": true,
|
1038
|
+
"inheritedFrom": {
|
1039
|
+
"name": "AutoFocusOnMountMixin",
|
1040
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
1041
|
+
}
|
873
1042
|
},
|
874
1043
|
{
|
875
|
-
"kind": "
|
876
|
-
"name": "
|
877
|
-
"
|
878
|
-
|
879
|
-
"type": {
|
880
|
-
"text": "void"
|
881
|
-
}
|
1044
|
+
"kind": "field",
|
1045
|
+
"name": "tabIndex",
|
1046
|
+
"type": {
|
1047
|
+
"text": "number"
|
882
1048
|
},
|
883
|
-
"
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
],
|
892
|
-
"description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
|
893
|
-
},
|
894
|
-
{
|
895
|
-
"kind": "method",
|
896
|
-
"name": "setChildrenAccordionAttributes",
|
897
|
-
"privacy": "private",
|
898
|
-
"return": {
|
899
|
-
"type": {
|
900
|
-
"text": "void"
|
901
|
-
}
|
902
|
-
},
|
903
|
-
"parameters": [
|
904
|
-
{
|
905
|
-
"name": "attributeName",
|
906
|
-
"type": {
|
907
|
-
"text": "string"
|
908
|
-
},
|
909
|
-
"description": "The name of the attribute to set."
|
910
|
-
},
|
911
|
-
{
|
912
|
-
"name": "attributeValue",
|
913
|
-
"type": {
|
914
|
-
"text": "string"
|
915
|
-
},
|
916
|
-
"description": "The value to set the attribute to."
|
917
|
-
}
|
918
|
-
],
|
919
|
-
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
920
|
-
}
|
921
|
-
],
|
922
|
-
"attributes": [
|
923
|
-
{
|
924
|
-
"name": "size",
|
925
|
-
"type": {
|
926
|
-
"text": "Size"
|
927
|
-
},
|
928
|
-
"description": "The size of the accordion item.",
|
929
|
-
"default": "'small'",
|
930
|
-
"fieldName": "size"
|
931
|
-
},
|
932
|
-
{
|
933
|
-
"name": "variant",
|
934
|
-
"type": {
|
935
|
-
"text": "Variant"
|
936
|
-
},
|
937
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
938
|
-
"default": "'stacked'",
|
939
|
-
"fieldName": "variant"
|
940
|
-
},
|
941
|
-
{
|
942
|
-
"name": "allow-multiple",
|
943
|
-
"type": {
|
944
|
-
"text": "boolean"
|
945
|
-
},
|
946
|
-
"default": "false",
|
947
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
948
|
-
"fieldName": "allowMultiple"
|
949
|
-
}
|
950
|
-
],
|
951
|
-
"superclass": {
|
952
|
-
"name": "Component",
|
953
|
-
"module": "/src/models"
|
954
|
-
},
|
955
|
-
"tagName": "mdc-accordiongroup",
|
956
|
-
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
957
|
-
"customElement": true
|
958
|
-
}
|
959
|
-
],
|
960
|
-
"exports": [
|
961
|
-
{
|
962
|
-
"kind": "js",
|
963
|
-
"name": "default",
|
964
|
-
"declaration": {
|
965
|
-
"name": "AccordionGroup",
|
966
|
-
"module": "components/accordiongroup/accordiongroup.component.js"
|
967
|
-
}
|
968
|
-
}
|
969
|
-
]
|
970
|
-
},
|
971
|
-
{
|
972
|
-
"kind": "javascript-module",
|
973
|
-
"path": "components/alertchip/alertchip.component.js",
|
974
|
-
"declarations": [
|
975
|
-
{
|
976
|
-
"kind": "class",
|
977
|
-
"description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
|
978
|
-
"name": "AlertChip",
|
979
|
-
"cssProperties": [
|
980
|
-
{
|
981
|
-
"description": "The color of the label text",
|
982
|
-
"name": "--mdc-chip-color"
|
983
|
-
},
|
984
|
-
{
|
985
|
-
"description": "The color of the icon",
|
986
|
-
"name": "--mdc-chip-icon-color"
|
987
|
-
},
|
988
|
-
{
|
989
|
-
"description": "The border color of the alertchip",
|
990
|
-
"name": "--mdc-chip-border-color"
|
991
|
-
},
|
992
|
-
{
|
993
|
-
"description": "The background color of the alertchip",
|
994
|
-
"name": "--mdc-chip-background-color"
|
995
|
-
}
|
996
|
-
],
|
997
|
-
"cssParts": [
|
998
|
-
{
|
999
|
-
"description": "The alert icon",
|
1000
|
-
"name": "icon"
|
1001
|
-
},
|
1002
|
-
{
|
1003
|
-
"description": "The text label of the alertchip",
|
1004
|
-
"name": "label"
|
1005
|
-
}
|
1006
|
-
],
|
1007
|
-
"members": [
|
1008
|
-
{
|
1009
|
-
"kind": "field",
|
1010
|
-
"name": "variant",
|
1011
|
-
"type": {
|
1012
|
-
"text": "VariantType"
|
1013
|
-
},
|
1014
|
-
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
1015
|
-
"default": "neutral",
|
1016
|
-
"attribute": "variant"
|
1017
|
-
},
|
1018
|
-
{
|
1019
|
-
"kind": "field",
|
1020
|
-
"name": "label",
|
1021
|
-
"type": {
|
1022
|
-
"text": "string"
|
1023
|
-
},
|
1024
|
-
"default": "''",
|
1025
|
-
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
1026
|
-
"attribute": "label"
|
1027
|
-
},
|
1028
|
-
{
|
1029
|
-
"kind": "field",
|
1030
|
-
"name": "autoFocusOnMount",
|
1031
|
-
"type": {
|
1032
|
-
"text": "boolean"
|
1033
|
-
},
|
1034
|
-
"default": "false",
|
1035
|
-
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
1036
|
-
"attribute": "auto-focus-on-mount",
|
1037
|
-
"reflects": true,
|
1038
|
-
"inheritedFrom": {
|
1039
|
-
"name": "AutoFocusOnMountMixin",
|
1040
|
-
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
1041
|
-
}
|
1042
|
-
},
|
1043
|
-
{
|
1044
|
-
"kind": "field",
|
1045
|
-
"name": "tabIndex",
|
1046
|
-
"type": {
|
1047
|
-
"text": "number"
|
1048
|
-
},
|
1049
|
-
"default": "0",
|
1050
|
-
"description": "This property specifies the tab order of the element.",
|
1051
|
-
"attribute": "tabIndex",
|
1052
|
-
"reflects": true,
|
1053
|
-
"inheritedFrom": {
|
1054
|
-
"name": "TabIndexMixin",
|
1055
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
1056
|
-
}
|
1049
|
+
"default": "0",
|
1050
|
+
"description": "This property specifies the tab order of the element.",
|
1051
|
+
"attribute": "tabIndex",
|
1052
|
+
"reflects": true,
|
1053
|
+
"inheritedFrom": {
|
1054
|
+
"name": "TabIndexMixin",
|
1055
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1056
|
+
}
|
1057
1057
|
},
|
1058
1058
|
{
|
1059
1059
|
"kind": "field",
|
@@ -1768,545 +1768,218 @@
|
|
1768
1768
|
},
|
1769
1769
|
{
|
1770
1770
|
"kind": "javascript-module",
|
1771
|
-
"path": "components/
|
1771
|
+
"path": "components/announcementdialog/announcementdialog.component.js",
|
1772
1772
|
"declarations": [
|
1773
1773
|
{
|
1774
1774
|
"kind": "class",
|
1775
|
-
"description": "
|
1776
|
-
"name": "
|
1777
|
-
"
|
1775
|
+
"description": "AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\nIt can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\nThe dialog is available in 4 sizes: 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\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",
|
1776
|
+
"name": "AnnouncementDialog",
|
1777
|
+
"cssProperties": [
|
1778
1778
|
{
|
1779
|
-
"description": "
|
1780
|
-
"name": "
|
1779
|
+
"description": "background color of the illustration section",
|
1780
|
+
"name": "--mdc-announcementdialog-illustration-background-color"
|
1781
1781
|
},
|
1782
1782
|
{
|
1783
|
-
"description": "
|
1784
|
-
"name": "
|
1783
|
+
"description": "primary background color of the dialog",
|
1784
|
+
"name": "--mdc-dialog-primary-background-color",
|
1785
|
+
"inheritedFrom": {
|
1786
|
+
"name": "Dialog",
|
1787
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1788
|
+
}
|
1785
1789
|
},
|
1786
1790
|
{
|
1787
|
-
"description": "
|
1788
|
-
"name": "
|
1791
|
+
"description": "border color of the dialog",
|
1792
|
+
"name": "--mdc-dialog-border-color",
|
1793
|
+
"inheritedFrom": {
|
1794
|
+
"name": "Dialog",
|
1795
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1796
|
+
}
|
1789
1797
|
},
|
1790
1798
|
{
|
1791
|
-
"description": "
|
1792
|
-
"name": "
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
1796
|
-
|
1797
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
1798
|
-
"name": "leading"
|
1799
|
+
"description": "text color of the header/title of the dialog",
|
1800
|
+
"name": "--mdc-dialog-header-text-color",
|
1801
|
+
"inheritedFrom": {
|
1802
|
+
"name": "Dialog",
|
1803
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1804
|
+
}
|
1799
1805
|
},
|
1800
1806
|
{
|
1801
|
-
"description": "
|
1802
|
-
"name": "
|
1807
|
+
"description": "text color of the below header description of the dialog",
|
1808
|
+
"name": "--mdc-dialog-description-text-color",
|
1809
|
+
"inheritedFrom": {
|
1810
|
+
"name": "Dialog",
|
1811
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1812
|
+
}
|
1803
1813
|
},
|
1804
1814
|
{
|
1805
|
-
"description": "
|
1806
|
-
"name": "
|
1807
|
-
|
1808
|
-
|
1809
|
-
|
1810
|
-
|
1811
|
-
"name": "Component",
|
1812
|
-
"module": "/src/models"
|
1813
|
-
},
|
1814
|
-
"tagName": "mdc-appheader",
|
1815
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
1816
|
-
"customElement": true
|
1817
|
-
}
|
1818
|
-
],
|
1819
|
-
"exports": [
|
1820
|
-
{
|
1821
|
-
"kind": "js",
|
1822
|
-
"name": "default",
|
1823
|
-
"declaration": {
|
1824
|
-
"name": "Appheader",
|
1825
|
-
"module": "components/appheader/appheader.component.js"
|
1826
|
-
}
|
1827
|
-
}
|
1828
|
-
]
|
1829
|
-
},
|
1830
|
-
{
|
1831
|
-
"kind": "javascript-module",
|
1832
|
-
"path": "components/avatar/avatar.component.js",
|
1833
|
-
"declarations": [
|
1834
|
-
{
|
1835
|
-
"kind": "class",
|
1836
|
-
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
1837
|
-
"name": "Avatar",
|
1838
|
-
"cssProperties": [
|
1839
|
-
{
|
1840
|
-
"description": "Allows customization of the default background color.",
|
1841
|
-
"name": "--mdc-avatar-default-background-color"
|
1815
|
+
"description": "elevation of the dialog",
|
1816
|
+
"name": "--mdc-dialog-elevation-3",
|
1817
|
+
"inheritedFrom": {
|
1818
|
+
"name": "Dialog",
|
1819
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1820
|
+
}
|
1842
1821
|
},
|
1843
1822
|
{
|
1844
|
-
"description": "
|
1845
|
-
"name": "--mdc-
|
1823
|
+
"description": "width of the dialog",
|
1824
|
+
"name": "--mdc-dialog-width",
|
1825
|
+
"inheritedFrom": {
|
1826
|
+
"name": "Dialog",
|
1827
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1828
|
+
}
|
1846
1829
|
},
|
1847
1830
|
{
|
1848
|
-
"description": "
|
1849
|
-
"name": "--mdc-
|
1850
|
-
|
1851
|
-
|
1852
|
-
|
1853
|
-
|
1854
|
-
},
|
1855
|
-
{
|
1856
|
-
"description": "Allows customization of the loading overlay background color.",
|
1857
|
-
"name": "--mdc-avatar-loading-overlay-background-color"
|
1831
|
+
"description": "height of the dialog",
|
1832
|
+
"name": "--mdc-dialog-height",
|
1833
|
+
"inheritedFrom": {
|
1834
|
+
"name": "Dialog",
|
1835
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1836
|
+
}
|
1858
1837
|
}
|
1859
1838
|
],
|
1860
1839
|
"cssParts": [
|
1861
1840
|
{
|
1862
|
-
"description": "The main
|
1863
|
-
"name": "
|
1864
|
-
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1841
|
+
"description": "The main body container that holds the illustration and content sections",
|
1842
|
+
"name": "body",
|
1843
|
+
"inheritedFrom": {
|
1844
|
+
"name": "Dialog",
|
1845
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1846
|
+
}
|
1868
1847
|
},
|
1869
1848
|
{
|
1870
|
-
"description": "The
|
1871
|
-
"name": "
|
1849
|
+
"description": "The container for the illustration section",
|
1850
|
+
"name": "illustration-container"
|
1872
1851
|
},
|
1873
1852
|
{
|
1874
|
-
"description": "The
|
1875
|
-
"name": "
|
1853
|
+
"description": "The container for the content section",
|
1854
|
+
"name": "content-container"
|
1876
1855
|
},
|
1877
1856
|
{
|
1878
|
-
"description": "The
|
1879
|
-
"name": "
|
1880
|
-
}
|
1881
|
-
],
|
1882
|
-
"members": [
|
1883
|
-
{
|
1884
|
-
"kind": "field",
|
1885
|
-
"name": "src",
|
1886
|
-
"type": {
|
1887
|
-
"text": "string | undefined"
|
1888
|
-
},
|
1889
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
1890
|
-
"attribute": "src",
|
1857
|
+
"description": "The header text",
|
1858
|
+
"name": "header-text",
|
1891
1859
|
"inheritedFrom": {
|
1892
|
-
"name": "
|
1893
|
-
"module": "
|
1860
|
+
"name": "Dialog",
|
1861
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1894
1862
|
}
|
1895
1863
|
},
|
1896
1864
|
{
|
1897
|
-
"
|
1898
|
-
"name": "
|
1899
|
-
"type": {
|
1900
|
-
"text": "string | undefined"
|
1901
|
-
},
|
1902
|
-
"description": "The initials to be displayed for the avatar.",
|
1903
|
-
"attribute": "initials",
|
1865
|
+
"description": "The description text of the dialog.",
|
1866
|
+
"name": "description-text",
|
1904
1867
|
"inheritedFrom": {
|
1905
|
-
"name": "
|
1906
|
-
"module": "
|
1868
|
+
"name": "Dialog",
|
1869
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1907
1870
|
}
|
1908
1871
|
},
|
1909
1872
|
{
|
1910
|
-
"
|
1911
|
-
"name": "
|
1912
|
-
"type": {
|
1913
|
-
"text": "PresenceType | undefined"
|
1914
|
-
},
|
1915
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
1916
|
-
"attribute": "presence",
|
1873
|
+
"description": "The close button of the dialog.",
|
1874
|
+
"name": "dialog-close-btn",
|
1917
1875
|
"inheritedFrom": {
|
1918
|
-
"name": "
|
1919
|
-
"module": "
|
1876
|
+
"name": "Dialog",
|
1877
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1920
1878
|
}
|
1921
1879
|
},
|
1922
1880
|
{
|
1923
|
-
"
|
1924
|
-
"name": "
|
1925
|
-
"type": {
|
1926
|
-
"text": "AvatarSize"
|
1927
|
-
},
|
1928
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1929
|
-
"default": "32",
|
1930
|
-
"attribute": "size",
|
1931
|
-
"reflects": true,
|
1881
|
+
"description": "The header of the dialog.",
|
1882
|
+
"name": "header",
|
1932
1883
|
"inheritedFrom": {
|
1933
|
-
"name": "
|
1934
|
-
"module": "
|
1884
|
+
"name": "Dialog",
|
1885
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1935
1886
|
}
|
1936
1887
|
},
|
1937
1888
|
{
|
1938
|
-
"
|
1939
|
-
"name": "
|
1940
|
-
"type": {
|
1941
|
-
"text": "number | undefined"
|
1942
|
-
},
|
1943
|
-
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
1944
|
-
"attribute": "counter",
|
1889
|
+
"description": "The header section of the dialog.",
|
1890
|
+
"name": "header-section",
|
1945
1891
|
"inheritedFrom": {
|
1946
|
-
"name": "
|
1947
|
-
"module": "
|
1892
|
+
"name": "Dialog",
|
1893
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1948
1894
|
}
|
1949
|
-
}
|
1895
|
+
}
|
1896
|
+
],
|
1897
|
+
"slots": [
|
1950
1898
|
{
|
1951
|
-
"
|
1952
|
-
"name": "
|
1953
|
-
"type": {
|
1954
|
-
"text": "boolean"
|
1955
|
-
},
|
1956
|
-
"default": "false",
|
1957
|
-
"description": "Represents the typing indicator when the user is typing.",
|
1958
|
-
"attribute": "is-typing",
|
1899
|
+
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
1900
|
+
"name": "header-prefix",
|
1959
1901
|
"inheritedFrom": {
|
1960
|
-
"name": "
|
1961
|
-
"module": "
|
1902
|
+
"name": "Dialog",
|
1903
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1962
1904
|
}
|
1963
1905
|
},
|
1964
1906
|
{
|
1965
|
-
"
|
1966
|
-
"name": "
|
1967
|
-
"type": {
|
1968
|
-
"text": "IconNames | undefined"
|
1969
|
-
},
|
1970
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1971
|
-
"attribute": "icon-name",
|
1907
|
+
"description": "Slot for the dialog body content",
|
1908
|
+
"name": "dialog-body",
|
1972
1909
|
"inheritedFrom": {
|
1973
|
-
"name": "
|
1974
|
-
"module": "
|
1910
|
+
"name": "Dialog",
|
1911
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1975
1912
|
}
|
1976
|
-
}
|
1977
|
-
],
|
1978
|
-
"mixins": [
|
1913
|
+
},
|
1979
1914
|
{
|
1980
|
-
"
|
1981
|
-
"
|
1915
|
+
"description": "Slot for the illustration container section",
|
1916
|
+
"name": "illustration-container"
|
1982
1917
|
},
|
1983
1918
|
{
|
1984
|
-
"
|
1985
|
-
"
|
1986
|
-
}
|
1987
|
-
],
|
1988
|
-
"superclass": {
|
1989
|
-
"name": "Component",
|
1990
|
-
"module": "/src/models"
|
1991
|
-
},
|
1992
|
-
"tagName": "mdc-avatar",
|
1993
|
-
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
1994
|
-
"customElement": true,
|
1995
|
-
"attributes": [
|
1919
|
+
"description": "Slot for the content (header, description, etc) section",
|
1920
|
+
"name": "content-container"
|
1921
|
+
},
|
1996
1922
|
{
|
1997
|
-
"
|
1998
|
-
"
|
1999
|
-
|
2000
|
-
|
2001
|
-
"description": "
|
2002
|
-
"
|
1923
|
+
"description": "Slot for the description in the content (below header) - pass in Text, Links etc as needed.",
|
1924
|
+
"name": "description-container"
|
1925
|
+
},
|
1926
|
+
{
|
1927
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
1928
|
+
"name": "footer-link",
|
2003
1929
|
"inheritedFrom": {
|
2004
|
-
"name": "
|
2005
|
-
"module": "src/
|
1930
|
+
"name": "Dialog",
|
1931
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2006
1932
|
}
|
2007
1933
|
},
|
2008
1934
|
{
|
2009
|
-
"
|
2010
|
-
"
|
2011
|
-
"text": "string | undefined"
|
2012
|
-
},
|
2013
|
-
"description": "The initials to be displayed for the avatar.",
|
2014
|
-
"fieldName": "initials",
|
1935
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
1936
|
+
"name": "footer-button-secondary",
|
2015
1937
|
"inheritedFrom": {
|
2016
|
-
"name": "
|
2017
|
-
"module": "src/
|
1938
|
+
"name": "Dialog",
|
1939
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2018
1940
|
}
|
2019
1941
|
},
|
2020
1942
|
{
|
2021
|
-
"
|
2022
|
-
"
|
2023
|
-
"text": "PresenceType | undefined"
|
2024
|
-
},
|
2025
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
2026
|
-
"fieldName": "presence",
|
1943
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
1944
|
+
"name": "footer-button-primary",
|
2027
1945
|
"inheritedFrom": {
|
2028
|
-
"name": "
|
2029
|
-
"module": "src/
|
1946
|
+
"name": "Dialog",
|
1947
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2030
1948
|
}
|
2031
1949
|
},
|
2032
1950
|
{
|
2033
|
-
"
|
2034
|
-
"
|
2035
|
-
"text": "AvatarSize"
|
2036
|
-
},
|
2037
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
2038
|
-
"default": "32",
|
2039
|
-
"fieldName": "size",
|
1951
|
+
"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",
|
1952
|
+
"name": "footer",
|
2040
1953
|
"inheritedFrom": {
|
2041
|
-
"name": "
|
2042
|
-
"module": "src/
|
1954
|
+
"name": "Dialog",
|
1955
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2043
1956
|
}
|
2044
|
-
}
|
1957
|
+
}
|
1958
|
+
],
|
1959
|
+
"members": [
|
2045
1960
|
{
|
2046
|
-
"
|
1961
|
+
"kind": "field",
|
1962
|
+
"name": "illustration",
|
2047
1963
|
"type": {
|
2048
|
-
"text": "
|
1964
|
+
"text": "IllustrationNames | undefined"
|
2049
1965
|
},
|
2050
|
-
"description": "The
|
2051
|
-
"
|
2052
|
-
"
|
2053
|
-
"name": "AvatarComponentMixin",
|
2054
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
2055
|
-
}
|
1966
|
+
"description": "The illustration to display in the announcement dialog.\nThis can be an image URL, icon name, or any other illustration identifier.\n\nMake sure to choose the right illustration respective the size (the filename includes the size information, i.e. threetwozero = 320px)",
|
1967
|
+
"attribute": "illustration",
|
1968
|
+
"reflects": true
|
2056
1969
|
},
|
2057
1970
|
{
|
2058
|
-
"
|
1971
|
+
"kind": "field",
|
1972
|
+
"name": "size",
|
2059
1973
|
"type": {
|
2060
|
-
"text": "
|
1974
|
+
"text": "DialogSize"
|
2061
1975
|
},
|
2062
|
-
"
|
2063
|
-
"
|
2064
|
-
"
|
1976
|
+
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
1977
|
+
"default": "medium",
|
1978
|
+
"attribute": "size",
|
1979
|
+
"reflects": true,
|
2065
1980
|
"inheritedFrom": {
|
2066
|
-
"name": "
|
2067
|
-
"module": "
|
2068
|
-
}
|
2069
|
-
},
|
2070
|
-
{
|
2071
|
-
"name": "icon-name",
|
2072
|
-
"type": {
|
2073
|
-
"text": "IconNames | undefined"
|
2074
|
-
},
|
2075
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2076
|
-
"fieldName": "iconName",
|
2077
|
-
"inheritedFrom": {
|
2078
|
-
"name": "IconNameMixin",
|
2079
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
2080
|
-
}
|
2081
|
-
}
|
2082
|
-
]
|
2083
|
-
}
|
2084
|
-
],
|
2085
|
-
"exports": [
|
2086
|
-
{
|
2087
|
-
"kind": "js",
|
2088
|
-
"name": "default",
|
2089
|
-
"declaration": {
|
2090
|
-
"name": "Avatar",
|
2091
|
-
"module": "components/avatar/avatar.component.js"
|
2092
|
-
}
|
2093
|
-
}
|
2094
|
-
]
|
2095
|
-
},
|
2096
|
-
{
|
2097
|
-
"kind": "javascript-module",
|
2098
|
-
"path": "components/announcementdialog/announcementdialog.component.js",
|
2099
|
-
"declarations": [
|
2100
|
-
{
|
2101
|
-
"kind": "class",
|
2102
|
-
"description": "AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\nIt can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\nThe dialog is available in 4 sizes: 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\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",
|
2103
|
-
"name": "AnnouncementDialog",
|
2104
|
-
"cssProperties": [
|
2105
|
-
{
|
2106
|
-
"description": "background color of the illustration section",
|
2107
|
-
"name": "--mdc-announcementdialog-illustration-background-color"
|
2108
|
-
},
|
2109
|
-
{
|
2110
|
-
"description": "primary background color of the dialog",
|
2111
|
-
"name": "--mdc-dialog-primary-background-color",
|
2112
|
-
"inheritedFrom": {
|
2113
|
-
"name": "Dialog",
|
2114
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2115
|
-
}
|
2116
|
-
},
|
2117
|
-
{
|
2118
|
-
"description": "border color of the dialog",
|
2119
|
-
"name": "--mdc-dialog-border-color",
|
2120
|
-
"inheritedFrom": {
|
2121
|
-
"name": "Dialog",
|
2122
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2123
|
-
}
|
2124
|
-
},
|
2125
|
-
{
|
2126
|
-
"description": "text color of the header/title of the dialog",
|
2127
|
-
"name": "--mdc-dialog-header-text-color",
|
2128
|
-
"inheritedFrom": {
|
2129
|
-
"name": "Dialog",
|
2130
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2131
|
-
}
|
2132
|
-
},
|
2133
|
-
{
|
2134
|
-
"description": "text color of the below header description of the dialog",
|
2135
|
-
"name": "--mdc-dialog-description-text-color",
|
2136
|
-
"inheritedFrom": {
|
2137
|
-
"name": "Dialog",
|
2138
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2139
|
-
}
|
2140
|
-
},
|
2141
|
-
{
|
2142
|
-
"description": "elevation of the dialog",
|
2143
|
-
"name": "--mdc-dialog-elevation-3",
|
2144
|
-
"inheritedFrom": {
|
2145
|
-
"name": "Dialog",
|
2146
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2147
|
-
}
|
2148
|
-
},
|
2149
|
-
{
|
2150
|
-
"description": "width of the dialog",
|
2151
|
-
"name": "--mdc-dialog-width",
|
2152
|
-
"inheritedFrom": {
|
2153
|
-
"name": "Dialog",
|
2154
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2155
|
-
}
|
2156
|
-
},
|
2157
|
-
{
|
2158
|
-
"description": "height of the dialog",
|
2159
|
-
"name": "--mdc-dialog-height",
|
2160
|
-
"inheritedFrom": {
|
2161
|
-
"name": "Dialog",
|
2162
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2163
|
-
}
|
2164
|
-
}
|
2165
|
-
],
|
2166
|
-
"cssParts": [
|
2167
|
-
{
|
2168
|
-
"description": "The main body container that holds the illustration and content sections",
|
2169
|
-
"name": "body",
|
2170
|
-
"inheritedFrom": {
|
2171
|
-
"name": "Dialog",
|
2172
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2173
|
-
}
|
2174
|
-
},
|
2175
|
-
{
|
2176
|
-
"description": "The container for the illustration section",
|
2177
|
-
"name": "illustration-container"
|
2178
|
-
},
|
2179
|
-
{
|
2180
|
-
"description": "The container for the content section",
|
2181
|
-
"name": "content-container"
|
2182
|
-
},
|
2183
|
-
{
|
2184
|
-
"description": "The header text",
|
2185
|
-
"name": "header-text",
|
2186
|
-
"inheritedFrom": {
|
2187
|
-
"name": "Dialog",
|
2188
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2189
|
-
}
|
2190
|
-
},
|
2191
|
-
{
|
2192
|
-
"description": "The description text of the dialog.",
|
2193
|
-
"name": "description-text",
|
2194
|
-
"inheritedFrom": {
|
2195
|
-
"name": "Dialog",
|
2196
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2197
|
-
}
|
2198
|
-
},
|
2199
|
-
{
|
2200
|
-
"description": "The close button of the dialog.",
|
2201
|
-
"name": "dialog-close-btn",
|
2202
|
-
"inheritedFrom": {
|
2203
|
-
"name": "Dialog",
|
2204
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2205
|
-
}
|
2206
|
-
},
|
2207
|
-
{
|
2208
|
-
"description": "The header of the dialog.",
|
2209
|
-
"name": "header",
|
2210
|
-
"inheritedFrom": {
|
2211
|
-
"name": "Dialog",
|
2212
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2213
|
-
}
|
2214
|
-
},
|
2215
|
-
{
|
2216
|
-
"description": "The header section of the dialog.",
|
2217
|
-
"name": "header-section",
|
2218
|
-
"inheritedFrom": {
|
2219
|
-
"name": "Dialog",
|
2220
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2221
|
-
}
|
2222
|
-
}
|
2223
|
-
],
|
2224
|
-
"slots": [
|
2225
|
-
{
|
2226
|
-
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
2227
|
-
"name": "header-prefix",
|
2228
|
-
"inheritedFrom": {
|
2229
|
-
"name": "Dialog",
|
2230
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2231
|
-
}
|
2232
|
-
},
|
2233
|
-
{
|
2234
|
-
"description": "Slot for the dialog body content",
|
2235
|
-
"name": "dialog-body",
|
2236
|
-
"inheritedFrom": {
|
2237
|
-
"name": "Dialog",
|
2238
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2239
|
-
}
|
2240
|
-
},
|
2241
|
-
{
|
2242
|
-
"description": "Slot for the illustration container section",
|
2243
|
-
"name": "illustration-container"
|
2244
|
-
},
|
2245
|
-
{
|
2246
|
-
"description": "Slot for the content (header, description, etc) section",
|
2247
|
-
"name": "content-container"
|
2248
|
-
},
|
2249
|
-
{
|
2250
|
-
"description": "Slot for the description in the content (below header) - pass in Text, Links etc as needed.",
|
2251
|
-
"name": "description-container"
|
2252
|
-
},
|
2253
|
-
{
|
2254
|
-
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
2255
|
-
"name": "footer-link",
|
2256
|
-
"inheritedFrom": {
|
2257
|
-
"name": "Dialog",
|
2258
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2259
|
-
}
|
2260
|
-
},
|
2261
|
-
{
|
2262
|
-
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
2263
|
-
"name": "footer-button-secondary",
|
2264
|
-
"inheritedFrom": {
|
2265
|
-
"name": "Dialog",
|
2266
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2267
|
-
}
|
2268
|
-
},
|
2269
|
-
{
|
2270
|
-
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
2271
|
-
"name": "footer-button-primary",
|
2272
|
-
"inheritedFrom": {
|
2273
|
-
"name": "Dialog",
|
2274
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2275
|
-
}
|
2276
|
-
},
|
2277
|
-
{
|
2278
|
-
"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",
|
2279
|
-
"name": "footer",
|
2280
|
-
"inheritedFrom": {
|
2281
|
-
"name": "Dialog",
|
2282
|
-
"module": "src/components/dialog/dialog.component.ts"
|
2283
|
-
}
|
2284
|
-
}
|
2285
|
-
],
|
2286
|
-
"members": [
|
2287
|
-
{
|
2288
|
-
"kind": "field",
|
2289
|
-
"name": "illustration",
|
2290
|
-
"type": {
|
2291
|
-
"text": "IllustrationNames | undefined"
|
2292
|
-
},
|
2293
|
-
"description": "The illustration to display in the announcement dialog.\nThis can be an image URL, icon name, or any other illustration identifier.\n\nMake sure to choose the right illustration respective the size (the filename includes the size information, i.e. threetwozero = 320px)",
|
2294
|
-
"attribute": "illustration",
|
2295
|
-
"reflects": true
|
2296
|
-
},
|
2297
|
-
{
|
2298
|
-
"kind": "field",
|
2299
|
-
"name": "size",
|
2300
|
-
"type": {
|
2301
|
-
"text": "DialogSize"
|
2302
|
-
},
|
2303
|
-
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
2304
|
-
"default": "medium",
|
2305
|
-
"attribute": "size",
|
2306
|
-
"reflects": true,
|
2307
|
-
"inheritedFrom": {
|
2308
|
-
"name": "Dialog",
|
2309
|
-
"module": "components/dialog/dialog.component.js"
|
1981
|
+
"name": "Dialog",
|
1982
|
+
"module": "components/dialog/dialog.component.js"
|
2310
1983
|
}
|
2311
1984
|
},
|
2312
1985
|
{
|
@@ -2860,589 +2533,916 @@
|
|
2860
2533
|
],
|
2861
2534
|
"description": "Traps focus within the container.",
|
2862
2535
|
"inheritedFrom": {
|
2863
|
-
"name": "FocusTrapMixin",
|
2864
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
2536
|
+
"name": "FocusTrapMixin",
|
2537
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2538
|
+
}
|
2539
|
+
},
|
2540
|
+
{
|
2541
|
+
"kind": "method",
|
2542
|
+
"name": "renderFooter",
|
2543
|
+
"privacy": "protected",
|
2544
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
2545
|
+
"return": {
|
2546
|
+
"type": {
|
2547
|
+
"text": ""
|
2548
|
+
}
|
2549
|
+
},
|
2550
|
+
"inheritedFrom": {
|
2551
|
+
"name": "FooterMixin",
|
2552
|
+
"module": "utils/mixins/FooterMixin.js"
|
2553
|
+
}
|
2554
|
+
},
|
2555
|
+
{
|
2556
|
+
"kind": "field",
|
2557
|
+
"name": "id",
|
2558
|
+
"type": {
|
2559
|
+
"text": "string"
|
2560
|
+
},
|
2561
|
+
"default": "''",
|
2562
|
+
"description": "The unique ID of the dialog",
|
2563
|
+
"attribute": "id",
|
2564
|
+
"reflects": true,
|
2565
|
+
"inheritedFrom": {
|
2566
|
+
"name": "Dialog",
|
2567
|
+
"module": "components/dialog/dialog.component.js"
|
2568
|
+
}
|
2569
|
+
},
|
2570
|
+
{
|
2571
|
+
"kind": "field",
|
2572
|
+
"name": "triggerId",
|
2573
|
+
"type": {
|
2574
|
+
"text": "string | undefined"
|
2575
|
+
},
|
2576
|
+
"description": "The ID of the element that triggers the dialog",
|
2577
|
+
"default": "undefined",
|
2578
|
+
"attribute": "triggerId",
|
2579
|
+
"reflects": true,
|
2580
|
+
"inheritedFrom": {
|
2581
|
+
"name": "Dialog",
|
2582
|
+
"module": "components/dialog/dialog.component.js"
|
2583
|
+
}
|
2584
|
+
},
|
2585
|
+
{
|
2586
|
+
"kind": "field",
|
2587
|
+
"name": "visible",
|
2588
|
+
"type": {
|
2589
|
+
"text": "boolean"
|
2590
|
+
},
|
2591
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
2592
|
+
"default": "false",
|
2593
|
+
"attribute": "visible",
|
2594
|
+
"reflects": true,
|
2595
|
+
"inheritedFrom": {
|
2596
|
+
"name": "Dialog",
|
2597
|
+
"module": "components/dialog/dialog.component.js"
|
2598
|
+
}
|
2599
|
+
},
|
2600
|
+
{
|
2601
|
+
"kind": "field",
|
2602
|
+
"name": "variant",
|
2603
|
+
"type": {
|
2604
|
+
"text": "DialogVariant"
|
2605
|
+
},
|
2606
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
2607
|
+
"default": "default",
|
2608
|
+
"attribute": "variant",
|
2609
|
+
"reflects": true,
|
2610
|
+
"inheritedFrom": {
|
2611
|
+
"name": "Dialog",
|
2612
|
+
"module": "components/dialog/dialog.component.js"
|
2613
|
+
}
|
2614
|
+
},
|
2615
|
+
{
|
2616
|
+
"kind": "field",
|
2617
|
+
"name": "closeButtonAriaLabel",
|
2618
|
+
"type": {
|
2619
|
+
"text": "string | null"
|
2620
|
+
},
|
2621
|
+
"default": "null",
|
2622
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
2623
|
+
"attribute": "close-button-aria-label",
|
2624
|
+
"inheritedFrom": {
|
2625
|
+
"name": "Dialog",
|
2626
|
+
"module": "components/dialog/dialog.component.js"
|
2627
|
+
}
|
2628
|
+
},
|
2629
|
+
{
|
2630
|
+
"kind": "field",
|
2631
|
+
"name": "ariaLabel",
|
2632
|
+
"type": {
|
2633
|
+
"text": "string | null"
|
2634
|
+
},
|
2635
|
+
"default": "null",
|
2636
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
2637
|
+
"attribute": "aria-label",
|
2638
|
+
"reflects": true,
|
2639
|
+
"inheritedFrom": {
|
2640
|
+
"name": "Dialog",
|
2641
|
+
"module": "components/dialog/dialog.component.js"
|
2642
|
+
}
|
2643
|
+
},
|
2644
|
+
{
|
2645
|
+
"kind": "field",
|
2646
|
+
"name": "ariaLabelledby",
|
2647
|
+
"type": {
|
2648
|
+
"text": "string | null"
|
2649
|
+
},
|
2650
|
+
"default": "null",
|
2651
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
2652
|
+
"attribute": "aria-labelledby",
|
2653
|
+
"reflects": true,
|
2654
|
+
"inheritedFrom": {
|
2655
|
+
"name": "Dialog",
|
2656
|
+
"module": "components/dialog/dialog.component.js"
|
2657
|
+
}
|
2658
|
+
},
|
2659
|
+
{
|
2660
|
+
"kind": "field",
|
2661
|
+
"name": "ariaDescribedBy",
|
2662
|
+
"type": {
|
2663
|
+
"text": "string | null"
|
2664
|
+
},
|
2665
|
+
"default": "null",
|
2666
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
2667
|
+
"attribute": "aria-describedby",
|
2668
|
+
"reflects": true,
|
2669
|
+
"inheritedFrom": {
|
2670
|
+
"name": "Dialog",
|
2671
|
+
"module": "components/dialog/dialog.component.js"
|
2672
|
+
}
|
2673
|
+
},
|
2674
|
+
{
|
2675
|
+
"kind": "field",
|
2676
|
+
"name": "ariaDescription",
|
2677
|
+
"type": {
|
2678
|
+
"text": "string | null"
|
2679
|
+
},
|
2680
|
+
"default": "null",
|
2681
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
2682
|
+
"attribute": "aria-description",
|
2683
|
+
"reflects": true,
|
2684
|
+
"inheritedFrom": {
|
2685
|
+
"name": "Dialog",
|
2686
|
+
"module": "components/dialog/dialog.component.js"
|
2687
|
+
}
|
2688
|
+
},
|
2689
|
+
{
|
2690
|
+
"kind": "field",
|
2691
|
+
"name": "headerText",
|
2692
|
+
"type": {
|
2693
|
+
"text": "string | undefined"
|
2694
|
+
},
|
2695
|
+
"description": "Defines a string value to display as the title of the dialog",
|
2696
|
+
"attribute": "header-text",
|
2697
|
+
"reflects": true,
|
2698
|
+
"inheritedFrom": {
|
2699
|
+
"name": "Dialog",
|
2700
|
+
"module": "components/dialog/dialog.component.js"
|
2701
|
+
}
|
2702
|
+
},
|
2703
|
+
{
|
2704
|
+
"kind": "field",
|
2705
|
+
"name": "descriptionText",
|
2706
|
+
"type": {
|
2707
|
+
"text": "string | undefined"
|
2708
|
+
},
|
2709
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
2710
|
+
"attribute": "description-text",
|
2711
|
+
"reflects": true,
|
2712
|
+
"inheritedFrom": {
|
2713
|
+
"name": "Dialog",
|
2714
|
+
"module": "components/dialog/dialog.component.js"
|
2715
|
+
}
|
2716
|
+
},
|
2717
|
+
{
|
2718
|
+
"kind": "field",
|
2719
|
+
"name": "headerTagName",
|
2720
|
+
"type": {
|
2721
|
+
"text": "string"
|
2722
|
+
},
|
2723
|
+
"description": "The html tag to be used for the header text",
|
2724
|
+
"attribute": "header-tag-name",
|
2725
|
+
"reflects": true,
|
2726
|
+
"inheritedFrom": {
|
2727
|
+
"name": "Dialog",
|
2728
|
+
"module": "components/dialog/dialog.component.js"
|
2729
|
+
}
|
2730
|
+
},
|
2731
|
+
{
|
2732
|
+
"kind": "field",
|
2733
|
+
"name": "descriptionTagName",
|
2734
|
+
"type": {
|
2735
|
+
"text": "string"
|
2736
|
+
},
|
2737
|
+
"description": "The html tag to be used for the below-header description text",
|
2738
|
+
"attribute": "description-tag-name",
|
2739
|
+
"reflects": true,
|
2740
|
+
"inheritedFrom": {
|
2741
|
+
"name": "Dialog",
|
2742
|
+
"module": "components/dialog/dialog.component.js"
|
2743
|
+
}
|
2744
|
+
},
|
2745
|
+
{
|
2746
|
+
"kind": "field",
|
2747
|
+
"name": "role",
|
2748
|
+
"type": {
|
2749
|
+
"text": "DialogRole"
|
2750
|
+
},
|
2751
|
+
"description": "Role of the dialog",
|
2752
|
+
"default": "dialog",
|
2753
|
+
"attribute": "role",
|
2754
|
+
"reflects": true,
|
2755
|
+
"inheritedFrom": {
|
2756
|
+
"name": "Dialog",
|
2757
|
+
"module": "components/dialog/dialog.component.js"
|
2758
|
+
}
|
2759
|
+
},
|
2760
|
+
{
|
2761
|
+
"kind": "field",
|
2762
|
+
"name": "disableAriaHasPopup",
|
2763
|
+
"type": {
|
2764
|
+
"text": "boolean"
|
2765
|
+
},
|
2766
|
+
"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.",
|
2767
|
+
"default": "false",
|
2768
|
+
"attribute": "disable-aria-haspopup",
|
2769
|
+
"reflects": true,
|
2770
|
+
"inheritedFrom": {
|
2771
|
+
"name": "Dialog",
|
2772
|
+
"module": "components/dialog/dialog.component.js"
|
2773
|
+
}
|
2774
|
+
},
|
2775
|
+
{
|
2776
|
+
"kind": "method",
|
2777
|
+
"name": "closeDialog",
|
2778
|
+
"privacy": "private",
|
2779
|
+
"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.",
|
2780
|
+
"inheritedFrom": {
|
2781
|
+
"name": "Dialog",
|
2782
|
+
"module": "components/dialog/dialog.component.js"
|
2783
|
+
}
|
2784
|
+
},
|
2785
|
+
{
|
2786
|
+
"kind": "method",
|
2787
|
+
"name": "isOpenUpdated",
|
2788
|
+
"privacy": "private",
|
2789
|
+
"parameters": [
|
2790
|
+
{
|
2791
|
+
"name": "oldValue",
|
2792
|
+
"type": {
|
2793
|
+
"text": "boolean | undefined"
|
2794
|
+
},
|
2795
|
+
"description": "The old value of the visible property."
|
2796
|
+
},
|
2797
|
+
{
|
2798
|
+
"name": "newValue",
|
2799
|
+
"type": {
|
2800
|
+
"text": "boolean"
|
2801
|
+
},
|
2802
|
+
"description": "The new value of the visible property."
|
2803
|
+
}
|
2804
|
+
],
|
2805
|
+
"description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog.",
|
2806
|
+
"inheritedFrom": {
|
2807
|
+
"name": "Dialog",
|
2808
|
+
"module": "components/dialog/dialog.component.js"
|
2809
|
+
}
|
2810
|
+
}
|
2811
|
+
],
|
2812
|
+
"events": [
|
2813
|
+
{
|
2814
|
+
"description": "(React: onShown) Dispatched when the dialog is shown",
|
2815
|
+
"name": "shown",
|
2816
|
+
"reactName": "onShown",
|
2817
|
+
"inheritedFrom": {
|
2818
|
+
"name": "Dialog",
|
2819
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2820
|
+
}
|
2821
|
+
},
|
2822
|
+
{
|
2823
|
+
"description": "(React: onHidden) Dispatched when the dialog is hidden",
|
2824
|
+
"name": "hidden",
|
2825
|
+
"reactName": "onHidden",
|
2826
|
+
"inheritedFrom": {
|
2827
|
+
"name": "Dialog",
|
2828
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2829
|
+
}
|
2830
|
+
},
|
2831
|
+
{
|
2832
|
+
"description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
|
2833
|
+
"name": "created",
|
2834
|
+
"reactName": "onCreated",
|
2835
|
+
"inheritedFrom": {
|
2836
|
+
"name": "Dialog",
|
2837
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2838
|
+
}
|
2839
|
+
},
|
2840
|
+
{
|
2841
|
+
"description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
|
2842
|
+
"name": "destroyed",
|
2843
|
+
"reactName": "onDestroyed",
|
2844
|
+
"inheritedFrom": {
|
2845
|
+
"name": "Dialog",
|
2846
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2847
|
+
}
|
2848
|
+
},
|
2849
|
+
{
|
2850
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
|
2851
|
+
"name": "close",
|
2852
|
+
"reactName": "onClose",
|
2853
|
+
"inheritedFrom": {
|
2854
|
+
"name": "Dialog",
|
2855
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2856
|
+
}
|
2857
|
+
}
|
2858
|
+
],
|
2859
|
+
"attributes": [
|
2860
|
+
{
|
2861
|
+
"name": "illustration",
|
2862
|
+
"type": {
|
2863
|
+
"text": "IllustrationNames | undefined"
|
2864
|
+
},
|
2865
|
+
"description": "The illustration to display in the announcement dialog.\nThis can be an image URL, icon name, or any other illustration identifier.\n\nMake sure to choose the right illustration respective the size (the filename includes the size information, i.e. threetwozero = 320px)",
|
2866
|
+
"fieldName": "illustration"
|
2867
|
+
},
|
2868
|
+
{
|
2869
|
+
"name": "size",
|
2870
|
+
"type": {
|
2871
|
+
"text": "DialogSize"
|
2872
|
+
},
|
2873
|
+
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
2874
|
+
"default": "medium",
|
2875
|
+
"fieldName": "size",
|
2876
|
+
"inheritedFrom": {
|
2877
|
+
"name": "Dialog",
|
2878
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2865
2879
|
}
|
2866
2880
|
},
|
2867
2881
|
{
|
2868
|
-
"
|
2869
|
-
"
|
2870
|
-
|
2871
|
-
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
2872
|
-
"return": {
|
2873
|
-
"type": {
|
2874
|
-
"text": ""
|
2875
|
-
}
|
2882
|
+
"name": "should-focus-trap-wrap",
|
2883
|
+
"type": {
|
2884
|
+
"text": "boolean"
|
2876
2885
|
},
|
2886
|
+
"default": "true",
|
2887
|
+
"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.",
|
2888
|
+
"fieldName": "shouldFocusTrapWrap",
|
2877
2889
|
"inheritedFrom": {
|
2878
|
-
"name": "
|
2879
|
-
"module": "utils/mixins/
|
2890
|
+
"name": "FocusTrapMixin",
|
2891
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
2880
2892
|
}
|
2881
2893
|
},
|
2882
2894
|
{
|
2883
|
-
"kind": "field",
|
2884
2895
|
"name": "id",
|
2885
2896
|
"type": {
|
2886
2897
|
"text": "string"
|
2887
2898
|
},
|
2888
2899
|
"default": "''",
|
2889
2900
|
"description": "The unique ID of the dialog",
|
2890
|
-
"
|
2891
|
-
"reflects": true,
|
2901
|
+
"fieldName": "id",
|
2892
2902
|
"inheritedFrom": {
|
2893
2903
|
"name": "Dialog",
|
2894
|
-
"module": "components/dialog/dialog.component.
|
2904
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2895
2905
|
}
|
2896
2906
|
},
|
2897
2907
|
{
|
2898
|
-
"kind": "field",
|
2899
2908
|
"name": "triggerId",
|
2900
2909
|
"type": {
|
2901
2910
|
"text": "string | undefined"
|
2902
2911
|
},
|
2903
2912
|
"description": "The ID of the element that triggers the dialog",
|
2904
2913
|
"default": "undefined",
|
2905
|
-
"
|
2906
|
-
"reflects": true,
|
2914
|
+
"fieldName": "triggerId",
|
2907
2915
|
"inheritedFrom": {
|
2908
2916
|
"name": "Dialog",
|
2909
|
-
"module": "components/dialog/dialog.component.
|
2917
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2910
2918
|
}
|
2911
2919
|
},
|
2912
2920
|
{
|
2913
|
-
"kind": "field",
|
2914
2921
|
"name": "visible",
|
2915
2922
|
"type": {
|
2916
2923
|
"text": "boolean"
|
2917
2924
|
},
|
2918
2925
|
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
2919
2926
|
"default": "false",
|
2920
|
-
"
|
2921
|
-
"reflects": true,
|
2927
|
+
"fieldName": "visible",
|
2922
2928
|
"inheritedFrom": {
|
2923
2929
|
"name": "Dialog",
|
2924
|
-
"module": "components/dialog/dialog.component.
|
2930
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2931
|
+
}
|
2932
|
+
},
|
2933
|
+
{
|
2934
|
+
"name": "z-index",
|
2935
|
+
"type": {
|
2936
|
+
"text": "number"
|
2937
|
+
},
|
2938
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
2939
|
+
"default": "1000",
|
2940
|
+
"fieldName": "zIndex",
|
2941
|
+
"inheritedFrom": {
|
2942
|
+
"name": "Dialog",
|
2943
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2925
2944
|
}
|
2926
2945
|
},
|
2927
2946
|
{
|
2928
|
-
"kind": "field",
|
2929
2947
|
"name": "variant",
|
2930
2948
|
"type": {
|
2931
2949
|
"text": "DialogVariant"
|
2932
2950
|
},
|
2933
2951
|
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
2934
2952
|
"default": "default",
|
2935
|
-
"
|
2936
|
-
"reflects": true,
|
2953
|
+
"fieldName": "variant",
|
2937
2954
|
"inheritedFrom": {
|
2938
2955
|
"name": "Dialog",
|
2939
|
-
"module": "components/dialog/dialog.component.
|
2956
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2940
2957
|
}
|
2941
2958
|
},
|
2942
2959
|
{
|
2943
|
-
"
|
2944
|
-
"name": "closeButtonAriaLabel",
|
2960
|
+
"name": "close-button-aria-label",
|
2945
2961
|
"type": {
|
2946
2962
|
"text": "string | null"
|
2947
2963
|
},
|
2948
2964
|
"default": "null",
|
2949
2965
|
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
2950
|
-
"
|
2966
|
+
"fieldName": "closeButtonAriaLabel",
|
2951
2967
|
"inheritedFrom": {
|
2952
2968
|
"name": "Dialog",
|
2953
|
-
"module": "components/dialog/dialog.component.
|
2969
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2954
2970
|
}
|
2955
2971
|
},
|
2956
2972
|
{
|
2957
|
-
"
|
2958
|
-
"name": "ariaLabel",
|
2973
|
+
"name": "aria-label",
|
2959
2974
|
"type": {
|
2960
2975
|
"text": "string | null"
|
2961
2976
|
},
|
2962
2977
|
"default": "null",
|
2963
2978
|
"description": "Defines a string value for the aria-label attribute when header is not used",
|
2964
|
-
"
|
2965
|
-
"reflects": true,
|
2979
|
+
"fieldName": "ariaLabel",
|
2966
2980
|
"inheritedFrom": {
|
2967
2981
|
"name": "Dialog",
|
2968
|
-
"module": "components/dialog/dialog.component.
|
2982
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2969
2983
|
}
|
2970
2984
|
},
|
2971
2985
|
{
|
2972
|
-
"
|
2973
|
-
"name": "ariaLabelledby",
|
2986
|
+
"name": "aria-labelledby",
|
2974
2987
|
"type": {
|
2975
2988
|
"text": "string | null"
|
2976
2989
|
},
|
2977
2990
|
"default": "null",
|
2978
2991
|
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
2979
|
-
"
|
2980
|
-
"reflects": true,
|
2992
|
+
"fieldName": "ariaLabelledby",
|
2981
2993
|
"inheritedFrom": {
|
2982
2994
|
"name": "Dialog",
|
2983
|
-
"module": "components/dialog/dialog.component.
|
2995
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2984
2996
|
}
|
2985
2997
|
},
|
2986
2998
|
{
|
2987
|
-
"
|
2988
|
-
"name": "ariaDescribedBy",
|
2999
|
+
"name": "aria-describedby",
|
2989
3000
|
"type": {
|
2990
3001
|
"text": "string | null"
|
2991
3002
|
},
|
2992
3003
|
"default": "null",
|
2993
3004
|
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
2994
|
-
"
|
2995
|
-
"reflects": true,
|
3005
|
+
"fieldName": "ariaDescribedBy",
|
2996
3006
|
"inheritedFrom": {
|
2997
3007
|
"name": "Dialog",
|
2998
|
-
"module": "components/dialog/dialog.component.
|
3008
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2999
3009
|
}
|
3000
3010
|
},
|
3001
3011
|
{
|
3002
|
-
"
|
3003
|
-
"name": "ariaDescription",
|
3012
|
+
"name": "aria-description",
|
3004
3013
|
"type": {
|
3005
3014
|
"text": "string | null"
|
3006
3015
|
},
|
3007
3016
|
"default": "null",
|
3008
3017
|
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
3009
|
-
"
|
3010
|
-
"reflects": true,
|
3018
|
+
"fieldName": "ariaDescription",
|
3011
3019
|
"inheritedFrom": {
|
3012
3020
|
"name": "Dialog",
|
3013
|
-
"module": "components/dialog/dialog.component.
|
3021
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3014
3022
|
}
|
3015
3023
|
},
|
3016
3024
|
{
|
3017
|
-
"
|
3018
|
-
"name": "headerText",
|
3025
|
+
"name": "header-text",
|
3019
3026
|
"type": {
|
3020
3027
|
"text": "string | undefined"
|
3021
3028
|
},
|
3022
3029
|
"description": "Defines a string value to display as the title of the dialog",
|
3023
|
-
"
|
3024
|
-
"reflects": true,
|
3030
|
+
"fieldName": "headerText",
|
3025
3031
|
"inheritedFrom": {
|
3026
3032
|
"name": "Dialog",
|
3027
|
-
"module": "components/dialog/dialog.component.
|
3033
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3028
3034
|
}
|
3029
3035
|
},
|
3030
3036
|
{
|
3031
|
-
"
|
3032
|
-
"name": "descriptionText",
|
3037
|
+
"name": "description-text",
|
3033
3038
|
"type": {
|
3034
3039
|
"text": "string | undefined"
|
3035
3040
|
},
|
3036
3041
|
"description": "Defines a string value to display as the under-header description of the dialog",
|
3037
|
-
"
|
3038
|
-
"reflects": true,
|
3042
|
+
"fieldName": "descriptionText",
|
3039
3043
|
"inheritedFrom": {
|
3040
3044
|
"name": "Dialog",
|
3041
|
-
"module": "components/dialog/dialog.component.
|
3045
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3042
3046
|
}
|
3043
3047
|
},
|
3044
3048
|
{
|
3045
|
-
"
|
3046
|
-
"name": "headerTagName",
|
3049
|
+
"name": "header-tag-name",
|
3047
3050
|
"type": {
|
3048
3051
|
"text": "string"
|
3049
3052
|
},
|
3050
3053
|
"description": "The html tag to be used for the header text",
|
3051
|
-
"
|
3052
|
-
"reflects": true,
|
3054
|
+
"fieldName": "headerTagName",
|
3053
3055
|
"inheritedFrom": {
|
3054
3056
|
"name": "Dialog",
|
3055
|
-
"module": "components/dialog/dialog.component.
|
3057
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3056
3058
|
}
|
3057
3059
|
},
|
3058
3060
|
{
|
3059
|
-
"
|
3060
|
-
"name": "descriptionTagName",
|
3061
|
+
"name": "description-tag-name",
|
3061
3062
|
"type": {
|
3062
3063
|
"text": "string"
|
3063
3064
|
},
|
3064
3065
|
"description": "The html tag to be used for the below-header description text",
|
3065
|
-
"
|
3066
|
-
"reflects": true,
|
3066
|
+
"fieldName": "descriptionTagName",
|
3067
3067
|
"inheritedFrom": {
|
3068
3068
|
"name": "Dialog",
|
3069
|
-
"module": "components/dialog/dialog.component.
|
3069
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3070
3070
|
}
|
3071
3071
|
},
|
3072
3072
|
{
|
3073
|
-
"kind": "field",
|
3074
3073
|
"name": "role",
|
3075
3074
|
"type": {
|
3076
3075
|
"text": "DialogRole"
|
3077
3076
|
},
|
3078
3077
|
"description": "Role of the dialog",
|
3079
3078
|
"default": "dialog",
|
3080
|
-
"
|
3081
|
-
"reflects": true,
|
3079
|
+
"fieldName": "role",
|
3082
3080
|
"inheritedFrom": {
|
3083
3081
|
"name": "Dialog",
|
3084
|
-
"module": "components/dialog/dialog.component.
|
3082
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3085
3083
|
}
|
3086
3084
|
},
|
3087
3085
|
{
|
3088
|
-
"
|
3089
|
-
"name": "disableAriaHasPopup",
|
3086
|
+
"name": "disable-aria-haspopup",
|
3090
3087
|
"type": {
|
3091
3088
|
"text": "boolean"
|
3092
3089
|
},
|
3093
3090
|
"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.",
|
3094
3091
|
"default": "false",
|
3095
|
-
"
|
3096
|
-
"reflects": true,
|
3092
|
+
"fieldName": "disableAriaHasPopup",
|
3097
3093
|
"inheritedFrom": {
|
3098
3094
|
"name": "Dialog",
|
3099
|
-
"module": "components/dialog/dialog.component.
|
3095
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3100
3096
|
}
|
3101
3097
|
},
|
3102
3098
|
{
|
3103
|
-
"
|
3104
|
-
"
|
3105
|
-
|
3106
|
-
|
3099
|
+
"name": "focus-trap",
|
3100
|
+
"type": {
|
3101
|
+
"text": "boolean"
|
3102
|
+
},
|
3103
|
+
"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.",
|
3104
|
+
"default": "true",
|
3105
|
+
"fieldName": "focusTrap",
|
3107
3106
|
"inheritedFrom": {
|
3108
3107
|
"name": "Dialog",
|
3109
|
-
"module": "components/dialog/dialog.component.
|
3108
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3110
3109
|
}
|
3110
|
+
}
|
3111
|
+
],
|
3112
|
+
"superclass": {
|
3113
|
+
"name": "Dialog",
|
3114
|
+
"module": "/src/components/dialog/dialog.component"
|
3115
|
+
},
|
3116
|
+
"tagName": "mdc-announcementdialog",
|
3117
|
+
"jsDoc": "/**\n * AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\n * It can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\n * The dialog is available in 4 sizes: 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 * **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-illustration\n * @dependency mdc-text\n *\n * @tagname mdc-announcementdialog\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-announcementdialog-illustration-background-color - background color of the illustration section\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 * @cssproperty --mdc-dialog-height - height of the dialog\n *\n * @csspart body - The main body container that holds the illustration and content sections\n * @csspart illustration-container - The container for the illustration section\n * @csspart content-container - The container for the content section\n * @csspart header-text - The header text\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 illustration-container - Slot for the illustration container section\n * @slot content-container - Slot for the content (header, description, etc) section\n * @slot description-container - Slot for the description in the content (below header) - pass in Text, Links etc as needed.\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 */",
|
3118
|
+
"customElement": true
|
3119
|
+
}
|
3120
|
+
],
|
3121
|
+
"exports": [
|
3122
|
+
{
|
3123
|
+
"kind": "js",
|
3124
|
+
"name": "default",
|
3125
|
+
"declaration": {
|
3126
|
+
"name": "AnnouncementDialog",
|
3127
|
+
"module": "components/announcementdialog/announcementdialog.component.js"
|
3128
|
+
}
|
3129
|
+
}
|
3130
|
+
]
|
3131
|
+
},
|
3132
|
+
{
|
3133
|
+
"kind": "javascript-module",
|
3134
|
+
"path": "components/appheader/appheader.component.js",
|
3135
|
+
"declarations": [
|
3136
|
+
{
|
3137
|
+
"kind": "class",
|
3138
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
3139
|
+
"name": "Appheader",
|
3140
|
+
"cssParts": [
|
3141
|
+
{
|
3142
|
+
"description": "The main container for styling the header.",
|
3143
|
+
"name": "container"
|
3111
3144
|
},
|
3112
3145
|
{
|
3113
|
-
"
|
3114
|
-
"name": "
|
3115
|
-
|
3116
|
-
|
3117
|
-
|
3118
|
-
|
3119
|
-
|
3120
|
-
|
3121
|
-
|
3122
|
-
|
3123
|
-
},
|
3124
|
-
{
|
3125
|
-
"name": "newValue",
|
3126
|
-
"type": {
|
3127
|
-
"text": "boolean"
|
3128
|
-
},
|
3129
|
-
"description": "The new value of the visible property."
|
3130
|
-
}
|
3131
|
-
],
|
3132
|
-
"description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog.",
|
3133
|
-
"inheritedFrom": {
|
3134
|
-
"name": "Dialog",
|
3135
|
-
"module": "components/dialog/dialog.component.js"
|
3136
|
-
}
|
3146
|
+
"description": "The leading section of the header.",
|
3147
|
+
"name": "leading-section"
|
3148
|
+
},
|
3149
|
+
{
|
3150
|
+
"description": "The center section of the header.",
|
3151
|
+
"name": "center-section"
|
3152
|
+
},
|
3153
|
+
{
|
3154
|
+
"description": "The trailing section of the header.",
|
3155
|
+
"name": "trailing-section"
|
3137
3156
|
}
|
3138
3157
|
],
|
3139
|
-
"
|
3158
|
+
"slots": [
|
3159
|
+
{
|
3160
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
3161
|
+
"name": "leading"
|
3162
|
+
},
|
3163
|
+
{
|
3164
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
3165
|
+
"name": "center"
|
3166
|
+
},
|
3167
|
+
{
|
3168
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
3169
|
+
"name": "trailing"
|
3170
|
+
}
|
3171
|
+
],
|
3172
|
+
"members": [],
|
3173
|
+
"superclass": {
|
3174
|
+
"name": "Component",
|
3175
|
+
"module": "/src/models"
|
3176
|
+
},
|
3177
|
+
"tagName": "mdc-appheader",
|
3178
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
3179
|
+
"customElement": true
|
3180
|
+
}
|
3181
|
+
],
|
3182
|
+
"exports": [
|
3183
|
+
{
|
3184
|
+
"kind": "js",
|
3185
|
+
"name": "default",
|
3186
|
+
"declaration": {
|
3187
|
+
"name": "Appheader",
|
3188
|
+
"module": "components/appheader/appheader.component.js"
|
3189
|
+
}
|
3190
|
+
}
|
3191
|
+
]
|
3192
|
+
},
|
3193
|
+
{
|
3194
|
+
"kind": "javascript-module",
|
3195
|
+
"path": "components/avatar/avatar.component.js",
|
3196
|
+
"declarations": [
|
3197
|
+
{
|
3198
|
+
"kind": "class",
|
3199
|
+
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
3200
|
+
"name": "Avatar",
|
3201
|
+
"cssProperties": [
|
3140
3202
|
{
|
3141
|
-
"description": "
|
3142
|
-
"name": "
|
3143
|
-
"reactName": "onShown",
|
3144
|
-
"inheritedFrom": {
|
3145
|
-
"name": "Dialog",
|
3146
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3147
|
-
}
|
3203
|
+
"description": "Allows customization of the default background color.",
|
3204
|
+
"name": "--mdc-avatar-default-background-color"
|
3148
3205
|
},
|
3149
3206
|
{
|
3150
|
-
"description": "
|
3151
|
-
"name": "
|
3152
|
-
"reactName": "onHidden",
|
3153
|
-
"inheritedFrom": {
|
3154
|
-
"name": "Dialog",
|
3155
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3156
|
-
}
|
3207
|
+
"description": "Allows customization of the default foreground color.",
|
3208
|
+
"name": "--mdc-avatar-default-foreground-color"
|
3157
3209
|
},
|
3158
3210
|
{
|
3159
|
-
"description": "
|
3160
|
-
"name": "
|
3161
|
-
"reactName": "onCreated",
|
3162
|
-
"inheritedFrom": {
|
3163
|
-
"name": "Dialog",
|
3164
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3165
|
-
}
|
3211
|
+
"description": "Allows customization of the loading indicator background color.",
|
3212
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
3166
3213
|
},
|
3167
3214
|
{
|
3168
|
-
"description": "
|
3169
|
-
"name": "
|
3170
|
-
"reactName": "onDestroyed",
|
3171
|
-
"inheritedFrom": {
|
3172
|
-
"name": "Dialog",
|
3173
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3174
|
-
}
|
3215
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
3216
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
3175
3217
|
},
|
3176
3218
|
{
|
3177
|
-
"description": "
|
3178
|
-
"name": "
|
3179
|
-
"reactName": "onClose",
|
3180
|
-
"inheritedFrom": {
|
3181
|
-
"name": "Dialog",
|
3182
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3183
|
-
}
|
3219
|
+
"description": "Allows customization of the loading overlay background color.",
|
3220
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
3184
3221
|
}
|
3185
3222
|
],
|
3186
|
-
"
|
3223
|
+
"cssParts": [
|
3187
3224
|
{
|
3188
|
-
"
|
3189
|
-
"
|
3190
|
-
"text": "IllustrationNames | undefined"
|
3191
|
-
},
|
3192
|
-
"description": "The illustration to display in the announcement dialog.\nThis can be an image URL, icon name, or any other illustration identifier.\n\nMake sure to choose the right illustration respective the size (the filename includes the size information, i.e. threetwozero = 320px)",
|
3193
|
-
"fieldName": "illustration"
|
3225
|
+
"description": "The main content of the avatar.",
|
3226
|
+
"name": "content"
|
3194
3227
|
},
|
3195
3228
|
{
|
3196
|
-
"
|
3197
|
-
"
|
3198
|
-
"text": "DialogSize"
|
3199
|
-
},
|
3200
|
-
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
3201
|
-
"default": "medium",
|
3202
|
-
"fieldName": "size",
|
3203
|
-
"inheritedFrom": {
|
3204
|
-
"name": "Dialog",
|
3205
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3206
|
-
}
|
3229
|
+
"description": "The photo of the avatar.",
|
3230
|
+
"name": "photo"
|
3207
3231
|
},
|
3208
3232
|
{
|
3209
|
-
"
|
3210
|
-
"
|
3211
|
-
"text": "boolean"
|
3212
|
-
},
|
3213
|
-
"default": "true",
|
3214
|
-
"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.",
|
3215
|
-
"fieldName": "shouldFocusTrapWrap",
|
3216
|
-
"inheritedFrom": {
|
3217
|
-
"name": "FocusTrapMixin",
|
3218
|
-
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
3219
|
-
}
|
3233
|
+
"description": "The presence indicator of the avatar.",
|
3234
|
+
"name": "presence"
|
3220
3235
|
},
|
3221
3236
|
{
|
3222
|
-
"
|
3223
|
-
"
|
3224
|
-
"text": "string"
|
3225
|
-
},
|
3226
|
-
"default": "''",
|
3227
|
-
"description": "The unique ID of the dialog",
|
3228
|
-
"fieldName": "id",
|
3229
|
-
"inheritedFrom": {
|
3230
|
-
"name": "Dialog",
|
3231
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3232
|
-
}
|
3237
|
+
"description": "The wrapper for the loading indicator.",
|
3238
|
+
"name": "loading-wrapper"
|
3233
3239
|
},
|
3234
3240
|
{
|
3235
|
-
"
|
3241
|
+
"description": "The loading indicator of the avatar.",
|
3242
|
+
"name": "loader"
|
3243
|
+
}
|
3244
|
+
],
|
3245
|
+
"members": [
|
3246
|
+
{
|
3247
|
+
"kind": "field",
|
3248
|
+
"name": "src",
|
3236
3249
|
"type": {
|
3237
3250
|
"text": "string | undefined"
|
3238
3251
|
},
|
3239
|
-
"description": "The
|
3240
|
-
"
|
3241
|
-
"fieldName": "triggerId",
|
3252
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
3253
|
+
"attribute": "src",
|
3242
3254
|
"inheritedFrom": {
|
3243
|
-
"name": "
|
3244
|
-
"module": "
|
3255
|
+
"name": "AvatarComponentMixin",
|
3256
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3245
3257
|
}
|
3246
3258
|
},
|
3247
3259
|
{
|
3248
|
-
"
|
3260
|
+
"kind": "field",
|
3261
|
+
"name": "initials",
|
3249
3262
|
"type": {
|
3250
|
-
"text": "
|
3263
|
+
"text": "string | undefined"
|
3251
3264
|
},
|
3252
|
-
"description": "The
|
3253
|
-
"
|
3254
|
-
"fieldName": "visible",
|
3265
|
+
"description": "The initials to be displayed for the avatar.",
|
3266
|
+
"attribute": "initials",
|
3255
3267
|
"inheritedFrom": {
|
3256
|
-
"name": "
|
3257
|
-
"module": "
|
3268
|
+
"name": "AvatarComponentMixin",
|
3269
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3258
3270
|
}
|
3259
3271
|
},
|
3260
3272
|
{
|
3261
|
-
"
|
3273
|
+
"kind": "field",
|
3274
|
+
"name": "presence",
|
3262
3275
|
"type": {
|
3263
|
-
"text": "
|
3276
|
+
"text": "PresenceType | undefined"
|
3264
3277
|
},
|
3265
|
-
"description": "The
|
3266
|
-
"
|
3267
|
-
"fieldName": "zIndex",
|
3278
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
3279
|
+
"attribute": "presence",
|
3268
3280
|
"inheritedFrom": {
|
3269
|
-
"name": "
|
3270
|
-
"module": "
|
3281
|
+
"name": "AvatarComponentMixin",
|
3282
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3271
3283
|
}
|
3272
3284
|
},
|
3273
3285
|
{
|
3274
|
-
"
|
3286
|
+
"kind": "field",
|
3287
|
+
"name": "size",
|
3275
3288
|
"type": {
|
3276
|
-
"text": "
|
3289
|
+
"text": "AvatarSize"
|
3277
3290
|
},
|
3278
|
-
"description": "
|
3279
|
-
"default": "
|
3280
|
-
"
|
3291
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3292
|
+
"default": "32",
|
3293
|
+
"attribute": "size",
|
3294
|
+
"reflects": true,
|
3281
3295
|
"inheritedFrom": {
|
3282
|
-
"name": "
|
3283
|
-
"module": "
|
3296
|
+
"name": "AvatarComponentMixin",
|
3297
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3284
3298
|
}
|
3285
3299
|
},
|
3286
3300
|
{
|
3287
|
-
"
|
3301
|
+
"kind": "field",
|
3302
|
+
"name": "counter",
|
3288
3303
|
"type": {
|
3289
|
-
"text": "
|
3304
|
+
"text": "number | undefined"
|
3290
3305
|
},
|
3291
|
-
"
|
3292
|
-
"
|
3293
|
-
"fieldName": "closeButtonAriaLabel",
|
3306
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
3307
|
+
"attribute": "counter",
|
3294
3308
|
"inheritedFrom": {
|
3295
|
-
"name": "
|
3296
|
-
"module": "
|
3309
|
+
"name": "AvatarComponentMixin",
|
3310
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3297
3311
|
}
|
3298
3312
|
},
|
3299
3313
|
{
|
3300
|
-
"
|
3314
|
+
"kind": "field",
|
3315
|
+
"name": "isTyping",
|
3301
3316
|
"type": {
|
3302
|
-
"text": "
|
3317
|
+
"text": "boolean"
|
3303
3318
|
},
|
3304
|
-
"default": "
|
3305
|
-
"description": "
|
3306
|
-
"
|
3319
|
+
"default": "false",
|
3320
|
+
"description": "Represents the typing indicator when the user is typing.",
|
3321
|
+
"attribute": "is-typing",
|
3307
3322
|
"inheritedFrom": {
|
3308
|
-
"name": "
|
3309
|
-
"module": "
|
3323
|
+
"name": "AvatarComponentMixin",
|
3324
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3310
3325
|
}
|
3311
3326
|
},
|
3312
3327
|
{
|
3313
|
-
"
|
3328
|
+
"kind": "field",
|
3329
|
+
"name": "iconName",
|
3314
3330
|
"type": {
|
3315
|
-
"text": "
|
3331
|
+
"text": "IconNames | undefined"
|
3316
3332
|
},
|
3317
|
-
"
|
3318
|
-
"
|
3319
|
-
"fieldName": "ariaLabelledby",
|
3333
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3334
|
+
"attribute": "icon-name",
|
3320
3335
|
"inheritedFrom": {
|
3321
|
-
"name": "
|
3322
|
-
"module": "
|
3336
|
+
"name": "IconNameMixin",
|
3337
|
+
"module": "utils/mixins/IconNameMixin.js"
|
3323
3338
|
}
|
3324
|
-
}
|
3339
|
+
}
|
3340
|
+
],
|
3341
|
+
"mixins": [
|
3325
3342
|
{
|
3326
|
-
"name": "
|
3327
|
-
"
|
3328
|
-
"text": "string | null"
|
3329
|
-
},
|
3330
|
-
"default": "null",
|
3331
|
-
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
3332
|
-
"fieldName": "ariaDescribedBy",
|
3333
|
-
"inheritedFrom": {
|
3334
|
-
"name": "Dialog",
|
3335
|
-
"module": "src/components/dialog/dialog.component.ts"
|
3336
|
-
}
|
3343
|
+
"name": "AvatarComponentMixin",
|
3344
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
3337
3345
|
},
|
3338
3346
|
{
|
3339
|
-
"name": "
|
3340
|
-
"
|
3341
|
-
|
3342
|
-
|
3343
|
-
|
3344
|
-
|
3345
|
-
|
3346
|
-
|
3347
|
-
|
3348
|
-
|
3349
|
-
|
3350
|
-
|
3347
|
+
"name": "IconNameMixin",
|
3348
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
3349
|
+
}
|
3350
|
+
],
|
3351
|
+
"superclass": {
|
3352
|
+
"name": "Component",
|
3353
|
+
"module": "/src/models"
|
3354
|
+
},
|
3355
|
+
"tagName": "mdc-avatar",
|
3356
|
+
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
3357
|
+
"customElement": true,
|
3358
|
+
"attributes": [
|
3351
3359
|
{
|
3352
|
-
"name": "
|
3360
|
+
"name": "src",
|
3353
3361
|
"type": {
|
3354
3362
|
"text": "string | undefined"
|
3355
3363
|
},
|
3356
|
-
"description": "
|
3357
|
-
"fieldName": "
|
3364
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
3365
|
+
"fieldName": "src",
|
3358
3366
|
"inheritedFrom": {
|
3359
|
-
"name": "
|
3360
|
-
"module": "src/
|
3367
|
+
"name": "AvatarComponentMixin",
|
3368
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3361
3369
|
}
|
3362
3370
|
},
|
3363
3371
|
{
|
3364
|
-
"name": "
|
3372
|
+
"name": "initials",
|
3365
3373
|
"type": {
|
3366
3374
|
"text": "string | undefined"
|
3367
3375
|
},
|
3368
|
-
"description": "
|
3369
|
-
"fieldName": "
|
3376
|
+
"description": "The initials to be displayed for the avatar.",
|
3377
|
+
"fieldName": "initials",
|
3370
3378
|
"inheritedFrom": {
|
3371
|
-
"name": "
|
3372
|
-
"module": "src/
|
3379
|
+
"name": "AvatarComponentMixin",
|
3380
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3373
3381
|
}
|
3374
3382
|
},
|
3375
3383
|
{
|
3376
|
-
"name": "
|
3384
|
+
"name": "presence",
|
3377
3385
|
"type": {
|
3378
|
-
"text": "
|
3386
|
+
"text": "PresenceType | undefined"
|
3379
3387
|
},
|
3380
|
-
"description": "The
|
3381
|
-
"fieldName": "
|
3388
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
3389
|
+
"fieldName": "presence",
|
3382
3390
|
"inheritedFrom": {
|
3383
|
-
"name": "
|
3384
|
-
"module": "src/
|
3391
|
+
"name": "AvatarComponentMixin",
|
3392
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3385
3393
|
}
|
3386
3394
|
},
|
3387
3395
|
{
|
3388
|
-
"name": "
|
3396
|
+
"name": "size",
|
3389
3397
|
"type": {
|
3390
|
-
"text": "
|
3398
|
+
"text": "AvatarSize"
|
3391
3399
|
},
|
3392
|
-
"description": "
|
3393
|
-
"
|
3400
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3401
|
+
"default": "32",
|
3402
|
+
"fieldName": "size",
|
3394
3403
|
"inheritedFrom": {
|
3395
|
-
"name": "
|
3396
|
-
"module": "src/
|
3404
|
+
"name": "AvatarComponentMixin",
|
3405
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3397
3406
|
}
|
3398
3407
|
},
|
3399
3408
|
{
|
3400
|
-
"name": "
|
3409
|
+
"name": "counter",
|
3401
3410
|
"type": {
|
3402
|
-
"text": "
|
3411
|
+
"text": "number | undefined"
|
3403
3412
|
},
|
3404
|
-
"description": "
|
3405
|
-
"
|
3406
|
-
"fieldName": "role",
|
3413
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
3414
|
+
"fieldName": "counter",
|
3407
3415
|
"inheritedFrom": {
|
3408
|
-
"name": "
|
3409
|
-
"module": "src/
|
3416
|
+
"name": "AvatarComponentMixin",
|
3417
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3410
3418
|
}
|
3411
3419
|
},
|
3412
3420
|
{
|
3413
|
-
"name": "
|
3421
|
+
"name": "is-typing",
|
3414
3422
|
"type": {
|
3415
3423
|
"text": "boolean"
|
3416
3424
|
},
|
3417
|
-
"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.",
|
3418
3425
|
"default": "false",
|
3419
|
-
"
|
3426
|
+
"description": "Represents the typing indicator when the user is typing.",
|
3427
|
+
"fieldName": "isTyping",
|
3420
3428
|
"inheritedFrom": {
|
3421
|
-
"name": "
|
3422
|
-
"module": "src/
|
3429
|
+
"name": "AvatarComponentMixin",
|
3430
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3423
3431
|
}
|
3424
3432
|
},
|
3425
3433
|
{
|
3426
|
-
"name": "
|
3434
|
+
"name": "icon-name",
|
3427
3435
|
"type": {
|
3428
|
-
"text": "
|
3436
|
+
"text": "IconNames | undefined"
|
3429
3437
|
},
|
3430
|
-
"description": "
|
3431
|
-
"
|
3432
|
-
"fieldName": "focusTrap",
|
3438
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3439
|
+
"fieldName": "iconName",
|
3433
3440
|
"inheritedFrom": {
|
3434
|
-
"name": "
|
3435
|
-
"module": "src/
|
3441
|
+
"name": "IconNameMixin",
|
3442
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
3436
3443
|
}
|
3437
3444
|
}
|
3438
|
-
]
|
3439
|
-
"superclass": {
|
3440
|
-
"name": "Dialog",
|
3441
|
-
"module": "/src/components/dialog/dialog.component"
|
3442
|
-
},
|
3443
|
-
"tagName": "mdc-announcementdialog",
|
3444
|
-
"jsDoc": "/**\n * AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\n * It can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\n * The dialog is available in 4 sizes: 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 * **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-illustration\n * @dependency mdc-text\n *\n * @tagname mdc-announcementdialog\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-announcementdialog-illustration-background-color - background color of the illustration section\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 * @cssproperty --mdc-dialog-height - height of the dialog\n *\n * @csspart body - The main body container that holds the illustration and content sections\n * @csspart illustration-container - The container for the illustration section\n * @csspart content-container - The container for the content section\n * @csspart header-text - The header text\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 illustration-container - Slot for the illustration container section\n * @slot content-container - Slot for the content (header, description, etc) section\n * @slot description-container - Slot for the description in the content (below header) - pass in Text, Links etc as needed.\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 */",
|
3445
|
-
"customElement": true
|
3445
|
+
]
|
3446
3446
|
}
|
3447
3447
|
],
|
3448
3448
|
"exports": [
|
@@ -3450,8 +3450,8 @@
|
|
3450
3450
|
"kind": "js",
|
3451
3451
|
"name": "default",
|
3452
3452
|
"declaration": {
|
3453
|
-
"name": "
|
3454
|
-
"module": "components/
|
3453
|
+
"name": "Avatar",
|
3454
|
+
"module": "components/avatar/avatar.component.js"
|
3455
3455
|
}
|
3456
3456
|
}
|
3457
3457
|
]
|
@@ -28026,56 +28026,168 @@
|
|
28026
28026
|
},
|
28027
28027
|
{
|
28028
28028
|
"kind": "javascript-module",
|
28029
|
-
"path": "components/
|
28029
|
+
"path": "components/optgroup/optgroup.component.js",
|
28030
28030
|
"declarations": [
|
28031
28031
|
{
|
28032
28032
|
"kind": "class",
|
28033
|
-
"description": "
|
28034
|
-
"name": "
|
28033
|
+
"description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
|
28034
|
+
"name": "OptGroup",
|
28035
28035
|
"cssProperties": [
|
28036
28036
|
{
|
28037
|
-
"description": "
|
28038
|
-
"name": "--mdc-
|
28039
|
-
}
|
28037
|
+
"description": "Allows customization of the disabled option color.",
|
28038
|
+
"name": "--mdc-optgroup-disabled-color"
|
28039
|
+
}
|
28040
|
+
],
|
28041
|
+
"cssParts": [
|
28040
28042
|
{
|
28041
|
-
"description": "
|
28042
|
-
"name": "
|
28043
|
-
}
|
28043
|
+
"description": "The header text of the optgroup.",
|
28044
|
+
"name": "header-text"
|
28045
|
+
}
|
28046
|
+
],
|
28047
|
+
"slots": [
|
28044
28048
|
{
|
28045
|
-
"description": "
|
28046
|
-
"name": "
|
28047
|
-
}
|
28049
|
+
"description": "This is a default slot for mdc-option elements.",
|
28050
|
+
"name": "default"
|
28051
|
+
}
|
28052
|
+
],
|
28053
|
+
"members": [
|
28048
28054
|
{
|
28049
|
-
"
|
28050
|
-
"name": "
|
28055
|
+
"kind": "field",
|
28056
|
+
"name": "label",
|
28057
|
+
"type": {
|
28058
|
+
"text": "string | undefined"
|
28059
|
+
},
|
28060
|
+
"description": "The header text to be displayed on the top of the options list.",
|
28061
|
+
"attribute": "label",
|
28062
|
+
"reflects": true
|
28051
28063
|
},
|
28052
28064
|
{
|
28053
|
-
"
|
28054
|
-
"name": "
|
28065
|
+
"kind": "method",
|
28066
|
+
"name": "setDisabledForAllOptions",
|
28067
|
+
"privacy": "private",
|
28068
|
+
"return": {
|
28069
|
+
"type": {
|
28070
|
+
"text": "void"
|
28071
|
+
}
|
28072
|
+
}
|
28055
28073
|
},
|
28056
28074
|
{
|
28057
|
-
"
|
28058
|
-
"name": "
|
28075
|
+
"kind": "field",
|
28076
|
+
"name": "dataAriaLabel",
|
28077
|
+
"type": {
|
28078
|
+
"text": "string | null"
|
28079
|
+
},
|
28080
|
+
"default": "null",
|
28081
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
28082
|
+
"attribute": "data-aria-label",
|
28083
|
+
"reflects": true,
|
28084
|
+
"inheritedFrom": {
|
28085
|
+
"name": "DataAriaLabelMixin",
|
28086
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
28087
|
+
}
|
28059
28088
|
},
|
28060
28089
|
{
|
28061
|
-
"
|
28062
|
-
"name": "
|
28090
|
+
"kind": "field",
|
28091
|
+
"name": "disabled",
|
28092
|
+
"type": {
|
28093
|
+
"text": "boolean | undefined"
|
28094
|
+
},
|
28095
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
28096
|
+
"default": "undefined",
|
28097
|
+
"attribute": "disabled",
|
28098
|
+
"reflects": true,
|
28099
|
+
"inheritedFrom": {
|
28100
|
+
"name": "DisabledMixin",
|
28101
|
+
"module": "utils/mixins/DisabledMixin.js"
|
28102
|
+
}
|
28103
|
+
}
|
28104
|
+
],
|
28105
|
+
"attributes": [
|
28106
|
+
{
|
28107
|
+
"name": "label",
|
28108
|
+
"type": {
|
28109
|
+
"text": "string | undefined"
|
28110
|
+
},
|
28111
|
+
"description": "The header text to be displayed on the top of the options list.",
|
28112
|
+
"fieldName": "label"
|
28063
28113
|
},
|
28064
28114
|
{
|
28065
|
-
"
|
28066
|
-
"
|
28115
|
+
"name": "data-aria-label",
|
28116
|
+
"type": {
|
28117
|
+
"text": "string | null"
|
28118
|
+
},
|
28119
|
+
"default": "null",
|
28120
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
28121
|
+
"fieldName": "dataAriaLabel",
|
28122
|
+
"inheritedFrom": {
|
28123
|
+
"name": "DataAriaLabelMixin",
|
28124
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
28125
|
+
}
|
28067
28126
|
},
|
28068
28127
|
{
|
28069
|
-
"
|
28070
|
-
"
|
28128
|
+
"name": "disabled",
|
28129
|
+
"type": {
|
28130
|
+
"text": "boolean | undefined"
|
28131
|
+
},
|
28132
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
28133
|
+
"default": "undefined",
|
28134
|
+
"fieldName": "disabled",
|
28135
|
+
"inheritedFrom": {
|
28136
|
+
"name": "DisabledMixin",
|
28137
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
28138
|
+
}
|
28139
|
+
}
|
28140
|
+
],
|
28141
|
+
"mixins": [
|
28142
|
+
{
|
28143
|
+
"name": "DataAriaLabelMixin",
|
28144
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
28071
28145
|
},
|
28072
28146
|
{
|
28073
|
-
"
|
28074
|
-
"
|
28147
|
+
"name": "DisabledMixin",
|
28148
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
28149
|
+
}
|
28150
|
+
],
|
28151
|
+
"superclass": {
|
28152
|
+
"name": "Component",
|
28153
|
+
"module": "/src/models"
|
28154
|
+
},
|
28155
|
+
"tagName": "mdc-optgroup",
|
28156
|
+
"jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n *\n * @csspart header-text - The header text of the optgroup.\n */",
|
28157
|
+
"customElement": true
|
28158
|
+
}
|
28159
|
+
],
|
28160
|
+
"exports": [
|
28161
|
+
{
|
28162
|
+
"kind": "js",
|
28163
|
+
"name": "default",
|
28164
|
+
"declaration": {
|
28165
|
+
"name": "OptGroup",
|
28166
|
+
"module": "components/optgroup/optgroup.component.js"
|
28167
|
+
}
|
28168
|
+
}
|
28169
|
+
]
|
28170
|
+
},
|
28171
|
+
{
|
28172
|
+
"kind": "javascript-module",
|
28173
|
+
"path": "components/option/option.component.js",
|
28174
|
+
"declarations": [
|
28175
|
+
{
|
28176
|
+
"kind": "class",
|
28177
|
+
"description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\n\n**Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\nConsumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.",
|
28178
|
+
"name": "Option",
|
28179
|
+
"cssProperties": [
|
28180
|
+
{
|
28181
|
+
"description": "gap between columns in the option",
|
28182
|
+
"name": "--mdc-listitem-column-gap",
|
28183
|
+
"inheritedFrom": {
|
28184
|
+
"name": "ListItem",
|
28185
|
+
"module": "src/components/listitem/listitem.component.ts"
|
28186
|
+
}
|
28075
28187
|
},
|
28076
28188
|
{
|
28077
|
-
"description": "
|
28078
|
-
"name": "--mdc-
|
28189
|
+
"description": "width of the icon in the option",
|
28190
|
+
"name": "--mdc-option-icon-width"
|
28079
28191
|
},
|
28080
28192
|
{
|
28081
28193
|
"description": "Allows customization of the default background color.",
|
@@ -28125,14 +28237,6 @@
|
|
28125
28237
|
"module": "src/components/listitem/listitem.component.ts"
|
28126
28238
|
}
|
28127
28239
|
},
|
28128
|
-
{
|
28129
|
-
"description": "Allows customization of column gap.",
|
28130
|
-
"name": "--mdc-listitem-column-gap",
|
28131
|
-
"inheritedFrom": {
|
28132
|
-
"name": "ListItem",
|
28133
|
-
"module": "src/components/listitem/listitem.component.ts"
|
28134
|
-
}
|
28135
|
-
},
|
28136
28240
|
{
|
28137
28241
|
"description": "Allows customization of padding left and right.",
|
28138
28242
|
"name": "--mdc-listitem-padding-left-right",
|
@@ -28175,30 +28279,6 @@
|
|
28175
28279
|
}
|
28176
28280
|
],
|
28177
28281
|
"cssParts": [
|
28178
|
-
{
|
28179
|
-
"description": "The arrow of the navmenuitem.",
|
28180
|
-
"name": "arrow"
|
28181
|
-
},
|
28182
|
-
{
|
28183
|
-
"description": "The badge of the navmenuitem.",
|
28184
|
-
"name": "badge"
|
28185
|
-
},
|
28186
|
-
{
|
28187
|
-
"description": "The container of the icon.",
|
28188
|
-
"name": "icon-container"
|
28189
|
-
},
|
28190
|
-
{
|
28191
|
-
"description": "The container of the text.",
|
28192
|
-
"name": "text-container"
|
28193
|
-
},
|
28194
|
-
{
|
28195
|
-
"description": "The trailing arrow of the navmenuitem.",
|
28196
|
-
"name": "trailing-arrow",
|
28197
|
-
"inheritedFrom": {
|
28198
|
-
"name": "MenuItem",
|
28199
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
28200
|
-
}
|
28201
|
-
},
|
28202
28282
|
{
|
28203
28283
|
"description": "Allows customization of the leading part.",
|
28204
28284
|
"name": "leading",
|
@@ -28207,14 +28287,6 @@
|
|
28207
28287
|
"module": "src/components/listitem/listitem.component.ts"
|
28208
28288
|
}
|
28209
28289
|
},
|
28210
|
-
{
|
28211
|
-
"description": "Allows customization of leading arrow icon.",
|
28212
|
-
"name": "leading-arrow",
|
28213
|
-
"inheritedFrom": {
|
28214
|
-
"name": "MenuItem",
|
28215
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
28216
|
-
}
|
28217
|
-
},
|
28218
28290
|
{
|
28219
28291
|
"description": "Allows customization of the leading text part.",
|
28220
28292
|
"name": "leading-text",
|
@@ -28243,55 +28315,23 @@
|
|
28243
28315
|
"members": [
|
28244
28316
|
{
|
28245
28317
|
"kind": "field",
|
28246
|
-
"name": "
|
28247
|
-
"type": {
|
28248
|
-
"text": "boolean | undefined"
|
28249
|
-
},
|
28250
|
-
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
|
28251
|
-
"default": "undefined",
|
28252
|
-
"attribute": "active",
|
28253
|
-
"reflects": true
|
28254
|
-
},
|
28255
|
-
{
|
28256
|
-
"kind": "field",
|
28257
|
-
"name": "badgeType",
|
28258
|
-
"type": {
|
28259
|
-
"text": "BadgeType | undefined"
|
28260
|
-
},
|
28261
|
-
"description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
|
28262
|
-
"attribute": "badge-type",
|
28263
|
-
"reflects": true
|
28264
|
-
},
|
28265
|
-
{
|
28266
|
-
"kind": "field",
|
28267
|
-
"name": "counter",
|
28268
|
-
"type": {
|
28269
|
-
"text": "number | undefined"
|
28270
|
-
},
|
28271
|
-
"description": "Counter is the number which can be provided in the badge.",
|
28272
|
-
"attribute": "counter",
|
28273
|
-
"reflects": true
|
28274
|
-
},
|
28275
|
-
{
|
28276
|
-
"kind": "field",
|
28277
|
-
"name": "maxCounter",
|
28318
|
+
"name": "selected",
|
28278
28319
|
"type": {
|
28279
|
-
"text": "
|
28320
|
+
"text": "boolean"
|
28280
28321
|
},
|
28281
|
-
"
|
28282
|
-
"
|
28283
|
-
"attribute": "
|
28322
|
+
"default": "false",
|
28323
|
+
"description": "The selected attribute is used to indicate that the option is selected.",
|
28324
|
+
"attribute": "selected",
|
28284
28325
|
"reflects": true
|
28285
28326
|
},
|
28286
28327
|
{
|
28287
28328
|
"kind": "field",
|
28288
|
-
"name": "
|
28329
|
+
"name": "prefixIcon",
|
28289
28330
|
"type": {
|
28290
|
-
"text": "
|
28331
|
+
"text": "IconNames | undefined"
|
28291
28332
|
},
|
28292
|
-
"description": "
|
28293
|
-
"
|
28294
|
-
"attribute": "nav-id",
|
28333
|
+
"description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
|
28334
|
+
"attribute": "prefix-icon",
|
28295
28335
|
"reflects": true
|
28296
28336
|
},
|
28297
28337
|
{
|
@@ -28301,249 +28341,108 @@
|
|
28301
28341
|
"text": "string | null"
|
28302
28342
|
},
|
28303
28343
|
"default": "null",
|
28304
|
-
"description": "
|
28305
|
-
"attribute": "aria-label"
|
28306
|
-
},
|
28307
|
-
{
|
28308
|
-
"kind": "field",
|
28309
|
-
"name": "disableAriaCurrent",
|
28310
|
-
"type": {
|
28311
|
-
"text": "boolean | undefined"
|
28312
|
-
},
|
28313
|
-
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
|
28314
|
-
"attribute": "disable-aria-current",
|
28315
|
-
"reflects": true
|
28316
|
-
},
|
28317
|
-
{
|
28318
|
-
"kind": "field",
|
28319
|
-
"name": "tooltipText",
|
28320
|
-
"type": {
|
28321
|
-
"text": "string | undefined"
|
28322
|
-
},
|
28323
|
-
"description": "The tooltip text is displayed on hover of the list item.",
|
28324
|
-
"attribute": "tooltip-text",
|
28344
|
+
"description": "Any additional description can be provided here for screen readers.",
|
28345
|
+
"attribute": "aria-label",
|
28325
28346
|
"reflects": true
|
28326
28347
|
},
|
28327
|
-
{
|
28328
|
-
"kind": "method",
|
28329
|
-
"name": "removeTooltip",
|
28330
|
-
"privacy": "private"
|
28331
|
-
},
|
28332
|
-
{
|
28333
|
-
"kind": "method",
|
28334
|
-
"name": "renderDynamicTooltip",
|
28335
|
-
"privacy": "private",
|
28336
|
-
"return": {
|
28337
|
-
"type": {
|
28338
|
-
"text": "void"
|
28339
|
-
}
|
28340
|
-
}
|
28341
|
-
},
|
28342
|
-
{
|
28343
|
-
"kind": "method",
|
28344
|
-
"name": "isNested",
|
28345
|
-
"privacy": "private",
|
28346
|
-
"return": {
|
28347
|
-
"type": {
|
28348
|
-
"text": "boolean"
|
28349
|
-
}
|
28350
|
-
},
|
28351
|
-
"description": "Check whether the navmenuitem is inside a nested nav structure.\nReturns `true` if there is a parent `mdc-menupopover`\nThis method assumes nesting implies deeper levels of nav hierarchy."
|
28352
|
-
},
|
28353
|
-
{
|
28354
|
-
"kind": "method",
|
28355
|
-
"name": "handleClickEvent",
|
28356
|
-
"privacy": "private",
|
28357
|
-
"return": {
|
28358
|
-
"type": {
|
28359
|
-
"text": "void"
|
28360
|
-
}
|
28361
|
-
}
|
28362
|
-
},
|
28363
|
-
{
|
28364
|
-
"kind": "method",
|
28365
|
-
"name": "renderTextLabel",
|
28366
|
-
"privacy": "private",
|
28367
|
-
"parameters": [
|
28368
|
-
{
|
28369
|
-
"name": "label",
|
28370
|
-
"type": {
|
28371
|
-
"text": "string | undefined"
|
28372
|
-
}
|
28373
|
-
}
|
28374
|
-
]
|
28375
|
-
},
|
28376
|
-
{
|
28377
|
-
"kind": "method",
|
28378
|
-
"name": "renderArrowIcon",
|
28379
|
-
"privacy": "private",
|
28380
|
-
"parameters": [
|
28381
|
-
{
|
28382
|
-
"name": "showLabel",
|
28383
|
-
"type": {
|
28384
|
-
"text": "boolean | undefined"
|
28385
|
-
}
|
28386
|
-
}
|
28387
|
-
]
|
28388
|
-
},
|
28389
|
-
{
|
28390
|
-
"kind": "method",
|
28391
|
-
"name": "renderBadge",
|
28392
|
-
"privacy": "private",
|
28393
|
-
"parameters": [
|
28394
|
-
{
|
28395
|
-
"name": "showLabel",
|
28396
|
-
"type": {
|
28397
|
-
"text": "boolean | undefined"
|
28398
|
-
}
|
28399
|
-
}
|
28400
|
-
]
|
28401
|
-
},
|
28402
|
-
{
|
28403
|
-
"kind": "field",
|
28404
|
-
"name": "iconName",
|
28405
|
-
"type": {
|
28406
|
-
"text": "IconNames | undefined"
|
28407
|
-
},
|
28408
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
28409
|
-
"attribute": "icon-name",
|
28410
|
-
"inheritedFrom": {
|
28411
|
-
"name": "IconNameMixin",
|
28412
|
-
"module": "utils/mixins/IconNameMixin.js"
|
28413
|
-
}
|
28414
|
-
},
|
28415
28348
|
{
|
28416
28349
|
"kind": "field",
|
28417
|
-
"name": "
|
28350
|
+
"name": "name",
|
28418
28351
|
"type": {
|
28419
|
-
"text": "
|
28352
|
+
"text": "string"
|
28420
28353
|
},
|
28421
|
-
"
|
28422
|
-
"
|
28354
|
+
"default": "''",
|
28355
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
28356
|
+
"attribute": "name",
|
28423
28357
|
"reflects": true,
|
28424
28358
|
"inheritedFrom": {
|
28425
|
-
"name": "
|
28426
|
-
"module": "
|
28359
|
+
"name": "FormInternalsMixin",
|
28360
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28427
28361
|
}
|
28428
28362
|
},
|
28429
28363
|
{
|
28430
28364
|
"kind": "field",
|
28431
|
-
"name": "
|
28365
|
+
"name": "value",
|
28432
28366
|
"type": {
|
28433
|
-
"text": "
|
28367
|
+
"text": "string"
|
28434
28368
|
},
|
28435
|
-
"
|
28436
|
-
"
|
28369
|
+
"default": "''",
|
28370
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
28371
|
+
"attribute": "value",
|
28437
28372
|
"reflects": true,
|
28438
28373
|
"inheritedFrom": {
|
28439
|
-
"name": "
|
28440
|
-
"module": "
|
28374
|
+
"name": "FormInternalsMixin",
|
28375
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28441
28376
|
}
|
28442
28377
|
},
|
28443
28378
|
{
|
28444
28379
|
"kind": "field",
|
28445
|
-
"name": "
|
28380
|
+
"name": "validationMessage",
|
28446
28381
|
"type": {
|
28447
28382
|
"text": "string | undefined"
|
28448
28383
|
},
|
28449
|
-
"description": "
|
28450
|
-
"attribute": "
|
28384
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
28385
|
+
"attribute": "validation-message",
|
28451
28386
|
"reflects": true,
|
28452
28387
|
"inheritedFrom": {
|
28453
|
-
"name": "
|
28454
|
-
"module": "
|
28388
|
+
"name": "FormInternalsMixin",
|
28389
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28455
28390
|
}
|
28456
28391
|
},
|
28457
28392
|
{
|
28458
28393
|
"kind": "field",
|
28459
|
-
"name": "
|
28394
|
+
"name": "validity",
|
28460
28395
|
"type": {
|
28461
|
-
"text": "
|
28462
|
-
},
|
28463
|
-
"
|
28464
|
-
"attribute": "value",
|
28465
|
-
"reflects": true,
|
28396
|
+
"text": "ValidityState"
|
28397
|
+
},
|
28398
|
+
"readonly": true,
|
28466
28399
|
"inheritedFrom": {
|
28467
|
-
"name": "
|
28468
|
-
"module": "
|
28400
|
+
"name": "FormInternalsMixin",
|
28401
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28469
28402
|
}
|
28470
28403
|
},
|
28471
28404
|
{
|
28472
|
-
"kind": "
|
28473
|
-
"name": "
|
28474
|
-
"
|
28475
|
-
"return": {
|
28476
|
-
"type": {
|
28477
|
-
"text": "void"
|
28478
|
-
}
|
28479
|
-
},
|
28480
|
-
"parameters": [
|
28481
|
-
{
|
28482
|
-
"name": "event",
|
28483
|
-
"type": {
|
28484
|
-
"text": "KeyboardEvent"
|
28485
|
-
},
|
28486
|
-
"description": "The keyboard event that triggered the action."
|
28487
|
-
}
|
28488
|
-
],
|
28489
|
-
"description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
|
28405
|
+
"kind": "field",
|
28406
|
+
"name": "willValidate",
|
28407
|
+
"readonly": true,
|
28490
28408
|
"inheritedFrom": {
|
28491
|
-
"name": "
|
28492
|
-
"module": "
|
28409
|
+
"name": "FormInternalsMixin",
|
28410
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28493
28411
|
}
|
28494
28412
|
},
|
28495
28413
|
{
|
28496
28414
|
"kind": "method",
|
28497
|
-
"name": "
|
28498
|
-
"
|
28415
|
+
"name": "setValidity",
|
28416
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
28499
28417
|
"return": {
|
28500
28418
|
"type": {
|
28501
|
-
"text": "
|
28419
|
+
"text": ""
|
28502
28420
|
}
|
28503
28421
|
},
|
28504
|
-
"parameters": [
|
28505
|
-
{
|
28506
|
-
"name": "event",
|
28507
|
-
"type": {
|
28508
|
-
"text": "KeyboardEvent"
|
28509
|
-
},
|
28510
|
-
"description": "The keyboard event that triggered the action."
|
28511
|
-
}
|
28512
|
-
],
|
28513
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
28514
28422
|
"inheritedFrom": {
|
28515
|
-
"name": "
|
28516
|
-
"module": "
|
28423
|
+
"name": "FormInternalsMixin",
|
28424
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28517
28425
|
}
|
28518
28426
|
},
|
28519
28427
|
{
|
28520
28428
|
"kind": "method",
|
28521
|
-
"name": "
|
28522
|
-
"privacy": "protected",
|
28523
|
-
"description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
28429
|
+
"name": "checkValidity",
|
28524
28430
|
"return": {
|
28525
28431
|
"type": {
|
28526
|
-
"text": ""
|
28432
|
+
"text": "boolean"
|
28527
28433
|
}
|
28528
28434
|
},
|
28529
28435
|
"inheritedFrom": {
|
28530
|
-
"name": "
|
28531
|
-
"module": "
|
28436
|
+
"name": "FormInternalsMixin",
|
28437
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28532
28438
|
}
|
28533
28439
|
},
|
28534
28440
|
{
|
28535
28441
|
"kind": "method",
|
28536
|
-
"name": "
|
28537
|
-
"privacy": "protected",
|
28538
|
-
"description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
28539
|
-
"return": {
|
28540
|
-
"type": {
|
28541
|
-
"text": ""
|
28542
|
-
}
|
28543
|
-
},
|
28442
|
+
"name": "reportValidity",
|
28544
28443
|
"inheritedFrom": {
|
28545
|
-
"name": "
|
28546
|
-
"module": "
|
28444
|
+
"name": "FormInternalsMixin",
|
28445
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
28547
28446
|
}
|
28548
28447
|
},
|
28549
28448
|
{
|
@@ -28700,6 +28599,30 @@
|
|
28700
28599
|
"module": "components/listitem/listitem.component.js"
|
28701
28600
|
}
|
28702
28601
|
},
|
28602
|
+
{
|
28603
|
+
"kind": "method",
|
28604
|
+
"name": "handleKeyDown",
|
28605
|
+
"privacy": "protected",
|
28606
|
+
"return": {
|
28607
|
+
"type": {
|
28608
|
+
"text": "void"
|
28609
|
+
}
|
28610
|
+
},
|
28611
|
+
"parameters": [
|
28612
|
+
{
|
28613
|
+
"name": "event",
|
28614
|
+
"type": {
|
28615
|
+
"text": "KeyboardEvent"
|
28616
|
+
},
|
28617
|
+
"description": "The keyboard event triggered when a key is pressed down."
|
28618
|
+
}
|
28619
|
+
],
|
28620
|
+
"description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction.",
|
28621
|
+
"inheritedFrom": {
|
28622
|
+
"name": "ListItem",
|
28623
|
+
"module": "components/listitem/listitem.component.js"
|
28624
|
+
}
|
28625
|
+
},
|
28703
28626
|
{
|
28704
28627
|
"kind": "method",
|
28705
28628
|
"name": "triggerClickEvent",
|
@@ -28788,6 +28711,36 @@
|
|
28788
28711
|
"module": "components/listitem/listitem.component.js"
|
28789
28712
|
}
|
28790
28713
|
},
|
28714
|
+
{
|
28715
|
+
"kind": "method",
|
28716
|
+
"name": "renderTrailingControls",
|
28717
|
+
"privacy": "protected",
|
28718
|
+
"description": "Renders the trailing controls slot.",
|
28719
|
+
"return": {
|
28720
|
+
"type": {
|
28721
|
+
"text": ""
|
28722
|
+
}
|
28723
|
+
},
|
28724
|
+
"inheritedFrom": {
|
28725
|
+
"name": "ListItem",
|
28726
|
+
"module": "components/listitem/listitem.component.js"
|
28727
|
+
}
|
28728
|
+
},
|
28729
|
+
{
|
28730
|
+
"kind": "method",
|
28731
|
+
"name": "renderLeadingControls",
|
28732
|
+
"privacy": "protected",
|
28733
|
+
"description": "Renders the leading controls slot.",
|
28734
|
+
"return": {
|
28735
|
+
"type": {
|
28736
|
+
"text": ""
|
28737
|
+
}
|
28738
|
+
},
|
28739
|
+
"inheritedFrom": {
|
28740
|
+
"name": "ListItem",
|
28741
|
+
"module": "components/listitem/listitem.component.js"
|
28742
|
+
}
|
28743
|
+
},
|
28791
28744
|
{
|
28792
28745
|
"kind": "method",
|
28793
28746
|
"name": "stopEventPropagation",
|
@@ -28815,7 +28768,7 @@
|
|
28815
28768
|
],
|
28816
28769
|
"events": [
|
28817
28770
|
{
|
28818
|
-
"description": "(React: onClick) This event is dispatched when the
|
28771
|
+
"description": "(React: onClick) This event is dispatched when the option is clicked.",
|
28819
28772
|
"name": "click",
|
28820
28773
|
"reactName": "onClick",
|
28821
28774
|
"inheritedFrom": {
|
@@ -28824,7 +28777,7 @@
|
|
28824
28777
|
}
|
28825
28778
|
},
|
28826
28779
|
{
|
28827
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the
|
28780
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
|
28828
28781
|
"name": "keydown",
|
28829
28782
|
"reactName": "onKeyDown",
|
28830
28783
|
"inheritedFrom": {
|
@@ -28833,7 +28786,7 @@
|
|
28833
28786
|
}
|
28834
28787
|
},
|
28835
28788
|
{
|
28836
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the
|
28789
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
|
28837
28790
|
"name": "keyup",
|
28838
28791
|
"reactName": "onKeyUp",
|
28839
28792
|
"inheritedFrom": {
|
@@ -28842,7 +28795,7 @@
|
|
28842
28795
|
}
|
28843
28796
|
},
|
28844
28797
|
{
|
28845
|
-
"description": "(React: onFocus) This event is dispatched when the
|
28798
|
+
"description": "(React: onFocus) This event is dispatched when the option receives focus.",
|
28846
28799
|
"name": "focus",
|
28847
28800
|
"reactName": "onFocus",
|
28848
28801
|
"inheritedFrom": {
|
@@ -28851,12 +28804,7 @@
|
|
28851
28804
|
}
|
28852
28805
|
},
|
28853
28806
|
{
|
28854
|
-
"description": "(React:
|
28855
|
-
"name": "activechange",
|
28856
|
-
"reactName": "onActiveChange"
|
28857
|
-
},
|
28858
|
-
{
|
28859
|
-
"description": "(React: onEnabled) This event is dispatched after the menuitem is enabled",
|
28807
|
+
"description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
|
28860
28808
|
"name": "enabled",
|
28861
28809
|
"reactName": "onEnabled",
|
28862
28810
|
"inheritedFrom": {
|
@@ -28865,7 +28813,7 @@
|
|
28865
28813
|
}
|
28866
28814
|
},
|
28867
28815
|
{
|
28868
|
-
"description": "(React: onDisabled) This event is dispatched after the
|
28816
|
+
"description": "(React: onDisabled) This event is dispatched after the listitem is disabled",
|
28869
28817
|
"name": "disabled",
|
28870
28818
|
"reactName": "onDisabled",
|
28871
28819
|
"inheritedFrom": {
|
@@ -28874,7 +28822,7 @@
|
|
28874
28822
|
}
|
28875
28823
|
},
|
28876
28824
|
{
|
28877
|
-
"description": "(React: onCreated) This event is dispatched after the
|
28825
|
+
"description": "(React: onCreated) This event is dispatched after the listitem is created (added to the DOM)",
|
28878
28826
|
"name": "created",
|
28879
28827
|
"reactName": "onCreated",
|
28880
28828
|
"inheritedFrom": {
|
@@ -28883,7 +28831,7 @@
|
|
28883
28831
|
}
|
28884
28832
|
},
|
28885
28833
|
{
|
28886
|
-
"description": "(React: onDestroyed) This event is dispatched after the
|
28834
|
+
"description": "(React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)",
|
28887
28835
|
"name": "destroyed",
|
28888
28836
|
"reactName": "onDestroyed",
|
28889
28837
|
"inheritedFrom": {
|
@@ -28894,47 +28842,21 @@
|
|
28894
28842
|
],
|
28895
28843
|
"attributes": [
|
28896
28844
|
{
|
28897
|
-
"name": "
|
28898
|
-
"type": {
|
28899
|
-
"text": "boolean | undefined"
|
28900
|
-
},
|
28901
|
-
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
|
28902
|
-
"default": "undefined",
|
28903
|
-
"fieldName": "active"
|
28904
|
-
},
|
28905
|
-
{
|
28906
|
-
"name": "badge-type",
|
28907
|
-
"type": {
|
28908
|
-
"text": "BadgeType | undefined"
|
28909
|
-
},
|
28910
|
-
"description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
|
28911
|
-
"fieldName": "badgeType"
|
28912
|
-
},
|
28913
|
-
{
|
28914
|
-
"name": "counter",
|
28915
|
-
"type": {
|
28916
|
-
"text": "number | undefined"
|
28917
|
-
},
|
28918
|
-
"description": "Counter is the number which can be provided in the badge.",
|
28919
|
-
"fieldName": "counter"
|
28920
|
-
},
|
28921
|
-
{
|
28922
|
-
"name": "max-counter",
|
28845
|
+
"name": "selected",
|
28923
28846
|
"type": {
|
28924
|
-
"text": "
|
28847
|
+
"text": "boolean"
|
28925
28848
|
},
|
28926
|
-
"
|
28927
|
-
"
|
28928
|
-
"fieldName": "
|
28849
|
+
"default": "false",
|
28850
|
+
"description": "The selected attribute is used to indicate that the option is selected.",
|
28851
|
+
"fieldName": "selected"
|
28929
28852
|
},
|
28930
28853
|
{
|
28931
|
-
"name": "
|
28854
|
+
"name": "prefix-icon",
|
28932
28855
|
"type": {
|
28933
|
-
"text": "
|
28856
|
+
"text": "IconNames | undefined"
|
28934
28857
|
},
|
28935
|
-
"description": "
|
28936
|
-
"
|
28937
|
-
"fieldName": "navId"
|
28858
|
+
"description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
|
28859
|
+
"fieldName": "prefixIcon"
|
28938
28860
|
},
|
28939
28861
|
{
|
28940
28862
|
"name": "aria-label",
|
@@ -28942,83 +28864,45 @@
|
|
28942
28864
|
"text": "string | null"
|
28943
28865
|
},
|
28944
28866
|
"default": "null",
|
28945
|
-
"description": "
|
28867
|
+
"description": "Any additional description can be provided here for screen readers.",
|
28946
28868
|
"fieldName": "ariaLabel"
|
28947
28869
|
},
|
28948
28870
|
{
|
28949
|
-
"name": "
|
28950
|
-
"type": {
|
28951
|
-
"text": "boolean | undefined"
|
28952
|
-
},
|
28953
|
-
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
|
28954
|
-
"fieldName": "disableAriaCurrent"
|
28955
|
-
},
|
28956
|
-
{
|
28957
|
-
"name": "tooltip-text",
|
28958
|
-
"type": {
|
28959
|
-
"text": "string | undefined"
|
28960
|
-
},
|
28961
|
-
"description": "The tooltip text is displayed on hover of the list item.",
|
28962
|
-
"fieldName": "tooltipText"
|
28963
|
-
},
|
28964
|
-
{
|
28965
|
-
"name": "icon-name",
|
28966
|
-
"type": {
|
28967
|
-
"text": "IconNames | undefined"
|
28968
|
-
},
|
28969
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
28970
|
-
"fieldName": "iconName",
|
28971
|
-
"inheritedFrom": {
|
28972
|
-
"name": "IconNameMixin",
|
28973
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
28974
|
-
}
|
28975
|
-
},
|
28976
|
-
{
|
28977
|
-
"name": "arrow-position",
|
28978
|
-
"type": {
|
28979
|
-
"text": "ArrowPositions | undefined"
|
28980
|
-
},
|
28981
|
-
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
28982
|
-
"fieldName": "arrowPosition",
|
28983
|
-
"inheritedFrom": {
|
28984
|
-
"name": "MenuItem",
|
28985
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
28986
|
-
}
|
28987
|
-
},
|
28988
|
-
{
|
28989
|
-
"name": "arrow-direction",
|
28871
|
+
"name": "name",
|
28990
28872
|
"type": {
|
28991
|
-
"text": "
|
28873
|
+
"text": "string"
|
28992
28874
|
},
|
28993
|
-
"
|
28994
|
-
"
|
28875
|
+
"default": "''",
|
28876
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
28877
|
+
"fieldName": "name",
|
28995
28878
|
"inheritedFrom": {
|
28996
|
-
"name": "
|
28997
|
-
"module": "src/
|
28879
|
+
"name": "FormInternalsMixin",
|
28880
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
28998
28881
|
}
|
28999
28882
|
},
|
29000
28883
|
{
|
29001
|
-
"name": "
|
28884
|
+
"name": "value",
|
29002
28885
|
"type": {
|
29003
|
-
"text": "string
|
29004
|
-
},
|
29005
|
-
"
|
29006
|
-
"
|
28886
|
+
"text": "string"
|
28887
|
+
},
|
28888
|
+
"default": "''",
|
28889
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
28890
|
+
"fieldName": "value",
|
29007
28891
|
"inheritedFrom": {
|
29008
|
-
"name": "
|
29009
|
-
"module": "src/
|
28892
|
+
"name": "FormInternalsMixin",
|
28893
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
29010
28894
|
}
|
29011
28895
|
},
|
29012
28896
|
{
|
29013
|
-
"name": "
|
28897
|
+
"name": "validation-message",
|
29014
28898
|
"type": {
|
29015
28899
|
"text": "string | undefined"
|
29016
28900
|
},
|
29017
|
-
"description": "
|
29018
|
-
"fieldName": "
|
28901
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
28902
|
+
"fieldName": "validationMessage",
|
29019
28903
|
"inheritedFrom": {
|
29020
|
-
"name": "
|
29021
|
-
"module": "src/
|
28904
|
+
"name": "FormInternalsMixin",
|
28905
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
29022
28906
|
}
|
29023
28907
|
},
|
29024
28908
|
{
|
@@ -29136,20 +29020,20 @@
|
|
29136
29020
|
],
|
29137
29021
|
"mixins": [
|
29138
29022
|
{
|
29139
|
-
"name": "
|
29140
|
-
"module": "/src/utils/mixins/
|
29023
|
+
"name": "FormInternalsMixin",
|
29024
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
29141
29025
|
}
|
29142
29026
|
],
|
29143
29027
|
"superclass": {
|
29144
|
-
"name": "
|
29145
|
-
"module": "/src/components/
|
29028
|
+
"name": "ListItem",
|
29029
|
+
"module": "/src/components/listitem/listitem.component"
|
29146
29030
|
},
|
29147
|
-
"tagName": "mdc-
|
29148
|
-
"jsDoc": "/**\n *
|
29031
|
+
"tagName": "mdc-option",
|
29032
|
+
"jsDoc": "/**\n * Option component, which is used within Selectlistbox within Select component.\n *\n * The label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\n * The `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n *\n * The `selected` property is used to indicate whether the option is selected or not.\n * When the `selected` property is set to true, a checkmark icon will be displayed\n * on the right side of the option to indicate that it is selected.\n *\n * The `prefixIcon` property can be used to display an icon on the left side of the option label.\n *\n * **Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\n * Consumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-option\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n *\n * @cssproperty --mdc-listitem-column-gap - gap between columns in the option\n * @cssproperty --mdc-option-icon-width - width of the icon in the option\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
|
29149
29033
|
"customElement": true,
|
29150
29034
|
"slots": [
|
29151
29035
|
{
|
29152
|
-
"description": "slot for
|
29036
|
+
"description": "slot for list item controls to appear of leading end.",
|
29153
29037
|
"name": "leading-controls",
|
29154
29038
|
"inheritedFrom": {
|
29155
29039
|
"name": "ListItem",
|
@@ -29157,7 +29041,7 @@
|
|
29157
29041
|
}
|
29158
29042
|
},
|
29159
29043
|
{
|
29160
|
-
"description": "slot for
|
29044
|
+
"description": "slot for list item primary label.",
|
29161
29045
|
"name": "leading-text-primary-label",
|
29162
29046
|
"inheritedFrom": {
|
29163
29047
|
"name": "ListItem",
|
@@ -29165,7 +29049,7 @@
|
|
29165
29049
|
}
|
29166
29050
|
},
|
29167
29051
|
{
|
29168
|
-
"description": "slot for
|
29052
|
+
"description": "slot for list item secondary label.",
|
29169
29053
|
"name": "leading-text-secondary-label",
|
29170
29054
|
"inheritedFrom": {
|
29171
29055
|
"name": "ListItem",
|
@@ -29173,7 +29057,7 @@
|
|
29173
29057
|
}
|
29174
29058
|
},
|
29175
29059
|
{
|
29176
|
-
"description": "slot for
|
29060
|
+
"description": "slot for list item tertiary label.",
|
29177
29061
|
"name": "leading-text-tertiary-label",
|
29178
29062
|
"inheritedFrom": {
|
29179
29063
|
"name": "ListItem",
|
@@ -29181,7 +29065,7 @@
|
|
29181
29065
|
}
|
29182
29066
|
},
|
29183
29067
|
{
|
29184
|
-
"description": "slot for
|
29068
|
+
"description": "slot for list item side header text.",
|
29185
29069
|
"name": "trailing-text-side-header",
|
29186
29070
|
"inheritedFrom": {
|
29187
29071
|
"name": "ListItem",
|
@@ -29189,7 +29073,7 @@
|
|
29189
29073
|
}
|
29190
29074
|
},
|
29191
29075
|
{
|
29192
|
-
"description": "slot for
|
29076
|
+
"description": "slot for list item subline text.",
|
29193
29077
|
"name": "trailing-text-subline",
|
29194
29078
|
"inheritedFrom": {
|
29195
29079
|
"name": "ListItem",
|
@@ -29197,7 +29081,7 @@
|
|
29197
29081
|
}
|
29198
29082
|
},
|
29199
29083
|
{
|
29200
|
-
"description": "slot for
|
29084
|
+
"description": "slot for list item controls to appear of trailing end.",
|
29201
29085
|
"name": "trailing-controls",
|
29202
29086
|
"inheritedFrom": {
|
29203
29087
|
"name": "ListItem",
|
@@ -29220,176 +29104,64 @@
|
|
29220
29104
|
"kind": "js",
|
29221
29105
|
"name": "default",
|
29222
29106
|
"declaration": {
|
29223
|
-
"name": "
|
29224
|
-
"module": "components/
|
29107
|
+
"name": "Option",
|
29108
|
+
"module": "components/option/option.component.js"
|
29225
29109
|
}
|
29226
29110
|
}
|
29227
29111
|
]
|
29228
29112
|
},
|
29229
29113
|
{
|
29230
29114
|
"kind": "javascript-module",
|
29231
|
-
"path": "components/
|
29115
|
+
"path": "components/navmenuitem/navmenuitem.component.js",
|
29232
29116
|
"declarations": [
|
29233
29117
|
{
|
29234
29118
|
"kind": "class",
|
29235
|
-
"description": "
|
29236
|
-
"name": "
|
29119
|
+
"description": "`mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\nIt supports a leading icon, optional badge and dynamic text rendering.\n\nNote: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\ncomponent. Its structure, spacing, and interactions are designed to align with\nthe visual and functional requirements of side navigation layouts.\n\nBy providing the tooltip-text attribute, a tooltip will be displayed on hover of the navmenuitem. This tooltip is useful when an active navmenuitem is present within a submenu of the sidenavigation component.",
|
29120
|
+
"name": "NavMenuItem",
|
29237
29121
|
"cssProperties": [
|
29238
29122
|
{
|
29239
|
-
"description": "
|
29240
|
-
"name": "--mdc-
|
29241
|
-
}
|
29242
|
-
],
|
29243
|
-
"cssParts": [
|
29244
|
-
{
|
29245
|
-
"description": "The header text of the optgroup.",
|
29246
|
-
"name": "header-text"
|
29247
|
-
}
|
29248
|
-
],
|
29249
|
-
"slots": [
|
29250
|
-
{
|
29251
|
-
"description": "This is a default slot for mdc-option elements.",
|
29252
|
-
"name": "default"
|
29253
|
-
}
|
29254
|
-
],
|
29255
|
-
"members": [
|
29256
|
-
{
|
29257
|
-
"kind": "field",
|
29258
|
-
"name": "label",
|
29259
|
-
"type": {
|
29260
|
-
"text": "string | undefined"
|
29261
|
-
},
|
29262
|
-
"description": "The header text to be displayed on the top of the options list.",
|
29263
|
-
"attribute": "label",
|
29264
|
-
"reflects": true
|
29123
|
+
"description": "Text color of the navmenuitem in its normal state.",
|
29124
|
+
"name": "--mdc-navmenuitem-color"
|
29265
29125
|
},
|
29266
29126
|
{
|
29267
|
-
"
|
29268
|
-
"name": "
|
29269
|
-
"privacy": "private",
|
29270
|
-
"return": {
|
29271
|
-
"type": {
|
29272
|
-
"text": "void"
|
29273
|
-
}
|
29274
|
-
}
|
29127
|
+
"description": "Border color of the navmenuitem in its normal state.",
|
29128
|
+
"name": "--mdc-navmenuitem-border-color"
|
29275
29129
|
},
|
29276
29130
|
{
|
29277
|
-
"
|
29278
|
-
"name": "
|
29279
|
-
"type": {
|
29280
|
-
"text": "string | null"
|
29281
|
-
},
|
29282
|
-
"default": "null",
|
29283
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
29284
|
-
"attribute": "data-aria-label",
|
29285
|
-
"reflects": true,
|
29286
|
-
"inheritedFrom": {
|
29287
|
-
"name": "DataAriaLabelMixin",
|
29288
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
29289
|
-
}
|
29131
|
+
"description": "Text color of the navmenuitem when disabled.",
|
29132
|
+
"name": "--mdc-navmenuitem-disabled-color"
|
29290
29133
|
},
|
29291
29134
|
{
|
29292
|
-
"
|
29293
|
-
"name": "
|
29294
|
-
|
29295
|
-
"text": "boolean | undefined"
|
29296
|
-
},
|
29297
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
29298
|
-
"default": "undefined",
|
29299
|
-
"attribute": "disabled",
|
29300
|
-
"reflects": true,
|
29301
|
-
"inheritedFrom": {
|
29302
|
-
"name": "DisabledMixin",
|
29303
|
-
"module": "utils/mixins/DisabledMixin.js"
|
29304
|
-
}
|
29305
|
-
}
|
29306
|
-
],
|
29307
|
-
"attributes": [
|
29135
|
+
"description": "Width of the navmenuitem when expanded.",
|
29136
|
+
"name": "--mdc-navmenuitem-expanded-width"
|
29137
|
+
},
|
29308
29138
|
{
|
29309
|
-
"
|
29310
|
-
"
|
29311
|
-
"text": "string | undefined"
|
29312
|
-
},
|
29313
|
-
"description": "The header text to be displayed on the top of the options list.",
|
29314
|
-
"fieldName": "label"
|
29139
|
+
"description": "Background color of the navmenuitem when hovered.",
|
29140
|
+
"name": "--mdc-navmenuitem-hover-background-color"
|
29315
29141
|
},
|
29316
29142
|
{
|
29317
|
-
"
|
29318
|
-
"
|
29319
|
-
"text": "string | null"
|
29320
|
-
},
|
29321
|
-
"default": "null",
|
29322
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
29323
|
-
"fieldName": "dataAriaLabel",
|
29324
|
-
"inheritedFrom": {
|
29325
|
-
"name": "DataAriaLabelMixin",
|
29326
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
29327
|
-
}
|
29143
|
+
"description": "Background color of the active navmenuitem when hovered.",
|
29144
|
+
"name": "--mdc-navmenuitem-hover-active-background-color"
|
29328
29145
|
},
|
29329
29146
|
{
|
29330
|
-
"
|
29331
|
-
"
|
29332
|
-
|
29333
|
-
},
|
29334
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
29335
|
-
"default": "undefined",
|
29336
|
-
"fieldName": "disabled",
|
29337
|
-
"inheritedFrom": {
|
29338
|
-
"name": "DisabledMixin",
|
29339
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
29340
|
-
}
|
29341
|
-
}
|
29342
|
-
],
|
29343
|
-
"mixins": [
|
29147
|
+
"description": "Background color of the navmenuitem when pressed.",
|
29148
|
+
"name": "--mdc-navmenuitem-pressed-background-color"
|
29149
|
+
},
|
29344
29150
|
{
|
29345
|
-
"
|
29346
|
-
"
|
29151
|
+
"description": "Background color of the active navmenuitem when pressed.",
|
29152
|
+
"name": "--mdc-navmenuitem-pressed-active-background-color"
|
29347
29153
|
},
|
29348
29154
|
{
|
29349
|
-
"
|
29350
|
-
"
|
29351
|
-
}
|
29352
|
-
],
|
29353
|
-
"superclass": {
|
29354
|
-
"name": "Component",
|
29355
|
-
"module": "/src/models"
|
29356
|
-
},
|
29357
|
-
"tagName": "mdc-optgroup",
|
29358
|
-
"jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n *\n * @csspart header-text - The header text of the optgroup.\n */",
|
29359
|
-
"customElement": true
|
29360
|
-
}
|
29361
|
-
],
|
29362
|
-
"exports": [
|
29363
|
-
{
|
29364
|
-
"kind": "js",
|
29365
|
-
"name": "default",
|
29366
|
-
"declaration": {
|
29367
|
-
"name": "OptGroup",
|
29368
|
-
"module": "components/optgroup/optgroup.component.js"
|
29369
|
-
}
|
29370
|
-
}
|
29371
|
-
]
|
29372
|
-
},
|
29373
|
-
{
|
29374
|
-
"kind": "javascript-module",
|
29375
|
-
"path": "components/option/option.component.js",
|
29376
|
-
"declarations": [
|
29377
|
-
{
|
29378
|
-
"kind": "class",
|
29379
|
-
"description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\n\n**Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\nConsumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.",
|
29380
|
-
"name": "Option",
|
29381
|
-
"cssProperties": [
|
29155
|
+
"description": "Background color of the navmenuitem when disabled.",
|
29156
|
+
"name": "--mdc-navmenuitem-disabled-background-color"
|
29157
|
+
},
|
29382
29158
|
{
|
29383
|
-
"description": "
|
29384
|
-
"name": "--mdc-
|
29385
|
-
"inheritedFrom": {
|
29386
|
-
"name": "ListItem",
|
29387
|
-
"module": "src/components/listitem/listitem.component.ts"
|
29388
|
-
}
|
29159
|
+
"description": "Background color of the active navmenuitem when disabled.",
|
29160
|
+
"name": "--mdc-navmenuitem-disabled-active-background-color"
|
29389
29161
|
},
|
29390
29162
|
{
|
29391
|
-
"description": "
|
29392
|
-
"name": "--mdc-
|
29163
|
+
"description": "Background color of the active nav item in its rest state.",
|
29164
|
+
"name": "--mdc-navmenuitem-rest-active-background-color"
|
29393
29165
|
},
|
29394
29166
|
{
|
29395
29167
|
"description": "Allows customization of the default background color.",
|
@@ -29439,6 +29211,14 @@
|
|
29439
29211
|
"module": "src/components/listitem/listitem.component.ts"
|
29440
29212
|
}
|
29441
29213
|
},
|
29214
|
+
{
|
29215
|
+
"description": "Allows customization of column gap.",
|
29216
|
+
"name": "--mdc-listitem-column-gap",
|
29217
|
+
"inheritedFrom": {
|
29218
|
+
"name": "ListItem",
|
29219
|
+
"module": "src/components/listitem/listitem.component.ts"
|
29220
|
+
}
|
29221
|
+
},
|
29442
29222
|
{
|
29443
29223
|
"description": "Allows customization of padding left and right.",
|
29444
29224
|
"name": "--mdc-listitem-padding-left-right",
|
@@ -29481,6 +29261,30 @@
|
|
29481
29261
|
}
|
29482
29262
|
],
|
29483
29263
|
"cssParts": [
|
29264
|
+
{
|
29265
|
+
"description": "The arrow of the navmenuitem.",
|
29266
|
+
"name": "arrow"
|
29267
|
+
},
|
29268
|
+
{
|
29269
|
+
"description": "The badge of the navmenuitem.",
|
29270
|
+
"name": "badge"
|
29271
|
+
},
|
29272
|
+
{
|
29273
|
+
"description": "The container of the icon.",
|
29274
|
+
"name": "icon-container"
|
29275
|
+
},
|
29276
|
+
{
|
29277
|
+
"description": "The container of the text.",
|
29278
|
+
"name": "text-container"
|
29279
|
+
},
|
29280
|
+
{
|
29281
|
+
"description": "The trailing arrow of the navmenuitem.",
|
29282
|
+
"name": "trailing-arrow",
|
29283
|
+
"inheritedFrom": {
|
29284
|
+
"name": "MenuItem",
|
29285
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
29286
|
+
}
|
29287
|
+
},
|
29484
29288
|
{
|
29485
29289
|
"description": "Allows customization of the leading part.",
|
29486
29290
|
"name": "leading",
|
@@ -29489,6 +29293,14 @@
|
|
29489
29293
|
"module": "src/components/listitem/listitem.component.ts"
|
29490
29294
|
}
|
29491
29295
|
},
|
29296
|
+
{
|
29297
|
+
"description": "Allows customization of leading arrow icon.",
|
29298
|
+
"name": "leading-arrow",
|
29299
|
+
"inheritedFrom": {
|
29300
|
+
"name": "MenuItem",
|
29301
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
29302
|
+
}
|
29303
|
+
},
|
29492
29304
|
{
|
29493
29305
|
"description": "Allows customization of the leading text part.",
|
29494
29306
|
"name": "leading-text",
|
@@ -29517,23 +29329,55 @@
|
|
29517
29329
|
"members": [
|
29518
29330
|
{
|
29519
29331
|
"kind": "field",
|
29520
|
-
"name": "
|
29332
|
+
"name": "active",
|
29521
29333
|
"type": {
|
29522
|
-
"text": "boolean"
|
29334
|
+
"text": "boolean | undefined"
|
29523
29335
|
},
|
29524
|
-
"
|
29525
|
-
"
|
29526
|
-
"attribute": "
|
29336
|
+
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
|
29337
|
+
"default": "undefined",
|
29338
|
+
"attribute": "active",
|
29527
29339
|
"reflects": true
|
29528
29340
|
},
|
29529
29341
|
{
|
29530
29342
|
"kind": "field",
|
29531
|
-
"name": "
|
29343
|
+
"name": "badgeType",
|
29532
29344
|
"type": {
|
29533
|
-
"text": "
|
29345
|
+
"text": "BadgeType | undefined"
|
29534
29346
|
},
|
29535
|
-
"description": "
|
29536
|
-
"attribute": "
|
29347
|
+
"description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
|
29348
|
+
"attribute": "badge-type",
|
29349
|
+
"reflects": true
|
29350
|
+
},
|
29351
|
+
{
|
29352
|
+
"kind": "field",
|
29353
|
+
"name": "counter",
|
29354
|
+
"type": {
|
29355
|
+
"text": "number | undefined"
|
29356
|
+
},
|
29357
|
+
"description": "Counter is the number which can be provided in the badge.",
|
29358
|
+
"attribute": "counter",
|
29359
|
+
"reflects": true
|
29360
|
+
},
|
29361
|
+
{
|
29362
|
+
"kind": "field",
|
29363
|
+
"name": "maxCounter",
|
29364
|
+
"type": {
|
29365
|
+
"text": "number"
|
29366
|
+
},
|
29367
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
29368
|
+
"default": "99",
|
29369
|
+
"attribute": "max-counter",
|
29370
|
+
"reflects": true
|
29371
|
+
},
|
29372
|
+
{
|
29373
|
+
"kind": "field",
|
29374
|
+
"name": "navId",
|
29375
|
+
"type": {
|
29376
|
+
"text": "string | undefined"
|
29377
|
+
},
|
29378
|
+
"description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
|
29379
|
+
"default": "undefined",
|
29380
|
+
"attribute": "nav-id",
|
29537
29381
|
"reflects": true
|
29538
29382
|
},
|
29539
29383
|
{
|
@@ -29543,108 +29387,249 @@
|
|
29543
29387
|
"text": "string | null"
|
29544
29388
|
},
|
29545
29389
|
"default": "null",
|
29546
|
-
"description": "
|
29547
|
-
"attribute": "aria-label"
|
29390
|
+
"description": "Aria-label attribute to be set for accessibility",
|
29391
|
+
"attribute": "aria-label"
|
29392
|
+
},
|
29393
|
+
{
|
29394
|
+
"kind": "field",
|
29395
|
+
"name": "disableAriaCurrent",
|
29396
|
+
"type": {
|
29397
|
+
"text": "boolean | undefined"
|
29398
|
+
},
|
29399
|
+
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
|
29400
|
+
"attribute": "disable-aria-current",
|
29548
29401
|
"reflects": true
|
29549
29402
|
},
|
29550
29403
|
{
|
29551
29404
|
"kind": "field",
|
29552
|
-
"name": "
|
29405
|
+
"name": "tooltipText",
|
29553
29406
|
"type": {
|
29554
|
-
"text": "string"
|
29407
|
+
"text": "string | undefined"
|
29555
29408
|
},
|
29556
|
-
"
|
29557
|
-
"
|
29558
|
-
"
|
29409
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
29410
|
+
"attribute": "tooltip-text",
|
29411
|
+
"reflects": true
|
29412
|
+
},
|
29413
|
+
{
|
29414
|
+
"kind": "method",
|
29415
|
+
"name": "removeTooltip",
|
29416
|
+
"privacy": "private"
|
29417
|
+
},
|
29418
|
+
{
|
29419
|
+
"kind": "method",
|
29420
|
+
"name": "renderDynamicTooltip",
|
29421
|
+
"privacy": "private",
|
29422
|
+
"return": {
|
29423
|
+
"type": {
|
29424
|
+
"text": "void"
|
29425
|
+
}
|
29426
|
+
}
|
29427
|
+
},
|
29428
|
+
{
|
29429
|
+
"kind": "method",
|
29430
|
+
"name": "isNested",
|
29431
|
+
"privacy": "private",
|
29432
|
+
"return": {
|
29433
|
+
"type": {
|
29434
|
+
"text": "boolean"
|
29435
|
+
}
|
29436
|
+
},
|
29437
|
+
"description": "Check whether the navmenuitem is inside a nested nav structure.\nReturns `true` if there is a parent `mdc-menupopover`\nThis method assumes nesting implies deeper levels of nav hierarchy."
|
29438
|
+
},
|
29439
|
+
{
|
29440
|
+
"kind": "method",
|
29441
|
+
"name": "handleClickEvent",
|
29442
|
+
"privacy": "private",
|
29443
|
+
"return": {
|
29444
|
+
"type": {
|
29445
|
+
"text": "void"
|
29446
|
+
}
|
29447
|
+
}
|
29448
|
+
},
|
29449
|
+
{
|
29450
|
+
"kind": "method",
|
29451
|
+
"name": "renderTextLabel",
|
29452
|
+
"privacy": "private",
|
29453
|
+
"parameters": [
|
29454
|
+
{
|
29455
|
+
"name": "label",
|
29456
|
+
"type": {
|
29457
|
+
"text": "string | undefined"
|
29458
|
+
}
|
29459
|
+
}
|
29460
|
+
]
|
29461
|
+
},
|
29462
|
+
{
|
29463
|
+
"kind": "method",
|
29464
|
+
"name": "renderArrowIcon",
|
29465
|
+
"privacy": "private",
|
29466
|
+
"parameters": [
|
29467
|
+
{
|
29468
|
+
"name": "showLabel",
|
29469
|
+
"type": {
|
29470
|
+
"text": "boolean | undefined"
|
29471
|
+
}
|
29472
|
+
}
|
29473
|
+
]
|
29474
|
+
},
|
29475
|
+
{
|
29476
|
+
"kind": "method",
|
29477
|
+
"name": "renderBadge",
|
29478
|
+
"privacy": "private",
|
29479
|
+
"parameters": [
|
29480
|
+
{
|
29481
|
+
"name": "showLabel",
|
29482
|
+
"type": {
|
29483
|
+
"text": "boolean | undefined"
|
29484
|
+
}
|
29485
|
+
}
|
29486
|
+
]
|
29487
|
+
},
|
29488
|
+
{
|
29489
|
+
"kind": "field",
|
29490
|
+
"name": "iconName",
|
29491
|
+
"type": {
|
29492
|
+
"text": "IconNames | undefined"
|
29493
|
+
},
|
29494
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
29495
|
+
"attribute": "icon-name",
|
29496
|
+
"inheritedFrom": {
|
29497
|
+
"name": "IconNameMixin",
|
29498
|
+
"module": "utils/mixins/IconNameMixin.js"
|
29499
|
+
}
|
29500
|
+
},
|
29501
|
+
{
|
29502
|
+
"kind": "field",
|
29503
|
+
"name": "arrowPosition",
|
29504
|
+
"type": {
|
29505
|
+
"text": "ArrowPositions | undefined"
|
29506
|
+
},
|
29507
|
+
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
29508
|
+
"attribute": "arrow-position",
|
29559
29509
|
"reflects": true,
|
29560
29510
|
"inheritedFrom": {
|
29561
|
-
"name": "
|
29562
|
-
"module": "
|
29511
|
+
"name": "MenuItem",
|
29512
|
+
"module": "components/menuitem/menuitem.component.js"
|
29563
29513
|
}
|
29564
29514
|
},
|
29565
29515
|
{
|
29566
29516
|
"kind": "field",
|
29567
|
-
"name": "
|
29517
|
+
"name": "arrowDirection",
|
29568
29518
|
"type": {
|
29569
|
-
"text": "
|
29519
|
+
"text": "ArrowDirections | undefined"
|
29570
29520
|
},
|
29571
|
-
"
|
29572
|
-
"
|
29573
|
-
"attribute": "value",
|
29521
|
+
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
29522
|
+
"attribute": "arrow-direction",
|
29574
29523
|
"reflects": true,
|
29575
29524
|
"inheritedFrom": {
|
29576
|
-
"name": "
|
29577
|
-
"module": "
|
29525
|
+
"name": "MenuItem",
|
29526
|
+
"module": "components/menuitem/menuitem.component.js"
|
29578
29527
|
}
|
29579
29528
|
},
|
29580
29529
|
{
|
29581
29530
|
"kind": "field",
|
29582
|
-
"name": "
|
29531
|
+
"name": "name",
|
29583
29532
|
"type": {
|
29584
29533
|
"text": "string | undefined"
|
29585
29534
|
},
|
29586
|
-
"description": "
|
29587
|
-
"attribute": "
|
29535
|
+
"description": "The name attribute is used to identify the menu item when it is selected.",
|
29536
|
+
"attribute": "name",
|
29588
29537
|
"reflects": true,
|
29589
29538
|
"inheritedFrom": {
|
29590
|
-
"name": "
|
29591
|
-
"module": "
|
29539
|
+
"name": "MenuItem",
|
29540
|
+
"module": "components/menuitem/menuitem.component.js"
|
29592
29541
|
}
|
29593
29542
|
},
|
29594
29543
|
{
|
29595
29544
|
"kind": "field",
|
29596
|
-
"name": "
|
29545
|
+
"name": "value",
|
29597
29546
|
"type": {
|
29598
|
-
"text": "
|
29547
|
+
"text": "string | undefined"
|
29599
29548
|
},
|
29600
|
-
"
|
29549
|
+
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
29550
|
+
"attribute": "value",
|
29551
|
+
"reflects": true,
|
29601
29552
|
"inheritedFrom": {
|
29602
|
-
"name": "
|
29603
|
-
"module": "
|
29553
|
+
"name": "MenuItem",
|
29554
|
+
"module": "components/menuitem/menuitem.component.js"
|
29604
29555
|
}
|
29605
29556
|
},
|
29606
29557
|
{
|
29607
|
-
"kind": "
|
29608
|
-
"name": "
|
29609
|
-
"
|
29558
|
+
"kind": "method",
|
29559
|
+
"name": "handleKeyDown",
|
29560
|
+
"privacy": "protected",
|
29561
|
+
"return": {
|
29562
|
+
"type": {
|
29563
|
+
"text": "void"
|
29564
|
+
}
|
29565
|
+
},
|
29566
|
+
"parameters": [
|
29567
|
+
{
|
29568
|
+
"name": "event",
|
29569
|
+
"type": {
|
29570
|
+
"text": "KeyboardEvent"
|
29571
|
+
},
|
29572
|
+
"description": "The keyboard event that triggered the action."
|
29573
|
+
}
|
29574
|
+
],
|
29575
|
+
"description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
|
29610
29576
|
"inheritedFrom": {
|
29611
|
-
"name": "
|
29612
|
-
"module": "
|
29577
|
+
"name": "ListItem",
|
29578
|
+
"module": "components/listitem/listitem.component.js"
|
29579
|
+
}
|
29580
|
+
},
|
29581
|
+
{
|
29582
|
+
"kind": "method",
|
29583
|
+
"name": "handleKeyUp",
|
29584
|
+
"privacy": "private",
|
29585
|
+
"return": {
|
29586
|
+
"type": {
|
29587
|
+
"text": "void"
|
29588
|
+
}
|
29589
|
+
},
|
29590
|
+
"parameters": [
|
29591
|
+
{
|
29592
|
+
"name": "event",
|
29593
|
+
"type": {
|
29594
|
+
"text": "KeyboardEvent"
|
29595
|
+
},
|
29596
|
+
"description": "The keyboard event that triggered the action."
|
29597
|
+
}
|
29598
|
+
],
|
29599
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
29600
|
+
"inheritedFrom": {
|
29601
|
+
"name": "MenuItem",
|
29602
|
+
"module": "components/menuitem/menuitem.component.js"
|
29613
29603
|
}
|
29614
29604
|
},
|
29615
29605
|
{
|
29616
29606
|
"kind": "method",
|
29617
|
-
"name": "
|
29618
|
-
"
|
29607
|
+
"name": "renderTrailingControls",
|
29608
|
+
"privacy": "protected",
|
29609
|
+
"description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
29619
29610
|
"return": {
|
29620
29611
|
"type": {
|
29621
29612
|
"text": ""
|
29622
29613
|
}
|
29623
29614
|
},
|
29624
29615
|
"inheritedFrom": {
|
29625
|
-
"name": "
|
29626
|
-
"module": "
|
29616
|
+
"name": "ListItem",
|
29617
|
+
"module": "components/listitem/listitem.component.js"
|
29627
29618
|
}
|
29628
29619
|
},
|
29629
29620
|
{
|
29630
29621
|
"kind": "method",
|
29631
|
-
"name": "
|
29622
|
+
"name": "renderLeadingControls",
|
29623
|
+
"privacy": "protected",
|
29624
|
+
"description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
29632
29625
|
"return": {
|
29633
29626
|
"type": {
|
29634
|
-
"text": "
|
29627
|
+
"text": ""
|
29635
29628
|
}
|
29636
29629
|
},
|
29637
29630
|
"inheritedFrom": {
|
29638
|
-
"name": "
|
29639
|
-
"module": "
|
29640
|
-
}
|
29641
|
-
},
|
29642
|
-
{
|
29643
|
-
"kind": "method",
|
29644
|
-
"name": "reportValidity",
|
29645
|
-
"inheritedFrom": {
|
29646
|
-
"name": "FormInternalsMixin",
|
29647
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
29631
|
+
"name": "ListItem",
|
29632
|
+
"module": "components/listitem/listitem.component.js"
|
29648
29633
|
}
|
29649
29634
|
},
|
29650
29635
|
{
|
@@ -29801,30 +29786,6 @@
|
|
29801
29786
|
"module": "components/listitem/listitem.component.js"
|
29802
29787
|
}
|
29803
29788
|
},
|
29804
|
-
{
|
29805
|
-
"kind": "method",
|
29806
|
-
"name": "handleKeyDown",
|
29807
|
-
"privacy": "protected",
|
29808
|
-
"return": {
|
29809
|
-
"type": {
|
29810
|
-
"text": "void"
|
29811
|
-
}
|
29812
|
-
},
|
29813
|
-
"parameters": [
|
29814
|
-
{
|
29815
|
-
"name": "event",
|
29816
|
-
"type": {
|
29817
|
-
"text": "KeyboardEvent"
|
29818
|
-
},
|
29819
|
-
"description": "The keyboard event triggered when a key is pressed down."
|
29820
|
-
}
|
29821
|
-
],
|
29822
|
-
"description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction.",
|
29823
|
-
"inheritedFrom": {
|
29824
|
-
"name": "ListItem",
|
29825
|
-
"module": "components/listitem/listitem.component.js"
|
29826
|
-
}
|
29827
|
-
},
|
29828
29789
|
{
|
29829
29790
|
"kind": "method",
|
29830
29791
|
"name": "triggerClickEvent",
|
@@ -29913,36 +29874,6 @@
|
|
29913
29874
|
"module": "components/listitem/listitem.component.js"
|
29914
29875
|
}
|
29915
29876
|
},
|
29916
|
-
{
|
29917
|
-
"kind": "method",
|
29918
|
-
"name": "renderTrailingControls",
|
29919
|
-
"privacy": "protected",
|
29920
|
-
"description": "Renders the trailing controls slot.",
|
29921
|
-
"return": {
|
29922
|
-
"type": {
|
29923
|
-
"text": ""
|
29924
|
-
}
|
29925
|
-
},
|
29926
|
-
"inheritedFrom": {
|
29927
|
-
"name": "ListItem",
|
29928
|
-
"module": "components/listitem/listitem.component.js"
|
29929
|
-
}
|
29930
|
-
},
|
29931
|
-
{
|
29932
|
-
"kind": "method",
|
29933
|
-
"name": "renderLeadingControls",
|
29934
|
-
"privacy": "protected",
|
29935
|
-
"description": "Renders the leading controls slot.",
|
29936
|
-
"return": {
|
29937
|
-
"type": {
|
29938
|
-
"text": ""
|
29939
|
-
}
|
29940
|
-
},
|
29941
|
-
"inheritedFrom": {
|
29942
|
-
"name": "ListItem",
|
29943
|
-
"module": "components/listitem/listitem.component.js"
|
29944
|
-
}
|
29945
|
-
},
|
29946
29877
|
{
|
29947
29878
|
"kind": "method",
|
29948
29879
|
"name": "stopEventPropagation",
|
@@ -29970,7 +29901,7 @@
|
|
29970
29901
|
],
|
29971
29902
|
"events": [
|
29972
29903
|
{
|
29973
|
-
"description": "(React: onClick) This event is dispatched when the
|
29904
|
+
"description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
|
29974
29905
|
"name": "click",
|
29975
29906
|
"reactName": "onClick",
|
29976
29907
|
"inheritedFrom": {
|
@@ -29979,7 +29910,7 @@
|
|
29979
29910
|
}
|
29980
29911
|
},
|
29981
29912
|
{
|
29982
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the
|
29913
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
|
29983
29914
|
"name": "keydown",
|
29984
29915
|
"reactName": "onKeyDown",
|
29985
29916
|
"inheritedFrom": {
|
@@ -29988,7 +29919,7 @@
|
|
29988
29919
|
}
|
29989
29920
|
},
|
29990
29921
|
{
|
29991
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the
|
29922
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
|
29992
29923
|
"name": "keyup",
|
29993
29924
|
"reactName": "onKeyUp",
|
29994
29925
|
"inheritedFrom": {
|
@@ -29997,7 +29928,7 @@
|
|
29997
29928
|
}
|
29998
29929
|
},
|
29999
29930
|
{
|
30000
|
-
"description": "(React: onFocus) This event is dispatched when the
|
29931
|
+
"description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
|
30001
29932
|
"name": "focus",
|
30002
29933
|
"reactName": "onFocus",
|
30003
29934
|
"inheritedFrom": {
|
@@ -30006,7 +29937,12 @@
|
|
30006
29937
|
}
|
30007
29938
|
},
|
30008
29939
|
{
|
30009
|
-
"description": "(React:
|
29940
|
+
"description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
|
29941
|
+
"name": "activechange",
|
29942
|
+
"reactName": "onActiveChange"
|
29943
|
+
},
|
29944
|
+
{
|
29945
|
+
"description": "(React: onEnabled) This event is dispatched after the menuitem is enabled",
|
30010
29946
|
"name": "enabled",
|
30011
29947
|
"reactName": "onEnabled",
|
30012
29948
|
"inheritedFrom": {
|
@@ -30015,7 +29951,7 @@
|
|
30015
29951
|
}
|
30016
29952
|
},
|
30017
29953
|
{
|
30018
|
-
"description": "(React: onDisabled) This event is dispatched after the
|
29954
|
+
"description": "(React: onDisabled) This event is dispatched after the menuitem is disabled",
|
30019
29955
|
"name": "disabled",
|
30020
29956
|
"reactName": "onDisabled",
|
30021
29957
|
"inheritedFrom": {
|
@@ -30024,7 +29960,7 @@
|
|
30024
29960
|
}
|
30025
29961
|
},
|
30026
29962
|
{
|
30027
|
-
"description": "(React: onCreated) This event is dispatched after the
|
29963
|
+
"description": "(React: onCreated) This event is dispatched after the menuitem is created (added to the DOM)",
|
30028
29964
|
"name": "created",
|
30029
29965
|
"reactName": "onCreated",
|
30030
29966
|
"inheritedFrom": {
|
@@ -30033,7 +29969,7 @@
|
|
30033
29969
|
}
|
30034
29970
|
},
|
30035
29971
|
{
|
30036
|
-
"description": "(React: onDestroyed) This event is dispatched after the
|
29972
|
+
"description": "(React: onDestroyed) This event is dispatched after the menuitem is destroyed (removed from the DOM)",
|
30037
29973
|
"name": "destroyed",
|
30038
29974
|
"reactName": "onDestroyed",
|
30039
29975
|
"inheritedFrom": {
|
@@ -30044,21 +29980,47 @@
|
|
30044
29980
|
],
|
30045
29981
|
"attributes": [
|
30046
29982
|
{
|
30047
|
-
"name": "
|
29983
|
+
"name": "active",
|
30048
29984
|
"type": {
|
30049
|
-
"text": "boolean"
|
29985
|
+
"text": "boolean | undefined"
|
30050
29986
|
},
|
30051
|
-
"
|
30052
|
-
"
|
30053
|
-
"fieldName": "
|
29987
|
+
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
|
29988
|
+
"default": "undefined",
|
29989
|
+
"fieldName": "active"
|
30054
29990
|
},
|
30055
29991
|
{
|
30056
|
-
"name": "
|
29992
|
+
"name": "badge-type",
|
30057
29993
|
"type": {
|
30058
|
-
"text": "
|
29994
|
+
"text": "BadgeType | undefined"
|
30059
29995
|
},
|
30060
|
-
"description": "
|
30061
|
-
"fieldName": "
|
29996
|
+
"description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
|
29997
|
+
"fieldName": "badgeType"
|
29998
|
+
},
|
29999
|
+
{
|
30000
|
+
"name": "counter",
|
30001
|
+
"type": {
|
30002
|
+
"text": "number | undefined"
|
30003
|
+
},
|
30004
|
+
"description": "Counter is the number which can be provided in the badge.",
|
30005
|
+
"fieldName": "counter"
|
30006
|
+
},
|
30007
|
+
{
|
30008
|
+
"name": "max-counter",
|
30009
|
+
"type": {
|
30010
|
+
"text": "number"
|
30011
|
+
},
|
30012
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
30013
|
+
"default": "99",
|
30014
|
+
"fieldName": "maxCounter"
|
30015
|
+
},
|
30016
|
+
{
|
30017
|
+
"name": "nav-id",
|
30018
|
+
"type": {
|
30019
|
+
"text": "string | undefined"
|
30020
|
+
},
|
30021
|
+
"description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
|
30022
|
+
"default": "undefined",
|
30023
|
+
"fieldName": "navId"
|
30062
30024
|
},
|
30063
30025
|
{
|
30064
30026
|
"name": "aria-label",
|
@@ -30066,45 +30028,83 @@
|
|
30066
30028
|
"text": "string | null"
|
30067
30029
|
},
|
30068
30030
|
"default": "null",
|
30069
|
-
"description": "
|
30031
|
+
"description": "Aria-label attribute to be set for accessibility",
|
30070
30032
|
"fieldName": "ariaLabel"
|
30071
30033
|
},
|
30072
30034
|
{
|
30073
|
-
"name": "
|
30035
|
+
"name": "disable-aria-current",
|
30074
30036
|
"type": {
|
30075
|
-
"text": "
|
30037
|
+
"text": "boolean | undefined"
|
30076
30038
|
},
|
30077
|
-
"
|
30078
|
-
"
|
30079
|
-
|
30039
|
+
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
|
30040
|
+
"fieldName": "disableAriaCurrent"
|
30041
|
+
},
|
30042
|
+
{
|
30043
|
+
"name": "tooltip-text",
|
30044
|
+
"type": {
|
30045
|
+
"text": "string | undefined"
|
30046
|
+
},
|
30047
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
30048
|
+
"fieldName": "tooltipText"
|
30049
|
+
},
|
30050
|
+
{
|
30051
|
+
"name": "icon-name",
|
30052
|
+
"type": {
|
30053
|
+
"text": "IconNames | undefined"
|
30054
|
+
},
|
30055
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
30056
|
+
"fieldName": "iconName",
|
30080
30057
|
"inheritedFrom": {
|
30081
|
-
"name": "
|
30082
|
-
"module": "src/utils/mixins/
|
30058
|
+
"name": "IconNameMixin",
|
30059
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
30083
30060
|
}
|
30084
30061
|
},
|
30085
30062
|
{
|
30086
|
-
"name": "
|
30063
|
+
"name": "arrow-position",
|
30087
30064
|
"type": {
|
30088
|
-
"text": "
|
30065
|
+
"text": "ArrowPositions | undefined"
|
30089
30066
|
},
|
30090
|
-
"
|
30091
|
-
"
|
30092
|
-
"fieldName": "value",
|
30067
|
+
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
30068
|
+
"fieldName": "arrowPosition",
|
30093
30069
|
"inheritedFrom": {
|
30094
|
-
"name": "
|
30095
|
-
"module": "src/
|
30070
|
+
"name": "MenuItem",
|
30071
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
30096
30072
|
}
|
30097
30073
|
},
|
30098
30074
|
{
|
30099
|
-
"name": "
|
30075
|
+
"name": "arrow-direction",
|
30076
|
+
"type": {
|
30077
|
+
"text": "ArrowDirections | undefined"
|
30078
|
+
},
|
30079
|
+
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
30080
|
+
"fieldName": "arrowDirection",
|
30081
|
+
"inheritedFrom": {
|
30082
|
+
"name": "MenuItem",
|
30083
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
30084
|
+
}
|
30085
|
+
},
|
30086
|
+
{
|
30087
|
+
"name": "name",
|
30100
30088
|
"type": {
|
30101
30089
|
"text": "string | undefined"
|
30102
30090
|
},
|
30103
|
-
"description": "
|
30104
|
-
"fieldName": "
|
30091
|
+
"description": "The name attribute is used to identify the menu item when it is selected.",
|
30092
|
+
"fieldName": "name",
|
30105
30093
|
"inheritedFrom": {
|
30106
|
-
"name": "
|
30107
|
-
"module": "src/
|
30094
|
+
"name": "MenuItem",
|
30095
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
30096
|
+
}
|
30097
|
+
},
|
30098
|
+
{
|
30099
|
+
"name": "value",
|
30100
|
+
"type": {
|
30101
|
+
"text": "string | undefined"
|
30102
|
+
},
|
30103
|
+
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
30104
|
+
"fieldName": "value",
|
30105
|
+
"inheritedFrom": {
|
30106
|
+
"name": "MenuItem",
|
30107
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
30108
30108
|
}
|
30109
30109
|
},
|
30110
30110
|
{
|
@@ -30222,20 +30222,20 @@
|
|
30222
30222
|
],
|
30223
30223
|
"mixins": [
|
30224
30224
|
{
|
30225
|
-
"name": "
|
30226
|
-
"module": "/src/utils/mixins/
|
30225
|
+
"name": "IconNameMixin",
|
30226
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
30227
30227
|
}
|
30228
30228
|
],
|
30229
30229
|
"superclass": {
|
30230
|
-
"name": "
|
30231
|
-
"module": "/src/components/
|
30230
|
+
"name": "MenuItem",
|
30231
|
+
"module": "/src/components/menuitem/menuitem.component"
|
30232
30232
|
},
|
30233
|
-
"tagName": "mdc-
|
30234
|
-
"jsDoc": "/**\n *
|
30233
|
+
"tagName": "mdc-navmenuitem",
|
30234
|
+
"jsDoc": "/**\n * `mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\n * It supports a leading icon, optional badge and dynamic text rendering.\n *\n * Note: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\n * component. Its structure, spacing, and interactions are designed to align with\n * the visual and functional requirements of side navigation layouts.\n *\n * By providing the tooltip-text attribute, a tooltip will be displayed on hover of the navmenuitem. This tooltip is useful when an active navmenuitem is present within a submenu of the sidenavigation component.\n *\n * @tagname mdc-navmenuitem\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-badge\n * @dependency mdc-tooltip\n *\n * @event click - (React: onClick) This event is dispatched when the navmenuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.\n * @event focus - (React: onFocus) This event is dispatched when the navmenuitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @cssproperty --mdc-navmenuitem-color - Text color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-border-color - Border color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-disabled-color - Text color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-expanded-width - Width of the navmenuitem when expanded.\n * @cssproperty --mdc-navmenuitem-hover-background-color - Background color of the navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-hover-active-background-color - Background color of the active navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-pressed-background-color - Background color of the navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-pressed-active-background-color - Background color of the active navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-disabled-background-color - Background color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-disabled-active-background-color - Background color of the active navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-rest-active-background-color - Background color of the active nav item in its rest state.\n *\n * @csspart arrow - The arrow of the navmenuitem.\n * @csspart badge - The badge of the navmenuitem.\n * @csspart icon-container - The container of the icon.\n * @csspart text-container - The container of the text.\n * @csspart trailing-arrow - The trailing arrow of the navmenuitem.\n */",
|
30235
30235
|
"customElement": true,
|
30236
30236
|
"slots": [
|
30237
30237
|
{
|
30238
|
-
"description": "slot for
|
30238
|
+
"description": "slot for menu item controls to appear of leading end.",
|
30239
30239
|
"name": "leading-controls",
|
30240
30240
|
"inheritedFrom": {
|
30241
30241
|
"name": "ListItem",
|
@@ -30243,7 +30243,7 @@
|
|
30243
30243
|
}
|
30244
30244
|
},
|
30245
30245
|
{
|
30246
|
-
"description": "slot for
|
30246
|
+
"description": "slot for menu item primary label.",
|
30247
30247
|
"name": "leading-text-primary-label",
|
30248
30248
|
"inheritedFrom": {
|
30249
30249
|
"name": "ListItem",
|
@@ -30251,7 +30251,7 @@
|
|
30251
30251
|
}
|
30252
30252
|
},
|
30253
30253
|
{
|
30254
|
-
"description": "slot for
|
30254
|
+
"description": "slot for menu item secondary label.",
|
30255
30255
|
"name": "leading-text-secondary-label",
|
30256
30256
|
"inheritedFrom": {
|
30257
30257
|
"name": "ListItem",
|
@@ -30259,7 +30259,7 @@
|
|
30259
30259
|
}
|
30260
30260
|
},
|
30261
30261
|
{
|
30262
|
-
"description": "slot for
|
30262
|
+
"description": "slot for menu item tertiary label.",
|
30263
30263
|
"name": "leading-text-tertiary-label",
|
30264
30264
|
"inheritedFrom": {
|
30265
30265
|
"name": "ListItem",
|
@@ -30267,7 +30267,7 @@
|
|
30267
30267
|
}
|
30268
30268
|
},
|
30269
30269
|
{
|
30270
|
-
"description": "slot for
|
30270
|
+
"description": "slot for menu item side header text.",
|
30271
30271
|
"name": "trailing-text-side-header",
|
30272
30272
|
"inheritedFrom": {
|
30273
30273
|
"name": "ListItem",
|
@@ -30275,7 +30275,7 @@
|
|
30275
30275
|
}
|
30276
30276
|
},
|
30277
30277
|
{
|
30278
|
-
"description": "slot for
|
30278
|
+
"description": "slot for menu item subline text.",
|
30279
30279
|
"name": "trailing-text-subline",
|
30280
30280
|
"inheritedFrom": {
|
30281
30281
|
"name": "ListItem",
|
@@ -30283,7 +30283,7 @@
|
|
30283
30283
|
}
|
30284
30284
|
},
|
30285
30285
|
{
|
30286
|
-
"description": "slot for
|
30286
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
30287
30287
|
"name": "trailing-controls",
|
30288
30288
|
"inheritedFrom": {
|
30289
30289
|
"name": "ListItem",
|
@@ -30306,8 +30306,8 @@
|
|
30306
30306
|
"kind": "js",
|
30307
30307
|
"name": "default",
|
30308
30308
|
"declaration": {
|
30309
|
-
"name": "
|
30310
|
-
"module": "components/
|
30309
|
+
"name": "NavMenuItem",
|
30310
|
+
"module": "components/navmenuitem/navmenuitem.component.js"
|
30311
30311
|
}
|
30312
30312
|
}
|
30313
30313
|
]
|