How to Create Custom Events in Svelte

How to Create Custom Events in Svelte

Ferenc Almasi β€’ 2020 October 09 β€’ πŸ“– 1 min read
  • twitter
  • facebook

You can use the createEventDispatcher function in Svelte to dispatch custom events that you can listen to:

<script>
    import { createEventDispatcher } from 'svelte';

    const dispatch = createEventDispatcher();
    const callback = event => {
        console.log(`Dispatched with ${event.details}`);
    };
</script>

<button on:click={() => dispatch('notify', 'πŸ‘‹')}>
    Dispatch event
</button>

<ChildComponent on:notify={callback} />
Dispatch.svelte
Copied to clipboard!

The dispatch function takes two arguments:

  • The name of the event. In the example above, it is called notify
  • The details of the event. In the example above, it is a single string of πŸ‘‹

To listen to this dispatched event, you can attach an on:<customEventName> directive to elements.

Note that parent components can also listen to events dispatched in child components.

How to Create Custom Events in Svelte
If you would like to see more Webtips, follow @flowforfrank

Looking into SvelteΒ 3
Looking to improve your skills? Learn how to build reactive apps with Svelte + Tailwind.
Master Svelte

Resources:

Did you find this page helpful?
πŸ“š More Webtips
Frontend Course Dashboard
Master the Art of Frontend
  • check Unlimited access to hundred of tutorials
  • check Access to exclusive interactive lessons
  • check Remove ads to learn without distractions
Become a Pro

Recommended