fix(menu): refs are not destroyed on unmount #27141
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
|
|
averyjohnston
approved these changes
Apr 10, 2023
7 tasks
liamdebeasi
added a commit
that referenced
this pull request
Apr 10, 2023
<!-- Please refer to our contributing documentation for any questions on submitting a pull request, or let us know here if you need any help: https://ionicframework.com/docs/building/contributing --> <!-- Some docs updates need to be made in the `ionic-docs` repo, in a separate PR. See https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#modifying-documentation for details. --> <!-- 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. --> <!-- Issues are required for both bug fixes and features. --> Issue URL: resolves #24907 `ion-menu` currently clears the `menuInnerEl` and `backdropEl` refs created by Stencil when `disconnectedCallback` is fired. If the `ion-menu` component is re-mounted but _not_ re-rendered, those refs will still be `undefined` when the `open` method is called, resulting in the linked issue. Note that if the `ion-menu` re-renders before `open` is called then this issue does not reproduce. This clearing behavior was added ~6 years ago before we utilized Stencil refs: https://github.com/ionic-team/ionic-framework/blob/687b37ad3e3237b874473817bb7b59143ac113ce/packages/core/src/components/menu/menu.tsx#L136-L137 During this time we had to manually create and clear the element references. Several years later we moved to using Stencil refs, but we did not remove the logic that clears the refs: d83d8ee ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - Menu no longer sets `menuInnerEl` and `backdropEl` to `undefined` in `disconnectedCallback`. - The `close` method is called so that the state is reset prior to the menu being re-added. I observed that without this, the animation to re-present a menu did not work correctly. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
liamdebeasi
added a commit
that referenced
this pull request
Apr 17, 2023
<!-- Please refer to our contributing documentation for any questions on submitting a pull request, or let us know here if you need any help: https://ionicframework.com/docs/building/contributing --> <!-- Some docs updates need to be made in the `ionic-docs` repo, in a separate PR. See https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#modifying-documentation for details. --> <!-- 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. --> <!-- Please describe the current behavior that you are modifying. --> <!-- Issues are required for both bug fixes and features. --> Issue URL: resolves #24907 `ion-menu` currently clears the `menuInnerEl` and `backdropEl` refs created by Stencil when `disconnectedCallback` is fired. If the `ion-menu` component is re-mounted but _not_ re-rendered, those refs will still be `undefined` when the `open` method is called, resulting in the linked issue. Note that if the `ion-menu` re-renders before `open` is called then this issue does not reproduce. This clearing behavior was added ~6 years ago before we utilized Stencil refs: https://github.com/ionic-team/ionic-framework/blob/687b37ad3e3237b874473817bb7b59143ac113ce/packages/core/src/components/menu/menu.tsx#L136-L137 During this time we had to manually create and clear the element references. Several years later we moved to using Stencil refs, but we did not remove the logic that clears the refs: d83d8ee <!-- Please describe the behavior or changes that are being added by this PR. --> - Menu no longer sets `menuInnerEl` and `backdropEl` to `undefined` in `disconnectedCallback`. - The `close` method is called so that the state is reset prior to the menu being re-added. I observed that without this, the animation to re-present a menu did not work correctly. - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
liamdebeasi
added a commit
that referenced
this pull request
Apr 19, 2023
resolves #24907 --------- <!-- Please refer to our contributing documentation for any questions on submitting a pull request, or let us know here if you need any help: https://ionicframework.com/docs/building/contributing --> <!-- Some docs updates need to be made in the `ionic-docs` repo, in a separate PR. See https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#modifying-documentation for details. --> <!-- 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. --> <!-- Please describe the current behavior that you are modifying. --> <!-- Issues are required for both bug fixes and features. --> Issue URL: resolves #24907 `ion-menu` currently clears the `menuInnerEl` and `backdropEl` refs created by Stencil when `disconnectedCallback` is fired. If the `ion-menu` component is re-mounted but _not_ re-rendered, those refs will still be `undefined` when the `open` method is called, resulting in the linked issue. Note that if the `ion-menu` re-renders before `open` is called then this issue does not reproduce. This clearing behavior was added ~6 years ago before we utilized Stencil refs: https://github.com/ionic-team/ionic-framework/blob/687b37ad3e3237b874473817bb7b59143ac113ce/packages/core/src/components/menu/menu.tsx#L136-L137 During this time we had to manually create and clear the element references. Several years later we moved to using Stencil refs, but we did not remove the logic that clears the refs: d83d8ee <!-- Please describe the behavior or changes that are being added by this PR. --> - Menu no longer sets `menuInnerEl` and `backdropEl` to `undefined` in `disconnectedCallback`. - The `close` method is called so that the state is reset prior to the menu being re-added. I observed that without this, the animation to re-present a menu did not work correctly. - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
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.
What is the current behavior?
Issue URL: resolves #24907
ion-menucurrently clears themenuInnerElandbackdropElrefs created by Stencil whendisconnectedCallbackis fired. If theion-menucomponent is re-mounted but not re-rendered, those refs will still beundefinedwhen theopenmethod is called, resulting in the linked issue. Note that if theion-menure-renders beforeopenis called then this issue does not reproduce.This clearing behavior was added ~6 years ago before we utilized Stencil refs:
ionic-framework/packages/core/src/components/menu/menu.tsx
Lines 136 to 137 in 687b37a
During this time we had to manually create and clear the element references.
Several years later we moved to using Stencil refs, but we did not remove the logic that clears the refs: d83d8ee
What is the new behavior?
menuInnerElandbackdropEltoundefinedindisconnectedCallback.closemethod is called so that the state is reset prior to the menu being re-added. I observed that without this, the animation to re-present a menu did not work correctly.Does this introduce a breaking change?
Other information