Pest Plugin Browser

https://github.com/pestphp/pest-plugin-browser
Admin
This repository contains the Pest Plugin for Browser, extending Pest's testing capabilities for...
Tokens:126,258
Snippets:1,024
Trust Score:9.6
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Usage example: visit with emulation and assertions

Source: https://github.com/pestphp/pest-plugin-browser

Shows a typical usage of the visit() helper with device emulation, dark mode, locale, and assertions. The $page variable is typed as Webpage and the example chains emulation methods before assertions.

```php
use Pest\Browser\Api\Webpage;

/** @var Webpage $page */
$page = visit('/')
    ->on()->iphone15()
    ->inDarkMode()
    ->withLocale('en-GB');

$page
    ->assertSee('Welcome')
    ->assertUrlIs(url('/'))
    ->assertScreenshotMatches();
```

--------------------------------

### Install dev dependencies: composer install

Source: https://github.com/pestphp/pest-plugin-browser/blob/5.x/CONTRIBUTING.md

Run in the project root after cloning the fork to install development dependencies.

```bash
composer install
```

--------------------------------

### Catch PlaywrightNotInstalledException and PlaywrightOutdatedException

Source: https://github.com/pestphp/pest-plugin-browser

Wrap the Playwright server start call to handle missing or outdated Playwright installations. The catch blocks suggest running npm install playwright and npx playwright install, or updating to the latest version.

```php
use Pest\Browser\Exceptions\PlaywrightNotInstalledException;
use Pest\Browser\Exceptions\PlaywrightOutdatedException;

try {
    ServerManager::instance()->playwright()->start();
} catch (PlaywrightNotInstalledException $e) {
    // run: npm install playwright && npx playwright install
} catch (PlaywrightOutdatedException $e) {
    // run: npm install playwright@latest && npx playwright install
}
```

--------------------------------

### Custom HTTP server implementation example

Source: https://github.com/pestphp/pest-plugin-browser

Shows how to pass a factory closure to httpServer() that returns a custom HttpServer implementation.

```php
// Custom HTTP server implementation
use Pest\Browser\Configuration;
use Pest\Browser\Contracts\HttpServer;

(new Configuration())->httpServer(function (): HttpServer {
    return new MyCustomHttpServer();
});
```

--------------------------------

### InitScript

Source: https://github.com/pestphp/pest-plugin-browser

Provides a method to retrieve the injected browser script that installs `window.__pestBrowser` collectors for console logs and JavaScript errors.

```APIDOC
## InitScript

### Methods
- `get(): string` — returns the injected browser script that installs `window.__pestBrowser` collectors for `consoleLogs` and `jsErrors` (including unhandled rejections).
```

--------------------------------

### Configuration usage example

Source: https://github.com/pestphp/pest-plugin-browser

Shows how to instantiate Configuration and chain methods to set browser type, color scheme, timeout, slowMo, and headed mode. Typically used in tests/Pest.php.

```php
use Pest\Browser\Configuration;

// in tests/Pest.php
$configuration = new Configuration();   // no constructor args

$configuration
    ->inChrome()
    ->inDarkMode()
    ->timeout(10_000)
    ->slowMo(250)
    ->headed();
```

--------------------------------

### Usage example: from()->paris()

Source: https://github.com/pestphp/pest-plugin-browser

Uses the `paris()` preset to configure the page and then asserts the locale, timezone, and latitude are set correctly.

```php
visit('/')
    ->from()->paris()
    ->assertSeeIn('#locale', 'fr-FR')
    ->assertSeeIn('#timezone', 'Europe/Paris')
    ->assertSeeIn('#latitude', '48.8566');
```

--------------------------------

### Usage examples for visit()

Source: https://github.com/pestphp/pest-plugin-browser

Shows how to use visit() with a single URL, multiple URLs, and array destructuring. The single URL returns PendingAwaitablePage; multiple URLs return ArrayablePendingAwaitablePage.

```php
// Single URL — returns PendingAwaitablePage
$page = visit('/');

// Multiple URLs — returns ArrayablePendingAwaitablePage
visit(['/page1', '/page2'])->assertSee('Page');

// Array destructuring multiple pages
[$page1, $page2] = visit(['/page1', '/page2']);

$page1
    ->assertSee('Page 1')
    ->assertTitle('Page 1');
```

--------------------------------

### Usage example: geolocation with explicit host

Source: https://github.com/pestphp/pest-plugin-browser

Shows how to set geolocation and an explicit host when visiting a page, then assert on the displayed latitude.

```php
// Geolocation + permissions, explicit host
visit('/check-in')
    ->withHost('127.0.0.1')
    ->geolocation(51.5074, -0.1278)
    ->assertSeeIn('#latitude', '51.5074');
```

--------------------------------

### Strict comparisons example

Source: https://github.com/pestphp/pest-plugin-browser

Using assertSetStrict and assertNotSetStrict for strict type comparisons.

```php
// Strict comparisons
Livewire::test($component)
    ->assertSetStrict('flag', true)
    ->assertNotSetStrict('count', 3);
```

--------------------------------

### From constructor

Source: https://github.com/pestphp/pest-plugin-browser

