From 6bfd770b864adc1505d61d1d86342ebfb181912c Mon Sep 17 00:00:00 2001 From: web-padawan Date: Tue, 21 Jan 2025 14:06:28 +0200 Subject: [PATCH] chore: align vaadin-card JSDoc annotation in .d.ts file --- packages/card/src/vaadin-card.d.ts | 32 +++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/packages/card/src/vaadin-card.d.ts b/packages/card/src/vaadin-card.d.ts index 774413b1796..09e68ccb782 100644 --- a/packages/card/src/vaadin-card.d.ts +++ b/packages/card/src/vaadin-card.d.ts @@ -7,13 +7,39 @@ import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js'; import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js'; /** - * `` is a visual content container. + * `` is a versatile container for grouping related content and actions. + * It presents information in a structured and visually appealing manner, with + * customization options to fit various design requirements. * * ```html - * - *
Card content
+ * + * + *
Lapland
+ *
The Exotic North
+ *
Lapland is the northern-most region of Finland and an active outdoor destination.
+ * Book Vacation *
* ``` + * + * ### Styling + * + * The following shadow DOM parts are available for styling: + * + * Part name | Description + * ----------|------------- + * `media` | The container for the media element (e.g., image, video, icon). Shown above of before the card content. + * `header` | The container for title and subtitle - or for custom header content - and header prefix and suffix elements. + * `content` | The container for the card content (usually text content). + * `footer` | The container for footer elements. This part is always at the bottom of the card. + * + * The following custom properties are available for styling: + * + * Custom property | Description | Default + * ----------------|-------------|------------- + * `--vaadin-card-padding` | The space between the card edge and its content. Needs to a unified value for all edges, i.e., a single length value. | `1em` + * `--vaadin-card-gap` | The space between content elements within the card. | `1em` + * + * See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation. */ declare class Card extends ElementMixin(ThemableMixin(HTMLElement)) {}