t.scrollBy Method

Scrolls the target element by the specified distance. If the method does not specify a target, srolls the document body. Chainable.

t.scrollBy([target,] x, y[, options]) → this | Promise<any>

Parameter	Type	Description
target (optional)	Function | String | Selector | Snapshot | Promise	Identifies the webpage element to scroll to. See Select Target Elements.
x	Number	Horizontal scroll distance, in pixels (left-right). Can be negative.
y	Number	Vertical scroll distance, in pixels (top-down). Can be negative.
options (optional)	Object	A set of options with additional parameters for the action. See Options.

In the example below, TestCafe scrolls the webpage 500px down and 300px to the right:

fixture`TestController.scrollBy`
    .page`https://devexpress.github.io/testcafe/example/`;

test('Scroll the webpage', async t => {
    await t.resizeWindow(300,300);
    await t.scrollBy(300,500);
    await t.wait(1000);
});

Select Target Elements

Use the selector parameter to identify the target of a DOM event.

You can pass any of the following objects as a selector:

• A CSS selector string.

  test('Click submit', async t => {
  
      // Click will be performed on the first element
      // that matches the CSS selector.
      await t.click('#submit-button');
  });
  

• A selector.

  import { Selector } from 'testcafe';
  
  fixture`Parameter as Selector`
      .page`https://devexpress.github.io/testcafe/example/`;
  
  const lastCheckbox = Selector('fieldset p:last-child [type="checkbox"]');
  
  test('Click last checkbox', async t => {
  
      // Click will be performed on the element selected by
      // the 'getLastItem' selector.
      await t.click(lastCheckbox);
  });
  

• A client-side function that returns a DOM element.

  test('Click first child of the body', async t => {
  
      // Click will be performed on the element returned by the function,
      // which is the third child of the document's body.
      await t.click(() => document.body.children[0]);
  });
  

• A DOM node snapshot.

  import { Selector } from 'testcafe';
  
  fixture`Parameter as DOM node snapshot`
      .page`https://devexpress.github.io/testcafe/example/`;
  
  test('Click preferred interface', async t => {
      const preferredInterface = await Selector('#preferred-interface');
  
      // Click will be performed on the element whose snapshot
      // is specified. This is an element with the '#preferred-interface' ID.
      await t.click(preferredInterface);
  });
  

• A Promise returned by a selector.

  import { Selector } from 'testcafe';
  
  const submitButton = Selector('#submit-button');
  
  fixture`Parameter as Promise by Selector`
      .page`https://devexpress.github.io/testcafe/example/`;
  
  test('Click submit', async t => {
      // Click will be performed on the element specified by the selector
      // as soon as the promise is resolved.
      await t.click(submitButton());
  });
  

TestCafe waits for the target element to become visible before it executes an action. If this does not happen within the selector timeout, the test fails.

TestCafe cannot interact with background elements. If a different element overlaps the action target, TestCafe waits for this element to disappear. If this does not happen within the selector timeout, TestCafe performs the action with the element on top of the original target. Learn more about stacking and z-index on MDN.

Options

Offset options apply to t.scroll, t.scrollBy and t.scrollIntoView actions.

export interface OffsetOptions {
    offsetX: number;
    offsetY: number;
}

Parameter	Type	Description	Default
offsetX, offsetY	Number	Coordinates that define the action’s starting point. If positive, TestCafe calculates coordinates relative to the top-left corner of the target element. If negative, they are calculated relative to the bottom-right corner.	Top left corner of the target element

The example below scrolls the element until different corners of the element are visible.

import { Selector } from 'testcafe';

fixture`Offset options`
    .page`https://devexpress.github.io/testcafe/example/`;
test('Scroll element into view', async t => {
    const target = Selector('.main-content');

    await t.scrollIntoView(target);
    // No offset, scrolls until the element's center is visible
    await t.scrollIntoView(target, { offsetX: -1, offsetY: -1 });
    // Scrolls until the bottom right corner of the element is visible
    await t.scrollIntoView(target, { offsetX: 1, offsetY: 1 });
    // Scrolls until the top left corner of the element is visible
});