JupyterLab Top Bar

Monorepo to experiment with the top bar space in JupyterLab.

Similar to the status bar, the top bar can be used to place a few indicators and optimize the overall space.

Inspired by Gnome Shell Top Bar indicators.

Extensions

• jupyterlab-topbar-extension: generic extension to expose the top bar area
• jupyterlab-topbar-text: add and edit custom text
• jupyterlab-system-monitor: show system metrics (memory usage)
• jupyterlab-logout: add a "Log Out" button
• jupyterlab-theme-toggle: switch between the Light and Dark themes

Try it online

Try the extensions in your browser with Binder:

Installation

JupyterLab 3.0

# container extension
pip install jupyterlab-topbar

# to install the topbar-text extension
pip install jupyterlab-topbar-text

JupyterLab 1.x and 2.x

# container extension
jupyter labextension install jupyterlab-topbar-extension

# system metrics
jupyter labextension install jupyterlab-system-monitor
pip install jupyter-resource-usage

# custom text in the top bar
jupyter labextension install jupyterlab-topbar-text

# add a logout button
jupyter labextension install jupyterlab-logout

# theme toggling extension
jupyter labextension install jupyterlab-theme-toggle

All-in-one install:

jupyter labextension install jupyterlab-topbar-extension \
                             jupyterlab-system-monitor \
                             jupyterlab-topbar-text \
                             jupyterlab-logout \
                             jupyterlab-theme-toggle

Development

# create a new conda environment
conda create -n jupyterlab-topbar -c conda-forge jupyterlab nodejs -y
conda activate jupyterlab-topbar

# Install dependencies
jlpm

# Install the package in development mode
pip install -e .

# Link your development version of the extension with JupyterLab
jlpm run develop

# For the jupyterlab-topbar-text extension
jlpm run link

# Rebuild extension TypeScript source after making changes
jlpm run build

Uninstall

pip uninstall jupyterlab-topbar