shoelace/src/components/divider/divider.ts

40 wiersze
1.1 KiB
TypeScript
Czysty Zwykły widok Historia

2021-09-29 12:03:03 +00:00
import { customElement, property } from 'lit/decorators.js';
2022-03-24 12:01:09 +00:00
import { watch } from '../../internal/watch';
2023-01-13 20:43:55 +00:00
import ShoelaceElement from '../../internal/shoelace-element';
2021-09-29 12:03:03 +00:00
import styles from './divider.styles';
import type { CSSResultGroup } from 'lit';
2021-09-29 12:03:03 +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 Dividers are used to visually separate or group elements.
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/divider
2021-09-29 12:03:03 +00:00
* @status stable
2023-01-12 15:26:25 +00:00
* @since 2.0
2021-09-29 12:03:03 +00:00
*
* @cssproperty --color - The color of the divider.
* @cssproperty --width - The width of the divider.
* @cssproperty --spacing - The spacing of the divider.
2021-09-29 12:03:03 +00:00
*/
@customElement('sl-divider')
2022-08-17 15:37:37 +00:00
export default class SlDivider extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2021-09-29 12:03:03 +00:00
/** Draws the divider in a vertical orientation. */
@property({ type: Boolean, reflect: true }) vertical = false;
2022-07-20 20:46:06 +00:00
connectedCallback() {
super.connectedCallback();
2021-09-29 12:03:03 +00:00
this.setAttribute('role', 'separator');
}
@watch('vertical')
handleVerticalChange() {
this.setAttribute('aria-orientation', this.vertical ? 'vertical' : 'horizontal');
}
}
declare global {
interface HTMLElementTagNameMap {
'sl-divider': SlDivider;
}
}