docs: fix various typos in reference docs (#14011)

* docs: fix note about $derived

* fix some other typos

* revert one change

* emdash tweak
pull/14041/head
Conduitry 2 months ago committed by GitHub
parent 217e40998a
commit 6ad8240464
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -21,7 +21,7 @@ There are also plugins for [Rollup](https://github.com/sveltejs/rollup-plugin-sv
## Editor tooling ## Editor tooling
The Svelte team maintains a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) and there are integrations with various other [editors](https://sveltesociety.dev/resources#editor-support) and tools as well. The Svelte team maintains a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode), and there are integrations with various other [editors](https://sveltesociety.dev/resources#editor-support) and tools as well.
You can also check your code from the command line using [sv check](https://github.com/sveltejs/cli). You can also check your code from the command line using [sv check](https://github.com/sveltejs/cli).

@ -50,7 +50,7 @@ A `<script>` tag with a `module` attribute runs once when the module first evalu
You can `export` bindings from this block, and they will become exports of the compiled module. You cannot `export default`, since the default export is the component itself. You can `export` bindings from this block, and they will become exports of the compiled module. You cannot `export default`, since the default export is the component itself.
> [!NOTE] If you are using TypeScript and import such exports from a `module` block into a `.ts` file, make sure to have your editor setup so that TypeScript knows about them. This is the case for our VS Code extension and the IntelliJ plugin, in other cases you might need to setup our [TypeScript editor plugin](https://www.npmjs.com/package/typescript-svelte-plugin). > [!NOTE] If you are using TypeScript and import such exports from a `module` block into a `.ts` file, make sure to have your editor setup so that TypeScript knows about them. This is the case for our VS Code extension and the IntelliJ plugin, but in other cases you might need to setup our [TypeScript editor plugin](https://www.npmjs.com/package/typescript-svelte-plugin).
> [!LEGACY] > [!LEGACY]
> In Svelte 4, this script tag was created using `<script context="module">` > In Svelte 4, this script tag was created using `<script context="module">`

@ -21,7 +21,7 @@ The expression inside `$derived(...)` should be free of side-effects. Svelte wil
As with `$state`, you can mark class fields as `$derived`. As with `$state`, you can mark class fields as `$derived`.
> [!NOTE] Code in Svelte components is only executed once at creation, without the `$derived` rune `double` would maintain it's original value. > [!NOTE] Code in Svelte components is only executed once at creation. Without the `$derived` rune, `doubled` would maintain its original value even when `count` changes.
## `$derived.by` ## `$derived.by`

@ -243,8 +243,7 @@ export default function readable<T>(
## `$effect.root` ## `$effect.root`
The `$effect.root` rune is an advanced feature that creates a non-tracked scope that doesn't auto-cleanup. This is useful for The `$effect.root` rune is an advanced feature that creates a non-tracked scope that doesn't auto-cleanup. This is useful for nested effects that you want to manually control. This rune also allows for the creation of effects outside of the component initialisation phase.
nested effects that you want to manually control. This rune also allows for creation of effects outside of the component initialisation phase.
```svelte ```svelte
<script> <script>

@ -39,7 +39,7 @@ Await blocks allow you to branch on the three possible states of a [`Promise`](h
> [!NOTE] During server-side rendering, only the pending branch will be rendered. > [!NOTE] During server-side rendering, only the pending branch will be rendered.
> >
> If the provided expression is not a `Promise` only the `:then` branch will be rendered, including during server-side rendering. > If the provided expression is not a `Promise`, only the `:then` branch will be rendered, including during server-side rendering.
The `catch` block can be omitted if you don't need to render anything when the promise rejects (or no error is possible). The `catch` block can be omitted if you don't need to render anything when the promise rejects (or no error is possible).

@ -53,7 +53,7 @@ Snippets, and [render tags](@render), are a way to create reusable chunks of mar
{/each} {/each}
``` ```
Like function declarations, snippets can have an arbitrary number of parameters, which can have default values, and you can destructure each parameter. You cannot use rest parameters however. Like function declarations, snippets can have an arbitrary number of parameters, which can have default values, and you can destructure each parameter. You cannot use rest parameters, however.
## Snippet scope ## Snippet scope

@ -2,15 +2,12 @@
title: animate: title: animate:
--- ---
An animation is triggered when the contents of a [keyed each block](each#Keyed-each-blocks) are re-ordered. Animations do not run when an element is added or removed, only when the index of an existing data item within the each block changes. Animate directives must be on an element that is an _immediate_ child of a keyed each block. An animation is triggered when the contents of a [keyed each block](each#Keyed-each-blocks) are re-ordered. Animations do not run when an element is added or removed, only when the index of an existing data item within the each block changes. Animate directives must be on an element that is an _immediate_ child of a keyed each block.
Animations can be used with Svelte's [built-in animation functions](svelte-animate) or [custom animation functions](#Custom-animation-functions). Animations can be used with Svelte's [built-in animation functions](svelte-animate) or [custom animation functions](#Custom-animation-functions).
```svelte ```svelte
<!-- When `list` is reordered the animation will run--> <!-- When `list` is reordered the animation will run -->
{#each list as item, index (item)} {#each list as item, index (item)}
<li animate:flip>{item}</li> <li animate:flip>{item}</li>
{/each} {/each}
@ -115,4 +112,3 @@ A custom animation function can also return a `tick` function, which is called _
<div animate:whizz>{item}</div> <div animate:whizz>{item}</div>
{/each} {/each}
``` ```

@ -2,7 +2,7 @@
title: Nested <style> elements title: Nested <style> elements
--- ---
There should only be 1 top-level `<style>` tag per component. There can only be one top-level `<style>` tag per component.
However, it is possible to have a `<style>` tag nested inside other elements or logic blocks. However, it is possible to have a `<style>` tag nested inside other elements or logic blocks.

@ -36,7 +36,7 @@ Local variables (that do not represent store values) must _not_ have a `$` prefi
Prior to Svelte 5, stores were the go-to solution for creating cross-component reactive states or extracting logic. With runes, these use cases have greatly diminished. Prior to Svelte 5, stores were the go-to solution for creating cross-component reactive states or extracting logic. With runes, these use cases have greatly diminished.
- when extracting logic, it's better to take advantage of runes' universal reactivity: You can use runes outside the top level of components and even place them into JavaScript or TypeScript files (using a `.svelte.js` or `.svelte.ts` file ending) - when extracting logic, it's better to take advantage of runes' universal reactivity: You can use runes outside the top level of components and even place them into JavaScript or TypeScript files (using a `.svelte.js` or `.svelte.ts` file ending)
- when creating shared state, you can create a `$state` object containing the values you need and manipulating said state - when creating shared state, you can create a `$state` object containing the values you need and then manipulate said state
Stores are still a good solution when you have complex asynchronous data streams or it's important to have more manual control over updating values or listening to changes. If you're familiar with RxJs and want to reuse that knowledge, the `$` also comes in handy for you. Stores are still a good solution when you have complex asynchronous data streams or it's important to have more manual control over updating values or listening to changes. If you're familiar with RxJs and want to reuse that knowledge, the `$` also comes in handy for you.

@ -7,7 +7,7 @@ title: Lifecycle hooks
- beforeUpdate/afterUpdate with deprecation notice? - beforeUpdate/afterUpdate with deprecation notice?
- or skip this entirely and only have it in the reference docs? --> - or skip this entirely and only have it in the reference docs? -->
In Svelte 5, the component lifecycle consists of only two parts: Its creation and its destruction. Everything in-between - when certain state is updated - is not related to the component as a whole, only the parts that need to react to the state change are notified. This is because under the hood the smallest unit of change is actually not a component, it's the (render) effects that the component sets up upon component initialization. Consequently, there's no such thing as a "before update"/"after update" hook. In Svelte 5, the component lifecycle consists of only two parts: Its creation and its destruction. Everything in-between — when certain state is updated — is not related to the component as a whole; only the parts that need to react to the state change are notified. This is because under the hood the smallest unit of change is actually not a component, it's the (render) effects that the component sets up upon component initialization. Consequently, there's no such thing as a "before update"/"after update" hook.
## `onMount` ## `onMount`

Loading…
Cancel
Save