Svelte v5 における イベントハンドラの変更点
Svelte v5 では、イベントハンドラの書き方が一新され、いくつか非推奨となった書き方があります。この記事では、Svelte v4 と Svelte v5 のイベントハンドラの書き方の違いについて見ていきます。
Svelte v5 では、イベントハンドラの書き方が一新され、いくつか非推奨となった書き方があります。この記事では、Svelte v4 と Svelte v5 のイベントハンドラの書き方の違いについて見ていきます。
on: ディレクティブが非推奨に
Svelte v4 までは、DOM イベントを購読するために on: ディレクティブを使用していました。例えば、click イベントを購読する場合には以下のように記述します。
<script>
function handleClick() {
console.log("clicked");
}
</script>
<button on:click={handleClick}>Click me</button>Svelte v5 では、on: ディレクティブが非推奨となり、単なるプロパティとしてイベントハンドラを指定するようになりました。上記の例を Svelte v5 で書き直すと以下のようになります。
<script>
function handleClick() {
console.log("clicked");
}
</script>
<button onclick={handleClick}>Click me</button>onclick もプロパティの 1 つなったため、その他のプロパティと同じように省略記法も使用できます。
<script>
function onclick() {
console.log("clicked");
}
</script>
<button {onclick}>Click me</button>コンポーネントのイベント
Svelte v4 までは Svelte コンポーネントからイベントを発火するために createEventDispatcher 関数を使用していました。createEventDispatcher 関数は CustomEvent を作成します。CustomEvent に第 1 引数にイベント名、第 2 引数にイベントデータを渡すことで、コンポーネントからイベントが発火されます。
<script>
import { createEventDispatcher } from "svelte";
let title = "";
const dispatch = createEventDispatcher();
function handleClick() {
dispatch("createTodo", { title });
}
</script>
<input bind:value={title} />
<button on:click={handleClick}>Create</button>親コンポーネントからイベントを購読する場合には、on:createTodo ディレクティブを使用します。
<script>
import TodoForm from "./TodoForm.svelte";
import { createTodo } from "./api";
function handleCreate(event) {
createTodo(event.detail.title);
}
</script>
<TodoForm on:createTodo={handleCreate} />Svelte v5 では、createEventDispatcher 関数が非推奨となり、代わりに Props としてコールバック関数を渡すことが推奨されます。上記の例を Svelte v5 で書き直すと以下のようになります。
<script>
let title = $state("");
const { createTodo } = $props();
function handleClick() {
createTodo(title);
}
</script>
<input bind:value={title} />
<button onclick={handleClick}>Create</button>親コンポーネントからイベントを購読するには、Props としてコールバック関数を渡します。
<script>
import TodoForm from "./TodoForm.svelte";
import { createTodo } from "./api";
function handleCreate(title) {
createTodo(title);
}
</script>
<TodoForm createTodo={handleCreate} />on: ディレクティブと createEventDispatcher 関数が非推奨となったことで、以下のような利点が考えられます。
- Svelte の学習コストが軽減される
createEventDispatcher周りのボイラープレートが削減される- Props としてコールバック関数を渡すことにより、特定のイベントハンドラーが必須かどうかが明確になったり、コンポーネントが特定のイベントを発火しないことが保証される
イベントのフォワーディング
Svelte v4 までは、コンポーネントのイベントは DOM のイベントと異なりバブリングされませんでした。孫コンポーネントから親コンポーネントにイベントをフォワーディングするためには、子コンポーネントでイベントのフォーワーディングを行う必要がありました。
App.svelte → Parent.svelte → Child.svelte のような構造で Child.svelte でイベントを以下のように発火したとしましょう。
<script>
import { createEventDispatcher } from "svelte";
const dispatch = createEventDispatcher();
function handleClick() {
dispatch("click");
}
</script>
<button on:click={handleClick}>Click me</button>Parent.svelte で Child.svelte から発火されたイベントをフォワーディングするためには、Parent.svelte で以下のように値のない on:click ディレクティブを使用します。
<script>
import Child from "./Child.svelte";
</script>
<Child on:click />Svelte v5 では、単にイベントを Props として渡します。
<script>
const { onclick } = $props();
function handleClick() {
onclick();
}
</script>
<button onclick={handleClick}>Click me</button><script>
import Child from "./Child.svelte";
const { onclick } = $props();
</script>
<Child onclick={onclick} /><script>
import Parent from "./Parent.svelte";
function handleClick() {
console.log("clicked");
}
</script>
<Parent onclick={handleClick} />イベントの修飾子
Svelte v4 までは以下のようにイベントの修飾子を使用できました。
<button on:click|preventDefault={handler}>...</button>これは on: ディレクティブ特有の構文であり、on: ディレクティブが非推奨となったことで、上記のような修飾子も使われなくなります。これは明示的にイベントハンドラ内で処理するように変更します。
<script>
function handleClick(event) {
event.preventDefault();
console.log("clicked");
}
</script>
<button onclick={handleClick}>...</button>複数のイベントハンドラ
Svelte v4 までは以下のように複数のイベントハンドラを指定できました。
<button on:click={handler1} on:click={handler2}>...</button>これはある種のアンチパターンとされていました。属性が多い場合、同じイベントハンドラが登録されていることが認識しづらくなります。Svelte v5 では、重複したイベントハンドラを指定することは許可されなくなります。代わりに以下のように 1 つのイベントハンドラ内で処理するように変更します。
<script>
function handleClick(event) {
handler1(event);
handler2(event);
}
</script>
<button onclick={handleClick}>...</button>まとめ
- Svelte v5 では、
on:ディレクティブが非推奨となり、単なるプロパティとしてイベントハンドラを指定するようになった createEventDispatcher関数が非推奨となり、代わりに Props としてコールバック関数を渡すことが推奨される
