Charts: pass config and annotations to the macro as json #105
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
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 context of this PR?
After a discussion with the design system team, they don't want to encode json themselves in the macro - they'd rather receive the config directly as json.
This updates both the annotations and the config to be encoded as json before they are passed to the template.
Instead of using a script tag, the macro passes a json encoded string as a data attribute.
How to review
Test that creating charts in an information page all still works as expected.
Follow-up Actions
Update the macro parameters documentation in the charts spec
Potentially remove the custom version of
json_scriptfrom the repo, although TBC as this could still be a useful addition.