playwright/docs/README.md

Documentation

Capabilities

Playwright is a library to automate Chromium, Firefox and WebKit 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
   • Installation
   • Usage
   • First script
   • System requirements
   • Installation parameters
2. Core Concepts
   • Overview
   • Browser
   • Browser contexts
   • Pages and frames
   • Selectors
   • Auto-waiting
   • Execution contexts: Node.js and Browser
   • Object & element handles
3. Input
   • Text input
   • Checkboxes
   • Select options
   • Mouse click
   • Type characters
   • Keys and shortcuts
   • Upload files
   • Focus element
4. Emulation
   • Devices
   • Overview
   • User agent
   • Viewport
   • Locale & Timezone
   • Permissions
   • Geolocation
   • Color scheme and media
5. Network
   • Overview
   • HTTP Authentication
   • Handle file downloads
   • Network events
   • Handle requests
   • Modify requests
   • Abort requests
6. Assertions
   • Common patterns
   • Element Handles
   • Custom assertions
7. Debugging tools
   • VS Code debugger
   • Browser developer tools
   • Debug mode
8. Verification
   • Screenshots
   • Console logs
   • Page errors
   • Page events
9. Navigation and Loading
   • Overview
   • Common scenarios
   • Loading a popup
   • Client-side redirects
   • Navigation after a timeout
10. Multi-page scenarios
    • Multiple contexts
    • Multiple pages
    • Handling new pages
    • Handling popups
11. Test runners
    • Jest / Jasmine
    • AVA
    • Mocha
12. Continuous Integration
    • Docker
    • GitHub Actions
    • Azure Pipelines
    • Travis CI
    • CircleCI
    • Troubleshooting
13. Selector engines
14. Actionability
15. Extensibility
    • Custom selector engines
16. API Reference