shoelace/src/components/visually-hidden/visually-hidden.ts

29 wiersze
814 B
TypeScript
Czysty Zwykły widok Historia

2021-11-16 14:31:38 +00:00
import { customElement } from 'lit/decorators.js';
2023-01-13 20:43:55 +00:00
import { html } from 'lit';
2022-08-17 15:37:37 +00:00
import ShoelaceElement from '../../internal/shoelace-element';
2021-11-16 14:31:38 +00:00
import styles from './visually-hidden.styles';
import type { CSSResultGroup } from 'lit';
2021-11-16 14:31:38 +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 The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/visually-hidden
2022-03-14 12:50:25 +00:00
* @status stable
2023-01-12 15:26:25 +00:00
* @since 2.0
2021-11-16 14:31:38 +00:00
*
2022-12-06 16:18:14 +00:00
* @slot - The content to be visually hidden.
2021-11-16 14:31:38 +00:00
*/
@customElement('sl-visually-hidden')
2022-08-17 15:37:37 +00:00
export default class SlVisuallyHidden extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2021-11-16 14:31:38 +00:00
render() {
return html` <slot></slot> `;
}
}
declare global {
interface HTMLElementTagNameMap {
'sl-visually-hidden': SlVisuallyHidden;
}
}