new Footer(options)
View representing a page footer which can have multiple tabs and be minimised. The state of the footer is
stored in local storage
Parameters:
| Name | Type | Description |
|---|---|---|
options |
FooterOptions |
Extends
- Backbone.View
Members
-
className :string
-
Classes added to footer element
Type:
- string
-
events
-
Backbone events hash
-
expanded :string
-
Local storage key for if the footer is expanded
Type:
- string
-
index :string
-
Local storage key for the current tab index
Type:
- string
-
processors :Array.<FooterProcessor>
-
Defines the components of the footer
Type:
- Array.<FooterProcessor>
Methods
-
handleTabClick(e)
-
Event handler called when a tab is clicked
Parameters:
Name Type Description eobject jQuery event
-
hide()
-
Hides the footer
-
render()
-
Renders the footer according to the defined processors and tabData
-
selectIndex(index)
-
Select a footer tab by index
Parameters:
Name Type Description indexNumber The index of the tab in tabData
-
show()
-
Shows the footer
-
toggle()
-
Toggles the footer
-
updateForState(state)
-
Shows or hides the footer.
Parameters:
Name Type Description stateboolean True to show the footer, false to hide the footer