The Key is merely an easy way to define which key you are interested in. It has an entry for all the special keys and a constructor (Regular) for all the rest.

Shortcut is simply a record of a message and a keyCombination that describe the keyboard shortcut you're interested in.

Please note that the Maybe Bool for the alt, shift, ctrl and meta modifirs allows you to choose if you would like to ignore a modifier (Nothing), force it to be present (True) or force it to be abscent (False)

For instance the following key combination will match both Shift O and Ctrl Shift O but not Shift Meta O

myKeyCombination =
    { baseKey = Regular "O"
    , alt = Nothing
    , shift = Just True
    , ctrl = Nothing
    , meta = Just False
    }

if you're only interested in one key not in any of the modifiers then simpleShortcut is made for you. Both of these are equivalent:

myShortcut =
    { msg = SimpleMessage
    , keyCombination =
        { baseKey = Regular "O"
        , alt = Nothing
        , shift = Nothing
        , ctrl = Nothing
        , meta = Nothing
        }
    }


mySimpleShortcut =
    simpleShortcut <| Regular "O"

alias of simpleShortcut Escape

equivalent of setting all the modifiers to Nothing and the alt modifier to Just True

equivalent of setting all the modifiers to Nothing and the shift modifier to Just True

equivalent of setting all the modifiers to Nothing and the ctrl modifier to Just True

equivalent of setting all the modifiers to Nothing and the meta modifier to Just True

This is the elm wrapper for the custom-element provided by the NPM companion package