waitForDisplayed

Wait for an element for the provided amount of milliseconds to be displayed or not displayed.

Usage#

$(selector).waitForDisplayed({ timeout, reverse, timeoutMsg, interval })

Parameters#

Name	Type	Details
`options` optional	`WaitForOptions`	waitForEnabled options (optional)
`options.timeout` optional	`Number`	time in ms (default: 500)
`options.reverse` optional	`Boolean`	if true it waits for the opposite (default: false)
`options.timeoutMsg` optional	`String`	if exists it overrides the default error message
`options.interval` optional	`Number`	interval between checks (default: `waitforInterval`)

Examples#

index.html

<div id="elem" style="visibility: hidden;">Hello World!</div>
<script type="text/javascript">
    setTimeout(() => {
        document.getElementById('elem').style.visibility = 'visible';
    }, 2000);
</script>

waitForDisplayedExample.js

it('should detect when element is visible', () => {
    const elem = $('#elem')
    elem.waitForDisplayed({ timeout: 3000 });
});
it('should detect when element is no longer visible', () => {
    const elem = $('#elem')
    elem.waitForDisplayed({ reverse: true });
});