Docs: fix and restore live code snippet updates in interactive playgrounds#42593
Open
julien-deramond wants to merge 1 commit into
Open
Docs: fix and restore live code snippet updates in interactive playgrounds#42593julien-deramond wants to merge 1 commit into
julien-deramond wants to merge 1 commit into
Conversation
8b63b9f to
370850c
Compare
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
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.
Description
When interacting with the interactive playgrounds, the live code snippet was never updated to reflect the current state of the controls.
The
ButtonPlayground,MenuPlacementPlayground, andNavbarPlacementPlaygroundcomponents are supposed to update the live code snippet whenever the user changes a control, but nothing was ever updated.codeSnippetwas alwaysnullbecause the selector.highlight codedidn't match the actual rendered element.astro-code code.This fixes the selector by targeting
<pre class="astro-code">directly, and replaces thetextContentapproach with a call tohighlightCodefrom@libs/highlight.Indeed, without calling this method, the content would have been updated, but without syntax highlighting!
Since Shiki is isomorphic, Vite bundles it for the browser transparently. The returned markup is parsed with
DOMParserand the whole<pre>is swapped in the DOM, preserving both the updated content and Shiki's token spans with their theme CSS variables. ThecodeSnippetPrereference is updated on each swap so subsequent interactions keep targeting the right node.Live previews
Now, the playground code snippets are updated 🥳