├── .eslintrc.json ├── .gitignore ├── .nvmrc ├── .pa11yci ├── .prettierrc ├── LICENSE ├── README.md ├── e2e ├── aria-snapshots.spec.ts ├── axe.spec.ts ├── keyboard.spec.ts ├── reflow.spec.ts ├── semantics.spec.ts ├── spacing.spec.ts └── textsize.spec.ts ├── next.config.mjs ├── package-lock.json ├── package.json ├── playwright.config.ts ├── postcss.config.mjs ├── public ├── GuideDog1.jpg ├── icons │ ├── cross.png │ ├── exclamation.png │ └── search.png ├── next.svg └── vercel.svg ├── results.json ├── src ├── app │ ├── bugpit │ │ └── page.tsx │ ├── favicon.ico │ ├── globals.css │ ├── keyboard │ │ └── page.tsx │ ├── layout.tsx │ ├── page.tsx │ ├── reflow │ │ └── page.tsx │ ├── spacing │ │ └── page.tsx │ └── textsize │ │ └── page.tsx ├── components │ ├── BadExampleForAButton.tsx │ ├── BadExampleForALinkButton.tsx │ └── keyboard │ │ └── KeyboardAccessibleDialog.tsx └── test │ ├── KeyboardAccessibleDialog.test.tsx │ ├── automatedTool.test.tsx │ └── semantics.test.tsx ├── tailwind.config.ts ├── test-setup.js ├── tsconfig.json └── vite.config.js /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es2021": true, 5 | "node": true 6 | }, 7 | "parser": "@typescript-eslint/parser", 8 | "parserOptions": { 9 | "ecmaVersion": 12, 10 | "sourceType": "module", 11 | "ecmaFeatures": { 12 | "jsx": true 13 | } 14 | }, 15 | "extends": [ 16 | "eslint:recommended", 17 | "plugin:react/recommended", 18 | "plugin:react/jsx-runtime", 19 | "plugin:react-hooks/recommended", 20 | "plugin:jsx-a11y/recommended" 21 | ], 22 | "plugins": ["react", "react-hooks", "@typescript-eslint", "jsx-a11y"], 23 | "overrides": [ 24 | { 25 | "files": ["src/**", "db/**"], 26 | "rules": { 27 | "no-unused-vars": "off", 28 | "@typescript-eslint/no-unused-vars": "error", 29 | "jsx-a11y/anchor-ambiguous-text": [2, { 30 | "words": ["back"] 31 | }] 32 | } 33 | } 34 | ], 35 | "settings": { 36 | "react": { 37 | "version": "detect" 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | /test-results/** 11 | /playwright-report/** 12 | 13 | # next.js 14 | /.next/ 15 | /out/ 16 | 17 | # production 18 | /build 19 | 20 | # misc 21 | .DS_Store 22 | *.pem 23 | 24 | # debug 25 | npm-debug.log* 26 | yarn-debug.log* 27 | yarn-error.log* 28 | .pnpm-debug.log* 29 | 30 | # local env files 31 | .env*.local 32 | 33 | # vercel 34 | .vercel 35 | 36 | # typescript 37 | *.tsbuildinfo 38 | next-env.d.ts 39 | 40 | # IntelliJ 41 | /.idea/ 42 | /a11y-testing.iml 43 | 44 | 45 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 18 2 | -------------------------------------------------------------------------------- /.pa11yci: -------------------------------------------------------------------------------- 1 | { 2 | "defaults": { 3 | "timeout": 10000 4 | }, 5 | "urls": [ 6 | "http://localhost:3000", 7 | "http://localhost:3000/keyboard", 8 | "http://localhost:3000/reflow", 9 | "http://localhost:3000/spacing", 10 | "http://localhost:3000/textsize", 11 | "http://localhost:3000/bugpit" 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "plugins": ["prettier-plugin-tailwindcss"] 3 | } 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Automated accessibility testing. 2 | 3 | This is a project demonstrating strategies for writing tests for the accessibility of the user interface. 4 | 5 | The code stack is React with NextJS. 6 | 7 | ## Getting Started 8 | 9 | To install: 10 | ```bash 11 | npm install 12 | ``` 13 | 14 | The project contains a couple of test pages. Start the development server and visit http://localhost:3000 to see them. 15 | 16 | ```bash 17 | npm run dev 18 | ``` 19 | 20 | ## Linting 21 | The linter plugin [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y) asserts 22 | accessibility best practices purely on the code basis and supports during coding. 23 | 24 | ```bash 25 | npm run lint 26 | ``` 27 | 28 | ## Unit tests 29 | 30 | The unit test use [Vitest](https://vitest.dev/) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/). 31 | They also demonstrate the usage of [axe-core](https://github.com/dequelabs/axe-core), an automated accessibility testing tool. 32 | To run: 33 | 34 | ```bash 35 | npm run test 36 | ``` 37 | 38 | ## E2E tests 39 | 40 | The E2E tests use [Playwright](https://playwright.dev/) (main branch) 41 | or [Cypress](https://www.cypress.io/) (cypress branch). 42 | 43 | They need a running dev server. 44 | 45 | Like the unit tests, they also demonstrate the usage of [axe-core](https://github.com/dequelabs/axe-core). 46 | Note that some tests fail intentionally. This is documented in the code. 47 | To run: 48 | 49 | ```bash 50 | npm run test:e2e 51 | ``` 52 | 53 | ## CI tests 54 | 55 | Automated accessibility tests can be run in the pipeline with [Pa11y](https://pa11y.org/). 56 | The automated testing tool used is [HTML_CodeSniffer](https://github.com/squizlabs/HTML_CodeSniffer). 57 | They need a running dev server. 58 | To run: 59 | 60 | ```bash 61 | npm run test:ci 62 | ``` 63 | -------------------------------------------------------------------------------- /e2e/aria-snapshots.spec.ts: -------------------------------------------------------------------------------- 1 | import { test, expect } from "@playwright/test"; 2 | 3 | //Demonstrate the usage of snapshots for aria attributes 4 | 5 | test.describe("Aria Snapshots", () => { 6 | test("should have proper semantics in keyboard navigation page", async ({ 7 | page, 8 | }) => { 9 | await page.goto("/keyboard"); 10 | await expect(page.locator("ul")).toMatchAriaSnapshot(` 11 | - list: 12 | - listitem: 13 | - text: Can everything in the page be reached and used with the keyboard? See 14 | - link "WCAG 2.1.1" 15 | - listitem: 16 | - text: Is the focus order logical? See 17 | - link "WCAG 2.4.3" 18 | - listitem: 19 | - text: Can the keyboard user be trapped? See 20 | - link "WCAG 2.1.2"`); 21 | }); 22 | 23 | test("should have certain text in h1 heading", async ({ page }) => { 24 | await page.goto("/keyboard"); 25 | // partial matching, we do not need to specify everything 26 | await expect(page.getByText("Keyboard navigation test cases")) 27 | .toMatchAriaSnapshot(` 28 | - heading [level=1] 29 | `); 30 | }); 31 | }); 32 | -------------------------------------------------------------------------------- /e2e/axe.spec.ts: -------------------------------------------------------------------------------- 1 | import { test, expect } from "@playwright/test"; 2 | import AxeBuilder from "@axe-core/playwright"; 3 | 4 | //Demonstrate the usage of the automated testing tool axe 5 | 6 | test.describe("Axe tests", () => { 7 | test("should not have a11y violations", async ({ page }) => { 8 | await page.goto("/bugpit"); 9 | const accessibilityScanResults = await new AxeBuilder({ page }).analyze(); 10 | expect(accessibilityScanResults.violations).toEqual([]); 11 | }); 12 | }); 13 | -------------------------------------------------------------------------------- /e2e/keyboard.spec.ts: -------------------------------------------------------------------------------- 1 | import { expect, Locator, Page, test } from "@playwright/test"; 2 | import AxeBuilder from "@axe-core/playwright"; 3 | 4 | // Examples for automated testing of keyboard accessibility: 5 | // - focus/tab order 6 | // - user flow with a keyboard 7 | // - focus style 8 | 9 | test.describe("Keyboard navigation", () => { 10 | test.beforeEach(async ({ page }) => { 11 | await page.goto("/keyboard"); 12 | }); 13 | 14 | // Assert baseline accessibility of the page 15 | test("should not have automatically detectable accessibility issues", async ({ 16 | page, 17 | }) => { 18 | const accessibilityScanResults = await new AxeBuilder({ page }).analyze(); 19 | expect(accessibilityScanResults.violations).toEqual([]); 20 | }); 21 | 22 | // Tests for tab order 23 | test("should focus back link first", async ({ page }) => { 24 | await page.keyboard.press("Tab"); 25 | await expect(page.locator("*:focus-visible")).toHaveText("Back to main"); 26 | }); 27 | 28 | test("should have correct tab order", async ({ page }) => { 29 | await expect(await nextElementInTabOrder(page)).toHaveText("Back to main"); 30 | await expect(await nextElementInTabOrder(page)).toHaveAccessibleName( 31 | "WCAG 2.1.1", 32 | ); 33 | await expect(await previousElementInTabOrder(page)).toHaveText( 34 | "Back to main", 35 | ); 36 | }); 37 | 38 | // this fails, because Button 3 is before Button 2 in the focus order 39 | test("should have focus order following visible order", async ({ page }) => { 40 | await page.getByRole("button", { name: "Button 1" }).focus(); 41 | const button2 = await nextElementInTabOrder(page); 42 | await expect(button2).toHaveAccessibleName("Button 2"); 43 | const button3 = await nextElementInTabOrder(page); 44 | await expect(button3).toHaveAccessibleName("Button 3"); 45 | }); 46 | 47 | // Example for testing user flow with the keyboard 48 | test("should be able to use the info dialog with the keyboard", async ({ 49 | page, 50 | }) => { 51 | const dialogButton = page.getByRole("button", { name: "More information" }); 52 | await dialogButton.focus(); 53 | await page.keyboard.press("Enter"); 54 | await expect(page.getByText("OK")).toBeVisible(); 55 | const closeButton = page.locator("*:focus-visible"); 56 | await expect(closeButton).toHaveAccessibleName("Close Dialog"); 57 | await nextElementInTabOrder(page); 58 | const okButton = page.locator("*:focus-visible"); 59 | await expect(okButton).toHaveAccessibleName("OK"); 60 | await page.keyboard.press("Enter"); 61 | await expect(page.getByText("OK")).toHaveCount(0); 62 | }); 63 | 64 | // Example for testing that a focus style is applied 65 | test("should have focus style", async ({ page }) => { 66 | await page.keyboard.press("Tab"); 67 | const focusedElement = page.locator("*:focus-visible"); 68 | const hasFocusStyle = await focusedElement.evaluate((element) => { 69 | const computedStyle = window.getComputedStyle(element); 70 | return ( 71 | computedStyle.getPropertyValue("outline") === 72 | "rgb(128, 128, 128) solid 2px" && 73 | computedStyle.getPropertyValue("outline-offset") === "4px" && 74 | computedStyle.getPropertyValue("border-radius") === "2px" 75 | ); 76 | }); 77 | expect(hasFocusStyle).toBeTruthy(); 78 | }); 79 | 80 | const nextElementInTabOrder = async (page: Page): Promise => { 81 | await page.keyboard.press("Tab"); 82 | return page.locator("*:focus-visible"); 83 | }; 84 | 85 | const previousElementInTabOrder = async (page: Page): Promise => { 86 | await page.keyboard.press("Shift+Tab"); 87 | return page.locator("*:focus-visible"); 88 | }; 89 | }); 90 | -------------------------------------------------------------------------------- /e2e/reflow.spec.ts: -------------------------------------------------------------------------------- 1 | import { test, expect } from "@playwright/test"; 2 | import AxeBuilder from "@axe-core/playwright"; 3 | 4 | // Example tests for correct layout on small screens (320x256px) 5 | // according to WCAG 1.4.10 Reflow 6 | 7 | test.describe("Reflow", () => { 8 | test.beforeEach(async ({ page }) => { 9 | await page.goto("/reflow"); 10 | await page.setViewportSize({ width: 320, height: 256 }); 11 | }); 12 | 13 | // Ensure baseline accessibility of the page 14 | test("should not have automatically detectable accessibility issues", async ({ 15 | page, 16 | }) => { 17 | const accessibilityScanResults = await new AxeBuilder({ page }).analyze(); 18 | expect(accessibilityScanResults.violations).toEqual([]); 19 | }); 20 | 21 | // this fails, because on the small resolution the search box is not completely in viewport 22 | test("should have searchbox completely in view on smallest resolution", async ({ 23 | page, 24 | }) => { 25 | const searchbox = page.getByRole("searchbox"); 26 | await expect(searchbox).toBeInViewport({ ratio: 1 }); 27 | }); 28 | 29 | // this fails, because on the small resolution home link cannot be scrolled into viewport at all 30 | test("should be able to scroll homelink into view on smallest resolution", async ({ 31 | page, 32 | }) => { 33 | const homeLink = page.getByRole("link", { name: "Home" }); 34 | await homeLink.scrollIntoViewIfNeeded(); 35 | await expect(homeLink).toBeInViewport({ ratio: 1 }); 36 | }); 37 | 38 | // this fails, because on the small resolution there is a horizontal scrollbar 39 | test("should not have horizontal scrollbar on smallest resolution", async ({ 40 | page, 41 | }) => { 42 | const hasHorizontalScrollbar = await page.evaluate( 43 | () => 44 | document.documentElement.scrollWidth > 45 | document.documentElement.clientWidth, 46 | ); 47 | expect(hasHorizontalScrollbar).toBeFalsy(); 48 | }); 49 | }); 50 | -------------------------------------------------------------------------------- /e2e/semantics.spec.ts: -------------------------------------------------------------------------------- 1 | import { expect, test } from "@playwright/test"; 2 | 3 | // Tests for demonstrating the assertion of proper semantics in a web page 4 | 5 | test.describe("Asserting semantics", () => { 6 | test.beforeEach(async ({ page }) => { 7 | await page.goto("/keyboard"); 8 | }); 9 | 10 | test("should have appropriate heading", async ({ page }) => { 11 | await expect(page.getByRole("heading", { level: 1 })).toHaveText( 12 | "Keyboard navigation test cases", 13 | ); 14 | }); 15 | 16 | test("should have a button for the more information popup", async ({ 17 | page, 18 | }) => { 19 | await expect( 20 | page.getByRole("button", { name: "More information" }), 21 | ).toBeVisible(); 22 | }); 23 | 24 | test("alternative: should have a button for the more information popup", async ({ 25 | page, 26 | }) => { 27 | // This is to demonstrate how to use toHaveAccessibleName 28 | // when it cannot be asserted through the selector for some reason 29 | await expect(page.getByRole("button").first()).toHaveAccessibleName( 30 | "More information", 31 | ); 32 | }); 33 | }); 34 | -------------------------------------------------------------------------------- /e2e/spacing.spec.ts: -------------------------------------------------------------------------------- 1 | import { test, expect, Page, Locator } from "@playwright/test"; 2 | import AxeBuilder from "@axe-core/playwright"; 3 | 4 | // Example tests for correct layout when text spacing is increased 5 | // according to WCAG 1.4.12 Text spacing 6 | 7 | test.describe("Spacing", () => { 8 | test.beforeEach(async ({ page }) => { 9 | await page.goto("/spacing"); 10 | }); 11 | 12 | test("should not have overflowing content", async ({ page }) => { 13 | await assertNoViolations(page); 14 | 15 | const cssAppraisalText = page.getByText("CSS is very awesome"); 16 | expect(await contentFitsInsideContainer(cssAppraisalText)).toBeTruthy(); 17 | }); 18 | 19 | // this fails, because the content overflows 20 | test("should not have overflowing content when spacing is increased", async ({ 21 | page, 22 | }) => { 23 | await page.evaluate(() => { 24 | document.documentElement.style.lineHeight = "1.5rem"; 25 | document.documentElement.style.letterSpacing = "0.12em"; 26 | document.documentElement.style.wordSpacing = "0.16em"; 27 | }); 28 | 29 | await assertNoViolations(page); 30 | 31 | const cssAppraisalText = page.getByText("CSS is very awesome"); 32 | expect(await contentFitsInsideContainer(cssAppraisalText)).toBeTruthy(); 33 | }); 34 | 35 | const contentFitsInsideContainer = async (locator: Locator) => 36 | await locator.evaluate( 37 | (element) => 38 | element.scrollHeight <= element.clientHeight && 39 | element.scrollWidth <= element.clientWidth, 40 | ); 41 | 42 | const assertNoViolations = async (page: Page) => { 43 | const accessibilityScanResults = await new AxeBuilder({ page }).analyze(); 44 | expect(accessibilityScanResults.violations).toEqual([]); 45 | }; 46 | }); 47 | -------------------------------------------------------------------------------- /e2e/textsize.spec.ts: -------------------------------------------------------------------------------- 1 | import { test, expect, Page, Locator } from "@playwright/test"; 2 | import AxeBuilder from "@axe-core/playwright"; 3 | 4 | // Example tests for correct layout when text size is increased to 200% 5 | // according to WCAG 1.4.4 Resize text 6 | 7 | test.describe("Text size", () => { 8 | test.beforeEach(async ({ page }) => { 9 | await page.goto("/textsize"); 10 | }); 11 | 12 | test("should not have overflowing content on normal text size", async ({ 13 | page, 14 | }) => { 15 | await assertNoViolations(page); 16 | 17 | const cssAppraisalText = page.getByText("CSS is awesome"); 18 | expect(await contentFitsInsideContainer(cssAppraisalText)).toBeTruthy(); 19 | 20 | const cssAppraisalText2 = page.getByText("CSS is still awesome"); 21 | expect(await contentFitsInsideContainer(cssAppraisalText2)).toBeTruthy(); 22 | }); 23 | 24 | // this fails because content overflows 25 | test("should not have overflowing content on 200% text size", async ({ 26 | page, 27 | }) => { 28 | await page.evaluate(() => { 29 | document.documentElement.style.fontSize = "200%"; 30 | }); 31 | 32 | await assertNoViolations(page); 33 | 34 | const cssAppraisalText = page.getByText("CSS is awesome"); 35 | expect(await contentFitsInsideContainer(cssAppraisalText)).toBeTruthy(); 36 | }); 37 | 38 | // this fails because content is clipped 39 | test("should not have clipped content on 200% text size", async ({ 40 | page, 41 | }) => { 42 | await page.evaluate(() => { 43 | document.documentElement.style.fontSize = "200%"; 44 | }); 45 | 46 | await assertNoViolations(page); 47 | 48 | const cssAppraisalText = page.getByText("CSS is still awesome"); 49 | expect(await contentFitsInsideContainer(cssAppraisalText)).toBeTruthy(); 50 | }); 51 | 52 | const contentFitsInsideContainer = async (locator: Locator) => 53 | await locator.evaluate( 54 | (element) => 55 | element.scrollHeight <= element.clientHeight && 56 | element.scrollWidth <= element.clientWidth, 57 | ); 58 | 59 | const assertNoViolations = async (page: Page) => { 60 | const accessibilityScanResults = await new AxeBuilder({ page }).analyze(); 61 | expect(accessibilityScanResults.violations).toEqual([]); 62 | }; 63 | }); 64 | -------------------------------------------------------------------------------- /next.config.mjs: -------------------------------------------------------------------------------- 1 | /** @type {import('next').NextConfig} */ 2 | const nextConfig = {}; 3 | 4 | export default nextConfig; 5 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "a11y-testing", 3 | "version": "0.1.0", 4 | "private": true, 5 | "scripts": { 6 | "dev": "next dev", 7 | "build": "next build", 8 | "start": "next start", 9 | "lint": "next lint", 10 | "test": "vitest", 11 | "test:e2e": "playwright test --ui", 12 | "test:ci": "./node_modules/.bin/pa11y-ci" 13 | }, 14 | "dependencies": { 15 | "@types/node": "^20", 16 | "@types/react": "^18", 17 | "@types/react-dom": "^18", 18 | "color-contrast-checker": "^2.1.0", 19 | "next": "^14.2.24", 20 | "pa11y": "^8.0.0", 21 | "react": "^18", 22 | "react-dom": "^18" 23 | }, 24 | "devDependencies": { 25 | "@axe-core/playwright": "^4.9.1", 26 | "@playwright/test": "^1.49.0", 27 | "@testing-library/jest-dom": "^6.4.6", 28 | "@testing-library/react": "^16.0.0", 29 | "@testing-library/user-event": "^14.5.2", 30 | "@types/jest-axe": "^3.5.9", 31 | "@typescript-eslint/eslint-plugin": "^7.12.0", 32 | "@typescript-eslint/parser": "^7.5.0", 33 | "@vitejs/plugin-react": "^4.3.4", 34 | "eslint": "^8", 35 | "eslint-config-next": "14.2.3", 36 | "eslint-plugin-jsx-a11y": "^6.10.1", 37 | "eslint-plugin-react": "^7.34.1", 38 | "eslint-plugin-react-hooks": "^4.6.0", 39 | "jest-axe": "^9.0.0", 40 | "jest-environment-jsdom": "^29.7.0", 41 | "jsdom": "^24.1.0", 42 | "pa11y-ci": "^2.4.2", 43 | "pa11y-reporter-html": "^2.0.0", 44 | "postcss": "^8", 45 | "prettier": "3.2.5", 46 | "prettier-plugin-tailwindcss": "^0.5.13", 47 | "tailwindcss": "^3.4.1", 48 | "typescript": "^5", 49 | "vitest": "^2.1.9" 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /playwright.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig, devices } from "@playwright/test"; 2 | 3 | /** 4 | * Read environment variables from file. 5 | * https://github.com/motdotla/dotenv 6 | */ 7 | // require('dotenv').config(); 8 | 9 | /** 10 | * See https://playwright.dev/docs/test-configuration. 11 | */ 12 | export default defineConfig({ 13 | testDir: "./e2e", 14 | /* Run tests in files in parallel */ 15 | fullyParallel: true, 16 | /* Fail the build on CI if you accidentally left test.only in the source code. */ 17 | // eslint-disable-next-line no-undef 18 | forbidOnly: !!process.env.CI, 19 | /* Retry on CI only */ 20 | // eslint-disable-next-line no-undef 21 | retries: process.env.CI ? 2 : 0, 22 | /* Opt out of parallel tests on CI. */ 23 | // eslint-disable-next-line no-undef 24 | workers: process.env.CI ? 1 : undefined, 25 | /* Reporter to use. See https://playwright.dev/docs/test-reporters */ 26 | reporter: "html", 27 | /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ 28 | use: { 29 | /* Base URL to use in actions like `await page.goto('/')`. */ 30 | baseURL: "http://localhost:3000", 31 | 32 | /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */ 33 | trace: "on-first-retry", 34 | browserName: "chromium", 35 | }, 36 | 37 | /* Configure projects for major browsers */ 38 | projects: [ 39 | { 40 | name: "chromium", 41 | use: { ...devices["Desktop Chrome"] }, 42 | }, 43 | 44 | { 45 | name: "firefox", 46 | use: { ...devices["Desktop Firefox"] }, 47 | }, 48 | 49 | { 50 | name: "webkit", 51 | use: { ...devices["Desktop Safari"] }, 52 | }, 53 | 54 | /* Test against mobile viewports. */ 55 | // { 56 | // name: 'Mobile Chrome', 57 | // use: { ...devices['Pixel 5'] }, 58 | // }, 59 | // { 60 | // name: 'Mobile Safari', 61 | // use: { ...devices['iPhone 12'] }, 62 | // }, 63 | 64 | /* Test against branded browsers. */ 65 | // { 66 | // name: 'Microsoft Edge', 67 | // use: { ...devices['Desktop Edge'], channel: 'msedge' }, 68 | // }, 69 | // { 70 | // name: 'Google Chrome', 71 | // use: { ...devices['Desktop Chrome'], channel: 'chrome' }, 72 | // }, 73 | ], 74 | 75 | /* Run your local dev server before starting the tests */ 76 | // webServer: { 77 | // command: 'npm run start', 78 | // url: 'http://127.0.0.1:3000', 79 | // reuseExistingServer: !process.env.CI, 80 | // }, 81 | }); 82 | -------------------------------------------------------------------------------- /postcss.config.mjs: -------------------------------------------------------------------------------- 1 | /** @type {import('postcss-load-config').Config} */ 2 | const config = { 3 | plugins: { 4 | tailwindcss: {}, 5 | }, 6 | }; 7 | 8 | export default config; 9 | -------------------------------------------------------------------------------- /public/GuideDog1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/annam002/automated-accessibility-testing/fd7ecd89e6526bce775b1246125c96481ab33c8e/public/GuideDog1.jpg -------------------------------------------------------------------------------- /public/icons/cross.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/annam002/automated-accessibility-testing/fd7ecd89e6526bce775b1246125c96481ab33c8e/public/icons/cross.png -------------------------------------------------------------------------------- /public/icons/exclamation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/annam002/automated-accessibility-testing/fd7ecd89e6526bce775b1246125c96481ab33c8e/public/icons/exclamation.png -------------------------------------------------------------------------------- /public/icons/search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/annam002/automated-accessibility-testing/fd7ecd89e6526bce775b1246125c96481ab33c8e/public/icons/search.png -------------------------------------------------------------------------------- /public/next.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /public/vercel.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /results.json: -------------------------------------------------------------------------------- 1 | { 2 | "total": 2, 3 | "passes": 1, 4 | "errors": 1, 5 | "results": { 6 | "http://localhost:3000/": [], 7 | "http://localhost:3000/labels": [ 8 | { 9 | "code": "WCAG2AA.Principle4.Guideline4_1.4_1_1.F77", 10 | "type": "error", 11 | "typeCode": 1, 12 | "message": "Duplicate id attribute value \"birthdate\" found on the web page.", 13 | "context": "", 14 | "selector": "#birthdate", 15 | "runner": "htmlcs", 16 | "runnerExtras": {}, 17 | "typeLabel": "Error" 18 | } 19 | ] 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/app/bugpit/page.tsx: -------------------------------------------------------------------------------- 1 | import { BadExampleForAButton } from "@/components/BadExampleForAButton"; 2 | import { BadExampleForALinkButton } from "@/components/BadExampleForALinkButton"; 3 | 4 | export default function BugExamplePage() { 5 | return ( 6 |
7 |
8 | This page is full of accessibility bugs 9 |
10 | Back 11 |
12 |