Constructor for `From` that holds the pending page configuration. It is meaningful only internally; consumers get a `From` via `PendingAwaitablePage::from()`.

```php
/**
 * @param  array<string, mixed>  $options
 */
public function __construct(
    private BrowserType $browserType,
    private Device $device,
    private string $url,
    private array $options,
)
```

--------------------------------

### Webpage content() method

Source: https://github.com/pestphp/pest-plugin-browser

Gets the page's content.

```php
/** Gets the page's content. */
public function content(): string
```

--------------------------------

### Usage example: fluent chain with retried assertions

Source: https://github.com/pestphp/pest-plugin-browser

Shows how AwaitableWebpage hides behind the fluent chain. Assertions like assertSee are retried until they pass or timeout, while click is non-awaitable and invoked once.

```php
// AwaitableWebpage hides behind the fluent chain: assertions are retried
// until they pass or the timeout elapses.
visit('/')
    ->click('Launch')           // click is non-awaitable (in default list)
    ->assertSee('Ready');       // assertSee is retried until it resolves
```

--------------------------------

### Usage example: non-awaitable methods and short timeout behavior

Source: https://github.com/pestphp/pest-plugin-browser

Demonstrates that non-awaitable methods like typeSlowly are invoked once without retry, and that under a timeout <= 1000ms all methods are called directly.

```php
// Non-awaitable methods are invoked once: a retried speed-typing would
// duplicate characters and a retried click could open a second menu.
try {
    visit('/')->typeSlowly('#note', 'hello', 250);
} catch (\Throwable $e) {
    // The action either completed or failed outright — it was not retried.
}

// Under a short timeout (<= 1000ms) ALL methods are called directly.
```

--------------------------------

### Usage example: chain assertion and count/iterate

Source: https://github.com/pestphp/pest-plugin-browser

Shows chaining an assertion against every page at once, and counting/iterating over the collection.

```php
// Chain an assertion against every page at once
visit(['/page1', '/page2'])
    ->assertSee('Welcome');

// Count / iterate
$pages = visit(['/a', '/b', '/c']);
count($pages);      // 3
foreach ($pages as $page) { /* ... */ }
```

--------------------------------

### Usage example: dynamic city iteration

Source: https://github.com/pestphp/pest-plugin-browser

Iterates over all `City` enum cases and dynamically calls the corresponding preset method to assert the timezone for each city.

```php
use Pest\Browser\Enums\City;

// Access the enum's own data to build assertions dynamically
$cities = City::cases();

foreach ($cities as $city) {
    visit('/')
        ->from()->{$city->value}()
        ->assertSeeIn('#timezone', $city->timezone());
}
```

--------------------------------

### Webpage::url()

Source: https://github.com/pestphp/pest-plugin-browser

Gets the page's URL. Returns the full current `window.location.href`.

```APIDOC
## Webpage::url()

### Description
Gets the page's URL. (full current `window.location.href`)

### Method
`url()`

### Return Type
`string`

### Source
`src/Api/Webpage.php:68`
```

--------------------------------

### Webpage::content()

Source: https://github.com/pestphp/pest-plugin-browser

Gets the page's content. Returns the full HTML content of the current page.

```APIDOC
## Webpage::content()

### Description
Gets the page's content.

### Method
`content()`

### Return Type
`string`

### Source
`src/Api/Webpage.php:60`
```

--------------------------------

### Usage example: fetching page info throws ExpectationFailedException

Source: https://github.com/pestphp/pest-plugin-browser

Attempting to fetch page information through the collection throws an ExpectationFailedException with a message about array destructuring.

```php
// Attempting to fetch page info through the collection throws:
try {
    visit(['/a', '/b'])->url();
} catch (\PHPUnit\Framework\ExpectationFailedException $e) {
    // "Attempted to fetch page information in multiple pages. Array
    //  destructuring is required ... Example: [$page1, $page2] = visit(...)"
}
```

--------------------------------

### text(string $selector): ?string

Source: https://github.com/pestphp/pest-plugin-browser

Gets the text content of the matched element. Returns null if no element is matched.

```APIDOC
## text(string $selector): ?string

### Description
Get text content of the matched element.

### Method
text

### Parameters
- **$selector** (string) - Required - The selector to match the element.

### Return
- **?string** - The text content, or null if not found.
```

--------------------------------

### Tracing

Source: https://github.com/pestphp/pest-plugin-browser

Provides tracing capabilities for Playwright, including starting, stopping, and grouping trace recordings.

```APIDOC
## Tracing

### Methods
- `start(string $title)`
- `path(): ?string`
- `group(string $name, ?string $file, ?int $line, callable $callback): mixed`
- `stopAll(bool $save): array<int,string>`
- `isRecording(): bool`
```

--------------------------------

### desktop()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the DESKTOP device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## desktop()

### Description
Selects the DESKTOP device preset and returns a new On instance.

### Method
`desktop(): self`

### Returns
- **self** - A new On instance with the DESKTOP device preset applied.

```

--------------------------------

### httpServer method

Source: https://github.com/pestphp/pest-plugin-browser

Sets a custom HTTP server factory. Throws LogicException if the HTTP server has already been created.

```php
/**
 * Uses a custom HTTP server implementation.
 *
 * @param  Closure(): HttpServer  $factory
 */
