[FC-0059] feat: add copy to clipboard feature to library authoring #1197

rpenido · 2024-07-31T14:12:25Z

Description

This PR adds the feature to copy library components to the clipboard to be later pasted into a course or another library (in progress #1176)

Note: Drag and Drop blocks will be supported in a follow up task

Support information

Closes #1104

Depends on:

[FC-0059] feat: allow copy library v2 xblock edx-platform#35211

Testing Instructions

Create a new library v2
Add components to this library (Text, Problems or Video; Drag and Drop is NOT supported right now)
Select the "Copy to clipboard" option in the card menu
A toast must show "Component copied to clipboard"
Go to a course of your choice
Open a Unit
Paste the block and check the results
You can check the error toast trying to copy a Drag and Drop component.

Private ref: FAL-3769

openedx-webhooks · 2024-07-31T14:12:30Z

Thanks for the pull request, @rpenido!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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.

src/library-authoring/components/ComponentCard.test.tsx

codecov · 2024-08-02T13:39:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.90%. Comparing base (cba85ab) to head (b960fc5).
Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1197      +/-   ##
==========================================
+ Coverage   92.88%   92.90%   +0.01%     
==========================================
  Files         750      750              
  Lines       13468    13480      +12     
  Branches     2930     2927       -3     
==========================================
+ Hits        12510    12523      +13     
+ Misses        923      922       -1     
  Partials       35       35

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rpenido · 2024-08-02T14:11:16Z

src/search-manager/data/api.ts

@@ -101,13 +112,13 @@ export interface ContentHit {
   * - After that is the name and usage key of any parent Section/Subsection/Unit/etc.
   */
  breadcrumbs: [{ displayName: string }, ...Array<{ displayName: string, usageKey: string }>];
-  tags: Record<'taxonomy' | 'level0' | 'level1' | 'level2' | 'level3', string[]>;


We don't necessarily have these fields in a ContentHit. A hit without tags will have tag: {}. A hit with a level1 tag will have tags: { "taxonomy": ["Taxonomy"], level0: ["Taxonomy > Level0"], level1: ["Taxonomy > Level0 > Level1"] }

yusuf-musleh

@rpenido Great work on this! The code looks good here had a few nits. I also left a comment about an issue I faced in the edx-platform PR that needs to be addressed.

yusuf-musleh · 2024-08-04T05:11:13Z

src/library-authoring/components/ComponentCard.tsx

+        src={MoreVert}
+        iconAs={Icon}
+        variant="primary"
+        alt="component-card-menu-toggle" // FixMe: Add alt text


nit: Adding the alt intl text

Fixed here: ace4c25

yusuf-musleh · 2024-08-04T05:12:47Z

src/library-authoring/components/ComponentCard.tsx

+        <Dropdown.Item disabled>
+          {intl.formatMessage(messages.menuEdit)}
+        </Dropdown.Item>
+        <Dropdown.Item onClick={updateClipboardClick} data-testid="component-card-menu-copy-clipboard">


nit: Is it possible to get the dropdown item in the tests through other means instead of relying on the data-testid? Since that is generally discouraged and should be the last resort.

Unfortunately not. 😞
The card menu is a button without a label. Getting via getByRole('button', { name: '' }) could work, but I don't think it will have a better result in the test readability.

For the Dropdown.Item, I'm using the label. Removing the data-testid here as it is not being used: b960fc5

Got it, thanks for the clarification

openedx-webhooks · 2024-08-08T16:32:07Z

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

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

rpenido changed the title ~~feat: add copy to clipboard feature to library authoring~~ feat: add copy to clipboard feature to library authoring [FC-0059] Jul 31, 2024

rpenido changed the title ~~feat: add copy to clipboard feature to library authoring [FC-0059]~~ [FC-0059] feat: add copy to clipboard feature to library authoring Jul 31, 2024

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jul 31, 2024

rpenido force-pushed the rpenido/fal-3769-add-copy-to-clipboard-from-3-dot-menu branch from 2f2ef0d to 0dae5ae Compare July 31, 2024 20:37

yusuf-musleh reviewed Aug 2, 2024

View reviewed changes

src/library-authoring/components/ComponentCard.test.tsx Outdated Show resolved Hide resolved

feat: add copy to clipboard feature to library authoring

a12c942

rpenido force-pushed the rpenido/fal-3769-add-copy-to-clipboard-from-3-dot-menu branch from e2004d5 to a12c942 Compare August 2, 2024 13:30

rpenido mentioned this pull request Aug 2, 2024

[FC-0059] feat: allow copy library v2 xblock openedx/edx-platform#35211

Merged

rpenido commented Aug 2, 2024

View reviewed changes

rpenido requested a review from yusuf-musleh August 2, 2024 14:50

yusuf-musleh approved these changes Aug 4, 2024

View reviewed changes

rpenido added 2 commits August 6, 2024 10:08

fix: add alt text for menu

ace4c25

refactor: remove unused datatest-id

b960fc5

rpenido marked this pull request as ready for review August 6, 2024 13:13

rpenido requested a review from a team as a code owner August 6, 2024 13:13

rpenido requested a review from bradenmacdonald August 6, 2024 13:14

bradenmacdonald approved these changes Aug 8, 2024

View reviewed changes

bradenmacdonald merged commit bb88101 into openedx:master Aug 8, 2024
7 checks passed

bradenmacdonald deleted the rpenido/fal-3769-add-copy-to-clipboard-from-3-dot-menu branch August 8, 2024 16:32

ChrisChV mentioned this pull request Aug 13, 2024

feat: Library Home - Paste Content [FC-0059] #1187

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FC-0059] feat: add copy to clipboard feature to library authoring #1197

[FC-0059] feat: add copy to clipboard feature to library authoring #1197

rpenido commented Jul 31, 2024 •

edited

Loading

openedx-webhooks commented Jul 31, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading

rpenido Aug 2, 2024 •

edited

Loading

yusuf-musleh left a comment

yusuf-musleh Aug 4, 2024

rpenido Aug 6, 2024

yusuf-musleh Aug 4, 2024

rpenido Aug 6, 2024

yusuf-musleh Aug 7, 2024

openedx-webhooks commented Aug 8, 2024

[FC-0059] feat: add copy to clipboard feature to library authoring #1197

[FC-0059] feat: add copy to clipboard feature to library authoring #1197

Conversation

rpenido commented Jul 31, 2024 • edited Loading

Description

Support information

Testing Instructions

openedx-webhooks commented Jul 31, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

codecov bot commented Aug 2, 2024 • edited Loading

Codecov Report

rpenido Aug 2, 2024 • edited Loading

Choose a reason for hiding this comment

yusuf-musleh left a comment

Choose a reason for hiding this comment

yusuf-musleh Aug 4, 2024

Choose a reason for hiding this comment

rpenido Aug 6, 2024

Choose a reason for hiding this comment

yusuf-musleh Aug 4, 2024

Choose a reason for hiding this comment

rpenido Aug 6, 2024

Choose a reason for hiding this comment

yusuf-musleh Aug 7, 2024

Choose a reason for hiding this comment

openedx-webhooks commented Aug 8, 2024

rpenido commented Jul 31, 2024 •

edited

Loading

openedx-webhooks commented Jul 31, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading

rpenido Aug 2, 2024 •

edited

Loading