feat(tour): Add callbacks for onStartTour and onEndTour #87810
Merged
Conversation
This file contains 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
github-actions
bot
added
the
Scope: Frontend
leeandher
approved these changes
Mar 25, 2025
There was a problem hiding this comment.
I really appreciate these PRs @malwilley I think the quality of life improvements and developer-friendliness is wayy better this way!! ❤️
Comment on lines
+199
to
+201
| const nextStep = useCallback(() => { | ||
| dispatch({type: 'NEXT_STEP'}); | ||
| }, []); |
There was a problem hiding this comment.
Looks good! Just FYI, if the NEXT_STEP action is called when there are no more steps, it will have the same result as the END_TOUR action. If that's the case, I'm wondering if we'd expect callbacks.onEndTour() to be invoked.
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
andrewshie-sentry
pushed a commit
that referenced
this pull request
Mar 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Depends on #87805
Look at 119f725 for the actual diff that's not reliant on the previous PR
The purpose for these changes is to add
onStartTour()andonEndTour()callbacks. I want this so that I can show a reminder tooltip. I could rely on state changes, but allows users to avoid a useEffect.I implemented this by wrapping the dispatch calls into functions which also call the callback. This should make the component API a bit clearer, since it returns functions like
startTourandendTourinstead of the rawdispatch.