GamepadEvent: gamepad property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.

We'd love to hear more about your role and the company you work for
Please help us by answering a few questions.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The GamepadEvent.gamepad property of the GamepadEvent interface returns a Gamepad object, providing access to the associated gamepad data for fired gamepadconnected and gamepaddisconnected events.

Value

A Gamepad object.

Examples

The gamepad property being called on a fired gamepadconnected event.

js
window.addEventListener("gamepadconnected", (e) => {
  console.log(
    "Gamepad connected at index %d: %s. %d buttons, %d axes.",
    e.gamepad.index,
    e.gamepad.id,
    e.gamepad.buttons.length,
    e.gamepad.axes.length,
  );
});

Specifications

Specification
Gamepad
# dom-gamepadevent-gamepad

Browser compatibility

See also

Using the Gamepad API