import { html, LitElement } from 'lit'; import { customElement, property, query } from 'lit/decorators.js'; import { classMap } from 'lit/directives/class-map.js'; import { ifDefined } from 'lit/directives/if-defined.js'; import '~/components/icon-button/icon-button'; import { animateTo, stopAnimations } from '~/internal/animate'; import { emit, waitForEvent } from '~/internal/event'; import Modal from '~/internal/modal'; import { lockBodyScrolling, unlockBodyScrolling } from '~/internal/scroll'; import { HasSlotController } from '~/internal/slot'; import { uppercaseFirstLetter } from '~/internal/string'; import { watch } from '~/internal/watch'; import { getAnimation, setDefaultAnimation } from '~/utilities/animation-registry'; import { LocalizeController } from '~/utilities/localize'; import styles from './drawer.styles'; /** * @since 2.0 * @status stable * * @dependency sl-icon-button * * @slot - The drawer's content. * @slot label - The drawer's label. Alternatively, you can use the label prop. * @slot footer - The drawer's footer, usually one or more buttons representing various options. * * @event sl-show - Emitted when the drawer opens. * @event sl-after-show - Emitted after the drawer opens and all animations are complete. * @event sl-hide - Emitted when the drawer closes. * @event sl-after-hide - Emitted after the drawer closes and all animations are complete. * @event sl-initial-focus - Emitted when the drawer opens and is ready to receive focus. Calling * `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input. * @event {{ source: 'close-button' | 'keyboard' | 'overlay' }} sl-request-close - Emitted when the user attempts to * close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling * `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in * destructive behavior such as data loss. * * @csspart base - The component's internal wrapper. * @csspart overlay - The overlay. * @csspart panel - The drawer panel (where the drawer and its content is rendered). * @csspart header - The drawer header. * @csspart title - The drawer title. * @csspart close-button - The close button. * @csspart close-button__base - The close button's `base` part. * @csspart body - The drawer body. * @csspart footer - The drawer footer. * * @cssproperty --size - The preferred size of the drawer. This will be applied to the drawer's width or height * depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens. * @cssproperty --header-spacing - The amount of padding to use for the header. * @cssproperty --body-spacing - The amount of padding to use for the body. * @cssproperty --footer-spacing - The amount of padding to use for the footer. * * @animation drawer.showTop - The animation to use when showing a drawer with `top` placement. * @animation drawer.showEnd - The animation to use when showing a drawer with `end` placement. * @animation drawer.showBottom - The animation to use when showing a drawer with `bottom` placement. * @animation drawer.showStart - The animation to use when showing a drawer with `start` placement. * @animation drawer.hideTop - The animation to use when hiding a drawer with `top` placement. * @animation drawer.hideEnd - The animation to use when hiding a drawer with `end` placement. * @animation drawer.hideBottom - The animation to use when hiding a drawer with `bottom` placement. * @animation drawer.hideStart - The animation to use when hiding a drawer with `start` placement. * @animation drawer.denyClose - The animation to use when a request to close the drawer is denied. * @animation drawer.overlay.show - The animation to use when showing the drawer's overlay. * @animation drawer.overlay.hide - The animation to use when hiding the drawer's overlay. */ @customElement('sl-drawer') export default class SlDrawer extends LitElement { static styles = styles; @query('.drawer') drawer: HTMLElement; @query('.drawer__panel') panel: HTMLElement; @query('.drawer__overlay') overlay: HTMLElement; private readonly hasSlotController = new HasSlotController(this, 'footer'); private readonly localize = new LocalizeController(this); private modal: Modal; private originalTrigger: HTMLElement | null; /** Indicates whether or not the drawer is open. You can use this in lieu of the show/hide methods. */ @property({ type: Boolean, reflect: true }) open = false; /** * The drawer's label as displayed in the header. You should always include a relevant label even when using * `no-header`, as it is required for proper accessibility. */ @property({ reflect: true }) label = ''; /** The direction from which the drawer will open. */ @property({ reflect: true }) placement: 'top' | 'end' | 'bottom' | 'start' = 'end'; /** * By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of * its parent element, set this prop and add `position: relative` to the parent. */ @property({ type: Boolean, reflect: true }) contained = false; /** * Removes the header. This will also remove the default close button, so please ensure you provide an easy, * accessible way for users to dismiss the drawer. */ @property({ attribute: 'no-header', type: Boolean, reflect: true }) noHeader = false; connectedCallback() { super.connectedCallback(); this.modal = new Modal(this); } firstUpdated() { this.drawer.hidden = !this.open; if (this.open && !this.contained) { this.modal.activate(); lockBodyScrolling(this); } } disconnectedCallback() { super.disconnectedCallback(); unlockBodyScrolling(this); } /** Shows the drawer. */ async show() { if (this.open) { return undefined; } this.open = true; return waitForEvent(this, 'sl-after-show'); } /** Hides the drawer */ async hide() { if (!this.open) { return undefined; } this.open = false; return waitForEvent(this, 'sl-after-hide'); } private requestClose(source: 'close-button' | 'keyboard' | 'overlay') { const slRequestClose = emit(this, 'sl-request-close', { cancelable: true, detail: { source } }); if (slRequestClose.defaultPrevented) { const animation = getAnimation(this, 'drawer.denyClose'); animateTo(this.panel, animation.keyframes, animation.options); return; } this.hide(); } handleKeyDown(event: KeyboardEvent) { if (event.key === 'Escape') { event.stopPropagation(); this.requestClose('keyboard'); } } @watch('open', { waitUntilFirstUpdate: true }) async handleOpenChange() { if (this.open) { // Show emit(this, 'sl-show'); this.originalTrigger = document.activeElement as HTMLElement; // Lock body scrolling only if the drawer isn't contained if (!this.contained) { this.modal.activate(); lockBodyScrolling(this); } // When the drawer is shown, Safari will attempt to set focus on whatever element has autofocus. This causes the // drawer's animation to jitter, so we'll temporarily remove the attribute, call `focus({ preventScroll: true })` // ourselves, and add the attribute back afterwards. // // Related: https://github.com/shoelace-style/shoelace/issues/693 // const autoFocusTarget = this.querySelector('[autofocus]'); if (autoFocusTarget) { autoFocusTarget.removeAttribute('autofocus'); } await Promise.all([stopAnimations(this.drawer), stopAnimations(this.overlay)]); this.drawer.hidden = false; // Set initial focus requestAnimationFrame(() => { const slInitialFocus = emit(this, 'sl-initial-focus', { cancelable: true }); if (!slInitialFocus.defaultPrevented) { // Set focus to the autofocus target and restore the attribute if (autoFocusTarget) { (autoFocusTarget as HTMLInputElement).focus({ preventScroll: true }); } else { this.panel.focus({ preventScroll: true }); } } // Restore the autofocus attribute if (autoFocusTarget) { autoFocusTarget.setAttribute('autofocus', ''); } }); const panelAnimation = getAnimation(this, `drawer.show${uppercaseFirstLetter(this.placement)}`); const overlayAnimation = getAnimation(this, 'drawer.overlay.show'); await Promise.all([ animateTo(this.panel, panelAnimation.keyframes, panelAnimation.options), animateTo(this.overlay, overlayAnimation.keyframes, overlayAnimation.options) ]); emit(this, 'sl-after-show'); } else { // Hide emit(this, 'sl-hide'); this.modal.deactivate(); unlockBodyScrolling(this); await Promise.all([stopAnimations(this.drawer), stopAnimations(this.overlay)]); const panelAnimation = getAnimation(this, `drawer.hide${uppercaseFirstLetter(this.placement)}`); const overlayAnimation = getAnimation(this, 'drawer.overlay.hide'); await Promise.all([ animateTo(this.panel, panelAnimation.keyframes, panelAnimation.options), animateTo(this.overlay, overlayAnimation.keyframes, overlayAnimation.options) ]); this.drawer.hidden = true; // Restore focus to the original trigger const trigger = this.originalTrigger; if (typeof trigger?.focus === 'function') { setTimeout(() => trigger.focus()); } emit(this, 'sl-after-hide'); } } render() { /* eslint-disable lit-a11y/click-events-have-key-events */ return html`
this.requestClose('overlay')} tabindex="-1">
`; /* eslint-enable lit-a11y/click-events-have-key-events */ } } // Top setDefaultAnimation('drawer.showTop', { keyframes: [ { opacity: 0, transform: 'translateY(-100%)' }, { opacity: 1, transform: 'translateY(0)' } ], options: { duration: 250, easing: 'ease' } }); setDefaultAnimation('drawer.hideTop', { keyframes: [ { opacity: 1, transform: 'translateY(0)' }, { opacity: 0, transform: 'translateY(-100%)' } ], options: { duration: 250, easing: 'ease' } }); // End setDefaultAnimation('drawer.showEnd', { keyframes: [ { opacity: 0, transform: 'translateX(100%)' }, { opacity: 1, transform: 'translateX(0)' } ], options: { duration: 250, easing: 'ease' } }); setDefaultAnimation('drawer.hideEnd', { keyframes: [ { opacity: 1, transform: 'translateX(0)' }, { opacity: 0, transform: 'translateX(100%)' } ], options: { duration: 250, easing: 'ease' } }); // Bottom setDefaultAnimation('drawer.showBottom', { keyframes: [ { opacity: 0, transform: 'translateY(100%)' }, { opacity: 1, transform: 'translateY(0)' } ], options: { duration: 250, easing: 'ease' } }); setDefaultAnimation('drawer.hideBottom', { keyframes: [ { opacity: 1, transform: 'translateY(0)' }, { opacity: 0, transform: 'translateY(100%)' } ], options: { duration: 250, easing: 'ease' } }); // Start setDefaultAnimation('drawer.showStart', { keyframes: [ { opacity: 0, transform: 'translateX(-100%)' }, { opacity: 1, transform: 'translateX(0)' } ], options: { duration: 250, easing: 'ease' } }); setDefaultAnimation('drawer.hideStart', { keyframes: [ { opacity: 1, transform: 'translateX(0)' }, { opacity: 0, transform: 'translateX(-100%)' } ], options: { duration: 250, easing: 'ease' } }); // Deny close setDefaultAnimation('drawer.denyClose', { keyframes: [{ transform: 'scale(1)' }, { transform: 'scale(1.01)' }, { transform: 'scale(1)' }], options: { duration: 250 } }); // Overlay setDefaultAnimation('drawer.overlay.show', { keyframes: [{ opacity: 0 }, { opacity: 1 }], options: { duration: 250 } }); setDefaultAnimation('drawer.overlay.hide', { keyframes: [{ opacity: 1 }, { opacity: 0 }], options: { duration: 250 } }); declare global { interface HTMLElementTagNameMap { 'sl-drawer': SlDrawer; } }