Skip to content

Commit 8df29aa

Browse files
authored
Merge branch 'main' into svelte-html
2 parents dd748e2 + 8ba1b9d commit 8df29aa

File tree

208 files changed

+2170
-11277
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

208 files changed

+2170
-11277
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'svelte': patch
3+
---
4+
5+
fix: avoid mutation validation for invalidate_inner_signals

documentation/docs/03-template-syntax/03-each.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ Iterating over values can be done with an each block. The values in question can
2323
</ul>
2424
```
2525

26-
You can use each blocks to iterate over any array or array-like value — that is, any object with a `length` property.
27-
2826
An each block can also specify an _index_, equivalent to the second argument in an `array.map(...)` callback:
2927

3028
```svelte

documentation/docs/03-template-syntax/11-bind.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,34 @@ The general syntax is `bind:property={expression}`, where `expression` is an _lv
1212
<input bind:value />
1313
```
1414

15+
1516
Svelte creates an event listener that updates the bound value. If an element already has a listener for the same event, that listener will be fired before the bound value is updated.
1617

1718
Most bindings are _two-way_, meaning that changes to the value will affect the element and vice versa. A few bindings are _readonly_, meaning that changing their value will have no effect on the element.
1819

20+
## Function bindings
21+
22+
You can also use `bind:property={get, set}`, where `get` and `set` are functions, allowing you to perform validation and transformation:
23+
24+
```svelte
25+
<input bind:value={
26+
() => value,
27+
(v) => value = v.toLowerCase()}
28+
/>
29+
```
30+
31+
In the case of readonly bindings like [dimension bindings](#Dimensions), the `get` value should be `null`:
32+
33+
```svelte
34+
<div
35+
bind:clientWidth={null, redraw}
36+
bind:clientHeight={null, redraw}
37+
>...</div>
38+
```
39+
40+
> [!NOTE]
41+
> Function bindings are available in Svelte 5.9.0 and newer.
42+
1943
## `<input bind:value>`
2044

2145
A `bind:value` directive on an `<input>` element binds the input's `value` property:

documentation/docs/98-reference/.generated/client-warnings.md

Lines changed: 75 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,31 @@ The easiest way to log a value as it changes over time is to use the [`$inspect`
6666
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
6767
```
6868

69+
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.
70+
71+
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:
72+
73+
```svelte
74+
<script>
75+
let { src } = $props();
76+
77+
if (typeof window !== 'undefined') {
78+
// stash the value...
79+
const initial = src;
80+
81+
// unset it...
82+
src = undefined;
83+
84+
$effect(() => {
85+
// ...and reset after we've mounted
86+
src = initial;
87+
});
88+
}
89+
</script>
90+
91+
<img {src} />
92+
```
93+
6994
### hydration_html_changed
7095
7196
```
@@ -76,6 +101,31 @@ The value of an `{@html ...}` block changed between server and client renders. T
76101
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
77102
```
78103
104+
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.
105+
106+
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:
107+
108+
```svelte
109+
<script>
110+
let { markup } = $props();
111+
112+
if (typeof window !== 'undefined') {
113+
// stash the value...
114+
const initial = markup;
115+
116+
// unset it...
117+
markup = undefined;
118+
119+
$effect(() => {
120+
// ...and reset after we've mounted
121+
markup = initial;
122+
});
123+
}
124+
</script>
125+
126+
{@html markup}
127+
```
128+
79129
### hydration_mismatch
80130
81131
```
@@ -86,6 +136,10 @@ Hydration failed because the initial UI does not match what was rendered on the
86136
Hydration failed because the initial UI does not match what was rendered on the server. The error occurred near %location%
87137
```
88138
139+
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.
140+
141+
During development, this error is often preceeded by a `console.error` detailing the offending HTML, which needs fixing.
142+
89143
### invalid_raw_snippet_render
90144
91145
```
@@ -110,6 +164,10 @@ Tried to unmount a component that was not mounted
110164
%parent% passed a value to %child% with `bind:`, but the value is owned by %owner%. Consider creating a binding between %owner% and %parent%
111165
```
112166

