Overview

Introduction

Welcome to the documentation for cursor.js. Here you will find the API reference and usage examples.

Why cursor.js?

Traditional product tour libraries (like react-joyride or intro.js) get the job done, but let's face it—they can be static, rigid, and frankly, a bit boring. In the era of AI and intelligent systems, users expect dynamic, fluid, and human-like guidance.

cursor.js is built from the ground up for the AI world. It provides a highly programmable, visual cursor that natively interacts with the DOM just like a real user would.

Use Cases:

• AI Agent Visualization: Show users exactly what your AI agents or copilots are doing on the screen in real-time.
• Next-Gen Product Tours: Replace boring tooltips with an automated "ghost user" that gives an interactive, lifelike walkthrough of your app.
• Automated Demos: Programmatically demonstrate complex workflows in a way that feels organic and engaging.

Quick Start

Here is a simple example to get you started:

import { Cursor } from '@cursor.js/core';

const cursor = new Cursor();

cursor
  .hover('.submit-action')
  .click('.submit-action')
  .wait(1000)
  .type('#search-box', 'Hello world!', { delay: 50 });