@zag-js/tour NPM

@zag-js/tour

Core logic for the tour widget implemented as a state machine

Installation

yarn add @zag-js/tour
# or
npm i @zag-js/tour

Contribution

Yes please! See the contributing guidelines for details.

Licence

This project is licensed under the terms of the MIT license.

Docs Examples

Useful for designing guided product tours, feature highlights, contextual help in your application.

https://design.mindsphere.io/patterns/guided-tour.html
https://design.mindsphere.io/patterns/guided-tour.html
https://codepen.io/collection/DyPkzY?cursor=eyJwYWdlIjoxfQ==
Changing the placement of a tour, per step
Exiting the tour on interaction outside
Styling the overlay background
Adding a stroke around around the overlay
Highlighting with no target
Showing tour progress
Removing the overlay
Disabling keyboard navigation
Handling Cross frame elements (iframes)
RTL Support (right to left)
Customizing the accessibility labels
Asynchronous steps using effects
- Lazy-Loading
- Show step after a delay
Celebrating the end of the tour
- End the tour with a celebration
Wait for Navigation and Content to Load
Accessibility
- Keyboard navigation
- Screen reader support
- Focus management
- Live region for content updates

Pro Examples

Customizable Tour Templates
Analytics Integration
Multi-Language Support
Advanced Branching Logic

js machine xstate statechart component chakra-ui tour guide app walkthrough intro

@zag-js/anatomy @zag-js/core @zag-js/dom-query @zag-js/popper @zag-js/dismissable @zag-js/interact-outside @zag-js/utils @zag-js/types @zag-js/focus-trap

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

0.0.0-v1-beta-20250221135618

4 months ago

0.0.0-v1-beta-20250222173217

4 months ago

0.0.0-v1-beta-20250220125322

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

9 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

0.0.0-dev-20240723090825

11 months ago

0.62.0

11 months ago

0.0.0-dev-20240619115122

12 months ago

0.0.0-dev-20240614092224

12 months ago

0.0.0-dev-20240621154058

12 months ago

0.0.0-dev-20240714222614

11 months ago

0.0.0-dev-20240626155314

12 months ago

0.0.0-dev-20240612172509

1 year ago

0.0.0-dev-20240712125036

11 months ago

0.0.0-dev-20240703094721

11 months ago

0.0.0-dev-20240611182543

1 year ago

0.0.0-dev-20240616132821

12 months ago

0.0.0-dev-20240627160556

12 months ago

0.0.0-dev-20240712143332

11 months ago

0.0.0-dev-20240626134742

12 months ago

0.56.1

1 year ago

0.56.0

1 year ago

0.0.0-dev-20240610023609

1 year ago

0.0.0-dev-20240627164007

12 months ago

0.0.0-dev-20240627105448

12 months ago

0.0.0-dev-20240614174340

12 months ago

0.0.0-dev-20240610144328

1 year ago

0.0.0-dev-20240617131842

12 months ago

0.0.0-dev-20240614164654

12 months ago

0.0.0-dev-20240611102459

1 year ago

0.0.0-dev-20240622114650

12 months ago

0.0.0-dev-20240630000246

12 months ago

0.0.0-dev-20240611130830

1 year ago

0.0.0-dev-20240624011811

12 months ago

0.0.0-dev-20240617184452

12 months ago

0.0.0-dev-20240610024234

1 year ago

0.0.0-dev-20240708155322

11 months ago

0.0.0-dev-20240614095902

12 months ago

0.0.0-dev-20240615014318

12 months ago

0.0.0-dev-20240614111542

12 months ago

0.0.0-dev-20240621201816

12 months ago

0.0.0-dev-20240625084734

12 months ago

0.59.0

12 months ago

0.0.0-dev-20240614105434

12 months ago

0.0.0-dev-20240620113708

12 months ago

0.0.0-dev-20240708161145

11 months ago

0.0.0-dev-20240619194623

12 months ago

0.0.0-dev-20240621181818

12 months ago

0.0.0-dev-20240623020119

12 months ago

0.0.0-dev-20240627110057

12 months ago

0.0.0-dev-20240610140222

1 year ago

0.0.0-dev-20240714214509

11 months ago

0.0.0-dev-20240625092805

12 months ago

0.0.0-dev-20240708154713

11 months ago

0.0.0-dev-20240617134713

12 months ago

0.0.0-dev-20240621195040

12 months ago

0.0.0-dev-20240708161628

11 months ago

0.0.0-dev-20240625085745

12 months ago

0.60.0

11 months ago

0.0.0-dev-20240629013500

12 months ago

0.57.0

12 months ago

0.0.0-dev-20240626144005

12 months ago

0.0.0-dev-20240621014505

12 months ago

0.0.0-dev-20240626224340

12 months ago

0.0.0-dev-20240705091354

11 months ago

0.61.1

11 months ago

0.0.0-dev-20240610185501

1 year ago

0.61.0

11 months ago

