Skip to main content

A cell toolbar for JupyterLab.

Project description

jlab-enhanced-cell-toolbar

Github Actions Status Binder npm PyPI conda-forge

A cell toolbar for JupyterLab.

Demonstration

There are some Settings to tune the available buttons and the look of this extension.

Requirements

  • JupyterLab >= 3.0

For JupyterLab 2.x, have look there.

Install

pip install jlab-enhanced-cell-toolbar

or

conda install -c conda-forge jlab-enhanced-cell-toolbar

Uninstall

pip uninstall jlab-enhanced-cell-toolbar

or

conda remove -c conda-forge jlab-enhanced-cell-toolbar

Settings

  • defaultTags: The list of default available tags. For example, using the following settings:
{
    "defaultTags": ["hide", "slide"]
}

default tags

  • leftMenu and rightMenu: The action buttons to be displayed on the left and right of the cell toolbar. For example, using the following settings:
{
    "leftMenu": [
        {
          "command": "notebook:run-cell",
          "icon": "ui-components:run"
        }
    ],
    "rightMenu": [
        {
          "command": "notebook:delete-cell",
          "icon": "@jlab-enhanced/cell-toolbar:delete"
        }
    ]
}

custom actions

The default JupyterLab icon names can be found in the ui-components package.

  • leftSpace: The left empty white space width in pixel. For example, using the following settings:
{
    "leftSpace": 48
}

left_space

Alternatives

Don't like what you see here? Try these other approaches:

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jlab_enhanced_cell_toolbar directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

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

jlab-enhanced-cell-toolbar-3.1.0.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jlab-enhanced-cell-toolbar-3.1.0.tar.gz.

File metadata

  • Download URL: jlab-enhanced-cell-toolbar-3.1.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for jlab-enhanced-cell-toolbar-3.1.0.tar.gz
Algorithm Hash digest
SHA256 ee1dff1d9c90a4f752d0e1adef8703ea0480f35ea1d20c87c8e8619e50214520
MD5 1a18d38e88a5ac9e41394e3cb258370e
BLAKE2b-256 3aecb1a92b6dc96d2c4178ff7d5c73062b46015ec00d336667134ed98024db66

See more details on using hashes here.

File details

Details for the file jlab_enhanced_cell_toolbar-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: jlab_enhanced_cell_toolbar-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for jlab_enhanced_cell_toolbar-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59188c8847bdce387252f8397ddb632e47b09c708e4ac700cd7a19f5ed1d548c
MD5 03ad967712031b01c16086f63dc40fa3
BLAKE2b-256 980b0695d94b72460c14290e2db42b2ff260bb50218b08d9476c1928c18e6e77

See more details on using hashes here.

Supported by

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