import Modal from '../../internal/modal.js'; import ShoelaceElement from '../../internal/shoelace-element.js'; import SlIconButton from '../icon-button/icon-button.component.js'; import type { CSSResultGroup } from 'lit'; /** * @summary Drawers slide in from a container to expose additional options and information. * @documentation https://shoelace.style/components/drawer * @status stable * @since 2.0 * * @dependency sl-icon-button * * @slot - The drawer's main content. * @slot label - The drawer's label. Alternatively, you can use the `label` attribute. * @slot header-actions - Optional actions to add to the header. Works best with ``. * @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 base wrapper. * @csspart overlay - The overlay that covers the screen behind the drawer. * @csspart panel - The drawer's panel (where the drawer and its content are rendered). * @csspart header - The drawer's header. This element wraps the title and header actions. * @csspart header-actions - Optional actions to add to the header. Works best with ``. * @csspart title - The drawer's title. * @csspart close-button - The close button, an ``. * @csspart close-button__base - The close button's exported `base` part. * @csspart body - The drawer's body. * @csspart footer - The drawer's 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. * * @property modal - Exposes the internal modal utility that controls focus trapping. To temporarily disable focus * trapping and allow third-party modals spawned from an active Shoelace modal, call `modal.activateExternal()` when * the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Shoelace's focus trapping. */ export default class SlDrawer extends ShoelaceElement { static styles: CSSResultGroup; static dependencies: { 'sl-icon-button': typeof SlIconButton; }; private readonly hasSlotController; private readonly localize; private originalTrigger; modal: Modal; private closeWatcher; drawer: HTMLElement; panel: HTMLElement; overlay: HTMLElement; /** * Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can * use the `show()` and `hide()` methods and this attribute will reflect the drawer's open state. */ open: boolean; /** * 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. If you need to display HTML, use the `label` slot instead. */ label: string; /** The direction from which the drawer will open. */ placement: 'top' | 'end' | 'bottom' | 'start'; /** * 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 attribute and add `position: relative` to the parent. */ contained: boolean; /** * 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. */ noHeader: boolean; firstUpdated(): void; disconnectedCallback(): void; private requestClose; private addOpenListeners; private removeOpenListeners; private handleDocumentKeyDown; handleOpenChange(): Promise; handleNoModalChange(): void; /** Shows the drawer. */ show(): Promise; /** Hides the drawer */ hide(): Promise; render(): import("lit-html").TemplateResult<1>; }