Simple and complete Vue.js testing utilities that encourage good testing practices.
\n\nVue Testing Library is a lightweight adapter built on top of DOM Testing Library and @vue/test-utils.
\n\nTimes clicked: {{ count }}
\n \n\n\n\n```\n\n```js\nimport {render, screen, fireEvent} from '@testing-library/vue'\nimport Button from './Button'\n\ntest('increments value on click', async () => {\n // The `render` method renders the component into the document.\n // It also binds to `screen` all the available queries to interact with\n // the component.\n render(Button)\n\n // queryByText returns the first matching node for the provided text\n // or returns null.\n expect(screen.queryByText('Times clicked: 0')).toBeTruthy()\n\n // getByText returns the first matching node for the provided text\n // or throws an error.\n const button = screen.getByText('increment')\n\n // Click a couple of times.\n await fireEvent.click(button)\n await fireEvent.click(button)\n\n expect(screen.queryByText('Times clicked: 2')).toBeTruthy()\n})\n```\n\n> You might want to install [`jest-dom`][jest-dom] to add handy assertions such\n> as `.toBeInTheDocument()`. In the example above, you could write\n> `expect(screen.getByText('Times clicked: 0')).toBeInTheDocument()`.\n\n> Using `byText` queries it's not the only nor the best way to query for\n> elements. Read [Which query should I use?][which-query] to discover\n> alternatives. In the example above, `getByRole('button', {name: 'increment'})`\n> is possibly the best option to get the button element.\n\n### More examples\n\nYou'll find examples of testing with different situations and popular libraries\nin [the test directory][test-directory].\n\nSome included are:\n\n- [`vuex`][vuex-example]\n- [`vue-router`][vue-router-example]\n- [`vee-validate`][vee-validate-example]\n- [`vue-i18n`][vue-i18n-example]\n- [`vuetify`][vuetify-example]\n\nFeel free to contribute with more examples!\n\n## Guiding Principles\n\n> [The more your tests resemble the way your software is used, the more\n> confidence they can give you.][guiding-principle]\n\nWe try to only expose methods and utilities that encourage you to write tests\nthat closely resemble how your Vue components are used.\n\nUtilities are included in this project based on the following guiding\nprinciples:\n\n1. If it relates to rendering components, it deals with DOM nodes rather than\n component instances, nor should it encourage dealing with component\n instances.\n2. It should be generally useful for testing individual Vue components or full\n Vue applications.\n3. Utility implementations and APIs should be simple and flexible.\n\nAt the end of the day, what we want is for this library to be pretty\nlight-weight, simple, and understandable.\n\n## Docs\n\n[**Read the docs**][docs] | [Edit the docs][docs-edit]\n\n## Typings\n\n_Please note that TypeScript 4.X is required._\n\nThe TypeScript type definitions are in the [types][types-directory] directory.\n\n## ESLint support\n\nIf you want to lint test files that use Vue Testing Library, you can use the\nofficial plugin: [eslint-plugin-testing-library][eslint-plugin-testing-library].\n\n## Issues\n\n_Looking to contribute? Look for the [Good First Issue][good-first-issue]\nlabel._\n\n### 🐛 Bugs\n\nPlease [file an issue][add-issue-bug] for bugs, missing documentation, or\nunexpected behavior.\n\n[**See Bugs**][bugs]\n\n### 💡 Feature Requests\n\nPlease [file an issue][add-issue] to suggest new features. Vote on feature\nrequests by adding a 👍. This helps maintainers prioritize what to work on.\n\n### ❓ Questions\n\nFor questions related to using the library, please visit a support community\ninstead of filing an issue on GitHub.\n\n- [Discord][discord]\n\n## License\n\n[MIT][license]\n\n## Contributors\n\n[](https://github.com/dfcook)\n[](https://github.com/afontcu)\n[](https://github.com/eunjae-lee)\n[](https://github.com/tim-maguire)\n[](https://github.com/samdelacruz)\n[](https://github.com/ankitsinghaniyaz)\n[](https://github.com/lindgr3n)\n[](https://github.com/kentcdodds)\n[](https://github.com/brennj)\n[](https://github.com/makeupsomething)\n[](https://github.com/mb200)\n[](https://github.com/Oluwasetemi)\n[](https://github.com/cimbul)\n[](https://github.com/alexkrolick)\n[](https://github.com/edufarre)\n[](https://github.com/SandraDml)\n[](https://github.com/arnaublanche)\n[](https://github.com/NoelDeMartin)\n[](https://github.com/chiptus)\n[](https://github.com/bennettdams)\n[](https://github.com/mediafreakch)\n[](https://github.com/afenton90)\n[](https://github.com/cilice)\n[](https://github.com/ITenthusiasm)\n\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/vue-testing-library.svg\n[coverage]: https://codecov.io/github/testing-library/vue-testing-library\n[github-badge]: https://badge.fury.io/gh/testing-library%2Fvue-testing-library.svg\n[github]: https://badge.fury.io/gh/testing-library%2Fvue-testing-library\n[npm-badge]: https://badge.fury.io/js/%40testing-library%2Fvue.svg\n[npm]: https://badge.fury.io/js/%40testing-library%2Fvue\n[license-badge]: https://img.shields.io/github/license/testing-library/vue-testing-library.svg\n[license]: https://github.com/testing-library/vue-testing-library/blob/master/LICENSE\n[discord]: https://testing-library.com/discord\n[discord-badge]: https://img.shields.io/discord/723559267868737556.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square\n[jest-dom]: https://github.com/testing-library/jest-dom\n[which-query]: https://testing-library.com/docs/guide-which-query\n[guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106\n[good-first-issue]: https://github.com/testing-library/vue-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22\n\n[docs]: https://testing-library.com/vue\n[docs-edit]: https://github.com/testing-library/testing-library-docs\n[eslint-plugin-testing-library]: https://github.com/testing-library/eslint-plugin-testing-library\n\n[bugs]: https://github.com/testing-library/vue-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc\n[add-issue-bug]: https://github.com/testing-library/vue-testing-library/issues/new?assignees=&labels=bug&template=bug_report.md&title=\n[add-issue]: (https://github.com/testing-library/vue-testing-library/issues/new)\n\n[types-directory]: https://github.com/testing-library/vue-testing-library/blob/main/types\n[test-directory]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__\n[vuex-example]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__/vuex.js\n[vue-router-example]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__/vue-router.js\n[vee-validate-example]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__/validate-plugin.js\n[vue-i18n-example]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__/translations-vue-i18n.js\n[vuetify-example]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__/vuetify.js\n","users":{}}