Namespace Railgun.ShowHideSiderail
A wrapper object containing functionality for the a feature of Railgun that
expands the content area. The siderailHidden property of this object
has a counterpart in localStorage.
- Defined in: RailgunClient.js
| Field Attributes | Field Name and Description |
|---|---|
| <static> <constant> | Railgun.ShowHideSiderail.leftArrow Constant which contains the HTML code for the left arrow in the user interface. |
| <static> <constant> | Railgun.ShowHideSiderail.rightArrow Constant which contains the HTML code for the right arrow in the user interface. |
| <static> | Railgun.ShowHideSiderail.siderailHidden Stores the current state of the siderail: true if hidden,
false otherwise. |
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
| <static> | Railgun.ShowHideSiderail.hideSiderail() Shows the siderail upon clicking the hide siderail (rightArrow) button and issues
a request to store siderailHidden == true in storage. |
| <static> | Railgun.ShowHideSiderail.init() Initialization method for the ShowHideSiderail module. |
| <static> | Railgun.ShowHideSiderail.showSiderail() Shows the siderail upon clicking the show siderail (leftArrow) button and issues
a request to store siderailHidden == false in storage. |
Field Detail
<static> <constant> {String}Railgun.ShowHideSiderail.leftArrow
Constant which contains the HTML code for the left arrow in the user interface. The
arrow appears in the toolbar and has the railgun-siderail-left-arrow CSS class. When
clicked, this arrow should reveal the siderail.
<static> <constant> {String}Railgun.ShowHideSiderail.rightArrow
Constant which contains the HTML code for the right arrow in the user interface. The
arrow appears in the toolbar and has the railgun-siderail-left-arrow CSS class. When
clicked, this arrow should collapse the siderail.
<static> {Boolean}Railgun.ShowHideSiderail.siderailHidden
Stores the current state of the siderail:
true if hidden,
false otherwise.- Default Value:
- false
Method Detail
- <static> Railgun.ShowHideSiderail.hideSiderail()Shows the siderail upon clicking the hide siderail (rightArrow) button and issues a request to store siderailHidden == true in storage.
- <static> Railgun.ShowHideSiderail.init()Initialization method for the ShowHideSiderail module. Initializes the
siderailHiddenproperty and modifies the DOM accordingly. - <static> Railgun.ShowHideSiderail.showSiderail()Shows the siderail upon clicking the show siderail (leftArrow) button and issues a request to store siderailHidden == false in storage.
