Package Exports
- cypress-plugin-guided-tour
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cypress-plugin-guided-tour) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Cypress guided tour plugin
A simple plugin to add guided tour functionality to cypress steps
Motivation
You use Cypress to write your tests, why not use them as documentation and tutorials?
Installation
Add the plugin to devDependencies
npm install -D cypress-plugin-guided-tourAt the top of cypress/support/index.js:
require('cypress-plugin-guided-tour')Usage
.guide(text, delay = 0)can be chainned from any DSL, if chainned from an element, a rectangle will surround that element.
cy.get('input').guide('Type something here'); // delay is calculated based on number of words
cy.get('input', 200).guide('Type something here'); // Adds 200 ms delay- Run your tests with the environment property
guidedMode=true:
$ npx cypress run --env guidedMode=trueAdditional configuration
Styles can be configured via the following cypress environment properties:
| Name | Description |
|---|---|
| titleStyle | The style to be applied for the guiding message |
| surroundingStyle | The style to be applied when an element is highlighted |