├── style ├── index.css ├── index.js ├── icons │ └── md │ │ ├── baseline-star-24px.svg │ │ ├── baseline-star_border-24px.svg │ │ └── LICENSE └── base.css ├── .eslintignore ├── requirements.txt ├── .prettierignore ├── .prettierrc ├── run_tests.sh ├── pyproject.toml ├── .gitignore ├── install.json ├── tests ├── test_folder │ └── test_file.rtf ├── test_file.py └── test_folder.py ├── jupyterlab_favorites ├── __init__.py └── _version.py ├── src ├── svg.d.ts ├── icons.ts ├── utils.ts ├── token.ts ├── manager.ts ├── components.tsx └── index.ts ├── MANIFEST.in ├── tsconfig.json ├── .travis.yml ├── .eslintrc.js ├── schema └── favorites.json ├── LICENSE ├── .github └── workflows │ └── build.yml ├── setup.py ├── README.md └── package.json /style/index.css: -------------------------------------------------------------------------------- 1 | @import 'base.css'; -------------------------------------------------------------------------------- /style/index.js: -------------------------------------------------------------------------------- 1 | import './base.css'; 2 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | coverage 4 | **/*.d.ts 5 | tests 6 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | jupyter 2 | jupyterlab >= 3.0.0 3 | selenium >= 3.0.0 4 | pytest 5 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | **/node_modules 3 | **/lib 4 | **/package.json 5 | jupyterlab-favorites 6 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "singleQuote": true, 3 | "trailingComma": "none", 4 | "arrowParens": "avoid" 5 | } 6 | -------------------------------------------------------------------------------- /run_tests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | jupyter lab --port=8889 --NotebookApp.token='' & 3 | child_pid=$! 4 | pytest 5 | kill $child_pid 6 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["jupyter_packaging~=0.7.9", "jupyterlab~=3.0", "setuptools>=40.8.0", "wheel"] 3 | build-backend = "setuptools.build_meta" 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.bundle.* 2 | lib/ 3 | node_modules/ 4 | *.egg-info/ 5 | .ipynb_checkpoints 6 | *.DS_STORE 7 | build/ 8 | dist/ 9 | *.pyc 10 | tsconfig.tsbuildinfo 11 | geckodriver.log 12 | -------------------------------------------------------------------------------- /install.json: -------------------------------------------------------------------------------- 1 | { 2 | "packageManager": "python", 3 | "packageName": "jupyterlab-favorites", 4 | "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab-favorites" 5 | } 6 | -------------------------------------------------------------------------------- /tests/test_folder/test_file.rtf: -------------------------------------------------------------------------------- 1 | {\rtf1\ansi\ansicpg1252\cocoartf1671\cocoasubrtf600 2 | {\fonttbl\f0\fswiss\fcharset0 Helvetica;} 3 | {\colortbl;\red255\green255\blue255;} 4 | {\*\expandedcolortbl;;} 5 | \margl1440\margr1440\vieww10800\viewh8400\viewkind0 6 | \pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0 7 | 8 | \f0\fs24 \cf0 testing file} -------------------------------------------------------------------------------- /jupyterlab_favorites/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | import json 3 | from pathlib import Path 4 | 5 | from ._version import __version__ 6 | 7 | HERE = Path(__file__).parent.resolve() 8 | 9 | with (HERE / "labextension" / "package.json").open() as fid: 10 | data = json.load(fid) 11 | 12 | def _jupyter_labextension_paths(): 13 | return [{ 14 | "src": "labextension", 15 | "dest": data["name"] 16 | }] 17 | 18 | -------------------------------------------------------------------------------- /src/svg.d.ts: -------------------------------------------------------------------------------- 1 | // Copyright (c) Jupyter Development Team. 2 | // Distributed under the terms of the Modified BSD License. 3 | 4 | // including this file in a package allows for the use of import statements 5 | // with svg files. Example: `import xSvg from 'path/xSvg.svg'` 6 | 7 | // for use with raw-loader in Webpack. 8 | // The svg will be imported as a raw string 9 | 10 | declare module '*.svg' { 11 | const value: string; 12 | export default value; 13 | } 14 | -------------------------------------------------------------------------------- /src/icons.ts: -------------------------------------------------------------------------------- 1 | import { LabIcon } from '@jupyterlab/ui-components'; 2 | import starSvgstr from '../style/icons/md/baseline-star-24px.svg'; 3 | import starBorderSvgstr from '../style/icons/md/baseline-star_border-24px.svg'; 4 | 5 | export const filledStarIcon = new LabIcon({ 6 | name: 'jupyterlab-favorites:filledStar', 7 | svgstr: starSvgstr, 8 | }); 9 | 10 | export const starIcon = new LabIcon({ 11 | name: 'jupyterlab-favorites:star', 12 | svgstr: starBorderSvgstr, 13 | }); 14 | -------------------------------------------------------------------------------- /style/icons/md/baseline-star-24px.svg: -------------------------------------------------------------------------------- 1 | 5 | 9 | 10 | 13 | 17 | -------------------------------------------------------------------------------- /style/icons/md/baseline-star_border-24px.svg: -------------------------------------------------------------------------------- 1 | 5 | 6 | 9 | 13 | -------------------------------------------------------------------------------- /jupyterlab_favorites/_version.py: -------------------------------------------------------------------------------- 1 | import json 2 | from pathlib import Path 3 | 4 | __all__ = ["__version__"] 5 | 6 | def _fetchVersion(): 7 | HERE = Path(__file__).parent.resolve() 8 | 9 | for settings in HERE.rglob("package.json"): 10 | try: 11 | with settings.open() as f: 12 | return json.load(f)["version"] 13 | except FileNotFoundError: 14 | pass 15 | 16 | raise FileNotFoundError(f"Could not find package.json under dir {HERE!s}") 17 | 18 | __version__ = _fetchVersion() 19 | 20 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.md 3 | include pyproject.toml 4 | include jupyter-config/jupyterlab-favorites.json 5 | 6 | include package.json 7 | include install.json 8 | include ts*.json 9 | include yarn.lock 10 | 11 | graft jupyterlab_favorites/labextension 12 | 13 | # Javascript files 14 | graft src 15 | graft style 16 | prune **/node_modules 17 | prune lib 18 | 19 | # Patterns to exclude from any directory 20 | global-exclude *~ 21 | global-exclude *.pyc 22 | global-exclude *.pyo 23 | global-exclude .git 24 | global-exclude .ipynb_checkpoints 25 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "allowSyntheticDefaultImports": true, 4 | "composite": true, 5 | "declaration": true, 6 | "esModuleInterop": true, 7 | "incremental": true, 8 | "jsx": "react", 9 | "module": "esnext", 10 | "moduleResolution": "node", 11 | "noEmitOnError": true, 12 | "noImplicitAny": true, 13 | "noUnusedLocals": true, 14 | "preserveWatchOutput": true, 15 | "resolveJsonModule": true, 16 | "outDir": "lib", 17 | "rootDir": "src", 18 | "strict": true, 19 | "strictNullChecks": false, 20 | "target": "es2017", 21 | "types": [] 22 | }, 23 | "include": ["src/*"] 24 | } 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | 2 | language: python 3 | dist: bionic 4 | cache: pip 5 | env: 6 | global: 7 | - MOZ_HEADLESS=1 8 | addons: 9 | firefox: "78.0.1" 10 | sudo: required 11 | services: 12 | - xvfb 13 | before_install: 14 | - nvm use 12.13.1 15 | - wget https://github.com/mozilla/geckodriver/releases/download/v0.26.0/geckodriver-v0.26.0-linux64.tar.gz 16 | - sudo tar -xzf geckodriver-v0.26.0-linux64.tar.gz -C /usr/bin 17 | - sudo chmod a+x /usr/bin/geckodriver 18 | install: 19 | - "pip install -r requirements.txt" 20 | - npm install selenium-webdriver@^3.0.0 21 | - node --version 22 | - npm install 23 | - npm run build 24 | - jupyter labextension install . 25 | 26 | script: 27 | - jupyter labextension list 28 | - jupyter lab --port=8889 --NotebookApp.token='' & 29 | - pytest 30 | 31 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | import { LabIcon } from '@jupyterlab/ui-components'; 2 | import { filledStarIcon, starIcon } from './icons'; 3 | 4 | export function getFavoritesIcon(filled: boolean): LabIcon { 5 | return filled ? filledStarIcon : starIcon; 6 | } 7 | 8 | export function getName(path: string) { 9 | let name = ''; 10 | const parts = path.split('/'); 11 | if (parts.length > 0) { 12 | name = parts[parts.length - 1]; 13 | } 14 | return name; 15 | } 16 | 17 | export function getPinnerActionDescription(showRemove: boolean) { 18 | return `${showRemove ? 'Remove' : 'Add'} Favorite`; 19 | } 20 | 21 | export function mergePaths(root: string, path: string) { 22 | if (root.endsWith('/')) { 23 | root = root.slice(0, -1); 24 | } 25 | if (path.endsWith('/')) { 26 | path = path.slice(1); 27 | } 28 | return `${root}/${path}`; 29 | } 30 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | extends: [ 3 | 'eslint:recommended', 4 | 'plugin:@typescript-eslint/eslint-recommended', 5 | 'plugin:@typescript-eslint/recommended', 6 | 'plugin:prettier/recommended' 7 | ], 8 | parser: '@typescript-eslint/parser', 9 | parserOptions: { 10 | project: 'tsconfig.json', 11 | sourceType: 'module' 12 | }, 13 | plugins: ['@typescript-eslint'], 14 | rules: { 15 | '@typescript-eslint/naming-convention': [ 16 | 'error', 17 | { 18 | 'selector': 'interface', 19 | 'format': ['PascalCase'], 20 | 'custom': { 21 | 'regex': '^I[A-Z]', 22 | 'match': true 23 | } 24 | } 25 | ], 26 | '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }], 27 | '@typescript-eslint/no-explicit-any': 'off', 28 | '@typescript-eslint/no-namespace': 'off', 29 | '@typescript-eslint/no-use-before-define': 'off', 30 | '@typescript-eslint/quotes': [ 31 | 'error', 32 | 'single', 33 | { avoidEscape: true, allowTemplateLiterals: false } 34 | ], 35 | curly: ['error', 'all'], 36 | eqeqeq: 'error', 37 | 'prefer-arrow-callback': 'error' 38 | } 39 | }; 40 | -------------------------------------------------------------------------------- /src/token.ts: -------------------------------------------------------------------------------- 1 | export namespace PluginIDs { 2 | export const favorites = 'jupyterlab-favorites'; 3 | } 4 | 5 | export namespace CommandIDs { 6 | export const addOrRemoveFavorite = `${PluginIDs.favorites}:add-or-remove-favorite`; 7 | export const removeFavorite = `${PluginIDs.favorites}:remove-favorite`; 8 | export const openFavorite = `${PluginIDs.favorites}:open-favorite`; 9 | export const toggleFavoritesWidget = `${PluginIDs.favorites}:toggle-favorites-widget`; 10 | export const restoreDefaults = `${PluginIDs.favorites}:restore-defaults`; 11 | export const clearFavorites = `${PluginIDs.favorites}:clear-favorites`; 12 | } 13 | 14 | export namespace SettingIDs { 15 | export const themes = '@jupyterlab/apputils-extension:themes'; 16 | export const favorites = `${PluginIDs.favorites}:favorites`; 17 | } 18 | 19 | export namespace IFavorites { 20 | export type Favorite = { 21 | root: string; 22 | path: string; 23 | contentType: string; 24 | iconLabel?: string; 25 | name?: string; 26 | default?: boolean; 27 | hidden?: boolean; 28 | }; 29 | 30 | export type FavoritesSettings = { 31 | favorites?: Array; 32 | showWidget?: boolean; 33 | }; 34 | } 35 | -------------------------------------------------------------------------------- /schema/favorites.json: -------------------------------------------------------------------------------- 1 | { 2 | "jupyter.lab.setting-icon": "jupyterlab-favorites:filledStar", 3 | "jupyter.lab.setting-icon-label": "Favorites", 4 | "title": "Favorites", 5 | "description": "Favorites settings.", 6 | "type": "object", 7 | "additionalProperties": false, 8 | "properties": { 9 | "favorites": { 10 | "title": "Favorites", 11 | "description": "The list of favorites.", 12 | "items": { "$ref": "#/definitions/favorite" }, 13 | "type": "array", 14 | "default": [] 15 | }, 16 | "showWidget": { 17 | "title": "Show Widget", 18 | "description": "Toggles the favorites widget above the filebrowser breadcrumbs.", 19 | "type": "boolean", 20 | "default": true 21 | } 22 | }, 23 | "definitions": { 24 | "favorite": { 25 | "properties": { 26 | "root": { "type": "string" }, 27 | "path": { "type": "string" }, 28 | "contentType": { "type": "string" }, 29 | "iconLabel": { "type": "string" }, 30 | "name": { "type": "string" }, 31 | "default": { "type": "boolean" }, 32 | "hidden": { "type": "boolean" } 33 | }, 34 | "required": ["root", "path"], 35 | "type": "object" 36 | } 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2019, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. 2 | 3 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 4 | 5 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 6 | 7 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 8 | 9 | 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 10 | 11 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- /style/base.css: -------------------------------------------------------------------------------- 1 | .jp-Favorites-pinner { 2 | position: absolute; 3 | right: 6px; 4 | bottom: -59px; 5 | cursor: pointer; 6 | } 7 | 8 | /* Increase the right margin from 12px to allow room for pinner */ 9 | .jp-BreadCrumbs.jp-FileBrowser-crumbs { 10 | margin: 4px 26px 4px 12px; 11 | } 12 | 13 | .jp-Favorites-BreadCrumbs-Icon svg { 14 | border-radius: var(--jp-border-radius); 15 | cursor: pointer; 16 | height: 16px; 17 | margin: 0px 2px; 18 | padding: 0px 2px; 19 | vertical-align: middle; 20 | width: 16px; 21 | } 22 | 23 | .jp-Favorites-header, 24 | .jp-FileBrowser-header { 25 | padding: 8px 0 8px 12px; 26 | color: var(--jp-ui-font-color1); 27 | font-size: var(--jp-ui-font-size0); 28 | font-weight: 600; 29 | text-transform: uppercase; 30 | border-bottom: solid var(--jp-border-width) var(--jp-border-color2); 31 | letter-spacing: 1px; 32 | } 33 | 34 | .jp-Favorites-container { 35 | overflow: auto; 36 | max-height: 120px; 37 | } 38 | 39 | .jp-Favorites { 40 | flex: 0 0 auto; 41 | overflow: visible; 42 | } 43 | 44 | .jp-Favorites-item { 45 | display: flex; 46 | flex-direction: row; 47 | padding: 4px 12px; 48 | cursor: pointer; 49 | } 50 | 51 | .jp-Favorites-item:hover { 52 | background-color: var(--jp-layout-color2); 53 | } 54 | 55 | .jp-Favorites-itemIcon svg { 56 | display: block; 57 | height: 16px; 58 | margin: 0 5px; 59 | width: 16px; 60 | } 61 | 62 | .jp-Favorites-itemText { 63 | flex: 1 0 64px; 64 | white-space: nowrap; 65 | overflow: hidden; 66 | text-overflow: ellipsis; 67 | -webkit-user-select: none; 68 | -moz-user-select: none; 69 | -ms-user-select: none; 70 | user-select: none; 71 | } -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: master 6 | pull_request: 7 | branches: '*' 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v2 15 | - name: Install node 16 | uses: actions/setup-node@v1 17 | with: 18 | node-version: '12.x' 19 | - name: Install Python 20 | uses: actions/setup-python@v2 21 | with: 22 | python-version: '3.7' 23 | architecture: 'x64' 24 | 25 | 26 | - name: Setup pip cache 27 | uses: actions/cache@v2 28 | with: 29 | path: ~/.cache/pip 30 | key: pip-3.7-${{ hashFiles('package.json') }} 31 | restore-keys: | 32 | pip-3.7- 33 | pip- 34 | 35 | - name: Get yarn cache directory path 36 | id: yarn-cache-dir-path 37 | run: echo "::set-output name=dir::$(yarn cache dir)" 38 | - name: Setup yarn cache 39 | uses: actions/cache@v2 40 | id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) 41 | with: 42 | path: ${{ steps.yarn-cache-dir-path.outputs.dir }} 43 | key: yarn-${{ hashFiles('**/yarn.lock') }} 44 | restore-keys: | 45 | yarn- 46 | 47 | - name: Install dependencies 48 | run: python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9 49 | - name: Build the extension 50 | run: | 51 | jlpm 52 | jlpm run eslint:check 53 | python -m pip install . 54 | 55 | jupyter labextension list 2>&1 | grep -ie "jupyterlab-favorites.*OK" 56 | python -m jupyterlab.browser_check 57 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | jupyterlab-favorites setup 3 | """ 4 | import json 5 | from pathlib import Path 6 | 7 | from jupyter_packaging import ( 8 | create_cmdclass, 9 | install_npm, 10 | ensure_targets, 11 | combine_commands, 12 | skip_if_exists 13 | ) 14 | import setuptools 15 | 16 | HERE = Path(__file__).parent.resolve() 17 | 18 | # The name of the project 19 | name = "jupyterlab-favorites" 20 | python_name = name.replace("-", "_") 21 | 22 | lab_path = (HERE / python_name / "labextension") 23 | 24 | # Representative files that should exist after a successful build 25 | jstargets = [ 26 | str(lab_path / "package.json"), 27 | ] 28 | 29 | package_data_spec = { 30 | name: ["*"], 31 | } 32 | 33 | labext_name = "jupyterlab-favorites" 34 | 35 | data_files_spec = [ 36 | ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"), 37 | ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"), 38 | ] 39 | 40 | cmdclass = create_cmdclass("jsdeps", 41 | package_data_spec=package_data_spec, 42 | data_files_spec=data_files_spec 43 | ) 44 | 45 | js_command = combine_commands( 46 | install_npm(HERE, build_cmd="build:prod", npm=["jlpm"]), 47 | ensure_targets(jstargets), 48 | ) 49 | 50 | is_repo = (HERE / ".git").exists() 51 | if is_repo: 52 | cmdclass["jsdeps"] = js_command 53 | else: 54 | cmdclass["jsdeps"] = skip_if_exists(jstargets, js_command) 55 | 56 | long_description = (HERE / "README.md").read_text() 57 | 58 | # Get the package info from package.json 59 | pkg_json = json.loads((HERE / "package.json").read_bytes()) 60 | 61 | setup_args = dict( 62 | name=python_name, 63 | version=pkg_json["version"], 64 | url=pkg_json["homepage"], 65 | author=pkg_json["author"], 66 | description=pkg_json["description"], 67 | license=pkg_json["license"], 68 | long_description=long_description, 69 | long_description_content_type="text/markdown", 70 | cmdclass=cmdclass, 71 | packages=setuptools.find_packages(), 72 | install_requires=[ 73 | "jupyterlab~=3.0", 74 | ], 75 | zip_safe=False, 76 | include_package_data=True, 77 | python_requires=">=3.6", 78 | platforms="Linux, Mac OS X, Windows", 79 | keywords=["Jupyter", "JupyterLab", "JupyterLab3"], 80 | classifiers=[ 81 | "License :: OSI Approved :: BSD License", 82 | "Programming Language :: Python", 83 | "Programming Language :: Python :: 3", 84 | "Programming Language :: Python :: 3.6", 85 | "Programming Language :: Python :: 3.7", 86 | "Programming Language :: Python :: 3.8", 87 | "Programming Language :: Python :: 3.9", 88 | "Framework :: Jupyter", 89 | ], 90 | ) 91 | 92 | 93 | if __name__ == "__main__": 94 | setuptools.setup(**setup_args) 95 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # This repo has been forked to jupyterlab-contrib, where you can find the current version. 2 | [https://github.com/jupyterlab-contrib/jupyterlab-favorites](https://github.com/jupyterlab-contrib/jupyterlab-favorites) 3 | 4 | # jupyterlab-favorites 5 | 6 | [![Build Status](https://travis-ci.com/NERSC/jupyterlab-favorites.svg?branch=master)](https://travis-ci.com/NERSC/jupyterlab-favorites)[![Conda Version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-favorites.svg)](https://anaconda.org/conda-forge/jupyterlab-favorites) 7 | 8 | Add the ability to save favorite folders to JupyterLab for quicker browsing. 9 | 10 | ## Installation 11 | 12 | ### Prerequisites 13 | 14 | * JupyterLab 3.x 15 | 16 | ### Install from pypi 17 | 18 | ``` 19 | python -m pip install "jupyterlab-favorites==3.0.0" 20 | ``` 21 | 22 | ### Install from github 23 | 24 | ``` 25 | python -m pip install "git+https://github.com/NERSC/jupyterlab-favorites@v3.0.0#egg=jupyterlab-favorites" 26 | ``` 27 | 28 | ### Install from conda 29 | 30 | ``` 31 | conda install jupyterlab-favorites 32 | ``` 33 | 34 | ### Install locally from a git checkout 35 | ``` 36 | git clone https://github.com/NERSC/jupyterlab-favorites.git 37 | cd jupyterlab-favorites 38 | pip install . 39 | ``` 40 | 41 | ## Development 42 | 43 | ### Prerequisites 44 | 45 | * An active `conda` environment with JupyterLab 3.x installed 46 | 47 | ### Install locally from a git checkout 48 | ```bash 49 | git clone https://github.com/NERSC/jupyterlab-favorites.git 50 | cd jupyterlab-favorites 51 | pip install -ve . 52 | ``` 53 | This copies the frontend code for the extension into JupyterLab. 54 | 55 | To keep the source code synced with JupyterLab, you can run the following: 56 | ```bash 57 | jupyter labextension develop --overwrite . 58 | ``` 59 | 60 | To rebuild the extension manually after each change:: 61 | ```bash 62 | jlpm run build 63 | ``` 64 | 65 | To automatically rebuild after each change, run in a separate terminal: 66 | ```bash 67 | jlpm run watch 68 | ``` 69 | 70 | ## Older JupyterLab versions 71 | 72 | ### JupyterLab v2 Support 73 | 74 | NPM install 75 | ```bash 76 | jupyter labextension install jupyterlab-favorites@2.0.0 77 | ``` 78 | 79 | ### Jupyterlab v1 Support 80 | 81 | Via NPM: 82 | ```{bash} 83 | jupyter labextension install jupyterlab-favorites@1.0.0 84 | ``` 85 | 86 | Or use the tagged 1.0.0 release at: 87 | https://github.com/NERSC/jupyterlab-favorites/tree/v1.0.0 88 | 89 | ## Testing 90 | Download Firefox browser if not already installed: https://www.mozilla.org/en-US/firefox/new/ 91 | 92 | Install Selenium: 93 | ```bash 94 | conda install -c conda-forge selenium 95 | ``` 96 | Install Pytest: 97 | ```bash 98 | conda install -c anaconda pytest 99 | ``` 100 | 101 | Change directory to this repo after cloning 102 | ```bash 103 | cd yourfolder/jupyterlab-favorites 104 | ``` 105 | Running test script: 106 | ```bash 107 | ./run_tests.sh 108 | ``` 109 | This will open jupyter lab and run available tests. 110 | Note: You will need to run in a clean jupyter environment (without existing favorites files) 111 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "jupyterlab-favorites", 3 | "version": "3.0.0", 4 | "description": "Add the ability to save favorite folders to JupyterLab for quicker browsing", 5 | "keywords": [ 6 | "jupyter", 7 | "jupyterlab", 8 | "jupyterlab-extension" 9 | ], 10 | "homepage": "https://github.com/NERSC/jupyterlab-favorites", 11 | "bugs": { 12 | "url": "https://github.com/NERSC/jupyterlab-favorites/issues" 13 | }, 14 | "license": "BSD-3-Clause", 15 | "author": "Trevor Slaton", 16 | "files": [ 17 | "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}", 18 | "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}", 19 | "schema/*.json", 20 | "style/index.js" 21 | ], 22 | "main": "lib/index.js", 23 | "types": "lib/index.d.ts", 24 | "style": "style/index.css", 25 | "sideEffects": [ 26 | "style/**/*", 27 | "style/index.js" 28 | ], 29 | "repository": { 30 | "type": "git", 31 | "url": "https://github.com/NERSC/jupyterlab-favorites.git" 32 | }, 33 | "scripts": { 34 | "build": "jlpm run build:lib && jlpm run build:labextension:dev", 35 | "build:labextension": "jupyter labextension build .", 36 | "build:labextension:dev": "jupyter labextension build --development True .", 37 | "build:lib": "tsc", 38 | "build:prod": "jlpm run build:lib && jlpm run build:labextension", 39 | "clean": "jlpm run clean:lib", 40 | "clean:all": "jlpm run clean:lib && jlpm run clean:labextension", 41 | "clean:labextension": "rimraf jupyterlab_favorites/labextension", 42 | "clean:lib": "rimraf lib tsconfig.tsbuildinfo", 43 | "eslint": "eslint . --ext .ts,.tsx --fix", 44 | "eslint:check": "eslint . --ext .ts,.tsx", 45 | "install:extension": "jupyter labextension develop --overwrite .", 46 | "prepare": "jlpm run clean && jlpm run build:prod", 47 | "watch": "run-p watch:src watch:labextension", 48 | "watch:labextension": "jupyter labextension watch .", 49 | "watch:src": "tsc -w" 50 | }, 51 | "dependencies": { 52 | "@jupyterlab/application": "^3.0.4", 53 | "@jupyterlab/apputils": "^3.0.3", 54 | "@jupyterlab/coreutils": "^5.0.2", 55 | "@jupyterlab/docregistry": "^3.0.4", 56 | "@jupyterlab/filebrowser": "^3.0.4", 57 | "@jupyterlab/mainmenu": "^3.0.3", 58 | "@jupyterlab/services": "^6.0.3", 59 | "@jupyterlab/settingregistry": "^3.0.2", 60 | "@jupyterlab/ui-components": "^3.0.3", 61 | "@lumino/algorithm": "^1.3.3", 62 | "@lumino/commands": "^1.12.0", 63 | "@lumino/signaling": "^1.4.3", 64 | "@lumino/widgets": "^1.16.1" 65 | }, 66 | "devDependencies": { 67 | "@jupyterlab/builder": "^3.0.3", 68 | "@typescript-eslint/eslint-plugin": "^4.8.1", 69 | "@typescript-eslint/parser": "^4.8.1", 70 | "eslint": "^7.14.0", 71 | "eslint-config-prettier": "^6.15.0", 72 | "eslint-plugin-prettier": "^3.1.4", 73 | "npm-run-all": "^4.1.5", 74 | "prettier": "^2.1.1", 75 | "rimraf": "^3.0.2", 76 | "typescript": "~4.1.3" 77 | }, 78 | "jupyterlab": { 79 | "extension": true, 80 | "schemaDir": "schema", 81 | "outputDir": "jupyterlab_favorites/labextension" 82 | }, 83 | "prettier": { 84 | "singleQuote": true 85 | }, 86 | "styleModule": "style/index.js" 87 | } 88 | -------------------------------------------------------------------------------- /tests/test_file.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | import time 3 | import json 4 | from selenium import webdriver 5 | from selenium.webdriver.common.by import By 6 | from selenium.webdriver.common.action_chains import ActionChains 7 | from selenium.webdriver.support import expected_conditions 8 | from selenium.webdriver.support.wait import WebDriverWait 9 | from selenium.webdriver.common.keys import Keys 10 | from selenium.webdriver.common.desired_capabilities import DesiredCapabilities 11 | 12 | 13 | class TestAddfavs(): 14 | def setup_method(self, method): 15 | self.driver = webdriver.Firefox() 16 | self.vars = {} 17 | 18 | def teardown_method(self, method): 19 | self.driver.quit() 20 | 21 | def test_addfavs(self): 22 | self.driver.get("http://localhost:8889/lab/") 23 | self.driver.implicitly_wait(30) 24 | 25 | # src_file = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[2]/div[4]/ul/li[2]") 26 | # actions = ActionChains(self.driver) 27 | # actions.double_click(src_file).perform() #works 28 | tests = self.driver.find_element(By.XPATH, "//span[contains(text(),'tests')]") 29 | self.driver.implicitly_wait(30) 30 | actions = ActionChains(self.driver) 31 | self.driver.implicitly_wait(30) 32 | actions.double_click(tests).perform() 33 | self.driver.implicitly_wait(15) 34 | 35 | test_folder = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_folder')]") 36 | actions = ActionChains(self.driver) 37 | actions.double_click(test_folder).perform() 38 | self.driver.implicitly_wait(15) 39 | 40 | # test_folder_fav = self.driver.find_element(By.XPATH,"/html/body/div/div[3]/div[2]/div[1]/div[6]/div[2]/div/div/span") 41 | # actions = ActionChains(self.driver) 42 | # actions.click(test_folder_fav).perform() 43 | test_file = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_file.rtf')]") 44 | actions = ActionChains(self.driver) 45 | actions.context_click(test_file).perform() 46 | self.driver.implicitly_wait(100) 47 | 48 | elem_fav = self.driver.find_element(By.XPATH, "//div[contains(text(),'Add Favorite')]") 49 | actions.click(elem_fav).perform() 50 | self.driver.implicitly_wait(100) 51 | 52 | # added_fav_text = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div[2]/div/span[2]") 53 | # added_fav_text = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[6]/div[2]/div/div[2]/div") 54 | # assert added_fav_text.text == "test_folder" 55 | 56 | 57 | 58 | #file_fav = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div[2]/div") 59 | file_fav = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_file.rtf')]") 60 | assert file_fav.text == "test_file.rtf" 61 | 62 | #file_removefav = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div[2]") 63 | file_removefav = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_file.rtf')]") 64 | self.driver.implicitly_wait(100) 65 | actions = ActionChains(self.driver) 66 | actions.context_click(file_removefav).perform() 67 | actions.send_keys(Keys.ARROW_DOWN).perform() 68 | actions.send_keys(Keys.ENTER).perform() 69 | self.driver.implicitly_wait(100) 70 | 71 | #home_folder = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[6]/div[3]/span[1]") 72 | home_folder = self.driver.find_element_by_css_selector(".jp-BreadCrumbs-home > svg:nth-child(1)") 73 | self.driver.implicitly_wait(100) 74 | actions = ActionChains(self.driver) 75 | actions.click(home_folder).perform() 76 | 77 | 78 | 79 | 80 | if __name__ == '__main__': 81 | setup_method() 82 | test_addfavs() 83 | teardown_method() -------------------------------------------------------------------------------- /tests/test_folder.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | import time 3 | import json 4 | from selenium import webdriver 5 | from selenium.webdriver.common.by import By 6 | from selenium.webdriver.common.action_chains import ActionChains 7 | from selenium.webdriver.support import expected_conditions 8 | from selenium.webdriver.support.wait import WebDriverWait 9 | from selenium.webdriver.common.keys import Keys 10 | from selenium.webdriver.common.desired_capabilities import DesiredCapabilities 11 | 12 | class TestAddfavs(): 13 | def setup_method(self, method): 14 | self.driver = webdriver.Firefox() 15 | self.vars = {} 16 | 17 | def teardown_method(self, method): 18 | self.driver.quit() 19 | 20 | def test_addfavs(self): 21 | self.driver.get("http://localhost:8889/lab/") 22 | self.driver.implicitly_wait(100) 23 | WebDriverWait(self.driver, 1000) 24 | 25 | # src_file = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[2]/div[4]/ul/li[2]") 26 | # actions = ActionChains(self.driver) 27 | # actions.double_click(src_file).perform() #works 28 | tests = self.driver.find_element(By.XPATH, "//span[contains(text(),'tests')]") 29 | WebDriverWait(self.driver, 200) 30 | actions = ActionChains(self.driver) 31 | WebDriverWait(self.driver, 200) 32 | self.driver.implicitly_wait(5000) 33 | actions.double_click(tests).perform() 34 | self.driver.implicitly_wait(15) 35 | 36 | test_folder = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_folder')]") 37 | actions = ActionChains(self.driver) 38 | actions.double_click(test_folder).perform() 39 | self.driver.implicitly_wait(15) 40 | 41 | #test_folder_fav = self.driver.find_element(By.XPATH,"/html/body/div/div[3]/div[2]/div[1]/div[6]/div[2]/div/div/span") 42 | #test_folder_fav = self.driver.find_element(By.XPATH,"/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div/span") 43 | WebDriverWait(self.driver, 200) 44 | #test_folder_fav = self.driver.find_element(By.XPATH,"/html/body/div/div[3]/div[2]/div[1]/div[6]/div[2]/div/div") 45 | test_folder_fav = self.driver.find_element_by_css_selector(".jp-Favorites-pinner") 46 | #test_folder_fav = self.driver.find_elements_by_class_name("jp-Favorites-BreadCrumbs-Icon") 47 | actions = ActionChains(self.driver) 48 | actions.click(test_folder_fav).perform() 49 | 50 | # added_fav_text = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div[2]/div/span[2]") 51 | #added_fav_text = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div[2]/div/span[2]") 52 | #added_fav_text = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div/span") 53 | added_fav_text = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_folder')]") 54 | assert added_fav_text.text == "test_folder" 55 | WebDriverWait(self.driver, 200) 56 | 57 | #added_fav_elem = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[2]/div/div[2]/div/span[2]") 58 | added_fav_elem = self.driver.find_element(By.XPATH, "//span[contains(text(),'test_folder')]") 59 | WebDriverWait(self.driver, 5000) 60 | actions = ActionChains(self.driver) 61 | actions.click(added_fav_elem).perform() 62 | # actions.context_click(added_fav_elem).perform() 63 | # WebDriverWait(self.driver, 5000) 64 | # actions.send_keys(Keys.ARROW_DOWN).perform() 65 | # WebDriverWait(self.driver, 500) 66 | # actions.send_keys(Keys.ENTER).perform() 67 | 68 | #home_folder = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[5]/div[3]/span[1]") 69 | # home_folder = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[6]/div[3]/span[1]") 70 | # self.driver.implicitly_wait(15) 71 | # actions = ActionChains(self.driver) 72 | # actions.click(home_folder).perform() 73 | 74 | 75 | 76 | # def test_removefavs(self): 77 | # added_fav_elem = self.driver.find_element(By.XPATH, "/html/body/div/div[3]/div[2]/div[1]/div[2]/div[2]/div/div[1]/div[3]") 78 | # actions = ActionChains(self.driver) 79 | # actions.context_click(added_fav_elem).perform() 80 | # actions.send_keys(Keys.ARROW_DOWN).perform() 81 | # actions.send_keys(Keys.ENTER).perform() 82 | 83 | if __name__ == '__main__': 84 | setup_method() 85 | test_addfavs() 86 | # test_removefavs() 87 | teardown_method() -------------------------------------------------------------------------------- /src/manager.ts: -------------------------------------------------------------------------------- 1 | import { Menu } from '@lumino/widgets'; 2 | import { Signal } from '@lumino/signaling'; 3 | import { ISettingRegistry } from '@jupyterlab/settingregistry'; 4 | import { CommandRegistry } from '@lumino/commands'; 5 | import { ContentsManager } from '@jupyterlab/services'; 6 | import { IFavorites, SettingIDs, CommandIDs } from './token'; 7 | import { getName } from './utils'; 8 | 9 | export class FavoritesManager { 10 | favoritesMenu: Menu; 11 | favoritesChanged = new Signal>(this); 12 | visibilityChanged = new Signal(this); 13 | 14 | constructor( 15 | serverRoot: string, 16 | commands: CommandRegistry, 17 | settings: ISettingRegistry, 18 | contents: ContentsManager 19 | ) { 20 | this._serverRoot = serverRoot; 21 | this._commandRegistry = commands; 22 | this._settingsRegistry = settings; 23 | this._contentsManager = contents; 24 | // This menu will appear in the File menu 25 | this.favoritesMenu = new Menu({ commands: this._commandRegistry }); 26 | this.favoritesMenu.title.label = 'Favorites'; 27 | // Listen for updates to settings 28 | this._settingsRegistry.pluginChanged.connect(async (_, pluginName) => { 29 | if (pluginName === SettingIDs.favorites) { 30 | // Triggers favoritesChanged, so showWidget will also get loaded 31 | this.loadFavorites(); 32 | } 33 | }); 34 | // Listen for update to own favorites 35 | this.favoritesChanged.connect(async (_) => { 36 | this._showWidget = await this.loadShowWidget(); 37 | this.syncFavoritesMenu(); 38 | this.visibilityChanged.emit(this.isVisible()); 39 | }); 40 | } 41 | 42 | get serverRoot(): string { 43 | return this._serverRoot; 44 | } 45 | 46 | get favorites(): Array { 47 | const favorites = this._favorites || []; 48 | return favorites.filter((f) => f.root === this.serverRoot); 49 | } 50 | 51 | set favorites(favorites: Array) { 52 | this._favorites = favorites; 53 | this.favoritesChanged.emit(this.visibleFavorites()); 54 | } 55 | 56 | async addFavorite(favorite: IFavorites.Favorite) { 57 | const favorites = this._favorites.slice(); 58 | const index = favorites.findIndex( 59 | (f) => f.root === this.serverRoot && f.path === favorite.path 60 | ); 61 | const existing = favorites[index]; 62 | if (existing) { 63 | if (existing.hidden) { 64 | existing.hidden = false; 65 | this.saveSettings({ favorites }); 66 | } 67 | } else { 68 | this.saveSettings({ favorites: favorites.concat([favorite]) }); 69 | } 70 | } 71 | 72 | clearFavorites() { 73 | this.clearFavoritesOrRestoreDefaults(true); 74 | } 75 | 76 | init() { 77 | this.loadFavorites(); 78 | } 79 | 80 | isVisible() { 81 | return this._showWidget && this.visibleFavorites().length > 0; 82 | } 83 | 84 | hasFavorite(path: string) { 85 | return this.visibleFavorites().findIndex((f) => f.path === path) >= 0; 86 | } 87 | 88 | handleClick(favorite: IFavorites.Favorite) { 89 | this._commandRegistry.execute(CommandIDs.openFavorite, { favorite }); 90 | } 91 | 92 | async overwriteSettings(settings: IFavorites.FavoritesSettings) { 93 | const newSettings = JSON.stringify(settings, null, 4); 94 | this._settingsRegistry.upload(SettingIDs.favorites, newSettings); 95 | } 96 | 97 | async removeFavorite(path: string) { 98 | const favorites = this._favorites.slice(); 99 | const index = favorites.findIndex( 100 | (f) => f.root === this.serverRoot && f.path === path 101 | ); 102 | const existing = favorites[index]; 103 | if (existing) { 104 | if (existing.default) { 105 | existing.hidden = true; 106 | } else { 107 | favorites.splice(index, 1); 108 | } 109 | this.saveSettings({ favorites }); 110 | } 111 | } 112 | 113 | async removeFavoriteIfInvalid(favorite: IFavorites.Favorite) { 114 | this._contentsManager 115 | .get(favorite.path, { content: false }) 116 | .catch((error) => { 117 | if (error.response.status === 404) { 118 | this.removeFavorite(favorite.path); 119 | } 120 | }); 121 | } 122 | 123 | restoreDefaults() { 124 | this.clearFavoritesOrRestoreDefaults(false); 125 | } 126 | 127 | async saveSettings(settings: IFavorites.FavoritesSettings) { 128 | if (settings.favorites !== undefined) { 129 | await this._settingsRegistry.set( 130 | SettingIDs.favorites, 131 | 'favorites', 132 | settings.favorites 133 | ); 134 | } 135 | if (settings.showWidget !== undefined) { 136 | this._settingsRegistry.set( 137 | SettingIDs.favorites, 138 | 'showWidget', 139 | settings.showWidget 140 | ); 141 | } 142 | } 143 | 144 | visibleFavorites(): IFavorites.Favorite[] { 145 | return this.favorites 146 | .filter((f) => !f.hidden) 147 | .sort((a, b) => { 148 | if (a.contentType === b.contentType) { 149 | return getName(a.path) <= getName(b.path) ? -1 : 1; 150 | } else { 151 | return a.contentType < b.contentType ? -1 : 1; 152 | } 153 | }); 154 | } 155 | 156 | private clearFavoritesOrRestoreDefaults(hidden: boolean) { 157 | const favorites = this._favorites; 158 | const defaultFavorites: Array = []; 159 | favorites.forEach((favorite) => { 160 | if (favorite.default) { 161 | favorite.hidden = hidden; 162 | defaultFavorites.push(favorite); 163 | } 164 | }); 165 | this.overwriteSettings({ favorites: defaultFavorites }); 166 | } 167 | 168 | private async loadFavorites() { 169 | const favorites = await this._settingsRegistry.get( 170 | SettingIDs.favorites, 171 | 'favorites' 172 | ); 173 | this.favorites = favorites.composite as IFavorites.Favorite[]; 174 | } 175 | 176 | private async loadShowWidget() { 177 | const showWidgetSettings = await this._settingsRegistry.get( 178 | SettingIDs.favorites, 179 | 'showWidget' 180 | ); 181 | return showWidgetSettings.composite as boolean; 182 | } 183 | 184 | private syncFavoritesMenu() { 185 | this.favoritesMenu.clearItems(); 186 | const visibleFavorites = this.visibleFavorites(); 187 | if (visibleFavorites.length > 0) { 188 | visibleFavorites.forEach((favorite) => { 189 | this.favoritesMenu.addItem({ 190 | command: CommandIDs.openFavorite, 191 | args: { favorite }, 192 | }); 193 | }); 194 | this.favoritesMenu.addItem({ type: 'separator' }); 195 | } 196 | const showWidget = this._showWidget; 197 | this.favoritesMenu.addItem({ 198 | command: CommandIDs.toggleFavoritesWidget, 199 | args: { showWidget }, 200 | }); 201 | this.favoritesMenu.addItem({ 202 | command: CommandIDs.restoreDefaults, 203 | }); 204 | this.favoritesMenu.addItem({ 205 | command: CommandIDs.clearFavorites, 206 | }); 207 | } 208 | 209 | private _settingsRegistry: ISettingRegistry; 210 | private _commandRegistry: CommandRegistry; 211 | private _contentsManager: ContentsManager; 212 | private _favorites: IFavorites.Favorite[]; 213 | private _serverRoot: string; 214 | private _showWidget: boolean; 215 | } 216 | -------------------------------------------------------------------------------- /src/components.tsx: -------------------------------------------------------------------------------- 1 | import { ReactWidget, UseSignal } from '@jupyterlab/apputils'; 2 | import { FileBrowser } from '@jupyterlab/filebrowser'; 3 | import { folderIcon, LabIcon, fileIcon } from '@jupyterlab/ui-components'; 4 | import { Signal } from '@lumino/signaling'; 5 | import * as React from 'react'; 6 | import { FavoritesManager } from './manager'; 7 | import { IFavorites } from './token'; 8 | import { 9 | getFavoritesIcon, 10 | getName, 11 | getPinnerActionDescription, 12 | mergePaths, 13 | } from './utils'; 14 | 15 | /** 16 | * The parent node class for Favorites content. 17 | */ 18 | const FAVORITE_MAIN_CLASS = 'jp-Favorites'; 19 | 20 | /** 21 | * The class name for the node containing the Favorites label that appears above 22 | * favorited items when there are favorited items. When there are no favorited items, 23 | * this class is hidden. 24 | */ 25 | const FAVORITE_HEADER_CLASS = 'jp-Favorites-header'; 26 | 27 | /** 28 | * The class name for the node that contains favorited items. 29 | */ 30 | const FAVORITE_CONTAINER_CLASS = 'jp-Favorites-container'; 31 | 32 | /** 33 | * The class name for the parent node of a favorited item that appears in the favorited items section. 34 | */ 35 | const FAVORITE_ITEM_CLASS = 'jp-Favorites-item'; 36 | 37 | /** 38 | * The class name for the icon that appears to the left of the favorited item. 39 | */ 40 | const FAVORITE_ITEM_ICON_CLASS = 'jp-Favorites-itemIcon'; 41 | 42 | /** 43 | * The class name for the text that describes the favorited item. 44 | */ 45 | const FAVORITE_ITEM_TEXT_CLASS = 'jp-Favorites-itemText'; 46 | 47 | /** 48 | * The class name for the FileBrowser label that appears above FileBrowser content when there are favorited items. 49 | * When there are no favorited items, this class is hidden. 50 | */ 51 | const FILEBROWSER_HEADER_CLASS = 'jp-FileBrowser-header'; 52 | 53 | /** 54 | * The class name for the node containing the FileBrowser BreadCrumbs favorite icon. This node 55 | * is also responsible for click actions on the icon. 56 | */ 57 | const FAVORITE_ITEM_PINNER_CLASS = 'jp-Favorites-pinner'; 58 | 59 | /** 60 | * The class name for the the BreadCrumbs favorite icon. 61 | * This icon is overlaid on top of the FileBrowser content via CSS. 62 | */ 63 | const FAVORITE_BREADCRUMB_ICON_CLASS = 'jp-Favorites-BreadCrumbs-Icon'; 64 | 65 | namespace types { 66 | export type FavoriteComponentProps = { 67 | favorite: IFavorites.Favorite; 68 | handleClick: (favorite: IFavorites.Favorite) => void; 69 | }; 70 | 71 | export interface IFavoritesBreadCrumbProps { 72 | currentPath: string; 73 | manager: FavoritesManager; 74 | handleClick: (path: string) => void; 75 | } 76 | } 77 | 78 | const FavoriteComponent = (props: types.FavoriteComponentProps) => { 79 | const { favorite, handleClick } = props; 80 | let displayName = getName(favorite.path); 81 | if (favorite.name) { 82 | displayName = favorite.name; 83 | } 84 | 85 | let FavoriteIcon: LabIcon; 86 | if (favorite.iconLabel) { 87 | FavoriteIcon = LabIcon.resolve({ icon: favorite.iconLabel }); 88 | } else { 89 | // Fallback for favorite using the v1 setting definition 90 | if (favorite.contentType === 'directory') { 91 | FavoriteIcon = folderIcon; 92 | } else { 93 | FavoriteIcon = fileIcon; 94 | } 95 | } 96 | 97 | return ( 98 |
{ 102 | handleClick(favorite); 103 | }} 104 | > 105 | 106 | {displayName} 107 |
108 | ); 109 | }; 110 | 111 | const FavoritesBreadCrumbs: React.FunctionComponent = ( 112 | props: types.IFavoritesBreadCrumbProps 113 | ): JSX.Element => { 114 | if (props.currentPath) { 115 | const FavoriteIcon = getFavoritesIcon( 116 | props.manager.hasFavorite(props.currentPath) 117 | ); 118 | return ( 119 |
props.handleClick(props.currentPath)} 125 | > 126 | 130 |
131 | ); 132 | } 133 | return null; 134 | }; 135 | 136 | export class FavoritesWidget extends ReactWidget { 137 | private manager: FavoritesManager; 138 | private filebrowser: FileBrowser; 139 | private pathChanged = new Signal(this); 140 | 141 | constructor(manager: FavoritesManager, filebrowser: FileBrowser) { 142 | super(); 143 | this.manager = manager; 144 | this.filebrowser = filebrowser; 145 | this.addClass(FAVORITE_MAIN_CLASS); 146 | 147 | this.filebrowser.model.pathChanged.connect((_, changedArgs) => { 148 | const path = changedArgs.newValue; 149 | this.pathChanged.emit(path); 150 | }); 151 | } 152 | 153 | handlePinnerClick(path: string) { 154 | const shouldRemove = this.manager.hasFavorite(path); 155 | if (shouldRemove) { 156 | this.manager.removeFavorite(path); 157 | } else { 158 | const favorite = { 159 | root: this.manager.serverRoot, 160 | contentType: 'directory', 161 | iconLabel: folderIcon.name, 162 | path, 163 | } as IFavorites.Favorite; 164 | this.manager.addFavorite(favorite); 165 | } 166 | } 167 | 168 | render() { 169 | return ( 170 | 175 | {( 176 | manager: FavoritesManager, 177 | visibleFavorites: Array 178 | ) => ( 179 |
180 | 185 | {(manager: FavoritesManager, isVisible: boolean) => 186 | isVisible && ( 187 | <> 188 |
Favorites
189 |
190 | {visibleFavorites.map((f) => ( 191 | 196 | ))} 197 |
198 |
File Browser
199 | 200 | ) 201 | } 202 | 203 | 208 | {(widget: FavoritesWidget, currentPath: string) => ( 209 | 214 | )} 215 | 216 |
217 | )} 218 | 219 | ); 220 | } 221 | } 222 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { 2 | JupyterFrontEnd, 3 | JupyterFrontEndPlugin, 4 | } from '@jupyterlab/application'; 5 | import { IFileBrowserFactory } from '@jupyterlab/filebrowser'; 6 | import { IMainMenu } from '@jupyterlab/mainmenu'; 7 | import { ISettingRegistry } from '@jupyterlab/settingregistry'; 8 | import { toArray } from '@lumino/algorithm'; 9 | import { Menu, PanelLayout } from '@lumino/widgets'; 10 | import { FavoritesWidget } from './components'; 11 | import { starIcon } from './icons'; 12 | import { FavoritesManager } from './manager'; 13 | import { IFavorites, PluginIDs, CommandIDs } from './token'; 14 | import { 15 | getFavoritesIcon, 16 | getPinnerActionDescription, 17 | mergePaths, 18 | } from './utils'; 19 | import { PageConfig } from '@jupyterlab/coreutils'; 20 | 21 | const TOOLBAR_CLASS = 'jp-FileBrowser-toolbar'; 22 | 23 | /** 24 | * Initialization data for the jupyterlab-favorites extension. 25 | */ 26 | const favorites: JupyterFrontEndPlugin = { 27 | id: PluginIDs.favorites, 28 | autoStart: true, 29 | requires: [IFileBrowserFactory, ISettingRegistry], 30 | optional: [IMainMenu], 31 | activate: async ( 32 | app: JupyterFrontEnd, 33 | factory: IFileBrowserFactory, 34 | settingsRegistry: ISettingRegistry, 35 | mainMenu: IMainMenu 36 | ) => { 37 | console.log('JupyterLab extension jupyterlab-favorites is activated!'); 38 | const docRegistry = app.docRegistry; 39 | const filebrowser = factory.defaultBrowser; 40 | const layout = filebrowser.layout as PanelLayout; 41 | const { commands, serviceManager } = app; 42 | const favoritesManager = new FavoritesManager( 43 | PageConfig.getOption('serverRoot') || 'Jupyter Server Root', 44 | commands, 45 | settingsRegistry, 46 | serviceManager.contents 47 | ); 48 | favoritesManager.init(); 49 | const favoritesWidget = new FavoritesWidget(favoritesManager, filebrowser); 50 | // Insert the Favorites widget contents at the top of the FileBrowser area under the toolbar 51 | let insertIndex = 0; 52 | layout.widgets.forEach((widget, index) => { 53 | if (widget.node.className.includes(TOOLBAR_CLASS)) { 54 | insertIndex = index + 1; 55 | return; // no reason to continue to iterate once the className is found 56 | } 57 | }); 58 | layout.insertWidget(insertIndex, favoritesWidget); 59 | 60 | // Context Menu commands 61 | const getSelectedItems = () => { 62 | const widget = tracker.currentWidget; 63 | if (!widget) { 64 | return []; 65 | } 66 | return toArray(widget.selectedItems()); 67 | }; 68 | const { tracker } = factory; 69 | commands.addCommand(CommandIDs.addOrRemoveFavorite, { 70 | execute: () => { 71 | const selectedItems = getSelectedItems(); 72 | if (selectedItems.length > 0) { 73 | const selectedItem = selectedItems[0]; 74 | const shouldRemove = favoritesManager.hasFavorite(selectedItem.path); 75 | if (shouldRemove) { 76 | favoritesManager.removeFavorite(selectedItem.path); 77 | } else { 78 | const fileType = docRegistry.getFileTypeForModel(selectedItem); 79 | favoritesManager.addFavorite({ 80 | root: favoritesManager.serverRoot, 81 | path: selectedItem.path, 82 | contentType: fileType.contentType, 83 | iconLabel: fileType.icon.name, 84 | }); 85 | } 86 | } 87 | }, 88 | isVisible: () => { 89 | const selectedItems = getSelectedItems(); 90 | return selectedItems.length === 1; 91 | }, 92 | icon: () => { 93 | const selectedItems = getSelectedItems(); 94 | const selectedItem = selectedItems[0]; 95 | const showFilled = !favoritesManager.hasFavorite(selectedItem.path); 96 | return getFavoritesIcon(showFilled); 97 | }, 98 | label: () => { 99 | const selectedItems = getSelectedItems(); 100 | const selectedItem = selectedItems[0]; 101 | const showRemove = favoritesManager.hasFavorite(selectedItem.path); 102 | return getPinnerActionDescription(showRemove); 103 | }, 104 | }); 105 | app.contextMenu.addItem({ 106 | command: CommandIDs.addOrRemoveFavorite, 107 | selector: '.jp-DirListing-item[data-isdir]', 108 | rank: 3, 109 | }); 110 | commands.addCommand(CommandIDs.removeFavorite, { 111 | execute: () => { 112 | const contextNode: HTMLElement = app.contextMenuHitTest((node) => 113 | node.classList.contains('jp-Favorites-item') 114 | ); 115 | const fullPath = contextNode.getAttribute('title'); 116 | let path = fullPath.replace(favoritesManager.serverRoot, ''); 117 | if (path.startsWith('/')) { 118 | path = path.slice(1); 119 | } 120 | favoritesManager.removeFavorite(path); 121 | }, 122 | icon: starIcon, 123 | label: 'Remove Favorite', 124 | }); 125 | app.contextMenu.addItem({ 126 | command: CommandIDs.removeFavorite, 127 | selector: '.jp-Favorites-item', 128 | rank: 0, 129 | }); 130 | // Main Menu 131 | if (mainMenu) { 132 | mainMenu.fileMenu.addGroup( 133 | [ 134 | { 135 | type: 'submenu' as Menu.ItemType, 136 | submenu: favoritesManager.favoritesMenu, 137 | }, 138 | ], 139 | 1 140 | ); 141 | } 142 | // Try to merge with existing Group 1 143 | try { 144 | const groups = (mainMenu.fileMenu as any)._groups; 145 | let numRankOneGroups = 0; 146 | let openGroupIndex = -1; 147 | for (let i = 0; i < groups.length; i++) { 148 | const group = groups[i]; 149 | if (group.rank === 1) { 150 | numRankOneGroups += 1; 151 | if (openGroupIndex < 0) { 152 | openGroupIndex = i; 153 | } 154 | } 155 | } 156 | if (numRankOneGroups === 2) { 157 | const openGroup = groups[openGroupIndex]; 158 | openGroup.size = openGroup.size + 1; 159 | groups.splice(openGroupIndex + 1, 1); 160 | const fileMenu = (mainMenu.fileMenu as any).menu; 161 | const fileMenuItems = fileMenu._items; 162 | let removeSeparators = false; 163 | for (let i = fileMenuItems.length - 1; i > 0; i--) { 164 | const fileMenuItem = fileMenuItems[i]; 165 | if (fileMenuItem.command === 'filebrowser:open-path') { 166 | break; 167 | } 168 | if (removeSeparators && fileMenuItem.type === 'separator') { 169 | fileMenu.removeItemAt(i); 170 | } else if (fileMenuItem.type === 'submenu') { 171 | const label = fileMenuItem.submenu.title.label; 172 | if (label === 'Favorites') { 173 | removeSeparators = true; 174 | } 175 | } 176 | } 177 | } 178 | } catch (e) { 179 | console.log(e); 180 | } 181 | // Commands 182 | commands.addCommand(CommandIDs.openFavorite, { 183 | execute: async (args) => { 184 | const favorite = args.favorite as IFavorites.Favorite; 185 | const path = favorite.path === '' ? '/' : favorite.path; 186 | await commands.execute('filebrowser:open-path', { path }); 187 | //favoritesManager.removeFavoriteIfInvalid(favorite); 188 | }, 189 | label: (args) => { 190 | const favorite = args.favorite as IFavorites.Favorite; 191 | return mergePaths(favorite.root, favorite.path); 192 | }, 193 | }); 194 | commands.addCommand(CommandIDs.toggleFavoritesWidget, { 195 | execute: async (args) => { 196 | const showWidget = args.showWidget as boolean; 197 | favoritesManager.saveSettings({ showWidget: !showWidget }); 198 | }, 199 | label: (args) => { 200 | const showWidget = args.showWidget as boolean; 201 | return `${showWidget ? 'Hide' : 'Show'} Favorites Widget`; 202 | }, 203 | isVisible: () => favoritesManager.visibleFavorites().length > 0, 204 | }); 205 | commands.addCommand(CommandIDs.restoreDefaults, { 206 | execute: () => favoritesManager.restoreDefaults(), 207 | label: 'Restore Defaults', 208 | }); 209 | commands.addCommand(CommandIDs.clearFavorites, { 210 | execute: () => favoritesManager.clearFavorites(), 211 | label: 'Clear Favorites', 212 | }); 213 | }, 214 | }; 215 | 216 | export default favorites; 217 | -------------------------------------------------------------------------------- /style/icons/md/LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------