Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(react): IonNav apply properties to page components #25603

Merged
merged 17 commits into from Jul 28, 2022
Merged

Conversation

sean-perkins
Copy link
Contributor

@sean-perkins sean-perkins commented Jul 11, 2022

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
    • Some docs updates need to be made in the ionic-docs repo, in a separate PR. See the contributing guide for details.
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Root params set on IonNav are not inherited by the root component.

Issue URL: resolves #25602

What is the new behavior?

IonNav will now assign the properties to the page components correctly.

IonNav now supports two ways to assign properties to page components:

Memorized Components

const root = useCallback(() => <MyComponent first="Sean" last="Perkins />, []);

<IonNav root={root} />

rootParams

<IonNav root={MyComponent} rootParams={{ first: "Sean", last: "Perkins" }} />

Additionally, this PR caches element references, which partially resolves an issue with Vite + React and hmr clearing the views within IonNav.

Does this introduce a breaking change?

  • Yes
  • No

Other information

Dev-build: 6.1.15-dev.11657908598.17be2d80

@github-actions github-actions bot added the package: react @ionic/react package label Jul 11, 2022
@sean-perkins sean-perkins marked this pull request as ready for review July 11, 2022 02:49
@sean-perkins sean-perkins requested a review from a team as a code owner July 11, 2022 02:49
Copy link
Contributor

@amandaejohnston amandaejohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to update the docs for rootParams as well?

@sean-perkins
Copy link
Contributor Author

I have a thought here on how to support both implementation patterns... will report back if it works.

@sean-perkins
Copy link
Contributor Author

Ok this is ready, we can support both memorized components and rootParams usages. 🎉


Component.props = propsOrDataObj;
refMap.set(component, hostComponent);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need the map?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One instance of the delegate is constructed for one instance of IonNav, but IonNav can attach multiple views to the DOM.

The map allows us to keep track of all instances of the individual views that were pushed inside the Nav. We can then do a look-up against the map to find the correct instance to remove the view from the DOM.

In the previous implementation, the value of Component would be reset when a new view was pushed, which prevented the previous view from ever being removed.

Alternatively you could use an object instead of a map here, but since we are associating to a React component, a WeakMap would be my recommendation here so that it does not interfere with garbage collection.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: react @ionic/react package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: IonNav in React does not support rootParams
3 participants