@docsvision/webclient/Platform/ConnectPinButtonToMainMenuScript.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { BaseControl, BaseControlParams, BaseControlState } from "@docsvision/webclient/System/BaseControl";
import { LayoutScript, LayoutScriptParams, LayoutScriptState } from "@docsvision/webclient/System/LayoutScript";
/**
 * Содержит публичные свойства элемента управления [ConnectPinButtonToMainMenuScript]{@link ConnectPinButtonToMainMenuScript}.
 */
export declare class ConnectPinButtonToMainMenuScriptParams extends LayoutScriptParams {
    /** Название контрола с главным меню */
    mainMenuName: string;
    /** Название контрола с кнопкой прикрепления меню */
    pinButtonName: string;
    /** Класс иконки для прикрепления меню */
    pinIconClassName?: string;
    /** Класс иконки для открепления меню */
    unpinIconClassName?: string;
}
/** @internal */
export interface IConnectPinButtonToMainMenuScriptState extends ConnectPinButtonToMainMenuScriptParams, LayoutScriptState {
}
export interface ConnectPinButtonToMainMenuScriptState extends IConnectPinButtonToMainMenuScriptState {
}
/**
 * Класс для связывания главного меню и кнопки его прикрепления/открепления
 */
export declare class ConnectPinButtonToMainMenuScript extends LayoutScript<ConnectPinButtonToMainMenuScriptParams, IConnectPinButtonToMainMenuScriptState> {
    private mainMenu;
    private get pinButton();
    /** @internal */
    protected createParams(): ConnectPinButtonToMainMenuScriptParams;
    /** @internal */
    init(): void;
    /**
     * При нажатии на кнопку прикрепления меню
     */
    onPinButtonClick(): void;
    /**
     * При появлении/скрытии меню
     */
    onMenuToggle: (sender: BaseControl<BaseControlParams, BaseControlState>, data: boolean) => void;
    /**
     * Обновление иконки прикрепления меню
     */
    updateIcon(): void;
}