mui / mui/base-ui

[discussion] Add Tour component (onboarding, feature discovery)?

Open
#4,780 0 comments 8 reactions 0 assignees View on GitHub
discussion scope: new proposal type: new feature waiting for 👍
Dominant language
TypeScript
Stars
10.9k
Forks
543
Avg merge
1d 20h
Merged PRs (30d)
101

Description

*⚠️ Info: This issue is for product research, to gather community input. In this [base-ui repo](https://github.com/mui/base-ui) we are, currently, focused on the core set of components needed to create a great design system, so the probability we build this in this repo is very low.*

## Summary

Image

## Examples in other libraries

- https://ui.nuxt.com/docs/composables/use-tour
- https://github.com/nilbuild/driver.js
- https://github.com/gilbarbara/react-joyride
- https://github.com/uixmat/onborda (with Shadcn UI example)
- https://saas-ui.dev/docs/components/engagement/tour
- https://github.com/shipshapecode/shepherd
- https://frigade.com/engage#components
- https://www.command.ai/docs/nudges/nudges/tours/overview/

*([internal benchmark](https://www.notion.so/mui-org/x-Tour-component-35ccbfe7b6608037bbb8d8ed40298236))*

## Motivation

Unclear. We had some requests in https://github.com/mui/mui-x/issues/13933 for this but never that much. There is some room for API in Base UI since https://www.onborda.dev/docs/card exists for Shadcn UI, but I can't help myself wonder, is this UI for the pre-AI era? Why would anyone want this? In any case, a placeholder issue will help get more clarity on whether the community needs this or not.

- User requests:
- https://x.com/auduongtuan/status/2041517545015111756
- https://x.com/mhmdev64/status/2042634956464140338
- UI library requests:
- https://github.com/shadcn-ui/ui/issues/999
- https://github.com/mui/mui-x/issues/13933

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.