-
Notifications
You must be signed in to change notification settings - Fork 3.8k
refactor!: Use JSON instead of XML for defining dynamic toolbox categories. #8658
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
gonfunko
merged 6 commits into
RaspberryPiFoundation:rc/v12.0.0
from
gonfunko:json-categories
Jan 8, 2025
Merged
refactor!: Use JSON instead of XML for defining dynamic toolbox categories. #8658
gonfunko
merged 6 commits into
RaspberryPiFoundation:rc/v12.0.0
from
gonfunko:json-categories
Jan 8, 2025
Conversation
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
Collaborator
|
Since we are not deleting the XML code yet, we should keep the old XML functions around. They are exported, and external devs may be calling them from their own custom flyout categories. I think that means we need to add new functions to do all of the JSON work you're doing here, while marking the old functions as deprecated either in cod eor in comments. |
rachel-fenichel
requested changes
Jan 7, 2025
4130a48 to
f39d232
Compare
rachel-fenichel
approved these changes
Jan 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
The basics
The details
Resolves
Fixes #5580
Proposed Changes
This PR updates the variable, dynamic variable, and procedure toolbox category definitions to use the newer JSON schema in place of the older XML-based format.
Reason for Changes
Support for XML will eventually be removed, and this serves as both eating our own dogfood and a practical example of implementing a dynamic category definition with JSON which third party developers may benefit from as a reference.
Deprecations
Element[]return type of theflyoutCategory()method for each category is now deprecated. Users can opt-in to the newFlyoutItemInfo[](JSON) return type by passing a second argument offalseto the method. We expect to switch the default return type in v13.