Skip to content

feat: add optional compiler-ignore attribute to <slot> #8057

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

Closed
wants to merge 1 commit into from
Closed

feat: add optional compiler-ignore attribute to <slot> #8057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions site/content/docs/03-template-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1609,6 +1609,14 @@ Named slots can also expose values. The `let:` directive goes on the element wit
</FancyList>
```

---

Svelte can also instructed to ignore a `<slot>` element and treat it in a semantically generic way so that that `<slot>` can retain its default behavior as an HTML Element.
This is useful if you are rendering your Svelte application to a `shadowRoot` and you wish to have slotted content come from the light DOM outside of the Svelte application

```sv
<slot name="some-slot" compiler-ignore></slot>
```

### `<svelte:self>`

Expand Down
13 changes: 12 additions & 1 deletion src/compiler/compile/nodes/shared/map_children.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,22 @@ function get_constructor(type) {
}
}

function should_treat_as_element(child: TemplateNode) {
switch (child.type) {
case 'Slot':
return child.attributes.some((attr) => attr.name === 'compiler-ignore' && attr.value);
default: return false;
}
}

export default function map_children(component, parent, scope, children: TemplateNode[]) {
let last = null;
let ignores = [];

return children.map(child => {
return children.map(child => {
if (should_treat_as_element(child)) {
child.type = 'Element';
}
const constructor = get_constructor(child.type);

const use_ignores = child.type !== 'Text' && child.type !== 'Comment' && ignores.length;
Expand Down
4 changes: 3 additions & 1 deletion test/runtime/samples/$$slot/A.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@ $$slots: {toString($$slots)}
</div>
{:else}
Slot b is not available
{/if}
{/if}

<slot compiler-ignore name="c"></slot>
2 changes: 2 additions & 0 deletions test/runtime/samples/$$slot/_config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ export default {
<span slot="a">hello world</span>
$$slots: {"a":true,"default":true}
Slot b is not available
<slot compiler-ignore name="c"></slot>

<span>bye world</span>
<span slot="a">hello world</span>
$$slots: {"a":true,"b":true,"default":true}
<div><span slot="b">hello world</span></div>
<slot compiler-ignore name="c"></slot>
`,

async test({ assert, component }) {
Expand Down