Skip to content

docs: Add spread guidance for multiple event handlers #13240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 16, 2024
Merged

docs: Add spread guidance for multiple event handlers #13240

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6732213
Update 04-event-handlers.md
GeoffCox Sep 13, 2024
80b5413
Update 04-event-handlers.md
GeoffCox Sep 13, 2024
fe91dd1
tweak
Rich-Harris Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions sites/svelte-5-preview/src/routes/docs/content/01-api/04-event-handlers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,20 @@ Duplicate attributes/properties on elements — which now includes event handler
</button>
```

When spreading props, local event handlers must go _after_ the spread, or they risk being overwritten:

```svelte
<button
{...props}
onclick={(e) => {
doStuff(e);
props.onclick?.(e);
}}
>
...
</button>
```

## Why the change?

By deprecating `createEventDispatcher` and the `on:` directive in favour of callback props and normal element properties, we:
Expand Down