Wagtail 2.13 compatibility #14
Merged
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
Rendered widget output is now embedded in JSON within the data-block attribute, rather than directly on the page, and needs to be escaped accordingly
This provides a way for the data required to render the widget to be serialised and passed to Javascript, so it can be rendered and populated client-side and not just through a Django template.
This is built-in functionality of the WidgetWithScript utility class used by AdminChooser, and saves us having to include the initialisation JS in the template. Doing it this way means that we can call render_html from the StreamField logic to get just the HTML without the JS (and then trigger the JS at the right point in the StreamField lifecycle).
The standard widget rendering does not use this, as the call to create_instance_selector_widget ignores the return value. However, it will be used by the client-side component in the telepath implementation of StreamField: https://docs.wagtail.io/en/latest/reference/streamfield/widget_api.html
|
Just to add - wagtail-instance-selector's modal embeds are affected by wagtail/wagtail#7169, so if you test against the current 2.13 release candidates you may encounter JS errors on opening them... this will be fixed for 2.13 final. |
|
@markfinger Wagtail 2.13 is now out - https://github.com/wagtail/wagtail/releases/tag/v2.13 - would be great to have this reviewed and released out in the wild, if you have time. |
|
This looks amazing! Thanks @gasman! |
|
Thanks for all the work, @gasman. Sorry for the delay in response, I've been on leave. I've run a quick test against one of our wagtail 2.11 systems, and everything looks alright. |
|
Thanks again to everyone for the reports and the fixes. |
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.
Fixes #11. The new telepath StreamField implementation in 2.13 requires some fairly heavy refactoring to the InstanceSelector widget, since InstanceSelector was quite heavily reliant on rendering a template for each instance, while StreamField needs to be able to construct them client-side from serialised data. I got it working by extracting an 'state' dict consisting of the pk, display_markup and edit_url, which can be used by both the server-side and client-side rendering logic.
(For reference, I submitted a fairly similar patch to wagtailmodelchooser that might help in following the changes: neon-jungle/wagtailmodelchooser#27)