Class Pane

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.

Hierarchy

  • Pane

Constructors

constructor

Properties

$element active hideTimeout pinned pinnedKey showing

Methods

disable enable hide onmouseleave render show togglePinned

Constructors

constructor

Properties

Protected $element

$element: JQueryStatic

The page element.

Protected active

active: boolean

Whether or not the pane is currently exists.

hideTimeout

hideTimeout: undefined | Timeout

Protected pinned

pinned: boolean

Whether or not the pane is currently pinned.

Protected pinnedKey

pinnedKey: string

The localStorage key to store the pane's pinned state with.

Protected showing

showing: boolean

Whether or not the pane is currently showing, or is hidden off the edge of the screen.

Methods

disable

enable

hide

onmouseleave

  • Begin a timeout to hide the pane, which can be cancelled by showing the pane.

    Returns void

Protected render

show

togglePinned

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.24