Skip to main content

Jupyterlab extension that makes the tabs coloured (using pastel colours) to help you find tab when many of them are opened. Colour persists between refreshes

Project description

jupyterlab_colourful_tab_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO Donate PayPal

[!TIP] This extension is part of the stellars_jupyterlab_extensions metapackage. Install all Stellars extensions at once: pip install stellars_jupyterlab_extensions

A JupyterLab extension that applies pastel colours to tabs for visual identification when many tabs are open.

Coloured tabs make it easy to identify different notebooks and files at a glance.

Right-click any tab to select a colour from the "Tab Colour" submenu.

Features

Assign colours to tabs via right-click context menu for easy visual identification when working with multiple notebooks and files.

Colour options:

  • Red, Orange, Yellow, Green, Blue, Purple
  • Pastel shades optimised for both light and dark themes

Key features:

  • Right-click any tab to assign a colour from the "Set Tab Colour" submenu
  • Selected (active) tab shows a distinct shade of its colour so it stands out from other coloured tabs
  • Colours persist across browser refreshes via localStorage
  • Notebook toolbar matches the active tab colour
  • Automatic cleanup when tabs are closed

Yes, this is yet another mass-produced JupyterLab extension that does one trivially simple thing. We are almost embarrassed by how utterly unremarkable it is - just some CSS classes and a context menu. But someone had to do it, and here we are. You're welcome.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_colourful_tab_extension

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_colourful_tab_extension

Extension API

Other extensions can tint a widget's tab programmatically via the public IColourfulTabs token.

  • Import the token from jupyterlab_colourful_tab_extension and request it as an optional (or requires) plugin dependency
  • Call setColour(widget, colourId) where colourId is one of rose, peach, lemon, mint, sky, lavender, or null to clear
  • The tint rides the widget's Lumino title.className, so it survives tab re-renders and reordering with no DOM querying
  • Programmatic colours are independent of the right-click menu's localStorage-persisted colours
import {
  JupyterFrontEnd,
  JupyterFrontEndPlugin
} from '@jupyterlab/application';
import { IColourfulTabs } from 'jupyterlab_colourful_tab_extension';

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my_extension:plugin',
  autoStart: true,
  optional: [IColourfulTabs],
  activate: (app: JupyterFrontEnd, colourfulTabs: IColourfulTabs | null) => {
    if (colourfulTabs) {
      colourfulTabs.setColour(widget, 'sky');
    }
  }
};

[!IMPORTANT] The consumer must declare jupyterlab_colourful_tab_extension as a shared singleton in its package.json jupyterlab.sharedPackages block (with "bundled": false). Without it, module federation serves two copies of the token and the optional dependency silently resolves to null.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_colourful_tab_extension-1.1.12.tar.gz (592.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_colourful_tab_extension-1.1.12.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_colourful_tab_extension-1.1.12.tar.gz
Algorithm Hash digest
SHA256 0066a4b28d707f5c5e2e7c08f9960b2a2fbc33cf9f8ffb39062caa4c56e0a461
MD5 4ab620bdfea57d368d85416e0cee466b
BLAKE2b-256 4af4bcbfc4036578cd4139c97bb75c4339110a0f044d68ba0b37f784fe4ecfab

See more details on using hashes here.

File details

Details for the file jupyterlab_colourful_tab_extension-1.1.12-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_colourful_tab_extension-1.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 e901242b0617a925a54df42ec781193a9afd54bd7f1a1f00e706d932541e6b9f
MD5 329c942f9b350d59cdc1ebf6ec45c0a2
BLAKE2b-256 1d87448d77dae3b26d6b6e1a246555ebe7fca8dfba31ffec96ab95cb8513044d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page