v-dialogs/types/drawer.d.ts

A simple command-style pop-up dialog components for Vue3

import { DialogBaseOptions, ContainerDialog, ContainerDialogBox } from './base'

export declare interface DrawerOptions extends DialogBaseOptions {
  /**
   * Display the header
   * @default true
   */
  header?: boolean
  /**
   * The title text displayed in header
   */
  title?: string
  /**
   * Dialog width
   */
  width?: number
  /**
   * Dialog height
   */
  height?: number
  /** The parameters pass to component as props */
  params?: Record<string, unknown>
  /**
   * The close dialog button in header
   * @default true
   */
  closeButton?: boolean
  /**
   * The drawer dialog placement
   * @default `right`
   */
  placement?: 'left' | 'right' | 'top' | 'bottom'
  /**
   * Drawer dialog rounded border
   * @default true
   */
  rounded?: boolean
  /**
   * Display drawer dialog backdrop
   * @default true
   */
  backdrop?: boolean
  /**
   * Backdrop click to close dialog
   * @default true
   */
  backdropClose?: boolean
  /**
   * Event responder
   * @param eventName
   * @param data
   * @returns
   */
  callback?: (eventName: string, data?: unknown[]) => void
}

/**
 * Display a drawer dialog
 * @param component - The component to display
 * @param options - custom options
 * @returns the method to close dialog
 */
export declare const DialogDrawer: typeof ContainerDialog<DrawerOptions>
/**
 * Use component to display content in a drawer dialog
 */
export declare const DialogDrawerBox: ContainerDialogBox<DrawerOptions>