Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/template

EventHandler.preventDefault

Modifies an EventHandler to call preventDefault() on the event.

Package version
1.0.0-beta.13
Category
Default action control
Since
1.0.0
Member of
EventHandler

Import

import { EventHandler } from "@typed/template";

Access EventHandler.preventDefault through the imported EventHandler export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export declare function preventDefault<Ev extends Event, E = never, R = never>(handler: EventHandler<Ev, E, R>): EventHandler<Ev, E, R>;

Why

This records the policy on the handler while keeping the event native.

Ownership and lifetime

The returned description is inert; the renderer Scope owns its listener.

Examples

import * as EventHandler from "@typed/template/EventHandler"
import { html } from "@typed/template"

const handler = EventHandler.make((event) => {
  console.log("Form submit prevented")
})

const preventDefaultHandler = EventHandler.preventDefault(handler)

const template = html`<form onsubmit=${preventDefaultHandler}>...</form>`

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source