Skip to content

Commit

Permalink
docs(testing): update browserHeadless description
Browse files Browse the repository at this point in the history
this commit updates the description of `browserHeadless` to account for
the changes made in stenciljs/core#4356
  • Loading branch information
rwaskiewicz committed May 4, 2023
1 parent fe46cb3 commit b7895bf
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/testing/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,24 @@ export interface TestingConfig extends JestConfig {
browserExecutablePath?: string;

/**
* Whether to run browser e2e tests in headless mode. Defaults to true.
* Whether to run browser e2e tests in headless mode.
*
* `headless` is an argument passed through to Puppeteer (which is passed to Chrome) for
* end-to-end testing. Prior to Chrome v112, `headless` was treated like a boolean flag.
* Starting with Chrome v112, 'new' is an accepted option to support Chrome's new
* headless mode.
*
* The following values are accepted:
* - "new" - enables the "new" headless mode, starting with Chrome 112
* - `true` - enables the "old" headless mode, prior to Chrome 112
* - `false` - enables the "headful" mode
*
* Stencil will default to `true` (the old headless mode) if no value is provided.
*
* In the future, Chrome will enable the new headless mode by default, even when `true`
* is provided.
*
* {@see https://developer.chrome.com/articles/new-headless/}
*/
browserHeadless?: boolean;

Expand Down

0 comments on commit b7895bf

Please sign in to comment.