Add configuration settings to disable help panel, share panel and account menu #6783
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6783 +/- ##
=======================================
Coverage 99.43% 99.43%
=======================================
Files 270 270
Lines 10243 10268 +25
Branches 2450 2467 +17
=======================================
+ Hits 10185 10210 +25
Misses 58 58 ☔ View full report in Codecov by Sentry. |
Enable third-party authority owners to hide: 1. The Share / Import / Export panel 2. The Help / Version panel 3. The user account menu The initial use case is the exam-notes app where the Import/Export panel is hidden to address a concern around cheating and the Help/Version panel is hidden to remove unwanted links to external websites (our KB) in this context. The user account menu is hidden just to simplify the UI. Part of #6782.
The purpose of disabling the Help panel is to remove links to external websites which is necessary for the exam-notes app. Therefore we also need to remove the formatting help link from the annotation toolbar.
When the `enableHelpPanel` service configuration is set to `false`, don't show the tutorial/help panel to new users on first launch.
robertknight
force-pushed
the
hide-share-account-help-controls
branch
from
dcb88a7 to
2c866df
Compare
acelaya
reviewed
Jan 27, 2025
| enableAccountMenu?: boolean; | ||
|
|
||
| /** Enable or disable the Help / Version panel. */ | ||
| enableHelpPanel?: boolean; |
There was a problem hiding this comment.
I reckon we have some rst documentation that covers these options. Should we update it?
There was a problem hiding this comment.
We do, I'll update that in a separate PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add configuration options for annotation services to hide additional controls:
enableHelpPanelallows hiding the Help panel. This also disables automatic display of the tutorial on first run and removes the Help link in the annotation toolbar.enableShareImportExportPanelallows hiding the Share menu in the toolbar which contains the Share, Import and Export panelsenableAccountMenuallows hiding the user account menuWith all of these controls disabled, the client looks like this:
Fixes #6782.
This can be tested with the exam-notes app using https://github.com/hypothesis/exam-notes/pull/23.