shoelace/src/components/card/card.ts

62 wiersze
2.2 KiB
TypeScript
Czysty Zwykły widok Historia

2021-09-29 12:40:26 +00:00
import { classMap } from 'lit/directives/class-map.js';
2023-01-13 20:43:55 +00:00
import { customElement } from 'lit/decorators.js';
2022-03-24 12:01:09 +00:00
import { HasSlotController } from '../../internal/slot';
2023-01-13 20:43:55 +00:00
import { html } from 'lit';
import ShoelaceElement from '../../internal/shoelace-element';
2021-07-10 00:45:44 +00:00
import styles from './card.styles';
import type { CSSResultGroup } from 'lit';
2020-07-22 20:02:49 +00:00
/**
Enrich components `@summary` with description from docs (#962) * keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
2022-10-21 13:56:35 +00:00
* @summary Cards can be used to group related subjects in a container.
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/card
2020-07-22 20:02:49 +00:00
* @status stable
2023-01-12 15:26:25 +00:00
* @since 2.0
2020-07-22 20:02:49 +00:00
*
2022-12-06 16:18:14 +00:00
* @slot - The card's main content.
* @slot header - An optional header for the card.
* @slot footer - An optional footer for the card.
* @slot image - An optional image to render at the start of the card.
2020-07-22 20:02:49 +00:00
*
2022-12-06 16:18:14 +00:00
* @csspart base - The component's base wrapper.
* @csspart image - The container that wraps the card's image.
* @csspart header - The container that wraps the card's header.
* @csspart body - The container that wraps the card's main content.
* @csspart footer - The container that wraps the card's footer.
*
2021-06-25 20:25:46 +00:00
* @cssproperty --border-color - The card's border color, including borders that occur inside the card.
2022-12-06 16:18:14 +00:00
* @cssproperty --border-radius - The border radius for the card's edges.
* @cssproperty --border-width - The width of the card's borders.
* @cssproperty --padding - The padding to use for the card's sections.
2020-07-22 20:02:49 +00:00
*/
2021-03-18 13:04:23 +00:00
@customElement('sl-card')
2022-08-17 15:37:37 +00:00
export default class SlCard extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2020-07-22 20:02:49 +00:00
private readonly hasSlotController = new HasSlotController(this, 'footer', 'header', 'image');
2020-07-22 20:02:49 +00:00
render() {
2021-02-26 14:09:13 +00:00
return html`
2020-07-22 20:02:49 +00:00
<div
part="base"
2021-02-26 14:09:13 +00:00
class=${classMap({
2020-07-22 20:02:49 +00:00
card: true,
'card--has-footer': this.hasSlotController.test('footer'),
'card--has-image': this.hasSlotController.test('image'),
'card--has-header': this.hasSlotController.test('header')
2021-02-26 14:09:13 +00:00
})}
2020-07-22 20:02:49 +00:00
>
2022-12-02 22:03:59 +00:00
<slot name="image" part="image" class="card__image"></slot>
<slot name="header" part="header" class="card__header"></slot>
<slot part="body" class="card__body"></slot>
<slot name="footer" part="footer" class="card__footer"></slot>
2020-07-22 20:02:49 +00:00
</div>
2021-02-26 14:09:13 +00:00
`;
2020-07-22 20:02:49 +00:00
}
}
2021-03-12 14:09:08 +00:00
declare global {
interface HTMLElementTagNameMap {
'sl-card': SlCard;
}
}