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

feat: add to collection menu item functionality [FC-0062] #1413

Merged
merged 8 commits into from
Oct 22, 2024

Conversation

navinkarkera
Copy link
Contributor

Description

Clicking on Add to collection menu item will display sidebar with Manage tab open and Tags section collapsed for better visibility of collections section. Also, refactors library context to replace three separate state variables with single object type

Supporting information

Testing instructions

  • Click on Add to Collection menu item in components card as well as in the sidebar, it should open up sidebar with Manage tab active and tags section collapsed.gg

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

openedx-webhooks commented Oct 21, 2024

Thanks for the pull request, @navinkarkera!

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.

Copy link

codecov bot commented Oct 21, 2024

Codecov Report

Attention: Patch coverage is 95.12195% with 4 lines in your changes missing coverage. Please review.

Project coverage is 93.11%. Comparing base (841aede) to head (07567b3).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...y-authoring/component-info/ComponentManagement.tsx 88.88% 2 Missing ⚠️
...library-authoring/component-info/ComponentInfo.tsx 91.66% 1 Missing ⚠️
...ary-authoring/component-info/ManageCollections.tsx 90.90% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1413      +/-   ##
==========================================
- Coverage   93.12%   93.11%   -0.01%     
==========================================
  Files        1051     1051              
  Lines       20171    20207      +36     
  Branches     4207     4297      +90     
==========================================
+ Hits        18784    18816      +32     
- Misses       1327     1328       +1     
- Partials       60       63       +3     

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

@navinkarkera navinkarkera marked this pull request as ready for review October 21, 2024 15:53
@navinkarkera navinkarkera requested a review from a team as a code owner October 21, 2024 15:53
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Thanks, nice refactor! I think this is close, just a suggested simplification and a missing feature:

Instead of seeing this:
Screenshot 2024-10-21 at 12 15 53 PM

Could you make it so we see this (as if "Manage Collection" is already clicked) when using the "Add to collection..." menu?
Screenshot 2024-10-21 at 12 16 16 PM

@@ -61,35 +74,57 @@ const ComponentManagement = () => {
/>
{[true, 'true'].includes(getConfig().ENABLE_TAGGING_TAXONOMY_PAGES)
&& (
<Collapsible
defaultOpen
Copy link
Contributor

Choose a reason for hiding this comment

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

Was it not possible to simply set defaultOpen={sidebarComponentInfo?.collapse !== 'tags'} ? That would be a lot simpler than making the collapsible into a controlled component.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, it only works when the component is first mounted.

@bradenmacdonald
Copy link
Contributor

Also looks like there is a conflict now.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 21, 2024
Replace three separate state variables with single object type
Clicking on `Add to collection` menu item will display sidebar with
`Manage` tab open and `Tags` section collapsed for better visibility of
collections section.
Possible issue: mockResult being modified by multiple tests in parallel
@navinkarkera
Copy link
Contributor Author

@bradenmacdonald Done. Had to play with some useEffects to get consistent behaviour.

@bradenmacdonald
Copy link
Contributor

@navinkarkera Nice! Seems to work well. Normally significant usage of useEffect is a bad sign so we might look for ways to refactor this in the future. But seems fine.

Copy link
Contributor

@bradenmacdonald bradenmacdonald 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, including testing it with the keyboard, and didn't find any remaining issues.

@bradenmacdonald bradenmacdonald merged commit 675e02f into openedx:master Oct 22, 2024
8 checks passed
@bradenmacdonald bradenmacdonald deleted the navin/add-collection-menu branch October 22, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants