Command Registry

Associates listener functions with commands in a context-sensitive way using DOM node. You can access a global instance of this class via inkdrop.commands.

The global command registry facilitates a style of event handling known as event delegation. Inkdrop commands are expressed as custom DOM events that can be invoked on the currently focused element via a key binding. Rather than binding listeners for command events directly to DOM nodes, you instead register command event listeners globally on inkdrop.commands and constrain them to specific kinds of elements with DOM nodes.

Command names must follow the namespace:action pattern, where namespace will typically be the name of your package, and action describes the behavior of your command. If either part consists of multiple words, these must be separated by hyphens. E.g. awesome-package:turn-it-up-to-eleven. All words should be lowercased.

As the event bubbles upward through the DOM, all registered event listeners with matching selectors are invoked in order of specificity. In the event of a specificity tie, the most recently registered listener is invoked first. This mirrors the "cascade" semantics of CSS. Event listeners are invoked in the context of the current DOM node, meaning this always points at event.currentTarget. As is normally the case with DOM events, stopPropagation and stopImmediatePropagation can be used to terminate the bubbling process and prevent invocation of additional listeners.

Register a command

inkdrop.commands.add(
  document.body,
  'custom:insert-date',
  (event) => {
    const { editingNote } = inkdrop.store.getState()
    const body = editingNote.body + '\n' + new Date().toLocaleString()
    inkdrop.store.dispatch(actions.editingNote.update({ body }))
    inkdrop.store.dispatch(actions.editor.change(true))
  }
)

Add multiple commands

inkdrop.commands.add(document.body, {
  'custom:insert-date': () => {
    const { editingNote } = inkdrop.store.getState()
    const body = editingNote.body + '\n' + new Date().toLocaleString()
    inkdrop.store.dispatch(actions.editingNote.update({ body }))
    inkdrop.store.dispatch(actions.editor.change(true))
  }
})

Dispatch the given command

Simulate the dispatch of a command on a DOM node.

This is useful for testing, especially when simulating a command's invocation on a detached DOM node. Otherwise, the DOM node must be attached to the document so the event can bubble up to the root node.

inkdrop.commands.dispatch(document.body, 'core:save-note')