americanexpress / react-albus

✨ React component library for building declarative multi-step flows.
Apache License 2.0
1.1k stars 89 forks source link

feat: add `preserveQuery` option to Wizard #126

Closed teofanis closed 11 months ago

teofanis commented 1 year ago

This is a continuation/remake of this PR. Also addresses issue #36

Description

Introduced the preserveQuery prop to the Wizard component to allow for maintaining search parameters in the URL during navigation. This addition ensures users can maintain state in the URL, enabling deep-linking scenarios and improving user experience.

Motivation and Context

The preserveQuery prop addresses a common use-case where developers want to maintain URL parameters for various reasons, such as sharing links or retaining user settings across navigation.

Addresses issue #36 .

How Has This Been Tested?

Wrote tests cases using the enzyme testing library. Tests handle scenarios listed below.

(Only when the preserveQuery prop is passed).

Let me know if there's a specific test scenario that I should add.

Types of Changes

Checklist:

What is the Impact to Developers Using react-albus?

Developers now have the option to maintain URL parameters using the preserveQuery prop. This enhancement will provide flexibility to developers, ensuring a better user experience in scenarios where URL state needs to be retained.

P.S - I can add an example under examples/preserve-query later on.

github-actions[bot] commented 1 year ago

This pull request is stale because it has been open 30 days with no activity.