Jennifer Shehane
2.8 KiB
title, comments, description
| title | comments | description |
|---|---|---|
| go | true |
Navigate back or forward to the previous or next URL in the browser's history.
If going forward or back causes a full page refresh, Cypress will wait for the new page to load before moving on to new commands. Cypress additionally handles situations where a page load was not caused (such as hash routing) and will resolve immediately.
Syntax
.go(direction)
.go(direction, options)
Usage
.go() cannot be chained off any other cy commands, so should be chained off of cy for clarity.
{% fa fa-check-circle green %} Valid Usage
cy.go('back')
Arguments
{% fa fa-angle-right %} direction (String, Number)
The direction to navigate.
You can use back or forward to go one step back or forward. You could also navigate to a specific history position (-1 goes back one page, 1 goes forward one page, etc).
{% fa fa-angle-right %} options (Object)
Pass in an options object to change the default behavior of .go.
| Option | Default | Notes |
|---|---|---|
log |
true |
whether to display command in command log |
timeout |
pageLoadTimeout | Total time to retry the navigation |
| Returns | the window object |
| Timeout | cy.go will retry for the duration of the pageLoadTimeout or the duration of the timeout specified in the command's options. |
Yields
.go() yields the window object.
Timeout
.go() will retry for the duration of the pageLoadTimeout or the duration of the timeout specified in the command's options.
Examples
Back / Forward
Go back in browser's history
cy.go('back') // equivalent to clicking back button
Go forward in browser's history
cy.go('forward') // equivalent to clicking forward button
Number
Go back in browser's history
cy.go(-1) // equivalent to clicking back button
Go forward in browser's history
cy.go(1) // equivalent to clicking forward button
Command Log
Go back in browser's history
cy
.visit('http://localhost:8000/folders')
.go('back')
The commands above will display in the command log as:
When clicking on the get command within the command log, the console outputs the following:
