Installation

Install the package

npm

bash npm install guide.js

pnpm

bash pnpm add guide.js

yarn

bash yarn add guide.js

bun

bash bun add guide.js

Import the stylesheet

Guide.js ships a single CSS file. Import it once, anywhere in your app:

import "guide.js/styles.css";

Peer dependencies

Guide.js requires React 18 or newer:

{
  "peerDependencies": {
    "react": ">=18",
    "react-dom": ">=18"
  }
}

Next steps

Head to the quick start to build your first tour.