Custom events

Custom events

You can add event listeners like onclick and onfocus using maquette using the following notation.

  h('div', { onclick: handleClick, onfocus: () => { focused = true; } }, ['Click me']);

But what if you are using custom elements that trigger events like sl-expand or sl-collapse? Since maquette 4.0 you can now use the following notation:

  h('sl-tree', { on: { 'sl-expand': handleExpand, 'sl-collapse': handleCollapse } }, []);

The on notation also allows configuring event handlers to be passive or handle events during the capture phase.

  h('div', { on: { scroll: { listener: handleScroll, options: { passive: true, capture: true } } } }, []);

Example

This example demonstrates how to use the on notation to listen to custom events.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var expandCount = 0;
function render() {
  return h('sl-tree', { on: { 'sl-expand': () => { expandCount++; } } }, [
    h('sl-tree-item', [
      `Tree expanded ${expandCount} times`,
      h('sl-tree-item', [ 'leaf' ])
    ])
  ]);
}
projector.append(domNode, render);
// loads the shoelace custom element library
var cdn = 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.13.1/cdn/';
maquette.dom.append(document.body, h('script', {
  type: 'module',
  src: `${cdn}shoelace-autoloader.js`
}));
maquette.dom.append(document.body, h('link', {
  rel: 'stylesheet',
  href: `${cdn}themes/light.css`
}));
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX