https://github.com/jupyterlab-contrib/jupyterlab-quickopen
Quickly open a file in JupyterLab by typing part of its name
https://github.com/jupyterlab-contrib/jupyterlab-quickopen
jupyter jupyterlab jupyterlab-extension
Last synced: about 1 month ago
JSON representation
Quickly open a file in JupyterLab by typing part of its name
- Host: GitHub
- URL: https://github.com/jupyterlab-contrib/jupyterlab-quickopen
- Owner: jupyterlab-contrib
- License: bsd-3-clause
- Created: 2018-12-04T01:00:58.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-09T19:20:14.000Z (6 months ago)
- Last Synced: 2024-10-12T09:22:48.768Z (6 months ago)
- Topics: jupyter, jupyterlab, jupyterlab-extension
- Language: TypeScript
- Homepage:
- Size: 898 KB
- Stars: 76
- Watchers: 5
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- best-of-jupyter - GitHub - 46% open · ⏱️ 08.12.2024): (JupyterLab Extensions)
README
# jupyterlab-quickopen
[](https://jupyterlab-contrib.github.io/)
[](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-quickopen/main?urlpath=lab%2Ftree%2Fbinder%2Ftutorial.ipynb)
Quickly open a file in JupyterLab by typing part of its name
https://github.com/user-attachments/assets/77567c89-ad52-4be8-b0e4-612700353242
## Compatibility
- Python >=3.8.x
- [JupyterLab](https://github.com/jupyterlab/jupyterlab) >=3.2
- [Jupyter Server](https://github.com/jupyter/jupyter_server) >=2.4
- Configurations where notebook documents and other files reside on a filesystem local to the
Jupyter Server (which is the the default), not remote storage (e.g., S3)
## Usage
After installing the extension, you can open the quick open panel by pressing `Ctrl Shift P` (or `Cmd P` on macOS). Start typing the name of the file you want to open, and the quick open panel will show a list of files that match the text you've typed.
https://github.com/user-attachments/assets/77567c89-ad52-4be8-b0e4-612700353242
The extension also works in Jupyter Notebook 7:
https://github.com/user-attachments/assets/49147847-2b98-4016-8a11-5d0e8d9749e1
## Install
To install the extension with `pip`:
```bash
pip install jupyterlab-quickopen
```
With `conda` / `mamba`:
```bash
conda install -c conda-forge jupyterlab-quickopen
```
## Configure
### Using a custom Keyboard Shortcut
The default keyboard shortcut for opening the quickopen panel is `Accel Ctrl P`.
You can assign your own keyboard shortcut to show the quickopen panel at any time. Open the keyboard editor
by clicking _Settings → Advanced Settings Editor → Keyboard Shortcuts_. Then enter JSON in
the _User Overrides_ text area like the following, adjusting the `keys` value to assign the shortcut
of your choosing:
```json
{
"shortcuts": [
{
"command": "quickopen:activate",
"keys": ["Accel Ctrl P"],
"selector": "body",
"title": "Activate Quick Open",
"category": "Main Area"
}
]
}
```
### Patterns to Exclude
You can control which files to exclude from the quick open list using the Jupyter Server settings,
JupyterLab settings, or both.
On the server side, use the `ContentsManager.allow_hidden` and/or `ContentsManager.hide_globs`
settings. See the
[documentation about Jupyter Server options](https://jupyter-server.readthedocs.io/en/latest/operators/configuring-extensions.html)
for details.
In the JupyterLab web app, open the _Settings_ menu, click the _Advanced Settings Editor_ option,
select the _Quick Open_ item in the _Raw View_ sidebar, and enter JSON in the _User Overrides_ text
area to override the default values.
### 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 jupyterlab_quickopen directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_quickopen
# Rebuild extension Typescript source after making changes
jlpm 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 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 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
```
### Releasing
See [RELEASE](RELEASE.md)
### Acknowledgements
This extension was originally created by [Peter Parente](https://github.com/parente) and was
later moved to the `jupyterlab-contrib` GitHub organization.