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

bug: regression: IonRouterOutlet ref is always undefined #29924

Closed
3 tasks done
aeharding opened this issue Oct 5, 2024 · 2 comments · Fixed by #29940
Closed
3 tasks done

bug: regression: IonRouterOutlet ref is always undefined #29924

aeharding opened this issue Oct 5, 2024 · 2 comments · Fixed by #29940
Labels
package: react @ionic/react package type: bug a confirmed bug report

Comments

@aeharding
Copy link
Contributor

Prerequisites

Ionic Framework Version

v8.x

Current Behavior

In ionic 8.2.6, I could get the ref (React) like the following:

const ref = useRef();

requestAnimationFrame(() => {
  console.log(ref.current);
});

return <IonRouterOutlet ref={ref} />

Which prints:

image

In Ionic 8.3.2, this prints:

image

Expected Behavior

8.2.6 behavior

Steps to Reproduce

  1. Clone https://github.com/aeharding/bugged-outlet
  2. Checkout branch 8.2.6. Install, ionic serve
  3. Observe expected output in console
  4. Checkout branch 8.3.2. Install, ionic serve
  5. Observe bugged output (all undefined)

Code Reproduction URL

https://github.com/aeharding/bugged-outlet

Ionic Info

Ionic:

   Ionic CLI       : 7.2.0 (/Users/aeharding/.nvm/versions/node/v22.1.0/lib/node_modules/@ionic/cli)
   Ionic Framework : @ionic/react 8.3.2

Capacitor:

   Capacitor CLI      : 6.1.2
   @capacitor/android : not installed
   @capacitor/core    : 6.1.2
   @capacitor/ios     : not installed

Utility:

   cordova-res : not installed globally
   native-run  : not installed globally

System:

   NodeJS : v22.1.0 (/Users/aeharding/.nvm/versions/node/v22.1.0/bin/node)
   npm    : 10.7.0
   OS     : macOS Unknown

Additional Information

No response

@ionitron-bot ionitron-bot bot added the triage label Oct 5, 2024
@thetaPC
Copy link
Contributor

thetaPC commented Oct 10, 2024

Thank you for submitting the issue!

I was able to replicate it and a fix will be available soon!

@thetaPC thetaPC added the type: bug a confirmed bug report label Oct 10, 2024
@ionitron-bot ionitron-bot bot removed the triage label Oct 10, 2024
@brandyscarney brandyscarney added the package: react @ionic/react package label Oct 15, 2024
github-merge-queue bot pushed a commit that referenced this issue Oct 16, 2024
Issue number: resolves #29885, resolves #29924

---------

<!-- Please do not submit updates to dependencies unless it fixes an
issue. -->

<!-- Please try to limit your pull request to one type (bugfix, feature,
etc). Submit multiple pull requests if needed. -->

## What is the current behavior?
<!-- Please describe the current behavior that you are modifying. -->

React and Vue:

Tab bar could be a standalone element within `IonTabs` and would
navigate without issues with a router outlet before v8.3:

```tsx
<IonTabs>
  <IonRouterOutlet></IonRouterOutlet>

  <IonTabBar></IonTabBar>
</IonTabs>
```

It would work as if it was written as:

```tsx
<IonTabs>
  <IonRouterOutlet></IonRouterOutlet>

  <IonTabBar slot="bottom">
    <!-- Buttons -->
  </IonTabBar>
</IonTabs>
```

After v8.3, any `ion-tab-bar` that was not a direct child of `ion-tabs`
would lose it's expected behavior when used with a router outlet. If a
user clicked on a tab button, then the content would not be redirected
to that expected view.

React only:

Users can no longer add a `ref` to the `IonRouterOutlet`, it always
returns undefined.

```
<IonTabs>
      <IonRouterOutlet ref={ref}>

     <IonTabBar slot="bottom">
    <!-- Buttons -->
  </IonTabBar>
</IonTabs>
```

## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->

The fixes were already reviewed through PR
#29925 and PR
#29927. I split them
to make it easier to review.

React and Vue:

The React tabs has been updated to pass data to the tab bar through
context instead of passing it through a ref. By using a context, the
data will be available for the tab bar to use regardless of its level.

React only:

Reverted the logic for `routerOutletRef` and added a comment of the
importance of it.

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

<!--
  If this introduces a breaking change:
1. Describe the impact and migration path for existing applications
below.
  2. Update the BREAKING.md file with the breaking change.
3. Add "BREAKING CHANGE: [...]" to the commit description when merging.
See
https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer
for more information.
-->


## Other information

<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->

N/A
Copy link

ionitron-bot bot commented Nov 15, 2024

Thanks for the issue! This issue is being locked to prevent comments that are not relevant to the original issue. If this is still an issue with the latest version of Ionic, please create a new issue and ensure the template is fully filled out.

@ionitron-bot ionitron-bot bot locked and limited conversation to collaborators Nov 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
package: react @ionic/react package type: bug a confirmed bug report
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants