Skip to content

docs: Clarify when is a variable proxied #15804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Clarify when is a variable proxied #15804

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbc8106
Update 02-$state.md
sacrosanctic Apr 19, 2025
9a37a6e
Update 02-$state.md
sacrosanctic Apr 19, 2025
9f4eeb7
Update 02-$state.md
sacrosanctic Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/docs/02-runes/02-$state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Unlike other frameworks you may have encountered, there is no API for interactin

If `$state` is used with an array or a simple object, the result is a deeply reactive _state proxy_. [Proxies](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) allow Svelte to run code when you read or write properties, including via methods like `array.push(...)`, triggering granular updates.

> [!NOTE] Classes like `Set` and `Map` will not be proxied, but Svelte provides reactive implementations for various built-ins like these that can be imported from [`svelte/reactivity`](./svelte-reactivity).
> [!NOTE] Classes will not be proxied. Reactivity should be [implemented explicitly](./$state#Classes). Reactive implementations for various built-ins that can be imported from [`svelte/reactivity`](./svelte-reactivity).

State is proxified recursively until Svelte finds something other than an array or simple object. In a case like this...

Expand Down