packages/modal/src/types.ts - develop - bearury/ui-kit-ce

packages/modal/src/types.ts
119 строк3 KB
Nemtsev Vyacheslav
feat(modal): добавлено свойство onAfterOpenChange
26 сен 2025, 10:54
26 сен 2025, 10:54eb4a90e
import * as React from 'react'
import { PortalProps } from '@v-uik/portal'
import {
  ComponentPropsWithRefFix,
  ComponentPropsWithAttributes,
} from '@v-uik/common'

import { Classes } from './classes'

interface ModalStylesProps {
  /**
   * Ширина модального окна.
   *
   * @inner
   */
  width?: number | string
}

export interface ModalProps
  extends ModalStylesProps,
    ComponentPropsWithRefFix<'div'> {
  /**
   * JSS-классы для стилизации.
   *
   * @inner
   */
  classes?: Partial<Classes>
  /**
   * Флаг открытия модального окна.
   *
   * @inner
   */
  open?: boolean
  /**
   * HTML-аттрибуты элемента фона окна.
   *
   * @inner
   */
  backdropProps?: ComponentPropsWithAttributes<ComponentPropsWithRefFix<'div'>>
  /**
   * HTML-аттрибуты элемента модального окна.
   *
   * @inner
   */
  contentProps?: ComponentPropsWithAttributes<ComponentPropsWithRefFix<'div'>>
  /**
   * HTML-элемент или функция, возвращающая HTML-элемент, в который рендерится children.
   *
   * @inner
   */
  container?: PortalProps['container']
  /**
   * Отключить срабатывание обработчика onClose при нажатии клавиши Esc.
   *
   * @inner
   */
  disableEscapePressHandler?: boolean
  /**
   * Отключить срабатывание обработчика onClose при клике за пределами модального окна.
   *
   * @inner
   */
  disableBackdropClickHandler?: boolean

  /**
   * Флаг отключения подложки модального окна.
   *
   * @inner
   */
  disableBackdrop?: boolean

  /**
   * Обработчик закрытия окна.
   *
   * @returns
   */
  onClose?: (
    event:
      | React.MouseEvent<HTMLDivElement>
      | React.KeyboardEvent<HTMLDivElement>
      | React.MouseEvent<HTMLButtonElement>
      | null
  ) => void

  /**
   * Флаг сохранения компонента в DOM после скрытия.
   *
   * @inner
   */
  keepMounted?: boolean

  /**
   * Определение положения модального окна по оси z.
   *
   * @inner
   */
  zIndex?: number
  /**
   * Функция обратного вызова, срабатывающая при изменении состояния `Modal` после окончания анимации.
   *
   * @param {boolean} open - значение флага открытия модального окна.
   *
   * @returns
   */
  onAfterOpenChange?: (open: boolean) => void
}

export type ShowOptions = Omit<ModalProps, 'open' | 'children' | 'onClose'> & {
  /**
   *
   * @inner
   */
  content?: React.ReactNode
  /**
   *
   * @returns
   */
  onClose?: () => void
}