Feature: Add additional Step Handlers useWizard #197
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
This allows users to attach callbacks to be called when navigating backwards, and jumping in the step hiearchy. This takes the handler for next step as inspiration for the other triggers, encapsulating them in the same async call methods. These differ from usig the onStepChange method, and allows for attaching different behaviour inside step components instead of higher up in a component hiearachy.
…p and previousStep methods
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.
Description
Hi!
The company I work with had a case where we needed to attach some effects whenever we changed the step away from the current one, calling a function and doing some API calls. We couldn't easily use the
onStepChangeprop in theWizardcomponent as the definition of the function needed data for the particular Step-component it was in.handleStepwas not sufficient, as we needed to also call this function when navigating back (or go directly to another step).This PR adds additional step handlers to the useWizard hook, allowing more control over the wizard's steps when calling
previousStepandgoToStep. The methodology has in large part been copied fromhandleStepto be consistent,Key Changes
Added new step handlers to manage wizard logic.
Updated documentation to reflect new feature.
Updated test to reflect the async nature of the
previousStepandgotToStepchanges.