From 27b7c7d8744a4d1bd87b1d74f1d70aa1a0800e28 Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Wed, 17 Apr 2024 21:51:55 +0100 Subject: [PATCH] Draft implementation of starring --- src/favorites.ts | 23 +++++ src/icons.ts | 7 ++ src/index.ts | 5 +- src/last_used.ts | 2 +- src/launcher.tsx | 85 +++++++++++++++-- src/svg.d.ts | 4 + style/base.css | 65 +++++++++++-- style/icons/md/LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++ style/icons/md/star.svg | 4 + 9 files changed, 380 insertions(+), 17 deletions(-) create mode 100644 src/favorites.ts create mode 100644 src/icons.ts create mode 100644 src/svg.d.ts create mode 100644 style/icons/md/LICENSE create mode 100644 style/icons/md/star.svg diff --git a/src/favorites.ts b/src/favorites.ts new file mode 100644 index 0000000..92dd59f --- /dev/null +++ b/src/favorites.ts @@ -0,0 +1,23 @@ +import { ILauncher } from '@jupyterlab/launcher'; + +export interface IFavoritesDatabase { + get(item: ILauncher.IItemOptions): boolean | null; + set(item: ILauncher.IItemOptions, isFavourite: boolean): void; +} + +export class FavoritesDatabase implements IFavoritesDatabase { + constructor() { + // TODO: use settings registry, or state db, or server to persist this info + this._db = new Map(); + } + get(item: ILauncher.IItemOptions) { + return this._db.get(this._itemKey(item)) ?? null; + } + set(item: ILauncher.IItemOptions, isFavourite: boolean) { + this._db.set(this._itemKey(item), isFavourite); + } + private _itemKey(item: ILauncher.IItemOptions): string { + return item.command + '_' + JSON.stringify(item.args); + } + private _db: Map; +} diff --git a/src/icons.ts b/src/icons.ts new file mode 100644 index 0000000..e75259f --- /dev/null +++ b/src/icons.ts @@ -0,0 +1,7 @@ +import { LabIcon } from '@jupyterlab/ui-components'; +import starSvgstr from '../style/icons/md/star.svg'; + +export const starIcon = new LabIcon({ + name: 'jupyterlab-new-launcher:star', + svgstr: starSvgstr +}); diff --git a/src/index.ts b/src/index.ts index 9c11dcc..320d598 100644 --- a/src/index.ts +++ b/src/index.ts @@ -16,6 +16,7 @@ import { ReadonlyPartialJSONObject } from '@lumino/coreutils'; import { DockPanel, TabBar, Widget } from '@lumino/widgets'; import { NewLauncher as Launcher } from './launcher'; import { LastUsedDatabase } from './last_used'; +import { FavoritesDatabase } from './favorites'; /** * The command IDs used by the launcher plugin. @@ -74,6 +75,7 @@ function activate( } const lastUsedDatabase = new LastUsedDatabase(); + const favoritesDatabase = new FavoritesDatabase(); commands.addCommand(CommandIDs.create, { label: trans.__('New Launcher'), @@ -94,7 +96,8 @@ function activate( callback, commands, translator, - lastUsedDatabase + lastUsedDatabase, + favoritesDatabase }); launcher.model = model; diff --git a/src/last_used.ts b/src/last_used.ts index f1b2a1f..a13cecf 100644 --- a/src/last_used.ts +++ b/src/last_used.ts @@ -5,7 +5,7 @@ export interface ILastUsedDatabase { recordAsUsedNow(item: ILauncher.IItemOptions): void; } -export class LastUsedDatabase { +export class LastUsedDatabase implements ILastUsedDatabase { constructor() { // TODO: use settings registry, or state db, or server to persist this info this._db = new Map(); diff --git a/src/launcher.tsx b/src/launcher.tsx index b7d3691..c198356 100644 --- a/src/launcher.tsx +++ b/src/launcher.tsx @@ -14,6 +14,8 @@ import { } from '@jupyterlab/ui-components'; import * as React from 'react'; import { ILastUsedDatabase } from './last_used'; +import { IFavoritesDatabase } from './favorites'; +import { starIcon } from './icons'; function TypeCard(props: { trans: TranslationBundle; @@ -48,6 +50,8 @@ interface IItem extends ILauncher.IItemOptions { iconClass: string; execute: () => Promise; lastUsed: Date | null; + starred: boolean; + toggleStar: () => void; } interface IKernelItem extends IItem { @@ -153,9 +157,17 @@ function LauncherBody(props: { }} sortKey={'kernel'} onRowClick={event => { - const element = (event.target as HTMLElement).querySelector( - '.jp-TableKernelItem' - )!; + const target = event.target as HTMLElement; + const row = target.closest('tr'); + if (!row) { + return; + } + const cell = target.closest('td'); + const starButton = cell?.querySelector('.jp-starIconButton'); + if (starButton) { + return (starButton as HTMLElement).click(); + } + const element = row.querySelector('.jp-TableKernelItem')!; (element as HTMLElement).click(); }} columns={[ @@ -189,8 +201,12 @@ function LauncherBody(props: { renderCell: (row: IKernelItem) => ( { + row.execute(); + event.stopPropagation(); + }} onKeyDown={event => { + // TODO memoize func defs for perf if (event.key === 'Enter') { row.execute(); } @@ -227,6 +243,37 @@ function LauncherBody(props: { } return a.lastUsed > b.lastUsed ? 1 : -1; } + }, + { + id: 'star', + label: '', + renderCell: (row: IKernelItem) => { + const [, forceUpdate] = React.useReducer(x => x + 1, 0); + + const starred = row.starred; + const title = starred + ? trans.__('Click to add this kernel to favourites') + : trans.__('Click to remove the kernel from favourites'); + return ( + + ); + }, + sort: (a: IKernelItem, b: IKernelItem) => + Number(a.starred) - Number(b.starred) } ]} /> @@ -238,6 +285,7 @@ function LauncherBody(props: { export namespace NewLauncher { export interface IOptions extends ILauncher.IOptions { lastUsedDatabase: ILastUsedDatabase; + favoritesDatabase: IFavoritesDatabase; } } @@ -247,8 +295,10 @@ export class NewLauncher extends Launcher { this.commands = options.commands; this.trans = this.translator.load('jupyterlab-new-launcher'); this._lastUsedDatabase = options.lastUsedDatabase; + this._favoritesDatabase = options.favoritesDatabase; } private _lastUsedDatabase: ILastUsedDatabase; + private _favoritesDatabase: IFavoritesDatabase; trans: TranslationBundle; renderCommand = (item: ILauncher.IItemOptions): IItem => { @@ -260,15 +310,34 @@ export class NewLauncher extends Launcher { const execute = async () => { await this.commands.execute(item.command, args); this._lastUsedDatabase.recordAsUsedNow(item); + obj.lastUsed = this._lastUsedDatabase.get(item); }; const lastUsed = this._lastUsedDatabase.get(item); - return { ...item, icon, iconClass, label, caption, execute, lastUsed }; + const starred = this._favoritesDatabase.get(item) ?? false; + const toggleStar = () => { + const wasStarred = this._favoritesDatabase.get(item); + const newState = !wasStarred; + obj.starred = newState; + this._favoritesDatabase.set(item, newState); + }; + const obj = { + ...item, + icon, + iconClass, + label, + caption, + execute, + lastUsed, + starred, + toggleStar + }; + + return obj; }; renderKernelCommand = (item: ILauncher.IItemOptions): IItem => { - return { - ...this.renderCommand(item) - }; + // note: do not use spread syntax here or object attributes will get frozen + return this.renderCommand(item); }; /** diff --git a/src/svg.d.ts b/src/svg.d.ts new file mode 100644 index 0000000..43f969e --- /dev/null +++ b/src/svg.d.ts @@ -0,0 +1,4 @@ +declare module '*.svg' { + const script: string; + export default script; +} diff --git a/style/base.css b/style/base.css index 4fa7ba7..3338d0d 100644 --- a/style/base.css +++ b/style/base.css @@ -10,6 +10,7 @@ --jp-animation-depth: 10px; --jp-animation-time: 150ms; --jp-title-height: 24px; + padding: var(--jp-animation-depth); } @@ -46,26 +47,76 @@ } .jp-LauncherBody { - margin: 0 12px; + padding: 0 12px; + height: 100%; + overflow-y: auto; } .jp-LauncherBody-Title { font-size: 20px; } +.jp-Launcher-openByKernel { + --jp-icon-size: 16px; +} + .jp-Launcher-openByKernel .jp-Launcher-kernelIcon { - width: 16px; - height: 16px; + width: var(--jp-icon-size); + height: var(--jp-icon-size); } .jp-Launcher-openByKernel .jp-LauncherCard-noKernelIcon { - font-size: 16px; + font-size: var(--jp-icon-size); } .jp-Launcher-openByKernel .jp-LauncherCard-icon { - height: 16px; + height: var(--jp-icon-size); +} + +.jp-Launcher-openByKernel th[data-id='icon'], +.jp-Launcher-openByKernel th[data-id='star'] { + width: var(--jp-icon-size); +} + +.jp-Launcher-openByKernel .jp-starIcon { + width: var(--jp-icon-size); + height: var(--jp-icon-size); +} + +.jp-starIconButton { + --jp-transition-transform: rotate(72deg); + + border: 0; + margin: 0; + padding: 0 6px; + background: transparent; + cursor: pointer; +} + +.jp-starIcon .jp-star-filled { + opacity: 0; } -.jp-Launcher-openByKernel th[data-id='icon'] { - width: 16px; +.jp-starIcon .jp-star-filled, +.jp-starIcon .jp-star-border { + transition-property: opacity, transform; + transition-duration: 0.2s; + transition-timing-function: ease-out; + transform-origin: center; +} + +.jp-starIconButton.jp-mod-starred .jp-star-filled { + opacity: 1; + transform: var(--jp-transition-transform); +} + +.jp-starIconButton.jp-mod-starred .jp-star-border { + opacity: 0; + transform: var(--jp-transition-transform); +} + +/* Styles for scenario where full row is clickable */ + +.jp-Launcher-openByKernel tr { + cursor: pointer; } diff --git a/style/icons/md/LICENSE b/style/icons/md/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/style/icons/md/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/style/icons/md/star.svg b/style/icons/md/star.svg new file mode 100644 index 0000000..367501e --- /dev/null +++ b/style/icons/md/star.svg @@ -0,0 +1,4 @@ + + + +