Skip to content

Add documentation and tutorial for svelte:fragment #6097

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
Mar 29, 2021
Merged

Add documentation and tutorial for svelte:fragment #6097

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2466f84
Add documentation and tutorial for svelte:fragment
stephane-vanraes Mar 18, 2021
2ddb127
Apply suggestions from code review
stephane-vanraes Mar 19, 2021
a697a2b
Add new line to tutorial
stephane-vanraes Mar 19, 2021
dabe8f8
Apply suggestions for svelte:fragment docs and tut
stephane-vanraes Mar 28, 2021
f409945
Minor tweaks to doc for svelte:fragment
stephane-vanraes Mar 29, 2021
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
44 changes: 44 additions & 0 deletions site/content/docs/02-template-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1328,6 +1328,28 @@ Named slots allow consumers to target specific areas. They can also have fallbac
</Widget>
```

Components can be placed in a named slot using the syntax `<Component slot="name" />`.
In order to place content in a slot without losing the flow layout (ie: without using a wrapper element) you can use the special element `<svelte:fragment>`.

```sv
<!-- Widget.svelte -->
<div>
<slot name="header">No header was provided</slot>
<p>Some content between header and footer</p>
<slot name="footer"></slot>
</div>

<!-- App.svelte -->
<Widget>
<HeaderComponent slot="header" />
<svelte:fragment slot="footer">
<p>All rights reserved.</p>
<p>Copyright (c) 2019 Svelte Industries</p>
</svelte:fragment>
</Widget>
```


#### [`$$slots`](slots_object)

---
Expand Down Expand Up @@ -1537,3 +1559,25 @@ The `<svelte:options>` element provides a place to specify per-component compile
```sv
<svelte:options tag="my-custom-element"/>
```

### `<svelte:fragment>`

The `<svelte:fragment>` element allows you to place content in a named [docs](docs#slot_name) without wrapping it in a container. This keeps the flow layout of your document intact.

```sv
<!-- Widget.svelte -->
<div>
<slot name="header">No header was provided</slot>
<p>Some content between header and footer</p>
<slot name="footer"></slot>
</div>

<!-- App.svelte -->
<Widget>
<h1 slot="header">Hello</h1>
<svelte:fragment slot="footer">
<p>All rights reserved.</p>
<p>Copyright (c) 2019 Svelte Industries</p>
</svelte:fragment>
</Widget>
```
11 changes: 11 additions & 0 deletions site/content/tutorial/16-special-elements/08-svelte-fragment/app-a/App.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
import Box from './Box.svelte'
</script>

<!-- App.svelte -->
<Box>
<div slot="footer">
<p>All rights reserved.</p>
<p>Copyright (c) 2019 Svelte Industries</p>
</div>
</Box>
20 changes: 20 additions & 0 deletions site/content/tutorial/16-special-elements/08-svelte-fragment/app-a/Box.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<style>
.box {
width: 300px;
border: 1px solid #aaa;
border-radius: 2px;
box-shadow: 2px 2px 8px rgba(0,0,0,0.1);
padding: 1em;
margin: 0 0 1em 0;

display: flex;
flex-direction: column;
gap: 1em;
}
</style>

<div class="box">
<slot name="header">No header was provided</slot>
<p>Some content between header and footer</p>
<slot name="footer"></slot>
</div>
11 changes: 11 additions & 0 deletions site/content/tutorial/16-special-elements/08-svelte-fragment/app-b/App.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
import Box from './Box.svelte'
</script>

<!-- App.svelte -->
<Box>
<svelte:fragment slot="footer">
<p>All rights reserved.</p>
<p>Copyright (c) 2019 Svelte Industries</p>
</svelte:fragment>
</Box>
20 changes: 20 additions & 0 deletions site/content/tutorial/16-special-elements/08-svelte-fragment/app-b/Box.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<style>
.box {
width: 300px;
border: 1px solid #aaa;
border-radius: 2px;
box-shadow: 2px 2px 8px rgba(0,0,0,0.1);
padding: 1em;
margin: 0 0 1em 0;

display: flex;
flex-direction: column;
gap: 1em;
}
</style>

<div class="box">
<slot name="header">No header was provided</slot>
<p>Some content between header and footer</p>
<slot name="footer"></slot>
</div>
42 changes: 42 additions & 0 deletions site/content/tutorial/16-special-elements/08-svelte-fragment/text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: <svelte:fragment>
---

The `<svelte:fragment>` element allows you to add content to a named slot without breaking the document's flow layout.

In the example notice how we applied a flex layout with a gap of 2em to the box.

```sv
<!-- Box.svelte -->
<style>
.box {
width: 300px;
border: 1px solid #aaa;
border-radius: 2px;
box-shadow: 2px 2px 8px rgba(0,0,0,0.1);
padding: 1em;
margin: 0 0 1em 0;

display: flex;
flex-direction: column;
gap: 1em;
}
</style>

<div class="box">
<slot name="header">No header was provided</slot>
<p>Some content between header and footer</p>
<slot name="footer"></slot>
</div>
```

However, the content in the footer is not spaced out according to this rhythm because wrapping it in a div created a new flow layout.

We can solve this by changing `<div slot="footer">` in the `App` component:

```sv
<svelte:fragment slot="footer">
<p>All rights reserved.</p>
<p>Copyright (c) 2019 Svelte Industries</p>
</svelte:fragment>
```