Skip to content

docs: update docs for v17 #459

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

Merged
merged 1 commit into from
Jun 22, 2024
Merged

docs: update docs for v17 #459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 18 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,18 @@ describe('Counter', () => {
## Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `devDependencies`:
should be installed as one of your project's `devDependencies`.
Starting from ATL version 17, you'll also need to install `@testing-library/dom`:

```bash
npm install @testing-library/angular --save-dev
npm install --save-dev @testing-library/angular @testing-library/dom
```

Or, you can use the `ng add` command.
This includes the installation of `@testing-library/dom`.

```bash
ng add @testing-library/angular
```

You may also be interested in installing `jest-dom` so you can use
Expand All @@ -160,14 +168,14 @@ You may also be interested in installing `jest-dom` so you can use

## Version compatibility

| Angular | Angular Testing Library |
| ------- | ----------------------- |
| 18.x | 16.x, 15.x, 14.x, 13.x |
| 17.x | 16.x, 15.x, 14.x, 13.x |
| 16.x | 14.x, 13.x |
| >= 15.1 | 14.x, 13.x |
| < 15.1 | 12.x, 11.x |
| 14.x | 12.x, 11.x |
| Angular | Angular Testing Library |
| ------- | ---------------------------- |
| 18.x | 17.x, 16.x, 15.x, 14.x, 13.x |
| 17.x | 17.x, 16.x, 15.x, 14.x, 13.x |
| 16.x | 14.x, 13.x |
| >= 15.1 | 14.x, 13.x |
| < 15.1 | 12.x, 11.x |
| 14.x | 12.x, 11.x |

## Guiding Principles

Expand Down