--- id: emulation title: "Device and environment emulation" --- Playwright allows overriding various parameters of the device where the browser is running: - viewport size, device scale factor, touch support - locale, timezone - color scheme - geolocation Most of these parameters are configured during the browser context construction, but some of them such as viewport size can be changed for individual pages. - [Devices](#devices) - [User agent](#user-agent) - [Viewport](#viewport) - [Locale & timezone](#locale--timezone) - [Permissions](#permissions) - [Geolocation](#geolocation) - [Color scheme and media](#color-scheme-and-media)
## Devices Playwright comes with a registry of device parameters for selected mobile devices. It can be used to simulate browser behavior on a mobile device: ```js const { chromium, devices } = require('playwright'); const browser = await chromium.launch(); const pixel2 = devices['Pixel 2']; const context = await browser.newContext({ ...pixel2, }); ``` All pages created in the context above will share the same device parameters. #### API reference - [playwright.devices](api/class-playwright.md#playwrightdevices) - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions)
## User agent All pages created in the context above will share the user agent specified: ```js const context = await browser.newContext({ userAgent: 'My user agent' }); ``` #### API reference - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions)
## Viewport Create a context with custom viewport size: ```js // Create context with given viewport const context = await browser.newContext({ viewport: { width: 1280, height: 1024 } }); // Resize viewport for individual page await page.setViewportSize({ width: 1600, height: 1200 }); // Emulate high-DPI const context = await browser.newContext({ viewport: { width: 2560, height: 1440 }, deviceScaleFactor: 2, }); ``` #### API reference - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions) - [page.setViewportSize(viewportSize)](api/class-page.md#pagesetviewportsizeviewportsize)
## Locale & timezone ```js // Emulate locale and time const context = await browser.newContext({ locale: 'de-DE', timezoneId: 'Europe/Berlin', }); ``` #### API reference - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions)
## Permissions Allow all pages in the context to show system notifications: ```js const context = await browser.newContext({ permissions: ['notifications'], }); ``` Grant all pages in the existing context access to current location: ```js await context.grantPermissions(['geolocation']); ``` Grant notifications access from a specific domain: ```js await context.grantPermissions(['notifications'], {origin: 'https://skype.com'} ); ``` Revoke all permissions: ```js await context.clearPermissions(); ``` #### API reference - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions) - [browserContext.grantPermissions(permissions[, options])](api/class-browsercontext.md#browsercontextgrantpermissionspermissions-options) - [browserContext.clearPermissions()](api/class-browsercontext.md#browsercontextclearpermissions)
## Geolocation Create a context with `"geolocation"` permissions granted: ```js const context = await browser.newContext({ geolocation: { longitude: 48.858455, latitude: 2.294474 }, permissions: ['geolocation'] }); ``` ```js await context.setGeolocation({ longitude: 29.979097, latitude: 31.134256 }); ``` **Note** you can only change geolocation for all pages in the context. #### API reference - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions) - [browserContext.setGeolocation(geolocation)](api/class-browsercontext.md#browsercontextsetgeolocationgeolocation)
## Color scheme and media Create a context with dark or light mode. Pages created in this context will follow this color scheme preference. ```js // Create context with dark mode const context = await browser.newContext({ colorScheme: 'dark' // or 'light' }); // Create page with dark mode const page = await browser.newPage({ colorScheme: 'dark' // or 'light' }); // Change color scheme for the page await page.emulateMedia({ colorScheme: 'dark' }); // Change media for page await page.emulateMedia({ media: 'print' }); ``` #### API reference - [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions) - [page.emulateMedia(params)](api/class-page.md#pageemulatemediaparams) [Playwright]: api/class-playwright.md "Playwright" [Browser]: api/class-browser.md "Browser" [BrowserContext]: api/class-browsercontext.md "BrowserContext" [Page]: api/class-page.md "Page" [Frame]: api/class-frame.md "Frame" [ElementHandle]: api/class-elementhandle.md "ElementHandle" [JSHandle]: api/class-jshandle.md "JSHandle" [ConsoleMessage]: api/class-consolemessage.md "ConsoleMessage" [Dialog]: api/class-dialog.md "Dialog" [Download]: api/class-download.md "Download" [Video]: api/class-video.md "Video" [FileChooser]: api/class-filechooser.md "FileChooser" [Keyboard]: api/class-keyboard.md "Keyboard" [Mouse]: api/class-mouse.md "Mouse" [Touchscreen]: api/class-touchscreen.md "Touchscreen" [Request]: api/class-request.md "Request" [Response]: api/class-response.md "Response" [Selectors]: api/class-selectors.md "Selectors" [Route]: api/class-route.md "Route" [WebSocket]: api/class-websocket.md "WebSocket" [TimeoutError]: api/class-timeouterror.md "TimeoutError" [Accessibility]: api/class-accessibility.md "Accessibility" [Worker]: api/class-worker.md "Worker" [BrowserServer]: api/class-browserserver.md "BrowserServer" [BrowserType]: api/class-browsertype.md "BrowserType" [Logger]: api/class-logger.md "Logger" [ChromiumBrowser]: api/class-chromiumbrowser.md "ChromiumBrowser" [ChromiumBrowserContext]: api/class-chromiumbrowsercontext.md "ChromiumBrowserContext" [ChromiumCoverage]: api/class-chromiumcoverage.md "ChromiumCoverage" [CDPSession]: api/class-cdpsession.md "CDPSession" [FirefoxBrowser]: api/class-firefoxbrowser.md "FirefoxBrowser" [WebKitBrowser]: api/class-webkitbrowser.md "WebKitBrowser" [Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array" [Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer" [ChildProcess]: https://nodejs.org/api/child_process.html "ChildProcess" [Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element" [Error]: https://nodejs.org/api/errors.html#errors_class_error "Error" [Evaluation Argument]: ./core-concepts.md#evaluationargument "Evaluation Argument" [Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map "Map" [Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object "Object" [Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise" [RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp "RegExp" [Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable" [UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail" [URL]: https://nodejs.org/api/url.html "URL" [USKeyboardLayout]: ../src/usKeyboardLayout.ts "USKeyboardLayout" [UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time" [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean" [function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function" [iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator" [null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null "null" [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number" [origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin" [selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector" [Readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable "Readable" [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type "string" [xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"