@momentum-design/components 0.120.34 → 0.120.36

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.
@@ -10284,6 +10284,21 @@
10284
10284
  "attribute": "autofocus",
10285
10285
  "reflects": true
10286
10286
  },
10287
+ {
10288
+ "kind": "field",
10289
+ "name": "helpTextType",
10290
+ "type": {
10291
+ "text": "ValidationType"
10292
+ },
10293
+ "description": "The type of help text/validation. It can be 'default' or 'error'.",
10294
+ "attribute": "help-text-type",
10295
+ "reflects": true,
10296
+ "default": "'default'",
10297
+ "inheritedFrom": {
10298
+ "name": "FormfieldWrapper",
10299
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10300
+ }
10301
+ },
10287
10302
  {
10288
10303
  "kind": "method",
10289
10304
  "name": "setFormValue",
@@ -10525,20 +10540,6 @@
10525
10540
  "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10526
10541
  }
10527
10542
  },
10528
- {
10529
- "kind": "field",
10530
- "name": "helpTextType",
10531
- "type": {
10532
- "text": "ValidationType"
10533
- },
10534
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
10535
- "attribute": "help-text-type",
10536
- "reflects": true,
10537
- "inheritedFrom": {
10538
- "name": "FormfieldWrapper",
10539
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
10540
- }
10541
- },
10542
10543
  {
10543
10544
  "kind": "field",
10544
10545
  "name": "helpText",
@@ -10760,6 +10761,19 @@
10760
10761
  "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
10761
10762
  "fieldName": "autofocus"
10762
10763
  },
10764
+ {
10765
+ "name": "help-text-type",
10766
+ "type": {
10767
+ "text": "ValidationType"
10768
+ },
10769
+ "description": "The type of help text/validation. It can be 'default' or 'error'.",
10770
+ "fieldName": "helpTextType",
10771
+ "default": "'default'",
10772
+ "inheritedFrom": {
10773
+ "name": "FormfieldWrapper",
10774
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10775
+ }
10776
+ },
10763
10777
  {
10764
10778
  "name": "auto-focus-on-mount",
10765
10779
  "type": {
@@ -10862,18 +10876,6 @@
10862
10876
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10863
10877
  }
10864
10878
  },
10865
- {
10866
- "name": "help-text-type",
10867
- "type": {
10868
- "text": "ValidationType"
10869
- },
10870
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
10871
- "fieldName": "helpTextType",
10872
- "inheritedFrom": {
10873
- "name": "FormfieldWrapper",
10874
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
10875
- }
10876
- },
10877
10879
  {
10878
10880
  "name": "help-text",
10879
10881
  "type": {
@@ -19307,6 +19309,17 @@
19307
19309
  "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
19308
19310
  "attribute": "clear-aria-label"
19309
19311
  },
19312
+ {
19313
+ "kind": "field",
19314
+ "name": "dataAriaDescribedby",
19315
+ "type": {
19316
+ "text": "string | null"
19317
+ },
19318
+ "default": "null",
19319
+ "description": "Defines a id pointing to the element which describes the input element.\nThe AriaDescribedby attribute to be set for accessibility.",
19320
+ "attribute": "data-aria-describedby",
19321
+ "reflects": true
19322
+ },
19310
19323
  {
19311
19324
  "kind": "method",
19312
19325
  "name": "setInputValidity",
@@ -19931,6 +19944,15 @@
19931
19944
  "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
19932
19945
  "fieldName": "clearAriaLabel"
19933
19946
  },
19947
+ {
19948
+ "name": "data-aria-describedby",
19949
+ "type": {
19950
+ "text": "string | null"
19951
+ },
19952
+ "default": "null",
19953
+ "description": "Defines a id pointing to the element which describes the input element.\nThe AriaDescribedby attribute to be set for accessibility.",
19954
+ "fieldName": "dataAriaDescribedby"
19955
+ },
19934
19956
  {
19935
19957
  "name": "auto-focus-on-mount",
19936
19958
  "type": {
@@ -31913,6 +31935,21 @@
31913
31935
  "module": "components/input/input.component.js"
31914
31936
  }
31915
31937
  },
31938
+ {
31939
+ "kind": "field",
31940
+ "name": "dataAriaDescribedby",
31941
+ "type": {
31942
+ "text": "string | null"
31943
+ },
31944
+ "default": "null",
31945
+ "description": "Defines a id pointing to the element which describes the input element.\nThe AriaDescribedby attribute to be set for accessibility.",
31946
+ "attribute": "data-aria-describedby",
31947
+ "reflects": true,
31948
+ "inheritedFrom": {
31949
+ "name": "Input",
31950
+ "module": "components/input/input.component.js"
31951
+ }
31952
+ },
31916
31953
  {
31917
31954
  "kind": "method",
31918
31955
  "name": "setInputValidity",
@@ -32552,6 +32589,19 @@
32552
32589
  "module": "src/components/input/input.component.ts"
32553
32590
  }
32554
32591
  },
