Instantiate a new command linker.
Connect a command/argument pair to a given node so that when it is clicked, the command will execute.
The node being connected.
The command ID to execute upon click.
Optional
args: ReadonlyPartialJSONObjectThe arguments with which to invoke the command.
The same node that was passed in, after it has been connected.
Only click
events will execute the command on a connected node. So, there
are two considerations that are relevant:
HTMLElement
passed in should be clickable.Disconnect a node that has been connected to execute a command on click.
The node being disconnected.
The same node that was passed in, after it has been disconnected.
This method is safe to call multiple times and is safe to call on nodes that were never connected.
This method can be called on rendered virtual DOM nodes that were populated
using the populateVNodeDataset
method in order to disconnect them from
executing their command/argument pair.
Populate the dataset
attribute within the collection of attributes used
to instantiate a virtual DOM node with the values necessary for its
rendered DOM node to respond to clicks by executing a command/argument
pair.
The command ID to execute upon click.
Optional
args: ReadonlyPartialJSONObjectThe arguments with which to invoke the command.
A dataset
collection for use within virtual node attributes.
The return value can be used on its own as the value for the dataset
attribute of a virtual element, or it can be added to an existing dataset
as in the example below.
let command = 'some:command-id';
let args = { alpha: 'beta' };
let anchor = h.a({
className: 'some-class',
dataset: {
foo: '1',
bar: '2',
../...linker.populateVNodeDataset(command, args)
}
}, 'some text');
A static class that provides helper methods to generate clickable nodes that execute registered commands with pre-populated arguments.