@jlab-enhanced/favorites 3.2.0 → 3.2.2

package/README.md

@@ -2,18 +2,24 @@
 
 [![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/jupyterlab-favorites/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-favorites/actions?query=workflow%3ABuild)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-favorites/master?urlpath=lab)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-favorites/main?urlpath=lab)
 [![npm](https://img.shields.io/npm/v/@jlab-enhanced/favorites)](https://www.npmjs.com/package/@jlab-enhanced/favorites)
 [![PyPI](https://img.shields.io/pypi/v/jupyterlab-favorites)](https://pypi.org/project/jupyterlab-favorites)
 [![conda-forge](https://img.shields.io/conda/vn/conda-forge/jupyterlab-favorites)](https://anaconda.org/conda-forge/jupyterlab-favorites)
 
 Add the ability to save favorite folders to JupyterLab for quicker browsing.
 
-![JupyterLab Favorites extension demonstration](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-favorites/master/jupyterlab-favorites.gif)
+![JupyterLab Favorites extension demonstration](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-favorites/main/jupyterlab-favorites.gif)
 
 ## Requirements
 
-- JupyterLab >= 3.0.0 or Notebook >= 7.0.0
+- JupyterLab >= 4.0.0 or Notebook >= 7.0.0
+
+> For JupyterLab 3, you can install jupyterlab-favorites 3.1.x using pip for example:
+
+```sh
+pip install "jupyterlab-favorites~=3.1.1"
+```
 
 ## Install
 

package/lib/components.js

@@ -79,7 +79,7 @@ export const FavoritesBreadCrumbs = (props) => {
         var _a;
         const isFavorite = (_a = manager === null || manager === void 0 ? void 0 : manager.hasFavorite(currentPath)) !== null && _a !== void 0 ? _a : false;
         const icon = getFavoritesIcon(isFavorite);
-        return (React.createElement("button", { className: "jp-ToolbarButtonComponent", title: getPinnerActionDescription(isFavorite), onClick: e => {
+        return (React.createElement("button", { className: "jp-ToolbarButtonComponent jp-Button jp-mod-minimal", title: getPinnerActionDescription(isFavorite), onClick: e => {
                 props.handleClick(currentPath);
             } },
             React.createElement(icon.react, { className: FAVORITE_BREADCRUMB_ICON_CLASS, tag: "span" })));

package/lib/index.js

@@ -3,8 +3,6 @@ import { IDefaultFileBrowser, IFileBrowserFactory } from '@jupyterlab/filebrowse
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ReactWidget, UseSignal, folderIcon } from '@jupyterlab/ui-components';
-import { toArray } from '@lumino/algorithm';
-import { Throttler } from '@lumino/polling';
 import { Widget } from '@lumino/widgets';
 import React from 'react';
 import { FavoritesBreadCrumbs, FavoritesWidget } from './components';
@@ -16,10 +14,13 @@ import { InputDialog } from '@jupyterlab/apputils';
 export { IFavorites } from './token';
 const BREADCRUMBS_CLASS = 'jp-FileBrowser-crumbs';
 /**
- * The class name for the node containing the FileBrowser BreadCrumbs favorite icon.  This node
- * is also responsible for click actions on the icon.
+ * The class name for the node containing the FileBrowser BreadCrumbs favorite icon.
  */
 const FAVORITE_ITEM_PINNER_CLASS = 'jp-Favorites-pinner';
+/**
+ * Modifier class added to breadcrumbs to ensure the favourite icon has enough spacing.
+ */
+const BREADCUMBS_FAVORITES_CLASS = 'jp-Favorites-crumbs';
 /**
  * Initialization data for the jupyterlab-favorites extension.
  */
@@ -63,17 +64,8 @@ const favorites = {
                         } }))));
                     favoriteIcon.addClass(FAVORITE_ITEM_PINNER_CLASS);
                     Widget.attach(favoriteIcon, breadcrumbs);
-                    const throttler = new Throttler(() => {
-                        breadcrumbs.insertAdjacentElement('beforeend', favoriteIcon.node);
-                    });
-                    const observer = new MutationObserver(() => {
-                        throttler.invoke();
-                    });
-                    observer.observe(breadcrumbs, { childList: true });
-                    filebrowser.disposed.connect(() => {
-                        throttler.dispose();
-                        observer.disconnect();
-                    });
+                    breadcrumbs.insertAdjacentElement('beforebegin', favoriteIcon.node);
+                    breadcrumbs.classList.add(BREADCUMBS_FAVORITES_CLASS);
                 };
                 filebrowser.model.pathChanged.connect(initializeBreadcrumbsIcon);
                 initializeBreadcrumbsIcon();
@@ -85,7 +77,7 @@ const favorites = {
             if (!widget) {
                 return [];
             }
-            return toArray(widget.selectedItems());
+            return Array.from(widget.selectedItems());
         };
         const { tracker } = factory;
         commands.addCommand(CommandIDs.addOrRemoveFavorite, {

package/lib/manager.d.ts

@@ -29,7 +29,7 @@ export declare class FavoritesManager {
     removeFavoriteIfInvalid(favorite: IFavorites.Favorite): Promise<void>;
     restoreDefaults(): void;
     saveSettings(settings: IFavorites.FavoritesSettings): Promise<void>;
-    visibleFavorites(): IFavorites.Favorite[];
+    visibleFavorites(sort?: boolean): IFavorites.Favorite[];
     private clearFavoritesOrRestoreDefaults;
     private loadFavorites;
     private loadShowWidget;

package/lib/manager.js

@@ -62,10 +62,10 @@ export class FavoritesManager {
         this.loadFavorites();
     }
     isVisible() {
-        return this._showWidget && this.visibleFavorites().length > 0;
+        return this._showWidget && this.visibleFavorites(false).length > 0;
     }
     hasFavorite(path) {
-        return this.visibleFavorites().findIndex(f => f.path === path) >= 0;
+        return this.visibleFavorites(false).findIndex(f => f.path === path) >= 0;
     }
     handleClick(favorite) {
         this._commandRegistry.execute(CommandIDs.openFavorite, { favorite });
@@ -122,10 +122,12 @@ export class FavoritesManager {
             this._settingsRegistry.set(SettingIDs.favorites, 'showWidget', settings.showWidget);
         }
     }
-    visibleFavorites() {
-        return this.favorites
-            .filter(f => !f.hidden)
-            .sort((a, b) => {
+    visibleFavorites(sort = true) {
+        const filtered = this.favorites.filter(f => !f.hidden);
+        if (!sort) {
+            return filtered;
+        }
+        return filtered.sort((a, b) => {
             if (a.contentType === b.contentType) {
                 return getName(a.path) <= getName(b.path) ? -1 : 1;
             }
@@ -147,8 +149,12 @@ export class FavoritesManager {
     }
     async loadFavorites() {
         var _a;
-        const favorites = await this._settingsRegistry.get(SettingIDs.favorites, 'favorites');
-        this.favorites = ((_a = favorites.composite) !== null && _a !== void 0 ? _a : []);
+        const setting = await this._settingsRegistry.get(SettingIDs.favorites, 'favorites');
+        const favorites = ((_a = setting.composite) !== null && _a !== void 0 ? _a : []);
+        this.favorites = favorites.map(favorite => {
+            var _a;
+            return { ...favorite, root: (_a = favorite.root) !== null && _a !== void 0 ? _a : this.serverRoot };
+        });
     }
     async loadShowWidget() {
         var _a;

package/lib/utils.d.ts

@@ -8,3 +8,4 @@ export declare function getFavoritesIcon(filled: boolean): LabIcon;
 export declare function getName(path: string): [string, string];
 export declare function getPinnerActionDescription(showRemove: boolean): string;
 export declare function mergePaths(root: string, path: string): string;
+export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jlab-enhanced/favorites",
-    "version": "3.2.0",
+    "version": "3.2.2",
     "description": "Add the ability to save favorite folders to JupyterLab for quicker browsing",
     "keywords": [
         "jupyter",
@@ -77,10 +77,8 @@
         "@jupyterlab/services": "^7.0.5",
         "@jupyterlab/settingregistry": "^4.0.5",
         "@jupyterlab/ui-components": "^4.0.5",
-        "@lumino/algorithm": "^2.0.0",
         "@lumino/commands": "^2.0.1",
         "@lumino/coreutils": "^2.0.1",
-        "@lumino/polling": "^2.0.0",
         "@lumino/signaling": "^2.0.0",
         "@lumino/widgets": "^2.0.1"
     },

package/schema/favorites.json

@@ -22,10 +22,11 @@
           "type": "string"
         },
         "root": {
-          "type": "string"
+          "type": "string",
+          "description": "Root path used for filtering out favourites from instances of JupyterLab launched in a different root directory. If not given the favourite will be shown if the associated file exists."
         }
       },
-      "required": ["root", "path"],
+      "required": ["path"],
       "type": "object"
     }
   },

package/style/base.css

@@ -1,15 +1,24 @@
 .jp-Favorites-pinner {
-  float: right;
-  cursor: pointer;
+  position: absolute;
+  right: 0;
+  overflow: visible;
+
+  /* aimed to match the upstream breadcrumbs */
+  margin: 8px 12px;
 }
 
-.jp-Favorites-BreadCrumbs-Icon svg {
-  border-radius: var(--jp-border-radius);
-  cursor: pointer;
+.jp-Favorites-pinner > .jp-ToolbarButtonComponent {
+  height: 24px;
+  margin-top: -5px;
+}
+
+.jp-Favorites-crumbs {
+  margin-right: 40px;
+}
+
+.jp-Favorites-BreadCrumbs-Icon,
+.jp-Favorites-BreadCrumbs-Icon > svg {
   height: 16px;
-  margin: 0 2px;
-  padding: 0 2px;
-  vertical-align: middle;
   width: 16px;
 }
 
@@ -45,7 +54,7 @@
   background-color: var(--jp-layout-color2);
 }
 
-.jp-Favorites-itemIcon svg {
+.jp-Favorites-itemIcon > svg {
   display: block;
   height: 16px;
   margin: 0 5px;