docs: rename header to header content

vaadin · Oct 1, 2024 · 0a9cbc4 · 0a9cbc4
1 parent ac84cbb
commit 0a9cbc4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/packages/dashboard/src/vaadin-dashboard-widget.d.ts b/packages/dashboard/src/vaadin-dashboard-widget.d.ts
@@ -17,7 +17,7 @@ import { DashboardItemMixin } from './vaadin-dashboard-item-mixin.js';
  *
  * ```html
  * <vaadin-dashboard-widget widget-title="Title">
- *   <span slot="header">Header</span>
+ *   <span slot="header-content">Header</span>
  *   <div>Content</div>
  * </vaadin-dashboard-widget>
  * ```
@@ -26,16 +26,16 @@ import { DashboardItemMixin } from './vaadin-dashboard-item-mixin.js';
  *
  * You can configure the item by using `slot` names.
  *
- * Slot name | Description
- * ----------|-------------
- * `title`   | A slot for the widget title. Overrides the `widgetTitle` property.
- * `header`  | A slot for the widget header.
+ * Slot name        | Description
+ * -----------------|-------------
+ * `title`          | A slot for the widget title. Overrides the `widgetTitle` property.
+ * `header-content` | A slot for the widget header content.
  *
  * #### Example
  *
  * ```html
  * <vaadin-dashboard-widget>
- *   <span slot="header">Header</span>
+ *   <span slot="header-content">Header</span>
  *   <span slot="title">Title</span>
  *   <div>Content</div>
  * </vaadin-dashboard-widget>

diff --git a/packages/dashboard/src/vaadin-dashboard-widget.js b/packages/dashboard/src/vaadin-dashboard-widget.js
@@ -24,7 +24,7 @@ import { getDefaultI18n } from './vaadin-dashboard-item-mixin.js';
  *
  * ```html
  * <vaadin-dashboard-widget widget-title="Title">
- *   <span slot="header">Header</span>
+ *   <span slot="header-content">Header</span>
  *   <div>Content</div>
  * </vaadin-dashboard-widget>
  * ```
@@ -33,16 +33,16 @@ import { getDefaultI18n } from './vaadin-dashboard-item-mixin.js';
  *
  * You can configure the item by using `slot` names.
  *
- * Slot name | Description
- * ----------|-------------
- * `title`   | A slot for the widget title. Overrides the `widgetTitle` property.
- * `header`  | A slot for the widget header.
+ * Slot name        | Description
+ * -----------------|-------------
+ * `title`          | A slot for the widget title. Overrides the `widgetTitle` property.
+ * `header-content` | A slot for the widget header content.
  *
  * #### Example
  *
  * ```html
  * <vaadin-dashboard-widget>
- *   <span slot="header">Header</span>
+ *   <span slot="header-content">Header</span>
  *   <span slot="title">Title</span>
  *   <div>Content</div>
  * </vaadin-dashboard-widget>