public function httpServer(Closure $factory): self
```

--------------------------------

### Webpage url() method

Source: https://github.com/pestphp/pest-plugin-browser

Gets the page's URL (full current window.location.href).

```php
/** Gets the page's URL. (full current `window.location.href`) */
public function url(): string
```

--------------------------------

### surfaceLaptop5()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the SURFACE_LAPTOP_5 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## surfaceLaptop5()

### Description
Selects the SURFACE_LAPTOP_5 device preset and returns a new On instance.

### Method
`surfaceLaptop5(): self`

### Returns
- **self** - A new On instance with the SURFACE_LAPTOP_5 device preset applied.

```

--------------------------------

### Usage: visit with iPhone 15 preset

Source: https://github.com/pestphp/pest-plugin-browser

Selects the iPhone 15 device preset and asserts mobile experience.

```php
visit('/')
    ->on()->iphone15()
    ->assertSee('Mobile experience')
    ->assertScreenshotMatches();
```

--------------------------------

### inLightMode method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the color scheme to light.

```php
public function inLightMode(): self
```

--------------------------------

### macbook16()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the MACBOOK_16 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## macbook16()

### Description
Selects the MACBOOK_16 device preset and returns a new On instance.

### Method
`macbook16(): self`

### Returns
- **self** - A new On instance with the MACBOOK_16 device preset applied.

```

--------------------------------

### iPadMini()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the IPAD_MINI device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## iPadMini()

### Description
Selects the IPAD_MINI device preset and returns a new On instance.

### Method
`iPadMini(): self`

### Returns
- **self** - A new On instance with the IPAD_MINI device preset applied.

```

--------------------------------

### Usage: programmatic iteration over devices

Source: https://github.com/pestphp/pest-plugin-browser

Iterates over device method names using reflection to run screenshot assertions for each.

```php
// Programmatic iteration over all devices
$reflection = new \ReflectionClass(\Pest\Browser\Api\On::class);
foreach (['macbook16', 'iphone15Pro', 'pixel8'] as $device) {
    visit('/')->on()->{$device}()
        ->assertScreenshotMatches();
}
```

--------------------------------

### attribute(string $selector, string $attribute): ?string

Source: https://github.com/pestphp/pest-plugin-browser

Gets the value of the given attribute for the matched element, or null if not present.

```APIDOC
## attribute(string $selector, string $attribute): ?string

### Description
Get the given attribute value, or `null`.

### Method
attribute

### Parameters
- **$selector** (string) - Required - The selector to match the element.
- **$attribute** (string) - Required - The attribute name to retrieve.

### Return
- **?string** - The attribute value, or null.
```

--------------------------------

### iPhoneSE()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the IPHONE_SE device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## iPhoneSE()

### Description
Selects the IPHONE_SE device preset and returns a new On instance.

### Method
`iPhoneSE(): self`

### Returns
- **self** - A new On instance with the IPHONE_SE device preset applied.

```

--------------------------------

### Webpage value() method

Source: https://github.com/pestphp/pest-plugin-browser

Gets the locator for the given selector (input value). Uses $this->guessLocator($selector)->inputValue().

```php
/** Gets the locator for the given selector (input value). */
public function value(string $selector): string
```

--------------------------------

### headed method

Source: https://github.com/pestphp/pest-plugin-browser

Uses Playwright in headed mode.

```php
/**
 * Uses playwright in headed mode.
 */
public function headed(): self
```

--------------------------------

### withHost method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the host for the server. If the HTTP server already exists and is a LaravelHttpServer, also re-points generated URLs via $http->syncGeneratedUrls().

```php
/**
 * Sets the host for the server.
 */
public function withHost(?string $host): self
```

--------------------------------

### Webpage::value()

Source: https://github.com/pestphp/pest-plugin-browser

Gets the locator for the given selector (input value). This method returns the input value of the element matching the selector.

```APIDOC
## Webpage::value()

### Description
Gets the locator for the given selector (input value).

### Method
`value(string $selector)`

### Parameters
- **$selector** (string) - Required - The CSS selector for the input element.

### Return Type
`string`

### Source
`src/Api/Webpage.php:94`
```

--------------------------------

### Usage: switching device (only last applied)

Source: https://github.com/pestphp/pest-plugin-browser

Shows that only the last selected device (macbookAir) is applied because each method returns a new On.

```php
// Switching device: only macbookAir is applied
visit('/')
    ->on()->mobile()->macbookAir()
    ->assertSee('laptop')
    ->resize(1440, 900);
```

--------------------------------

### Livewire component test with anonymous class

Source: https://github.com/pestphp/pest-plugin-browser

Full example of testing an anonymous Livewire component: assertSee, click, assertSet, assertNotSet.

```php
use Livewire\Component;
use Pest\Browser\Api\Livewire;

$component = new class extends Component
{
    public int $counter = 0;

    public function increment(): void
    {
        $this->counter++;
    }

    public function render(): string
    {
        return <<<'HTML'
            <div>
                <h1>Hello, World!</h1>
                <button wire:click="increment">Increment</button>
                <span>{{ $counter }}</span>
            </div>
        HTML;
    }
};

