fix: ensure exported images reflect recent style and configuration changes#1916
Open
ppmpreetham wants to merge 1 commit intomermaid-js:developfrom
Open
fix: ensure exported images reflect recent style and configuration changes#1916ppmpreetham wants to merge 1 commit intomermaid-js:developfrom
ppmpreetham wants to merge 1 commit intomermaid-js:developfrom
Conversation
✅ Deploy Preview for mermaidjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
📑 Summary
This PR fixes a bug where exporting an image after changing the diagram's configuration (styles) would result in an image with the old styles. It ensures that changes made in the Config editor correctly trigger a diagram update so the exported image reflects the latest state.
📏 Design Decisions
Previously, when the diagram text was changed,
updateCodeproperly triggered theupdateDiagram: trueflag. However, when the configuration was changed, theupdateConfigfunction insrc/lib/util/state.tsonly updated the config string without setting theupdateDiagramflag. Because of this, theexportImagefunction was relying on a stale render state, causing it to export the previous version of the diagram.To fix this, I updated the
updateConfigfunction to includeupdateDiagram: true, mirroring the behavior ofupdateCode. This explicitly signals the application to refresh the render cycle when styles are modified.📋 Tasks
Make sure you
developbranch