shoelace/src/components/resize-observer/resize-observer.ts

91 wiersze
2.4 KiB
TypeScript
Czysty Zwykły widok Historia

2021-10-07 13:31:20 +00:00
import { customElement, property } from 'lit/decorators.js';
2023-01-13 20:43:55 +00:00
import { html } from 'lit';
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-07-10 00:45:44 +00:00
import styles from './resize-observer.styles';
import type { CSSResultGroup } from 'lit';
2021-02-26 14:09:13 +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 Resize Observer component offers a thin, declarative interface to the [`ResizeObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/resize-observer
2021-03-23 12:43:38 +00:00
* @status stable
2023-01-12 15:26:25 +00:00
* @since 2.0
*
2021-09-30 21:16:27 +00:00
* @slot - One or more elements to watch for resizing.
*
2021-06-25 20:25:46 +00:00
* @event {{ entries: ResizeObserverEntry[] }} sl-resize - Emitted when the element is resized.
2021-02-26 14:09:13 +00:00
*/
2021-03-18 13:04:23 +00:00
@customElement('sl-resize-observer')
2022-08-17 15:37:37 +00:00
export default class SlResizeObserver extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2021-02-26 14:09:13 +00:00
private resizeObserver: ResizeObserver;
private observedElements: HTMLElement[] = [];
2021-10-07 13:31:20 +00:00
/** Disables the observer. */
@property({ type: Boolean, reflect: true }) disabled = false;
2021-03-06 17:01:39 +00:00
connectedCallback() {
super.connectedCallback();
2021-03-15 17:02:49 +00:00
this.resizeObserver = new ResizeObserver((entries: ResizeObserverEntry[]) => {
2022-09-16 20:21:40 +00:00
this.emit('sl-resize', { detail: { entries } });
2021-03-15 17:02:49 +00:00
});
2021-10-07 13:31:20 +00:00
if (!this.disabled) {
this.startObserver();
}
2021-02-26 14:09:13 +00:00
}
2021-03-06 17:01:39 +00:00
disconnectedCallback() {
super.disconnectedCallback();
2021-10-07 13:31:20 +00:00
this.stopObserver();
2021-02-26 14:09:13 +00:00
}
2023-01-03 20:04:07 +00:00
private handleSlotChange() {
2021-10-07 13:31:20 +00:00
if (!this.disabled) {
this.startObserver();
}
}
2023-01-03 20:04:07 +00:00
private startObserver() {
const slot = this.shadowRoot!.querySelector('slot');
2021-02-26 14:09:13 +00:00
if (slot !== null) {
2021-10-07 13:31:20 +00:00
const elements = slot.assignedElements({ flatten: true }) as HTMLElement[];
2021-02-26 14:09:13 +00:00
2021-10-07 13:31:20 +00:00
// Unwatch previous elements
this.observedElements.forEach(el => this.resizeObserver.unobserve(el));
2021-10-07 13:31:20 +00:00
this.observedElements = [];
// Watch new elements
elements.forEach(el => {
2021-10-07 13:31:20 +00:00
this.resizeObserver.observe(el);
this.observedElements.push(el);
});
}
}
2023-01-03 20:04:07 +00:00
private stopObserver() {
2021-10-07 13:31:20 +00:00
this.resizeObserver.disconnect();
}
@watch('disabled', { waitUntilFirstUpdate: true })
handleDisabledChange() {
if (this.disabled) {
this.stopObserver();
} else {
this.startObserver();
}
2021-02-26 14:09:13 +00:00
}
render() {
2021-03-06 17:01:39 +00:00
return html` <slot @slotchange=${this.handleSlotChange}></slot> `;
2021-02-26 14:09:13 +00:00
}
}
2021-03-12 14:09:08 +00:00
declare global {
interface HTMLElementTagNameMap {
'sl-resize-observer': SlResizeObserver;
}
}