32592
+ {
32593
+ "name": "data-aria-describedby",
32594
+ "type": {
32595
+ "text": "string | null"
32596
+ },
32597
+ "default": "null",
32598
+ "description": "Defines a id pointing to the element which describes the input element.\nThe AriaDescribedby attribute to be set for accessibility.",
32599
+ "fieldName": "dataAriaDescribedby",
32600
+ "inheritedFrom": {
32601
+ "name": "Input",
32602
+ "module": "src/components/input/input.component.ts"
32603
+ }
32604
+ },
32555
32605
  {
32556
32606
  "name": "disabled",
32557
32607
  "type": {
@@ -37612,289 +37662,84 @@
37612
37662
  },
37613
37663
  {
37614
37664
  "kind": "javascript-module",
37615
- "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
37665
+ "path": "components/searchfield/searchfield.component.js",
37616
37666
  "declarations": [
37617
37667
  {
37618
37668
  "kind": "class",
37619
- "description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
37620
- "name": "ScreenreaderAnnouncer",
37621
- "members": [
37669
+ "description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
37670
+ "name": "Searchfield",
37671
+ "cssProperties": [
37622
37672
  {
37623
- "kind": "field",
37624
- "name": "announcement",
37625
- "type": {
37626
- "text": "string"
37627
- },
37628
- "default": "''",
37629
- "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
37630
- "attribute": "announcement",
37631
- "reflects": true
37673
+ "description": "Font size for the label text.",
37674
+ "name": "--mdc-label-font-size",
37675
+ "inheritedFrom": {
37676
+ "name": "FormfieldWrapper",
37677
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37678
+ }
37632
37679
  },
37633
37680
  {
37634
- "kind": "field",
37635
- "name": "identity",
37636
- "type": {
37637
- "text": "string"
37638
- },
37639
- "default": "''",
37640
- "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
37641
- "attribute": "identity",
37642
- "reflects": true
37681
+ "description": "Font weight for the label text.",
37682
+ "name": "--mdc-label-font-weight",
37683
+ "inheritedFrom": {
37684
+ "name": "FormfieldWrapper",
37685
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37686
+ }
37643
37687
  },
37644
37688
  {
37645
- "kind": "field",
37646
- "name": "dataAriaLive",
37647
- "type": {
37648
- "text": "AriaLive"
37649
- },
37650
- "description": "Aria live value for announcement.",
37651
- "default": "'polite'",
37652
- "attribute": "data-aria-live",
37653
- "reflects": true
37689
+ "description": "Line height for the label text.",
37690
+ "name": "--mdc-label-line-height",
37691
+ "inheritedFrom": {
37692
+ "name": "FormfieldWrapper",
37693
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37694
+ }
37654
37695
  },
37655
37696
  {
37656
- "kind": "field",
37657
- "name": "delay",
37658
- "type": {
37659
- "text": "number"
37660
- },
37661
- "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
37662
- "default": "150",
37663
- "attribute": "delay",
37664
- "reflects": true
37697
+ "description": "Color for the label text.",
37698
+ "name": "--mdc-label-color",
37699
+ "inheritedFrom": {
37700
+ "name": "FormfieldWrapper",
37701
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37702
+ }
37665
37703
  },
37666
37704
  {
37667
- "kind": "field",
37668
- "name": "timeout",
37669
- "type": {
37670
- "text": "number"
37671
- },
37672
- "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
37673
- "default": "20_000",
37674
- "attribute": "timeout",
37675
- "reflects": true
37705
+ "description": "Font size for the help text.",
37706
+ "name": "--mdc-help-text-font-size",
37707
+ "inheritedFrom": {
37708
+ "name": "FormfieldWrapper",
37709
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37710
+ }
37676
37711
  },
37677
37712
  {
37678
- "kind": "field",
37679
- "name": "debounceTime",
37680
- "type": {
37681
- "text": "number"
37682
- },
37683
- "description": "The debounce time delay in milliseconds for announcements.",
37684
- "default": "500",
37685
- "attribute": "debounce-time",
37686
- "reflects": true
37713
+ "description": "Font weight for the help text.",
37714
+ "name": "--mdc-help-text-font-weight",
37715
+ "inheritedFrom": {
37716
+ "name": "FormfieldWrapper",
37717
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37718
+ }
37687
37719
  },
37688
37720
  {
37689
- "kind": "method",
37690
- "name": "announce",
37691
- "parameters": [
37692
- {
37693
- "name": "announcement",
37694
- "type": {
37695
- "text": "string"
37696
- },
37697
- "description": "The announcement to be made."
37698
- },
37699
- {
37700
- "name": "delay",
37701
- "type": {
37702
- "text": "number"
37703
- },
37704
- "description": "The delay in milliseconds before announcing the message."
37705
- },
37706
- {
37707
- "name": "timeout",
37708
- "type": {
37709
- "text": "number"
37710
- },
37711
- "description": "The timeout in milliseconds before removing the announcement."
37712
- },
37713
- {
37714
- "name": "ariaLive",
37715
- "type": {
37716
- "text": "AriaLive"
37717
- },
37718
- "description": "The aria live value for the announcement."
37719
- }
37720
- ],
37721
- "description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
37721
+ "description": "Line height for the help text.",
37722
+ "name": "--mdc-help-text-line-height",
37723
+ "inheritedFrom": {
37724
+ "name": "FormfieldWrapper",
37725
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37726
+ }
37722
37727
  },
37723
37728
  {
37724
- "kind": "method",
37725
- "name": "clearTimeOutsAndAnnouncements",
37726
- "privacy": "private",
37727
- "description": "Clears all timeouts and removes all announcements from the screen reader."
37729
+ "description": "Color for the help text.",
37730
+ "name": "--mdc-help-text-color",
37731
+ "inheritedFrom": {
37732
+ "name": "FormfieldWrapper",
37733
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37734
+ }
37728
37735
  },
37729
37736
  {
37730
- "kind": "method",
37731
- "name": "createAnnouncementAriaLiveRegion",
37732
- "privacy": "private",
37733
- "description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
37734
- },
37735
- {
37736
- "kind": "method",
37737
- "name": "setupDebouncedAnnounce",
37738
- "privacy": "private",
37739
- "description": "Creates a single debounced function that will read the latest this.announcement when executed.\n\nThis function is used to debounce the announcement so that it will only be made after\nthis.debounceTime milliseconds have passed since the last time this.announcement was updated."
37740
- }
37741
- ],
37742
- "attributes": [
37743
- {
37744
- "name": "announcement",
37745
- "type": {
37746
- "text": "string"
37747
- },
37748
- "default": "''",
37749
- "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
37750
- "fieldName": "announcement"
37751
- },
37752
- {
37753
- "name": "identity",
37754
- "type": {
37755
- "text": "string"
37756
- },
37757
- "default": "''",
37758
- "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
37759
- "fieldName": "identity"
37760
- },
37761
- {
37762
- "name": "data-aria-live",
37763
- "type": {
37764
- "text": "AriaLive"
37765
- },
37766
- "description": "Aria live value for announcement.",
37767
- "default": "'polite'",
37768
- "fieldName": "dataAriaLive"
37769
- },
37770
- {
37771
- "name": "delay",
37772
- "type": {
37773
- "text": "number"
37774
- },
37775
- "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
37776
- "default": "150",
37777
- "fieldName": "delay"
37778
- },
37779
- {
37780
- "name": "timeout",
37781
- "type": {
37782
- "text": "number"
37783
- },
37784
- "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
37785
- "default": "20_000",
37786
- "fieldName": "timeout"
37787
- },
37788
- {
37789
- "name": "debounce-time",
37790
- "type": {
37791
- "text": "number"
37792
- },
37793
- "description": "The debounce time delay in milliseconds for announcements.",
37794
- "default": "500",
37795
- "fieldName": "debounceTime"
37796
- }
37797
- ],
37798
- "superclass": {
37799
- "name": "Component",
37800
- "module": "/src/models"
37801
- },
37802
- "tagName": "mdc-screenreaderannouncer",
37803
- "jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
37804
- "customElement": true
37805
- }
37806
- ],
37807
- "exports": [
37808
- {
37809
- "kind": "js",
37810
- "name": "default",
37811
- "declaration": {
37812
- "name": "ScreenreaderAnnouncer",
37813
- "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
37814
- }
37815
- }
37816
- ]
37817
- },
37818
- {
37819
- "kind": "javascript-module",
37820
- "path": "components/searchfield/searchfield.component.js",
37821
- "declarations": [
37822
- {
37823
- "kind": "class",
37824
- "description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
37825
- "name": "Searchfield",
37826
- "cssProperties": [
37827
- {
37828
- "description": "Font size for the label text.",
37829
- "name": "--mdc-label-font-size",
37830
- "inheritedFrom": {
37831
- "name": "FormfieldWrapper",
37832
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37833
- }
37834
- },
37835
- {
37836
- "description": "Font weight for the label text.",
37837
- "name": "--mdc-label-font-weight",
37838
- "inheritedFrom": {
37839
- "name": "FormfieldWrapper",
37840
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37841
- }
37842
- },
37843
- {
37844
- "description": "Line height for the label text.",
37845
- "name": "--mdc-label-line-height",
37846
- "inheritedFrom": {
37847
- "name": "FormfieldWrapper",
37848
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37849
- }
37850
- },
37851
- {
37852
- "description": "Color for the label text.",
37853
- "name": "--mdc-label-color",
37854
- "inheritedFrom": {
37855
- "name": "FormfieldWrapper",
37856
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37857
- }
37858
- },
37859
- {
37860
- "description": "Font size for the help text.",
37861
- "name": "--mdc-help-text-font-size",
37862
- "inheritedFrom": {
37863
- "name": "FormfieldWrapper",
37864
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37865
- }
37866
- },
37867
- {
37868
- "description": "Font weight for the help text.",
37869
- "name": "--mdc-help-text-font-weight",
37870
- "inheritedFrom": {
37871
- "name": "FormfieldWrapper",
37872
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37873
- }
37874
- },
37875
- {
37876
- "description": "Line height for the help text.",
37877
- "name": "--mdc-help-text-line-height",
37878
- "inheritedFrom": {
37879
- "name": "FormfieldWrapper",
37880
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37881
- }
37882
- },
37883
- {
37884
- "description": "Color for the help text.",
37885
- "name": "--mdc-help-text-color",
37886
- "inheritedFrom": {
37887
- "name": "FormfieldWrapper",
37888
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37889
- }
37890
- },
37891
- {
37892
- "description": "Color for the required indicator text.",
37893
- "name": "--mdc-required-indicator-color",
37894
- "inheritedFrom": {
37895
- "name": "FormfieldWrapper",
37896
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37897
- }
37737
+ "description": "Color for the required indicator text.",
37738
+ "name": "--mdc-required-indicator-color",
37739
+ "inheritedFrom": {
37740
+ "name": "FormfieldWrapper",
37741
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
37742
+ }
37898
37743
  },
37899
37744
  {
37900
37745
  "description": "Text color for the input field",
@@ -38477,6 +38322,21 @@
38477
38322
  "module": "components/input/input.component.js"
38478
38323
  }
38479
38324
  },
38325
+ {
38326
+ "kind": "field",
38327
+ "name": "dataAriaDescribedby",
38328
+ "type": {
38329
+ "text": "string | null"
38330
+ },
38331
+ "default": "null",
38332
+ "description": "Defines a id pointing to the element which describes the input element.\nThe AriaDescribedby attribute to be set for accessibility.",
38333
+ "attribute": "data-aria-describedby",
38334
+ "reflects": true,
38335
+ "inheritedFrom": {
38336
+ "name": "Input",
38337
+ "module": "components/input/input.component.js"
38338
+ }
38339
+ },
38480
38340
  {
38481
38341
  "kind": "method",
38482
38342
  "name": "setInputValidity",
@@ -39129,6 +38989,19 @@
39129
38989
  "module": "src/components/input/input.component.ts"
39130
38990
  }
39131
38991
  },
38992
+ {
38993
+ "name": "data-aria-describedby",
38994
+ "type": {
38995
+ "text": "string | null"
38996
+ },
38997
+ "default": "null",
38998
+ "description": "Defines a id pointing to the element which describes the input element.\nThe AriaDescribedby attribute to be set for accessibility.",
38999
+ "fieldName": "dataAriaDescribedby",
39000
+ "inheritedFrom": {
39001
+ "name": "Input",
39002
+ "module": "src/components/input/input.component.ts"
39003
+ }
39004
+ },
39132
39005
  {
39133
39006
  "name": "disabled",
39134
39007
  "type": {
@@ -40550,213 +40423,195 @@
40550
40423
  },
40551
40424
  {
40552
40425
  "kind": "javascript-module",
40553
- "path": "components/sidenavigation/sidenavigation.component.js",
40426
+ "path": "components/screenreaderannouncer/screenreaderannouncer.component.js",
40554
40427
  "declarations": [
40555
40428
  {
40556
40429
  "kind": "class",
40557
- "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-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem'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 navmenuitem (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-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
40558
- "name": "SideNavigation",
40559
- "cssProperties": [
40560
- {
40561
- "description": "width of the sideNavigation when expanded",
40562
- "name": "--mdc-sidenavigation-expanded-width"
40563
- },
40564
- {
40565
- "description": "width of the sideNavigation when collapsed",
40566
- "name": "--mdc-sidenavigation-collapsed-width"
40567
- },
40568
- {
40569
- "description": "z-index of the vertical divider button",
40570
- "name": "--mdc-sidenavigation-vertical-divider-button-z-index"
40571
- }
40572
- ],
40573
- "cssParts": [
40574
- {
40575
- "description": "The main container wrapping the entire side navigation.",
40576
- "name": "side-navigation-container"
40577
- },
40578
- {
40579
- "description": "The scrollable section of the side navigation.",
40580
- "name": "scrollable-section"
40581
- },
40582
- {
40583
- "description": "The fixed section of the side navigation.",
40584
- "name": "fixed-section"
40585
- },
40586
- {
40587
- "description": "The divider between the scrollable and fixed sections.",
40588
- "name": "separator"
40589
- },
40590
- {
40591
- "description": "The container wrapping the brand logo and footer text.",
40592
- "name": "brand-logo-container"
40593
- },
40594
- {
40595
- "description": "The footer text label in the fixed section.",
40596
- "name": "footer-text"
40597
- },
40598
- {
40599
- "description": "The vertical divider between the scrollable and fixed sections.",
40600
- "name": "vertical-divider"
40601
- },
40602
- {
40603
- "description": "The button inside the vertical divider used to toggle expand/collapse.",
40604
- "name": "vertical-divider-button"
40605
- }
40606
- ],
40607
- "slots": [
40608
- {
40609
- "description": "Slot for the scrollable content area of the side navigation.",
40610
- "name": "scrollable-section"
40611
- },
40612
- {
40613
- "description": "Slot for the fixed content area of the side navigation.",
40614
- "name": "fixed-section"
40615
- },
40616
- {
40617
- "description": "Slot for the brand logo (e.g., icon or img).",
40618
- "name": "brand-logo"
40619
- }
40620
- ],
40430
+ "description": "`mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n\nTo make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n\n**Internal logic**\n\nWhen the screenreader announcer is connected to the DOM, if the `identity` attribute is not\nprovided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\nin the DOM. If the `identity` attribute is provided, the identity element is used and no new element\nis created in the DOM.\n\nWhen the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n`aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\nAfter delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n\nThe announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n\nWhen the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\nall the announcement elements added are removed from the DOM and timeouts cleared.\n\n**Note**\n1. The default delay of 150 miliseconds is used as we dynamically generate the\naria-live region in the DOM and add the announcement text to it.\n3. If no `identity` is provided, all the screen reader components will create and use only one\n`<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n\nReference: https://patrickhlauke.github.io/aria/tests/live-regions/",
40431
+ "name": "ScreenreaderAnnouncer",
40621
40432
  "members": [
40622
40433
  {
40623
40434
  "kind": "field",
40624
- "name": "variant",
40435
+ "name": "announcement",
40625
40436
  "type": {
40626
- "text": "SideNavigationVariant"
40437
+ "text": "string"
40627
40438
  },
40628
- "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.",
40629
- "default": "flexible",
40630
- "attribute": "variant",
40439
+ "default": "''",
40440
+ "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
40441
+ "attribute": "announcement",
40631
40442
  "reflects": true
40632
40443
  },
40633
40444
  {
40634
40445
  "kind": "field",
40635
- "name": "footerText",
40446
+ "name": "identity",
40636
40447
  "type": {
40637
40448
  "text": "string"
40638
40449
  },
40639
40450
  "default": "''",
40640
- "description": "Displays footer text in the bottom section of the sidenavigation.",
40641
- "attribute": "footer-text",
40451
+ "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
40452
+ "attribute": "identity",
40642
40453
  "reflects": true
40643
40454
  },
40644
40455
  {
40645
40456
  "kind": "field",
40646
- "name": "grabberBtnAriaLabel",
40457
+ "name": "dataAriaLive",
40647
40458
  "type": {
40648
- "text": "string | undefined"
40459
+ "text": "AriaLive"
40649
40460
  },
40650
- "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
40651
- "default": "''",
40652
- "attribute": "grabber-btn-aria-label",
40461
+ "description": "Aria live value for announcement.",
40462
+ "default": "'polite'",
40463
+ "attribute": "data-aria-live",
40653
40464
  "reflects": true
40654
40465
  },
40655
40466
  {
40656
40467
  "kind": "field",
40657
- "name": "parentNavTooltipText",
40468
+ "name": "delay",
40658
40469
  "type": {
40659
- "text": "string | undefined"
40470
+ "text": "number"
40660
40471
  },
40661
- "description": "Tooltip text shown on parent nav items when a child is active.",
40662
- "attribute": "parent-nav-tooltip-text",
40472
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
40473
+ "default": "150",
40474
+ "attribute": "delay",
40663
40475
  "reflects": true
40664
40476
  },
40665
40477
  {
40666
40478
  "kind": "field",
40667
- "name": "Context",
40668
- "privacy": "public",
40669
- "static": true,
40670
- "readonly": true
40479
+ "name": "timeout",
40480
+ "type": {
40481
+ "text": "number"
40482
+ },
40483
+ "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
40484
+ "default": "20_000",
40485
+ "attribute": "timeout",
40486
+ "reflects": true
40671
40487
  },
40672
40488
  {
40673
- "kind": "method",
40674
- "name": "updateContext",
40675
- "privacy": "protected",
40676
- "return": {
40677
- "type": {
40678
- "text": "void"
40679
- }
40489
+ "kind": "field",
40490
+ "name": "debounceTime",
40491
+ "type": {
40492
+ "text": "number"
40680
40493
  },
40681
- "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
40494
+ "description": "The debounce time delay in milliseconds for announcements.",
40495
+ "default": "500",
40496
+ "attribute": "debounce-time",
40497
+ "reflects": true
40682
40498
  },
40683
40499
  {
40684
40500
  "kind": "method",
40685
- "name": "preventScrollOnSpace",
40686
- "privacy": "private",
40687
- "return": {
40688
- "type": {
40689
- "text": "void"
40690
- }
40691
- },
40501
+ "name": "announce",
40692
40502
  "parameters": [
40693
40503
  {
40694
- "name": "event",
40504
+ "name": "announcement",
40695
40505
  "type": {
40696
- "text": "KeyboardEvent"
40697
- }
40506
+ "text": "string"
40507
+ },
40508
+ "description": "The announcement to be made."
40509
+ },
40510
+ {
40511
+ "name": "delay",
40512
+ "type": {
40513
+ "text": "number"
40514
+ },
40515
+ "description": "The delay in milliseconds before announcing the message."
40516
+ },
40517
+ {
40518
+ "name": "timeout",
40519
+ "type": {
40520
+ "text": "number"
40521
+ },
40522
+ "description": "The timeout in milliseconds before removing the announcement."
40523
+ },
40524
+ {
40525
+ "name": "ariaLive",
40526
+ "type": {
40527
+ "text": "AriaLive"
40528
+ },
40529
+ "description": "The aria live value for the announcement."
40698
40530
  }
40699
- ]
40700
- }
40701
- ],
40702
- "events": [
40531
+ ],
40532
+ "description": "Announces the given announcement to the screen reader.\n\nA div element with aria-live attribute set to the given ariaLive value is created\nand a p element with the announcement text is appended to it.\n\nThe div element is appended to the element in the DOM identified with id as\nidentity attribute."
40533
+ },
40703
40534
  {
40704
- "name": "toggle",
40705
- "type": {
40706
- "text": "CustomEvent"
40707
- },
40708
- "description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
40709
- "reactName": "onToggle"
40535
+ "kind": "method",
40536
+ "name": "clearTimeOutsAndAnnouncements",
40537
+ "privacy": "private",
40538
+ "description": "Clears all timeouts and removes all announcements from the screen reader."
40710
40539
  },
40711
40540
  {
40712
- "description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
40713
- "name": "activechange",
40714
- "reactName": "onActiveChange"
40541
+ "kind": "method",
40542
+ "name": "createAnnouncementAriaLiveRegion",
40543
+ "privacy": "private",
40544
+ "description": "Creates a div element with id as identity attribute in the DOM.\n\nIf the identity attribute is not provided, it is set internally to\n`mdc-screenreaderannouncer-identity`."
40545
+ },
40546
+ {
40547
+ "kind": "method",
40548
+ "name": "setupDebouncedAnnounce",
40549
+ "privacy": "private",
40550
+ "description": "Creates a single debounced function that will read the latest this.announcement when executed.\n\nThis function is used to debounce the announcement so that it will only be made after\nthis.debounceTime milliseconds have passed since the last time this.announcement was updated."
40715
40551
  }
40716
40552
  ],
40717
40553
  "attributes": [
40718
40554
  {
40719
- "name": "variant",
40555
+ "name": "announcement",
40720
40556
  "type": {
40721
- "text": "SideNavigationVariant"
40557
+ "text": "string"
40722
40558
  },
40723
- "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.",
40724
- "default": "flexible",
40725
- "fieldName": "variant"
40559
+ "default": "''",
40560
+ "description": "The announcement attribute is a string that is used to announce messages to the screen reader.\nThe announcement is made when the announcement attribute is set to a non-empty string.",
40561
+ "fieldName": "announcement"
40726
40562
  },
40727
40563
  {
40728
- "name": "footer-text",
40564
+ "name": "identity",
40729
40565
  "type": {
40730
40566
  "text": "string"
40731
40567
  },
40732
40568
  "default": "''",
40733
- "description": "Displays footer text in the bottom section of the sidenavigation.",
40734
- "fieldName": "footerText"
40569
+ "description": "The id of the element in the light dom, to which announcement elements will be appended.\n\nIf id is not provided, it will be set to `mdc-screenreaderannouncer-identity` and\na div element with this id will be created in the light dom.",
40570
+ "fieldName": "identity"
40735
40571
  },
40736
40572
  {
40737
- "name": "grabber-btn-aria-label",
40573
+ "name": "data-aria-live",
40738
40574
  "type": {
40739
- "text": "string | undefined"
40575
+ "text": "AriaLive"
40740
40576
  },
40741
- "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
40742
- "default": "''",
40743
- "fieldName": "grabberBtnAriaLabel"
40577
+ "description": "Aria live value for announcement.",
40578
+ "default": "'polite'",
40579
+ "fieldName": "dataAriaLive"
40744
40580
  },
40745
40581
  {
40746
- "name": "parent-nav-tooltip-text",
40582
+ "name": "delay",
40747
40583
  "type": {
40748
- "text": "string | undefined"
40584
+ "text": "number"
40749
40585
  },
40750
- "description": "Tooltip text shown on parent nav items when a child is active.",
40751
- "fieldName": "parentNavTooltipText"
40586
+ "description": "Milliseconds to wait before adding the announcement to the identiy region in\nDOM, which will announce the message to the screen reader.",
40587
+ "default": "150",
40588
+ "fieldName": "delay"
40589
+ },
40590
+ {
40591
+ "name": "timeout",
40592
+ "type": {
40593
+ "text": "number"
40594
+ },
40595
+ "description": "Milliseconds to wait after which the announcement element will be removed from\nidentity region in DOM, causing the screen reader to not announcing the message.",
40596
+ "default": "20_000",
40597
+ "fieldName": "timeout"
40598
+ },
40599
+ {
40600
+ "name": "debounce-time",
40601
+ "type": {
40602
+ "text": "number"
40603
+ },
40604
+ "description": "The debounce time delay in milliseconds for announcements.",
40605
+ "default": "500",
40606
+ "fieldName": "debounceTime"
40752
40607
  }
40753
40608
  ],
40754
40609
  "superclass": {
40755
- "name": "Provider",
40610
+ "name": "Component",
40756
40611
  "module": "/src/models"
40757
40612
  },
40758
- "tagName": "mdc-sidenavigation",
40759
- "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-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem'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 navmenuitem (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-navmenuitem` and `mdc-menubar`\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 * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem 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 * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
40613
+ "tagName": "mdc-screenreaderannouncer",
40614
+ "jsDoc": "/**\n * `mdc-screenreaderannouncer` can be used to announce messages with the screen reader.\n *\n * To make an announcement set `announcement` attribute on the `mdc-screenreaderannouncer` element.\n *\n * **Internal logic**\n *\n * When the screenreader announcer is connected to the DOM, if the `identity` attribute is not\n * provided, it is set to `mdc-screenreaderannouncer-identity` and a `<div>` element with this id is created\n * in the DOM. If the `identity` attribute is provided, the identity element is used and no new element\n * is created in the DOM.\n *\n * When the `announcement` attribute is set, the screenreader announcer will create a `<div>` element with\n * `aria-live` attribute set to the value of `data-aria-live` attribute and append it to the `identity` element.\n * After delay of `delay` milliseconds, a <p> element with the announcement text is appended to the `<div>` element.\n *\n * The announcement `<div>` element is removed from the DOM after `timeout` milliseconds.\n *\n * When the screen announcer component is disconnected from the DOM, all the timeouts are cleared and\n * all the announcement elements added are removed from the DOM and timeouts cleared.\n *\n * **Note**\n * 1. The default delay of 150 miliseconds is used as we dynamically generate the\n * aria-live region in the DOM and add the announcement text to it.\n * 3. If no `identity` is provided, all the screen reader components will create and use only one\n * `<div>` element with id `mdc-screenreaderannouncer-identity` in the DOM.\n *\n * Reference: https://patrickhlauke.github.io/aria/tests/live-regions/\n *\n * @tagname mdc-screenreaderannouncer\n */",
40760
40615
  "customElement": true
40761
40616
  }
40762
40617
  ],
@@ -40765,8 +40620,8 @@
40765
40620
  "kind": "js",
40766
40621
  "name": "default",
40767
40622
  "declaration": {
40768
- "name": "SideNavigation",
40769
- "module": "components/sidenavigation/sidenavigation.component.js"
40623
+ "name": "ScreenreaderAnnouncer",
40624
+ "module": "components/screenreaderannouncer/screenreaderannouncer.component.js"
40770
40625
  }
40771
40626
  }
40772
40627
  ]
@@ -41773,6 +41628,229 @@
41773
41628
  }
41774
41629
  ]
