Skip to content
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

fix: advanced editor styling on library authoring [FC-0076] #36146

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Jan 21, 2025

Description

This PR fixes the styles for the advanced editors (poll, survey, LTI Provider, etc).

LTI Consumer

image

Survey

image

Google Document

image

Additional Information

Testing Instructions


Private ref: FAL-4012

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 21, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @rpenido!

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.


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.

Comment on lines -84 to -85
<!-- Built-in XBlocks (and some plugins) depends on LMS CSS -->
<link rel="stylesheet" href="{{ lms_root_url }}/static/css/lms-course.css">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the editor iframe, the lms-course.css caused some issues.

I didn't find where this was used to check the results, but the Unit Outline and the Course View seem okay.

We can't add this conditionally if needed.

@pomegranited
Copy link
Contributor

@rpenido These changes look and work fine within the legacy studio editor :)

However from the MFE, the nested scrollables are pretty awkward -- maybe make the editor modal a bit taller to accommodate the full iframe, and remove the outer nested scrollbar?

Advanced.editor.style.fixes.-.Made.with.Clipchamp.mp4

@rpenido
Copy link
Contributor Author

rpenido commented Jan 23, 2025

@rpenido These changes look and work fine within the legacy studio editor :)

However from the MFE, the nested scrollables are pretty awkward -- maybe make the editor modal a bit taller to accommodate the full iframe, and remove the outer nested scrollbar?
Advanced.editor.style.fixes.-.Made.with.Clipchamp.mp4

Thanks for the input, @pomegranited! It took me some time, but I think I won the scrollbars battle!
Can you test it again?

@pomegranited
Copy link
Contributor

@rpenido

It took me some time, but I think I won the scrollbars battle!

Almost.. it's working fine for Drag & Drop, but:

  • Google Docs still shows 2 scrollbars at small widths
  • Poll/Survey and LTI Consumer blocks still show 2 scrollbars always.

Maybe the templates for these XBlocks could be modified to remove the outside scrollable area? I think it'd be fine if we have to scroll down to the Save/Cancel/Add+ buttons like we do for Drag & Drop.

Also: Since we've got editing capability for all of these advanced block types now, shouldn't we update frontend-app-authoring's LIBRARY_SUPPORTED_BLOCKS default too?

@rpenido
Copy link
Contributor Author

rpenido commented Jan 24, 2025

Almost.. it's working fine for Drag & Drop, but:

* Google Docs still shows 2 scrollbars at small widths

* Poll/Survey and LTI Consumer blocks still show 2 scrollbars always.

Hi @pomegranited! Can you share what you are seeing? I didn't manage to reproduce it here.
Running tutor dev exec cms npm run build-dev should be enough. Maybe you have some cached CSS?
Can you try to clear it?

editor-modal.mp4

Maybe the templates for these XBlocks could be modified to remove the outside scrollable area? I think it'd be fine if we have to scroll down to the Save/Cancel/Add+ buttons like we do for Drag & Drop.

For me, the Drag & Drop also has the buttons always at the bottom of the dialog. Are you experiencing something different?
image

Also: Since we've got editing capability for all of these advanced block types now, shouldn't we update frontend-app-authoring's LIBRARY_SUPPORTED_BLOCKS default too?

That makes sense to me. What do you think @ChrisChV? Are there other requirements to make it active by default?

@rpenido rpenido changed the title fix: advanced editor styling on library authoring fix: advanced editor styling on library authoring [FC-0076] Jan 24, 2025
@ChrisChV
Copy link
Contributor

Also: Since we've got editing capability for all of these advanced block types now, shouldn't we update frontend-app-authoring's LIBRARY_SUPPORTED_BLOCKS default too?

That makes sense to me. What do you think @ChrisChV? Are there other requirements to make it active by default?

I think we need to finish the task of creating the advanced blocks before changing the default values ​​of LIBRARY_SUPPORTED_BLOCKS. That task of creation is blocked by openedx/frontend-app-authoring#1093 (comment) for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

4 participants