A zero-dependency Cypress plugin to wait for an element to exist on page
GPL-3.0 License
A zero-dependency plugin for Cypress to wait for an element.
You sometimes have to wait for an animation, data loading or whatever before we can find an element on the page.
This plugin allows you to wait for an element using Cypress own select engine and Promise ecosystem.
Cypress comes with a get
method which will wait for a timeout before failing which works most of
the time as long as you use that method.
If you need to use the jQuery selector or non-cypress methods you need to wait manually.
This is where this plugin comes in.
describe('Test suite', () => {
it('A test description', () => {
cy.visit('http://localhost:3000');
// The page does an animation or loading
// so we now need to wait for an element
// with the id `main-body`
cy.waitForSelector('#main-body');
// Now we have instant access to the #main-body element
const body = Cypress.$('#main-body title').attr('data-body');
});
});
The function waitForSelector
takes either:
Cypress.$
.describe('Test suite', () => {
it('A test description', () => {
cy.visit('http://localhost:3000');
// The page does an animation or loading
// so we now need to wait for localStorage
// to populate
cy.waitForSelector(() => {
const localData = localStorage.getItem('myData');
return localData !== null;
});
// Now we know from now on our localStorage is available
});
});
The plugin also takes an optional options object:
cy.waitForSelector('#main-body', {
timeout: 200, // The time in ms to poll for changes
tries: 300, // How many times to try before failing
// 300 tries at 200ms timeout = 1min
});
Install the plugin via yarn add cypress-waitforselector
(or npm i cypress-waitforselector
) and add it to your plugins.
Inside cypress/support/commands.js
add:
import 'cypress-waitforselector';
Copyright (c) Dominik Wilkowski. Licensed under GNU-GPLv3.