• function

scrollTop FuncUnit.prototype.scrollTop

 

scrollTop([scrollTop] [,timeout] [,success] [,message])

Gets an element's scrollTop or waits until it equals a specified value.

// gets the scrollTop
S("#foo").scrollTop();

// waits until the scrollTop is 100
S("#foo").scrollTop(100) 

Parameters

  1. scrollTop {Number | function()}Optional

    If provided uses this as a check before continuing to the next action. Or you can provide a function that returns true to continue to the next action.

  2. timeout {Number}Optional

    overrides FuncUnit.timeout. If provided, the wait will fail if not completed before this timeout.

  3. success {function()}Optional

    a callback that will run after this action completes.

  4. message {String}Optional

    if provided, an assertion will be passed when this wait condition completes successfully

Returns

{String | funcUnit}

if scrollTop is provided, returns the funcUnit selector for chaining, otherwise returns the scrollTop of the selector.