@testing-library/angular
TypeScript icon, indicating that this package has built-in type declarations

15.2.0 • Public • Published

@testing-library/angular

Octopus with the Angular logo

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


Read The Docs | Edit the docs



Build Status version downloads MIT License

All Contributors PRs Welcome Code of Conduct Discord

Watch on GitHub Star on GitHub Tweet

Open in GitHub Codespaces

Table of Contents

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.

Example

counter.component.ts

@Component({
  selector: 'counter',
  template: `
    <button (click)="decrement()">-</button>
    <span>Current Count: {{ counter }}</span>
    <button (click)="increment()">+</button>
  `,
})
export class CounterComponent {
  @Input() counter = 0;

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

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

counter.component.spec.ts

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

describe('Counter', () => {
  test('should render counter', async () => {
    await render(CounterComponent, { componentProperties: { counter: 5 } });

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

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

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

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

See more examples

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

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

You may also be interested in installing jest-dom so you can use the custom jest matchers.

Docs

Version compatibility

Angular Angular Testing Library
17.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.

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):

Tim Deschryver
Tim Deschryver

💻 📖 🚇 ⚠️
Michaël De Boey
Michaël De Boey

📖
Ignacio Le Fluk
Ignacio Le Fluk

💻 ⚠️
Tamás Szabó
Tamás Szabó

💻
Gregor Woiwode
Gregor Woiwode

💻
Toni Villena
Toni Villena

🐛 💻 📖 ⚠️
ShPelles
ShPelles

📖
Miluoshi
Miluoshi

💻 ⚠️
Nick McCurdy
Nick McCurdy

📖
Srinivasan Sekar
Srinivasan Sekar

📖
Bitcollage
Bitcollage

📖
Emil Sundin
Emil Sundin

💻
Ombrax
Ombrax

💻
Rafael Santana
Rafael Santana

💻 ⚠️ 🐛
Benjamin Blackwood
Benjamin Blackwood

📖 ⚠️
Gustavo Porto
Gustavo Porto

📖
Bo Vandersteene
Bo Vandersteene

💻
Janek
Janek

💻 ⚠️
Gleb Irovich
Gleb Irovich

💻 ⚠️
Arjen
Arjen

💻 🚧
Suguru Inatomi
Suguru Inatomi

💻 🤔
Amit Miran
Amit Miran

🚇
Jan-Willem Willebrands
Jan-Willem Willebrands

💻
Sandro
Sandro

💻 🐛
Michael Westphal
Michael Westphal

💻 ⚠️
Lukas
Lukas

💻
Matan Borenkraout
Matan Borenkraout

🚧
mleimer
mleimer

📖 ⚠️
MeIr
MeIr

🐛 ⚠️
John Dengis
John Dengis

💻 ⚠️
Rokas Brazdžionis
Rokas Brazdžionis

💻
Mateus Duraes
Mateus Duraes

💻
Josh Joseph
Josh Joseph

💻 ⚠️
Torsten Knauf
Torsten Knauf

🚧
antischematic
antischematic

🐛 🤔
Florian Pabst
Florian Pabst

💻
Mark Goho
Mark Goho

🚧 📖
Jan-Willem Baart
Jan-Willem Baart

💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

Docs

Read The Docs | Edit the docs

FAQ

I am using Reactive Forms and the jest-dom matcher toHaveFormValues always returns an empty object or there are missing fields. Why?

Only form elements with a name attribute will have their values passed to toHaveFormsValues.

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

❓ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

Getting started with GitHub Codespaces

To get started, create a codespace for this repository by clicking this 👇

Open in GitHub Codespaces

A codespace will open in a web-based version of Visual Studio Code. The dev container is fully configured with software needed for this project.

Note: Dev containers is an open spec which is supported by GitHub Codespaces and other tools.

LICENSE

MIT

Package Sidebar

Install

npm i @testing-library/angular

Weekly Downloads

74,327

Version

15.2.0

License

MIT

Unpacked Size

210 kB

Total Files

30

Last publish

Collaborators

  • eps1lon
  • mdjastrzebski
  • jdecroock
  • testing-library-bot
  • kentcdodds
  • timdeschryver
  • patrickhulce
  • dfcook
  • gpx
  • mpeyper
  • mihar-22
  • pago
  • cmckinstry
  • thymikee
  • brrianalexis