Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Omri Katz committed Dec 20, 2019
1 parent f212a97 commit a0b6f02
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions projects/ng-keyboard-shortcuts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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),
}
]
```
Expand Down

0 comments on commit a0b6f02

Please sign in to comment.