Newer
Older
alert / js / node_modules / flarum / forum / utils / Pane.d.ts
@Réz István Réz István on 18 Nov 2021 1 KB first commit
/**
 * The `Pane` class manages the page's discussion list sidepane. The pane is a
 * part of the content view (DiscussionPage component), but its visibility is
 * determined by CSS classes applied to the outer page element. This class
 * manages the application of those CSS classes.
 */
export default class Pane {
    constructor(element: any);
    /**
     * The localStorage key to store the pane's pinned state with.
     *
     * @type {String}
     * @protected
     */
    protected pinnedKey: string;
    /**
     * The page element.
     *
     * @type {jQuery}
     * @protected
     */
    protected $element: JQueryStatic;
    /**
     * Whether or not the pane is currently pinned.
     *
     * @type {Boolean}
     * @protected
     */
    protected pinned: boolean;
    /**
     * Whether or not the pane is currently exists.
     *
     * @type {Boolean}
     * @protected
     */
    protected active: boolean;
    /**
     * Whether or not the pane is currently showing, or is hidden off the edge
     * of the screen.
     *
     * @type {Boolean}
     * @protected
     */
    protected showing: boolean;
    /**
     * Enable the pane.
     *
     * @public
     */
    public enable(): void;
    /**
     * Disable the pane.
     *
     * @public
     */
    public disable(): void;
    /**
     * Show the pane.
     *
     * @public
     */
    public show(): void;
    /**
     * Hide the pane.
     *
     * @public
     */
    public hide(): void;
    /**
     * Begin a timeout to hide the pane, which can be cancelled by showing the
     * pane.
     *
     * @public
     */
    public onmouseleave(): void;
    hideTimeout: number;
    /**
     * Toggle whether or not the pane is pinned.
     *
     * @public
     */
    public togglePinned(): void;
    /**
     * Apply the appropriate CSS classes to the page element.
     *
     * @protected
     */
    protected render(): void;
}