search

openedx / frontend-app-course-authoring

The micro-frontend for course authoring in Open edX. Frontend interfaces that currently live in Studio/CMS should eventually live here.
GNU Affero General Public License v3.0
12 stars 70 forks source link

studio_view from xBlock/xBlock Asides not being displayed anywhere #545

Open arslanashraf7 opened 1 year ago

arslanashraf7 commented 1 year ago

Context:

Open edX has support for custom xBlock and xBlock asides where anyone could develop their custom xBlocks in a specific format e.g. defining functions such as student_view, studio_view that would return a fragment(packaged with HTML, CSS. JS resources) which would then be rendered in Studio and LMS. The Learning MFE does support this and renders the student_view if it exists but the authoring MFE doesn't. For reference on custom xBlocks please take a look at https://edx.readthedocs.io/projects/xblock-tutorial/en/latest/edx_platform/edx_studio.html.

Legacy Studio (Problem Editor)

In the legacy studio, when you create a custom xblock you could specify its studio_view which then renders in the edit section of that problem under Plugins Tab.

For example, Take a look at the below screenshot (The view rendered here is from xBlock Aside for the Multiple Choice problem):

image

New Course Authoring MFE (Problem Editor)

In the new MFE, It doesn't render this view anywhere. Although, It does fetch the studio_view via /xblock/<problem_key>/studio_view?_=<id>. You can notice this in the network tab when opening a problem in the new course authoring MFE. We also noticed that the custom studio_view is returned in the response of this API but it isn't rendered anywhere.

Here is a code reference from the lib-components where the API is defined to fetch studio view.

It's possible that this new Course Authoring MFE does support studio_view but there is no documentation on how to enable it? If it doesn't? Are there any plans to add support for this?

jristau1984 commented 1 year ago

Hi! There are many plans associated with this MFE, but it is not ready for use right now. The MFE is currently being built out, a spec memo was published to the community outlining this project. We expect it to be available in the Q release.

Is this enough info to resolve this issue, or would you like more included here? If so, can you list specific questions to be answered? Thanks!

arslanashraf7 commented 1 year ago

@jristau1984 Thanks for your quick response and for sharing your plans for the future.

Is this enough info to resolve this issue, or would you like more included here? If so, can you list specific questions to be answered? Thanks!

I think your response is clear and I'll definitely come back if there are questions in our internal discussions.

Just two things for now:

  1. Could you provide a link to that memo published to the community?
  2. Could you tell if this feat is planned for the Q release?
arslanashraf7 commented 9 months ago

Hi! There are many plans associated with this MFE, but it is not ready for use right now. The MFE is currently being built out, a spec memo was published to the community outlining this project. We expect it to be available in the Q release.

@jristau1984 Since the Quince release is out, Could you share:

  1. Is this MFE officially ready for use now?
  2. Does it support xBlock aside settings now?

-Thanks