Skip to main content

Props

Static Props​

Static properties are set during initialization and cannot be modified later.

container​

  • Type: HTMLElement | SVGElement
  • The element that listens for pointer events.
const pointers = new Pointers({
  container: document.getElementById('container'),
});

relative​

  • Type: boolean
  • Default: false
  • Calculate pointer coordinates relative to the container instead of the viewport.
const pointers = new Pointers({
  container: document.getElementById('container'),
  relative: true,
});

buttons​

  • Type: number[]

  • Default: [0]

  • Determines which mouse buttons trigger events.

    • 0: Main button pressed, usually the left button or the un-initialized state
    • 1: Auxiliary button pressed, usually the wheel button or the middle button (if present)
    • 2: Secondary button pressed, usually the right button
    • 3: Fourth button, typically the Browser Back button
    • 4: Fifth button, typically the Browser Forward button

    See MouseEvent.button.

const pointers = new Pointers({
  container: document.getElementById('container'),
  buttons: [0],
});

minPointers​

  • Type: number
  • Default: 1
  • Minimum number of active pointers (fingers) required to trigger the "start" callback.
const pointers = new Pointers({
  container: document.getElementById('container'),
  minPointers: 2,
});

maxPointers​

  • Type: number
  • Default: 5
  • Maximum number of pointers that can be tracked simultaneously.
const pointers = new Pointers({
  container: document.getElementById('container'),
  maxPointers: 5,
});

Mutable Props​

Mutable properties can be updated at runtime using .updateProps().

enabled​

  • Type: boolean
  • Default: true
  • Enables or disables pointer events.
const pointers = new Pointers({
  container: document.getElementById('container'),
  enabled: false
});

// change value
pointers.updateProps({
  enabled: true
});