Skip to content

Commit e487f61

Browse files
authored
docs: mark deprecated options as such (#13989)
closes #13984
1 parent 2e9dab6 commit e487f61

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

documentation/docs/05-special-elements/06-svelte-options.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,19 @@ title: <svelte:options>
88

99
The `<svelte:options>` element provides a place to specify per-component compiler options, which are detailed in the [compiler section](svelte-compiler#compile). The possible options are:
1010

11-
- `immutable={true}` — you never use mutable data, so the compiler can do simple referential equality checks to determine if values have changed
12-
- `immutable={false}` — the default. Svelte will be more conservative about whether or not mutable objects have changed
13-
- `accessors={true}` — adds getters and setters for the component's props
14-
- `accessors={false}` — the default
1511
- `runes={true}` — forces a component into _runes mode_ (see the [Legacy APIs](legacy-overview) section)
1612
- `runes={false}` — forces a component into _legacy mode_
17-
- `namespace="..."` — the namespace where this component will be used, most commonly "svg"; use the "foreign" namespace to opt out of case-insensitive attribute names and HTML-specific warnings
13+
- `namespace="..."` — the namespace where this component will be used, can be "html" (the default), "svg" or "mathml"
1814
- `customElement={...}` — the [options](custom-elements#Component-options) to use when compiling this component as a custom element. If a string is passed, it is used as the `tag` option
15+
- `css="injected"` — the component will inject its styles inline: During server side rendering, it's injected as a `<style>` tag in the `head`, during client side rendering, it's loaded via JavaScript
16+
17+
> [!LEGACY] Deprecated options
18+
> Svelte 4 also included the following options. They are deprecated in Svelte 5 and non-functional in runes mode.
19+
>
20+
> - `immutable={true}` — you never use mutable data, so the compiler can do simple referential equality checks to determine if values have changed
21+
> - `immutable={false}` — the default. Svelte will be more conservative about whether or not mutable objects have changed
22+
> - `accessors={true}` — adds getters and setters for the component's props
23+
> - `accessors={false}` — the default
1924
2025
```svelte
2126
<svelte:options customElement="my-custom-element" />

0 commit comments

Comments
 (0)