mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
928a1769ef
- Make docs/README.md more prominent, include capabilities - Link to examples from specific topics
101 lines
4.8 KiB
Markdown
101 lines
4.8 KiB
Markdown
# Documentation
|
|
|
|
### Capabilities
|
|
|
|
Playwright is a library to automate [Chromium](https://www.chromium.org/Home), [Firefox](https://www.mozilla.org/en-US/firefox/new/) and [WebKit](https://webkit.org/) with a single API. Playwright is built to enable cross-browser web automation that is **ever-green**, **capable**, **reliable** and **fast**.
|
|
|
|
* Ever-green browser engines
|
|
* Headless execution
|
|
* Scenarios that span multiple pages, domains and iframes
|
|
* Auto-wait for elements to be ready before executing actions (like click, fill)
|
|
* Reliable signals instead of timeouts (like network response, popup, navigation)
|
|
* Intercept network activity for stubbing and mocking network requests
|
|
* Emulate mobile devices, geolocation, permissions
|
|
* Support for web components via shadow-piercing selectors
|
|
* Native input events for mouse and keyboard
|
|
* Upload and download files
|
|
|
|
### Table of contents
|
|
|
|
1. [Getting Started](./intro.md)
|
|
- [Installation](./intro.md#installation)
|
|
- [Usage](./intro.md#usage)
|
|
- [First script](./intro.md#first-script)
|
|
- [System requirements](./intro.md#system-requirements)
|
|
- [Installation parameters](./installation.md)
|
|
1. [Core Concepts](./core-concepts.md)
|
|
- [Overview](./core-concepts.md#)
|
|
- [Browser](./core-concepts.md#browser)
|
|
- [Browser contexts](./core-concepts.md#browser-contexts)
|
|
- [Pages and frames](./core-concepts.md#pages-and-frames)
|
|
- [Selectors](./core-concepts.md#selectors)
|
|
- [Auto-waiting](./core-concepts.md#auto-waiting)
|
|
- [Execution contexts: Node.js and Browser](./core-concepts.md#execution-contexts-nodejs-and-browser)
|
|
- [Object & element handles](./core-concepts.md#object--element-handles)
|
|
1. [Input](./input.md)
|
|
- [Text input](./input.md#text-input)
|
|
- [Checkboxes](./input.md#checkboxes)
|
|
- [Select options](./input.md#select-options)
|
|
- [Mouse click](./input.md#mouse-click)
|
|
- [Type characters](./input.md#type-characters)
|
|
- [Keys and shortcuts](./input.md#keys-and-shortcuts)
|
|
- [Upload files](./input.md#upload-files)
|
|
- [Focus element](./input.md#focus-element)
|
|
1. [Emulation](./emulation.md)
|
|
- [Devices](./emulation.md#devices)
|
|
- [Overview](./emulation.md#)
|
|
- [User agent](./emulation.md#user-agent)
|
|
- [Viewport](./emulation.md#viewport)
|
|
- [Locale & Timezone](./emulation.md#locale--timezone)
|
|
- [Permissions](./emulation.md#permissions)
|
|
- [Geolocation](./emulation.md#geolocation)
|
|
- [Color scheme and media](./emulation.md#color-scheme-and-media)
|
|
1. [Network](./network.md)
|
|
- [Overview](./network.md#)
|
|
- [HTTP Authentication](./network.md#http-authentication)
|
|
- [Handle file downloads](./network.md#handle-file-downloads)
|
|
- [Network events](./network.md#network-events)
|
|
- [Handle requests](./network.md#handle-requests)
|
|
- [Modify requests](./network.md#modify-requests)
|
|
- [Abort requests](./network.md#abort-requests)
|
|
1. [Assertions](./assertions.md)
|
|
- [Common patterns](./assertions.md#common-patterns)
|
|
- [Element Handles](./assertions.md#element-handles)
|
|
- [Custom assertions](./assertions.md#custom-assertions)
|
|
1. [Debugging tools](./debug.md)
|
|
- [VS Code debugger](./debug.md#visual-studio-code-debugger)
|
|
- [Browser developer tools](./debug.md#browser-developer-tools)
|
|
- [Debug mode](./debug.md#run-in-debug-mode)
|
|
1. [Verification](./verification.md)
|
|
- [Screenshots](./verification.md#screenshots)
|
|
- [Console logs](./verification.md#console-logs)
|
|
- [Page errors](./verification.md#page-errors)
|
|
- [Page events](./verification.md#page-events)
|
|
1. [Navigation and Loading](./loading.md)
|
|
- [Overview](./loading.md#)
|
|
- [Common scenarios](./loading.md#common-scenarios)
|
|
- [Loading a popup](./loading.md#loading-a-popup)
|
|
- [Client-side redirects](./loading.md#unusual-client-side-redirects)
|
|
- [Navigation after a timeout](./loading.md#click-triggers-navigation-after-a-timeout)
|
|
1. [Multi-page scenarios](./multi-pages.md)
|
|
- [Multiple contexts](./multi-pages.md#multiple-contexts)
|
|
- [Multiple pages](./multi-pages.md#multiple-pages)
|
|
- [Handling new pages](./multi-pages.md#handling-new-pages)
|
|
- [Handling popups](./multi-pages.md#handling-popups)
|
|
1. [Test runners](./test-runners.md)
|
|
- [Jest / Jasmine](./test-runners.md#jest--jasmine)
|
|
- [AVA](./test-runners.md#ava)
|
|
- [Mocha](./test-runners.md#mocha)
|
|
1. [Continuous Integration](./ci.md)
|
|
- [Docker](./ci.md#docker)
|
|
- [GitHub Actions](./ci.md#github-actions)
|
|
- [Azure Pipelines](./ci.md#azure-pipelines)
|
|
- [Travis CI](./ci.md#travis-ci)
|
|
- [CircleCI](./ci.md#circleci)
|
|
- [Troubleshooting](./troubleshooting.md)
|
|
1. [Selector engines](./selectors.md)
|
|
1. [Actionability](./actionability.md)
|
|
1. [Extensibility](./extensibility.md)
|
|
- [Custom selector engines](./extensibility.md#custom-selector-engines)
|
|
1. [API Reference](./api.md)
|