Livewire::test($component)
    ->assertSee('Hello, World!')
    ->click('Increment')
    ->assertSee(1)
    ->assertSet('counter', 1)
    ->click('Increment')
    ->assertNotSet('counter', 1);
```

--------------------------------

### visit($url, $options)

Source: https://github.com/pestphp/pest-plugin-browser

The visit() method accepts an array of options that are forwarded into the browser context and navigation. Fluent PendingAwaitablePage modifiers populate the same context options.

```APIDOC
## visit($url, $options)

### Description
Accepts an `array<string, mixed>` `$options` that is forwarded into the browser context and navigation. The fluent `PendingAwaitablePage` modifiers populate the same context options.

### Parameters
#### Request Body
- `colorScheme` (string) - Optional - Preferred color scheme. Produced by `inDarkMode()` / `inLightMode()`.
- `locale` (string) - Optional - BCP-47 locale. Produced by `withLocale()`.
- `userAgent` (string) - Optional - Custom user agent. Produced by `withUserAgent()`.
- `timezoneId` (string) - Optional - IANA timezone. Produced by `withTimezone()`.
- `geolocation` (array) - Optional - `['latitude' => .., 'longitude' => ..]`. Produced by `geolocation(lat, lng)`.
- `permissions` (array) - Optional - Appends `'geolocation'`. Produced by `geolocation()`.
- `host` (string) - Optional - Temporary serve host (not forwarded to the browser context). Produced by `withHost()`.
- Additional context options (mixed) - Optional - Passed through to `browser->newContext(...)`; navigation `waitUntil`/`timeout` passed to `goto()`.

### Defaults
Default context values before merging (from `PendingAwaitablePage::buildAwaitablePage`): `locale: 'en-US'`, `timezoneId: 'UTC'`, `colorScheme: <default>`, plus the `Device::context()` preset.
```

--------------------------------

### Usage example: array destructure for per-page work

Source: https://github.com/pestphp/pest-plugin-browser

Shows destructuring the collection into individual pages to work per-page or fetch page-level data.

```php
// Array destructure to work per-page / fetch page-level data
[$page1, $page2] = visit(['/page1', '/page2']);

$page1->assertSee('Page 1');
$page2->assertSee('Page 2');
```

--------------------------------

### macbookAir()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the MACBOOK_AIR device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## macbookAir()

### Description
Selects the MACBOOK_AIR device preset and returns a new On instance.

### Method
`macbookAir(): self`

### Returns
- **self** - A new On instance with the MACBOOK_AIR device preset applied.

```

--------------------------------

### xiaomi13()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the XIAOMI_13 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## xiaomi13()

### Description
Selects the XIAOMI_13 device preset and returns a new On instance.

### Method
`xiaomi13(): self`

### Returns
- **self** - A new On instance with the XIAOMI_13 device preset applied.

```

--------------------------------

### __call()

Source: https://github.com/pestphp/pest-plugin-browser

Lazily creates a PendingAwaitablePage with the selected device and forwards the call to it. This is how method chaining like ->on()->iphone15()->assertSee('...') resolves into the page chain.

```APIDOC
## __call()

### Description
Lazily creates a PendingAwaitablePage with the selected device and forwards the call to it. The underlying PendingAwaitablePage is created only once (cached).

### Method
`__call(string $name, array $arguments): mixed`

### Parameters
- **$name** (string) - Required - The name of the method to call on the PendingAwaitablePage.
- **$arguments** (array) - Required - The arguments to pass to the method.

### Returns
- **mixed** - The result of the forwarded method call.

```

--------------------------------

### setHost(?string $host): void

Source: https://github.com/pestphp/pest-plugin-browser

Sets the host.

```APIDOC
## setHost(?string $host): void

### Description
Sets the host.

### Method
Static method

### Signature
```php
public static function setHost(?string $host): void
```

### Parameters
- **$host** (?string) - Required - The host to set, or null.

### Return Value
- **void** - No return value.
```

--------------------------------

### Livewire::test

Source: https://github.com/pestphp/pest-plugin-browser

Static factory method to start testing a Livewire component in the browser. It registers a temporary route to render the component and returns a TestableLivewire instance for fluent assertions.

```APIDOC
## Livewire::test

### Description
Tests a Livewire component with the given name and parameters. If a component instance is provided, its class name is used. It creates a Livewire Testable, registers a GET route at `/pest/livewire-visit/{componentId}` served through the `web` middleware, and returns a `TestableLivewire` instance.

### Method
Static method

### Signature
```php
public static function test(Component|string $name, array $parameters = []): TestableLivewire
```

### Parameters
- **$name** (`Livewire\Component|string`) - Required - Component instance or class name.
- **$parameters** (`array<string, mixed>`) - Optional - Component initial parameters. Default: `[]`.

### Return Type
`Pest\Browser\Api\TestableLivewire`

### Behavior
1. If `$name` is a `Component` instance, uses `$name::class`.
2. Creates a Livewire `Testable` and reads the component instance id.
3. Registers a `GET` route at `/pest/livewire-visit/{componentId}` served through the `web` middleware, rendering the component HTML with Livewire styles/scripts.
4. Returns `new TestableLivewire(visit($routeName), $componentId)`.

