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

Shareable URLs for library components and searches #1499

Open
Tracked by #1509
bradenmacdonald opened this issue Nov 13, 2024 · 2 comments
Open
Tracked by #1509

Shareable URLs for library components and searches #1499

bradenmacdonald opened this issue Nov 13, 2024 · 2 comments
Labels
enhancement Relates to new features or improvements to existing features

Comments

@bradenmacdonald
Copy link
Contributor

As an author working with content libraries, I want to easily share any component in a library with other people on my team, by copying the URL from my browser and sending it to them.

As an author working with content libraries, I want to easily share any search results with other people on my team, by copying the URL from my browser and sending it to them.

As an author working with content libraries, I want to bookmark a search in my browser and return to it at any time, with the same filters and keywords applied.

As an author of a content library with public read access, I want to easily share any component in a library with any authors on the same Open edX instance, by copying the URL from my browser and sending it to them.


Update the router for content libraries v2 so that:

  1. Filters (e.g. type, tags, and keywords) are reflected in the URL. Changes to the search parameters should replace the current URL, so that pressing back will go to the previous page rather than just undoing the last filter (which would be really annoying if you try to go back after changing the filters/keywords many times).
  2. The sidebar is also reflected in the URL, including the current tab if applicable.
  3. It should be possible to send a link to the "manage team" page.

Example (it doesn't have to use this exact format though): http://apps.local.openedx.io:2001/authoring/library/lib:OpenCraftX:ALPHA/collection/c-123/?type=text,problem&q=keyword&tags=foo,bar&sidebar=collection&sidebar_collection_id=c-123&sidebar_tab=details

With this example, changes to the query string should be done by replacing the current location (not added to history, not affecting the back button), and changes to the non-query string part should be done by updating the location (added to history, will integrate with back button).

@pomegranited
Copy link
Contributor

@bradenmacdonald

It should be possible to send a link to the "manage team" page.

The "manage team" page is currently in a modal.. should it be moved to its own page?

@bradenmacdonald
Copy link
Contributor Author

@pomegranited Not necessarily - you can easily use a react-router <Route> to wrap a modal and have the modal shown/hidden based on the URL. If we later move it to its own page, we can adjust the routes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Relates to new features or improvements to existing features
Projects
Status: In grooming
Development

No branches or pull requests

2 participants