What to test here

13 |

14 | This page is full of accessibility bugs. Run automated checks and find 15 | out what the automated testing tools can detect. 16 |

17 |
18 |
19 |
A buggy form
20 | 21 | 22 | 23 |
24 |
25 |
Images and links
26 | 27 | 28 |
29 |
30 | ); 31 | } 32 | -------------------------------------------------------------------------------- /src/app/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/annam002/automated-accessibility-testing/fd7ecd89e6526bce775b1246125c96481ab33c8e/src/app/favicon.ico -------------------------------------------------------------------------------- /src/app/globals.css: -------------------------------------------------------------------------------- 1 | @tailwind base; 2 | @tailwind components; 3 | @tailwind utilities; 4 | 5 | :focus-visible { 6 | outline: 2px solid gray; 7 | outline-offset: 4px; 8 | border-radius: 2px; 9 | } 10 | -------------------------------------------------------------------------------- /src/app/keyboard/page.tsx: -------------------------------------------------------------------------------- 1 | import { KeyboardAccessibleDialog } from "@/components/keyboard/KeyboardAccessibleDialog"; 2 | 3 | export default function KeyboardExamplePage() { 4 | return ( 5 |
6 |

Keyboard navigation test cases

7 | Back to main 8 |
9 |

What to test here

10 | 31 |
32 |
33 |

34 | Keyboard Accessible Dialog 35 |

36 | 37 |
38 |
39 |

40 | Tab Order is off here 41 |

42 |
43 | 44 | 45 | 46 |
47 |
48 |
49 | ); 50 | } 51 | -------------------------------------------------------------------------------- /src/app/layout.tsx: -------------------------------------------------------------------------------- 1 | import type { Metadata } from "next"; 2 | import "./globals.css"; 3 | 4 | export const metadata: Metadata = { 5 | title: "Automated Accessibility Testing", 6 | description: "", 7 | }; 8 | 9 | export default function RootLayout({ 10 | children, 11 | }: Readonly<{ 12 | children: React.ReactNode; 13 | }>) { 14 | return ( 15 | 16 | {children} 17 | 18 | ); 19 | } 20 | -------------------------------------------------------------------------------- /src/app/page.tsx: -------------------------------------------------------------------------------- 1 | export default function Home() { 2 | return ( 3 |
4 |

Test pages

5 | 22 |
23 | ); 24 | } 25 | -------------------------------------------------------------------------------- /src/app/reflow/page.tsx: -------------------------------------------------------------------------------- 1 | export default async function Reflow() { 2 | return ( 3 |
4 |

Reflow test cases

5 | Back to main 6 |
7 |

What to test here

8 |

9 | When setting the viewport to the size of 320x256 px, can everything in 10 | the page still be reached and operated without the need for horizontal 11 | scrolling? 12 |

13 |

14 | See{" "} 15 | 16 | WCAG 1.4.10 17 | 18 |

19 |
20 |
21 | 24 |
25 | 31 | 34 |
35 |
36 | 37 |
38 |

39 | Menu should be accessible without horizontal scrolling 40 |

41 | 48 |
49 |
50 | ); 51 | } 52 | -------------------------------------------------------------------------------- /src/app/spacing/page.tsx: -------------------------------------------------------------------------------- 1 | export default async function Spacing() { 2 | return ( 3 |
4 |

Text spacing test cases

5 | Back to main 6 |
7 |

What to test here

8 |

9 | When changing the text spacing, does the spacing increase accordingly 10 | and can everything in the page still be seen, reached and operated? 11 |

12 |

The spacing should be changed to the following:

13 |
    14 |
  • 15 | Line height (line spacing) to at least 1.5 times the font size; 16 |
    • 17 |
  • 18 | Spacing following paragraphs to at least 2 times the font size 19 |
    • 20 |
  • 21 | Letter spacing (tracking) to at least 0.12 times the font size; 22 |
    • 23 |
  • Word spacing to at least 0.16 times the font size.
    • 24 |
25 |

26 | See{" "} 27 | 28 | WCAG 1.4.12 29 | 30 |

31 |
32 |
33 |

Overlapping text at bigger text spacing

34 |
35 | CSS is very awesome 36 |
37 |
38 |
39 | ); 40 | } 41 | -------------------------------------------------------------------------------- /src/app/textsize/page.tsx: -------------------------------------------------------------------------------- 1 | export default async function TextSize() { 2 | return ( 3 |
4 |

Fontsize test cases

5 | Back to main 6 |
7 |

What to test here

8 |

9 | When setting the text size to 200% (32px), does the text size 10 | increase, and can everything in the page still be seen, reached and 11 | operated? 12 |

13 |

14 | See{" "} 15 | 16 | WCAG 1.4.4 17 | 18 |

19 |
20 |
21 |

Overlapping text at 200% text size

22 |
23 | CSS is awesome 24 |
25 |
26 |
27 |

Clipped text at 200% text size

28 |
29 | CSS is still awesome 30 |
31 |
32 |
33 | ); 34 | } 35 | -------------------------------------------------------------------------------- /src/components/BadExampleForAButton.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | //This is a bad example to demonstrate the capabilities of automated tools 4 | //Don't do this! Use the HTML button element instead. 5 | export const BadExampleForAButton = ({ label }: { label: string }) => { 6 | const submitCallback = () => { 7 | alert("Submitted"); 8 | }; 9 | return ( 10 |
submitCallback()} 12 | className={ 13 | "border-1 cursor-pointer border border-gray-500 bg-gray-300 p-4 text-center text-gray-700 hover:bg-gray-200" 14 | } 15 | > 16 | {label} 17 |
18 | ); 19 | }; 20 | -------------------------------------------------------------------------------- /src/components/BadExampleForALinkButton.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | //This is a bad example to demonstrate the capabilities of automated tools 4 | //Don't do this! Links need an href to work. If you need an onclick javascript action, 5 | //use an HTML button element instead. 6 | export const BadExampleForALinkButton = ({ label }: { label: string }) => { 7 | const clickCallback = () => { 8 | alert("Clicked"); 9 | }; 10 | return ( 11 | clickCallback()} 13 | className={ 14 | "border-1 cursor-pointer border border-gray-500 bg-gray-300 p-4 text-center text-gray-700 hover:bg-gray-200" 15 | } 16 | > 17 | {label} 18 | 19 | ); 20 | }; 21 | -------------------------------------------------------------------------------- /src/components/keyboard/KeyboardAccessibleDialog.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | import { useEffect, useState } from "react"; 4 | 5 | // Attention: This is not a general example of an accessible dialog! 6 | // It is fit for demonstration purposes only. 7 | // Refer to https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/ for a proper implementation 8 | export const KeyboardAccessibleDialog = () => { 9 | const [firstMount, setFirstMount] = useState(true); 10 | const [dialogOpen, setDialogOpen] = useState(false); 11 | 12 | useEffect(() => { 13 | if (firstMount) { 14 | setFirstMount(false); 15 | return; 16 | } 17 | if (dialogOpen) { 18 | document.getElementById("btn-close")?.focus(); 19 | } else { 20 | document.getElementById("btn-dialog")?.focus(); 21 | } 22 | }, [dialogOpen]); 23 | 24 | const openDialog = () => { 25 | setDialogOpen(true); 26 | return false; 27 | }; 28 | 29 | const handleKeyDown = (event: KeyboardEvent) => { 30 | if (event.key === "Escape") { 31 | //make it possible to close the modal with the escape key 32 | setDialogOpen(false); 33 | event.stopPropagation(); 34 | event.preventDefault(); 35 | } else if (event.key === "Tab") { 36 | //make sure the focus stays in the menu on pressing tab 37 | //implementation works with the assumption that there are the three buttons close, ok, cancel in the dialog 38 | 39 | const targetId = (event.target as HTMLButtonElement).id; 40 | const movingBackwards = event.shiftKey; 41 | if (targetId === "btn-cancel" && !movingBackwards) { 42 | document.getElementById("btn-close")?.focus(); 43 | event.stopPropagation(); 44 | event.preventDefault(); 45 | } else if (targetId === "btn-close" && movingBackwards) { 46 | document.getElementById("btn-cancel")?.focus(); 47 | event.stopPropagation(); 48 | event.preventDefault(); 49 | } 50 | } 51 | }; 52 | 53 | return ( 54 |
55 | 62 | {dialogOpen && ( 63 |
64 |
65 |
handleKeyDown(e as unknown as KeyboardEvent)} 71 | > 72 |
73 |

74 | Information 75 |

76 | 83 |
84 |
85 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed 86 | diam nonumy eirmod tempor invidunt ut labore et dolore magna 87 | aliquyam erat, sed diam voluptua. 88 |
89 |
90 | 97 | 104 |
105 |
106 |
107 |
108 | )} 109 |
110 | ); 111 | }; 112 | -------------------------------------------------------------------------------- /src/test/KeyboardAccessibleDialog.test.tsx: -------------------------------------------------------------------------------- 1 | import { render, screen } from "@testing-library/react"; 2 | import userEvent from "@testing-library/user-event"; 3 | import "@testing-library/jest-dom"; 4 | import { expect, test } from "vitest"; 5 | import { KeyboardAccessibleDialog } from "@/components/keyboard/KeyboardAccessibleDialog"; 6 | 7 | //Examples for keyboard testing with vitest & testing library 8 | //Prerequisite is the library "@testing-library/user-event" 9 | //It should be noted that keyboard navigation tests on unit test level are possible, 10 | //but since they run on a headless browser, there might be bugs or unimplemented 11 | //features that prevent a successful test. See also line 25. 12 | 13 | test("should be able to focus the menu button", async () => { 14 | const user = userEvent.setup(); 15 | render(); 16 | await user.tab(); 17 | 18 | //We need to first select the element we expect to have focussed, 19 | //and then assert that it is focussed. 20 | const menuButton = await screen.findByRole("button", { 21 | name: "More information", 22 | }); 23 | expect(menuButton).toHaveFocus(); 24 | 25 | //Alternative, but unfortunately doesn't work with focus-visible due to: https://github.com/dperini/nwsapi/issues/115 26 | expect(menuButton.matches(":focus")).toBe(true); 27 | 28 | await user.keyboard("[Enter]"); 29 | }); 30 | 31 | test("should have proper focus handling for dialog", async () => { 32 | const user = userEvent.setup(); 33 | render(); 34 | 35 | const menuButton = await screen.findByRole("button", { 36 | name: "More information", 37 | }); 38 | menuButton.focus(); 39 | 40 | await user.keyboard("[Enter]"); 41 | 42 | const closeButton = await screen.findByRole("button", { 43 | name: "Close Dialog", 44 | }); 45 | const okButton = await screen.findByRole("button", { name: "OK" }); 46 | const cancelButton = await screen.findByRole("button", { name: "Cancel" }); 47 | 48 | expect(closeButton).toHaveFocus(); 49 | 50 | await user.tab(); 51 | expect(okButton).toHaveFocus(); 52 | 53 | await user.tab(); 54 | expect(cancelButton).toHaveFocus(); 55 | 56 | await user.tab(); 57 | expect(closeButton).toHaveFocus(); 58 | 59 | await user.keyboard("{Shift>}{Tab}{/Shift}"); 60 | expect(cancelButton).toHaveFocus(); 61 | 62 | await user.keyboard("[Enter]"); 63 | 64 | expect(menuButton).toHaveFocus(); 65 | }); 66 | -------------------------------------------------------------------------------- /src/test/automatedTool.test.tsx: -------------------------------------------------------------------------------- 1 | import { render } from "@testing-library/react"; 2 | import "@testing-library/jest-dom"; 3 | import { expect, test } from "vitest"; 4 | import { axe, toHaveNoViolations } from "jest-axe"; 5 | import BugExamplePage from "../app/bugpit/page"; 6 | expect.extend(toHaveNoViolations); 7 | 8 | //Demonstrate the usage of the automated testing tool axe 9 | 10 | test("should not have a11y violations", async () => { 11 | const { container } = render(); 12 | const results = await axe(container); 13 | expect(results).toHaveNoViolations(); 14 | }); 15 | -------------------------------------------------------------------------------- /src/test/semantics.test.tsx: -------------------------------------------------------------------------------- 1 | import { render, screen } from "@testing-library/react"; 2 | import "@testing-library/jest-dom"; 3 | import { expect, test } from "vitest"; 4 | import KeyboardExamplePage from "../app/keyboard/page"; 5 | 6 | //Demonstrate asserting semantics with testing library selectors 7 | 8 | test("should have appropriate heading", async () => { 9 | render(); 10 | expect(await screen.findByRole("heading", { level: 1 })).toHaveTextContent( 11 | "Keyboard navigation test cases", 12 | ); 13 | }); 14 | 15 | test("should have a button for the more information popup", async () => { 16 | render(); 17 | const button = (await screen.findAllByRole("button"))[0]; 18 | expect(button).toHaveAccessibleName("More information"); 19 | }); 20 | 21 | test("alternative: should have a button for the more information popup", async () => { 22 | render(); 23 | await screen.findByRole("button", { 24 | name: "More information", 25 | }); 26 | }); 27 | -------------------------------------------------------------------------------- /tailwind.config.ts: -------------------------------------------------------------------------------- 1 | import type { Config } from "tailwindcss"; 2 | 3 | const config: Config = { 4 | content: [ 5 | "./src/pages/**/*.{js,ts,jsx,tsx,mdx}", 6 | "./src/components/**/*.{js,ts,jsx,tsx,mdx}", 7 | "./src/app/**/*.{js,ts,jsx,tsx,mdx}", 8 | ], 9 | corePlugins: { 10 | preflight: false, 11 | }, 12 | plugins: [], 13 | }; 14 | export default config; 15 | -------------------------------------------------------------------------------- /test-setup.js: -------------------------------------------------------------------------------- 1 | import { afterEach } from "vitest"; 2 | import { cleanup } from "@testing-library/react"; 3 | import "@testing-library/jest-dom"; 4 | 5 | // runs a cleanup after each test case (e.g. clearing jsdom) 6 | afterEach(() => { 7 | cleanup(); 8 | }); 9 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "types": ["vitest/importMeta", "node", "jest", "@testing-library/jest-dom"], 4 | "target": "es5", 5 | "lib": ["dom", "dom.iterable", "esnext"], 6 | "allowJs": true, 7 | "skipLibCheck": true, 8 | "strict": true, 9 | "forceConsistentCasingInFileNames": true, 10 | "noEmit": true, 11 | "esModuleInterop": true, 12 | "module": "esnext", 13 | "moduleResolution": "node", 14 | "resolveJsonModule": true, 15 | "isolatedModules": true, 16 | "jsx": "preserve", 17 | "incremental": true, 18 | "plugins": [ 19 | { 20 | "name": "next" 21 | } 22 | ], 23 | "baseUrl": ".", 24 | "paths": { 25 | "@/*": ["./src/*"] 26 | } 27 | }, 28 | "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"], 29 | "exclude": ["node_modules"] 30 | } 31 | -------------------------------------------------------------------------------- /vite.config.js: -------------------------------------------------------------------------------- 1 | import { defineConfig } from "vite"; 2 | import react from "@vitejs/plugin-react"; 3 | import path from "path"; 4 | 5 | // https://vitejs.dev/config/ 6 | export default defineConfig({ 7 | plugins: [react()], 8 | paths: { 9 | "src/*": ["./src/*"], 10 | }, 11 | resolve: { 12 | alias: [{ find: "@", replacement: path.resolve(__dirname, "src") }], 13 | }, 14 | test: { 15 | globals: true, 16 | environment: "jsdom", 17 | setupFiles: "./test-setup.js", 18 | exclude: ["**/node_modules/**", "**/e2e/**", "**/"], 19 | }, 20 | }); 21 | --------------------------------------------------------------------------------