usePointerEvent
function exported by @mwillbanks/tuil-ink.
function
Public function exported by @mwillbanks/tuil-ink.
export function usePointerEvent(
id: string,
type: PointerEventType,
listener: PointerListener,
options: { readonly capture?: boolean; readonly enabled?: boolean } = {},
): void;Members
This declaration has no public members.
Parameters
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | Supplies the id value as string. | — |
type | PointerEventType | Yes | Supplies the type value as PointerEventType. | PointerEventType |
listener | PointerListener | Yes | Supplies the listener value as PointerListener. | — |
options | { readonly capture?: boolean; readonly enabled?: boolean } | No | Supplies the options value as { readonly capture?: boolean; readonly enabled?: boolean }. | — |
Returns
void — Returns a value that satisfies void.
Related types: —
Throws
No thrown errors are documented for this declaration.
Related types
No package-local related types.
Source
View the secondary source reference