Skip to content

Add viewport support to prompt #6312

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
Oct 29, 2025
+54 −26
Merged

Add viewport support to prompt #6312

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e86fe7
document viewport support
jennifer-shehane Oct 27, 2025
66cdc66
lint
jennifer-shehane Oct 27, 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
80 changes: 54 additions & 26 deletions docs/api/commands/prompt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,12 @@ If Cypress cannot interpret a step, you'll see a dialog prompting you to refine
'confirm that the code frame includes HTML "<span class="token">'
```

### Change the viewport

```javascript
'set the viewport to 400x600'
```

### Wait

```javascript
Expand Down Expand Up @@ -671,49 +677,71 @@ cy.origin('https://cloud.cypress.io/login', () => {
### Mixed with traditional Cypress

```javascript
const electronicsCount = 25
const electronicsCount = Cypress.env('staging') === true ? 5 : 25

// Confirm the UI works in desktop view
cy.viewport(1024, 768)
// Confirm the UI works in staging environment
cy.task('seedStagingDB')
cy.visit(`${Cypress.env('stagingUrl')}/products`)
cy.prompt([
'filter by category "Electronics"',
'sort by price high to low',
`verify the product count is ${electronicsCount}`,
'verify the sort indicator is "Price: High to Low"',
])
cy.prompt(
[
'filter by category "Electronics"',
'sort by price high to low',
`verify the product count is {{electronicsCount}}`,
'verify the sort indicator is "Price: High to Low"',
],
{
placeholders: {
electronicsCount,
},
}
)

// Confirm the UI works in mobile view
cy.viewport(400, 600)
cy.visit(`${Cypress.env('stagingUrl')}/products`)
cy.prompt([
'filter by category "Electronics"',
'sort by price high to low',
`verify the product count is ${electronicsCount}`,
'verify the sort indicator is "Price: High to Low"',
])
// Confirm the UI works in production environment
cy.task('seedProductionDB')
cy.visit(`${Cypress.env('productionUrl')}/products`)
cy.prompt(
[
'filter by category "Electronics"',
'sort by price high to low',
`verify the product count is {{electronicsCount}}`,
'verify the sort indicator is "Price: High to Low"',
],
{
placeholders: {
electronicsCount,
},
}
)
```

Or to further clean up the `cy.prompt` call:

```javascript
const electronicsCount = 25
const electronicsCount = Cypress.env('staging') === true ? 5 : 25
const electronicsFilterPrompt = [
'filter by category "Electronics"',
'sort by price high to low',
`verify the product count is ${electronicsCount}`,
`verify the product count is {{electronicsCount}}`,
'verify the sort indicator is "Price: High to Low"',
]

// Confirm the UI works in desktop view
cy.viewport(1024, 768)
// Confirm the UI works in staging environment
cy.task('seedStagingDB')
cy.visit(`${Cypress.env('stagingUrl')}/products`)
cy.prompt(electronicsFilterPrompt)
cy.prompt(electronicsFilterPrompt, {
placeholders: {
electronicsCount,
},
})

// Confirm the UI works in mobile view
cy.viewport(400, 600)
// Confirm the UI works in production environment
cy.task('seedProductionDB')
cy.visit(`${Cypress.env('stagingUrl')}/products`)
cy.prompt(electronicsFilterPrompt)
cy.prompt(electronicsFilterPrompt, {
placeholders: {
electronicsCount,
},
})
```

## Limitations
Expand Down