Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add firefox-stable channel documentation #6328

Merged
merged 6 commits into from
May 3, 2021
Merged

docs: add firefox-stable channel documentation #6328

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7ef7186
docs: add firefox-stable channel documentation
aslushnikov Apr 26, 2021
05cf79f
use subsection
aslushnikov Apr 26, 2021
3ac712e
Update docs/src/browsers.md
aslushnikov Apr 26, 2021
869e4b6
add types & fix nit
aslushnikov May 3, 2021
2d5e956
fix types.d.ts
aslushnikov May 3, 2021
21b1dac
add per-language shell scripts
aslushnikov May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/api/class-browsertype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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).

Expand Down
42 changes: 41 additions & 1 deletion docs/src/browsers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,47 @@ on when to opt into stable channels, refer to the [Google Chrome & Microsoft Edg
## Firefox

Playwright's Firefox version matches the recent [Firefox Beta](https://www.mozilla.org/en-US/firefox/channel/desktop/)
build.
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.
```shell
aslushnikov marked this conversation as resolved.
Show resolved Hide resolved
$ npx 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

Expand Down