@wdio/image-comparison-core/dist/commands/checkTabbablePage.js

Image comparison core module for @wdio/visual-service - WebdriverIO visual testing framework

import drawTabbableOnCanvas from '../clientSideScripts/drawTabbableOnCanvas.js';
import removeElementFromDom from '../clientSideScripts/removeElementFromDom.js';
import checkFullPageScreen from './checkFullPageScreen.js';
/**
 * Compare an image with all tab executions
 */
export default async function checkTabbablePage({ browserInstance, checkTabbableOptions, folders, instanceData, isNativeContext = false, tag, testContext, }) {
    // 1a. Check if the method is supported in native context
    if (isNativeContext) {
        throw new Error('The method checkTabbablePage is not supported in native context for native mobile apps!');
    }
    // 1b. Inject drawing the tabbables
    await browserInstance.execute(drawTabbableOnCanvas, checkTabbableOptions.wic.tabbableOptions);
    // 2. Create the screenshot
    const fullPageCompareData = await checkFullPageScreen({
        browserInstance,
        checkFullPageOptions: checkTabbableOptions,
        instanceData,
        folders,
        isNativeContext,
        testContext,
        tag,
    });
    // 3. Remove the canvas
    await browserInstance.execute(removeElementFromDom, 'wic-tabbable-canvas');
    // 4. Return the data
    return fullPageCompareData;
}