https://github.com/sjmc11/tourguide-js

TourGuide is a Javascript library for creating user tours and on-boarding steps for your apps.
https://github.com/sjmc11/tourguide-js

onboarding tour tourguide ui user-experience user-onboarding walkthrough

Last synced: about 1 month ago
JSON representation

TourGuide is a Javascript library for creating user tours and on-boarding steps for your apps.

• Host: GitHub
• URL: https://github.com/sjmc11/tourguide-js
• Owner: sjmc11
• License: mit
• Created: 2022-11-11T15:56:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-30T19:59:14.000Z (3 months ago)
• Last Synced: 2024-08-30T20:55:46.366Z (3 months ago)
• Topics: onboarding, tour, tourguide, ui, user-experience, user-onboarding, walkthrough
• Language: TypeScript
• Homepage: https://tourguidejs.com
• Size: 345 KB
• Stars: 585
• Watchers: 5
• Forks: 25
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - sjmc11/tourguide-js - TourGuide is a Javascript library for creating user tours and on-boarding steps for your apps. (TypeScript)

README

        






TourGuide JS



Intuitive and customisable tours for user application onboarding




Explore the docs »



----







## QuickStart

### Installation

```

npm i @sjmc11/tourguidejs

```

### Usage

Include the tourGuide script and style in your project. A CDN method is supported.

```

// Style

import "@sjmc11/tourguidejs/src/scss/tour.scss"

// JS

import {TourGuideClient} from "@sjmc11/tourguidejs/src/Tour"

```

### Declare steps

Add the [data-tg-tour] attribute to elements that you want to include in your tour. This attribute should contain the relevant text for the tour guide step.

```