class SAPO.Component.FixedLayer

requires SAPO.Dom.Event

requires SAPO.Dom.Element

requires SAPO.Dom.Css

requires SAPO.Utility.Dimensions

requires SAPO.Effects.Fade

Defined in Component/FixedLayer/0.1/lib.js

Constructor Summary
FixedLayer (Object options)

Function Summary
destroy()
Destroys the layer and associated events

Constructor Details

constructor FixedLayer

FixedLayer(Object options)
Parameters:
options - options for the element
  • String cssURI - url for the css stylesheet
  • String closeLabel - content for the close button
  • Function contentCallback - callback that should return the content for the layer
  • Boolean cacheContent - if true, caches the content after the first time the callback is called
  • Boolean keepClosed - keeps the layer closed after it's closed for the first time
  • Number width - width for the layer
  • Number height - height for the layer
  • Object position - Object with 4 possible keys: top, left, right and bottom, each with number values. Defines the position of the layer.
  • Number showAfterPosition - Percentage value. The layer is shown after X percent of the page has been scrolled
  • Number showAfterElement - The layer is shown after the scroll has passed by this element
  • Number showEachSeconds - Shows the layer each X seconds
  • Boolean showAtStart - if true, shows the layer as soon as the instance is created
  • Number hideAfter - hides the layer after X seconds have passed
  • Number fadeDuration - Duration for the hideAfter fadeout in milliseconds
  • String special - name of special case custom made

Function Details

function destroy

destroy()
Destroys the layer and associated events
Search: