Skip to main content

Configuration

tip

UI Coverage is a paid add-on. Schedule a demo today and see how easy it is to enhance your testing while speeding up your development process.

Configuration allows you to customize and fine-tune UI Coverage in Cypress to suit specific needs and scenarios. While UI Coverage is designed to work seamlessly out of the box, there are instances where custom configuration may be necessary to address unique application structures, testing requirements, or edge cases. This section guides you through setting configuration to enhance the functionality and accuracy of UI Coverage.

Note: By default, setting configuration is limited to Admin users. At your request, this can be changed to allow setting config by all users. Reach out to your Cypress point-of-contact if you would like to change this.

Setting Configuration​

To add or modify the configuration for your project, navigate to the "App Quality" tab in your project settings.

The Cypress Cloud UI showing the configuration editor

You can use the provided editor to write configuration in JSON format. A complete configuration with all available options looks as follows:

{
  "elementFilters": [
    {
      "selector": string,
      "include": boolean
    }
  ],
  "views": [
    {
      "pattern": string,
      "groupBy": [
        string
      ]
    }
  ],
  "viewFilters": [
    {
      "pattern": string,
      "include": boolean
    }
  ],
  "uiCoverage": {
    "attributeFilters": [
      {
        "attribute": string,
        "value": string,
        "include": boolean
      }
    ],
    "elementGroups": [
      {
        "selector": string,
        "name": string
      }
    ],
    "significantAttributes": [
      string
    ]
  }
}

Note that the root-level App Quality configuration properties (elementFilters, views, and viewFilters) impact both UI Coverage and Accessibility.

Viewing Configuration for a Run​

You can view configuration information for each run in the Properties tab, as shown below. This is the configuration set for the project at the start of the run.

The properties tab for a run, with an Application Quality section at the bottom

Contents