You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cypress-accessibility-checker/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ If you do not want to include `cypress-accessibility-checker` globally, you may
65
65
66
66
## Usage
67
67
68
-
The commands map directly to the description of the APIs located [in the accessibility-checker/src/README](https://github.com/IBMa/equal-access/blob/master/accessibility-checker/src/README.md). The names of the APIs within Cypress are just slightly different so they are globally unique in the Cypress namespace.
68
+
The commands map directly to the description of the APIs located in the [accessibility-checker/src/README](https://github.com/IBMa/equal-access/blob/master/accessibility-checker/src/README.md). The names of the APIs within Cypress are just slightly different so they are globally unique in the Cypress namespace.
69
69
70
70
The typical use case will be to get the accessibility compliance of a document and then assert the accessibility compliance against the configuration that is defined as part of the `.achecker.yml` file and any baselines that are defined. An example of how this looks is below:
71
71
@@ -75,7 +75,7 @@ The typical use case will be to get the accessibility compliance of a document a
75
75
cy.getCompliance('my scan').assertCompliance()
76
76
```
77
77
78
-
Examples of how to use each of the APIs below can be found in the `achecker.js` test file [located here](https://github.com/IBMa/equal-access/blob/master/cypress-accessibility-checker/test/cypress/integration/achecker.js).
78
+
Examples of how to use each of the APIs below can be found in the `achecker.js` test file [located here](https://github.com/IBMa/equal-access/blob/master/cypress-accessibility-checker/test/cypress/e2e/achecker.cy.js).
79
79
80
80
-`cy.getCompliance(label)`
81
81
- Similar to `getCompliance()` in the reference API above.
@@ -97,7 +97,7 @@ Chain the commands similar to other Cypress commands. For example, `cy.getCompli
97
97
98
98
Baselines are a helpful feature of `accessibility-checker` that can also be used in this Cypress wrapper. The concept involves capturing a scan result as a 'baseline' so that future scans will pass if they match the baseline. If they differ, then the test will fail. This feature is useful for things like false positives or issues you plan on not fixing.
99
99
100
-
The baseline feature is documented and implemented as part of `accessibility-checker`. Please see the [accessibility-checker/src/README](src/README.md) for details.
100
+
The baseline feature is documented and implemented as part of `accessibility-checker`. Please see the [accessibility-checker/src/README](https://github.com/IBMa/equal-access/blob/master/accessibility-checker/src/README.md) for details.
0 commit comments