@avilabs/ghost-cursor-playwright/README.md

Move your mouse like a human in playwright or generate realistic movements on any 2D plane

# ghost-cursor-playwright

Modification of actual ghost-cursor for puppeteer, with more functionality and rewrite to work well with playwright.
Note! target elements rendered in the DOM will be scrolled vertically and horizontally to be visible in viewport

### Download

```shell
npm i @avilabs/ghost-cursor-playwright
```

### How to import

```typescript
import { createCursor } from 'ghost-cursor-playwright'
or
const { createCursor } = require('ghost-cursor-playwright')
```

### How to use

Create amd attach cursor to page

```typescript
const cursor = await createCursor(page)
```

manipulate the cursor via:

```typescript
cursor.actions.move(target: string | BoundingBox | Vector, moveOptions?: moveOptions): Promise<void>;

type moveOptions = {
	paddingPercentage?: number;
	waitForSelector?: number;
	waitBeforeMove?: [number, number];
};


cursor.actions.click(clickOptions?: clickOptions, moveOptions?: moveOptions): Promise<void>;

type clickOptions = {
	target?: string | BoundingBox | Vector;
	waitBeforeClick?: [number, number];
	waitBetweenClick?: [number, number];
	doubleClick?: boolean;
};
// if target is given then cursor will use move function before click
// if target is JS path string, then function will check if for sure is on correct target (sometimes rendered objects are covered in viewport by menu bar or dialogs etc.), if false will proceed fallback to native click


// Optionally, you may also choose to move cursor randomly
cursor.performRandomMove()

```

util functions

```typescript
// actual position of cursor is mounted on window.mousePos, its value can be retrieve by
  cursor.getActualPosOfMouse(): Promise<Vector>;

// actual target of cursor is mounted on window.mouseTarget, to compare target under cursor with given JS PATH selector use:
  cursor.compareTargetOfMouse(selector: string): Promise<boolean>

// random Vector of element
  cursor.getElemBoundingBox(selector: string): Promise<BoundingBox>
  cursor.getRandomPointInsideElem(elemBoundingBox: BoundingBox, paddingPercentage?): Vector

// random Vector of viewport
  cursor.getRandomPointOnViewport(paddingPercentage?): Promise<Vector>
```