Liking cljdoc? Tell your friends :D

reagent-keybindings.keyboard


clear-keyboard-state!cljs

(clear-keyboard-state!)
source

deactivate-kb-shortcutscljs

(deactivate-kb-shortcuts)

While mounted, kb shortcuts are completely deactivated. Useful when showing a form in a modal. (We wouldn't want the user to activate shortcuts while typing in some text field.)

While mounted, kb shortcuts are completely deactivated.
Useful when showing a form in a modal. (We wouldn't want the user to
activate shortcuts while typing in some text field.)
sourceraw docstring

deactivate-shortcuts-compscljs

source

deregister-keys!cljs

(deregister-keys! shortcut-string id)
source

evt-modifierscljs

(evt-modifiers evt)

Return the keyboard modifiers associated with this event.

Return the keyboard modifiers associated with this event.
sourceraw docstring

get-keys-actioncljs

(get-keys-action keys-map)

Return the keys action, if any.

Return the keys action, if any.
sourceraw docstring

kb-actioncljs

(kb-action shortcut-string kb-fn)

Component to register a shortcut. If multiple shortcuts have the same keys, only the most recently added will be active. Re-registering the same keys and ID combination will update the action function without changing the order.

Modifiers in shortcut-string are separated from the main key by a space or a dash. For example : "ctrl-a" or "ctrl a"

The keyboard-listener component must be mounted somewhere in order for the shortcuts to be activated.

Component to register a shortcut. If multiple shortcuts have the same keys,
only the most recently added will be active. Re-registering the same
keys and ID combination will update the action function without
changing the order.

Modifiers in `shortcut-string` are separated from the main key by a space or a dash.
For example : 
"ctrl-a" or "ctrl a"

The `keyboard-listener` component must be mounted somewhere in order
for the shortcuts to be activated.
sourceraw docstring

key-down!cljs

(key-down! evt)
source

key-up!cljs

(key-up! evt)
source

keyboard-listenercljs

(keyboard-listener)

Component that will add the necessary events listeners to the window.

Component that will add the necessary events listeners to the
window.
sourceraw docstring

keyboard-statecljs

source

modifierscljs

source

mouse-buttonscljs

source

mouse-down!cljs

(mouse-down! evt)
source

mouse-up!cljs

(mouse-up! evt)
source

preventing-default-keyscljs

Prevent the default action for these keys.

Prevent the default action for these keys.
sourceraw docstring

register-keys!cljs

(register-keys! shortcut-string id action-fn)

Register a shortcut. If multiple shortcuts have the same keys, only the most recently added will be active. Re-registering the same keys and ID combination will update the action function without changing the order.

Register a shortcut. If multiple shortcuts have the same keys,
only the most recently added will be active. Re-registering the same
keys and ID combination will update the action function without
changing the order.
sourceraw docstring

registered-keyscljs

source

shortcuts-active?cljs

(shortcuts-active?)

Return true if keyboard and mouse shortcuts are active.

Return true if keyboard and mouse shortcuts are active.
sourceraw docstring

special-kscljs

source

string-to-keyscljs

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close