Skip to content

Commit

Permalink
docs: Update links and comments for realSwipe function (#630)
Browse files Browse the repository at this point in the history
Co-authored-by: Rahul Raj <[email protected]>
  • Loading branch information
RahulRaj97 and Rahul Raj authored Feb 16, 2024
1 parent a5ec233 commit 7ba7806
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,12 @@ declare namespace Cypress {
>;
/**
* Fires native touch swipe event. Actually fires sequence of native events: touchStart -> touchMove[] -> touchEnd
* @see https://github.com/dmtrKovalenko/cypress-real-events#cyrealhover
* @see https://github.com/dmtrKovalenko/cypress-real-events#cyrealswipe
* @example
* cy.get("swipeableRoot").realSwipe("toLeft") // or toRight, toTop, toBottom
* cy.get("swipeableRoot").realSwipe("toBottom", { length: 100, step: 10 })
* @param options hover options
* @param direction the direction to swipe (toLeft, toRight, toTop, toBottom)
* @param options swipe options, including touchPosition or specific x and y coordinates, length, and step
*/
realSwipe: NormalizeCypressCommand<
typeof import("./commands/realSwipe").realSwipe
Expand Down

0 comments on commit 7ba7806

Please sign in to comment.