• function

offset FuncUnit.prototype.offset

 

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

Gets an element's offset or waits until the offset is a specified value.

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

// waits until the offset is 100, 200
S("#foo").offset({top: 100, left: 200}) 

Parameters

  1. offset {Object | 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 the offset parameter is provided, returns the funcUnit selector for chaining, otherwise returns the css of the selector.