feat: add setAutoExpand API to control items expanding (#8149)

web-padawan · web-flow · commit 86b2fbb0356d · 2025-10-15T15:19:02.000+02:00
diff --git a/vaadin-side-nav-flow-parent/vaadin-side-nav-flow/src/main/java/com/vaadin/flow/component/sidenav/SideNav.java b/vaadin-side-nav-flow-parent/vaadin-side-nav-flow/src/main/java/com/vaadin/flow/component/sidenav/SideNav.java
@@ -151,6 +151,30 @@ public void setExpanded(boolean expanded) {
         getElement().setProperty("collapsed", !expanded);
     }
 
+    /**
+     * Gets whether to expand parent items of the nested matching item after
+     * initial rendering or navigation. By default, all the parent items are
+     * expanded.
+     *
+     * @return true if parent items for the item should be expanded
+     */
+    public boolean isAutoExpand() {
+        return !getElement().getProperty("noAutoExpand", false);
+    }
+
+    /**
+     * Sets whether to expand parent items of the nested matching item after
+     * initial rendering or navigation. By default, all the parent items are
+     * expanded.
+     *
+     * @param autoExpand
+     *            true if parent items for the item should be expanded, false
+     *            otherwise
+     */
+    public void setAutoExpand(boolean autoExpand) {
+        getElement().setProperty("noAutoExpand", !autoExpand);
+    }
+
     /**
      * Gets the internationalization object previously set for this component.
      * <p>
diff --git a/vaadin-side-nav-flow-parent/vaadin-side-nav-flow/src/test/java/com/vaadin/flow/component/sidenav/tests/SideNavTest.java b/vaadin-side-nav-flow-parent/vaadin-side-nav-flow/src/test/java/com/vaadin/flow/component/sidenav/tests/SideNavTest.java
@@ -55,6 +55,19 @@ public void setNotCollapsible_isNotCollapsible() {
         Assert.assertFalse(sideNav.isCollapsible());
     }
 
+    @Test
+    public void setAutoExpand_isAutoExpand() {
+        Assert.assertTrue(sideNav.isAutoExpand());
+        Assert.assertFalse(
+                sideNav.getElement().getProperty("noAutoExpand", false));
+
+        sideNav.setAutoExpand(false);
+
+        Assert.assertFalse(sideNav.isAutoExpand());
+        Assert.assertTrue(
+                sideNav.getElement().getProperty("noAutoExpand", false));
+    }
+
     @Test
     public void changeLabel_labelChanged() {
         Assert.assertNull(sideNav.getLabel());
