Testing Library ORG

@testing-library/angular

Simple and complete Angular testing utilities that encourage good testing
practices.

Read The Docs |
Edit the docs

<!-- prettier-ignore-start -->
[![Build Status][build-badge]][build]
[![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]

[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]
[![Discord][discord-badge]][discord]

[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]
<!-- prettier-ignore-end -->


Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

• [Table of Contents](#table-of-contents)
• [The problem](#the-problem)
• [This solution](#this-solution)
• [Example](#example)
• [Installation](#installation)
• [Version compatibility](#version-compatibility)
• [Guiding Principles](#guiding-principles)
• [Contributors](#contributors)
• [Docs](#docs)
• [FAQ](#faq)

- [I am using Reactive Forms and the jest-dom matcher toHaveFormValues always returns an empty object or there are missing fields. Why?](#i-am-using-reactive-forms-and-the-jest-dom-matcher-tohaveformvalues-always-returns-an-empty-object-or-there-are-missing-fields-why)

• [Issues](#issues)

- [🐛 Bugs](#-bugs) - [💡 Feature Requests](#-feature-requests) - [❓ Questions](#-questions)

• [Getting started with GitHub Codespaces](#getting-started-with-github-codespaces)
• [LICENSE](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

The problem

You want to write maintainable tests for your Angular components. As a part of
this goal, you want your tests to avoid including implementation details of your
components and rather focus on making your tests give you the confidence for
which they are intended. As part of this, you want your testbase to be
maintainable in the long run so refactors of your components (changes to
implementation but not functionality) don't break your tests and slow you and
your team down.

This solution

The @testing-library/angular is a very lightweight solution for
testing Angular components. It provides light utility functions on top of Angular
and @testing-library/dom, in a way that encourages better testing practices. Its
primary guiding principle is:

> [The more your tests resemble the way your software is used, the more
> confidence they can give you.][guiding-principle]

Example

counter.component.ts

ts
@Component({
  selector: 'atl-counter',
  template: `
    {{ hello() }}
    -
    Current Count: {{ counter() }}
    +
  `,
})
export class CounterComponent {
  counter = model(0);
  hello = input('Hi', { alias: 'greeting' });

  increment() {
    this.counter.set(this.counter() + 1);
  }

  decrement() {
    this.counter.set(this.counter() - 1);
  }
}

counter.component.spec.ts

typescript
import { render, screen, fireEvent, aliasedInput } from '@testing-library/angular';
import { CounterComponent } from './counter.component';

describe('Counter', () => {
  it('should render counter', async () => {
    await render(CounterComponent, {
      inputs: {
        counter: 5,
        // aliases need to be specified this way
        ...aliasedInput('greeting', 'Hello Alias!'),
      },
    });

    expect(screen.getByText('Current Count: 5')).toBeVisible();
    expect(screen.getByText('Hello Alias!')).toBeVisible();
  });

  it('should increment the counter on click', async () => {
    await render(CounterComponent, { inputs: { counter: 5 } });

    const incrementButton = screen.getByRole('button', { name: '+' });
    fireEvent.click(incrementButton);

    expect(screen.getByText('Current Count: 6')).toBeVisible();
  });
});

See more examples

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.
Starting from ATL version 17, you also need to install @testing-library/dom:

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

Or, you can use the ng add command.
This sets up your project to use Angular Testing Library, which also 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
the custom jest matchers.

> Docs

Version compatibility

| Angular | Angular Testing Library |
| ------- | ---------------------------------- |
| 22.x | 19.x |
| 21.x | 19.x |
| 20.x | 18.x, 17.x, 16.x, 15.x, 14.x, 13.x |
| 19.x | 17.x, 16.x, 15.x, 14.x, 13.x |
| 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

> [The more your tests resemble the way your software is used, the more
> confidence they can give you.][guiding-principle]

We try to only expose methods and utilities that encourage you to write tests
that closely resemble how your Angular components are used.

Utilities are included in this project based on the following guiding
principles:

1. If it relates to rendering components, it deals with DOM nodes rather than
component instances, nor should it encourage dealing with component
instances.
2. It should be generally useful for testing individual Angular components or
full Angular applications.
3. Utility implementations and APIs should be simple and flexible.

At the end of the day, what we want is for this library to be pretty
light-weight, simple, and understandable.

Contributors

Thanks goes to these people ([emoji key][emojis]):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

Tim Deschryver💻 📖 🚇 ⚠️
Michaël De Boey📖
Ignacio Le Fluk💻 ⚠️
Tamás Szabó💻
Gregor Woiwode💻
Toni Villena🐛 💻 📖 ⚠️
ShPelles📖


Miluoshi💻 ⚠️
Nick McCurdy📖
Srinivasan Sekar📖
Bitcollage📖
Emil Sundin💻
Ombrax💻
Rafael Santana💻 ⚠️ 🐛


Benjamin Blackwood📖 ⚠️
Gustavo Porto📖
Bo Vandersteene💻
Janek💻 ⚠️
Gleb Irovich💻 <a href="https://github.com/testing-library/angular-testing-library/commits?author=G

…

Collapse