playwright/docs/src/emulation.md

id	title
emulation	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

• langs: js, python

Playwright comes with a registry of device parameters for selected mobile devices. It can be used to simulate browser behavior on a mobile device:

const { chromium, devices } = require('playwright');
const browser = await chromium.launch();

const pixel2 = devices['Pixel 2'];
const context = await browser.newContext({
  ...pixel2,
});

import asyncio
from playwright.async_api import async_playwright

async def run(playwright):
    pixel_2 = playwright.devices['Pixel 2']
    browser = await playwright.webkit.launch(headless=False)
    context = await browser.new_context(
        **pixel_2,
    )

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

from playwright.sync_api import sync_playwright

def run(playwright):
    pixel_2 = playwright.devices['Pixel 2']
    browser = playwright.webkit.launch(headless=False)
    context = browser.new_context(
        **pixel_2,
    )

with sync_playwright() as playwright:
    run(playwright)

All pages created in the context above will share the same device parameters.

API reference

• [property: Playwright.devices]
• [method: Browser.newContext]

User agent

All pages created in the context above will share the user agent specified:

const context = await browser.newContext({
  userAgent: 'My user agent'
});

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withUserAgent("My user agent"));

context = await browser.new_context(
  user_agent='My user agent'
)

context = browser.new_context(
  user_agent='My user agent'
)

API reference

• [method: Browser.newContext]

Viewport

Create a context with custom viewport size:

// 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,
});

// Create context with given viewport
BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withViewportSize(1280, 1024));

// Resize viewport for individual page
page.setViewportSize(1600, 1200);

// Emulate high-DPI
BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withViewportSize(2560, 1440)
  .withDeviceScaleFactor(2);

# Create context with given viewport
context = await browser.new_context(
  viewport={ 'width': 1280, 'height': 1024 }
)

# Resize viewport for individual page
await page.set_viewport_size(width=1600, height=1200)

# Emulate high-DPI
context = await browser.new_context(
  viewport={ 'width': 2560, 'height': 1440 },
  device_scale_factor=2,
)

# Create context with given viewport
context = browser.new_context(
  viewport={ 'width': 1280, 'height': 1024 }
)

# Resize viewport for individual page
page.set_viewport_size(width=1600, height=1200)

# Emulate high-DPI
context = browser.new_context(
  viewport={ 'width': 2560, 'height': 1440 },
  device_scale_factor=2,

API reference

• [method: Browser.newContext]
• [method: Page.setViewportSize]

Locale & timezone

// Emulate locale and time
const context = await browser.newContext({
  locale: 'de-DE',
  timezoneId: 'Europe/Berlin',
});

// Emulate locale and time
BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withLocale("de-DE")
  .withTimezoneId("Europe/Berlin"));

# Emulate locale and time
context = await browser.new_context(
  locale='de-DE',
  timezone_id='Europe/Berlin',
)

# Emulate locale and time
context = browser.new_context(
  locale='de-DE',
  timezone_id='Europe/Berlin',
)

API reference

• [method: Browser.newContext]

Permissions

Allow all pages in the context to show system notifications:

const context = await browser.newContext({
  permissions: ['notifications'],
});

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withPermissions(Arrays.asList("notifications"));

context = await browser.new_context(
  permissions=['notifications'],
)

context = browser.new_context(
  permissions=['notifications'],
)

Grant all pages in the existing context access to current location:

await context.grantPermissions(['geolocation']);

context.grantPermissions(Arrays.asList("geolocation"));

await context.grant_permissions(['geolocation'])

context.grant_permissions(['geolocation'])

Grant notifications access from a specific domain:

await context.grantPermissions(['notifications'], {origin: 'https://skype.com'} );

context.grantPermissions(Arrays.asList("notifications"),
  new BrowserContext.GrantPermissionsOptions().withOrigin("https://skype.com"));

await context.grant_permissions(['notifications'], origin='https://skype.com')

context.grant_permissions(['notifications'], origin='https://skype.com')

Revoke all permissions:

await context.clearPermissions();

context.clearPermissions();

await context.clear_permissions()

context.clear_permissions()

API reference

• [method: Browser.newContext]
• [method: BrowserContext.grantPermissions]
• [method: BrowserContext.clearPermissions]

Geolocation

Create a context with "geolocation" permissions granted:

const context = await browser.newContext({
  geolocation: { longitude: 48.858455, latitude: 2.294474 },
  permissions: ['geolocation']
});

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withGeolocation(48.858455, 2.294474)
  .withPermissions(Arrays.asList("geolocation")));

context = await browser.new_context(
  geolocation={"longitude": 48.858455, "latitude": 2.294474},
  permissions=["geolocation"]
)

context = browser.new_context(
  geolocation={"longitude": 48.858455, "latitude": 2.294474},
  permissions=["geolocation"]
)

Change the location later:

await context.setGeolocation({ longitude: 29.979097, latitude: 31.134256 });

context.setGeolocation(new Geolocation(29.979097, 31.134256));

await context.set_geolocation({"longitude": 29.979097, "latitude": 31.134256})

context.set_geolocation({"longitude": 29.979097, "latitude": 31.134256})

Note you can only change geolocation for all pages in the context.

API reference

• [method: Browser.newContext]
• [method: BrowserContext.setGeolocation]

Color scheme and media

Create a context with dark or light mode. Pages created in this context will follow this color scheme preference.

// 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' });

// Create context with dark mode
BrowserContext context = browser.newContext(new Browser.NewContextOptions()
  .withColorScheme(ColorScheme.DARK)); // or "light"

// Create page with dark mode
Page page = browser.newPage(new Browser.NewPageOptions()
  .withColorScheme(ColorScheme.DARK)); // or "light"

// Change color scheme for the page
page.emulateMedia(new Page.EmulateMediaOptions().withColorScheme(ColorScheme.DARK));

// Change media for page
page.emulateMedia(new Page.EmulateMediaOptions().withMedia(Media.PRINT));

# Create context with dark mode
context = await browser.new_context(
  color_scheme='dark' # or 'light'
)

# Create page with dark mode
page = await browser.new_page(
  color_scheme='dark' # or 'light'
)

# Change color scheme for the page
await page.emulate_media(color_scheme='dark')

# Change media for page
await page.emulate_media(media='print')

# Create context with dark mode
context = browser.new_context(
  color_scheme='dark' # or 'light'
)

# Create page with dark mode
page = browser.new_page(
  color_scheme='dark' # or 'light'
)

# Change color scheme for the page
page.emulate_media(color_scheme='dark')

# Change media for page
page.emulate_media(media='print')

API reference

• [method: Browser.newContext]
• [method: Page.emulateMedia]