npm package: @jlab-enhanced/cell-toolbar
Description: A cell toolbar for JupyterLab.
Author: Frederic COLLONVAL
Latest version: 3.5.1

# jlab-enhanced-cell-toolbar

[![Extension status](https://img.shields.io/badge/status-ready-success "ready to be used")](https://jupyterlab-contrib.github.io/)
[![Github Actions Status](https://github.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/actions?query=workflow%3ABuild)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main?urlpath=lab/tree/Example.ipynb)
[![npm](https://img.shields.io/npm/v/@jlab-enhanced/cell-toolbar)](https://www.npmjs.com/package/@jlab-enhanced/cell-toolbar)
[![PyPI](https://img.shields.io/pypi/v/jlab-enhanced-cell-toolbar)](https://pypi.org/project/jlab-enhanced-cell-toolbar)
[![conda-forge](https://img.shields.io/conda/vn/conda-forge/jlab-enhanced-cell-toolbar)](https://anaconda.org/conda-forge/jlab-enhanced-cell-toolbar)

A cell toolbar for JupyterLab.

![Demonstration](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/default_look.gif)

Tags are displayed as read-only by default. You can click on the notebook toolbar button to start editing the tags on the
cell toolbars (as shown in the animation above).

There are some [Settings](#Settings) to tune the available buttons and the look of this extension.
For example, to show only the tags, you can set the following settings:

```json
{
    "helperButtons": null,
    "leftMenu": null,
    "rightMenu": null
}
```

## Requirements

-   JupyterLab >= 3.0

For JupyterLab 2.x, have look [there](https://github.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/tree/2.x).

## Install

```bash
pip install jlab-enhanced-cell-toolbar
```

or

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

## Uninstall

```bash
pip uninstall jlab-enhanced-cell-toolbar
```

or

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

## Settings

-   _defaultTags_: The list of default available tags. For example, using the following settings:

```json
{
    "defaultTags": ["hide", "slide"]
}
```

![default tags](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/default_tags.png)

-   _floatPosition_: Floating cell toolbar position in pixel.

For example, to obtain a cell toolbar partially overlapping the cell:

```json
{
    "floatPosition": {
        "right": 20,
        "top": 10
    }
}
```

![colab_toolbar](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/cell_toolbar_a_la_colab.png)


Another example, to put the toolbar inside the cell:

```json
{
    "floatPosition": {
        "right": 20,
        "top": 24
    }
}
```

![inside_cell_toolbar](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/toolbar_inside_cell.png)

> The `leftSpace` setting is ignored if this one is defined.

-   _helperButtons_: The list of helper buttons to display. For example, using the following settings:

```json
{
    "helperButtons": ["insert-cell-below", "run-cell-and-select-next"]
}
```

![helper buttons](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/helper_buttons.png)

-   _leftMenu_ and _rightMenu_: The action buttons to be displayed on the left and right of the cell toolbar. For example, using the following settings:

```json5
{
    "leftMenu": [
        {
            "command": "notebook:run-cell",
            "icon": "ui-components:run",
            // Will only display the item on code cells.
            "cellType": "code"
        }
    ],
    "rightMenu": [
        {
            "command": "notebook:delete-cell",
            "icon": "@jlab-enhanced/cell-toolbar:delete"
        }
    ]
}
```

![custom actions](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/menus.png)

> The default JupyterLab icon names can be found in the [ui-components](https://github.com/jupyterlab/jupyterlab/blob/master/packages/ui-components/src/icon/iconimports.ts) package.

-   _leftSpace_: The left empty white space width in pixel. For example, using the following settings:

```json
{
    "leftSpace": 48
}
```

![left_space](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/left_space.png)

> This setting is ignored if `floatPosition` is defined.

-   _showTags_: Whether to show (default) or not the tags widget. For example, using the following settings will hide the tags:

```json
{
    "showTags": false
}
```

![show_tags](https://raw.githubusercontent.com/jupyterlab-contrib/jlab-enhanced-cell-toolbar/main/docs/show_tags.png)

## Alternatives

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

-   [jupyterlab-show-cell-tags](https://github.com/mje-nz/jupyterlab-show-cell-tags)
-   [jupyterlab-colabinspired-codecellbtn](https://github.com/eddienko/jupyterlab-colabinspired-codecellbtn)
-   [jupyterlab-codecellbtn](https://github.com/ibqn/jupyterlab-codecellbtn)

## Contributing

### Development install

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

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# 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.

```bash
# 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:

```bash
jupyter lab build --minimize=False
```