# Vitest

[Vitest](https://vitest.dev/) is a blazing-fast unit test framework powered by Vite. Because Qwik Router uses [Vite](https://vitejs.dev/) by default, Vitest is our defacto unit test framework.

## Usage

You can add vitest easily by using the following Qwik starter script:

```shell
pnpm run qwik add vitest
```

After running the command, vitest will be installed and a new component will be added to your project. The component will be added to the `src/components/example` directory as well as a new unit test named `example.spec.tsx`.
If you are looking for an example for a Component with Qwik Router, see [QwikRouterMockProvider](/docs/api.md#qwikroutermockprovider).

```tsx title="example.spec.tsx"
import { createDOM } from '@qwik.dev/core/testing';
import { test, expect } from 'vitest';
import { ExampleTest } from './example';

test(`[ExampleTest Component]: Should render `, async () => {
  const { screen, render } = await createDOM();
  await render(<ExampleTest flag={true} />);
  expect(screen.outerHTML).toContain('');
  const div = screen.querySelector('.icon') as HTMLElement;
  expect(div.outerHTML).toContain('');
});

test(`[ExampleTest Component]: Should render `, async () => {
  const { screen, render } = await createDOM();
  await render(<ExampleTest flag={false} />);
  expect(screen.outerHTML).toContain('');
});

test(`[ExampleTest Component]: Click counter +1`, async () => {
  const { screen, render, userEvent } = await createDOM();
  await render(<ExampleTest flag={true} />);

  expect(screen.outerHTML).toContain('Count:0');

  const spanBefore = screen.querySelector('span') as HTMLDivElement;
  await userEvent('.btn-counter', 'click');
  expect(spanBefore.innerHTML).toEqual('Count:1');

  const spanAfter = screen.querySelector('span') as HTMLDivElement;
  await userEvent('button', 'click');
  expect(spanAfter.innerHTML).toEqual('Count:2');
});
```
