Pilot-ComponentKit
  2. /
  3. Common API Reference
  4. /
  5. Dialog

Dialog

Dialog – класс для создания диалоговых окон

ElementClass

ElementClass – интерфейс, добавляющий названия классов к заголовку, контенту и панели к которой прикреплен диалог.

export interface ElementClass {
  //Свойство, которое устанавливает класс панели к которой прикреплен диалог.
  panelClassName?: string;
  //Свойство, которое устанавливает класс контента диалога.
  contentClassName?: string;
  //Свойство, которое устанавливает класс заголовока диалога.
  headerClassName?: string;
}

Конструктор

  constructor(id: string, panelToAttach: HTMLElement);

где:
id– идентификатор диалога.
panelToAttach – элемент на странице к которому будет прикреплено диалоговое окно.

Свойства

dialog

Получает созданный элемент диалога.

get dialog(): HTMLElement;

dialogContent

Получает созданный элемент контента внутри диалога.

get dialogContent(): HTMLElement;

resizable

Получает флаг, который показывает возможность изменения размеров окна.

get resizable(): boolean;

Методы

setDialogContent()

Устанавливает содержимое диалога и возвращает класс Dialog.

setDialogContent(value: HTMLElement): Dialog

где:
value - HTML представление элемента.

setHeader()

Устанавливает заголовок диалога и возвращает класс Dialog.

setHeader(value: HTMLElement): Dialog

где:
value - HTML представление элемента.

setCaption()

Устанавливает текст заголовка диалога и возвращает класс Dialog.

setCaption(value: string) : Dialog

где:
value - текст заголовка.

setSvgIcon()

Метод позволяет установить иконку заголовка диалога в виде svg и возвращает класс Dialog.

setSvgIcon(template: string): Dialog

где:
template - svg элемент иконки в виде строки.

setFooter()

Устанавливает нижний колонтитул диалога и возвращает класс Dialog.

setFooter(value: HTMLElement): Dialog

где:
value - HTML представление элемента.

setDialogElementClassNames()

Устанавливает css классы содержимого в диалоговом окне и возвращает класс Dialog.

setDialogElementClassNames(value: ElementClass): Dialog

где:
value - объект с названиями классов для элементов внутри диалога.

setSize()

Устанавливает размеры диалога, возвращает класс Dialog.

setSize(width: number, height: number): Dialog

где:
width - ширина диалога. height - высота диалога.

setResizable()

Устанавливает возможность изменения ширины и высоты диалога, возвращает класс Dialog.

setResizable(value: boolean): Dialog

где:
value - флаг для назначения включения и выключения возможности изменения размеров окна.

setWindowOptions()

Устанавливает настройки для измнения положения и ширины/высоты диалога, возвращает класс Dialog. Без этой опции диалог не будет сохранять свои изменённые свойства. Подробнее: IWindowStateOptions.

setWindowOptions(value: IWindowStateOptions): Dialog

где:
value - настройки для работы измнения положения и ширины/высоты диалога.

setDraggable()

Устанавливает возможность изменения положения диалога, возвращает класс Dialog.

setDraggable(value: boolean): Dialog

где:
value - флаг для назначения включения/выключения возможности изменения положения.

setCloseble(value: boolean): Dialog

Устанавливает возможность закрытия диалога, возвращает класс Dialog.

setCloseble(value: boolean): Dialog

где:
value - флаг для назначения включения/выключения возможности закрытия диалога.

openDialog()

Создаёт компонет диалога на panelToAttach и возвращает его как HTMLElement.

openDialog(): HTMLElement

destroyDialog()

Уничтожает компонет диалога.

destroyDialog(): void

isDialogShown()

Возвращает состояние диалога, закрыт/открыт.

isDialogShown(): boolean

subscribe()

Подписка на состояние диалога, закрыт/открыт.

subscribe(fn: (state: boolean) => void): void

где:
fn - функция callback для обработки события открытия/закрытия окна. state - состояние открыт или закрыт диалог.

subscribeToResizeStart()

Подписка на событие изменения ширины или высоты диалога, отрабатывает в начале события.

subscribeToResizeStart(fn: () => void): void

где:
fn - функция callback для обработки события изменения ширины/высоты.

subscribeToResizeEnd()

Подписка на событие изменения ширины или высоты диалога, отрабатывает в конце события.

subscribeToResizeEnd(fn: () => void): void

где:
fn - функция callback для обработки события изменения ширины/высоты.