-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
feat: Changes in xblock_v2 to support studio_view [FC-0076] #36029
base: master
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @ChrisChV! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
- I tested this: Ran the testing instructions
- I read through the code
- I checked for accessibility issues
- Includes documentation
event.preventDefault(); | ||
window.parent.postMessage('save-clicked', '*'); | ||
}); | ||
</script> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm surprised this works. Doesn't this run before the cancel button and save button are even added to the document? Are we sure this will always run after they are added ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, we probably want to find some way to make this code only run in studio_view
, not any other view.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also: how does saving actually work? What code is handling the "Save" button and actually saving the changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, we probably want to find some way to make this code only run in studio_view, not any other view.
Updated. I verified the view_name
Are we sure this will always run after they are added ?
I refactored the code with a better approach. About cancel
, I moved the code after the block is rendered. About save
, I used the notify
function to catch the end of the save and send a message to the MFE. I chose this approach because it solves a bug when saving: The iframe was closing before the save operation was finished.
how does saving actually work? What code is handling the "Save" button and actually saving the changes?
Each block type has its own code and logic for saving, but they all have in common the notify
at the end of the save and call the studio_submit
handler, using xblock_handler
…nts on block render
Description
Updates to support
studio_view
(editors) in xblock_v2 iframe.studio_view
notify
function inruntime
. This is to avoid errors when saving the XblockSupporting information
Testing instructions
Follow the testing instructions at openedx/frontend-app-authoring#1568
Deadline
"None" if there's no rush, or provide a specific date or event (and reason) if there is one.
Other information
N/A