adds isKeybinding arg to _executeKeyBinding (#644)

* adds isKeybinding arg to _executeKeyBinding * fix ReadonlyJSONObject error * prettier * add _luminoEvent to args * add docs * prettier * add test for args._luminoEvent * prettier
jupyterlab · Oct 31, 2023 · 3aaa56f · 3aaa56f
1 parent c94ef4d
commit 3aaa56f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/packages/commands/src/index.ts b/packages/commands/src/index.ts
@@ -613,15 +613,19 @@ export class CommandRegistry {
    */
   private _executeKeyBinding(binding: CommandRegistry.IKeyBinding): void {
     let { command, args } = binding;
-    if (!this.hasCommand(command) || !this.isEnabled(command, args)) {
+    let newArgs: ReadonlyPartialJSONObject = {
+      _luminoEvent: { type: 'keybinding', keys: binding.keys },
+      ...args
+    };
+    if (!this.hasCommand(command) || !this.isEnabled(command, newArgs)) {
       let word = this.hasCommand(command) ? 'enabled' : 'registered';
       let keys = binding.keys.join(', ');
       let msg1 = `Cannot execute key binding '${keys}':`;
       let msg2 = `command '${command}' is not ${word}.`;
       console.warn(`${msg1} ${msg2}`);
       return;
     }
-    this.execute(command, args);
+    this.execute(command, newArgs);
   }
 
   /**
@@ -710,6 +714,8 @@ export namespace CommandRegistry {
      * the command.
      *
      * This may be invoked even when `isEnabled` returns `false`.
+     *
+     * If called via a keybinding the passed args will include a `_luminoEvent` that specify the event type and keys pressed for customization.
      */
     execute: CommandFunc<any | Promise<any>>;
 
@@ -865,6 +871,8 @@ export namespace CommandRegistry {
      * command as grayed-out or in some other non-interactive fashion.
      *
      * The default value is `() => true`.
+     *
+     * If called via a keybinding the passed args will include a `_luminoEvent` that specify the event type and keys pressed for customization
      */
     isEnabled?: CommandFunc<boolean>;
 
@@ -990,7 +998,7 @@ export namespace CommandRegistry {
     /**
      * The arguments for the command, if necessary.
      *
-     * The default value is an empty object.
+     * The default value is an empty object. If a command is activated by _executeKeyBinding, `args = {_luminoEvent: {type: <string>, keys: <string[]>}}`
      */
     args?: ReadonlyPartialJSONObject;
 

diff --git a/packages/commands/tests/src/index.spec.ts b/packages/commands/tests/src/index.spec.ts
@@ -701,9 +701,13 @@ describe('@lumino/commands', () => {
     describe('#processKeydownEvent()', () => {
       it('should dispatch on a correct keyboard event', () => {
         let called = false;
+        let _luminoEventType;
+        let _luminoEventKeys;
         registry.addCommand('test', {
-          execute: () => {
+          execute: args => {
             called = true;
+            _luminoEventType = (args._luminoEvent as ReadonlyJSONObject).type;
+            _luminoEventKeys = (args._luminoEvent as ReadonlyJSONObject).keys;
           }
         });
         registry.addKeyBinding({
@@ -718,6 +722,8 @@ describe('@lumino/commands', () => {
           })
         );
         expect(called).to.equal(true);
+        expect(_luminoEventType).to.equal('keybinding');
+        expect(_luminoEventKeys).to.contain('Ctrl ;');
       });
 
       it('should not dispatch on a suppressed node', () => {