|
|
<!-- This file is generated by scripts/process-messages/index.js. Do not edit! -->
|
|
|
|
|
|
### assignment_value_stale
|
|
|
|
|
|
```
|
|
|
Assignment to `%property%` property (%location%) will evaluate to the right-hand side, not the value of `%property%` following the assignment. This may result in unexpected behaviour.
|
|
|
```
|
|
|
|
|
|
Given a case like this...
|
|
|
|
|
|
```svelte
|
|
|
<script>
|
|
|
let object = $state({ array: null });
|
|
|
|
|
|
function add() {
|
|
|
(object.array ??= []).push(object.array.length);
|
|
|
}
|
|
|
</script>
|
|
|
|
|
|
<button onclick={add}>add</button>
|
|
|
<p>items: {JSON.stringify(object.items)}</p>
|
|
|
```
|
|
|
|
|
|
...the array being pushed to when the button is first clicked is the `[]` on the right-hand side of the assignment, but the resulting value of `object.array` is an empty state proxy. As a result, the pushed value will be discarded.
|
|
|
|
|
|
You can fix this by separating it into two statements:
|
|
|
|
|
|
```js
|
|
|
let object = { array: [0] };
|
|
|
// ---cut---
|
|
|
function add() {
|
|
|
object.array ??= [];
|
|
|
object.array.push(object.array.length);
|
|
|
}
|
|
|
```
|
|
|
|
|
|
### await_reactivity_loss
|
|
|
|
|
|
```
|
|
|
Detected reactivity loss when reading `%name%`. This happens when state is read in an async function after an earlier `await`
|
|
|
```
|
|
|
|
|
|
Svelte's signal-based reactivity works by tracking which bits of state are read when a template or `$derived(...)` expression executes. If an expression contains an `await`, Svelte transforms it such that any state _after_ the `await` is also tracked — in other words, in a case like this...
|
|
|
|
|
|
```js
|
|
|
let a = Promise.resolve(1);
|
|
|
let b = 2;
|
|
|
// ---cut---
|
|
|
let total = $derived(await a + b);
|
|
|
```
|
|
|
|
|
|
...both `a` and `b` are tracked, even though `b` is only read once `a` has resolved, after the initial execution.
|
|
|
|
|
|
This does _not_ apply to an `await` that is not 'visible' inside the expression. In a case like this...
|
|
|
|
|
|
```js
|
|
|
let a = Promise.resolve(1);
|
|
|
let b = 2;
|
|
|
// ---cut---
|
|
|
async function sum() {
|
|
|
return await a + b;
|
|
|
}
|
|
|
|
|
|
let total = $derived(await sum());
|
|
|
```
|
|
|
|
|
|
...`total` will depend on `a` (which is read immediately) but not `b` (which is not). The solution is to pass the values into the function:
|
|
|
|
|
|
```js
|
|
|
let a = Promise.resolve(1);
|
|
|
let b = 2;
|
|
|
// ---cut---
|
|
|
/**
|
|
|
* @param {Promise<number>} a
|
|
|
* @param {number} b
|
|
|
*/
|
|
|
async function sum(a, b) {
|
|
|
return await a + b;
|
|
|
}
|
|
|
|
|
|
let total = $derived(await sum(a, b));
|
|
|
```
|
|
|
|
|
|
### await_waterfall
|
|
|
|
|
|
```
|
|
|
An async derived, `%name%` (%location%) was not read immediately after it resolved. This often indicates an unnecessary waterfall, which can slow down your app
|
|
|
```
|
|
|
|
|
|
In a case like this...
|
|
|
|
|
|
```js
|
|
|
async function one() { return 1 }
|
|
|
async function two() { return 2 }
|
|
|
// ---cut---
|
|
|
let a = $derived(await one());
|
|
|
let b = $derived(await two());
|
|
|
```
|
|
|
|
|
|
...the second `$derived` will not be created until the first one has resolved. Since `await two()` does not depend on the value of `a`, this delay, often described as a 'waterfall', is unnecessary.
|
|
|
|
|
|
(Note that if the values of `await one()` and `await two()` subsequently change, they can do so concurrently — the waterfall only occurs when the deriveds are first created.)
|
|
|
|
|
|
You can solve this by creating the promises first and _then_ awaiting them:
|
|
|
|
|
|
```js
|
|
|
async function one() { return 1 }
|
|
|
async function two() { return 2 }
|
|
|
// ---cut---
|
|
|
let aPromise = $derived(one());
|
|
|
let bPromise = $derived(two());
|
|
|
|
|
|
let a = $derived(await aPromise);
|
|
|
let b = $derived(await bPromise);
|
|
|
```
|
|
|
|
|
|
### binding_property_non_reactive
|
|
|
|
|
|
```
|
|
|
`%binding%` is binding to a non-reactive property
|
|
|
```
|
|
|
|
|
|
```
|
|
|
`%binding%` (%location%) is binding to a non-reactive property
|
|
|
```
|
|
|
|
|
|
### console_log_state
|
|
|
|
|
|
```
|
|
|
Your `console.%method%` contained `$state` proxies. Consider using `$inspect(...)` or `$state.snapshot(...)` instead
|
|
|
```
|
|
|
|
|
|
When logging a [proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy), browser devtools will log the proxy itself rather than the value it represents. In the case of Svelte, the 'target' of a `$state` proxy might not resemble its current value, which can be confusing.
|
|
|
|
|
|
The easiest way to log a value as it changes over time is to use the [`$inspect`](/docs/svelte/$inspect) rune. Alternatively, to log things on a one-off basis (for example, inside an event handler) you can use [`$state.snapshot`](/docs/svelte/$state#$state.snapshot) to take a snapshot of the current value.
|
|
|
|
|
|
### event_handler_invalid
|
|
|
|
|
|
```
|
|
|
%handler% should be a function. Did you mean to %suggestion%?
|
|
|
```
|
|
|
|
|
|
### hydration_attribute_changed
|
|
|
|
|
|
```
|
|
|
The `%attribute%` attribute on `%html%` changed its value between server and client renders. The client value, `%value%`, will be ignored in favour of the server value
|
|
|
```
|
|
|
|
|
|
Certain attributes like `src` on an `<img>` element will not be repaired during hydration, i.e. the server value will be kept. That's because updating these attributes can cause the image to be refetched (or in the case of an `<iframe>`, for the frame to be reloaded), even if they resolve to the same resource.
|
|
|
|
|
|
To fix this, either silence the warning with a [`svelte-ignore`](basic-markup#Comments) comment, or ensure that the value stays the same between server and client. If you really need the value to change on hydration, you can force an update like this:
|
|
|
|
|
|
```svelte
|
|
|
<script>
|
|
|
let { src } = $props();
|
|
|
|
|
|
if (typeof window !== 'undefined') {
|
|
|
// stash the value...
|
|
|
const initial = src;
|
|
|
|
|
|
// unset it...
|
|
|
src = undefined;
|
|
|
|
|
|
$effect(() => {
|
|
|
// ...and reset after we've mounted
|
|
|
src = initial;
|
|
|
});
|
|
|
}
|
|
|
</script>
|
|
|
|
|
|
<img {src} />
|
|
|
```
|
|
|
|
|
|
### hydration_html_changed
|
|
|
|
|
|
```
|
|
|
The value of an `{@html ...}` block changed between server and client renders. The client value will be ignored in favour of the server value
|
|
|
```
|
|
|
|
|
|
```
|
|
|
The value of an `{@html ...}` block %location% changed between server and client renders. The client value will be ignored in favour of the server value
|
|
|
```
|
|
|
|
|
|
If the `{@html ...}` value changes between the server and the client, it will not be repaired during hydration, i.e. the server value will be kept. That's because change detection during hydration is expensive and usually unnecessary.
|
|
|
|
|
|
To fix this, either silence the warning with a [`svelte-ignore`](basic-markup#Comments) comment, or ensure that the value stays the same between server and client. If you really need the value to change on hydration, you can force an update like this:
|
|
|
|
|
|
```svelte
|
|
|
<script>
|
|
|
let { markup } = $props();
|
|
|
|
|
|
if (typeof window !== 'undefined') {
|
|
|
// stash the value...
|
|
|
const initial = markup;
|
|
|
|
|
|
// unset it...
|
|
|
markup = undefined;
|
|
|
|
|
|
$effect(() => {
|
|
|
// ...and reset after we've mounted
|
|
|
markup = initial;
|
|
|
});
|
|
|
}
|
|
|
</script>
|
|
|
|
|
|
{@html markup}
|
|
|
```
|
|
|
|
|
|
### hydration_mismatch
|
|
|
|
|
|
```
|
|
|
Hydration failed because the initial UI does not match what was rendered on the server
|
|
|
```
|
|
|
|
|
|
```
|
|
|
Hydration failed because the initial UI does not match what was rendered on the server. The error occurred near %location%
|
|
|
```
|
|
|
|
|
|
This warning is thrown when Svelte encounters an error while hydrating the HTML from the server. During hydration, Svelte walks the DOM, expecting a certain structure. If that structure is different (for example because the HTML was repaired by the DOM because of invalid HTML), then Svelte will run into issues, resulting in this warning.
|
|
|
|
|
|
During development, this error is often preceeded by a `console.error` detailing the offending HTML, which needs fixing.
|
|
|
|
|
|
### invalid_raw_snippet_render
|
|
|
|
|
|
```
|
|
|
The `render` function passed to `createRawSnippet` should return HTML for a single element
|
|
|
```
|
|
|
|
|
|
### legacy_recursive_reactive_block
|
|
|
|
|
|
```
|
|
|
Detected a migrated `$:` reactive block in `%filename%` that both accesses and updates the same reactive value. This may cause recursive updates when converted to an `$effect`.
|
|
|
```
|
|
|
|
|
|
### lifecycle_double_unmount
|
|
|
|
|
|
```
|
|
|
Tried to unmount a component that was not mounted
|
|
|
```
|
|
|
|
|
|
### ownership_invalid_binding
|
|
|
|
|
|
```
|
|
|
%parent% passed property `%prop%` to %child% with `bind:`, but its parent component %owner% did not declare `%prop%` as a binding. Consider creating a binding between %owner% and %parent% (e.g. `bind:%prop%={...}` instead of `%prop%={...}`)
|
|
|
```
|
|
|
|
|
|
Consider three components `GrandParent`, `Parent` and `Child`. If you do `<GrandParent bind:value>`, inside `GrandParent` pass on the variable via `<Parent {value} />` (note the missing `bind:`) and then do `<Child bind:value>` inside `Parent`, this warning is thrown.
|
|
|
|
|
|
To fix it, `bind:` to the value instead of just passing a property (i.e. in this example do `<Parent bind:value />`).
|
|
|
|
|
|
### ownership_invalid_mutation
|
|
|
|
|
|
```
|
|
|
Mutating unbound props (`%name%`, at %location%) is strongly discouraged. Consider using `bind:%prop%={...}` in %parent% (or using a callback) instead
|
|
|
```
|
|
|
|
|
|
Consider the following code:
|
|
|
|
|
|
```svelte
|
|
|
<!--- file: App.svelte --->
|
|
|
<script>
|
|
|
import Child from './Child.svelte';
|
|
|
let person = $state({ name: 'Florida', surname: 'Man' });
|
|
|
</script>
|
|
|
|
|
|
<Child {person} />
|
|
|
```
|
|
|
|
|
|
```svelte
|
|
|
<!--- file: Child.svelte --->
|
|
|
<script>
|
|
|
let { person } = $props();
|
|
|
</script>
|
|
|
|
|
|
<input bind:value={person.name}>
|
|
|
<input bind:value={person.surname}>
|
|
|
```
|
|
|
|
|
|
`Child` is mutating `person` which is owned by `App` without being explicitly "allowed" to do so. This is strongly discouraged since it can create code that is hard to reason about at scale ("who mutated this value?"), hence the warning.
|
|
|
|
|
|
To fix it, either create callback props to communicate changes, or mark `person` as [`$bindable`]($bindable).
|
|
|
|
|
|
### select_multiple_invalid_value
|
|
|
|
|
|
```
|
|
|
The `value` property of a `<select multiple>` element should be an array, but it received a non-array value. The selection will be kept as is.
|
|
|
```
|
|
|
|
|
|
When using `<select multiple value={...}>`, Svelte will mark all selected `<option>` elements as selected by iterating over the array passed to `value`. If `value` is not an array, Svelte will emit this warning and keep the selected options as they are.
|
|
|
|
|
|
To silence the warning, ensure that `value`:
|
|
|
|
|
|
- is an array for an explicit selection
|
|
|
- is `null` or `undefined` to keep the selection as is
|
|
|
|
|
|
### state_proxy_equality_mismatch
|
|
|
|
|
|
```
|
|
|
Reactive `$state(...)` proxies and the values they proxy have different identities. Because of this, comparisons with `%operator%` will produce unexpected results
|
|
|
```
|
|
|
|
|
|
`$state(...)` creates a [proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) of the value it is passed. The proxy and the value have different identities, meaning equality checks will always return `false`:
|
|
|
|
|
|
```svelte
|
|
|
<script>
|
|
|
let value = { foo: 'bar' };
|
|
|
let proxy = $state(value);
|
|
|
|
|
|
value === proxy; // always false
|
|
|
</script>
|
|
|
```
|
|
|
|
|
|
To resolve this, ensure you're comparing values where both values were created with `$state(...)`, or neither were. Note that `$state.raw(...)` will _not_ create a state proxy.
|
|
|
|
|
|
### svelte_boundary_reset_noop
|
|
|
|
|
|
```
|
|
|
A `<svelte:boundary>` `reset` function only resets the boundary the first time it is called
|
|
|
```
|
|
|
|
|
|
When an error occurs while rendering the contents of a [`<svelte:boundary>`](https://svelte.dev/docs/svelte/svelte-boundary), the `onerror` handler is called with the error plus a `reset` function that attempts to re-render the contents.
|
|
|
|
|
|
This `reset` function should only be called once. After that, it has no effect — in a case like this, where a reference to `reset` is stored outside the boundary, clicking the button while `<Contents />` is rendered will _not_ cause the contents to be rendered again.
|
|
|
|
|
|
```svelte
|
|
|
<script>
|
|
|
let reset;
|
|
|
</script>
|
|
|
|
|
|
<button onclick={reset}>reset</button>
|
|
|
|
|
|
<svelte:boundary onerror={(e, r) => (reset = r)}>
|
|
|
<!-- contents -->
|
|
|
|
|
|
{#snippet failed(e)}
|
|
|
<p>oops! {e.message}</p>
|
|
|
{/snippet}
|
|
|
</svelte:boundary>
|
|
|
```
|
|
|
|
|
|
### transition_slide_display
|
|
|
|
|
|
```
|
|
|
The `slide` transition does not work correctly for elements with `display: %value%`
|
|
|
```
|
|
|
|
|
|
The [slide](/docs/svelte/svelte-transition#slide) transition works by animating the `height` of the element, which requires a `display` style like `block`, `flex` or `grid`. It does not work for:
|
|
|
|
|
|
- `display: inline` (which is the default for elements like `<span>`), and its variants like `inline-block`, `inline-flex` and `inline-grid`
|
|
|
- `display: table` and `table-[name]`, which are the defaults for elements like `<table>` and `<tr>`
|
|
|
- `display: contents`
|
