refactor(config): enable stencil's experimental slot fixes #28995
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
rwaskiewicz
force-pushed
the
rwaskiewicz/enable-experimental-slot-fixes
branch
from
7f531e3
to
063e166
Compare
rwaskiewicz
force-pushed
the
rwaskiewicz/enable-experimental-slot-fixes
branch
from
063e166
to
68ae4a9
Compare
rwaskiewicz
force-pushed
the
rwaskiewicz/enable-experimental-slot-fixes
branch
from
ea211de
to
fd0fc3f
Compare
the stencil team has been working on fixing multiple issues with slots elements in the stencil codebase. to make these changes backwards compatible and communicate that they were volatile, we added two configuration flags for these fixes that were prefixed with the word "experimental". now that the effort to provide these fixes has largely solidified, the features behind these flags are slightly less volatile. while the "experimental" aspect still technically holds true, we've requested the Framework team to enable these flags in a v8 beta. the stencil team expects these flags to be set to `true` by default in stencil v5, which ought to help prepare for future migrations the ionic framework has to undergo.
Issue number: N/A --------- <!-- 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. --> Previously, Stencil would allow content to project through to a component even when a slot was not present. However, with the changes in `extras.experimentalScopedSlotChanges`, this behavior was changed to hide elements without a destination slot - matching the behavior of a shadow encapsulated component. As such, elements projected through the `ion-label` or `ion-buttons` components would no longer be visible in rendered output. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> This commit adds an explicit `slot` tag to components in core leveraging "scoped" encapsulation with no rendered content (i.e. elements with only a `Host` tag and styles). ## 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/.github/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. -->
rwaskiewicz
force-pushed
the
rwaskiewicz/enable-experimental-slot-fixes
branch
from
fd0fc3f
to
2a13799
Compare
This fixes an issue with the `ion-input` component not re-rendering in some cases when using the label slot functionality. HTML element patches in Stencil that are enabled by the `experimentalSlotFixes` flag result in DOM manipulations that won't trigger the current mutation observer configuration and callback.
thetaPC
changed the title
thetaPC
requested changes
Mar 11, 2024
| @@ -50,6 +50,7 @@ export const createSlotMutationController = ( | |||
|
|
|||
| hostMutationObserver.observe(el, { | |||
| childList: true, | |||
| subtree: true, | |||
There was a problem hiding this comment.
Let's add a comment explaining why this was adding. That way it's not accidentally removed in the future.
core/stencil.config.ts
Outdated
Comment on lines
261
to
262
| experimentalSlotFixes: true, | ||
| experimentalScopedSlotChanges: true, |
There was a problem hiding this comment.
Let's add a comment noting that these are needed until a stable version is released.
|
This is not considered a breaking change so no additional work needs to be done for that. |
thetaPC
requested changes
Mar 12, 2024
Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>
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.
Issue number: N/A
What is the current behavior?
the stencil team has been working on fixing multiple issues with slots
elements in the stencil code base. to make these changes backwards
compatible and communicate that they were volatile, we added two
configuration flags for these fixes that were prefixed with the word
"experimental".
now that the effort to provide these fixes has largely solidified, the
features behind these flags are slightly less volatile. while the
"experimental" aspect still technically holds true, we've requested
the Framework team to enable these flags in a v8 beta. the stencil
team expects these flags to be set to
trueby default in stencilv5, which ought to help prepare for future migrations the ionic
framework has to undergo.
Previously, Stencil would allow content to project through to a component even when a slot was not present. However, with the changes in
extras.experimentalScopedSlotChanges, this behavior was changed to hide elements without a destination slot - matching the behavior of a shadow encapsulated component.As such, elements projected through the
ion-labelorion-buttonscomponents would no longer be visible in rendered output.What is the new behavior?
This commit adds an explicit
slottag to components in core leveraging "scoped" encapsulation with no rendered content (i.e. elements with only aHosttag and styles).This fixes an issue with the
ion-inputcomponent not re-rendering in some cases when using the label slot functionality.HTML element patches in Stencil that are enabled by the
experimentalSlotFixesflag result in DOM manipulations that won't trigger the current mutation observer configuration and callback.Does this introduce a breaking change?
Other information
Would you like us to update the commit message to include the
BREAKING CHANGE:comment? Unsure of the actual impact on end users here.Similarly, would you like us to update the commit message here from
chore()to something else?