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

rpenido · 2025-01-21T20:32:32Z

Description

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

LTI Consumer

Survey

Google Document

Additional Information

Fix Advanced editor styling frontend-app-authoring#1578

Testing Instructions

Checkout this PR
Run tutor dev exec cms npm run build-dev to compile the Sass files
Go to a unit and create some advanced components (more info on feat: Add AdvancedEditors with an iframe [FC-0076] frontend-app-authoring#1568)
Copy and paste these components from the Unit to a Library
Check the editor for these blocks on the library authoring page

Private ref: FAL-4012

openedx-webhooks · 2025-01-21T20:32:37Z

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.

rpenido · 2025-01-21T20:37:45Z

common/templates/xblock_v2/xblock_iframe.html

-  <!-- Built-in XBlocks (and some plugins) depends on LMS CSS -->
-  <link rel="stylesheet" href="{{ lms_root_url }}/static/css/lms-course.css">


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.

openedx/core/djangoapps/xblock/rest_api/views.py

pomegranited · 2025-01-22T04:31:06Z

@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 · 2025-01-23T20:20:06Z

@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 · 2025-01-24T01:52:04Z

@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 · 2025-01-24T14:04:54Z

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?

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?

ChrisChV · 2025-01-24T18:44:16Z

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

pomegranited · 2025-01-28T04:04:25Z

@ChrisChV

I think we need to finish openedx/frontend-app-authoring#1513 before changing the default values of LIBRARY_SUPPORTED_BLOCKS

Totally fine to wait for this. I just wanted to make sure this config change is on your list :)

pomegranited

👍 My apologies @rpenido , my CSS must have been cached! They're working fine now.

Google docs is a little weird, since its modal is larger than its edit page:

But the rest look and work great.

I tested this using the PR test instructions.
I read through the code
I checked for accessibility issues by using my keyboard to navigate
~~Includes documentation~~ N/A
~~User-facing strings are extracted for translation~~ N/A

ChrisChV · 2025-01-29T02:48:17Z

cms/envs/test.py

@@ -136,6 +136,9 @@
 LMS_ROOT_URL = f"http://{LMS_BASE}"
 FEATURES['PREVIEW_LMS_BASE'] = "preview.localhost"

+CMS_BASE = "localhost:8001"
+CMS_ROOT_URL = f"http://{CMS_BASE}"


@rpenido I think CMS_ROOT_URL is a new env variable, right? I think we should add it in cms/envs/common.py, in cms/envs/production.py. What do you think?

Sure! Done here: f92d488

ChrisChV · 2025-01-29T20:23:11Z

@rpenido Do you think it's easy to fix this issue on this PR? No problem if it's not easy, it can be done in a follow-up task

rpenido · 2025-01-29T21:27:53Z

@rpenido Do you think it's easy to fix this issue on this PR? No problem if it's not easy, it can be done in a follow-up task

It is not an easy fix unless we include some hardcoded min-height to match the heights. I'm unsure if this is a good idea..
I would prefer to do it on a follow-up task if needed.

ChrisChV · 2025-01-29T21:49:27Z

It is not an easy fix unless we include some hardcoded min-height to match the heights. I'm unsure if this is a good idea..
I would prefer to do it on a follow-up task if needed.

@rpenido Thanks! I will merge it tomorrow morning

fix: advanced editor styling on library authoring

aa0acf7

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

rpenido commented Jan 21, 2025

View reviewed changes

openedx/core/djangoapps/xblock/rest_api/views.py Show resolved Hide resolved

rpenido and others added 2 commits January 22, 2025 18:30

fix: add CMS_ROOT_URL

db53e68

fix: issues with multiple scroll bars

f6659f3

fix: include fix for google-calendar

c7f5325

rpenido changed the title ~~fix: advanced editor styling on library authoring~~ fix: advanced editor styling on library authoring [FC-0076] Jan 24, 2025

pomegranited approved these changes Jan 28, 2025

View reviewed changes

pomegranited requested a review from ChrisChV January 28, 2025 06:19

ChrisChV approved these changes Jan 29, 2025

View reviewed changes

rpenido added 2 commits January 29, 2025 18:24

fix: add CMS_ROOT_URL to common and production env

f92d488

Merge branch 'master' into rpenido/fal-4012-fix-advanced-editor-styling

19d59f6

fix: double scrollbars on chrome

6a2721a

pomegranited mentioned this pull request Jan 30, 2025

fix: skip setting fields that are not in scope_mappings [FC-0076] openedx/XBlock#815

Open

Merge branch 'master' into rpenido/fal-4012-fix-advanced-editor-styling

8463317

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

rpenido commented Jan 21, 2025 •

edited

Loading

openedx-webhooks commented Jan 21, 2025 •

edited

Loading

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

Where can I find more information?

When can I expect my changes to be merged?

rpenido Jan 21, 2025

pomegranited commented Jan 22, 2025

rpenido commented Jan 23, 2025

pomegranited commented Jan 24, 2025

rpenido commented Jan 24, 2025

ChrisChV commented Jan 24, 2025

pomegranited commented Jan 28, 2025

pomegranited left a comment

ChrisChV Jan 29, 2025

rpenido Jan 29, 2025

ChrisChV commented Jan 29, 2025

rpenido commented Jan 29, 2025

ChrisChV commented Jan 29, 2025

		<!-- Built-in XBlocks (and some plugins) depends on LMS CSS -->
		<link rel="stylesheet" href="{{ lms_root_url }}/static/css/lms-course.css">

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

Are you sure you want to change the base?

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

Conversation

rpenido commented Jan 21, 2025 • edited Loading

Description

LTI Consumer

Survey

Google Document

Additional Information

Testing Instructions

openedx-webhooks commented Jan 21, 2025 • edited Loading

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

Where can I find more information?

When can I expect my changes to be merged?

rpenido Jan 21, 2025

Choose a reason for hiding this comment

pomegranited commented Jan 22, 2025

rpenido commented Jan 23, 2025

pomegranited commented Jan 24, 2025

rpenido commented Jan 24, 2025

ChrisChV commented Jan 24, 2025

pomegranited commented Jan 28, 2025

pomegranited left a comment

Choose a reason for hiding this comment

ChrisChV Jan 29, 2025

Choose a reason for hiding this comment

rpenido Jan 29, 2025

Choose a reason for hiding this comment

ChrisChV commented Jan 29, 2025

rpenido commented Jan 29, 2025

ChrisChV commented Jan 29, 2025

rpenido commented Jan 21, 2025 •

edited

Loading

openedx-webhooks commented Jan 21, 2025 •

edited

Loading