Conversation
Upgrades @stencil/core from 4.43.0 to 4.43.5. This release includes a fix for property default values that reference variables — Stencil now resolves the variable at doc-generation time instead of emitting the raw variable name. The split-pane `when` prop default is now correctly emitted as `'(min-width: 992px)'` instead of `QUERY['lg']` in api.txt and components.d.ts. Fixes stenciljs/core#6727
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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: resolves stenciljs/core#6727
What is the current behavior?
When a component property's default value is set to a JavaScript variable (e.g.
QUERY['lg']onion-split-pane'swhenprop), Stencil emits the raw variable expression into the generated documentation files (api.txt,components.d.ts, anddist/docs.json). This causes the component API docs to displayQUERY['lg']instead of the resolved value'(min-width: 992px)'.What is the new behavior?
Stencil 4.43.5 (via stenciljs/core#6728) resolves variable references at doc-generation time. After bumping and rebuilding:
core/api.txt—ion-split-pane'swhendefault is now'(min-width: 992px)'core/src/components.d.ts—@defaultJSDoc tag reflects the resolved valuedist/docs.json(published as@ionic/docs) — will also carry the resolved value once released, enabling ionic-docs to remove the hardcoded fallbacks for thegallerycomponentDoes this introduce a breaking change?
Other information
ionic-docsusing the updated@ionic/docspackage — at that point the hardcoded default descriptions forgallery'scolumnsandgapprops can be removed.