Add show_banner trait to control the banner display (jupyter#243)

dalejung · Apr 25, 2023 · 255772c · 255772c
1 parent 960fa16
commit 255772c
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 3 deletions.
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -20,4 +20,4 @@ dependencies:
   - sphinxcontrib_github_alt
   - ipython_genutils
   - jupyter_server>=1.8
-  - notebook_shim>=0.1.0
+  - notebook_shim>=0.2.3
diff --git a/docs/source/frontend_config.rst b/docs/source/frontend_config.rst
@@ -89,3 +89,12 @@ taking various value depending on the page where the configuration is issued.
 ``<section>`` can take various values like ``notebook``, ``tree``, and
 ``editor``. A ``common`` section contains configuration settings shared by all
 pages.
+
+
+Persisting configuration settings
+---------------------------------
+
+A banner might be shown to users to inform them about news or updates. This 
+banner can be hidden launching the server with the show_banner trait.::
+
+   jupyter notebook --NotebookApp.show_banner=False
diff --git a/nbclassic/notebookapp.py b/nbclassic/notebookapp.py
@@ -120,6 +120,13 @@ class NotebookApp(
 
     default_url = Unicode("%s/tree" % nbclassic_path()).tag(config=True)
 
+    show_banner = Bool(
+        True,
+        help="""Whether the banner is displayed on the page.
+        By default, the banner is displayed.
+        """
+        ).tag(config=True)
+
     # Override the default open_Browser trait in ExtensionApp,
     # setting it to True.
     open_browser = Bool(
@@ -184,6 +191,7 @@ def _prepare_templates(self):
             base_dir, 'nbclassic/i18n'), fallback=True)
         self.jinja2_env.install_gettext_translations(nbui, newstyle=False)
         self.jinja2_env.globals.update(nbclassic_path=nbclassic_path)
+        self.jinja2_env.globals.update(show_banner=self.show_banner)
 
     def _link_jupyter_server_extension(self, serverapp):
         # Monkey-patch Jupyter Server's and nbclassic's static path list to include

diff --git a/nbclassic/static/base/js/namespace.js b/nbclassic/static/base/js/namespace.js
@@ -73,7 +73,7 @@ define(function(){
     // tree
     jglobal('SessionList','tree/js/sessionlist');
 
-    Jupyter.version = "0.5.5";
+    Jupyter.version = "0.6.0.dev0";
     Jupyter._target = '_blank';
 
     return Jupyter;

diff --git a/nbclassic/templates/page.html b/nbclassic/templates/page.html
@@ -138,6 +138,7 @@
 
 <div id="header" role="navigation" aria-label="{% trans %}Top Menu{% endtrans %}">
   <div  id="newsId" style="display: none">
+    {% if show_banner %}
     <div class="alert alert-info" role="alert">
       <div style="display: flex">
         <div>
@@ -155,6 +156,7 @@
         </div>
       </div>
     </div>
+    {% endif %}
   </div>
   <div id="header-container" class="container">
   <div id="ipython_notebook" class="nav navbar-brand"><a href="

diff --git a/setup.cfg b/setup.cfg
@@ -40,7 +40,7 @@ install_requires =
     ipython_genutils
     jupyter_server>=1.8
     nbformat
-    notebook_shim>=0.1.0
+    notebook_shim>=0.2.3
     nbconvert>=5
     nest-asyncio>=1.5
     ipykernel # bless IPython kernel for now