0.0.0-dev-20240703173247

11 months ago

0.58.3

12 months ago

0.58.1

12 months ago

0.58.2

12 months ago

0.0.0-dev-20240614172110

12 months ago

0.58.0

12 months ago

0.0.0-dev-20240703140341

11 months ago

0.0.0-dev-20240702200508

11 months ago

0.0.0-dev-20240607214653

1 year ago

0.55.0

1 year ago

0.0.0-dev-20240607183506

1 year ago

0.0.0-dev-20240607195446

1 year ago

0.0.0-dev-20240607213716

1 year ago

0.0.0-dev-20240607175637

1 year ago

0.0.0-dev-20240603130555

1 year ago

0.0.0-dev-20240605193509

1 year ago

0.0.0-dev-20240605205254

1 year ago

0.53.0

1 year ago

0.54.0

1 year ago

0.0.0-dev-20240605203045

1 year ago

0.0.0-dev-20240601124629

1 year ago

0.0.0-dev-20240527101350

1 year ago

0.0.0-dev-20240523095548

1 year ago

0.0.0-dev-20240526213324

1 year ago

0.0.0-dev-20240527125555

1 year ago

0.0.0-dev-20240530150754

1 year ago

0.0.0-dev-20240522173351

1 year ago

0.51.2

1 year ago

0.51.0

1 year ago

0.51.1

1 year ago

0.0.0-dev-20240527125045

1 year ago

0.0.0-dev-20240522191731

1 year ago

0.0.0-dev-20240530104704

1 year ago

0.0.0-dev-20240526212646

1 year ago

0.0.0-dev-20240530135542

1 year ago

0.0.0-dev-20240523163344

1 year ago

0.0.0-dev-20240522210843

1 year ago

0.52.0

1 year ago

0.0.0-dev-20240522162309

1 year ago

0.0.0-dev-20240529193934

1 year ago

0.0.0-dev-20240527124419

1 year ago

0.0.0-dev-20240528140318

1 year ago

0.0.0-dev-20240522160301

1 year ago

0.0.0-dev-20240522210342

1 year ago

0.0.0-dev-20240601115836

1 year ago

0.0.0-dev-20240529193430

1 year ago

0.0.0-dev-20240522161520

1 year ago

0.0.0-dev-20240530212228

1 year ago

0.0.0-dev-20240525205323

1 year ago

0.0.0-dev-20240522175824

1 year ago

0.0.0-dev-20240520151730

1 year ago

0.0.0-dev-20240515162717

1 year ago

0.0.0-dev-20240515160243

1 year ago

0.0.0-dev-20240515121647

1 year ago

0.50.0

1 year ago

0.0.0-dev-20240514231431

1 year ago

0.0.0-dev-20240513172202

1 year ago

0.0.0-dev-20240510140649

1 year ago

0.0.0-dev-20240510162335

1 year ago

0.0.0-dev-20240509114608

1 year ago

0.0.0-dev-20240509181535

1 year ago

0.0.0-dev-20240508112036

1 year ago

0.0.0-dev-20240508002451

1 year ago

0.0.0-dev-20240508002941

1 year ago

0.0.0-dev-20240506183024

1 year ago

0.0.0-dev-20240506143411

1 year ago

0.0.0-dev-20240506201227

1 year ago

0.0.0-dev-20240506150048

1 year ago

0.0.0-dev-20240505103514

1 year ago

0.0.0-dev-20240503105745

1 year ago

0.0.0-dev-20240503111646

1 year ago

0.0.0-dev-20240502170637

1 year ago

0.0.0-dev-20240428211915

1 year ago

0.49.0

1 year ago

0.0.0-dev-20240428213103

1 year ago

0.0.0-dev-20240428225153

1 year ago

0.0.0-dev-20240427205601

1 year ago

0.0.0-dev-20240426135528

1 year ago

0.0.0-dev-20240426215128

1 year ago

0.0.0-dev-20240425134655

1 year ago

0.0.0-dev-20240424093930

1 year ago

0.0.0-dev-20240424210416

1 year ago

0.0.0-dev-20240424203504

1 year ago

0.0.0-dev-20240424190747

1 year ago

0.0.0-dev-20240424195730

1 year ago

0.0.0-dev-20240424204741

1 year ago

0.0.0-dev-20240424072132

1 year ago

0.0.0-dev-20240424101351

1 year ago

0.0.0-dev-20240424083844

1 year ago

0.0.0-dev-20240423155603

1 year ago

0.0.0-dev-20240423150835

1 year ago

0.0.0-dev-20240423165655

1 year ago

0.0.0-dev-20240422161736

1 year ago

0.48.0

1 year ago

0.0.0-dev-20240420183338

1 year ago

0.0.0-dev-20240420175436

1 year ago

0.0.0-dev-20240420202821

1 year ago

0.0.0-dev-20240419221913

1 year ago

0.0.0-dev-20240419232104

1 year ago

