Skip to content

Commit

Permalink
docs: capabilities (microsoft#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
sand4rt committed Nov 5, 2023
1 parent 07a30b0 commit 5c378b2
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions playwright-ct-angular/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
# Playwright Angular component testing
# 🎭 Playwright Angular component testing

> **Note**
> The API has been designed to closely resemble Playwright's API wherever applicable. This library is _(without guarantee)_ aimed at facilitating a smooth transition to Playwright once it offers official support for Angular components. It is important to take into account that this library will reach end of life when Playwright has official support for Angular component testing.
>
> To push for official support, feedback in the form of GitHub issues and or stars is appreciated!
## Capabilities

- Run tests fast, in parallel and optionally [over multiple machines](https://playwright.dev/docs/test-sharding).
- Run the test accross multiple _real_ desktop and mobile browsers.
- Full support for shadow DOM, multiple origins, (i)frames, tabs and contexts.
- Minimizes flakyness, due to auto waiting, web first assertions and ensures that every test runs in full isolation.
- Advanced [emulation capabilities](https://playwright.dev/docs/emulation) such as modifying screen size, color scheme and [the network](https://playwright.dev/docs/mock-browser-apis).
- [Visual regression testing](https://playwright.dev/docs/screenshots).
- Full zero-configuration TypeScript support.

Along with all these ✨ awesome capabilities ✨ that come with Playwright, you will also get:

- [Watch mode _(BETA)_](https://github.com/microsoft/playwright/issues/21960#issuecomment-1483604692).
- [Visual Studio Code intergration](https://playwright.dev/docs/getting-started-vscode).
- [UI mode](https://playwright.dev/docs/test-ui-mode) for debuging tests with a time travel experience complete with watch mode.
- [Playwright Tracing](https://playwright.dev/docs/trace-viewer-intro) for post-mortem debugging in CI.
- [Playwright Test Code generation](https://playwright.dev/docs/codegen-intro) to record and generate tests suites.

## Usage

Initialize Playwright Angular component testing with PNPM, NPM or Yarn and follow the installation steps:
Expand All @@ -19,7 +37,7 @@ npm init playwright-sand4rt@latest -- --ct
yarn create playwright-sand4rt --ct
```

Now you can start adding your first test:
Now you can start creating your tests:

```ts
// button.component.ts
Expand Down

0 comments on commit 5c378b2

Please sign in to comment.