[FC-0056][Plugin] Course outline sidebar #1344
Conversation
* feat: [AXIMST-572] create course-outline sidebar * fix: [AXIMST-572] after review
* feat: [AXIMST-617] display section and sequence sidebar level * fix: after review * fix: after review
* feat: [AXIMST-590] display units on sidebar, two tier layout * fix: expand prop-types * fix: after review
* feat: [AXIMST-578] display outline sidebar depends on feature flag * fix: after review
* feat: [AXIMST-635] display discussions sidebar by waffle flag * fix: after demo * fix: after review * fix: upstream failed tests
* feat: [AXIMST-641] display special exam label and unit lock icon * fix: after backend changes * fix: error with entrance exam * fix: after review
* feat: make sidebar fixed on scroll and add tests * fix: extend tests * fix: tests * fix: codecov * fix: after review
…plete subsection (#28) * fix: [AXIMST-748] update outline sidebar for locked subsection on complete subsection * fix: tests * fix: after review
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @ihor-romaniuk! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. This is currently a draft pull request. When it is ready for our review and all tests are green, click "Ready for Review", or remove "WIP" from the title, as appropriate. |
ihor-romaniuk
force-pushed
the
romaniuk/sidebar-main-plugin
branch
2 times, most recently
from
72f08f9
to
e0b25b1
Compare
ihor-romaniuk
force-pushed
the
romaniuk/sidebar-main-plugin
branch
from
e0b25b1
to
7345a26
Compare
ihor-romaniuk
force-pushed
the
romaniuk/sidebar-main-plugin
branch
from
ba20193
to
ae0ca19
Compare
| export const COURSE_OUTLINE_SIDEBAR_ID = 'COURSE_OUTLINE_SIDEBAR'; | ||
|
|
||
| export const extendSidebars = (key, value) => { | ||
| SIDEBARS[key] = value; | ||
| }; | ||
|
|
||
| export const checkIsSidebarAvailable = (id) => Object.keys(SIDEBARS).includes(id); |
There was a problem hiding this comment.
Through the close interaction of the Outline Sidebar plugin's display with the application's functionality display (sidebar display order, breadcrumb display, etc.), we should have a way to check for an active Outline Sidebar plugin.
Perhaps it should be reworked and placed in a global state and have a list of connected plugins.
| // Import plugin-specific sass files | ||
| @import "../plugins/index.scss"; |
There was a problem hiding this comment.
We needed to be able to include style files from plugins with the ability to use the Paragon system, so we decided to add one entry point for all plugin styles.
There was a problem hiding this comment.
Thank you for taking on this work! My first big request for a change, however, is the following:
Any feature that should be on by default - which is the case with this sidebar - should not be a plugin. It can be implemented as default content inside a plugin slot, but users should not have to change their configuration to get the corresponding functionality.
In other words, I would like to see all components and corresponding data functions moved out of plugins, but with one caveat: we should create an example plugin that disables the functionality being introduced, and document how to use it. This means we'll also have to test that this "disable plugin" actually works.
|
@arbrandes I created a new PR #1349, which will wrap insertion points of triggers for calling the navigation sidebar, added sidebar accessibility checks to hide breadcrumbs when a sidebar is present, and added an example of a standard configuration in |
Does that PR replace this one? Asking because I'd like to understand if we need to keep this PR open. |
itsjeyd
added
the
waiting on author
|
OSPR management note: This is part of a set of PRs for implementing Phase 1 changes for the FC-0056 project. We can consider it approved from the product perspective. |
|
@ihor-romaniuk Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future. |
|
The main PR about the course outline sidebar functionality #1349 |
itsjeyd
removed
the
waiting on author
Settings
Description
This pull request adds an important feature to our platform: displaying a navigation sidebar within a given course.
Note: Initial solution without using
Frontend Plugin Framework#1342Design
https://www.figma.com/file/gew5tORDX4Q7wxOS8vjqZu/side-nav-OEX?type=design&node-id=318-3234&mode=design&t=rBe1ToNYP8RY6QOp-0
Testing instructions