Skip to content

feat: [FC-0070] rendering library content in unit page - #35785

Merged
arbrandes merged 1 commit into
openedx:masterfrom
raccoongang:romaniuk/children-container-for-rendering-library
Jan 16, 2025
Merged

feat: [FC-0070] rendering library content in unit page#35785
arbrandes merged 1 commit into
openedx:masterfrom
raccoongang:romaniuk/children-container-for-rendering-library

Conversation

@ihor-romaniuk

@ihor-romaniuk ihor-romaniuk commented Nov 6, 2024

Copy link
Copy Markdown
Contributor

🚨 Dependencies:

Description

This feature introduces functionalities to improve XBlock interactions within iframes:

  • Add styles that adopt default styles for Library Content which renders chromless template via iframe in MFE Authoring.
  • When the isIframeEmbed option is enabled, the XBlock sends a postMessage to the parent window. When sending such a message, the standard link transition is cancelled and the transition is carried out in MFE Authoring.
Unit_Library_Content.mov

Related Pull Requests

Testing instructions

  • Create a new course.
  • Create several units.
  • Open the course unit page.
  • Add a Library xBlock to the unit.
  • Click the “View” button on the Library xBlock.

Note: The change requires rebuilding static assets with tutor dev exec lms opensx-assets build --env=dev

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 6, 2024
@openedx-webhooks

openedx-webhooks commented Nov 6, 2024

Copy link
Copy Markdown

Thanks for the pull request, @ihor-romaniuk!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@ihor-romaniuk ihor-romaniuk changed the title Romaniuk/children container for rendering library feat: [FC-0070] rendering library content in unit page Nov 6, 2024
@ihor-romaniuk ihor-romaniuk added the FC Relates to an Axim Funded Contribution project label Nov 7, 2024
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from ea6c563 to 7e3ef8a Compare November 22, 2024 17:50
@ihor-romaniuk
ihor-romaniuk marked this pull request as ready for review November 22, 2024 17:50
Comment thread cms/static/js/views/pages/container.js
Comment thread cms/static/sass/course-unit-mfe-iframe-bundle.scss Outdated
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from 7e3ef8a to 41a4092 Compare November 26, 2024 12:37
@bradenmacdonald

Copy link
Copy Markdown
Contributor

Testing instructions

Testing instructions are missing a rebuild of static assets. This PR didn't work for me until I ran tutor dev exec lms openedx-assets build --env=dev

Comment thread cms/static/js/views/pages/container.js Outdated
{
type: 'handleViewXBlockContent',
payload: {
destination: event.currentTarget.href || '',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if we can also send the usageId as a separate parameter in the payload here, instead of making the MFE parse it (const newUnitId = payload.destination.split('/').pop()).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. We can simplify payload data and reduce extra calculation on the MFE side.

@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 5 times, most recently from 320fc9a to e358489 Compare December 9, 2024 08:15
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 3 times, most recently from 84df7ac to a199471 Compare December 16, 2024 07:19
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 2 times, most recently from 294546c to 6f9d22c Compare January 6, 2025 08:48
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from 6f9d22c to 91e83a7 Compare January 13, 2025 16:43
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 2 times, most recently from 049bea5 to 299de9d Compare January 16, 2025 16:05
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from 299de9d to 9793296 Compare January 16, 2025 16:05
@ihor-romaniuk
ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from 9793296 to 422135c Compare January 16, 2025 16:23
@arbrandes
arbrandes merged commit 8aeaaf4 into openedx:master Jan 16, 2025
@ihor-romaniuk
ihor-romaniuk deleted the romaniuk/children-container-for-rendering-library branch January 16, 2025 17:07
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants