Plone 6.1: plone_layout view: Add is_xhr and use_ajax methods. (5.x branch) #409
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
|
@thet thanks for creating this Pull Request and helping to improve Plone! TL;DR: Finish pushing changes, pass all other checks, then paste a comment: To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically. Happy hacking! |
Add two new methods to the Plone layout view: - `is_xhr`: Returns True, if an AJAX request is detected. This is done by checking if the `HTTP_X_REQUESTED_WITH` request header is set to `XMLHttpRequest`. This is set by many JavaScript libraries. Bare `fetch` requests do not set this without any other intercention, though. So, `is_xhr` is not guaranteed to really detect every and all XHR requests. - `use_ajax`: Returns True, if `is_xhr` returns True, `ajax_load` is unset or not `False` and the `plone.use_ajax` registry parameter is set to True. This can be used to automatically switch to the ajax main template for XHR requests instead of manually setting `ajax_load`, for Plone 6.2. Manually setting the `ajax_load` query parameter always takes precedence.
|
@jenkins-plone-org please run jobs |
thet
changed the title
|
This feature doesn't go into Plone 6.1 but in 6.2. 6.2 implementation: #405 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add two new methods to the Plone layout view:
is_xhr: Returns True, if an AJAX request is detected. This is done by checking if theHTTP_X_REQUESTED_WITHrequest header is set toXMLHttpRequest. This is set by many JavaScript libraries. Barefetchrequests do not set this without any other intercention, though. So,is_xhris not guaranteed to really detect every and all XHR requests.use_ajax: Returns True, ifis_xhrreturns True,ajax_loadis unset or notFalseand theplone.use_ajaxregistry parameter is set to True. This can be used to automatically switch to the ajax main template for XHR requests instead of manually settingajax_load, for Plone 6.2. Manually setting theajax_loadquery parameter always takes precedence.Review Notes