cypress-real-events/commands/realHover.d.ts

Real native events for cypress. Dispatched via CDP.

import { Position, ScrollBehaviorOptions } from "../getCypressElementCoordinates";
export interface RealHoverOptions {
    /**
     * If set to `pen`, simulates touch based hover (via long press)
     */
    pointer?: "mouse" | "pen";
    /**
     * Position relative to the element where to hover the element.
     * @example cy.realHover({ position: "topLeft" })
     */
    position?: Position;
    /**
     * Controls how the page is scrolled to bring the subject into view, if needed.
     * @example cy.realHover({ scrollBehavior: "top" });
     */
    scrollBehavior?: ScrollBehaviorOptions;
    /**
     * Indicates whether any modifier (shiftKey | altKey | ctrlKey | metaKey) was pressed or not when an event occurred
     * @example cy.realMouseDown({ shiftKey: true });
     */
    shiftKey?: boolean;
    altKey?: boolean;
    ctrlKey?: boolean;
    metaKey?: boolean;
}
/** @ignore this, update documentation for this function at index.d.ts */
export declare function realHover(subject: JQuery, options?: RealHoverOptions): Promise<JQuery<HTMLElement>>;