@momentum-design/components 0.80.4 → 0.80.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +601 -317
- package/dist/browser/index.js.map +4 -4
- package/dist/components/list/list.component.d.ts +1 -1
- package/dist/components/listitem/listitem.component.js +10 -3
- package/dist/components/menupopover/menupopover.component.js +2 -1
- package/dist/components/navitem/index.d.ts +11 -0
- package/dist/components/navitem/index.js +8 -0
- package/dist/components/navitem/navitem.component.d.ts +125 -0
- package/dist/components/navitem/navitem.component.js +251 -0
- package/dist/components/navitem/navitem.constants.d.ts +16 -0
- package/dist/components/navitem/navitem.constants.js +21 -0
- package/dist/components/navitem/navitem.styles.d.ts +2 -0
- package/dist/components/navitem/navitem.styles.js +146 -0
- package/dist/components/navitem/navitem.types.d.ts +11 -0
- package/dist/components/navitem/navitem.types.js +1 -0
- package/dist/components/navitemlist/index.d.ts +7 -0
- package/dist/components/navitemlist/index.js +4 -0
- package/dist/components/navitemlist/navitemlist.component.d.ts +51 -0
- package/dist/components/navitemlist/navitemlist.component.js +92 -0
- package/dist/components/navitemlist/navitemlist.constants.d.ts +2 -0
- package/dist/components/navitemlist/navitemlist.constants.js +3 -0
- package/dist/components/navitemlist/navitemlist.styles.d.ts +2 -0
- package/dist/components/navitemlist/navitemlist.styles.js +23 -0
- package/dist/components/sidenavigation/index.d.ts +10 -0
- package/dist/components/sidenavigation/index.js +7 -0
- package/dist/components/sidenavigation/sidenavigation.component.d.ts +144 -0
- package/dist/components/sidenavigation/sidenavigation.component.js +244 -0
- package/dist/components/sidenavigation/sidenavigation.constants.d.ts +11 -0
- package/dist/components/sidenavigation/sidenavigation.constants.js +12 -0
- package/dist/components/sidenavigation/sidenavigation.context.d.ts +15 -0
- package/dist/components/sidenavigation/sidenavigation.context.js +78 -0
- package/dist/components/sidenavigation/sidenavigation.styles.d.ts +2 -0
- package/dist/components/sidenavigation/sidenavigation.styles.js +68 -0
- package/dist/components/sidenavigation/sidenavigation.types.d.ts +7 -0
- package/dist/components/sidenavigation/sidenavigation.types.js +1 -0
- package/dist/custom-elements.json +2512 -524
- package/dist/index.d.ts +4 -1
- package/dist/index.js +4 -1
- package/dist/react/index.d.ts +5 -2
- package/dist/react/index.js +5 -2
- package/dist/react/navitem/index.d.ts +43 -0
- package/dist/react/navitem/index.js +51 -0
- package/dist/react/navitemlist/index.d.ts +13 -0
- package/dist/react/navitemlist/index.js +22 -0
- package/dist/react/sidenavigation/index.d.ts +56 -0
- package/dist/react/sidenavigation/index.js +64 -0
- package/dist/utils/mixins/MenuMixin.js +39 -14
- package/dist/utils/roles.d.ts +1 -0
- package/dist/utils/roles.js +1 -0
- package/package.json +1 -1
@@ -520,67 +520,6 @@
|
|
520
520
|
}
|
521
521
|
]
|
522
522
|
},
|
523
|
-
{
|
524
|
-
"kind": "javascript-module",
|
525
|
-
"path": "components/appheader/appheader.component.js",
|
526
|
-
"declarations": [
|
527
|
-
{
|
528
|
-
"kind": "class",
|
529
|
-
"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**.",
|
530
|
-
"name": "Appheader",
|
531
|
-
"cssParts": [
|
532
|
-
{
|
533
|
-
"description": "The main container for styling the header.",
|
534
|
-
"name": "container"
|
535
|
-
},
|
536
|
-
{
|
537
|
-
"description": "The leading section of the header.",
|
538
|
-
"name": "leading-section"
|
539
|
-
},
|
540
|
-
{
|
541
|
-
"description": "The center section of the header.",
|
542
|
-
"name": "center-section"
|
543
|
-
},
|
544
|
-
{
|
545
|
-
"description": "The trailing section of the header.",
|
546
|
-
"name": "trailing-section"
|
547
|
-
}
|
548
|
-
],
|
549
|
-
"slots": [
|
550
|
-
{
|
551
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
552
|
-
"name": "leading"
|
553
|
-
},
|
554
|
-
{
|
555
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
556
|
-
"name": "center"
|
557
|
-
},
|
558
|
-
{
|
559
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
560
|
-
"name": "trailing"
|
561
|
-
}
|
562
|
-
],
|
563
|
-
"members": [],
|
564
|
-
"superclass": {
|
565
|
-
"name": "Component",
|
566
|
-
"module": "/src/models"
|
567
|
-
},
|
568
|
-
"tagName": "mdc-appheader",
|
569
|
-
"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 */",
|
570
|
-
"customElement": true
|
571
|
-
}
|
572
|
-
],
|
573
|
-
"exports": [
|
574
|
-
{
|
575
|
-
"kind": "js",
|
576
|
-
"name": "default",
|
577
|
-
"declaration": {
|
578
|
-
"name": "Appheader",
|
579
|
-
"module": "components/appheader/appheader.component.js"
|
580
|
-
}
|
581
|
-
}
|
582
|
-
]
|
583
|
-
},
|
584
523
|
{
|
585
524
|
"kind": "javascript-module",
|
586
525
|
"path": "components/animation/animation.component.js",
|
@@ -793,6 +732,67 @@
|
|
793
732
|
}
|
794
733
|
]
|
795
734
|
},
|
735
|
+
{
|
736
|
+
"kind": "javascript-module",
|
737
|
+
"path": "components/appheader/appheader.component.js",
|
738
|
+
"declarations": [
|
739
|
+
{
|
740
|
+
"kind": "class",
|
741
|
+
"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**.",
|
742
|
+
"name": "Appheader",
|
743
|
+
"cssParts": [
|
744
|
+
{
|
745
|
+
"description": "The main container for styling the header.",
|
746
|
+
"name": "container"
|
747
|
+
},
|
748
|
+
{
|
749
|
+
"description": "The leading section of the header.",
|
750
|
+
"name": "leading-section"
|
751
|
+
},
|
752
|
+
{
|
753
|
+
"description": "The center section of the header.",
|
754
|
+
"name": "center-section"
|
755
|
+
},
|
756
|
+
{
|
757
|
+
"description": "The trailing section of the header.",
|
758
|
+
"name": "trailing-section"
|
759
|
+
}
|
760
|
+
],
|
761
|
+
"slots": [
|
762
|
+
{
|
763
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
764
|
+
"name": "leading"
|
765
|
+
},
|
766
|
+
{
|
767
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
768
|
+
"name": "center"
|
769
|
+
},
|
770
|
+
{
|
771
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
772
|
+
"name": "trailing"
|
773
|
+
}
|
774
|
+
],
|
775
|
+
"members": [],
|
776
|
+
"superclass": {
|
777
|
+
"name": "Component",
|
778
|
+
"module": "/src/models"
|
779
|
+
},
|
780
|
+
"tagName": "mdc-appheader",
|
781
|
+
"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 */",
|
782
|
+
"customElement": true
|
783
|
+
}
|
784
|
+
],
|
785
|
+
"exports": [
|
786
|
+
{
|
787
|
+
"kind": "js",
|
788
|
+
"name": "default",
|
789
|
+
"declaration": {
|
790
|
+
"name": "Appheader",
|
791
|
+
"module": "components/appheader/appheader.component.js"
|
792
|
+
}
|
793
|
+
}
|
794
|
+
]
|
795
|
+
},
|
796
796
|
{
|
797
797
|
"kind": "javascript-module",
|
798
798
|
"path": "components/avatar/avatar.component.js",
|
@@ -11475,6 +11475,248 @@
|
|
11475
11475
|
}
|
11476
11476
|
]
|
11477
11477
|
},
|
11478
|
+
{
|
11479
|
+
"kind": "javascript-module",
|
11480
|
+
"path": "components/icon/icon.component.js",
|
11481
|
+
"declarations": [
|
11482
|
+
{
|
11483
|
+
"kind": "class",
|
11484
|
+
"description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
|
11485
|
+
"name": "Icon",
|
11486
|
+
"cssProperties": [
|
11487
|
+
{
|
11488
|
+
"description": "Allows customization of the default fill color.",
|
11489
|
+
"name": "--mdc-icon-fill-color"
|
11490
|
+
},
|
11491
|
+
{
|
11492
|
+
"description": "Allows customization of the icon size.",
|
11493
|
+
"name": "--mdc-icon-size"
|
11494
|
+
},
|
11495
|
+
{
|
11496
|
+
"description": "Allows customization of the icon border radius.",
|
11497
|
+
"name": "--mdc-icon-border-radius"
|
11498
|
+
}
|
11499
|
+
],
|
11500
|
+
"members": [
|
11501
|
+
{
|
11502
|
+
"kind": "field",
|
11503
|
+
"name": "iconData",
|
11504
|
+
"type": {
|
11505
|
+
"text": "HTMLElement | undefined"
|
11506
|
+
},
|
11507
|
+
"privacy": "private"
|
11508
|
+
},
|
11509
|
+
{
|
11510
|
+
"kind": "field",
|
11511
|
+
"name": "lengthUnitFromContext",
|
11512
|
+
"type": {
|
11513
|
+
"text": "string | undefined"
|
11514
|
+
},
|
11515
|
+
"privacy": "private"
|
11516
|
+
},
|
11517
|
+
{
|
11518
|
+
"kind": "field",
|
11519
|
+
"name": "sizeFromContext",
|
11520
|
+
"type": {
|
11521
|
+
"text": "number | undefined"
|
11522
|
+
},
|
11523
|
+
"privacy": "private"
|
11524
|
+
},
|
11525
|
+
{
|
11526
|
+
"kind": "field",
|
11527
|
+
"name": "name",
|
11528
|
+
"type": {
|
11529
|
+
"text": "IconNames | undefined"
|
11530
|
+
},
|
11531
|
+
"description": "Name of the icon (= filename)",
|
11532
|
+
"attribute": "name",
|
11533
|
+
"reflects": true
|
11534
|
+
},
|
11535
|
+
{
|
11536
|
+
"kind": "field",
|
11537
|
+
"name": "size",
|
11538
|
+
"type": {
|
11539
|
+
"text": "number | undefined"
|
11540
|
+
},
|
11541
|
+
"description": "Size of the icon (works in combination with length unit)",
|
11542
|
+
"attribute": "size"
|
11543
|
+
},
|
11544
|
+
{
|
11545
|
+
"kind": "field",
|
11546
|
+
"name": "lengthUnit",
|
11547
|
+
"type": {
|
11548
|
+
"text": "string | undefined"
|
11549
|
+
},
|
11550
|
+
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
11551
|
+
"attribute": "length-unit"
|
11552
|
+
},
|
11553
|
+
{
|
11554
|
+
"kind": "field",
|
11555
|
+
"name": "ariaLabel",
|
11556
|
+
"type": {
|
11557
|
+
"text": "string | null"
|
11558
|
+
},
|
11559
|
+
"default": "null",
|
11560
|
+
"description": "Aria-label attribute to be set for accessibility",
|
11561
|
+
"attribute": "aria-label"
|
11562
|
+
},
|
11563
|
+
{
|
11564
|
+
"kind": "field",
|
11565
|
+
"name": "ariaLabelledBy",
|
11566
|
+
"type": {
|
11567
|
+
"text": "string | null"
|
11568
|
+
},
|
11569
|
+
"default": "null",
|
11570
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
11571
|
+
"attribute": "aria-labelledby"
|
11572
|
+
},
|
11573
|
+
{
|
11574
|
+
"kind": "field",
|
11575
|
+
"name": "iconProviderContext",
|
11576
|
+
"privacy": "private",
|
11577
|
+
"readonly": true
|
11578
|
+
},
|
11579
|
+
{
|
11580
|
+
"kind": "field",
|
11581
|
+
"name": "abortController",
|
11582
|
+
"type": {
|
11583
|
+
"text": "AbortController"
|
11584
|
+
},
|
11585
|
+
"privacy": "private",
|
11586
|
+
"default": "new AbortController()"
|
11587
|
+
},
|
11588
|
+
{
|
11589
|
+
"kind": "method",
|
11590
|
+
"name": "prepareIconElement",
|
11591
|
+
"privacy": "private",
|
11592
|
+
"parameters": [
|
11593
|
+
{
|
11594
|
+
"name": "iconData",
|
11595
|
+
"type": {
|
11596
|
+
"text": "string"
|
11597
|
+
},
|
11598
|
+
"description": "The icon string to be parsed"
|
11599
|
+
}
|
11600
|
+
],
|
11601
|
+
"description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
|
11602
|
+
"return": {
|
11603
|
+
"type": {
|
11604
|
+
"text": ""
|
11605
|
+
}
|
11606
|
+
}
|
11607
|
+
},
|
11608
|
+
{
|
11609
|
+
"kind": "method",
|
11610
|
+
"name": "getIconData",
|
11611
|
+
"privacy": "private",
|
11612
|
+
"description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
|
11613
|
+
},
|
11614
|
+
{
|
11615
|
+
"kind": "method",
|
11616
|
+
"name": "handleIconLoadedSuccess",
|
11617
|
+
"privacy": "private",
|
11618
|
+
"parameters": [
|
11619
|
+
{
|
11620
|
+
"name": "iconHtml",
|
11621
|
+
"type": {
|
11622
|
+
"text": "HTMLElement"
|
11623
|
+
},
|
11624
|
+
"description": "The icon html element which has been fetched from the icon provider."
|
11625
|
+
}
|
11626
|
+
],
|
11627
|
+
"description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
|
11628
|
+
},
|
11629
|
+
{
|
11630
|
+
"kind": "method",
|
11631
|
+
"name": "handleIconLoadedFailure",
|
11632
|
+
"privacy": "private",
|
11633
|
+
"parameters": [
|
11634
|
+
{
|
11635
|
+
"name": "error",
|
11636
|
+
"type": {
|
11637
|
+
"text": "unknown"
|
11638
|
+
}
|
11639
|
+
}
|
11640
|
+
],
|
11641
|
+
"description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
11642
|
+
},
|
11643
|
+
{
|
11644
|
+
"kind": "method",
|
11645
|
+
"name": "updateSize",
|
11646
|
+
"privacy": "private",
|
11647
|
+
"description": "Updates the size by setting the width and height"
|
11648
|
+
},
|
11649
|
+
{
|
11650
|
+
"kind": "field",
|
11651
|
+
"name": "computedIconSize",
|
11652
|
+
"privacy": "private",
|
11653
|
+
"readonly": true
|
11654
|
+
}
|
11655
|
+
],
|
11656
|
+
"attributes": [
|
11657
|
+
{
|
11658
|
+
"name": "name",
|
11659
|
+
"type": {
|
11660
|
+
"text": "IconNames | undefined"
|
11661
|
+
},
|
11662
|
+
"description": "Name of the icon (= filename)",
|
11663
|
+
"fieldName": "name"
|
11664
|
+
},
|
11665
|
+
{
|
11666
|
+
"name": "size",
|
11667
|
+
"type": {
|
11668
|
+
"text": "number | undefined"
|
11669
|
+
},
|
11670
|
+
"description": "Size of the icon (works in combination with length unit)",
|
11671
|
+
"fieldName": "size"
|
11672
|
+
},
|
11673
|
+
{
|
11674
|
+
"name": "length-unit",
|
11675
|
+
"type": {
|
11676
|
+
"text": "string | undefined"
|
11677
|
+
},
|
11678
|
+
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
11679
|
+
"fieldName": "lengthUnit"
|
11680
|
+
},
|
11681
|
+
{
|
11682
|
+
"name": "aria-label",
|
11683
|
+
"type": {
|
11684
|
+
"text": "string | null"
|
11685
|
+
},
|
11686
|
+
"default": "null",
|
11687
|
+
"description": "Aria-label attribute to be set for accessibility",
|
11688
|
+
"fieldName": "ariaLabel"
|
11689
|
+
},
|
11690
|
+
{
|
11691
|
+
"name": "aria-labelledby",
|
11692
|
+
"type": {
|
11693
|
+
"text": "string | null"
|
11694
|
+
},
|
11695
|
+
"default": "null",
|
11696
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
11697
|
+
"fieldName": "ariaLabelledBy"
|
11698
|
+
}
|
11699
|
+
],
|
11700
|
+
"superclass": {
|
11701
|
+
"name": "Component",
|
11702
|
+
"module": "/src/models"
|
11703
|
+
},
|
11704
|
+
"tagName": "mdc-icon",
|
11705
|
+
"jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n */",
|
11706
|
+
"customElement": true
|
11707
|
+
}
|
11708
|
+
],
|
11709
|
+
"exports": [
|
11710
|
+
{
|
11711
|
+
"kind": "js",
|
11712
|
+
"name": "default",
|
11713
|
+
"declaration": {
|
11714
|
+
"name": "Icon",
|
11715
|
+
"module": "components/icon/icon.component.js"
|
11716
|
+
}
|
11717
|
+
}
|
11718
|
+
]
|
11719
|
+
},
|
11478
11720
|
{
|
11479
11721
|
"kind": "javascript-module",
|
11480
11722
|
"path": "components/formfieldwrapper/formfieldwrapper.component.js",
|
@@ -11745,248 +11987,6 @@
|
|
11745
11987
|
}
|
11746
11988
|
]
|
11747
11989
|
},
|
11748
|
-
{
|
11749
|
-
"kind": "javascript-module",
|
11750
|
-
"path": "components/icon/icon.component.js",
|
11751
|
-
"declarations": [
|
11752
|
-
{
|
11753
|
-
"kind": "class",
|
11754
|
-
"description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
|
11755
|
-
"name": "Icon",
|
11756
|
-
"cssProperties": [
|
11757
|
-
{
|
11758
|
-
"description": "Allows customization of the default fill color.",
|
11759
|
-
"name": "--mdc-icon-fill-color"
|
11760
|
-
},
|
11761
|
-
{
|
11762
|
-
"description": "Allows customization of the icon size.",
|
11763
|
-
"name": "--mdc-icon-size"
|
11764
|
-
},
|
11765
|
-
{
|
11766
|
-
"description": "Allows customization of the icon border radius.",
|
11767
|
-
"name": "--mdc-icon-border-radius"
|
11768
|
-
}
|
11769
|
-
],
|
11770
|
-
"members": [
|
11771
|
-
{
|
11772
|
-
"kind": "field",
|
11773
|
-
"name": "iconData",
|
11774
|
-
"type": {
|
11775
|
-
"text": "HTMLElement | undefined"
|
11776
|
-
},
|
11777
|
-
"privacy": "private"
|
11778
|
-
},
|
11779
|
-
{
|
11780
|
-
"kind": "field",
|
11781
|
-
"name": "lengthUnitFromContext",
|
11782
|
-
"type": {
|
11783
|
-
"text": "string | undefined"
|
11784
|
-
},
|
11785
|
-
"privacy": "private"
|
11786
|
-
},
|
11787
|
-
{
|
11788
|
-
"kind": "field",
|
11789
|
-
"name": "sizeFromContext",
|
11790
|
-
"type": {
|
11791
|
-
"text": "number | undefined"
|
11792
|
-
},
|
11793
|
-
"privacy": "private"
|
11794
|
-
},
|
11795
|
-
{
|
11796
|
-
"kind": "field",
|
11797
|
-
"name": "name",
|
11798
|
-
"type": {
|
11799
|
-
"text": "IconNames | undefined"
|
11800
|
-
},
|
11801
|
-
"description": "Name of the icon (= filename)",
|
11802
|
-
"attribute": "name",
|
11803
|
-
"reflects": true
|
11804
|
-
},
|
11805
|
-
{
|
11806
|
-
"kind": "field",
|
11807
|
-
"name": "size",
|
11808
|
-
"type": {
|
11809
|
-
"text": "number | undefined"
|
11810
|
-
},
|
11811
|
-
"description": "Size of the icon (works in combination with length unit)",
|
11812
|
-
"attribute": "size"
|
11813
|
-
},
|
11814
|
-
{
|
11815
|
-
"kind": "field",
|
11816
|
-
"name": "lengthUnit",
|
11817
|
-
"type": {
|
11818
|
-
"text": "string | undefined"
|
11819
|
-
},
|
11820
|
-
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
11821
|
-
"attribute": "length-unit"
|
11822
|
-
},
|
11823
|
-
{
|
11824
|
-
"kind": "field",
|
11825
|
-
"name": "ariaLabel",
|
11826
|
-
"type": {
|
11827
|
-
"text": "string | null"
|
11828
|
-
},
|
11829
|
-
"default": "null",
|
11830
|
-
"description": "Aria-label attribute to be set for accessibility",
|
11831
|
-
"attribute": "aria-label"
|
11832
|
-
},
|
11833
|
-
{
|
11834
|
-
"kind": "field",
|
11835
|
-
"name": "ariaLabelledBy",
|
11836
|
-
"type": {
|
11837
|
-
"text": "string | null"
|
11838
|
-
},
|
11839
|
-
"default": "null",
|
11840
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
11841
|
-
"attribute": "aria-labelledby"
|
11842
|
-
},
|
11843
|
-
{
|
11844
|
-
"kind": "field",
|
11845
|
-
"name": "iconProviderContext",
|
11846
|
-
"privacy": "private",
|
11847
|
-
"readonly": true
|
11848
|
-
},
|
11849
|
-
{
|
11850
|
-
"kind": "field",
|
11851
|
-
"name": "abortController",
|
11852
|
-
"type": {
|
11853
|
-
"text": "AbortController"
|
11854
|
-
},
|
11855
|
-
"privacy": "private",
|
11856
|
-
"default": "new AbortController()"
|
11857
|
-
},
|
11858
|
-
{
|
11859
|
-
"kind": "method",
|
11860
|
-
"name": "prepareIconElement",
|
11861
|
-
"privacy": "private",
|
11862
|
-
"parameters": [
|
11863
|
-
{
|
11864
|
-
"name": "iconData",
|
11865
|
-
"type": {
|
11866
|
-
"text": "string"
|
11867
|
-
},
|
11868
|
-
"description": "The icon string to be parsed"
|
11869
|
-
}
|
11870
|
-
],
|
11871
|
-
"description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
|
11872
|
-
"return": {
|
11873
|
-
"type": {
|
11874
|
-
"text": ""
|
11875
|
-
}
|
11876
|
-
}
|
11877
|
-
},
|
11878
|
-
{
|
11879
|
-
"kind": "method",
|
11880
|
-
"name": "getIconData",
|
11881
|
-
"privacy": "private",
|
11882
|
-
"description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
|
11883
|
-
},
|
11884
|
-
{
|
11885
|
-
"kind": "method",
|
11886
|
-
"name": "handleIconLoadedSuccess",
|
11887
|
-
"privacy": "private",
|
11888
|
-
"parameters": [
|
11889
|
-
{
|
11890
|
-
"name": "iconHtml",
|
11891
|
-
"type": {
|
11892
|
-
"text": "HTMLElement"
|
11893
|
-
},
|
11894
|
-
"description": "The icon html element which has been fetched from the icon provider."
|
11895
|
-
}
|
11896
|
-
],
|
11897
|
-
"description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
|
11898
|
-
},
|
11899
|
-
{
|
11900
|
-
"kind": "method",
|
11901
|
-
"name": "handleIconLoadedFailure",
|
11902
|
-
"privacy": "private",
|
11903
|
-
"parameters": [
|
11904
|
-
{
|
11905
|
-
"name": "error",
|
11906
|
-
"type": {
|
11907
|
-
"text": "unknown"
|
11908
|
-
}
|
11909
|
-
}
|
11910
|
-
],
|
11911
|
-
"description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
11912
|
-
},
|
11913
|
-
{
|
11914
|
-
"kind": "method",
|
11915
|
-
"name": "updateSize",
|
11916
|
-
"privacy": "private",
|
11917
|
-
"description": "Updates the size by setting the width and height"
|
11918
|
-
},
|
11919
|
-
{
|
11920
|
-
"kind": "field",
|
11921
|
-
"name": "computedIconSize",
|
11922
|
-
"privacy": "private",
|
11923
|
-
"readonly": true
|
11924
|
-
}
|
11925
|
-
],
|
11926
|
-
"attributes": [
|
11927
|
-
{
|
11928
|
-
"name": "name",
|
11929
|
-
"type": {
|
11930
|
-
"text": "IconNames | undefined"
|
11931
|
-
},
|
11932
|
-
"description": "Name of the icon (= filename)",
|
11933
|
-
"fieldName": "name"
|
11934
|
-
},
|
11935
|
-
{
|
11936
|
-
"name": "size",
|
11937
|
-
"type": {
|
11938
|
-
"text": "number | undefined"
|
11939
|
-
},
|
11940
|
-
"description": "Size of the icon (works in combination with length unit)",
|
11941
|
-
"fieldName": "size"
|
11942
|
-
},
|
11943
|
-
{
|
11944
|
-
"name": "length-unit",
|
11945
|
-
"type": {
|
11946
|
-
"text": "string | undefined"
|
11947
|
-
},
|
11948
|
-
"description": "Length unit attribute for overriding length-unit from `IconProvider`",
|
11949
|
-
"fieldName": "lengthUnit"
|
11950
|
-
},
|
11951
|
-
{
|
11952
|
-
"name": "aria-label",
|
11953
|
-
"type": {
|
11954
|
-
"text": "string | null"
|
11955
|
-
},
|
11956
|
-
"default": "null",
|
11957
|
-
"description": "Aria-label attribute to be set for accessibility",
|
11958
|
-
"fieldName": "ariaLabel"
|
11959
|
-
},
|
11960
|
-
{
|
11961
|
-
"name": "aria-labelledby",
|
11962
|
-
"type": {
|
11963
|
-
"text": "string | null"
|
11964
|
-
},
|
11965
|
-
"default": "null",
|
11966
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
11967
|
-
"fieldName": "ariaLabelledBy"
|
11968
|
-
}
|
11969
|
-
],
|
11970
|
-
"superclass": {
|
11971
|
-
"name": "Component",
|
11972
|
-
"module": "/src/models"
|
11973
|
-
},
|
11974
|
-
"tagName": "mdc-icon",
|
11975
|
-
"jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n */",
|
11976
|
-
"customElement": true
|
11977
|
-
}
|
11978
|
-
],
|
11979
|
-
"exports": [
|
11980
|
-
{
|
11981
|
-
"kind": "js",
|
11982
|
-
"name": "default",
|
11983
|
-
"declaration": {
|
11984
|
-
"name": "Icon",
|
11985
|
-
"module": "components/icon/icon.component.js"
|
11986
|
-
}
|
11987
|
-
}
|
11988
|
-
]
|
11989
|
-
},
|
11990
11990
|
{
|
11991
11991
|
"kind": "javascript-module",
|
11992
11992
|
"path": "components/iconprovider/iconprovider.component.js",
|
@@ -14200,7 +14200,7 @@
|
|
14200
14200
|
{
|
14201
14201
|
"kind": "method",
|
14202
14202
|
"name": "handleMouseClick",
|
14203
|
-
"privacy": "
|
14203
|
+
"privacy": "protected",
|
14204
14204
|
"return": {
|
14205
14205
|
"type": {
|
14206
14206
|
"text": "void"
|
@@ -14993,7 +14993,7 @@
|
|
14993
14993
|
{
|
14994
14994
|
"kind": "method",
|
14995
14995
|
"name": "handleMouseClick",
|
14996
|
-
"privacy": "
|
14996
|
+
"privacy": "protected",
|
14997
14997
|
"return": {
|
14998
14998
|
"type": {
|
14999
14999
|
"text": "void"
|
@@ -15242,6 +15242,31 @@
|
|
15242
15242
|
"module": "utils/mixins/MenuMixin.js"
|
15243
15243
|
}
|
15244
15244
|
},
|
15245
|
+
{
|
15246
|
+
"kind": "method",
|
15247
|
+
"name": "isValidNavItemList",
|
15248
|
+
"privacy": "private",
|
15249
|
+
"return": {
|
15250
|
+
"type": {
|
15251
|
+
"text": ""
|
15252
|
+
}
|
15253
|
+
},
|
15254
|
+
"parameters": [
|
15255
|
+
{
|
15256
|
+
"name": "tagName",
|
15257
|
+
"optional": true,
|
15258
|
+
"type": {
|
15259
|
+
"text": "string"
|
15260
|
+
},
|
15261
|
+
"description": "The tag name to check."
|
15262
|
+
}
|
15263
|
+
],
|
15264
|
+
"description": "Checks if the given tag name is a valid navitemlist tag name.",
|
15265
|
+
"inheritedFrom": {
|
15266
|
+
"name": "MenuMixin",
|
15267
|
+
"module": "utils/mixins/MenuMixin.js"
|
15268
|
+
}
|
15269
|
+
},
|
15245
15270
|
{
|
15246
15271
|
"kind": "method",
|
15247
15272
|
"name": "isValidPopover",
|
@@ -15592,6 +15617,30 @@
|
|
15592
15617
|
"module": "utils/mixins/MenuMixin.js"
|
15593
15618
|
}
|
15594
15619
|
},
|
15620
|
+
{
|
15621
|
+
"kind": "method",
|
15622
|
+
"name": "getKeyBasedOnDirection",
|
15623
|
+
"privacy": "private",
|
15624
|
+
"return": {
|
15625
|
+
"type": {
|
15626
|
+
"text": ""
|
15627
|
+
}
|
15628
|
+
},
|
15629
|
+
"parameters": [
|
15630
|
+
{
|
15631
|
+
"name": "originalKey",
|
15632
|
+
"type": {
|
15633
|
+
"text": "string"
|
15634
|
+
},
|
15635
|
+
"description": "The original key pressed."
|
15636
|
+
}
|
15637
|
+
],
|
15638
|
+
"description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction.",
|
15639
|
+
"inheritedFrom": {
|
15640
|
+
"name": "MenuMixin",
|
15641
|
+
"module": "utils/mixins/MenuMixin.js"
|
15642
|
+
}
|
15643
|
+
},
|
15595
15644
|
{
|
15596
15645
|
"kind": "method",
|
15597
15646
|
"name": "handleKeyDown",
|
@@ -18093,6 +18142,31 @@
|
|
18093
18142
|
"module": "utils/mixins/MenuMixin.js"
|
18094
18143
|
}
|
18095
18144
|
},
|
18145
|
+
{
|
18146
|
+
"kind": "method",
|
18147
|
+
"name": "isValidNavItemList",
|
18148
|
+
"privacy": "private",
|
18149
|
+
"return": {
|
18150
|
+
"type": {
|
18151
|
+
"text": ""
|
18152
|
+
}
|
18153
|
+
},
|
18154
|
+
"parameters": [
|
18155
|
+
{
|
18156
|
+
"name": "tagName",
|
18157
|
+
"optional": true,
|
18158
|
+
"type": {
|
18159
|
+
"text": "string"
|
18160
|
+
},
|
18161
|
+
"description": "The tag name to check."
|
18162
|
+
}
|
18163
|
+
],
|
18164
|
+
"description": "Checks if the given tag name is a valid navitemlist tag name.",
|
18165
|
+
"inheritedFrom": {
|
18166
|
+
"name": "MenuMixin",
|
18167
|
+
"module": "utils/mixins/MenuMixin.js"
|
18168
|
+
}
|
18169
|
+
},
|
18096
18170
|
{
|
18097
18171
|
"kind": "method",
|
18098
18172
|
"name": "isValidPopover",
|
@@ -18443,6 +18517,30 @@
|
|
18443
18517
|
"module": "utils/mixins/MenuMixin.js"
|
18444
18518
|
}
|
18445
18519
|
},
|
18520
|
+
{
|
18521
|
+
"kind": "method",
|
18522
|
+
"name": "getKeyBasedOnDirection",
|
18523
|
+
"privacy": "private",
|
18524
|
+
"return": {
|
18525
|
+
"type": {
|
18526
|
+
"text": ""
|
18527
|
+
}
|
18528
|
+
},
|
18529
|
+
"parameters": [
|
18530
|
+
{
|
18531
|
+
"name": "originalKey",
|
18532
|
+
"type": {
|
18533
|
+
"text": "string"
|
18534
|
+
},
|
18535
|
+
"description": "The original key pressed."
|
18536
|
+
}
|
18537
|
+
],
|
18538
|
+
"description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction.",
|
18539
|
+
"inheritedFrom": {
|
18540
|
+
"name": "MenuMixin",
|
18541
|
+
"module": "utils/mixins/MenuMixin.js"
|
18542
|
+
}
|
18543
|
+
},
|
18446
18544
|
{
|
18447
18545
|
"kind": "method",
|
18448
18546
|
"name": "handleKeyDown",
|
@@ -20161,206 +20259,116 @@
|
|
20161
20259
|
},
|
20162
20260
|
{
|
20163
20261
|
"kind": "javascript-module",
|
20164
|
-
"path": "components/
|
20262
|
+
"path": "components/navitem/navitem.component.js",
|
20165
20263
|
"declarations": [
|
20166
20264
|
{
|
20167
20265
|
"kind": "class",
|
20168
|
-
"description": "
|
20169
|
-
"name": "
|
20266
|
+
"description": "`mdc-navitem` is a menuitem styled to work as a navigation tab.\nIt supports a leading icon, optional badge and dynamic text rendering.\n\nNote: `mdc-navitem` is intended to be used inside `mdc-navitemlist` 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.",
|
20267
|
+
"name": "NavItem",
|
20170
20268
|
"cssProperties": [
|
20171
20269
|
{
|
20172
|
-
"description": "
|
20173
|
-
"name": "--mdc-
|
20174
|
-
}
|
20175
|
-
],
|
20176
|
-
"slots": [
|
20270
|
+
"description": "Text color of the navitem in its normal state.",
|
20271
|
+
"name": "--mdc-navitem-color"
|
20272
|
+
},
|
20177
20273
|
{
|
20178
|
-
"description": "
|
20179
|
-
"name": "
|
20180
|
-
}
|
20181
|
-
],
|
20182
|
-
"members": [
|
20274
|
+
"description": "Border color of the navitem in its normal state.",
|
20275
|
+
"name": "--mdc-navitem-border-color"
|
20276
|
+
},
|
20183
20277
|
{
|
20184
|
-
"
|
20185
|
-
"name": "
|
20186
|
-
"type": {
|
20187
|
-
"text": "string | undefined"
|
20188
|
-
},
|
20189
|
-
"description": "The header text to be displayed on the top of the options list.",
|
20190
|
-
"attribute": "label",
|
20191
|
-
"reflects": true
|
20278
|
+
"description": "Text color of the navitem when disabled.",
|
20279
|
+
"name": "--mdc-navitem-disabled-color"
|
20192
20280
|
},
|
20193
20281
|
{
|
20194
|
-
"
|
20195
|
-
"name": "
|
20196
|
-
"privacy": "private",
|
20197
|
-
"return": {
|
20198
|
-
"type": {
|
20199
|
-
"text": "void"
|
20200
|
-
}
|
20201
|
-
}
|
20282
|
+
"description": "Width of the navItem when expanded.",
|
20283
|
+
"name": "--mdc-navitem-expanded-width"
|
20202
20284
|
},
|
20203
20285
|
{
|
20204
|
-
"
|
20205
|
-
"name": "
|
20206
|
-
"type": {
|
20207
|
-
"text": "string | null"
|
20208
|
-
},
|
20209
|
-
"default": "null",
|
20210
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
20211
|
-
"attribute": "data-aria-label",
|
20212
|
-
"reflects": true,
|
20213
|
-
"inheritedFrom": {
|
20214
|
-
"name": "DataAriaLabelMixin",
|
20215
|
-
"module": "utils/mixins/DataAriaLabelMixin.js"
|
20216
|
-
}
|
20286
|
+
"description": "Background color of the navitem when hovered.",
|
20287
|
+
"name": "--mdc-navitem-hover-background-color"
|
20217
20288
|
},
|
20218
20289
|
{
|
20219
|
-
"
|
20220
|
-
"name": "
|
20221
|
-
|
20222
|
-
"text": "boolean | undefined"
|
20223
|
-
},
|
20224
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
20225
|
-
"default": "undefined",
|
20226
|
-
"attribute": "disabled",
|
20227
|
-
"reflects": true,
|
20228
|
-
"inheritedFrom": {
|
20229
|
-
"name": "DisabledMixin",
|
20230
|
-
"module": "utils/mixins/DisabledMixin.js"
|
20231
|
-
}
|
20232
|
-
}
|
20233
|
-
],
|
20234
|
-
"attributes": [
|
20290
|
+
"description": "Background color of the active navitem when hovered.",
|
20291
|
+
"name": "--mdc-navitem-hover-active-background-color"
|
20292
|
+
},
|
20235
20293
|
{
|
20236
|
-
"
|
20237
|
-
"
|
20238
|
-
"text": "string | undefined"
|
20239
|
-
},
|
20240
|
-
"description": "The header text to be displayed on the top of the options list.",
|
20241
|
-
"fieldName": "label"
|
20294
|
+
"description": "Background color of the navitem when pressed.",
|
20295
|
+
"name": "--mdc-navitem-pressed-background-color"
|
20242
20296
|
},
|
20243
20297
|
{
|
20244
|
-
"
|
20245
|
-
"
|
20246
|
-
"text": "string | null"
|
20247
|
-
},
|
20248
|
-
"default": "null",
|
20249
|
-
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
20250
|
-
"fieldName": "dataAriaLabel",
|
20251
|
-
"inheritedFrom": {
|
20252
|
-
"name": "DataAriaLabelMixin",
|
20253
|
-
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
20254
|
-
}
|
20298
|
+
"description": "Background color of the active navitem when pressed.",
|
20299
|
+
"name": "--mdc-navitem-pressed-active-background-color"
|
20255
20300
|
},
|
20256
20301
|
{
|
20257
|
-
"
|
20258
|
-
"
|
20259
|
-
|
20260
|
-
},
|
20261
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
20262
|
-
"default": "undefined",
|
20263
|
-
"fieldName": "disabled",
|
20264
|
-
"inheritedFrom": {
|
20265
|
-
"name": "DisabledMixin",
|
20266
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
20267
|
-
}
|
20268
|
-
}
|
20269
|
-
],
|
20270
|
-
"mixins": [
|
20302
|
+
"description": "Background color of the navitem when disabled.",
|
20303
|
+
"name": "--mdc-navitem-disabled-background-color"
|
20304
|
+
},
|
20271
20305
|
{
|
20272
|
-
"
|
20273
|
-
"
|
20306
|
+
"description": "Background color of the active navitem when disabled.",
|
20307
|
+
"name": "--mdc-navitem-disabled-active-background-color"
|
20274
20308
|
},
|
20275
20309
|
{
|
20276
|
-
"
|
20277
|
-
"
|
20278
|
-
}
|
20279
|
-
],
|
20280
|
-
"superclass": {
|
20281
|
-
"name": "Component",
|
20282
|
-
"module": "/src/models"
|
20283
|
-
},
|
20284
|
-
"tagName": "mdc-optgroup",
|
20285
|
-
"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 */",
|
20286
|
-
"customElement": true
|
20287
|
-
}
|
20288
|
-
],
|
20289
|
-
"exports": [
|
20290
|
-
{
|
20291
|
-
"kind": "js",
|
20292
|
-
"name": "default",
|
20293
|
-
"declaration": {
|
20294
|
-
"name": "OptGroup",
|
20295
|
-
"module": "components/optgroup/optgroup.component.js"
|
20296
|
-
}
|
20297
|
-
}
|
20298
|
-
]
|
20299
|
-
},
|
20300
|
-
{
|
20301
|
-
"kind": "javascript-module",
|
20302
|
-
"path": "components/option/option.component.js",
|
20303
|
-
"declarations": [
|
20304
|
-
{
|
20305
|
-
"kind": "class",
|
20306
|
-
"description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.\nWe can pass a tooltip which will be displayed on hover of the option label text.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
|
20307
|
-
"name": "Option",
|
20308
|
-
"slots": [
|
20310
|
+
"description": "Background color of the active nav item in its rest state.",
|
20311
|
+
"name": "--mdc-navitem-rest-active-background-color"
|
20312
|
+
},
|
20309
20313
|
{
|
20310
|
-
"description": "
|
20311
|
-
"name": "default"
|
20314
|
+
"description": "Allows customization of the default background color.",
|
20315
|
+
"name": "--mdc-listitem-default-background-color",
|
20316
|
+
"inheritedFrom": {
|
20317
|
+
"name": "ListItem",
|
20318
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20319
|
+
}
|
20312
20320
|
},
|
20313
20321
|
{
|
20314
|
-
"description": "
|
20315
|
-
"name": "
|
20322
|
+
"description": "Allows customization of the background color on hover.",
|
20323
|
+
"name": "--mdc-listitem-background-color-hover",
|
20316
20324
|
"inheritedFrom": {
|
20317
20325
|
"name": "ListItem",
|
20318
20326
|
"module": "src/components/listitem/listitem.component.ts"
|
20319
20327
|
}
|
20320
20328
|
},
|
20321
20329
|
{
|
20322
|
-
"description": "
|
20323
|
-
"name": "
|
20330
|
+
"description": "Allows customization of the background color when pressed.",
|
20331
|
+
"name": "--mdc-listitem-background-color-active",
|
20324
20332
|
"inheritedFrom": {
|
20325
20333
|
"name": "ListItem",
|
20326
20334
|
"module": "src/components/listitem/listitem.component.ts"
|
20327
20335
|
}
|
20328
20336
|
},
|
20329
20337
|
{
|
20330
|
-
"description": "
|
20331
|
-
"name": "
|
20338
|
+
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
20339
|
+
"name": "--mdc-listitem-primary-label-color",
|
20332
20340
|
"inheritedFrom": {
|
20333
20341
|
"name": "ListItem",
|
20334
20342
|
"module": "src/components/listitem/listitem.component.ts"
|
20335
20343
|
}
|
20336
20344
|
},
|
20337
20345
|
{
|
20338
|
-
"description": "
|
20339
|
-
"name": "
|
20346
|
+
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
20347
|
+
"name": "--mdc-listitem-secondary-label-color",
|
20340
20348
|
"inheritedFrom": {
|
20341
20349
|
"name": "ListItem",
|
20342
20350
|
"module": "src/components/listitem/listitem.component.ts"
|
20343
20351
|
}
|
20344
20352
|
},
|
20345
20353
|
{
|
20346
|
-
"description": "
|
20347
|
-
"name": "
|
20354
|
+
"description": "Allows customization of the disabled color.",
|
20355
|
+
"name": "--mdc-listitem-disabled-color",
|
20348
20356
|
"inheritedFrom": {
|
20349
20357
|
"name": "ListItem",
|
20350
20358
|
"module": "src/components/listitem/listitem.component.ts"
|
20351
20359
|
}
|
20352
20360
|
},
|
20353
20361
|
{
|
20354
|
-
"description": "
|
20355
|
-
"name": "
|
20362
|
+
"description": "Allows customization of column gap.",
|
20363
|
+
"name": "--mdc-listitem-column-gap",
|
20356
20364
|
"inheritedFrom": {
|
20357
20365
|
"name": "ListItem",
|
20358
20366
|
"module": "src/components/listitem/listitem.component.ts"
|
20359
20367
|
}
|
20360
20368
|
},
|
20361
20369
|
{
|
20362
|
-
"description": "
|
20363
|
-
"name": "
|
20370
|
+
"description": "Allows customization of padding left and right.",
|
20371
|
+
"name": "--mdc-listitem-padding-left-and-right",
|
20364
20372
|
"inheritedFrom": {
|
20365
20373
|
"name": "ListItem",
|
20366
20374
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -20370,23 +20378,55 @@
|
|
20370
20378
|
"members": [
|
20371
20379
|
{
|
20372
20380
|
"kind": "field",
|
20373
|
-
"name": "
|
20381
|
+
"name": "active",
|
20374
20382
|
"type": {
|
20375
|
-
"text": "boolean"
|
20383
|
+
"text": "boolean | undefined"
|
20376
20384
|
},
|
20377
|
-
"
|
20378
|
-
"
|
20379
|
-
"attribute": "
|
20385
|
+
"description": "The navitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navitem is in an inactive state, indicating it is toggled off.",
|
20386
|
+
"default": "undefined",
|
20387
|
+
"attribute": "active",
|
20380
20388
|
"reflects": true
|
20381
20389
|
},
|
20382
20390
|
{
|
20383
20391
|
"kind": "field",
|
20384
|
-
"name": "
|
20392
|
+
"name": "badgeType",
|
20385
20393
|
"type": {
|
20386
|
-
"text": "
|
20394
|
+
"text": "BadgeType | undefined"
|
20387
20395
|
},
|
20388
|
-
"description": "
|
20389
|
-
"attribute": "
|
20396
|
+
"description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
|
20397
|
+
"attribute": "badge-type",
|
20398
|
+
"reflects": true
|
20399
|
+
},
|
20400
|
+
{
|
20401
|
+
"kind": "field",
|
20402
|
+
"name": "counter",
|
20403
|
+
"type": {
|
20404
|
+
"text": "number | undefined"
|
20405
|
+
},
|
20406
|
+
"description": "Counter is the number which can be provided in the badge.",
|
20407
|
+
"attribute": "counter",
|
20408
|
+
"reflects": true
|
20409
|
+
},
|
20410
|
+
{
|
20411
|
+
"kind": "field",
|
20412
|
+
"name": "maxCounter",
|
20413
|
+
"type": {
|
20414
|
+
"text": "number"
|
20415
|
+
},
|
20416
|
+
"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`.",
|
20417
|
+
"default": "99",
|
20418
|
+
"attribute": "max-counter",
|
20419
|
+
"reflects": true
|
20420
|
+
},
|
20421
|
+
{
|
20422
|
+
"kind": "field",
|
20423
|
+
"name": "navId",
|
20424
|
+
"type": {
|
20425
|
+
"text": "string | undefined"
|
20426
|
+
},
|
20427
|
+
"description": "Id of the navItem (used as a identificator when used in the navItemList)\nNote: It has to be unique.",
|
20428
|
+
"default": "undefined",
|
20429
|
+
"attribute": "nav-id",
|
20390
20430
|
"reflects": true
|
20391
20431
|
},
|
20392
20432
|
{
|
@@ -20396,139 +20436,1887 @@
|
|
20396
20436
|
"text": "string | null"
|
20397
20437
|
},
|
20398
20438
|
"default": "null",
|
20399
|
-
"description": "
|
20400
|
-
"attribute": "aria-label"
|
20439
|
+
"description": "Aria-label attribute to be set for accessibility",
|
20440
|
+
"attribute": "aria-label"
|
20441
|
+
},
|
20442
|
+
{
|
20443
|
+
"kind": "field",
|
20444
|
+
"name": "disableAriaCurrent",
|
20445
|
+
"type": {
|
20446
|
+
"text": "boolean | undefined"
|
20447
|
+
},
|
20448
|
+
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navitem\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.",
|
20449
|
+
"attribute": "disable-aria-current",
|
20401
20450
|
"reflects": true
|
20402
20451
|
},
|
20403
20452
|
{
|
20404
20453
|
"kind": "method",
|
20405
|
-
"name": "
|
20454
|
+
"name": "isNested",
|
20406
20455
|
"privacy": "private",
|
20407
|
-
"
|
20456
|
+
"return": {
|
20457
|
+
"type": {
|
20458
|
+
"text": "boolean"
|
20459
|
+
}
|
20460
|
+
},
|
20461
|
+
"description": "Check whether the navitem 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."
|
20408
20462
|
},
|
20409
20463
|
{
|
20410
20464
|
"kind": "method",
|
20411
|
-
"name": "
|
20465
|
+
"name": "handleClickEvent",
|
20412
20466
|
"privacy": "private",
|
20413
20467
|
"return": {
|
20414
20468
|
"type": {
|
20415
20469
|
"text": "void"
|
20416
20470
|
}
|
20417
|
-
}
|
20471
|
+
}
|
20472
|
+
},
|
20473
|
+
{
|
20474
|
+
"kind": "method",
|
20475
|
+
"name": "renderTextLabel",
|
20476
|
+
"privacy": "private",
|
20418
20477
|
"parameters": [
|
20419
20478
|
{
|
20420
|
-
"name": "
|
20479
|
+
"name": "label",
|
20421
20480
|
"type": {
|
20422
|
-
"text": "string"
|
20481
|
+
"text": "string | undefined"
|
20423
20482
|
}
|
20424
|
-
}
|
20483
|
+
}
|
20484
|
+
]
|
20485
|
+
},
|
20486
|
+
{
|
20487
|
+
"kind": "method",
|
20488
|
+
"name": "renderArrowIcon",
|
20489
|
+
"privacy": "private",
|
20490
|
+
"parameters": [
|
20425
20491
|
{
|
20426
|
-
"name": "
|
20492
|
+
"name": "showLabel",
|
20427
20493
|
"type": {
|
20428
|
-
"text": "
|
20494
|
+
"text": "boolean | undefined"
|
20429
20495
|
}
|
20430
20496
|
}
|
20431
|
-
]
|
20432
|
-
"description": "Updates the attribute of the option to reflect the current state."
|
20497
|
+
]
|
20433
20498
|
},
|
20434
20499
|
{
|
20435
|
-
"kind": "
|
20436
|
-
"name": "
|
20437
|
-
"
|
20438
|
-
|
20439
|
-
|
20440
|
-
|
20441
|
-
|
20442
|
-
|
20443
|
-
|
20444
|
-
|
20445
|
-
|
20446
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
20447
|
-
}
|
20500
|
+
"kind": "method",
|
20501
|
+
"name": "renderBadge",
|
20502
|
+
"privacy": "private",
|
20503
|
+
"parameters": [
|
20504
|
+
{
|
20505
|
+
"name": "showLabel",
|
20506
|
+
"type": {
|
20507
|
+
"text": "boolean | undefined"
|
20508
|
+
}
|
20509
|
+
}
|
20510
|
+
]
|
20448
20511
|
},
|
20449
20512
|
{
|
20450
20513
|
"kind": "field",
|
20451
|
-
"name": "
|
20514
|
+
"name": "iconName",
|
20452
20515
|
"type": {
|
20453
|
-
"text": "
|
20516
|
+
"text": "IconNames | undefined"
|
20454
20517
|
},
|
20455
|
-
"
|
20456
|
-
"
|
20457
|
-
"attribute": "value",
|
20458
|
-
"reflects": true,
|
20518
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
20519
|
+
"attribute": "icon-name",
|
20459
20520
|
"inheritedFrom": {
|
20460
|
-
"name": "
|
20461
|
-
"module": "utils/mixins/
|
20521
|
+
"name": "IconNameMixin",
|
20522
|
+
"module": "utils/mixins/IconNameMixin.js"
|
20462
20523
|
}
|
20463
20524
|
},
|
20464
20525
|
{
|
20465
20526
|
"kind": "field",
|
20466
|
-
"name": "
|
20527
|
+
"name": "arrowPosition",
|
20467
20528
|
"type": {
|
20468
|
-
"text": "
|
20529
|
+
"text": "ArrowPositions | undefined"
|
20469
20530
|
},
|
20470
|
-
"description": "
|
20471
|
-
"attribute": "
|
20531
|
+
"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.",
|
20532
|
+
"attribute": "arrow-position",
|
20472
20533
|
"reflects": true,
|
20473
20534
|
"inheritedFrom": {
|
20474
|
-
"name": "
|
20475
|
-
"module": "
|
20535
|
+
"name": "MenuItem",
|
20536
|
+
"module": "components/menuitem/menuitem.component.js"
|
20476
20537
|
}
|
20477
20538
|
},
|
20478
20539
|
{
|
20479
20540
|
"kind": "field",
|
20480
|
-
"name": "
|
20541
|
+
"name": "arrowDirection",
|
20481
20542
|
"type": {
|
20482
|
-
"text": "
|
20543
|
+
"text": "ArrowDirections | undefined"
|
20483
20544
|
},
|
20484
|
-
"
|
20485
|
-
"
|
20486
|
-
|
20487
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
20488
|
-
}
|
20489
|
-
},
|
20490
|
-
{
|
20491
|
-
"kind": "field",
|
20492
|
-
"name": "willValidate",
|
20493
|
-
"readonly": true,
|
20545
|
+
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
20546
|
+
"attribute": "arrow-direction",
|
20547
|
+
"reflects": true,
|
20494
20548
|
"inheritedFrom": {
|
20495
|
-
"name": "
|
20496
|
-
"module": "
|
20549
|
+
"name": "MenuItem",
|
20550
|
+
"module": "components/menuitem/menuitem.component.js"
|
20497
20551
|
}
|
20498
20552
|
},
|
20499
20553
|
{
|
20500
20554
|
"kind": "method",
|
20501
|
-
"name": "
|
20502
|
-
"
|
20555
|
+
"name": "renderTrailingControls",
|
20556
|
+
"privacy": "protected",
|
20557
|
+
"description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
20503
20558
|
"return": {
|
20504
20559
|
"type": {
|
20505
20560
|
"text": ""
|
20506
20561
|
}
|
20507
20562
|
},
|
20508
20563
|
"inheritedFrom": {
|
20509
|
-
"name": "
|
20510
|
-
"module": "
|
20564
|
+
"name": "ListItem",
|
20565
|
+
"module": "components/listitem/listitem.component.js"
|
20511
20566
|
}
|
20512
20567
|
},
|
20513
20568
|
{
|
20514
20569
|
"kind": "method",
|
20515
|
-
"name": "
|
20570
|
+
"name": "renderLeadingControls",
|
20571
|
+
"privacy": "protected",
|
20572
|
+
"description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
20516
20573
|
"return": {
|
20517
20574
|
"type": {
|
20518
|
-
"text": "
|
20575
|
+
"text": ""
|
20519
20576
|
}
|
20520
20577
|
},
|
20521
20578
|
"inheritedFrom": {
|
20522
|
-
"name": "
|
20523
|
-
"module": "
|
20524
|
-
}
|
20525
|
-
},
|
20526
|
-
{
|
20527
|
-
"kind": "
|
20528
|
-
"name": "
|
20529
|
-
"
|
20530
|
-
"
|
20531
|
-
|
20579
|
+
"name": "ListItem",
|
20580
|
+
"module": "components/listitem/listitem.component.js"
|
20581
|
+
}
|
20582
|
+
},
|
20583
|
+
{
|
20584
|
+
"kind": "field",
|
20585
|
+
"name": "disabled",
|
20586
|
+
"type": {
|
20587
|
+
"text": "boolean | undefined"
|
20588
|
+
},
|
20589
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
20590
|
+
"default": "undefined",
|
20591
|
+
"attribute": "disabled",
|
20592
|
+
"reflects": true,
|
20593
|
+
"inheritedFrom": {
|
20594
|
+
"name": "ListItem",
|
20595
|
+
"module": "components/listitem/listitem.component.js"
|
20596
|
+
}
|
20597
|
+
},
|
20598
|
+
{
|
20599
|
+
"kind": "field",
|
20600
|
+
"name": "tabIndex",
|
20601
|
+
"type": {
|
20602
|
+
"text": "number"
|
20603
|
+
},
|
20604
|
+
"default": "0",
|
20605
|
+
"description": "This property specifies the tab order of the element.",
|
20606
|
+
"attribute": "tabIndex",
|
20607
|
+
"reflects": true,
|
20608
|
+
"inheritedFrom": {
|
20609
|
+
"name": "ListItem",
|
20610
|
+
"module": "components/listitem/listitem.component.js"
|
20611
|
+
}
|
20612
|
+
},
|
20613
|
+
{
|
20614
|
+
"kind": "field",
|
20615
|
+
"name": "variant",
|
20616
|
+
"type": {
|
20617
|
+
"text": "ListItemVariants"
|
20618
|
+
},
|
20619
|
+
"description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
|
20620
|
+
"default": "'full-width'",
|
20621
|
+
"attribute": "variant",
|
20622
|
+
"reflects": true,
|
20623
|
+
"inheritedFrom": {
|
20624
|
+
"name": "ListItem",
|
20625
|
+
"module": "components/listitem/listitem.component.js"
|
20626
|
+
}
|
20627
|
+
},
|
20628
|
+
{
|
20629
|
+
"kind": "field",
|
20630
|
+
"name": "label",
|
20631
|
+
"type": {
|
20632
|
+
"text": "string | undefined"
|
20633
|
+
},
|
20634
|
+
"description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
|
20635
|
+
"attribute": "label",
|
20636
|
+
"reflects": true,
|
20637
|
+
"inheritedFrom": {
|
20638
|
+
"name": "ListItem",
|
20639
|
+
"module": "components/listitem/listitem.component.js"
|
20640
|
+
}
|
20641
|
+
},
|
20642
|
+
{
|
20643
|
+
"kind": "field",
|
20644
|
+
"name": "secondaryLabel",
|
20645
|
+
"type": {
|
20646
|
+
"text": "string | undefined"
|
20647
|
+
},
|
20648
|
+
"description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
|
20649
|
+
"attribute": "secondary-label",
|
20650
|
+
"reflects": true,
|
20651
|
+
"inheritedFrom": {
|
20652
|
+
"name": "ListItem",
|
20653
|
+
"module": "components/listitem/listitem.component.js"
|
20654
|
+
}
|
20655
|
+
},
|
20656
|
+
{
|
20657
|
+
"kind": "field",
|
20658
|
+
"name": "tertiaryLabel",
|
20659
|
+
"type": {
|
20660
|
+
"text": "string | undefined"
|
20661
|
+
},
|
20662
|
+
"description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
|
20663
|
+
"attribute": "tertiary-label",
|
20664
|
+
"reflects": true,
|
20665
|
+
"inheritedFrom": {
|
20666
|
+
"name": "ListItem",
|
20667
|
+
"module": "components/listitem/listitem.component.js"
|
20668
|
+
}
|
20669
|
+
},
|
20670
|
+
{
|
20671
|
+
"kind": "field",
|
20672
|
+
"name": "sideHeaderText",
|
20673
|
+
"type": {
|
20674
|
+
"text": "string | undefined"
|
20675
|
+
},
|
20676
|
+
"description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
|
20677
|
+
"attribute": "side-header-text",
|
20678
|
+
"reflects": true,
|
20679
|
+
"inheritedFrom": {
|
20680
|
+
"name": "ListItem",
|
20681
|
+
"module": "components/listitem/listitem.component.js"
|
20682
|
+
}
|
20683
|
+
},
|
20684
|
+
{
|
20685
|
+
"kind": "field",
|
20686
|
+
"name": "sublineText",
|
20687
|
+
"type": {
|
20688
|
+
"text": "string | undefined"
|
20689
|
+
},
|
20690
|
+
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
20691
|
+
"attribute": "subline-text",
|
20692
|
+
"reflects": true,
|
20693
|
+
"inheritedFrom": {
|
20694
|
+
"name": "ListItem",
|
20695
|
+
"module": "components/listitem/listitem.component.js"
|
20696
|
+
}
|
20697
|
+
},
|
20698
|
+
{
|
20699
|
+
"kind": "field",
|
20700
|
+
"name": "tooltipText",
|
20701
|
+
"type": {
|
20702
|
+
"text": "string | undefined"
|
20703
|
+
},
|
20704
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
20705
|
+
"attribute": "tooltip-text",
|
20706
|
+
"reflects": true,
|
20707
|
+
"inheritedFrom": {
|
20708
|
+
"name": "ListItem",
|
20709
|
+
"module": "components/listitem/listitem.component.js"
|
20710
|
+
}
|
20711
|
+
},
|
20712
|
+
{
|
20713
|
+
"kind": "field",
|
20714
|
+
"name": "tooltipPlacement",
|
20715
|
+
"type": {
|
20716
|
+
"text": "PopoverPlacement"
|
20717
|
+
},
|
20718
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
20719
|
+
"default": "'top'",
|
20720
|
+
"attribute": "tooltip-placement",
|
20721
|
+
"reflects": true,
|
20722
|
+
"inheritedFrom": {
|
20723
|
+
"name": "ListItem",
|
20724
|
+
"module": "components/listitem/listitem.component.js"
|
20725
|
+
}
|
20726
|
+
},
|
20727
|
+
{
|
20728
|
+
"kind": "method",
|
20729
|
+
"name": "handleKeyDown",
|
20730
|
+
"privacy": "private",
|
20731
|
+
"return": {
|
20732
|
+
"type": {
|
20733
|
+
"text": "void"
|
20734
|
+
}
|
20735
|
+
},
|
20736
|
+
"parameters": [
|
20737
|
+
{
|
20738
|
+
"name": "event",
|
20739
|
+
"type": {
|
20740
|
+
"text": "KeyboardEvent"
|
20741
|
+
},
|
20742
|
+
"description": "The keyboard event triggered when a key is pressed down."
|
20743
|
+
}
|
20744
|
+
],
|
20745
|
+
"description": "Fires the click event when the enter or space key is pressed.",
|
20746
|
+
"inheritedFrom": {
|
20747
|
+
"name": "ListItem",
|
20748
|
+
"module": "components/listitem/listitem.component.js"
|
20749
|
+
}
|
20750
|
+
},
|
20751
|
+
{
|
20752
|
+
"kind": "method",
|
20753
|
+
"name": "triggerClickEvent",
|
20754
|
+
"privacy": "private",
|
20755
|
+
"description": "Triggers a click event on the list item.",
|
20756
|
+
"inheritedFrom": {
|
20757
|
+
"name": "ListItem",
|
20758
|
+
"module": "components/listitem/listitem.component.js"
|
20759
|
+
}
|
20760
|
+
},
|
20761
|
+
{
|
20762
|
+
"kind": "method",
|
20763
|
+
"name": "handleClick",
|
20764
|
+
"privacy": "private",
|
20765
|
+
"return": {
|
20766
|
+
"type": {
|
20767
|
+
"text": "void"
|
20768
|
+
}
|
20769
|
+
},
|
20770
|
+
"description": "Handles the click event on the list item.\nIf the tooltip is open, it has to be closed first.",
|
20771
|
+
"inheritedFrom": {
|
20772
|
+
"name": "ListItem",
|
20773
|
+
"module": "components/listitem/listitem.component.js"
|
20774
|
+
}
|
20775
|
+
},
|
20776
|
+
{
|
20777
|
+
"kind": "method",
|
20778
|
+
"name": "displayTooltipForLongText",
|
20779
|
+
"privacy": "private",
|
20780
|
+
"return": {
|
20781
|
+
"type": {
|
20782
|
+
"text": "void"
|
20783
|
+
}
|
20784
|
+
},
|
20785
|
+
"description": "Display a tooltip for the listitem.\nCreate the tooltip programmatically after the nearest parent element.",
|
20786
|
+
"inheritedFrom": {
|
20787
|
+
"name": "ListItem",
|
20788
|
+
"module": "components/listitem/listitem.component.js"
|
20789
|
+
}
|
20790
|
+
},
|
20791
|
+
{
|
20792
|
+
"kind": "method",
|
20793
|
+
"name": "hideTooltipOnLeave",
|
20794
|
+
"privacy": "private",
|
20795
|
+
"return": {
|
20796
|
+
"type": {
|
20797
|
+
"text": "void"
|
20798
|
+
}
|
20799
|
+
},
|
20800
|
+
"description": "Removes the dynamically created tooltip for long text label on focus or mouse leave.\nThis is triggered on focusout and mouseout events.",
|
20801
|
+
"inheritedFrom": {
|
20802
|
+
"name": "ListItem",
|
20803
|
+
"module": "components/listitem/listitem.component.js"
|
20804
|
+
}
|
20805
|
+
},
|
20806
|
+
{
|
20807
|
+
"kind": "method",
|
20808
|
+
"name": "getText",
|
20809
|
+
"privacy": "protected",
|
20810
|
+
"return": {
|
20811
|
+
"type": {
|
20812
|
+
"text": ""
|
20813
|
+
}
|
20814
|
+
},
|
20815
|
+
"parameters": [
|
20816
|
+
{
|
20817
|
+
"name": "slotName",
|
20818
|
+
"type": {
|
20819
|
+
"text": "string"
|
20820
|
+
},
|
20821
|
+
"description": "The name of the slot to be used."
|
20822
|
+
},
|
20823
|
+
{
|
20824
|
+
"name": "type",
|
20825
|
+
"type": {
|
20826
|
+
"text": "TextType"
|
20827
|
+
},
|
20828
|
+
"description": "The type of the text element."
|
20829
|
+
},
|
20830
|
+
{
|
20831
|
+
"name": "content",
|
20832
|
+
"optional": true,
|
20833
|
+
"type": {
|
20834
|
+
"text": "string"
|
20835
|
+
},
|
20836
|
+
"description": "The text content to be displayed within the slot."
|
20837
|
+
}
|
20838
|
+
],
|
20839
|
+
"description": "Generates a template for a text slot with the specified content.",
|
20840
|
+
"inheritedFrom": {
|
20841
|
+
"name": "ListItem",
|
20842
|
+
"module": "components/listitem/listitem.component.js"
|
20843
|
+
}
|
20844
|
+
},
|
20845
|
+
{
|
20846
|
+
"kind": "method",
|
20847
|
+
"name": "disableSlottedChildren",
|
20848
|
+
"privacy": "private",
|
20849
|
+
"return": {
|
20850
|
+
"type": {
|
20851
|
+
"text": "void"
|
20852
|
+
}
|
20853
|
+
},
|
20854
|
+
"parameters": [
|
20855
|
+
{
|
20856
|
+
"name": "disabled",
|
20857
|
+
"type": {
|
20858
|
+
"text": "boolean"
|
20859
|
+
},
|
20860
|
+
"description": "Whether to disable or enable the controls."
|
20861
|
+
}
|
20862
|
+
],
|
20863
|
+
"description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls.",
|
20864
|
+
"inheritedFrom": {
|
20865
|
+
"name": "ListItem",
|
20866
|
+
"module": "components/listitem/listitem.component.js"
|
20867
|
+
}
|
20868
|
+
},
|
20869
|
+
{
|
20870
|
+
"kind": "method",
|
20871
|
+
"name": "stopEventPropagation",
|
20872
|
+
"privacy": "protected",
|
20873
|
+
"return": {
|
20874
|
+
"type": {
|
20875
|
+
"text": "void"
|
20876
|
+
}
|
20877
|
+
},
|
20878
|
+
"parameters": [
|
20879
|
+
{
|
20880
|
+
"name": "event",
|
20881
|
+
"type": {
|
20882
|
+
"text": "Event"
|
20883
|
+
},
|
20884
|
+
"description": "The mouse event triggered when a click occurs."
|
20885
|
+
}
|
20886
|
+
],
|
20887
|
+
"description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
|
20888
|
+
"inheritedFrom": {
|
20889
|
+
"name": "ListItem",
|
20890
|
+
"module": "components/listitem/listitem.component.js"
|
20891
|
+
}
|
20892
|
+
}
|
20893
|
+
],
|
20894
|
+
"events": [
|
20895
|
+
{
|
20896
|
+
"description": "(React: onClick) This event is dispatched when the navitem is clicked.",
|
20897
|
+
"name": "click",
|
20898
|
+
"reactName": "onClick",
|
20899
|
+
"inheritedFrom": {
|
20900
|
+
"name": "ListItem",
|
20901
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20902
|
+
}
|
20903
|
+
},
|
20904
|
+
{
|
20905
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navitem.",
|
20906
|
+
"name": "keydown",
|
20907
|
+
"reactName": "onKeyDown",
|
20908
|
+
"inheritedFrom": {
|
20909
|
+
"name": "ListItem",
|
20910
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20911
|
+
}
|
20912
|
+
},
|
20913
|
+
{
|
20914
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the navitem.",
|
20915
|
+
"name": "keyup",
|
20916
|
+
"reactName": "onKeyUp",
|
20917
|
+
"inheritedFrom": {
|
20918
|
+
"name": "ListItem",
|
20919
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20920
|
+
}
|
20921
|
+
},
|
20922
|
+
{
|
20923
|
+
"description": "(React: onFocus) This event is dispatched when the navitem receives focus.",
|
20924
|
+
"name": "focus",
|
20925
|
+
"reactName": "onFocus",
|
20926
|
+
"inheritedFrom": {
|
20927
|
+
"name": "ListItem",
|
20928
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20929
|
+
}
|
20930
|
+
},
|
20931
|
+
{
|
20932
|
+
"description": "(React: onActiveChange) Dispatched when the active state of the navitem changes.",
|
20933
|
+
"name": "activechange",
|
20934
|
+
"reactName": "onActiveChange"
|
20935
|
+
}
|
20936
|
+
],
|
20937
|
+
"attributes": [
|
20938
|
+
{
|
20939
|
+
"name": "active",
|
20940
|
+
"type": {
|
20941
|
+
"text": "boolean | undefined"
|
20942
|
+
},
|
20943
|
+
"description": "The navitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navitem is in an inactive state, indicating it is toggled off.",
|
20944
|
+
"default": "undefined",
|
20945
|
+
"fieldName": "active"
|
20946
|
+
},
|
20947
|
+
{
|
20948
|
+
"name": "badge-type",
|
20949
|
+
"type": {
|
20950
|
+
"text": "BadgeType | undefined"
|
20951
|
+
},
|
20952
|
+
"description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
|
20953
|
+
"fieldName": "badgeType"
|
20954
|
+
},
|
20955
|
+
{
|
20956
|
+
"name": "counter",
|
20957
|
+
"type": {
|
20958
|
+
"text": "number | undefined"
|
20959
|
+
},
|
20960
|
+
"description": "Counter is the number which can be provided in the badge.",
|
20961
|
+
"fieldName": "counter"
|
20962
|
+
},
|
20963
|
+
{
|
20964
|
+
"name": "max-counter",
|
20965
|
+
"type": {
|
20966
|
+
"text": "number"
|
20967
|
+
},
|
20968
|
+
"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`.",
|
20969
|
+
"default": "99",
|
20970
|
+
"fieldName": "maxCounter"
|
20971
|
+
},
|
20972
|
+
{
|
20973
|
+
"name": "nav-id",
|
20974
|
+
"type": {
|
20975
|
+
"text": "string | undefined"
|
20976
|
+
},
|
20977
|
+
"description": "Id of the navItem (used as a identificator when used in the navItemList)\nNote: It has to be unique.",
|
20978
|
+
"default": "undefined",
|
20979
|
+
"fieldName": "navId"
|
20980
|
+
},
|
20981
|
+
{
|
20982
|
+
"name": "aria-label",
|
20983
|
+
"type": {
|
20984
|
+
"text": "string | null"
|
20985
|
+
},
|
20986
|
+
"default": "null",
|
20987
|
+
"description": "Aria-label attribute to be set for accessibility",
|
20988
|
+
"fieldName": "ariaLabel"
|
20989
|
+
},
|
20990
|
+
{
|
20991
|
+
"name": "disable-aria-current",
|
20992
|
+
"type": {
|
20993
|
+
"text": "boolean | undefined"
|
20994
|
+
},
|
20995
|
+
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navitem\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.",
|
20996
|
+
"fieldName": "disableAriaCurrent"
|
20997
|
+
},
|
20998
|
+
{
|
20999
|
+
"name": "icon-name",
|
21000
|
+
"type": {
|
21001
|
+
"text": "IconNames | undefined"
|
21002
|
+
},
|
21003
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
21004
|
+
"fieldName": "iconName",
|
21005
|
+
"inheritedFrom": {
|
21006
|
+
"name": "IconNameMixin",
|
21007
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
21008
|
+
}
|
21009
|
+
},
|
21010
|
+
{
|
21011
|
+
"name": "arrow-position",
|
21012
|
+
"type": {
|
21013
|
+
"text": "ArrowPositions | undefined"
|
21014
|
+
},
|
21015
|
+
"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.",
|
21016
|
+
"fieldName": "arrowPosition",
|
21017
|
+
"inheritedFrom": {
|
21018
|
+
"name": "MenuItem",
|
21019
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
21020
|
+
}
|
21021
|
+
},
|
21022
|
+
{
|
21023
|
+
"name": "arrow-direction",
|
21024
|
+
"type": {
|
21025
|
+
"text": "ArrowDirections | undefined"
|
21026
|
+
},
|
21027
|
+
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
21028
|
+
"fieldName": "arrowDirection",
|
21029
|
+
"inheritedFrom": {
|
21030
|
+
"name": "MenuItem",
|
21031
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
21032
|
+
}
|
21033
|
+
},
|
21034
|
+
{
|
21035
|
+
"name": "disabled",
|
21036
|
+
"type": {
|
21037
|
+
"text": "boolean | undefined"
|
21038
|
+
},
|
21039
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
21040
|
+
"default": "undefined",
|
21041
|
+
"fieldName": "disabled",
|
21042
|
+
"inheritedFrom": {
|
21043
|
+
"name": "ListItem",
|
21044
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21045
|
+
}
|
21046
|
+
},
|
21047
|
+
{
|
21048
|
+
"name": "tabIndex",
|
21049
|
+
"type": {
|
21050
|
+
"text": "number"
|
21051
|
+
},
|
21052
|
+
"default": "0",
|
21053
|
+
"description": "This property specifies the tab order of the element.",
|
21054
|
+
"fieldName": "tabIndex",
|
21055
|
+
"inheritedFrom": {
|
21056
|
+
"name": "ListItem",
|
21057
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21058
|
+
}
|
21059
|
+
},
|
21060
|
+
{
|
21061
|
+
"name": "variant",
|
21062
|
+
"type": {
|
21063
|
+
"text": "ListItemVariants"
|
21064
|
+
},
|
21065
|
+
"description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
|
21066
|
+
"default": "'full-width'",
|
21067
|
+
"fieldName": "variant",
|
21068
|
+
"inheritedFrom": {
|
21069
|
+
"name": "ListItem",
|
21070
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21071
|
+
}
|
21072
|
+
},
|
21073
|
+
{
|
21074
|
+
"name": "label",
|
21075
|
+
"type": {
|
21076
|
+
"text": "string | undefined"
|
21077
|
+
},
|
21078
|
+
"description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
|
21079
|
+
"fieldName": "label",
|
21080
|
+
"inheritedFrom": {
|
21081
|
+
"name": "ListItem",
|
21082
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21083
|
+
}
|
21084
|
+
},
|
21085
|
+
{
|
21086
|
+
"name": "secondary-label",
|
21087
|
+
"type": {
|
21088
|
+
"text": "string | undefined"
|
21089
|
+
},
|
21090
|
+
"description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
|
21091
|
+
"fieldName": "secondaryLabel",
|
21092
|
+
"inheritedFrom": {
|
21093
|
+
"name": "ListItem",
|
21094
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21095
|
+
}
|
21096
|
+
},
|
21097
|
+
{
|
21098
|
+
"name": "tertiary-label",
|
21099
|
+
"type": {
|
21100
|
+
"text": "string | undefined"
|
21101
|
+
},
|
21102
|
+
"description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
|
21103
|
+
"fieldName": "tertiaryLabel",
|
21104
|
+
"inheritedFrom": {
|
21105
|
+
"name": "ListItem",
|
21106
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21107
|
+
}
|
21108
|
+
},
|
21109
|
+
{
|
21110
|
+
"name": "side-header-text",
|
21111
|
+
"type": {
|
21112
|
+
"text": "string | undefined"
|
21113
|
+
},
|
21114
|
+
"description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
|
21115
|
+
"fieldName": "sideHeaderText",
|
21116
|
+
"inheritedFrom": {
|
21117
|
+
"name": "ListItem",
|
21118
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21119
|
+
}
|
21120
|
+
},
|
21121
|
+
{
|
21122
|
+
"name": "subline-text",
|
21123
|
+
"type": {
|
21124
|
+
"text": "string | undefined"
|
21125
|
+
},
|
21126
|
+
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
21127
|
+
"fieldName": "sublineText",
|
21128
|
+
"inheritedFrom": {
|
21129
|
+
"name": "ListItem",
|
21130
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21131
|
+
}
|
21132
|
+
},
|
21133
|
+
{
|
21134
|
+
"name": "tooltip-text",
|
21135
|
+
"type": {
|
21136
|
+
"text": "string | undefined"
|
21137
|
+
},
|
21138
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
21139
|
+
"fieldName": "tooltipText",
|
21140
|
+
"inheritedFrom": {
|
21141
|
+
"name": "ListItem",
|
21142
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21143
|
+
}
|
21144
|
+
},
|
21145
|
+
{
|
21146
|
+
"name": "tooltip-placement",
|
21147
|
+
"type": {
|
21148
|
+
"text": "PopoverPlacement"
|
21149
|
+
},
|
21150
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
21151
|
+
"default": "'top'",
|
21152
|
+
"fieldName": "tooltipPlacement",
|
21153
|
+
"inheritedFrom": {
|
21154
|
+
"name": "ListItem",
|
21155
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21156
|
+
}
|
21157
|
+
}
|
21158
|
+
],
|
21159
|
+
"mixins": [
|
21160
|
+
{
|
21161
|
+
"name": "IconNameMixin",
|
21162
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
21163
|
+
}
|
21164
|
+
],
|
21165
|
+
"superclass": {
|
21166
|
+
"name": "MenuItem",
|
21167
|
+
"module": "/src/components/menuitem/menuitem.component"
|
21168
|
+
},
|
21169
|
+
"tagName": "mdc-navitem",
|
21170
|
+
"jsDoc": "/**\n * `mdc-navitem` 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-navitem` is intended to be used inside `mdc-navitemlist` 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 * @tagname mdc-navitem\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 navitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navitem.\n * @event focus - (React: onFocus) This event is dispatched when the navitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navitem changes.\n *\n * @cssproperty --mdc-navitem-color - Text color of the navitem in its normal state.\n * @cssproperty --mdc-navitem-border-color - Border color of the navitem in its normal state.\n * @cssproperty --mdc-navitem-disabled-color - Text color of the navitem when disabled.\n * @cssproperty --mdc-navitem-expanded-width - Width of the navItem when expanded.\n * @cssproperty --mdc-navitem-hover-background-color - Background color of the navitem when hovered.\n * @cssproperty --mdc-navitem-hover-active-background-color - Background color of the active navitem when hovered.\n * @cssproperty --mdc-navitem-pressed-background-color - Background color of the navitem when pressed.\n * @cssproperty --mdc-navitem-pressed-active-background-color - Background color of the active navitem when pressed.\n * @cssproperty --mdc-navitem-disabled-background-color - Background color of the navitem when disabled.\n * @cssproperty --mdc-navitem-disabled-active-background-color - Background color of the active navitem when disabled.\n * @cssproperty --mdc-navitem-rest-active-background-color - Background color of the active nav item in its rest state.\n */",
|
21171
|
+
"customElement": true,
|
21172
|
+
"slots": [
|
21173
|
+
{
|
21174
|
+
"description": "slot for list item controls to appear of leading end.",
|
21175
|
+
"name": "leading-controls",
|
21176
|
+
"inheritedFrom": {
|
21177
|
+
"name": "ListItem",
|
21178
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21179
|
+
}
|
21180
|
+
},
|
21181
|
+
{
|
21182
|
+
"description": "slot for list item primary label.",
|
21183
|
+
"name": "leading-text-primary-label",
|
21184
|
+
"inheritedFrom": {
|
21185
|
+
"name": "ListItem",
|
21186
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21187
|
+
}
|
21188
|
+
},
|
21189
|
+
{
|
21190
|
+
"description": "slot for list item secondary label.",
|
21191
|
+
"name": "leading-text-secondary-label",
|
21192
|
+
"inheritedFrom": {
|
21193
|
+
"name": "ListItem",
|
21194
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21195
|
+
}
|
21196
|
+
},
|
21197
|
+
{
|
21198
|
+
"description": "slot for list item tertiary label.",
|
21199
|
+
"name": "leading-text-tertiary-label",
|
21200
|
+
"inheritedFrom": {
|
21201
|
+
"name": "ListItem",
|
21202
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21203
|
+
}
|
21204
|
+
},
|
21205
|
+
{
|
21206
|
+
"description": "slot for list item side header text.",
|
21207
|
+
"name": "trailing-text-side-header",
|
21208
|
+
"inheritedFrom": {
|
21209
|
+
"name": "ListItem",
|
21210
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21211
|
+
}
|
21212
|
+
},
|
21213
|
+
{
|
21214
|
+
"description": "slot for list item subline text.",
|
21215
|
+
"name": "trailing-text-subline",
|
21216
|
+
"inheritedFrom": {
|
21217
|
+
"name": "ListItem",
|
21218
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21219
|
+
}
|
21220
|
+
},
|
21221
|
+
{
|
21222
|
+
"description": "slot for list item controls to appear of trailing end.",
|
21223
|
+
"name": "trailing-controls",
|
21224
|
+
"inheritedFrom": {
|
21225
|
+
"name": "ListItem",
|
21226
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21227
|
+
}
|
21228
|
+
}
|
21229
|
+
]
|
21230
|
+
}
|
21231
|
+
],
|
21232
|
+
"exports": [
|
21233
|
+
{
|
21234
|
+
"kind": "js",
|
21235
|
+
"name": "default",
|
21236
|
+
"declaration": {
|
21237
|
+
"name": "NavItem",
|
21238
|
+
"module": "components/navitem/navitem.component.js"
|
21239
|
+
}
|
21240
|
+
}
|
21241
|
+
]
|
21242
|
+
},
|
21243
|
+
{
|
21244
|
+
"kind": "javascript-module",
|
21245
|
+
"path": "components/navitemlist/navitemlist.component.js",
|
21246
|
+
"declarations": [
|
21247
|
+
{
|
21248
|
+
"kind": "class",
|
21249
|
+
"description": "`mdc-navitemlist` is a container component used to group multiple mdc-navitem elements into a navigation list.\nIt provides the structural foundation for organizing vertical nav items and\nensures consistent behavior and layout within side navigation patterns.\n\nNote: mdc-navitemlist is typically used within the sidenavigation component.",
|
21250
|
+
"name": "NavItemList",
|
21251
|
+
"slots": [
|
21252
|
+
{
|
21253
|
+
"description": "Slot for projecting one or more navigation items, optional section headers and dividers.",
|
21254
|
+
"name": "default",
|
21255
|
+
"inheritedFrom": {
|
21256
|
+
"name": "MenuBar",
|
21257
|
+
"module": "src/components/menubar/menubar.component.ts"
|
21258
|
+
}
|
21259
|
+
}
|
21260
|
+
],
|
21261
|
+
"members": [
|
21262
|
+
{
|
21263
|
+
"kind": "field",
|
21264
|
+
"name": "ariaLabel",
|
21265
|
+
"type": {
|
21266
|
+
"text": "string | null"
|
21267
|
+
},
|
21268
|
+
"default": "null",
|
21269
|
+
"description": "Aria-label attribute to be set for accessibility",
|
21270
|
+
"attribute": "aria-label"
|
21271
|
+
},
|
21272
|
+
{
|
21273
|
+
"kind": "field",
|
21274
|
+
"name": "navItems",
|
21275
|
+
"type": {
|
21276
|
+
"text": "NavItem[]"
|
21277
|
+
},
|
21278
|
+
"privacy": "private",
|
21279
|
+
"description": "Returns all nested, non-disabled mdc-navitem elements inside this component.",
|
21280
|
+
"readonly": true
|
21281
|
+
},
|
21282
|
+
{
|
21283
|
+
"kind": "field",
|
21284
|
+
"name": "ariaOrientation",
|
21285
|
+
"type": {
|
21286
|
+
"text": "Orientation"
|
21287
|
+
},
|
21288
|
+
"description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
|
21289
|
+
"default": "'horizontal'",
|
21290
|
+
"attribute": "aria-orientation",
|
21291
|
+
"reflects": true,
|
21292
|
+
"inheritedFrom": {
|
21293
|
+
"name": "MenuBar",
|
21294
|
+
"module": "components/menubar/menubar.component.js"
|
21295
|
+
}
|
21296
|
+
},
|
21297
|
+
{
|
21298
|
+
"kind": "method",
|
21299
|
+
"name": "setMenuBarPopoverValue",
|
21300
|
+
"privacy": "private",
|
21301
|
+
"parameters": [
|
21302
|
+
{
|
21303
|
+
"name": "value",
|
21304
|
+
"type": {
|
21305
|
+
"text": "boolean"
|
21306
|
+
},
|
21307
|
+
"description": "The value to set."
|
21308
|
+
}
|
21309
|
+
],
|
21310
|
+
"description": "Sets the value of the data-menu-popover-open attribute on the menu element.",
|
21311
|
+
"inheritedFrom": {
|
21312
|
+
"name": "MenuBar",
|
21313
|
+
"module": "components/menubar/menubar.component.js"
|
21314
|
+
}
|
21315
|
+
},
|
21316
|
+
{
|
21317
|
+
"kind": "method",
|
21318
|
+
"name": "isMenuPopoverOpen",
|
21319
|
+
"privacy": "private",
|
21320
|
+
"return": {
|
21321
|
+
"type": {
|
21322
|
+
"text": "boolean"
|
21323
|
+
}
|
21324
|
+
},
|
21325
|
+
"description": "Returns true if the data-menu-popover-open attribute on the menu element is set to 'true', false otherwise.",
|
21326
|
+
"inheritedFrom": {
|
21327
|
+
"name": "MenuBar",
|
21328
|
+
"module": "components/menubar/menubar.component.js"
|
21329
|
+
}
|
21330
|
+
},
|
21331
|
+
{
|
21332
|
+
"kind": "method",
|
21333
|
+
"name": "getCurrentIndex",
|
21334
|
+
"privacy": "private",
|
21335
|
+
"return": {
|
21336
|
+
"type": {
|
21337
|
+
"text": ""
|
21338
|
+
}
|
21339
|
+
},
|
21340
|
+
"parameters": [
|
21341
|
+
{
|
21342
|
+
"name": "target",
|
21343
|
+
"type": {
|
21344
|
+
"text": "EventTarget | null"
|
21345
|
+
},
|
21346
|
+
"description": "The target element to find the index of."
|
21347
|
+
}
|
21348
|
+
],
|
21349
|
+
"description": "Returns the index of the given target in the menuItems array.\nIf the target is not a menu item, but a child element of a menu item,\nit returns the index of the parent menu item.",
|
21350
|
+
"inheritedFrom": {
|
21351
|
+
"name": "MenuBar",
|
21352
|
+
"module": "components/menubar/menubar.component.js"
|
21353
|
+
}
|
21354
|
+
},
|
21355
|
+
{
|
21356
|
+
"kind": "method",
|
21357
|
+
"name": "updatePopoverPlacementBasedOnOrientation",
|
21358
|
+
"privacy": "protected",
|
21359
|
+
"return": {
|
21360
|
+
"type": {
|
21361
|
+
"text": "void"
|
21362
|
+
}
|
21363
|
+
},
|
21364
|
+
"description": "Updates the placement of the popover based on the aria-orientation property.",
|
21365
|
+
"inheritedFrom": {
|
21366
|
+
"name": "MenuBar",
|
21367
|
+
"module": "components/menubar/menubar.component.js"
|
21368
|
+
}
|
21369
|
+
},
|
21370
|
+
{
|
21371
|
+
"kind": "method",
|
21372
|
+
"name": "updateTabIndexAndFocusNewIndex",
|
21373
|
+
"privacy": "private",
|
21374
|
+
"parameters": [
|
21375
|
+
{
|
21376
|
+
"name": "menuItems",
|
21377
|
+
"type": {
|
21378
|
+
"text": "Array<HTMLElement>"
|
21379
|
+
},
|
21380
|
+
"description": "The list of menu items."
|
21381
|
+
},
|
21382
|
+
{
|
21383
|
+
"name": "currentIndex",
|
21384
|
+
"type": {
|
21385
|
+
"text": "number"
|
21386
|
+
},
|
21387
|
+
"description": "The current index of the focused menu item."
|
21388
|
+
},
|
21389
|
+
{
|
21390
|
+
"name": "newIndex",
|
21391
|
+
"type": {
|
21392
|
+
"text": "number"
|
21393
|
+
},
|
21394
|
+
"description": "The index of the new active element in the list."
|
21395
|
+
}
|
21396
|
+
],
|
21397
|
+
"description": "Updates the tabindex of the current index to -1 and the tabindex of the new index to 0,\neffectively setting the active element. This is used when navigating the menu via keyboard.",
|
21398
|
+
"inheritedFrom": {
|
21399
|
+
"name": "MenuBar",
|
21400
|
+
"module": "components/menubar/menubar.component.js"
|
21401
|
+
}
|
21402
|
+
},
|
21403
|
+
{
|
21404
|
+
"kind": "method",
|
21405
|
+
"name": "isValidMenu",
|
21406
|
+
"privacy": "private",
|
21407
|
+
"return": {
|
21408
|
+
"type": {
|
21409
|
+
"text": ""
|
21410
|
+
}
|
21411
|
+
},
|
21412
|
+
"parameters": [
|
21413
|
+
{
|
21414
|
+
"name": "tagName",
|
21415
|
+
"optional": true,
|
21416
|
+
"type": {
|
21417
|
+
"text": "string"
|
21418
|
+
},
|
21419
|
+
"description": "The tag name to check."
|
21420
|
+
}
|
21421
|
+
],
|
21422
|
+
"description": "Checks if the given tag name is a valid menu tag name.",
|
21423
|
+
"inheritedFrom": {
|
21424
|
+
"name": "MenuBar",
|
21425
|
+
"module": "components/menubar/menubar.component.js"
|
21426
|
+
}
|
21427
|
+
},
|
21428
|
+
{
|
21429
|
+
"kind": "method",
|
21430
|
+
"name": "isValidNavItemList",
|
21431
|
+
"privacy": "private",
|
21432
|
+
"return": {
|
21433
|
+
"type": {
|
21434
|
+
"text": ""
|
21435
|
+
}
|
21436
|
+
},
|
21437
|
+
"parameters": [
|
21438
|
+
{
|
21439
|
+
"name": "tagName",
|
21440
|
+
"optional": true,
|
21441
|
+
"type": {
|
21442
|
+
"text": "string"
|
21443
|
+
},
|
21444
|
+
"description": "The tag name to check."
|
21445
|
+
}
|
21446
|
+
],
|
21447
|
+
"description": "Checks if the given tag name is a valid navitemlist tag name.",
|
21448
|
+
"inheritedFrom": {
|
21449
|
+
"name": "MenuBar",
|
21450
|
+
"module": "components/menubar/menubar.component.js"
|
21451
|
+
}
|
21452
|
+
},
|
21453
|
+
{
|
21454
|
+
"kind": "method",
|
21455
|
+
"name": "isValidPopover",
|
21456
|
+
"privacy": "private",
|
21457
|
+
"return": {
|
21458
|
+
"type": {
|
21459
|
+
"text": ""
|
21460
|
+
}
|
21461
|
+
},
|
21462
|
+
"parameters": [
|
21463
|
+
{
|
21464
|
+
"name": "tagName",
|
21465
|
+
"optional": true,
|
21466
|
+
"type": {
|
21467
|
+
"text": "string"
|
21468
|
+
},
|
21469
|
+
"description": "The tag name to check."
|
21470
|
+
}
|
21471
|
+
],
|
21472
|
+
"description": "Checks if the given tag name is a valid menu popover tag name.",
|
21473
|
+
"inheritedFrom": {
|
21474
|
+
"name": "MenuBar",
|
21475
|
+
"module": "components/menubar/menubar.component.js"
|
21476
|
+
}
|
21477
|
+
},
|
21478
|
+
{
|
21479
|
+
"kind": "method",
|
21480
|
+
"name": "openPopover",
|
21481
|
+
"privacy": "private",
|
21482
|
+
"return": {
|
21483
|
+
"type": {
|
21484
|
+
"text": ""
|
21485
|
+
}
|
21486
|
+
},
|
21487
|
+
"parameters": [
|
21488
|
+
{
|
21489
|
+
"name": "index",
|
21490
|
+
"type": {
|
21491
|
+
"text": "number"
|
21492
|
+
},
|
21493
|
+
"description": "The index of the menu item to open the popover for."
|
21494
|
+
}
|
21495
|
+
],
|
21496
|
+
"description": "Opens the popover at the given index if it exists.",
|
21497
|
+
"inheritedFrom": {
|
21498
|
+
"name": "MenuBar",
|
21499
|
+
"module": "components/menubar/menubar.component.js"
|
21500
|
+
}
|
21501
|
+
},
|
21502
|
+
{
|
21503
|
+
"kind": "method",
|
21504
|
+
"name": "navigateToPrevMenuItem",
|
21505
|
+
"privacy": "private",
|
21506
|
+
"return": {
|
21507
|
+
"type": {
|
21508
|
+
"text": "void"
|
21509
|
+
}
|
21510
|
+
},
|
21511
|
+
"parameters": [
|
21512
|
+
{
|
21513
|
+
"name": "currentIndex",
|
21514
|
+
"type": {
|
21515
|
+
"text": "number"
|
21516
|
+
},
|
21517
|
+
"description": "The current index of the focused menu item."
|
21518
|
+
},
|
21519
|
+
{
|
21520
|
+
"name": "firstMenuIndex",
|
21521
|
+
"type": {
|
21522
|
+
"text": "number"
|
21523
|
+
},
|
21524
|
+
"description": "The index of the first menu item."
|
21525
|
+
},
|
21526
|
+
{
|
21527
|
+
"name": "lastMenuIndex",
|
21528
|
+
"type": {
|
21529
|
+
"text": "number"
|
21530
|
+
},
|
21531
|
+
"description": "The index of the last menu item."
|
21532
|
+
},
|
21533
|
+
{
|
21534
|
+
"name": "ariaOrientation",
|
21535
|
+
"type": {
|
21536
|
+
"text": "Orientation"
|
21537
|
+
},
|
21538
|
+
"description": "The orientation of the menu."
|
21539
|
+
}
|
21540
|
+
],
|
21541
|
+
"description": "Navigates to the previous menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0.",
|
21542
|
+
"inheritedFrom": {
|
21543
|
+
"name": "MenuBar",
|
21544
|
+
"module": "components/menubar/menubar.component.js"
|
21545
|
+
}
|
21546
|
+
},
|
21547
|
+
{
|
21548
|
+
"kind": "method",
|
21549
|
+
"name": "navigateToNextMenuItem",
|
21550
|
+
"privacy": "private",
|
21551
|
+
"return": {
|
21552
|
+
"type": {
|
21553
|
+
"text": "void"
|
21554
|
+
}
|
21555
|
+
},
|
21556
|
+
"parameters": [
|
21557
|
+
{
|
21558
|
+
"name": "currentIndex",
|
21559
|
+
"type": {
|
21560
|
+
"text": "number"
|
21561
|
+
},
|
21562
|
+
"description": "The current index of the focused menu item."
|
21563
|
+
},
|
21564
|
+
{
|
21565
|
+
"name": "firstMenuIndex",
|
21566
|
+
"type": {
|
21567
|
+
"text": "number"
|
21568
|
+
},
|
21569
|
+
"description": "The index of the first menu item."
|
21570
|
+
},
|
21571
|
+
{
|
21572
|
+
"name": "lastMenuIndex",
|
21573
|
+
"type": {
|
21574
|
+
"text": "number"
|
21575
|
+
},
|
21576
|
+
"description": "The index of the last menu item."
|
21577
|
+
},
|
21578
|
+
{
|
21579
|
+
"name": "ariaOrientation",
|
21580
|
+
"type": {
|
21581
|
+
"text": "Orientation"
|
21582
|
+
},
|
21583
|
+
"description": "The orientation of the menu."
|
21584
|
+
}
|
21585
|
+
],
|
21586
|
+
"description": "Navigates to the next menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0.",
|
21587
|
+
"inheritedFrom": {
|
21588
|
+
"name": "MenuBar",
|
21589
|
+
"module": "components/menubar/menubar.component.js"
|
21590
|
+
}
|
21591
|
+
},
|
21592
|
+
{
|
21593
|
+
"kind": "method",
|
21594
|
+
"name": "getParentMenuItemDetails",
|
21595
|
+
"privacy": "private",
|
21596
|
+
"return": {
|
21597
|
+
"type": {
|
21598
|
+
"text": ""
|
21599
|
+
}
|
21600
|
+
},
|
21601
|
+
"parameters": [
|
21602
|
+
{
|
21603
|
+
"name": "menuChildId",
|
21604
|
+
"type": {
|
21605
|
+
"text": "string"
|
21606
|
+
},
|
21607
|
+
"description": "The id of the menu child element."
|
21608
|
+
},
|
21609
|
+
{
|
21610
|
+
"name": "menu",
|
21611
|
+
"optional": true,
|
21612
|
+
"type": {
|
21613
|
+
"text": "HTMLElement | null"
|
21614
|
+
},
|
21615
|
+
"description": "The current menu element to start traversing from."
|
21616
|
+
}
|
21617
|
+
],
|
21618
|
+
"description": "Returns the parent menu item details for the given menu child id.\nIt recursively traverses up the DOM tree until it finds a menu or menubar element.",
|
21619
|
+
"inheritedFrom": {
|
21620
|
+
"name": "MenuBar",
|
21621
|
+
"module": "components/menubar/menubar.component.js"
|
21622
|
+
}
|
21623
|
+
},
|
21624
|
+
{
|
21625
|
+
"kind": "method",
|
21626
|
+
"name": "hideAllPopovers",
|
21627
|
+
"privacy": "private",
|
21628
|
+
"return": {
|
21629
|
+
"type": {
|
21630
|
+
"text": "void"
|
21631
|
+
}
|
21632
|
+
},
|
21633
|
+
"parameters": [
|
21634
|
+
{
|
21635
|
+
"name": "menu",
|
21636
|
+
"optional": true,
|
21637
|
+
"type": {
|
21638
|
+
"text": "HTMLElement | null"
|
21639
|
+
},
|
21640
|
+
"description": "The current menu element to start traversing from."
|
21641
|
+
}
|
21642
|
+
],
|
21643
|
+
"description": "Recursively hides all the popovers up the DOM tree until it finds a menu or menubar element.",
|
21644
|
+
"inheritedFrom": {
|
21645
|
+
"name": "MenuBar",
|
21646
|
+
"module": "components/menubar/menubar.component.js"
|
21647
|
+
}
|
21648
|
+
},
|
21649
|
+
{
|
21650
|
+
"kind": "method",
|
21651
|
+
"name": "navigateToPrevParentMenuItem",
|
21652
|
+
"privacy": "private",
|
21653
|
+
"return": {
|
21654
|
+
"type": {
|
21655
|
+
"text": "void"
|
21656
|
+
}
|
21657
|
+
},
|
21658
|
+
"parameters": [
|
21659
|
+
{
|
21660
|
+
"name": "currentIndex",
|
21661
|
+
"type": {
|
21662
|
+
"text": "number"
|
21663
|
+
},
|
21664
|
+
"description": "The current index of the focused menu item."
|
21665
|
+
},
|
21666
|
+
{
|
21667
|
+
"name": "key",
|
21668
|
+
"type": {
|
21669
|
+
"text": "string"
|
21670
|
+
}
|
21671
|
+
}
|
21672
|
+
],
|
21673
|
+
"description": "Recursively navigates up the DOM tree until it finds the previous menu item\nand updates the tabindex of the current index to -1 and the tabindex of the new index to 0.\nAlso opens the popover of the previous menu item.",
|
21674
|
+
"inheritedFrom": {
|
21675
|
+
"name": "MenuBar",
|
21676
|
+
"module": "components/menubar/menubar.component.js"
|
21677
|
+
}
|
21678
|
+
},
|
21679
|
+
{
|
21680
|
+
"kind": "method",
|
21681
|
+
"name": "closePopoverAndNavigateToPrevParentMenuItem",
|
21682
|
+
"privacy": "private",
|
21683
|
+
"return": {
|
21684
|
+
"type": {
|
21685
|
+
"text": "void"
|
21686
|
+
}
|
21687
|
+
},
|
21688
|
+
"parameters": [
|
21689
|
+
{
|
21690
|
+
"name": "currentIndex",
|
21691
|
+
"type": {
|
21692
|
+
"text": "number"
|
21693
|
+
},
|
21694
|
+
"description": "The current index of the focused menu item."
|
21695
|
+
},
|
21696
|
+
{
|
21697
|
+
"name": "key",
|
21698
|
+
"type": {
|
21699
|
+
"text": "string"
|
21700
|
+
}
|
21701
|
+
}
|
21702
|
+
],
|
21703
|
+
"description": "Closes the current menu popover and navigates to the previous parent menu item.",
|
21704
|
+
"inheritedFrom": {
|
21705
|
+
"name": "MenuBar",
|
21706
|
+
"module": "components/menubar/menubar.component.js"
|
21707
|
+
}
|
21708
|
+
},
|
21709
|
+
{
|
21710
|
+
"kind": "method",
|
21711
|
+
"name": "getParentMenuContents",
|
21712
|
+
"privacy": "private",
|
21713
|
+
"return": {
|
21714
|
+
"type": {
|
21715
|
+
"text": ""
|
21716
|
+
}
|
21717
|
+
},
|
21718
|
+
"parameters": [
|
21719
|
+
{
|
21720
|
+
"name": "currentMenuItem",
|
21721
|
+
"type": {
|
21722
|
+
"text": "HTMLElement | null"
|
21723
|
+
},
|
21724
|
+
"description": "The current menu item to start traversing from."
|
21725
|
+
}
|
21726
|
+
],
|
21727
|
+
"description": "Gets the parent menu contents of the given current menu item.\nIt recursively traverses up the DOM tree until it finds the parent menu element\nand gets the parent menu item details and the children of the parent menu item.",
|
21728
|
+
"inheritedFrom": {
|
21729
|
+
"name": "MenuBar",
|
21730
|
+
"module": "components/menubar/menubar.component.js"
|
21731
|
+
}
|
21732
|
+
},
|
21733
|
+
{
|
21734
|
+
"kind": "method",
|
21735
|
+
"name": "openPopoverAndNavigateToNextChildrenMenuItem",
|
21736
|
+
"privacy": "private",
|
21737
|
+
"return": {
|
21738
|
+
"type": {
|
21739
|
+
"text": "void"
|
21740
|
+
}
|
21741
|
+
},
|
21742
|
+
"parameters": [
|
21743
|
+
{
|
21744
|
+
"name": "currentIndex",
|
21745
|
+
"type": {
|
21746
|
+
"text": "number"
|
21747
|
+
},
|
21748
|
+
"description": "The current index of the focused menu item."
|
21749
|
+
}
|
21750
|
+
],
|
21751
|
+
"description": "Opens the popover of the next children menu item if there are children.\nIf there are no children, then it closes all popovers recursively and\nnavigates to the next menu item from the menu bar.\nIf the parent menu item does not have any children, then we will go to the next menu item.",
|
21752
|
+
"inheritedFrom": {
|
21753
|
+
"name": "MenuBar",
|
21754
|
+
"module": "components/menubar/menubar.component.js"
|
21755
|
+
}
|
21756
|
+
},
|
21757
|
+
{
|
21758
|
+
"kind": "method",
|
21759
|
+
"name": "isValidMenuItem",
|
21760
|
+
"privacy": "private",
|
21761
|
+
"return": {
|
21762
|
+
"type": {
|
21763
|
+
"text": ""
|
21764
|
+
}
|
21765
|
+
},
|
21766
|
+
"parameters": [
|
21767
|
+
{
|
21768
|
+
"name": "menuItem",
|
21769
|
+
"type": {
|
21770
|
+
"text": "HTMLElement"
|
21771
|
+
},
|
21772
|
+
"description": "The menu item to check."
|
21773
|
+
}
|
21774
|
+
],
|
21775
|
+
"description": "Checks if the given menu item is a valid menu item.",
|
21776
|
+
"inheritedFrom": {
|
21777
|
+
"name": "MenuBar",
|
21778
|
+
"module": "components/menubar/menubar.component.js"
|
21779
|
+
}
|
21780
|
+
},
|
21781
|
+
{
|
21782
|
+
"kind": "method",
|
21783
|
+
"name": "resetTabIndexAndSetActiveTabIndex",
|
21784
|
+
"privacy": "private",
|
21785
|
+
"parameters": [
|
21786
|
+
{
|
21787
|
+
"name": "menuItems",
|
21788
|
+
"type": {
|
21789
|
+
"text": "Array<HTMLElement>"
|
21790
|
+
}
|
21791
|
+
},
|
21792
|
+
{
|
21793
|
+
"description": "The index of the new active element in the list.",
|
21794
|
+
"name": "newIndex"
|
21795
|
+
}
|
21796
|
+
],
|
21797
|
+
"description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard.",
|
21798
|
+
"inheritedFrom": {
|
21799
|
+
"name": "MenuBar",
|
21800
|
+
"module": "components/menubar/menubar.component.js"
|
21801
|
+
}
|
21802
|
+
},
|
21803
|
+
{
|
21804
|
+
"kind": "method",
|
21805
|
+
"name": "getKeyBasedOnDirection",
|
21806
|
+
"privacy": "private",
|
21807
|
+
"return": {
|
21808
|
+
"type": {
|
21809
|
+
"text": ""
|
21810
|
+
}
|
21811
|
+
},
|
21812
|
+
"parameters": [
|
21813
|
+
{
|
21814
|
+
"name": "originalKey",
|
21815
|
+
"type": {
|
21816
|
+
"text": "string"
|
21817
|
+
},
|
21818
|
+
"description": "The original key pressed."
|
21819
|
+
}
|
21820
|
+
],
|
21821
|
+
"description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction.",
|
21822
|
+
"inheritedFrom": {
|
21823
|
+
"name": "MenuBar",
|
21824
|
+
"module": "components/menubar/menubar.component.js"
|
21825
|
+
}
|
21826
|
+
},
|
21827
|
+
{
|
21828
|
+
"kind": "method",
|
21829
|
+
"name": "handleKeyDown",
|
21830
|
+
"privacy": "protected",
|
21831
|
+
"return": {
|
21832
|
+
"type": {
|
21833
|
+
"text": "void"
|
21834
|
+
}
|
21835
|
+
},
|
21836
|
+
"parameters": [
|
21837
|
+
{
|
21838
|
+
"name": "event",
|
21839
|
+
"type": {
|
21840
|
+
"text": "KeyboardEvent"
|
21841
|
+
},
|
21842
|
+
"description": "The keyboard event."
|
21843
|
+
}
|
21844
|
+
],
|
21845
|
+
"description": "Handles the keydown event on the menu bar.\nThe keys are as follows:\n- HOME: Sets focus to the first menu item.\n- END: Sets focus to the last menu item.\n- ARROW_LEFT:\n - If orientation is horizontal, then it navigates to the previous menu item.\n - If orientation is vertical, then it closes the popover of the current menu item and\n navigates to the previous parent menu item.\n- ARROW_RIGHT:\n - If orientation is horizontal, then it navigates to the next menu item.\n - If orientation is vertical, then it opens the popover of the current menu item and\n navigates to the next children menu item.\n- ARROW_UP:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the previous menu item.\n- ARROW_DOWN:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the next menu item.\n- SPACE:\n- ENTER:\n - If the next element sibling is a menu popover, then it opens the popover of the current\n menu item and navigates to the next children menu item.\n - If the target element is a menu item, then it closes all popovers recursively and\n navigates to the previous parent menu item.\n- ESCAPE:\n - If a popover is already open then we close it and navigate to the parent menu item.\n - If the current menuitem is a child of menubar, then we will set the value of isMenuPopoverOpen to false.,",
|
21846
|
+
"inheritedFrom": {
|
21847
|
+
"name": "MenuBar",
|
21848
|
+
"module": "components/menubar/menubar.component.js"
|
21849
|
+
}
|
21850
|
+
},
|
21851
|
+
{
|
21852
|
+
"kind": "method",
|
21853
|
+
"name": "closeAllPopoversExceptCurrent",
|
21854
|
+
"privacy": "private",
|
21855
|
+
"return": {
|
21856
|
+
"type": {
|
21857
|
+
"text": "void"
|
21858
|
+
}
|
21859
|
+
},
|
21860
|
+
"parameters": [
|
21861
|
+
{
|
21862
|
+
"name": "currentIndex",
|
21863
|
+
"type": {
|
21864
|
+
"text": "number"
|
21865
|
+
},
|
21866
|
+
"description": "The index of the current menu item."
|
21867
|
+
}
|
21868
|
+
],
|
21869
|
+
"description": "Closes all popovers except the current one.",
|
21870
|
+
"inheritedFrom": {
|
21871
|
+
"name": "MenuBar",
|
21872
|
+
"module": "components/menubar/menubar.component.js"
|
21873
|
+
}
|
21874
|
+
},
|
21875
|
+
{
|
21876
|
+
"kind": "method",
|
21877
|
+
"name": "handleMouseClick",
|
21878
|
+
"privacy": "protected",
|
21879
|
+
"return": {
|
21880
|
+
"type": {
|
21881
|
+
"text": "void"
|
21882
|
+
}
|
21883
|
+
},
|
21884
|
+
"parameters": [
|
21885
|
+
{
|
21886
|
+
"name": "event",
|
21887
|
+
"type": {
|
21888
|
+
"text": "MouseEvent"
|
21889
|
+
},
|
21890
|
+
"description": "The mouse click event."
|
21891
|
+
}
|
21892
|
+
],
|
21893
|
+
"description": "Handles the mouse click event on the menu items.\n- If the menuitem has children, then it opens the popover of the next children menu item.\n- If the menuitem does not have children, then it closes all popovers recursively.",
|
21894
|
+
"inheritedFrom": {
|
21895
|
+
"name": "MenuBar",
|
21896
|
+
"module": "components/menubar/menubar.component.js"
|
21897
|
+
}
|
21898
|
+
}
|
21899
|
+
],
|
21900
|
+
"attributes": [
|
21901
|
+
{
|
21902
|
+
"name": "aria-label",
|
21903
|
+
"type": {
|
21904
|
+
"text": "string | null"
|
21905
|
+
},
|
21906
|
+
"default": "null",
|
21907
|
+
"description": "Aria-label attribute to be set for accessibility",
|
21908
|
+
"fieldName": "ariaLabel"
|
21909
|
+
},
|
21910
|
+
{
|
21911
|
+
"name": "aria-orientation",
|
21912
|
+
"type": {
|
21913
|
+
"text": "Orientation"
|
21914
|
+
},
|
21915
|
+
"description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
|
21916
|
+
"default": "'horizontal'",
|
21917
|
+
"fieldName": "ariaOrientation",
|
21918
|
+
"inheritedFrom": {
|
21919
|
+
"name": "MenuBar",
|
21920
|
+
"module": "src/components/menubar/menubar.component.ts"
|
21921
|
+
}
|
21922
|
+
}
|
21923
|
+
],
|
21924
|
+
"mixins": [
|
21925
|
+
{
|
21926
|
+
"name": "MenuMixin",
|
21927
|
+
"module": "/src/utils/mixins/MenuMixin"
|
21928
|
+
}
|
21929
|
+
],
|
21930
|
+
"superclass": {
|
21931
|
+
"name": "MenuBar",
|
21932
|
+
"module": "/src/components/menubar/menubar.component"
|
21933
|
+
},
|
21934
|
+
"tagName": "mdc-navitemlist",
|
21935
|
+
"jsDoc": "/**\n * `mdc-navitemlist` is a container component used to group multiple mdc-navitem elements into a navigation list.\n * It provides the structural foundation for organizing vertical nav items and\n * ensures consistent behavior and layout within side navigation patterns.\n *\n * Note: mdc-navitemlist is typically used within the sidenavigation component.\n * @tagname mdc-navitemlist\n *\n * @slot default - Slot for projecting one or more navigation items, optional section headers and dividers.\n */",
|
21936
|
+
"customElement": true
|
21937
|
+
}
|
21938
|
+
],
|
21939
|
+
"exports": [
|
21940
|
+
{
|
21941
|
+
"kind": "js",
|
21942
|
+
"name": "default",
|
21943
|
+
"declaration": {
|
21944
|
+
"name": "NavItemList",
|
21945
|
+
"module": "components/navitemlist/navitemlist.component.js"
|
21946
|
+
}
|
21947
|
+
}
|
21948
|
+
]
|
21949
|
+
},
|
21950
|
+
{
|
21951
|
+
"kind": "javascript-module",
|
21952
|
+
"path": "components/optgroup/optgroup.component.js",
|
21953
|
+
"declarations": [
|
21954
|
+
{
|
21955
|
+
"kind": "class",
|
21956
|
+
"description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
|
21957
|
+
"name": "OptGroup",
|
21958
|
+
"cssProperties": [
|
21959
|
+
{
|
21960
|
+
"description": "Allows customization of the disabled option color.",
|
21961
|
+
"name": "--mdc-optgroup-disabled-color"
|
21962
|
+
}
|
21963
|
+
],
|
21964
|
+
"slots": [
|
21965
|
+
{
|
21966
|
+
"description": "This is a default slot for mdc-option elements.",
|
21967
|
+
"name": "default"
|
21968
|
+
}
|
21969
|
+
],
|
21970
|
+
"members": [
|
21971
|
+
{
|
21972
|
+
"kind": "field",
|
21973
|
+
"name": "label",
|
21974
|
+
"type": {
|
21975
|
+
"text": "string | undefined"
|
21976
|
+
},
|
21977
|
+
"description": "The header text to be displayed on the top of the options list.",
|
21978
|
+
"attribute": "label",
|
21979
|
+
"reflects": true
|
21980
|
+
},
|
21981
|
+
{
|
21982
|
+
"kind": "method",
|
21983
|
+
"name": "setDisabledForAllOptions",
|
21984
|
+
"privacy": "private",
|
21985
|
+
"return": {
|
21986
|
+
"type": {
|
21987
|
+
"text": "void"
|
21988
|
+
}
|
21989
|
+
}
|
21990
|
+
},
|
21991
|
+
{
|
21992
|
+
"kind": "field",
|
21993
|
+
"name": "dataAriaLabel",
|
21994
|
+
"type": {
|
21995
|
+
"text": "string | null"
|
21996
|
+
},
|
21997
|
+
"default": "null",
|
21998
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
21999
|
+
"attribute": "data-aria-label",
|
22000
|
+
"reflects": true,
|
22001
|
+
"inheritedFrom": {
|
22002
|
+
"name": "DataAriaLabelMixin",
|
22003
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
22004
|
+
}
|
22005
|
+
},
|
22006
|
+
{
|
22007
|
+
"kind": "field",
|
22008
|
+
"name": "disabled",
|
22009
|
+
"type": {
|
22010
|
+
"text": "boolean | undefined"
|
22011
|
+
},
|
22012
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
22013
|
+
"default": "undefined",
|
22014
|
+
"attribute": "disabled",
|
22015
|
+
"reflects": true,
|
22016
|
+
"inheritedFrom": {
|
22017
|
+
"name": "DisabledMixin",
|
22018
|
+
"module": "utils/mixins/DisabledMixin.js"
|
22019
|
+
}
|
22020
|
+
}
|
22021
|
+
],
|
22022
|
+
"attributes": [
|
22023
|
+
{
|
22024
|
+
"name": "label",
|
22025
|
+
"type": {
|
22026
|
+
"text": "string | undefined"
|
22027
|
+
},
|
22028
|
+
"description": "The header text to be displayed on the top of the options list.",
|
22029
|
+
"fieldName": "label"
|
22030
|
+
},
|
22031
|
+
{
|
22032
|
+
"name": "data-aria-label",
|
22033
|
+
"type": {
|
22034
|
+
"text": "string | null"
|
22035
|
+
},
|
22036
|
+
"default": "null",
|
22037
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
22038
|
+
"fieldName": "dataAriaLabel",
|
22039
|
+
"inheritedFrom": {
|
22040
|
+
"name": "DataAriaLabelMixin",
|
22041
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
22042
|
+
}
|
22043
|
+
},
|
22044
|
+
{
|
22045
|
+
"name": "disabled",
|
22046
|
+
"type": {
|
22047
|
+
"text": "boolean | undefined"
|
22048
|
+
},
|
22049
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
22050
|
+
"default": "undefined",
|
22051
|
+
"fieldName": "disabled",
|
22052
|
+
"inheritedFrom": {
|
22053
|
+
"name": "DisabledMixin",
|
22054
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
22055
|
+
}
|
22056
|
+
}
|
22057
|
+
],
|
22058
|
+
"mixins": [
|
22059
|
+
{
|
22060
|
+
"name": "DataAriaLabelMixin",
|
22061
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
22062
|
+
},
|
22063
|
+
{
|
22064
|
+
"name": "DisabledMixin",
|
22065
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
22066
|
+
}
|
22067
|
+
],
|
22068
|
+
"superclass": {
|
22069
|
+
"name": "Component",
|
22070
|
+
"module": "/src/models"
|
22071
|
+
},
|
22072
|
+
"tagName": "mdc-optgroup",
|
22073
|
+
"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 */",
|
22074
|
+
"customElement": true
|
22075
|
+
}
|
22076
|
+
],
|
22077
|
+
"exports": [
|
22078
|
+
{
|
22079
|
+
"kind": "js",
|
22080
|
+
"name": "default",
|
22081
|
+
"declaration": {
|
22082
|
+
"name": "OptGroup",
|
22083
|
+
"module": "components/optgroup/optgroup.component.js"
|
22084
|
+
}
|
22085
|
+
}
|
22086
|
+
]
|
22087
|
+
},
|
22088
|
+
{
|
22089
|
+
"kind": "javascript-module",
|
22090
|
+
"path": "components/option/option.component.js",
|
22091
|
+
"declarations": [
|
22092
|
+
{
|
22093
|
+
"kind": "class",
|
22094
|
+
"description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.\nWe can pass a tooltip which will be displayed on hover of the option label text.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
|
22095
|
+
"name": "Option",
|
22096
|
+
"slots": [
|
22097
|
+
{
|
22098
|
+
"description": "This is a default/unnamed slot",
|
22099
|
+
"name": "default"
|
22100
|
+
},
|
22101
|
+
{
|
22102
|
+
"description": "slot for list item controls to appear of leading end.",
|
22103
|
+
"name": "leading-controls",
|
22104
|
+
"inheritedFrom": {
|
22105
|
+
"name": "ListItem",
|
22106
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22107
|
+
}
|
22108
|
+
},
|
22109
|
+
{
|
22110
|
+
"description": "slot for list item primary label.",
|
22111
|
+
"name": "leading-text-primary-label",
|
22112
|
+
"inheritedFrom": {
|
22113
|
+
"name": "ListItem",
|
22114
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22115
|
+
}
|
22116
|
+
},
|
22117
|
+
{
|
22118
|
+
"description": "slot for list item secondary label.",
|
22119
|
+
"name": "leading-text-secondary-label",
|
22120
|
+
"inheritedFrom": {
|
22121
|
+
"name": "ListItem",
|
22122
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22123
|
+
}
|
22124
|
+
},
|
22125
|
+
{
|
22126
|
+
"description": "slot for list item tertiary label.",
|
22127
|
+
"name": "leading-text-tertiary-label",
|
22128
|
+
"inheritedFrom": {
|
22129
|
+
"name": "ListItem",
|
22130
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22131
|
+
}
|
22132
|
+
},
|
22133
|
+
{
|
22134
|
+
"description": "slot for list item side header text.",
|
22135
|
+
"name": "trailing-text-side-header",
|
22136
|
+
"inheritedFrom": {
|
22137
|
+
"name": "ListItem",
|
22138
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22139
|
+
}
|
22140
|
+
},
|
22141
|
+
{
|
22142
|
+
"description": "slot for list item subline text.",
|
22143
|
+
"name": "trailing-text-subline",
|
22144
|
+
"inheritedFrom": {
|
22145
|
+
"name": "ListItem",
|
22146
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22147
|
+
}
|
22148
|
+
},
|
22149
|
+
{
|
22150
|
+
"description": "slot for list item controls to appear of trailing end.",
|
22151
|
+
"name": "trailing-controls",
|
22152
|
+
"inheritedFrom": {
|
22153
|
+
"name": "ListItem",
|
22154
|
+
"module": "src/components/listitem/listitem.component.ts"
|
22155
|
+
}
|
22156
|
+
}
|
22157
|
+
],
|
22158
|
+
"members": [
|
22159
|
+
{
|
22160
|
+
"kind": "field",
|
22161
|
+
"name": "selected",
|
22162
|
+
"type": {
|
22163
|
+
"text": "boolean"
|
22164
|
+
},
|
22165
|
+
"default": "false",
|
22166
|
+
"description": "The selected attribute is used to indicate that the option is selected.",
|
22167
|
+
"attribute": "selected",
|
22168
|
+
"reflects": true
|
22169
|
+
},
|
22170
|
+
{
|
22171
|
+
"kind": "field",
|
22172
|
+
"name": "prefixIcon",
|
22173
|
+
"type": {
|
22174
|
+
"text": "IconNames | undefined"
|
22175
|
+
},
|
22176
|
+
"description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
|
22177
|
+
"attribute": "prefix-icon",
|
22178
|
+
"reflects": true
|
22179
|
+
},
|
22180
|
+
{
|
22181
|
+
"kind": "field",
|
22182
|
+
"name": "ariaLabel",
|
22183
|
+
"type": {
|
22184
|
+
"text": "string | null"
|
22185
|
+
},
|
22186
|
+
"default": "null",
|
22187
|
+
"description": "Any additional description can be provided here for screen readers.",
|
22188
|
+
"attribute": "aria-label",
|
22189
|
+
"reflects": true
|
22190
|
+
},
|
22191
|
+
{
|
22192
|
+
"kind": "method",
|
22193
|
+
"name": "handleDefaultSlotChange",
|
22194
|
+
"privacy": "private",
|
22195
|
+
"description": "Listens to changes in the default slot and updates the label of the option accordingly.\nThis is used to set the label of the option when it is not explicitly set.\nIt is called internally when the slot is changed."
|
22196
|
+
},
|
22197
|
+
{
|
22198
|
+
"kind": "method",
|
22199
|
+
"name": "updateAttribute",
|
22200
|
+
"privacy": "private",
|
22201
|
+
"return": {
|
22202
|
+
"type": {
|
22203
|
+
"text": "void"
|
22204
|
+
}
|
22205
|
+
},
|
22206
|
+
"parameters": [
|
22207
|
+
{
|
22208
|
+
"name": "attributeName",
|
22209
|
+
"type": {
|
22210
|
+
"text": "string"
|
22211
|
+
}
|
22212
|
+
},
|
22213
|
+
{
|
22214
|
+
"name": "value",
|
22215
|
+
"type": {
|
22216
|
+
"text": "string"
|
22217
|
+
}
|
22218
|
+
}
|
22219
|
+
],
|
22220
|
+
"description": "Updates the attribute of the option to reflect the current state."
|
22221
|
+
},
|
22222
|
+
{
|
22223
|
+
"kind": "field",
|
22224
|
+
"name": "name",
|
22225
|
+
"type": {
|
22226
|
+
"text": "string"
|
22227
|
+
},
|
22228
|
+
"default": "''",
|
22229
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
22230
|
+
"attribute": "name",
|
22231
|
+
"reflects": true,
|
22232
|
+
"inheritedFrom": {
|
22233
|
+
"name": "FormInternalsMixin",
|
22234
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22235
|
+
}
|
22236
|
+
},
|
22237
|
+
{
|
22238
|
+
"kind": "field",
|
22239
|
+
"name": "value",
|
22240
|
+
"type": {
|
22241
|
+
"text": "string"
|
22242
|
+
},
|
22243
|
+
"default": "''",
|
22244
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
22245
|
+
"attribute": "value",
|
22246
|
+
"reflects": true,
|
22247
|
+
"inheritedFrom": {
|
22248
|
+
"name": "FormInternalsMixin",
|
22249
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22250
|
+
}
|
22251
|
+
},
|
22252
|
+
{
|
22253
|
+
"kind": "field",
|
22254
|
+
"name": "validationMessage",
|
22255
|
+
"type": {
|
22256
|
+
"text": "string | undefined"
|
22257
|
+
},
|
22258
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
22259
|
+
"attribute": "validation-message",
|
22260
|
+
"reflects": true,
|
22261
|
+
"inheritedFrom": {
|
22262
|
+
"name": "FormInternalsMixin",
|
22263
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22264
|
+
}
|
22265
|
+
},
|
22266
|
+
{
|
22267
|
+
"kind": "field",
|
22268
|
+
"name": "validity",
|
22269
|
+
"type": {
|
22270
|
+
"text": "ValidityState"
|
22271
|
+
},
|
22272
|
+
"readonly": true,
|
22273
|
+
"inheritedFrom": {
|
22274
|
+
"name": "FormInternalsMixin",
|
22275
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22276
|
+
}
|
22277
|
+
},
|
22278
|
+
{
|
22279
|
+
"kind": "field",
|
22280
|
+
"name": "willValidate",
|
22281
|
+
"readonly": true,
|
22282
|
+
"inheritedFrom": {
|
22283
|
+
"name": "FormInternalsMixin",
|
22284
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22285
|
+
}
|
22286
|
+
},
|
22287
|
+
{
|
22288
|
+
"kind": "method",
|
22289
|
+
"name": "setValidity",
|
22290
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
22291
|
+
"return": {
|
22292
|
+
"type": {
|
22293
|
+
"text": ""
|
22294
|
+
}
|
22295
|
+
},
|
22296
|
+
"inheritedFrom": {
|
22297
|
+
"name": "FormInternalsMixin",
|
22298
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22299
|
+
}
|
22300
|
+
},
|
22301
|
+
{
|
22302
|
+
"kind": "method",
|
22303
|
+
"name": "checkValidity",
|
22304
|
+
"return": {
|
22305
|
+
"type": {
|
22306
|
+
"text": "boolean"
|
22307
|
+
}
|
22308
|
+
},
|
22309
|
+
"inheritedFrom": {
|
22310
|
+
"name": "FormInternalsMixin",
|
22311
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
22312
|
+
}
|
22313
|
+
},
|
22314
|
+
{
|
22315
|
+
"kind": "method",
|
22316
|
+
"name": "reportValidity",
|
22317
|
+
"inheritedFrom": {
|
22318
|
+
"name": "FormInternalsMixin",
|
22319
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
20532
22320
|
}
|
20533
22321
|
},
|
20534
22322
|
{
|
@@ -27310,6 +29098,165 @@
|
|
27310
29098
|
}
|
27311
29099
|
]
|
27312
29100
|
},
|
29101
|
+
{
|
29102
|
+
"kind": "javascript-module",
|
29103
|
+
"path": "components/sidenavigation/sidenavigation.component.js",
|
29104
|
+
"declarations": [
|
29105
|
+
{
|
29106
|
+
"kind": "class",
|
29107
|
+
"description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-navitemlist` and `mdc-navitem`\n\n### Usage:\nIn a sidenavigation, navitems can be used in the following ways:\n\n1. **Simple navitem** – No submenu or interaction beyond selection.\n\n2. **Navitem with submenu**:\n - Provide an `id` on the `mdc-navitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navitem` and `mdc-navitemlist`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
|
29108
|
+
"name": "SideNavigation",
|
29109
|
+
"cssProperties": [
|
29110
|
+
{
|
29111
|
+
"description": "width of the sideNavigation when expanded",
|
29112
|
+
"name": "--mdc-sidenavigation-expanded-width"
|
29113
|
+
},
|
29114
|
+
{
|
29115
|
+
"description": "width of the sideNavigation when collpased",
|
29116
|
+
"name": "--mdc-sidenavigation-collapsed-width"
|
29117
|
+
}
|
29118
|
+
],
|
29119
|
+
"slots": [
|
29120
|
+
{
|
29121
|
+
"description": "Slot for the scrollable content area of the side navigation.",
|
29122
|
+
"name": "scrollable-section"
|
29123
|
+
},
|
29124
|
+
{
|
29125
|
+
"description": "Slot for the fixed content area of the side navigation.",
|
29126
|
+
"name": "fixed-section"
|
29127
|
+
},
|
29128
|
+
{
|
29129
|
+
"description": "Slot for the brand logo (e.g., icon or img).",
|
29130
|
+
"name": "brand-logo"
|
29131
|
+
}
|
29132
|
+
],
|
29133
|
+
"members": [
|
29134
|
+
{
|
29135
|
+
"kind": "field",
|
29136
|
+
"name": "Context",
|
29137
|
+
"privacy": "public",
|
29138
|
+
"static": true,
|
29139
|
+
"readonly": true
|
29140
|
+
},
|
29141
|
+
{
|
29142
|
+
"kind": "field",
|
29143
|
+
"name": "variant",
|
29144
|
+
"type": {
|
29145
|
+
"text": "SideNavigationVariant"
|
29146
|
+
},
|
29147
|
+
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
29148
|
+
"default": "flexible",
|
29149
|
+
"attribute": "variant",
|
29150
|
+
"reflects": true
|
29151
|
+
},
|
29152
|
+
{
|
29153
|
+
"kind": "field",
|
29154
|
+
"name": "customerName",
|
29155
|
+
"type": {
|
29156
|
+
"text": "string"
|
29157
|
+
},
|
29158
|
+
"default": "''",
|
29159
|
+
"description": "Name of the customer. This is displayed in the bottom section of the side-navigation component.",
|
29160
|
+
"attribute": "customer-name",
|
29161
|
+
"reflects": true
|
29162
|
+
},
|
29163
|
+
{
|
29164
|
+
"kind": "field",
|
29165
|
+
"name": "grabberBtnAriaLabel",
|
29166
|
+
"type": {
|
29167
|
+
"text": "string | undefined"
|
29168
|
+
},
|
29169
|
+
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
29170
|
+
"default": "''",
|
29171
|
+
"attribute": "grabber-btn-aria-label",
|
29172
|
+
"reflects": true
|
29173
|
+
},
|
29174
|
+
{
|
29175
|
+
"kind": "field",
|
29176
|
+
"name": "parentNavTooltipText",
|
29177
|
+
"type": {
|
29178
|
+
"text": "string | undefined"
|
29179
|
+
},
|
29180
|
+
"description": "Tooltip text shown on parent nav items when a child is active.",
|
29181
|
+
"attribute": "parent-nav-tooltip-text",
|
29182
|
+
"reflects": true
|
29183
|
+
},
|
29184
|
+
{
|
29185
|
+
"kind": "method",
|
29186
|
+
"name": "updateContext",
|
29187
|
+
"privacy": "protected",
|
29188
|
+
"return": {
|
29189
|
+
"type": {
|
29190
|
+
"text": "void"
|
29191
|
+
}
|
29192
|
+
},
|
29193
|
+
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
29194
|
+
}
|
29195
|
+
],
|
29196
|
+
"events": [
|
29197
|
+
{
|
29198
|
+
"description": "(React: onActiveChange) Dispatched when the active state of the navitem changes.",
|
29199
|
+
"name": "activechange",
|
29200
|
+
"reactName": "onActiveChange"
|
29201
|
+
}
|
29202
|
+
],
|
29203
|
+
"attributes": [
|
29204
|
+
{
|
29205
|
+
"name": "variant",
|
29206
|
+
"type": {
|
29207
|
+
"text": "SideNavigationVariant"
|
29208
|
+
},
|
29209
|
+
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
29210
|
+
"default": "flexible",
|
29211
|
+
"fieldName": "variant"
|
29212
|
+
},
|
29213
|
+
{
|
29214
|
+
"name": "customer-name",
|
29215
|
+
"type": {
|
29216
|
+
"text": "string"
|
29217
|
+
},
|
29218
|
+
"default": "''",
|
29219
|
+
"description": "Name of the customer. This is displayed in the bottom section of the side-navigation component.",
|
29220
|
+
"fieldName": "customerName"
|
29221
|
+
},
|
29222
|
+
{
|
29223
|
+
"name": "grabber-btn-aria-label",
|
29224
|
+
"type": {
|
29225
|
+
"text": "string | undefined"
|
29226
|
+
},
|
29227
|
+
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
29228
|
+
"default": "''",
|
29229
|
+
"fieldName": "grabberBtnAriaLabel"
|
29230
|
+
},
|
29231
|
+
{
|
29232
|
+
"name": "parent-nav-tooltip-text",
|
29233
|
+
"type": {
|
29234
|
+
"text": "string | undefined"
|
29235
|
+
},
|
29236
|
+
"description": "Tooltip text shown on parent nav items when a child is active.",
|
29237
|
+
"fieldName": "parentNavTooltipText"
|
29238
|
+
}
|
29239
|
+
],
|
29240
|
+
"superclass": {
|
29241
|
+
"name": "Provider",
|
29242
|
+
"module": "/src/models"
|
29243
|
+
},
|
29244
|
+
"tagName": "mdc-sidenavigation",
|
29245
|
+
"jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-navitemlist` and `mdc-navitem`\n *\n * ### Usage:\n * In a sidenavigation, navitems can be used in the following ways:\n *\n * 1. **Simple navitem** – No submenu or interaction beyond selection.\n *\n * 2. **Navitem with submenu**:\n * - Provide an `id` on the `mdc-navitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navitem` and `mdc-navitemlist`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collpased\n */",
|
29246
|
+
"customElement": true
|
29247
|
+
}
|
29248
|
+
],
|
29249
|
+
"exports": [
|
29250
|
+
{
|
29251
|
+
"kind": "js",
|
29252
|
+
"name": "default",
|
29253
|
+
"declaration": {
|
29254
|
+
"name": "SideNavigation",
|
29255
|
+
"module": "components/sidenavigation/sidenavigation.component.js"
|
29256
|
+
}
|
29257
|
+
}
|
29258
|
+
]
|
29259
|
+
},
|
27313
29260
|
{
|
27314
29261
|
"kind": "javascript-module",
|
27315
29262
|
"path": "components/spinner/spinner.component.js",
|
@@ -36198,6 +38145,27 @@
|
|
36198
38145
|
],
|
36199
38146
|
"description": "Checks if the given tag name is a valid menu tag name."
|
36200
38147
|
},
|
38148
|
+
{
|
38149
|
+
"kind": "method",
|
38150
|
+
"name": "isValidNavItemList",
|
38151
|
+
"privacy": "private",
|
38152
|
+
"return": {
|
38153
|
+
"type": {
|
38154
|
+
"text": ""
|
38155
|
+
}
|
38156
|
+
},
|
38157
|
+
"parameters": [
|
38158
|
+
{
|
38159
|
+
"name": "tagName",
|
38160
|
+
"optional": true,
|
38161
|
+
"type": {
|
38162
|
+
"text": "string"
|
38163
|
+
},
|
38164
|
+
"description": "The tag name to check."
|
38165
|
+
}
|
38166
|
+
],
|
38167
|
+
"description": "Checks if the given tag name is a valid navitemlist tag name."
|
38168
|
+
},
|
36201
38169
|
{
|
36202
38170
|
"kind": "method",
|
36203
38171
|
"name": "isValidPopover",
|
@@ -36500,6 +38468,26 @@
|
|
36500
38468
|
],
|
36501
38469
|
"description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard."
|
36502
38470
|
},
|
38471
|
+
{
|
38472
|
+
"kind": "method",
|
38473
|
+
"name": "getKeyBasedOnDirection",
|
38474
|
+
"privacy": "private",
|
38475
|
+
"return": {
|
38476
|
+
"type": {
|
38477
|
+
"text": ""
|
38478
|
+
}
|
38479
|
+
},
|
38480
|
+
"parameters": [
|
38481
|
+
{
|
38482
|
+
"name": "originalKey",
|
38483
|
+
"type": {
|
38484
|
+
"text": "string"
|
38485
|
+
},
|
38486
|
+
"description": "The original key pressed."
|
38487
|
+
}
|
38488
|
+
],
|
38489
|
+
"description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction."
|
38490
|
+
},
|
36503
38491
|
{
|
36504
38492
|
"kind": "method",
|
36505
38493
|
"name": "handleKeyDown",
|