### Request Example
```php
use Livewire\Component;
use Pest\Browser\Api\Livewire;

$component = new class extends Component
{
    public int $counter = 0;

    public function increment(): void
    {
        $this->counter++;
    }

    public function render(): string
    {
        return <<<'HTML'
            <div>
                <h1>Hello, World!</h1>
                <button wire:click="increment">Increment</button>
                <span>{{ $counter }}</span>
            </div>
        HTML;
    }
};

Livewire::test($component)
    ->assertSee('Hello, World!')
    ->click('Increment')
    ->assertSee(1)
    ->assertSet('counter', 1)
    ->click('Increment')
    ->assertNotSet('counter', 1);
```

```php
// Passing parameters by name
use Pest\Browser\Api\Livewire;

Livewire::test(\App\Livewire\Counter::class, ['start' => 5])
    ->assertSet('start', 5)
    ->click('Increment')
    ->assertSet('counter', 6);
```
```

--------------------------------

### macbook14()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the MACBOOK_14 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## macbook14()

### Description
Selects the MACBOOK_14 device preset and returns a new On instance.

### Method
`macbook14(): self`

### Returns
- **self** - A new On instance with the MACBOOK_14 device preset applied.

```

--------------------------------

### PlaywrightServer contract interface

Source: https://github.com/pestphp/pest-plugin-browser

Defines the contract for Playwright server drivers. Implementers must provide start, stop, and a url method that throws ServerNotFoundException if the server is not available.

```php
interface PlaywrightServer
{
    public function start(): void;
    public function stop(): void;
    /** @throws ServerNotFoundException */
    public function url(): string;
}
```

--------------------------------

### __call method for lazy page creation

Source: https://github.com/pestphp/pest-plugin-browser

Creates the actual visit page instance once and forwards the call. Enables chaining like ->on()->iphone15()->assertSee().

```php
/**
 * Creates the actual visit page instance once, and calls the given method on it.
 *
 * @param  array<int, mixed>  $arguments
 */
public function __call(string $name, array $arguments): mixed
```

--------------------------------

### host(): ?string

Source: https://github.com/pestphp/pest-plugin-browser

Returns the current host.

```APIDOC
## host(): ?string

### Description
Returns the current host.

### Method
Static method

### Signature
```php
public static function host(): ?string
```

### Return Value
- **?string** - The current host, or null.
```

--------------------------------

### Livewire::test method signature

Source: https://github.com/pestphp/pest-plugin-browser

Static factory method to test a Livewire component. Accepts a component instance or class name and optional parameters. Registers a GET route and returns a TestableLivewire instance.

```php
/**
 * Tests a Livewire component with the given name and parameters.
 *
 * @param  array<string, mixed>  $parameters
 */
public static function test(Component|string $name, array $parameters = []): TestableLivewire
```

--------------------------------

### iPhone15()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the IPHONE_15 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## iPhone15()

### Description
Selects the IPHONE_15 device preset and returns a new On instance.

### Method
`iPhone15(): self`

### Returns
- **self** - A new On instance with the IPHONE_15 device preset applied.

```

--------------------------------

### assertScript

Source: https://github.com/pestphp/pest-plugin-browser

Asserts that the given JavaScript expression evaluates to the expected value. If the expression does not look like a comparison/condition and does not start with 'return ' or 'function', it is wrapped into 'function() { return {$expression}; }' before evaluation. Returns the Webpage instance for chaining.

```APIDOC
## assertScript

### Description
Asserts that the given JavaScript expression evaluates to the expected value. If the expression does not look like a comparison/condition and does not start with 'return ' or 'function', it is wrapped into 'function() { return {$expression}; }' before evaluation.

### Method
assertScript

### Signature
`public function assertScript(string $expression, mixed $expected = true): Webpage`

### Parameters
- **$expression** (string) - Required - The JavaScript expression to evaluate.
- **$expected** (mixed) - Optional - The expected result. Defaults to `true`.

### Return Value
- **Webpage** - The current Webpage instance for chaining.
```

--------------------------------

### Run unit tests: composer test:unit

Source: https://github.com/pestphp/pest-plugin-browser/blob/5.x/CONTRIBUTING.md

Runs the unit tests.

```bash
composer test:unit
```

--------------------------------

### HttpServer contract interface

Source: https://github.com/pestphp/pest-plugin-browser

Defines the contract for HTTP server drivers in the Pest Browser plugin. Implementers must provide start, stop, rewrite, flush, bootstrap, and exception handling methods.

```php
interface HttpServer
{
    public function start(): void;
    public function stop(): void;
    public function rewrite(string $url): string;
    public function flush(): void;
    public function bootstrap(): void;
    public function lastThrowable(): ?Throwable;
    /** @throws Throwable */
    public function throwLastThrowableIfNeeded(): void;
}
```

--------------------------------

### mobile()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the MOBILE device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## mobile()

### Description
Selects the MOBILE device preset and returns a new On instance.

### Method
`mobile(): self`

### Returns
- **self** - A new On instance with the MOBILE device preset applied.

```

--------------------------------

### inSafari method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the default browser type to Safari.

```php
public function inSafari(): self
```

--------------------------------

### huaweiP50()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the HUAWEI_P50 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## huaweiP50()

