Skip to content

Commit 75295ac

Browse files
dummdidummConduitryRich-Harris
authored
docs: enhance breaking change section (#9674)
* docs: enhance breaking change section - mention createRoot first, explain difference to mount - mentiond bind:this change - sub headings - adjust createRoot type that missed the events property * Update packages/svelte/src/internal/client/render.js Co-authored-by: Conduitry <[email protected]> * clarify --------- Co-authored-by: Conduitry <[email protected]> Co-authored-by: Rich Harris <[email protected]>
1 parent dd4061b commit 75295ac

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

packages/svelte/src/internal/client/render.js

+1
Original file line numberDiff line numberDiff line change
@@ -2918,6 +2918,7 @@ export function unwrap(value) {
29182918
* @param {{
29192919
* target: Node;
29202920
* props?: Props;
2921+
* events?: Events;
29212922
* context?: Map<any, any>;
29222923
* intro?: boolean;
29232924
* immutable?: boolean;

sites/svelte-5-preview/src/routes/docs/content/03-appendix/02-breaking-changes.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,23 @@ While Svelte 5 is a complete rewrite, we have done our best to ensure that most
99
In Svelte 3 and 4, components are classes. In Svelte 5 they are functions and should be instantiated differently. If you need to manually instantiate components, you should use `mount` or `createRoot` (imported from `svelte`) instead. If you see this error using SvelteKit, try updating to the latest version of SvelteKit first, which adds support for Svelte 5. If you're using Svelte without SvelteKit, you'll likely have a `main.js` file (or similar) which you need to adjust:
1010

1111
```diff
12-
+ import { mount } from 'svelte';
12+
+ import { createRoot } from 'svelte';
1313
import App from './App.svelte'
1414

1515
- const app = new App({ target: document.getElementById("app") });
16-
+ const app = mount(App, { target: document.getElementById("app") });
16+
+ const app = createRoot(App, { target: document.getElementById("app") });
1717

1818
export default app;
1919
```
2020

21+
`createRoot` returns an object with a `$set` and `$destroy` method on it. It does not come with an `$on` method you may know from the class component API. Instead, pass them via the `events` property on the options argument. If you don't need to interact with the component instance after creating it, you can use `mount` instead, which saves some bytes.
22+
23+
> Note that using `events` is discouraged — instead, [use callbacks](https://svelte-5-preview.vercel.app/docs/event-handlers)
24+
2125
As a stop-gap-solution, you can also use `createClassComponent` or `asClassComponent` (imported from `svelte/legacy`) instead to keep the same API after instantiating. If this component is not under your control, you can use the `legacy.componentApi` compiler option for auto-applied backwards compatibility (note that this adds a bit of overhead to each component).
2226

27+
### Server API changes
28+
2329
Similarly, components no longer have a `render` method when compiled for server side rendering. Instead, pass the function to `render` from `svelte/server`:
2430

2531
```diff
@@ -32,6 +38,10 @@ import App from './App.svelte';
3238

3339
`render` also no longer returns CSS; it should be served separately from a CSS file.
3440

41+
### bind:this changes
42+
43+
Because components are no longer classes, using `bind:this` no longer returns a class instance with `$set`, `$on` and `$destroy` methods on it. It only returns the instance exports (`export function/const`) and, if you're using the `accessors` option, a getter/setter-pair for each property.
44+
3545
## Whitespace handling changed
3646

3747
Previously, Svelte employed a very complicated algorithm to determine if whitespace should be kept or not. Svelte 5 simplifies this which makes it easier to reason about as a developer. The rules are:

0 commit comments

Comments
 (0)