@wordpress/e2e-test-utils-playwright
Version:
End-To-End (E2E) test utils for WordPress.
46 lines • 1.29 kB
JavaScript
;
/**
* Named viewport options.
*
* @typedef {"large"|"medium"|"small"} WPDimensionsName
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.setBrowserViewport = setBrowserViewport;
/**
* Viewport dimensions object.
*
* @typedef {Object} WPViewportDimensions
*
* @property {number} width Width, in pixels.
* @property {number} height Height, in pixels.
*/
/**
* Predefined viewport dimensions to reference by name.
*
* @enum {WPViewportDimensions}
*
* @type {Record<WPDimensionsName, WPViewportDimensions>}
*/
const PREDEFINED_DIMENSIONS = {
large: { width: 960, height: 700 },
medium: { width: 768, height: 700 },
small: { width: 600, height: 700 },
};
/**
* Valid argument argument type from which to derive viewport dimensions.
*
* @typedef {WPDimensionsName|WPViewportDimensions} WPViewport
*/
/**
* Sets browser viewport to specified type.
*
* @this {import('./').PageUtils}
* @param {WPViewport} viewport Viewport name or dimensions object to assign.
*/
async function setBrowserViewport(viewport) {
const dimensions = typeof viewport === 'string'
? PREDEFINED_DIMENSIONS[viewport]
: viewport;
await this.page.setViewportSize(dimensions);
}
//# sourceMappingURL=set-browser-viewport.js.map