41775
41630
  },
41631
+ {
41632
+ "kind": "javascript-module",
41633
+ "path": "components/sidenavigation/sidenavigation.component.js",
41634
+ "declarations": [
41635
+ {
41636
+ "kind": "class",
41637
+ "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-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem'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 navmenuitem (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-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
41638
+ "name": "SideNavigation",
41639
+ "cssProperties": [
41640
+ {
41641
+ "description": "width of the sideNavigation when expanded",
41642
+ "name": "--mdc-sidenavigation-expanded-width"
41643
+ },
41644
+ {
41645
+ "description": "width of the sideNavigation when collapsed",
41646
+ "name": "--mdc-sidenavigation-collapsed-width"
41647
+ },
41648
+ {
41649
+ "description": "z-index of the vertical divider button",
41650
+ "name": "--mdc-sidenavigation-vertical-divider-button-z-index"
41651
+ }
41652
+ ],
41653
+ "cssParts": [
41654
+ {
41655
+ "description": "The main container wrapping the entire side navigation.",
41656
+ "name": "side-navigation-container"
41657
+ },
41658
+ {
41659
+ "description": "The scrollable section of the side navigation.",
41660
+ "name": "scrollable-section"
41661
+ },
41662
+ {
41663
+ "description": "The fixed section of the side navigation.",
41664
+ "name": "fixed-section"
41665
+ },
41666
+ {
41667
+ "description": "The divider between the scrollable and fixed sections.",
41668
+ "name": "separator"
41669
+ },
41670
+ {
41671
+ "description": "The container wrapping the brand logo and footer text.",
41672
+ "name": "brand-logo-container"
41673
+ },
41674
+ {
41675
+ "description": "The footer text label in the fixed section.",
41676
+ "name": "footer-text"
41677
+ },
41678
+ {
41679
+ "description": "The vertical divider between the scrollable and fixed sections.",
41680
+ "name": "vertical-divider"
41681
+ },
41682
+ {
41683
+ "description": "The button inside the vertical divider used to toggle expand/collapse.",
41684
+ "name": "vertical-divider-button"
41685
+ }
41686
+ ],
41687
+ "slots": [
41688
+ {
41689
+ "description": "Slot for the scrollable content area of the side navigation.",
41690
+ "name": "scrollable-section"
41691
+ },
41692
+ {
41693
+ "description": "Slot for the fixed content area of the side navigation.",
41694
+ "name": "fixed-section"
41695
+ },
41696
+ {
41697
+ "description": "Slot for the brand logo (e.g., icon or img).",
41698
+ "name": "brand-logo"
41699
+ }
41700
+ ],
41701
+ "members": [
41702
+ {
41703
+ "kind": "field",
41704
+ "name": "variant",
41705
+ "type": {
41706
+ "text": "SideNavigationVariant"
41707
+ },
41708
+ "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.",
41709
+ "default": "flexible",
41710
+ "attribute": "variant",
41711
+ "reflects": true
41712
+ },
41713
+ {
41714
+ "kind": "field",
41715
+ "name": "footerText",
41716
+ "type": {
41717
+ "text": "string"
41718
+ },
41719
+ "default": "''",
41720
+ "description": "Displays footer text in the bottom section of the sidenavigation.",
41721
+ "attribute": "footer-text",
41722
+ "reflects": true
41723
+ },
41724
+ {
41725
+ "kind": "field",
41726
+ "name": "grabberBtnAriaLabel",
41727
+ "type": {
41728
+ "text": "string | undefined"
41729
+ },
41730
+ "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
41731
+ "default": "''",
41732
+ "attribute": "grabber-btn-aria-label",
41733
+ "reflects": true
41734
+ },
41735
+ {
41736
+ "kind": "field",
41737
+ "name": "parentNavTooltipText",
41738
+ "type": {
41739
+ "text": "string | undefined"
41740
+ },
41741
+ "description": "Tooltip text shown on parent nav items when a child is active.",
41742
+ "attribute": "parent-nav-tooltip-text",
41743
+ "reflects": true
41744
+ },
41745
+ {
41746
+ "kind": "field",
41747
+ "name": "Context",
41748
+ "privacy": "public",
41749
+ "static": true,
41750
+ "readonly": true
41751
+ },
41752
+ {
41753
+ "kind": "method",
41754
+ "name": "updateContext",
41755
+ "privacy": "protected",
41756
+ "return": {
41757
+ "type": {
41758
+ "text": "void"
41759
+ }
41760
+ },
41761
+ "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
41762
+ },
41763
+ {
41764
+ "kind": "method",
41765
+ "name": "preventScrollOnSpace",
41766
+ "privacy": "private",
41767
+ "return": {
41768
+ "type": {
41769
+ "text": "void"
41770
+ }
41771
+ },
41772
+ "parameters": [
41773
+ {
41774
+ "name": "event",
41775
+ "type": {
41776
+ "text": "KeyboardEvent"
41777
+ }
41778
+ }
41779
+ ]
41780
+ }
41781
+ ],
41782
+ "events": [
41783
+ {
41784
+ "name": "toggle",
41785
+ "type": {
41786
+ "text": "CustomEvent"
41787
+ },
41788
+ "description": "(React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.",
41789
+ "reactName": "onToggle"
41790
+ },
41791
+ {
41792
+ "description": "(React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.",
41793
+ "name": "activechange",
41794
+ "reactName": "onActiveChange"
41795
+ }
41796
+ ],
41797
+ "attributes": [
41798
+ {
41799
+ "name": "variant",
41800
+ "type": {
41801
+ "text": "SideNavigationVariant"
41802
+ },
41803
+ "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.",
41804
+ "default": "flexible",
41805
+ "fieldName": "variant"
41806
+ },
41807
+ {
41808
+ "name": "footer-text",
41809
+ "type": {
41810
+ "text": "string"
41811
+ },
41812
+ "default": "''",
41813
+ "description": "Displays footer text in the bottom section of the sidenavigation.",
41814
+ "fieldName": "footerText"
41815
+ },
41816
+ {
41817
+ "name": "grabber-btn-aria-label",
41818
+ "type": {
41819
+ "text": "string | undefined"
41820
+ },
41821
+ "description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
41822
+ "default": "''",
41823
+ "fieldName": "grabberBtnAriaLabel"
41824
+ },
41825
+ {
41826
+ "name": "parent-nav-tooltip-text",
41827
+ "type": {
41828
+ "text": "string | undefined"
41829
+ },
41830
+ "description": "Tooltip text shown on parent nav items when a child is active.",
41831
+ "fieldName": "parentNavTooltipText"
41832
+ }
41833
+ ],
41834
+ "superclass": {
41835
+ "name": "Provider",
41836
+ "module": "/src/models"
41837
+ },
41838
+ "tagName": "mdc-sidenavigation",
41839
+ "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-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem'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 navmenuitem (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-navmenuitem` and `mdc-menubar`\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 * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem 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 * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
41840
+ "customElement": true
41841
+ }
41842
+ ],
41843
+ "exports": [
41844
+ {
41845
+ "kind": "js",
41846
+ "name": "default",
41847
+ "declaration": {
41848
+ "name": "SideNavigation",
41849
+ "module": "components/sidenavigation/sidenavigation.component.js"
41850
+ }
41851
+ }
41852
+ ]
41853
+ },
41776
41854
  {
41777
41855
  "kind": "javascript-module",
41778
41856
  "path": "components/staticcheckbox/staticcheckbox.component.js",