svantic/modules/modal/modal.svelte.d.ts

A set of Fomantic-UI components for Svelte framework

import { SvelteComponentTyped } from 'svelte/internal'
import { Module } from '../utils'
import ModalSettings from './settings'
import Header from './header.svelte.svelte'
import Content from './content.svelte'
import Actions from './actions.svelte'
import Description from './description.svelte'
import type { MountEvent } from '../../common'

interface ModalProps extends Module<ModalSettings> {
  size?: string
  basic?: boolean
  active?: boolean
  overlay?: boolean
  inverted?: boolean
  fullscreen?: boolean
}
/**
 * @escription Svantic Modal
 */
declare class Modal extends SvelteComponentTyped<ModalProps> {
  static Header: new () => Header
  static Content: new () => Content
  static Actions: new () => Actions
  static Description: new () => Description

  /**
   *@description 	Shows the modal
   */
  show(): void

  /**
   *@description 	Hides the modal
   */
  hide(): void

  /**
   *@description 	Toggles the modal
   */
  toggle(): void

  /**
   *@description 	Refreshes centering of modal on page
   */
  refresh(): void

  /**
   *@description 	Shows associated page dimmer
   */
  showDimmer(): void

  /**
   *@description 	Hides associated page dimmer
   */
  hideDimmer(): void

  /**
   *@description 	Hides all modals not selected modal in a dimmer
   */
  hideOthers(): void

  /**
   *@description 	Hides all visible modals in the same dimmer
   */
  hideAll(): void

  /**
   *@description 	Caches current modal size
   */
  cacheSizes(): void

  /**
   *@description 	Returns whether the modal can fit on the page
   */
  canFit(): Promise<boolean>

  /**
   *@description 	Returns whether the modal is active
   */
  isActive(): Promise<boolean>

  /**
   *@description 	Sets modal to active
   */
  setActive(): void

  ready(): Promise<void>
}
export default Modal