docs: add list of slots to JSDoc annotation

vaadin · Jan 16, 2025 · 3538579 · 3538579
1 parent 483e5f7
commit 3538579
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/packages/horizontal-layout/src/vaadin-horizontal-layout.d.ts b/packages/horizontal-layout/src/vaadin-horizontal-layout.d.ts
@@ -27,6 +27,16 @@ import { HorizontalLayoutMixin } from './vaadin-horizontal-layout-mixin.js';
  * `theme="padding"` | Applies the default amount of CSS padding for the host element (specified by the theme)
  * `theme="spacing"` | Applies the default amount of CSS margin between items (specified by the theme)
  * `theme="wrap"` | Items wrap to the next row when they exceed the layout width
+ *
+ * ### Component's slots
+ *
+ * The following slots are available to be set:
+ *
+ * Slot name          | Description
+ * -------------------|---------------
+ * no name            | Default slot
+ * `middle`           | Slot for the content placed in the middle
+ * `end`              | Slot for the content placed at the end
  */
 declare class HorizontalLayout extends HorizontalLayoutMixin(ThemableMixin(ElementMixin(HTMLElement))) {}
 

diff --git a/packages/horizontal-layout/src/vaadin-horizontal-layout.js b/packages/horizontal-layout/src/vaadin-horizontal-layout.js
@@ -33,6 +33,16 @@ registerStyles('vaadin-horizontal-layout', horizontalLayoutStyles, { moduleId: '
  * `theme="spacing"` | Applies the default amount of CSS margin between items (specified by the theme)
  * `theme="wrap"` | Items wrap to the next row when they exceed the layout width
  *
+ * ### Component's slots
+ *
+ * The following slots are available to be set:
+ *
+ * Slot name          | Description
+ * -------------------|---------------
+ * no name            | Default slot
+ * `middle`           | Slot for the content placed in the middle
+ * `end`              | Slot for the content placed at the end
+ *
  * @customElement
  * @extends HTMLElement
  * @mixes ThemableMixin