Actions

Releases all keys, pointers, and clears internal state.

Short-hand for performing a simple left-click (down/up) with the mouse.

Short-hand for performing a simple right-click (down/up) with the mouse.

Short-hand for performing a double left-click with the mouse.

Configures a drag-and-drop action consisting of the following steps:

1. Move to the center of the from element (element to be dragged).
2. Press the left mouse button.
3. If the to target is a WebElement, move the mouse to its center. Otherwise, move the mouse by the specified offset.
4. Release the left mouse button.

Appends actions to the end of the current sequence for the given device. If device synchronization is enabled, after inserting the actions, pauses will be inserted for all other devices to ensure all action sequences are the same length.

Inserts an action to press a single key.

Inserts an action to release a single key.

Inserts an action for moving the mouse x and y pixels relative to the specified origin. The origin may be defined as the mouse's current position, the top-left corner of the viewport, or the center of a specific WebElement. Default is top left corner of the view-port if origin is not specified

You may adjust how long the remote end should take, in milliseconds, to perform the move using the duration parameter (defaults to 100 ms). The number of incremental move events generated over this duration is an implementation detail for the remote end.

Inserts a pause action for the specified devices, ensuring each device is idle for a tick. The length of the pause (in milliseconds) may be specified as the first parameter to this method (defaults to 0). Otherwise, you may just specify the individual devices that should pause.

If no devices are specified, a pause action will be created (using the same duration) for every device.

When device synchronization is enabled (the default for new Actions objects), there is no need to specify devices as pausing one automatically pauses the others for the same duration. In other words, the following are all equivalent:

let a1 = driver.actions();
a1.pause(100).perform();

let a2 = driver.actions();
a2.pause(100, a2.keyboard()).perform();
// Synchronization ensures a2.mouse() is automatically paused too.

let a3 = driver.actions();
a3.pause(100, a3.keyboard(), a3.mouse()).perform();

When device synchronization is disabled, you can cause individual devices to pause during a tick. For example, to hold the SHIFT key down while moving the mouse:

let actions = driver.actions({async: true});

actions.keyDown(Key.SHIFT);
actions.pause(actions.mouse())  // Pause for shift down
    .press(Button.LEFT)
    .move({x: 10, y: 10})
    .release(Button.LEFT);
actions
    .pause(
        actions.keyboard(),  // Pause for press left
        actions.keyboard(),  // Pause for move
        actions.keyboard())  // Pause for release left
   .keyUp(Key.SHIFT);
await actions.perform();

Performs the configured action sequence.

Inserts an action to press a mouse button at the mouse's current location.

Inserts an action to release a mouse button at the mouse's current location.

scrolls a page via the coordinates given

Inserts a sequence of actions to type the provided key sequence. For each key, this will record a pair of keyDown and keyUp actions. An implication of this pairing is that modifier keys (e.g. Key.SHIFT) will always be immediately released. In other words, sendKeys(Key.SHIFT, 'a') is the same as typing sendKeys('a'), not sendKeys('A').

Ensures the action sequence for every device referenced in this action sequence is the same length. For devices whose sequence is too short, this will insert pauses so that every device has an explicit action defined at each tick.