@vaadin/dialog/src/vaadin-dialog-overlay-mixin.d.ts

vaadin-dialog

/**
 * @license
 * Copyright (c) 2017 - 2026 Vaadin Ltd.
 * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
 */
import type { Constructor } from '@open-wc/dedupe-mixin';
import type { OverlayMixinClass } from '@vaadin/overlay/src/vaadin-overlay-mixin.js';
import type { DialogRenderer } from './vaadin-dialog.js';

export type DialogOverlayBounds = {
  top: number;
  left: number;
  width: number;
  height: number;
};

export declare function DialogOverlayMixin<T extends Constructor<HTMLElement>>(
  base: T,
): Constructor<DialogOverlayMixinClass> & Constructor<OverlayMixinClass> & T;

export declare class DialogOverlayMixinClass {
  /**
   * String used for rendering a dialog title.
   * @attr {string} header-title
   */
  headerTitle: string;

  /**
   * Whether to keep the overlay within the viewport.
   */
  keepInViewport: boolean;

  /**
   * Custom function for rendering the dialog header.
   */
  headerRenderer: DialogRenderer | null | undefined;

  /**
   * Custom function for rendering the dialog footer.
   */
  footerRenderer: DialogRenderer | null | undefined;

  /**
   * Retrieves the coordinates of the overlay.
   */
  getBounds(): DialogOverlayBounds;
}