feat: add tour component #10410
Open
feat: add tour component #10410
+2,273
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: cdf1e7c The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Introduces the new
Tourcomponent to Chakra UI, a guided tour feature that helps users understand interfaces through interactive steps with contextual highlights and messaging.⛳️ Current behavior (updates)
N/A—this is a new component. Chakra UI did not previously have a Tour component.
🚀 New behavior
New Tour component features:
Tour.Root/Tour.RootProvider- container withuseTourhook supportTour.BackdropTour.SpotlightTour.PositionerTour.Content,Tour.Title,Tour.Description- step messagingTour.Arrow,Tour.ArrowTip- pointer stylingTour.Control,Tour.ProgressText,Tour.ActionTriggers- navigation UITour.CloseTrigger- dismiss buttonTour features:
dialog,tooltip,floating,waitstart(),next(),prev(),setStep(), progress trackingonStepChange,onStatusChange)💣 Is this a breaking change (Yes/No):
No
This is a new component with no impact on existing functionality.
📝 Additional Information
Built on top of Ark UI's Tour primitive with Chakra styling and composition patterns. Follows Chakra's slot recipe structure for customization.