Skip to content

[FC-0009] New actions menu for editing components in Studio (behind waffle flag)#31853

Merged
bradenmacdonald merged 1 commit intoopenedx:masterfrom
open-craft:braden/component-actions-menu
Mar 3, 2023
Merged

[FC-0009] New actions menu for editing components in Studio (behind waffle flag)#31853
bradenmacdonald merged 1 commit intoopenedx:masterfrom
open-craft:braden/component-actions-menu

Conversation

@bradenmacdonald
Copy link
Contributor

Description

This is the first PR for the upcoming copy/paste feature in Studio.

This PR implements the following tickets:

Currently, we are gating this change behind a feature flag, so this will not be visible yet to most authors.

For course authors and developers who opt-in to test this new feature, they will see the new consolidated "Actions" menu instead of the icons for "Access Settings", "Duplicate", etc. One reason for this is that with the new menu, we can have both a "duplicate" and a "copy" action without confusing anyone, which is harder to do with just icons visible.

This screen recording shows the current UX, then enables the feature flag and shows the new UX for users who opt-in to test this out:

demo.mov

Impacted roles: Course Author (opt-in for now)

The new feature flag is contentstore.enable_copy_paste_feature

Supporting information

See GitHub issues linked above.

Testing instructions

  1. Open Studio and check that the current Unit page for editing components in a Unit is unchanged.
  2. Go to http://studio.local.overhang.io:8001/admin/waffle/flag/ (or devstack/sandbox equivalent)
  3. Add a new flag, contentstore.enable_copy_paste_feature and enable it for Everyone
  4. Go to a Unit page in Studio and test the new actions menu. It should work as shown in the video above.

Deadline

None

Other information

  • For now, clicking on the "Copy" action just displays an ugly "Not implemented yet" alert. I assume that's fine as nobody will see this for now, except people who are explicitly trying to develop/test it.
  • In an effort to minimize the work, this change re-uses existing Studio menu components and icons as much as possible. As a result, one difference from the UX mockups is that there is a line between every menu item, and not just before the delete button. This is consistent with all the other menus in Studio but doesn't match the design.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core committer labels Feb 28, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

As a core committer in this repo, you can merge this once the pull request is approved per the core committer reviewer requirements and according to the agreement with your edX Champion.

@bradenmacdonald bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Feb 28, 2023
@bradenmacdonald bradenmacdonald changed the title New actions menu for editing components in Studio (behind waffle flag) [FC-0009] New actions menu for editing components in Studio (behind waffle flag) Feb 28, 2023
@Agrendalath
Copy link
Member

@bradenmacdonald, the code looks great, but there is a minor issue with the z-index of the menu:
image

@ali-hugo
Copy link

ali-hugo commented Mar 1, 2023

@bradenmacdonald Everything looks great to me!

Thanks for mentioning the lines between the menu options. It makes sense to keep things simple for now. We can always revisit this in the future if we find that we need to differentiate "delete" from the other options.

Thanks for the ping :)

@ormsbee
Copy link
Contributor

ormsbee commented Mar 2, 2023

FYI @jristau1984, @JAAkana, @mondiaz, @connorhaugh

@bradenmacdonald bradenmacdonald force-pushed the braden/component-actions-menu branch from a7457f4 to aa7f411 Compare March 3, 2023 00:47
@bradenmacdonald
Copy link
Contributor Author

@Agrendalath I fixed the z-index issue with f8f71f7cedb34d8f51386fa0774d0455dca7726e

Thanks for catching that.

Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

👍

  • I tested this: tested the menu locally
  • I read through the code
  • I checked for accessibility issues: n/a
  • Includes documentation: n/a
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

@ormsbee
Copy link
Contributor

ormsbee commented Mar 3, 2023

Maybe if you squash your commits and kick it again, the checks will run properly?

@bradenmacdonald bradenmacdonald force-pushed the braden/component-actions-menu branch from aa7f411 to 1f8e037 Compare March 3, 2023 17:24
@bradenmacdonald bradenmacdonald force-pushed the braden/component-actions-menu branch from 1f8e037 to ba9fde0 Compare March 3, 2023 17:27
@bradenmacdonald bradenmacdonald merged commit 6805654 into openedx:master Mar 3, 2023
@bradenmacdonald bradenmacdonald deleted the braden/component-actions-menu branch March 3, 2023 18:09
@openedx-webhooks
Copy link

@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

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

Labels

core committer 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.

7 participants