95 lines
4.9 KiB
TypeScript
Executable file
95 lines
4.9 KiB
TypeScript
Executable file
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 Dialogs, sometimes called "modals", appear above the page and require the user's immediate attention.
|
|
* @documentation https://shoelace.style/components/dialog
|
|
* @status stable
|
|
* @since 2.0
|
|
*
|
|
* @dependency sl-icon-button
|
|
*
|
|
* @slot - The dialog's main content.
|
|
* @slot label - The dialog's label. Alternatively, you can use the `label` attribute.
|
|
* @slot header-actions - Optional actions to add to the header. Works best with `<sl-icon-button>`.
|
|
* @slot footer - The dialog's footer, usually one or more buttons representing various options.
|
|
*
|
|
* @event sl-show - Emitted when the dialog opens.
|
|
* @event sl-after-show - Emitted after the dialog opens and all animations are complete.
|
|
* @event sl-hide - Emitted when the dialog closes.
|
|
* @event sl-after-hide - Emitted after the dialog closes and all animations are complete.
|
|
* @event sl-initial-focus - Emitted when the dialog 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 dialog by clicking the close button, clicking the overlay, or pressing escape. Calling
|
|
* `event.preventDefault()` will keep the dialog open. Avoid using this unless closing the dialog 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 dialog.
|
|
* @csspart panel - The dialog's panel (where the dialog and its content are rendered).
|
|
* @csspart header - The dialog's header. This element wraps the title and header actions.
|
|
* @csspart header-actions - Optional actions to add to the header. Works best with `<sl-icon-button>`.
|
|
* @csspart title - The dialog's title.
|
|
* @csspart close-button - The close button, an `<sl-icon-button>`.
|
|
* @csspart close-button__base - The close button's exported `base` part.
|
|
* @csspart body - The dialog's body.
|
|
* @csspart footer - The dialog's footer.
|
|
*
|
|
* @cssproperty --width - The preferred width of the dialog. Note that the dialog 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 dialog.show - The animation to use when showing the dialog.
|
|
* @animation dialog.hide - The animation to use when hiding the dialog.
|
|
* @animation dialog.denyClose - The animation to use when a request to close the dialog is denied.
|
|
* @animation dialog.overlay.show - The animation to use when showing the dialog's overlay.
|
|
* @animation dialog.overlay.hide - The animation to use when hiding the dialog'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 SlDialog extends ShoelaceElement {
|
|
static styles: CSSResultGroup;
|
|
static dependencies: {
|
|
'sl-icon-button': typeof SlIconButton;
|
|
};
|
|
private readonly hasSlotController;
|
|
private readonly localize;
|
|
private originalTrigger;
|
|
modal: Modal;
|
|
private closeWatcher;
|
|
dialog: HTMLElement;
|
|
panel: HTMLElement;
|
|
overlay: HTMLElement;
|
|
/**
|
|
* Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can
|
|
* use the `show()` and `hide()` methods and this attribute will reflect the dialog's open state.
|
|
*/
|
|
open: boolean;
|
|
/**
|
|
* The dialog'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;
|
|
/**
|
|
* Disables the header. This will also remove the default close button, so please ensure you provide an easy,
|
|
* accessible way for users to dismiss the dialog.
|
|
*/
|
|
noHeader: boolean;
|
|
firstUpdated(): void;
|
|
disconnectedCallback(): void;
|
|
private requestClose;
|
|
private addOpenListeners;
|
|
private removeOpenListeners;
|
|
private handleDocumentKeyDown;
|
|
handleOpenChange(): Promise<void>;
|
|
/** Shows the dialog. */
|
|
show(): Promise<void>;
|
|
/** Hides the dialog */
|
|
hide(): Promise<void>;
|
|
render(): import("lit-html").TemplateResult<1>;
|
|
}
|