Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: align vaadin-card JSDoc annotation in .d.ts file #8545

Merged
merged 1 commit into from
Jan 21, 2025
Merged

chore: align vaadin-card JSDoc annotation in .d.ts file #8545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions packages/card/src/vaadin-card.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

/**
* `<vaadin-card>` is a visual content container.
* `<vaadin-card>` 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
* <vaadin-card>
* <div>Card content</div>
* <vaadin-card theme="outlined cover-media">
* <img slot="media" width="200" src="..." alt="">
* <div slot="title">Lapland</div>
* <div slot="subtitle">The Exotic North</div>
* <div>Lapland is the northern-most region of Finland and an active outdoor destination.</div>
* <vaadin-button slot="footer">Book Vacation</vaadin-button>
* </vaadin-card>
* ```
*
* ### 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)) {}

Expand Down