Navigation Steps
Beginners: start with Quick Start or Running Tests if you need the operational context first. This page is the exact navigation-step reference.
Source: src/tests/steps/actions/navigation.step.ts.
See shared placeholder rules in Step Parameter Conventions.
Prefer installing published steps with npx appraisejs@latest add step ...
instead of adding the package to your project with npm install.
Use this when
Section titled “Use this when”Use navigation steps when the scenario must move to a URL, use the selected environment base URL, reload, or move backward in browser history.
Step catalog
Section titled “Step catalog”1. Navigate to URL
Section titled “1. Navigate to URL”Signature
Section titled “Signature”the user navigates to the {string} url
Install with CLI
Section titled “Install with CLI”npx appraisejs@latest add step navigation/navigate-to-urlWhat it does
Section titled “What it does”- Navigates directly to provided URL.
- Waits for
domcontentloaded.
Parameters
Section titled “Parameters”| Parameter | Represents | Expected data |
|---|---|---|
{string} | Destination URL | Absolute URL (for example https://example.com/login). |
Example
Section titled “Example”When the user navigates to the "https://example.com/login" url2. Navigate to selected environment base URL
Section titled “2. Navigate to selected environment base URL”Signature
Section titled “Signature”the user navigates to the base url of the selected environment
Install with CLI
Section titled “Install with CLI”npx appraisejs@latest add step navigation/navigate-to-environment-base-urlWhat it does
Section titled “What it does”- Reads
ENVIRONMENTruntime value. - Resolves environment config.
- Navigates to configured
baseUrl.
Parameters
Section titled “Parameters”- None.
Example
Section titled “Example”When the user navigates to the base url of the selected environment3. Reload page
Section titled “3. Reload page”Signature
Section titled “Signature”the user reloads the page
Install with CLI
Section titled “Install with CLI”npx appraisejs@latest add step navigation/reloadWhat it does
Section titled “What it does”- Reloads current page.
- Waits for
domcontentloaded.
Parameters
Section titled “Parameters”- None.
Example
Section titled “Example”When the user reloads the page4. Go back to previous page
Section titled “4. Go back to previous page”Signature
Section titled “Signature”the user goes back to the previous page
Install with CLI
Section titled “Install with CLI”npx appraisejs@latest add step navigation/go-backWhat it does
Section titled “What it does”- Executes browser back navigation.
- Waits for
domcontentloaded.
Parameters
Section titled “Parameters”- None.
Example
Section titled “Example”When the user goes back to the previous pageCommon failures
Section titled “Common failures”- Environment-based step fails if environment is unset or unknown.
- Navigation errors bubble up from Playwright as step failures.