UNPKG

@zeix/ui-element

Version:

UIElement - a HTML-first library for reactive Web Components

55 lines (28 loc) • 954 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
[**@zeix/ui-element**](../README.md) *** [@zeix/ui-element](../globals.md) / on # Function: on() > **on**\<`K`, `E`\>(`type`, `listener`, `options`): [`Effect`](../type-aliases/Effect.md)\<[`ComponentProps`](../type-aliases/ComponentProps.md), `E`\> Defined in: [src/lib/effects.ts:646](https://github.com/zeixcom/ui-element/blob/297c0e8e040b3880ad85a2bc873523a8086f09a3/src/lib/effects.ts#L646) Effect for attaching an event listener to an element. Provides proper cleanup when the effect is disposed. ## Type Parameters ### K `K` *extends* `string` ### E `E` *extends* `HTMLElement` ## Parameters ### type `K` Event type ### listener (`event`) => `void` Event listener function ### options Event listener options `boolean` | `AddEventListenerOptions` ## Returns [`Effect`](../type-aliases/Effect.md)\<[`ComponentProps`](../type-aliases/ComponentProps.md), `E`\> Effect function that manages the event listener ## Since 0.12.0