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: preserve library sidebar tab while switching items #1535

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Nov 28, 2024

Description

This PR makes the selected tab on the sidebar persist while selecting Components or Collections.

persist-tabs

More information

Testing instruction

  • Open the library authoring page, click on Components/Collections, and check the results
  • Note that if you click on a Collection (the default "Manage" tab is shown) and switch to a Component, the "Preview" tab will be shown (it will not persist). This is intended.

Private ref: FAL-3980

@rpenido rpenido requested a review from a team as a code owner November 28, 2024 15:27
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 28, 2024
@openedx-webhooks
Copy link

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.

Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.92%. Comparing base (abe68ac) to head (07e6790).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1535   +/-   ##
=======================================
  Coverage   92.91%   92.92%           
=======================================
  Files        1066     1066           
  Lines       20988    21000   +12     
  Branches     4538     4544    +6     
=======================================
+ Hits        19501    19514   +13     
- Misses       1414     1419    +5     
+ Partials       73       67    -6     

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

@bradenmacdonald
Copy link
Contributor

@rpenido I should have mentioned this to you earlier, but in #1499 we want to start putting a lot more of the state into URLs, so please keep that in mind while working on this. You don't have to implement it now, but try to implement this in a way that will make it easier to do that in the near future.

@rpenido rpenido force-pushed the rpenido/fal-3980-preserve-sidebar-tab-while-switching-items branch from e448d50 to 07e6790 Compare November 28, 2024 18:46
@rpenido
Copy link
Contributor Author

rpenido commented Nov 28, 2024

we want to start putting a lot more of the state into URLs

Act!
I'm moving the selected tab info to a state in our context, so I think this is going in the right direction.
Then, we can keep these states on the multiple contexts (after the context refactor) and update the URL accordingly (or store the states directly on the URL)

Copy link
Contributor

@DanielVZ96 DanielVZ96 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: (describe what you tested)
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

@ChrisChV ChrisChV merged commit 0771923 into openedx:master Dec 3, 2024
7 checks passed
@ChrisChV ChrisChV deleted the rpenido/fal-3980-preserve-sidebar-tab-while-switching-items branch December 3, 2024 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants