Callbacks

note

All Module callbacks are available in this class.

start

Fired when the required number of pointers is reached.

const pointers = new Pointers(
  {
    container: document.getElementById('container'),
  },
  {
    onStart: () => console.log('start'),
  },
);

or:

const destruct = pointers.on('start', () => console.log('start'));

// Cancel the callback
destruct();

pointerdown

Fired when a pointer is added.

const pointers = new Pointers(
  {
    container: document.getElementById('container'),
  },
  {
    onPointerdown: ({ event, pointer }) => console.log('pointerdown'),
  },
);

or:

const destruct = pointers.on('pointerdown', ({ event, pointer }) =>
  console.log('pointerdown'),
);

// Cancel the callback
destruct();

pointermove

Fired when a pointer moves.

const pointers = new Pointers(
  {
    container: document.getElementById('container'),
  },
  {
    onPointermove: ({ event, pointer }) => console.log('pointermove'),
  },
);

or:

const destruct = pointers.on('pointermove', ({ event, pointer }) =>
  console.log('pointermove'),
);

// Cancel the callback
destruct();

pointerup

Fired when a pointer is removed.

const pointers = new Pointers(
  {
    container: document.getElementById('container'),
  },
  {
    onPointerup: ({ pointer }) => console.log('pointerup'),
  },
);

or:

const destruct = pointers.on('pointerup', ({ pointer }) =>
  console.log('pointerup'),
);

// Cancel the callback
destruct();

end

Fired when pointer events are canceled.

const pointers = new Pointers(
  {
    container: document.getElementById('container'),
  },
  {
    onEnd: () => console.log('end'),
  },
);

or:

const destruct = pointers.on('end', () => console.log('end'));

// Cancel the callback
destruct();