### Description
Selects the HUAWEI_P50 device preset and returns a new On instance.

### Method
`huaweiP50(): self`

### Returns
- **self** - A new On instance with the HUAWEI_P50 device preset applied.

```

--------------------------------

### iPhone15Pro()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the IPHONE_15_PRO device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## iPhone15Pro()

### Description
Selects the IPHONE_15_PRO device preset and returns a new On instance.

### Method
`iPhone15Pro(): self`

### Returns
- **self** - A new On instance with the IPHONE_15_PRO device preset applied.

```

--------------------------------

### diff method

Source: https://github.com/pestphp/pest-plugin-browser

Enables diff mode for screenshot assertions.

```php
/**
 * Enables diff mode for screenshot assertions.
 */
public function diff(): self
```

--------------------------------

### Lint code: composer lint

Source: https://github.com/pestphp/pest-plugin-browser/blob/5.x/CONTRIBUTING.md

Run the linting command to ensure code style compliance as noted in the guidelines.

```bash
composer lint
```

--------------------------------

### trace method

Source: https://github.com/pestphp/pest-plugin-browser

Records a trace of each test, and keeps it when the test fails. Unless running on CI, the trace of a failed test is opened once the test suite has finished.

```php
/**
 * Records a trace of each test, and keeps it when the test fails. Unless running on CI,
 * the trace of a failed test is opened once the test suite has finished.
 */
public function trace(bool $open = true): self
```

--------------------------------

### iPadPro()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the IPAD_PRO device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## iPadPro()

### Description
Selects the IPAD_PRO device preset and returns a new On instance.

### Method
`iPadPro(): self`

### Returns
- **self** - A new On instance with the IPAD_PRO device preset applied.

```

--------------------------------

### waitForKey(): self

Source: https://github.com/pestphp/pest-plugin-browser

Waits for the page to reach a load state, then pauses for a key press.

```APIDOC
## waitForKey(): self

### Description
Waits for the load state and then pauses for a key press.

### Method
waitForKey

### Returns
- **self** - Returns the current instance for chaining.
```

--------------------------------

### oneplus11()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the ONEPLUS_11 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## oneplus11()

### Description
Selects the ONEPLUS_11 device preset and returns a new On instance.

### Method
`oneplus11(): self`

### Returns
- **self** - A new On instance with the ONEPLUS_11 device preset applied.

```

--------------------------------

### httpServer(Closure $factory): self

Source: https://github.com/pestphp/pest-plugin-browser

Sets a custom HTTP server implementation via a factory closure. Throws LogicException if the HTTP server has already been created.

```APIDOC
## httpServer(Closure $factory): self

### Description
Sets a custom HTTP server implementation via a factory closure. Throws LogicException if the HTTP server has already been created.

### Method
httpServer

### Parameters
- **$factory** (Closure): Required - A closure returning an HttpServer instance.

### Returns
- **self** - For chaining.

### Request Example
```php
use Pest\Browser\Configuration;
use Pest\Browser\Contracts\HttpServer;

(new Configuration())->httpServer(function (): HttpServer {
    return new MyCustomHttpServer();
});
```
```

--------------------------------

### pixel6a()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the PIXEL_6A device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## pixel6a()

### Description
Selects the PIXEL_6A device preset and returns a new On instance.

### Method
`pixel6a(): self`

### Returns
- **self** - A new On instance with the PIXEL_6A device preset applied.

```

--------------------------------

### galaxyNote20()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the GALAXY_NOTE_20 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## galaxyNote20()

### Description
Selects the GALAXY_NOTE_20 device preset and returns a new On instance.

### Method
`galaxyNote20(): self`

### Returns
- **self** - A new On instance with the GALAXY_NOTE_20 device preset applied.

```

--------------------------------

### on

Source: https://github.com/pestphp/pest-plugin-browser

Returns an On builder for selecting a device preset (viewport/touch/mobile).

```APIDOC
## on

### Description
Returns an [`On`](on.md) builder for selecting a device preset (viewport/touch/mobile).

### Method
`on`

### Signature
```php
public function on(): On
```

### Returns
- `On` - A builder for selecting a device preset.
```

--------------------------------

### Pest\Browser\Configuration fluent builder methods

Source: https://github.com/pestphp/pest-plugin-browser

Provides a fluent interface for configuring the browser plugin. These methods allow setting various configuration options for the browser testing environment.

```APIDOC
## Pest\Browser\Configuration fluent builder methods

### Description
Provides a fluent interface for configuring the browser plugin. These methods allow setting various configuration options for the browser testing environment.

### Method
Fluent Builder Methods

### Usage
Use the fluent methods on the `Pest\Browser\Configuration` class to set configuration options.
```

--------------------------------

### visit() method signature

Source: https://github.com/pestphp/pest-plugin-browser

The visit() method accepts a single URL string or an array of URL strings. It returns PendingAwaitablePage for a string and ArrayablePendingAwaitablePage for an array. Options are forwarded to the browser context.

```php
/**
 * Browse to the given URL.
 *
 * @template TUrl of array<int, string>|string
 *
 * @param  TUrl  $url
 * @param  array<string, mixed>  $options
 * @return (TUrl is array<int, string> ? ArrayablePendingAwaitablePage : PendingAwaitablePage)
 */
public function visit(array|string $url, array $options = []): ArrayablePendingAwaitablePage|PendingAwaitablePage
```

