mirror of
https://github.com/flarum/core.git
synced 2025-08-09 01:46:35 +02:00
Bundled output for commit 3537f76eab
Includes transpiled JS/TS, and Typescript declaration files (typings). [skip ci]
This commit is contained in:
89
js/dist-typings/forum/utils/Pane.d.ts
vendored
Normal file
89
js/dist-typings/forum/utils/Pane.d.ts
vendored
Normal file
@@ -0,0 +1,89 @@
|
||||
/**
|
||||
* 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 | undefined;
|
||||
/**
|
||||
* 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;
|
||||
}
|
Reference in New Issue
Block a user