Skip to content

Docs: Updated the custom elements documentation to include $host #16686

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

Merged
merged 5 commits into from
Aug 30, 2025
Merged

Docs: Updated the custom elements documentation to include $host #16686

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a7abf8d
Updated the custom elements documentation to include
Github11200 Aug 28, 2025
bd0403e
moved the rune reference further up
Github11200 Aug 29, 2025
83addfb
Small update to the sentence
Github11200 Aug 29, 2025
6cb43b9
updated the formatting
Github11200 Aug 29, 2025
8050a05
Update documentation/docs/07-misc/04-custom-elements.md
Rich-Harris Aug 30, 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/07-misc/04-custom-elements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Custom elements

<!-- - [basically what we have today](https://svelte.dev/docs/custom-elements-api) -->

Svelte components can also be compiled to custom elements (aka web components) using the `customElement: true` compiler option. You should specify a tag name for the component using the `<svelte:options>` [element](svelte-options).
Svelte components can also be compiled to custom elements (aka web components) using the `customElement: true` compiler option. You should specify a tag name for the component using the `<svelte:options>` [element](svelte-options). Within the custom element you can also access the host element and do things such as dispatching events using the [\$host](https://svelte.dev/docs/svelte/$host) rune.
Copy link
Member

@Ocean-OS Ocean-OS Aug 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

- Svelte components can also be compiled to custom elements (aka web components) using the `customElement: true` compiler option. You should specify a tag name for the component using the `<svelte:options>` [element](svelte-options). Within the custom element you can also access the host element and do things such as dispatching events using the [\$host](https://svelte.dev/docs/svelte/$host) rune.
+ Svelte components can also be compiled to custom elements (aka web components) using the `customElement: true` compiler option. You should specify a tag name for the component using the `<svelte:options>` [element](svelte-options). Within the Svelte component, you can access the host element via the [`$host`](https://svelte.dev/docs/svelte/$host) rune.

might be a bit cleaner, removes "do things" which doesn't sound the best


```svelte
<svelte:options customElement="my-element" />
Expand Down
Loading