Switch back to shortcut override plugin

jupyterlab · Dec 28, 2021 · 7c0b058 · 7c0b058
1 parent 37b0c2e
commit 7c0b058
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 19 deletions.
diff --git a/packages/documentsearch-extension/package.json b/packages/documentsearch-extension/package.json
@@ -52,8 +52,7 @@
     "access": "public"
   },
   "jupyterlab": {
-    "extension": true,
-    "schemaDir": "schema"
+    "extension": true
   },
   "styleModule": "style/index.js"
 }
diff --git a/packages/documentsearch-extension/schema/retroShellWidgetListener.json b/packages/documentsearch-extension/schema/retroShellWidgetListener.json
diff --git a/packages/documentsearch-extension/src/index.ts b/packages/documentsearch-extension/src/index.ts
@@ -5,12 +5,37 @@ import {
 
 import { ISearchProviderRegistry } from '@jupyterlab/documentsearch';
 
-import { IRetroShell } from '@retrolab/application';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 import { Widget } from '@lumino/widgets';
 
+import { IRetroShell } from '@retrolab/application';
+
 const SEARCHABLE_CLASS = 'jp-mod-searchable';
 
+/**
+ * A plugin to programmatically disable the Crtl-F shortcut in RetroLab
+ * See https://github.com/jupyterlab/retrolab/pull/294 and
+ * https://github.com/jupyterlab/jupyterlab/issues/11754 for more context.
+ */
+const disableShortcut: JupyterFrontEndPlugin<void> = {
+  id: '@retrolab/documentsearch-extension:disableShortcut',
+  requires: [ISettingRegistry],
+  autoStart: true,
+  activate: async (app: JupyterFrontEnd, registry: ISettingRegistry) => {
+    const docSearchShortcut = registry.plugins[
+      '@jupyterlab/documentsearch-extension:plugin'
+    ]?.schema['jupyter.lab.shortcuts']?.find(
+      shortcut => shortcut.command === 'documentsearch:start'
+    );
+
+    if (docSearchShortcut) {
+      docSearchShortcut.disabled = true;
+      docSearchShortcut.keys = [];
+    }
+  }
+};
+
 /**
  * A plugin to add document search functionalities.
  */
@@ -59,6 +84,9 @@ const retroShellWidgetListener: JupyterFrontEndPlugin<void> = {
 /**
  * Export the plugins as default.
  */
-const plugins: JupyterFrontEndPlugin<any>[] = [retroShellWidgetListener];
+const plugins: JupyterFrontEndPlugin<any>[] = [
+  disableShortcut,
+  retroShellWidgetListener
+];
 
 export default plugins;