feat: add target API to SideNavItem (#5962)

* feat: add target API to SideNavItem

* test: add tests for new target API in SideNavItem

* chore: run formatter

vaadin-side-nav-flow-parent/vaadin-side-nav-flow/src/main/java/com/vaadin/flow/component/sidenav/SideNavItem.java

@@ -357,6 +357,67 @@ public void setPathAliases(Set<String> pathAliases) {
  }
  }
 
+ /**
+ * Gets the target of this item.
+ *
+ * @return the target of this item
+ */
+ public String getTarget() {
+ return getElement().getProperty("target");
+ }
+
+ /**
+ * Where to display the linked URL, as the name for a browsing context.
+ * <p>
+ * The following keywords have special meanings for where to load the URL:
+ * <ul>
+ * <li><code>_self</code>: the current browsing context. (Default)</li>
+ * <li><code>_blank</code>: usually a new tab, but users can configure
+ * browsers to open a new window instead.</li>
+ * <li><code>_parent</code>: the parent browsing context of the current one.
+ * If no parent, behaves as <code>_self</code>.</li>
+ * <li><code>_top</code>: the topmost browsing context (the "highest"
+ * context that’s an ancestor of the current one). If no ancestors, behaves
+ * as <code>_self</code>.</li>
+ * </ul>
+ * </p>
+ *
+ * @param target
+ * the target of this item
+ */
+ public void setTarget(String target) {
+ if (target == null) {
+ getElement().removeProperty("target");
+ } else {
+ getElement().setProperty("target", target);
+ }
+ }
+
+ /**
+ * Sets whether the target URL should be opened in a new browser tab.
+ * <p>
+ * This is a convenience method for setting the target to
+ * <code>_blank</code>. See {@link #setTarget(String)} for more information.
+ * </p>
+ *
+ * @param openInNewBrowserTab
+ * true if the target URL should be opened in a new browser tab,
+ * false otherwise
+ */
+ public void setOpenInNewBrowserTab(boolean openInNewBrowserTab) {
+ setTarget(openInNewBrowserTab ? "_blank" : null);
+ }
+
+ /**
+ * Gets whether the target URL should be opened in a new browser tab.
+ *
+ * @return true if the target URL should be opened in a new browser tab,
+ * false otherwise
+ */
+ public boolean isOpenInNewBrowserTab() {
+ return "_blank".equals(getTarget());
+ }
+
  private Set<String> getPathAliasesFromView(Class<? extends Component> view,
  RouteParameters routeParameters) {
  RouteAlias[] routeAliases = view.getAnnotationsByType(RouteAlias.class);

vaadin-side-nav-flow-parent/vaadin-side-nav-flow/src/test/java/com/vaadin/flow/component/sidenav/tests/SideNavItemTest.java

@@ -604,6 +604,39 @@ public void setPathAsComponent_aliasWithMissingParameterNotAdded() {
  }, TestRouteWithAliases.class);
  }
 
+ @Test
+ public void setTarget_hasTarget() {
+ sideNavItem.setTarget("_blank");
+ Assert.assertEquals("_blank",
+ sideNavItem.getElement().getProperty("target"));
+ Assert.assertEquals("_blank", sideNavItem.getTarget());
+ }
+
+ @Test
+ public void targetDefined_setToNull_noTarget() {
+ sideNavItem.setTarget("_blank");
+ sideNavItem.setTarget(null);
+ Assert.assertFalse(sideNavItem.getElement().hasProperty("target"));
+ Assert.assertNull(sideNavItem.getTarget());
+ }
+
+ @Test
+ public void setOpenInNewBrowserTab_targetBlankDefinedOnProperty() {
+ // call setOpenInNewTab and check that getTarget returns "_blank"
+ sideNavItem.setOpenInNewBrowserTab(true);
+ Assert.assertEquals("_blank",
+ sideNavItem.getElement().getProperty("target"));
+ Assert.assertTrue(sideNavItem.isOpenInNewBrowserTab());
+ }
+
+ @Test
+ public void openInNewBrowserTabDefined_setOpenInNewBrowserTabToFalse() {
+ sideNavItem.setOpenInNewBrowserTab(true);
+ sideNavItem.setOpenInNewBrowserTab(false);
+ Assert.assertFalse(sideNavItem.getElement().hasProperty("target"));
+ Assert.assertFalse(sideNavItem.isOpenInNewBrowserTab());
+ }
+
  private boolean sideNavItemHasLabelElement() {
  return sideNavItem.getElement().getChildren()
  .anyMatch(this::isLabelElement);