167+
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.
168+
169+
To fix it, `bind:` to the value instead of just passing a property (i.e. in this example do `<Parent bind:value />`).
170+
113171
### ownership_invalid_mutation
114172

115173
```
@@ -120,45 +178,31 @@ Mutating a value outside the component that created it is strongly discouraged.
120178
%component% mutated a value owned by %owner%. This is strongly discouraged. Consider passing values to child components with `bind:`, or use a callback instead
121179
```
122180

123-
### reactive_declaration_non_reactive_property
124-
125-
```
126-
A `$:` statement (%location%) read reactive state that was not visible to the compiler. Updates to this state will not cause the statement to re-run. The behaviour of this code will change if you migrate it to runes mode
127-
```
128-
129-
In legacy mode, a `$:` [reactive statement](https://svelte.dev/docs/svelte/legacy-reactive-assignments) re-runs when the state it _references_ changes. This is determined at compile time, by analysing the code.
130-
131-
In runes mode, effects and deriveds re-run when there are changes to the values that are read during the function's _execution_.
181+
Consider the following code:
132182

133-
Often, the result is the same — for example these can be considered equivalent:
134-
135-
```js
136-
let a = 1, b = 2, sum = 3;
137-
// ---cut---
138-
$: sum = a + b;
139-
```
183+
```svelte
184+
<!--- file: App.svelte --->
185+
<script>
186+
import Child from './Child.svelte';
187+
let person = $state({ name: 'Florida', surname: 'Man' });
188+
</script>
140189

141-
```js
142-
let a = 1, b = 2;
143-
// ---cut---
144-
const sum = $derived(a + b);
190+
<Child {person} />
145191
```
146192
147-
In some cases — such as the one that triggered the above warning — they are _not_ the same:
148-
149-
```js
150-
let a = 1, b = 2, sum = 3;
151-
// ---cut---
152-
const add = () => a + b;
193+
```svelte
194+
<!--- file: Child.svelte --->
195+
<script>
196+
let { person } = $props();
197+
</script>
153198

154-
// the compiler can't 'see' that `sum` depends on `a` and `b`, but
155-
// they _would_ be read while executing the `$derived` version
156-
$: sum = add();
199+
<input bind:value={person.name}>
200+
<input bind:value={person.surname}>
157201
```
158202
159-
Similarly, reactive properties of [deep state](https://svelte.dev/docs/svelte/$state#Deep-state) are not visible to the compiler. As such, changes to these properties will cause effects and deriveds to re-run but will _not_ cause `$:` statements to re-run.
203+
`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.
160204
161-
When you [migrate this component](https://svelte.dev/docs/svelte/v5-migration-guide) to runes mode, the behaviour will change accordingly.
205+
To fix it, either create callback props to communicate changes, or mark `person` as [`$bindable`]($bindable).
162206
163207
### state_proxy_equality_mismatch
164208

documentation/docs/98-reference/.generated/compile-errors.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,16 @@ Sequence expressions are not allowed as attribute/directive values in runes mode
7878
Attribute values containing `{...}` must be enclosed in quote marks, unless the value only contains the expression
7979
```
8080

81+
### bind_group_invalid_expression
82+
83+
```
84+
`bind:group` can only bind to an Identifier or MemberExpression
85+
```
86+
8187
### bind_invalid_expression
8288

8389
```
84-
Can only bind to an Identifier or MemberExpression
90+
Can only bind to an Identifier or MemberExpression or a `{get, set}` pair
8591
```
8692

8793
### bind_invalid_name
@@ -94,6 +100,12 @@ Can only bind to an Identifier or MemberExpression
94100
`bind:%name%` is not a valid binding. %explanation%
95101
```
96102

103+
### bind_invalid_parens
104+
105+
```
106+
`bind:%name%={get, set}` must not have surrounding parentheses
107+
```
108+
97109
### bind_invalid_target
98110

99111
```

0 commit comments

Comments
 (0)