feat: add title API to dashboard widget (#6560)

* feat: add title for widget

* chore: run formatter

* refactor: use properties instead of attributes

* docs: fix the widget title property name

vaadin-dashboard-flow-parent/vaadin-dashboard-flow-integration-tests/pom.xml

@@ -59,6 +59,18 @@
             <groupId>com.vaadin</groupId>
             <artifactId>flow-polymer-template</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.vaadin</groupId>
+            <artifactId>vaadin-dashboard-flow</artifactId>
+            <version>24.5-SNAPSHOT</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.vaadin</groupId>
+            <artifactId>vaadin-dashboard-testbench</artifactId>
+            <version>24.5-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

vaadin-dashboard-flow-parent/vaadin-dashboard-flow-integration-tests/src/main/java/com/vaadin/flow/component/dashboard/tests/DashboardWidgetPage.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2000-2024 Vaadin Ltd.
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
+ * license.
+ */
+package com.vaadin.flow.component.dashboard.tests;
+
+import com.vaadin.flow.component.dashboard.DashboardWidget;
+import com.vaadin.flow.component.html.Div;
+import com.vaadin.flow.router.Route;
+
+/**
+ * @author Vaadin Ltd
+ */
+@Route("vaadin-dashboard-widget")
+public class DashboardWidgetPage extends Div {
+
+    public DashboardWidgetPage() {
+        DashboardWidget widget = new DashboardWidget();
+        widget.setTitle("Widget");
+        add(widget);
+    }
+}

vaadin-dashboard-flow-parent/vaadin-dashboard-flow-integration-tests/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardWidgetIT.java

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2000-2024 Vaadin Ltd.
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
+ * license.
+ */
+package com.vaadin.flow.component.dashboard.tests;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.vaadin.flow.component.dashboard.testbench.DashboardWidgetElement;
+import com.vaadin.flow.testutil.TestPath;
+import com.vaadin.tests.AbstractComponentIT;
+
+/**
+ * @author Vaadin Ltd
+ */
+@TestPath("vaadin-dashboard-widget")
+public class DashboardWidgetIT extends AbstractComponentIT {
+
+    private DashboardWidgetElement widget;
+
+    @Before
+    public void init() {
+        open();
+        widget = $(DashboardWidgetElement.class).waitForFirst();
+    }
+
+    @Test
+    public void titleIsSetCorrectly() {
+        Assert.assertEquals("Widget", widget.getTitle());
+    }
+}

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/pom.xml

@@ -50,6 +50,10 @@
             <artifactId>jakarta.jakartaee-web-api</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.vaadin</groupId>
+            <artifactId>flow-html-components</artifactId>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardWidget.java

@@ -22,4 +22,23 @@
 @JsModule("@vaadin/dashboard/src/vaadin-dashboard-widget.js")
 // @NpmPackage(value = "@vaadin/dashboard", version = "24.6.0-alpha0")
 public class DashboardWidget extends Component {
+
+    /**
+     * Returns the title of the widget.
+     *
+     * @return the {@code widgetTitle} property from the web component
+     */
+    public String getTitle() {
+        return getElement().getProperty("widgetTitle");
+    }
+
+    /**
+     * Sets the title of the widget.
+     *
+     * @param title
+     *            the title to set
+     */
+    public void setTitle(String title) {
+        getElement().setProperty("widgetTitle", title == null ? "" : title);
+    }
 }

vaadin-dashboard-flow-parent/vaadin-dashboard-testbench/src/main/java/com/vaadin/flow/component/dashboard/testbench/DashboardWidgetElement.java

@@ -16,4 +16,13 @@
  */
 @Element("vaadin-dashboard-widget")
 public class DashboardWidgetElement extends TestBenchElement {
+
+    /**
+     * Returns the title of the widget.
+     *
+     * @return the {@code widgetTitle} property from the web component
+     */
+    public String getTitle() {
+        return getPropertyString("widgetTitle");
+    }
 }