microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-14 21:53:35 +03:00
Code Issues Projects Releases Wiki Activity

docs: add firefox-stable channel documentation (#6328)

Browse Source 
Fixes #5993
This commit is contained in:
Andrey Lushnikov 2021-05-03 16:52:33 -07:00 committed by GitHub
parent fe94dc5cf3
commit 653d483ba8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 55 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/api/class-browsertype.md
View File

@ -214,7 +214,7 @@ Whether to run browser in headless mode. More details for
[`option: devtools`] option is `true`.
### option: BrowserType.launch.channel
- `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary">>
- `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary"|"firefox-stable">>
Browser distribution channel. Read more about using [Google Chrome and Microsoft Edge](./browsers.md#google-chrome--microsoft-edge).
@ -327,7 +327,7 @@ Whether to run browser in headless mode. More details for
[`option: devtools`] option is `true`.
### option: BrowserType.launchPersistentContext.channel
- `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary">>
- `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary"|"firefox-stable">>
Browser distribution channel. Read more about using [Google Chrome and Microsoft Edge](./browsers.md#google-chrome--microsoft-edge).
@ -434,7 +434,7 @@ Whether to run browser in headless mode. More details for
Port to use for the web socket. Defaults to 0 that picks any available port.
### option: BrowserType.launchServer.channel
- `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary">>
- `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary"|"firefox-stable">>
Browser distribution channel. Read more about using [Google Chrome and Microsoft Edge](./browsers.md#google-chrome--microsoft-edge).

48
docs/src/browsers.md
View File

@ -24,6 +24,54 @@ on when to opt into stable channels, refer to the [Google Chrome & Microsoft Edg
Playwright's Firefox version matches the recent [Firefox Beta](https://www.mozilla.org/en-US/firefox/channel/desktop/)
build.
### Firefox-Stable
Playwright team maintains a Playwright Firefox version that matches the latest Firefox Stable, a.k.a. `firefox-stable`.
Using `firefox-stable` is a 2-steps process:
1. Installing `firefox-stable` with Playwright CLI.
```sh js
$ npx playwright install firefox-stable
```
```sh java
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="install firefox-stable"
```
```sh python
$ playwright install firefox-stable
```
2. Using `firefox-stable` channel when launching browser.
```js
const { firefox } = require('playwright');
const browser = await firefox.launch({
channel: 'firefox-stable'
});
```
```java
import com.microsoft.playwright.*;
public class Example {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
BrowserType firefox = playwright.firefox();
Browser browser = firefox.launch(new BrowserType.LaunchOptions().setChannel("firefox-stable"));
}
}
}
```
```python async
browser = await playwright.firefox.launch(channel="firefox-stable")
```
```python sync
browser = playwright.firefox.launch(channel="firefox-stable")
```
## WebKit
Playwright's WebKit version matches the recent WebKit trunk build, before it is used in Apple Safari and

6
types/types.d.ts vendored
View File

@ -6768,7 +6768,7 @@ export interface BrowserType<Unused = {}> {
* Browser distribution channel. Read more about using
* [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge).
*/
channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary";
channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary"|"firefox-stable";
/**
* Enable Chromium sandboxing. Defaults to `true`.
@ -7098,7 +7098,7 @@ export interface BrowserType<Unused = {}> {
* Browser distribution channel. Read more about using
* [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge).
*/
channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary";
channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary"|"firefox-stable";
/**
* Enable Chromium sandboxing. Defaults to `true`.
@ -10799,7 +10799,7 @@ export interface LaunchOptions {
* Browser distribution channel. Read more about using
* [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge).
*/
channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary";
channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary"|"firefox-stable";
/**
* Enable Chromium sandboxing. Defaults to `false`.