Expand all

Skin

Representation of the current skin being rendered.

Constructor

new Skin(params) #

Parameters:

Name Type Description
params Object

Configuration options

Properties:
Name Type Description
eventBus OO.EventEmitter

Object used to listen for

page Page

scroll:throttled, resize:throttled, and section-toggled events

Source:

Fires:

Properties

defaults #

Properties:

Name Type Description
defaults Object

Default options hash.

Properties:
Name Type Description
page Page

page the skin is currently rendering

Mixes in:
Source:

Methods

getLicenseMsg() → {string|undefined} #

Returns the appropriate license message including links/name to terms of use (if any) and license page

Source:

Returns:

Type
string | undefined

Returns the appropriate license message including links/name to terms of use (if any) and license page

postRender() #

getSingleton() → {Skin}static #

Get a skin singleton

Source:

Returns:

Type
Skin
Get a skin singleton

Events

click() #

Fired when the skin is clicked.

Source:
Fired when the skin is clicked.