Class: FilterScrollToTop

FilterScrollToTop()

The scroll to top element. Is rendered inside the tag with class 'boost-pfs-filter-scroll-to-top'

Constructor

new FilterScrollToTop()

Creates a new ScrollToTop This should only be called once, because we only want one scroll to top element.
Source:

Extends

Members

children :Array

Array of child components
Type:
  • Array
Overrides:
Default Value:
  • []
Source:

parent :Component

The parent component
Type:
  • Component
Overrides:
Default Value:
  • null
Source:

Methods

_callAllBindEvents()

Bind events on the component (include all child-components)
Overrides:
Source:

_callAllInit()

Initialize the component (include all child-components)
Overrides:
Source:

_callAllRender()

Render the component (include all child-components)
Overrides:
Source:

addComponent(childComponent)

Add the child component into a component
Parameters:
Name Type Description
childComponent Object The child component
Overrides:
Source:

afterBindEvents()

After bind evnets on the component
Overrides:
Source:

afterInit()

After initialize callback
Overrides:
Source:

afterRender()

After reder component callback
Overrides:
Source:

beforeBindEvents()

Before bind events on component callback
Overrides:
Source:

beforeInit()

Before initialize callback
Overrides:
Source:

beforeRender()

Before reder component callback
Overrides:
Source:

bindEvents()

Bind events on the component
Overrides:
Source:

init()

Initialize component
Overrides:
Source:

isBindEvents()

Returns whether or not binding the events on a component
Overrides:
Source:

isLoopThroughChild()

Returns whether or not the childs of a component is refresh
Overrides:
Source:

isRender()

Returns whether or not the component is rendered
Overrides:
Source:

isShow() → {boolean}

Check the settings to see if we enabled scroll to top element or not.
Source:
Returns:
Type
boolean

refresh()

Refresh component
Overrides:
Source:

removeComponent(childComponent)

Remove a child component of a component
Parameters:
Name Type Description
childComponent Object The child component
Overrides:
Source:

render()

Render compoment
Overrides:
Source:

scrollToTop()

Called on click, do scroll top top animation
Source:

setVisibility()

Set visibility of the scroll to top element. Hide it if we're already at the top. This check function is called on scroll.
Source: