Hover Steps
Beginners: start with Locators if you still need the UI-element workflow first. This page is the exact hover-step reference.
Source: src/tests/steps/actions/hover.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 hover when the UI reveals state only after pointer movement, such as menus, tooltips, or nested controls.
Step catalog
Section titled “Step catalog”Hover over element
Section titled “Hover over element”Signature
Section titled “Signature”the user hovers the cursor over the {string} element
Install with CLI
Section titled “Install with CLI”npx appraisejs@latest add step hover/hoverWhat it does
Section titled “What it does”- Resolves locator by name.
- Runs Playwright
hover()on the target element.
Parameters
Section titled “Parameters”| Parameter | Represents | Expected data |
|---|---|---|
{string} | Target locator name | Existing locator key (for example menuTrigger). |
Example
Section titled “Example”When the user hovers the cursor over the "menuTrigger" elementCommon failures
Section titled “Common failures”- Step fails if locator is missing.
- Step fails if hover action cannot be completed.