Skip to content

docs: Update notes for views/viewFilters config #6084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2025
Merged

docs: Update notes for views/viewFilters config #6084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5507576
Update _viewfilters.mdx
tbiethman Jan 22, 2025
0c46a5b
Update _views.mdx
tbiethman Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/partials/_viewfilters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ By default, every URL visited within a test run is included in reports. However,
## Why use view filters?

:::info
Note: setting `viewFilters` impacts both Accessibility and UI Coverage reports.
This cannot be nested.
**Note:** setting `viewFilters` impacts both Accessibility and UI Coverage reports.
Nesting this property under an `accessibility` or `uiCoverage` key is
supported, if you need to split them up.
:::

- **Exclude Third-Party URLs**: If your application integrates with third-party services, you might want to exclude their URLs from analysis.
Expand Down
5 changes: 2 additions & 3 deletions docs/partials/_views.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ The `groupBy` property of a view definition allows you to create multiple views
## Why use views?

:::info
**Note:** setting `views` impacts both Accessibility and UI Coverage reports.
Nesting this property under an `accessibility` or `uiCoverage` key is
supported, if you need to split them up.
**Note**: setting `views` impacts both Accessibility and UI Coverage reports.
This cannot be nested.
:::

- **Group Dynamic URLs**: Group URLs with dynamic path parameters (e.g., `/users/alice` and `/users/bob`) that are not ids or uuids into a single view.
Expand Down
Loading