--------------------------------

### inChrome method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the default browser type to Chrome.

```php
public function inChrome(): self
```

--------------------------------

### AwaitableWebpage constructor with non-awaitable methods list

Source: https://github.com/pestphp/pest-plugin-browser

Constructor that accepts a Page, initial URL, and a list of methods that must not be retried. The default list includes actions like click, typeSlowly, and navigation methods to avoid duplicate work or restarted navigation.

```php
/**
 * Creates a new awaitable webpage instance.
 *
 * @param  array<int, string>  $nonAwaitableMethods
 */
public function __construct(
    private Page $page,
    private string $initialUrl,
    private array $nonAwaitableMethods = [
        'assertScreenshotMatches',
        'assertNoAccessibilityIssues',
        'typeSlowly',
        'click',
        'rightClick',
        'press',
        'pressAndWaitFor',
        'keys',
        'drag',
        'append',
        'navigate',
        'refresh',
        'back',
        'forward',
    ],
)
```

--------------------------------

### userAgent method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the browser's userAgent.

```php
/**
 * Sets the browsers userAgent.
 */
public function userAgent(string $userAgent): self
```

--------------------------------

### headed(): self

Source: https://github.com/pestphp/pest-plugin-browser

Uses Playwright in headed mode.

```APIDOC
## headed(): self

### Description
Uses Playwright in headed mode.

### Method
headed

### Parameters
None

### Returns
- **self** - For chaining.

### Request Example
```php
$configuration->headed();
```
```

--------------------------------

### visit(array|string $url, array $options = [])

Source: https://github.com/pestphp/pest-plugin-browser

Opens a page in the browser. Accepts a single URL string or an array of URLs to visit in parallel, with optional browser context options.

```APIDOC
## visit(array|string $url, array $options = [])

### Description
Browse to the given URL. Accepts a single URL string or an array of URL strings to visit in parallel.

### Method
visit

### Signature
`public function visit(array|string $url, array $options = []): ArrayablePendingAwaitablePage|PendingAwaitablePage`

### Parameters
- **$url** (array<int, string>|string) - Required - A single URL string, or an array of URL strings to visit in parallel.
- **$options** (array<string, mixed>) - Optional - Per-visit browser context options forwarded into the browser context (e.g. `timeout`, `waitUntil`). Default: `[]`.

### Return Type
- `PendingAwaitablePage` when `$url` is a `string`.
- `ArrayablePendingAwaitablePage` when `$url` is an `array<int, string>`.

### Behavior
When called with a string, it returns `new PendingAwaitablePage(Playwright::defaultBrowserType(), Device::DESKTOP, $url, $options)`. When called with an array, it maps every URL into its own `PendingAwaitablePage` (all sharing the same options), wrapped in an `ArrayablePendingAwaitablePage`.

### Request Example
```php
// Single URL — returns PendingAwaitablePage
$page = visit('/');

// Multiple URLs — returns ArrayablePendingAwaitablePage
visit(['/page1', '/page2'])->assertSee('Page');

// Array destructuring multiple pages
[$page1, $page2] = visit(['/page1', '/page2']);

$page1
    ->assertSee('Page 1')
    ->assertTitle('Page 1');
```
```

--------------------------------

### from

Source: https://github.com/pestphp/pest-plugin-browser

Returns a From builder for emulating a location (locale, timezone, geolocation).

```APIDOC
## from

### Description
Returns a [`From`](from.md) builder for emulating a location (locale, timezone, geolocation).

### Method
`from`

### Signature
```php
public function from(): From
```

### Returns
- `From` - A builder for emulating a location.
```

--------------------------------

### pixel7()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the PIXEL_7 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## pixel7()

### Description
Selects the PIXEL_7 device preset and returns a new On instance.

### Method
`pixel7(): self`

### Returns
- **self** - A new On instance with the PIXEL_7 device preset applied.

```

--------------------------------

### inDarkMode method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the color scheme to dark.

```php
public function inDarkMode(): self
```

--------------------------------

### ServerManager::hasHttp() method signature

Source: https://github.com/pestphp/pest-plugin-browser

Returns true if the HTTP server instance has been created.

```php
public function hasHttp(): bool
```

--------------------------------

### inLightMode(): self

Source: https://github.com/pestphp/pest-plugin-browser

Sets the color scheme to light mode.

```APIDOC
## inLightMode(): self

### Description
Sets the color scheme to light mode.

### Method
inLightMode

### Parameters
None

### Returns
- **self** - For chaining.

### Request Example
```php
$configuration->inLightMode();
```
```

--------------------------------

### assertPathBeginsWith

Source: https://github.com/pestphp/pest-plugin-browser

Asserts that the current URL path begins with the given path.

```APIDOC
## assertPathBeginsWith

### Description
Asserts that the current URL path begins with the given path.

### Method
assertPathBeginsWith

### Signature
`public function assertPathBeginsWith(string $path): Webpage`

