Mixin: module:argos/_PullToRefreshMixin

module:argos/_PullToRefreshMixin

Source:

Members

(static) pullRefreshBannerTemplate

Properties:
Type Description
external:Simplate
Source:

(static) pullRefreshTemplate

Properties:
Type Description
Simplate
Source:

(static) pullReleaseTemplate

Properties:
Type Description
Simplate
Source:

dragNode

Properties:
Type Description
DOMNode
Source:

enablePullToRefresh

Properties:
Name Type Description
enablePullToRefresh Boolean

If true, will enable the user to drag down and refresh the list. Default is true.
Source:

pullRefreshBanner

Properties:
Type Description
DOMNode
Source:

pullRefreshText

Properties:
Name Type Description
Text String

to indicate a pull to refresh
Source:

pullReleaseText

Properties:
Name Type Description
Text String

to indicate the user should release to cause the refresh
Source:

scrollerNode

Properties:
Type Description
DOMNode
Source:

Methods

initPullToRefresh(scrollerNode, dragNode)

Parameters:
Name Type Description
scrollerNode DOMNode

The node that scrolls and should be pulled on to refresh.
dragNode DOMNode

The node that the user will drag. Defaults to scrollerNode if not specified.
Source:

onPullToRefreshCancel()

Fires when the pull to refresh is canceled.

Source:

onPullToRefreshComplete()

Fires when the pull to refresh is successful.

Source:

shouldStartPullToRefresh(scrollerNode) → {Boolean}

Derived class must implement this to determine when pull to refresh should start. This is called when onTouchStart is fired.

Parameters:
Name Type Description
scrollerNode DOMNode

Reference to the scoller node
Source:
Returns:
Type
Boolean