docs: add android requirements to the api docs page (#8014)

This commit is contained in:
Pavel Feldman 2021-08-05 21:12:34 -07:00 committed by GitHub
parent 5ace65121e
commit b6d2c86d66
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 0 deletions

View File

@ -3,6 +3,21 @@
Playwright has **experimental** support for Android automation. See [here](./mobile.md) for more information. You can access android namespace via:
*Requirements*
* Android device or AVD Emulator.
* [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device. Typically running `adb devices` is all you need to do.
* [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the device
* "Enable command line on non-rooted devices" enabled in `chrome://flags`.
*Known limitations*
* Raw USB operation is not yet supported, so you need ADB.
* Device needs to be awake to produce screenshots. Enabling "Stay awake" developer mode will help.
* We didn't run all the tests against the device, so not everything works.
*How to run*
```js
const { _android: android } = require('playwright');
```

14
types/types.d.ts vendored
View File

@ -9158,6 +9158,20 @@ export {};
* Playwright has **experimental** support for Android automation. See [here](https://playwright.dev/docs/mobile) for more information. You can
* access android namespace via:
*
* *Requirements*
* - Android device or AVD Emulator.
* - [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device.
* Typically running `adb devices` is all you need to do.
* - [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the device
* - "Enable command line on non-rooted devices" enabled in `chrome://flags`.
*
* *Known limitations*
* - Raw USB operation is not yet supported, so you need ADB.
* - Device needs to be awake to produce screenshots. Enabling "Stay awake" developer mode will help.
* - We didn't run all the tests against the device, so not everything works.
*
* *How to run*
*
* ```js
* const { _android: android } = require('playwright');
* ```