36 lines
1.6 KiB
TypeScript
36 lines
1.6 KiB
TypeScript
|
import type { WaitForOptions } from '../../types.js';
|
||
|
|
/**
|
||
|
|
* Wait for an element for the provided amount of milliseconds to be clickable or not clickable.
|
||
|
|
*
|
||
|
|
* :::info
|
||
|
|
*
|
||
|
|
* As opposed to other element commands WebdriverIO will not wait for the element to exist to execute
|
||
|
|
* this command.
|
||
|
|
*
|
||
|
|
* This command is only available for desktop and mobile browsers, not for native mobile apps.
|
||
|
|
*
|
||
|
|
* :::
|
||
|
|
*
|
||
|
|
* <example>
|
||
|
|
:waitForClickable.js
|
||
|
|
it('should detect when element is clickable', async () => {
|
||
|
|
const elem = await $('#elem')
|
||
|
|
await elem.waitForClickable({ timeout: 3000 });
|
||
|
|
});
|
||
|
|
it('should detect when element is no longer clickable', async () => {
|
||
|
|
const elem = await $('#elem')
|
||
|
|
await elem.waitForClickable({ reverse: true });
|
||
|
|
});
|
||
|
|
* </example>
|
||
|
|
*
|
||
|
|
* @alias element.waitForClickable
|
||
|
|
* @param {WaitForOptions=} options waitForEnabled options (optional)
|
||
|
|
* @param {Number=} options.timeout time in ms (default set based on [`waitforTimeout`](/docs/configuration#waitfortimeout) config value)
|
||
|
|
* @param {Boolean=} options.reverse if true it waits for the opposite (default: false)
|
||
|
|
* @param {String=} options.timeoutMsg if exists it overrides the default error message
|
||
|
|
* @param {Number=} options.interval interval between checks (default: `waitforInterval`)
|
||
|
|
* @return {Boolean} `true` if element is clickable (or doesn't if flag is set)
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
export declare function waitForClickable(this: WebdriverIO.Element, { timeout, interval, reverse, timeoutMsg }?: WaitForOptions): Promise<true>;
|
||
|
|
//# sourceMappingURL=waitForClickable.d.ts.map
|