0.0.0-dev-20240418111020

1 year ago

0.0.0-dev-20240418105312

1 year ago

0.0.0-dev-20240418114332

1 year ago

0.47.0

1 year ago

0.0.0-dev-20240415150937

1 year ago

0.0.0-dev-20240415135943

1 year ago

0.0.0-dev-20240415132612

1 year ago

0.0.0-dev-20240415150427

1 year ago

0.0.0-dev-20240415135225

1 year ago

0.0.0-dev-20240414191827

1 year ago

0.0.0-dev-20240412193711

1 year ago

0.0.0-dev-20240412192708

1 year ago

0.0.0-dev-20240412181302

1 year ago

0.46.0

1 year ago

0.0.0-dev-20240411202552

1 year ago

0.0.0-dev-20240410000101

1 year ago

0.0.0-dev-20240409173156

1 year ago

0.0.0-dev-20240407194709

1 year ago

0.0.0-dev-20240406192502

1 year ago

0.0.0-dev-20240405093351

1 year ago

0.0.0-dev-20240405143052

1 year ago

0.0.0-dev-20240404201437

1 year ago

0.45.0

1 year ago

0.44.0

1 year ago

0.0.0-dev-20240402190741

1 year ago

0.0.0-dev-20240401134025

1 year ago

0.43.0

1 year ago

0.41.0

1 year ago

0.0.0-dev-20240401175026

1 year ago

0.0.0-dev-20240403172135

1 year ago

0.0.0-dev-20240402115802

1 year ago

0.0.0-dev-20240401113729

1 year ago

0.0.0-dev-20240402085645

1 year ago

0.0.0-dev-20240401181552

1 year ago

0.42.0

1 year ago

0.0.0-dev-20240402190329

1 year ago

0.0.0-dev-20240403170757

1 year ago

0.0.0-dev-20240401144529

1 year ago

0.0.0-dev-20240331223619

1 year ago

0.0.0-dev-20240330014326

1 year ago

0.0.0-dev-20240328082118

1 year ago

0.0.0-dev-20240327224627

1 year ago

0.0.0-dev-20240327185419

1 year ago

0.0.0-dev-20240327231551

1 year ago

0.0.0-dev-20240326142713

1 year ago

0.40.0

1 year ago

0.0.0-dev-20240325144630

1 year ago

0.0.0-dev-20240325182522

1 year ago

0.0.0-dev-20240325104526

1 year ago

0.0.0-dev-20240325182053

1 year ago

0.0.0-dev-20240325111212

1 year ago

0.0.0-dev-20240325135545

1 year ago

0.0.0-dev-20240325144058

1 year ago

0.0.0-dev-20240325210644

1 year ago

0.0.0-dev-20240325185213

1 year ago

0.0.0-dev-20240325210159

1 year ago

0.0.0-dev-20240325145650

1 year ago

0.0.0-dev-20240323192853

1 year ago

0.0.0-dev-20240323011014

1 year ago

0.0.0-dev-20240322210944

1 year ago

0.0.0-dev-20240323195153

1 year ago

0.0.0-dev-20240319130154

1 year ago

0.39.0

1 year ago

0.0.0-dev-20240319172205

1 year ago

0.0.0-dev-20240319145605

1 year ago

0.0.0-dev-20240319152430

1 year ago

0.0.0-dev-20240319131128

1 year ago

0.0.0-dev-20240319173246

1 year ago

0.0.0-dev-20240313130245

1 year ago

0.0.0-dev-20240311105914

1 year ago

0.0.0-dev-20240311104454

1 year ago

0.38.1

1 year ago

0.0.0-dev-20240308131516

1 year ago

0.0.0-dev-20240305102340

1 year ago

0.0.0-dev-20240304142605

1 year ago

0.0.0-dev-20240304130833

1 year ago

0.0.0-dev-20240229205109

1 year ago

0.38.0

1 year ago

0.0.0-dev-20240226122439

1 year ago

0.0.0-dev-20240222185953

1 year ago

0.37.3

1 year ago

0.37.2

1 year ago

0.37.1

1 year ago

0.0.0-dev-20240225083948

1 year ago

0.0.0-dev-20240223160309

1 year ago

0.0.0-dev-20240222152205

1 year ago

0.37.0

1 year ago

0.0.0-dev-20240220140757

1 year ago

0.0.0-dev-20240219123837

1 year ago

0.0.0-dev-20240220083154

1 year ago

0.0.0-dev-20240218230834

1 year ago

0.0.0-dev-20240219112318

1 year ago

0.0.0-dev-20240218231445

1 year ago

0.0.0-dev-20240218212651

1 year ago

0.0.0-dev-20240219111719

1 year ago

0.0.0-dev-20240218175520

1 year ago

0.0.0-dev-20240220080902

1 year ago

0.0.0-dev-20240219121231

1 year ago

0.0.0-dev-20240218121115

1 year ago

0.0.0-dev-20240216185224

1 year ago