Update documentation to help explain sequences clearer

[abritabroad]

I spent a few days digging through the code in order to figure out why my sequences were not working properly.

If you are trying to achieve the following scenario, the "g" command always wins.

[
    {
        key: ["g"],
        command: (output: ShortcutEventOutput) => console.log("g", output),
    },
    {
        key: ["g a"],
        command: (output: ShortcutEventOutput) => console.log("g a", output),
    }
]

If you add a trailing 'space' to to the first command's key, it will be treated as a sequence and the "g a" combination wins.

[
    {
        key: ["g "],   // <- Add trailing space here
        command: (output: ShortcutEventOutput) => console.log("g", output),
    },
    {
        key: ["g a"],
        command: (output: ShortcutEventOutput) => console.log("g a", output),
    }
]

Thanks!

[omridevk]

@abritabroad
Are you referring to this?
https://github.com/omridevk/ng-keyboard-shortcuts#important-note-1

[abritabroad]

Yes, there is no mention if needing a trailing space on the single key in order to get the double key's to work.

[omridevk]

I think that's more of a bug rather than a feature, i'll need to think about this. but the "g a" sequence suppose to win