What is react-joyride CLAUDE.md?

A project guide for React Joyride, a React library that adds step-by-step tours and onboarding tips to websites. It documents the codebase, commands, architecture, and main components.

Use it when changing React Joyride, running its checks, understanding its state management, or working on its website and end-to-end tests.

It gives coding agents the project-specific context needed to work consistently without repeatedly discovering how the repository is organized or tested.

How gilbarbara/react-joyride configures Claude Code

About the project

React Joyride is a React component library for adding guided tours, tooltips, and feature walkthroughs to web applications. Developers use it to introduce new users to an app or explain newly added functionality. Its catalogue add-on helps coding agents implement tours with the library's API and patterns.

gilbarbara/react-joyride · 7,891 stars · on GitHub · react-joyride.com

Reuse

Borrowing it

Nothing to install: this file belongs to gilbarbara/react-joyride. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/gilbarbara/react-joyride/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/gilbarbara/react-joyride

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/gilbarbara/react-joyride/claude-md/github.svg)](https://agentmods.dev/instructions/gilbarbara/react-joyride/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/gilbarbara/react-joyride/claude-md"><img src="https://agentmods.dev/badge/instructions/gilbarbara/react-joyride/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/gilbarbara/react-joyride/claude-md"><img src="https://agentmods.dev/badge/instructions/gilbarbara/react-joyride/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,893 This file is loaded in full into every session.

When invoked 1,893 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.01893	$0.01893
Opus 5.5	$0.00757	$0.00757
Sonnet 5.5	$0.00379	$0.00379
Haiku 4.5	$0.00189	$0.00189

Measured 2mo ago against content hash 806ed12ab2db, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

react-joyride CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 133 lines

How it starts

The opening of the file, as written. The whole thing — 133 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

Overview

React Joyride is a React library for creating guided tours (tooltips, walkthroughs, onboarding). Supports React 16.8-19 and SSR.

For deep architecture details, see docs/architecture.md.

Commands

Package manager: pnpm

pnpm lint              # ESLint with --fix on src/, test/, and e2e/
pnpm typecheck         # tsc using test/tsconfig.json
pnpm test              # Vitest (run once)
pnpm test:coverage     # With coverage
pnpm test:watch        # Watch mode
pnpm e2e               # Playwright (chromium, firefox, webkit)
pnpm e2e:chromium      # Chromium only
pnpm website           # Website at localhost:3000
pnpm website:build     # Build website for production
pnpm website:start     # Serve built website locally
pnpm website:serve     # Build + start website
pnpm build             # tsdown
pnpm check             # lint → typecheck → test:coverage
pnpm validate          # check → build → size → typevalidation

Single test: pnpm test modules/store | Single e2e: pnpm e2e:chromium standard

How It Works

Singleton Store class (ref-based) manages frozen state snapshots. React subscribes via useSyncExternalStore.

Two public APIs: <Joyride> component and useJoyride() hook (returns { controls, failures, on, state, step, Tour }).

State machine has two dimensions: tour Status (idle → ready → waiting → running ↔ paused → finished/skipped) and step Lifecycle (init → ready → beacon_before → beacon → tooltip_before → tooltip → complete). See architecture.md for full details.

Event system: Single onEvent(data, controls) callback receives discriminated events and tour controls: tour:start, step:before_hook, step:before, scroll:start, scroll:end, beacon, tooltip, step:after, step:after_hook, tour:end, tour:status, error:target_not_found, error.

Controlled (with stepIndex prop): Tour pauses at COMPLETE; parent manages index via onEvent. Uncontrolled: Store manages index internally; supports initialStepIndex.

Read the full file on GitHub · 133 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 133 lines · 1,893 tokens per session scan A 806ed12ab2db

Subscribe to this mod's changes

react-joyride CLAUDE.md is an instructions file published in the GitHub repository gilbarbara/react-joyride (7,891 stars, last pushed 4mo ago), licensed MIT. It adds 1,893 tokens to every session, about $0.0076 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

joyride react-component tooltip tour

react-joyride CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
react-joyride CLAUDE.mdgilbarbara/react-joyride	Instructions file	7.9k	4mo ago	MIT	A	1,893	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

react-joyride: Instructions file for Claude Code