diff --git a/projects/ng-keyboard-shortcuts/README.md b/projects/ng-keyboard-shortcuts/README.md index 67b560d..04a8c67 100644 --- a/projects/ng-keyboard-shortcuts/README.md +++ b/projects/ng-keyboard-shortcuts/README.md @@ -71,6 +71,8 @@ export class AppModule { key combinations are used with meta keys like control, shift, command, etc... and are defined using plus(+) sign as a separator. there can be multiple combinations for the same command, so either of the key combination will trigger the callback. +Since combinations uses the plus sign as a seperator, if you want to bind to the actual + charachater, +you will need to use "plus" instead. #### Examples: @@ -85,6 +87,11 @@ there can be multiple combinations for the same command, so either of the key co preventDefault: true, command: (output: ShortcutEventOutput) => console.log("control + a", output), + }, + { + key: "ctrl + plus", + preventDefault: true, + command: (output: ShortcutEventOutput) => console.log("control + plus key", output), } ] ```