@solid-primitives/event-listener

Name: event-listener Stage: 3 Package: "@solid-primitives/event-listener" Primitives: createEventListener Category: Browser APIs

@solid-primitives/event-listener

A helpful event listener primitive that binds window and any element supplied.

createEventListener - Very basic and straightforward primitive that handles multiple elements according to a single event binding.

Installation

npm install @solid-primitives/event-listener
# or
yarn add @solid-primitives/event-listener

How to use it

const [add, remove] = createEventListener(document.getElementById("mybutton"), "mouseDown", () =>
  console.log("Click")
);

or as a directive

<MyButton use:createEventListener={() => ["click", () => console.log("Click")]}>Click!</MyButton>;
// you can provide your own event map type as well:
createEventListener<{ myCustomEvent: Event }>(window, "myCustomEvent", () => console.log("yup!"));

Demo

You may view a working example here: https://codesandbox.io/s/solid-primitives-event-listener-8mm77

Changelog

Expand Changelog

0.0.100

First ported commit from react-use-event-listener.

1.1.4

Released a version with type mostly cleaned up.

1.2.3

Switched to a more idiomatic pattern: Warning: incompatible with the previous version!

1.2.5

Added CJS build.