Skip to content

docs: Update shadow query command to correct command signature #6107

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 3 commits into from
Feb 21, 2025
Merged

docs: Update shadow query command to correct command signature #6107

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c522508
docs: Update shadow query command to correct command signature
jennifer-shehane Feb 21, 2025
7bb1545
add options that are supported
jennifer-shehane Feb 21, 2025
c405584
lint
jennifer-shehane Feb 21, 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
15 changes: 13 additions & 2 deletions docs/api/commands/shadow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Traverse into the shadow DOM of an element.
## Syntax

```javascript
.shadow(selector)
.shadow(selector, options)
.shadow()
.shadow(options)
```

### Usage
Expand All @@ -34,6 +34,17 @@ cy.exec('npm start').shadow() // Errors, 'exec' does not yield DOM element
cy.get('.not-a-shadow-host').shadow() // Errors, subject must host a shadow root
```

### Arguments

<Icon name="angle-right" /> **options _(Object)_**

Pass in an options object to change the default behavior of `.shadow()`.

| Option | Default | Description |
| --------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `log` | `true` | Displays the command in the [Command log](/app/core-concepts/open-mode#Command-Log) |
| `timeout` | [`defaultCommandTimeout`](/app/references/configuration#Timeouts) | Time to wait for `cy.get()` to resolve before [timing out](#Timeouts) |

<HeaderYields />

- `.shadow()` yields the new DOM element(s) it found.
Expand Down