### Parameters
- **path** (string) - Required - The expected path prefix.
```

--------------------------------

### surfacePro9()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the SURFACE_PRO_9 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## surfacePro9()

### Description
Selects the SURFACE_PRO_9 device preset and returns a new On instance.

### Method
`surfacePro9(): self`

### Returns
- **self** - A new On instance with the SURFACE_PRO_9 device preset applied.

```

--------------------------------

### headed(): void

Source: https://github.com/pestphp/pest-plugin-browser

Disables headless mode.

```APIDOC
## headed(): void

### Description
Disables headless mode.

### Method
Static method

### Signature
```php
public static function headed(): void
```

### Return Value
- **void** - No return value.
```

--------------------------------

### navigate(string $url, array $options = []): self

Source: https://github.com/pestphp/pest-plugin-browser

Navigates to a resolved URL, using the ComputeUrl helper.

```APIDOC
## navigate(string $url, array $options = []): self

### Description
Navigates to a resolved URL.

### Method
navigate

### Parameters
- **$url** (string) - Required - The URL to navigate to.
- **$options** (array) - Optional - Additional navigation options.

### Returns
- **self** - Returns the current instance for chaining.
```

--------------------------------

### Run tests: composer test

Source: https://github.com/pestphp/pest-plugin-browser/blob/5.x/CONTRIBUTING.md

Runs all tests in the project.

```bash
composer test
```

--------------------------------

### galaxyS24Ultra()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the GALAXY_S24_ULTRA device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## galaxyS24Ultra()

### Description
Selects the GALAXY_S24_ULTRA device preset and returns a new On instance.

### Method
`galaxyS24Ultra(): self`

### Returns
- **self** - A new On instance with the GALAXY_S24_ULTRA device preset applied.

```

--------------------------------

### assertFragmentBeginsWith

Source: https://github.com/pestphp/pest-plugin-browser

Asserts that the current URL fragment begins with the given fragment.

```APIDOC
## assertFragmentBeginsWith

### Description
Asserts that the current URL fragment begins with the given fragment.

### Method
assertFragmentBeginsWith

### Signature
`public function assertFragmentBeginsWith(string $fragment): Webpage`

### Parameters
- **fragment** (string) - Required - The expected fragment prefix.
```

--------------------------------

### shouldTrace(): bool

Source: https://github.com/pestphp/pest-plugin-browser

Returns whether tracing is enabled.

```APIDOC
## shouldTrace(): bool

### Description
Returns whether tracing is enabled.

### Method
Static method

### Signature
```php
public static function shouldTrace(): bool
```

### Return Value
- **bool** - True if tracing is enabled.
```

--------------------------------

### shouldOpenTraces(): bool

Source: https://github.com/pestphp/pest-plugin-browser

Returns whether traces should be auto-opened.

```APIDOC
## shouldOpenTraces(): bool

### Description
Returns whether traces should be auto-opened.

### Method
Static method

### Signature
```php
public static function shouldOpenTraces(): bool
```

### Return Value
- **bool** - True if traces should be auto-opened.
```

--------------------------------

### iPhone14Pro()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the IPHONE_14_PRO device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## iPhone14Pro()

### Description
Selects the IPHONE_14_PRO device preset and returns a new On instance.

### Method
`iPhone14Pro(): self`

### Returns
- **self** - A new On instance with the IPHONE_14_PRO device preset applied.

```

--------------------------------

### page() method returning Page instance

Source: https://github.com/pestphp/pest-plugin-browser

Returns the wrapped Pest\Browser\Playwright\Page instance.

```php
/** Return the page instance. */
public function page(): Page
```

--------------------------------

### debug method

Source: https://github.com/pestphp/pest-plugin-browser

Enables debug mode for assertions.

```php
/**
 * Enables debug mode for assertions.
 */
public function debug(): self
```

--------------------------------

### pixel8()

Source: https://github.com/pestphp/pest-plugin-browser

Selects the PIXEL_8 device preset and returns a new On instance. This method is used to set the device context before visiting a page.

```APIDOC
## pixel8()

### Description
Selects the PIXEL_8 device preset and returns a new On instance.

### Method
`pixel8(): self`

### Returns
- **self** - A new On instance with the PIXEL_8 device preset applied.

```

--------------------------------

### tinker(): self

Source: https://github.com/pestphp/pest-plugin-browser

Alias of shell(), opens an interactive shell.

```APIDOC
## tinker(): self

### Description
Alias of shell(), opens an interactive shell.

### Method
tinker

### Returns
- **self** - Returns the current instance for chaining.
```

--------------------------------

### setShouldTrace(?bool $open = null): void

Source: https://github.com/pestphp/pest-plugin-browser

Enables tracing; when $open is provided also sets whether to auto-open traces.

```APIDOC
## setShouldTrace(?bool $open = null): void

### Description
Enables tracing; when $open is provided also sets whether to auto-open traces.

### Method
Static method

### Signature
```php
public static function setShouldTrace(?bool $open = null): void
```

### Parameters
- **$open** (?bool) - Optional - Whether to auto-open traces.

### Return Value
- **void** - No return value.
```

--------------------------------

### inFirefox method

Source: https://github.com/pestphp/pest-plugin-browser

Sets the default browser type to Firefox.

```php
public function inFirefox(): self
```
Tokens:
Raw