You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/tutorials/sveltekit.md
+27-27Lines changed: 27 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,17 @@
2
2
3
3
SvelteKit has been a stable popular vote since its launch and with Svelte version 5 releasing recently, as of time of writing, there isn't a better time to show off running it with Deno!
4
4
5
-
Through this tutorial we will walk through setting up a SvelteKit project, made much easier with the sv cli release and look at loading patters.
5
+
Through this tutorial we will walk through setting up a SvelteKit project, made easier with the sv cli release and look at loading patters.
6
6
7
7
You can see the finished app at [GitHub](https://github.com/s-petey/deno-sveltekit)
8
8
9
-
<!-- TODO: Add gif / video of the app sv_create -->
10
-
11
9
## Getting started
12
10
13
11
We can scaffold an application easily with `npx sv create`. This is [SvelteKit's CLI](https://github.com/sveltejs/cli) which has a lot of utility.
All we are doing here is converting our map to an array so we can see them rendered on the `+page.svelte`. Within this page you can remove everything if you'd like or just add the following.
103
+
All we are doing here is converting our map to an array so we can see them rendered on the `+page.svelte`. Within this page you can remove anything you'd like or just add the following.
106
104
107
105
```svelte
108
106
<script lang="ts">
@@ -121,14 +119,14 @@ Notice while you are working with `data` we have type safety to know that `data.
121
119
122
120
### Adding an individual Dino page
123
121
124
-
Now that we are rendering each dino and have links on each of them setup we can add a route to handle rendering this data.
122
+
Now that we are rendering each dino and have links on each of them setup, we can add a route to handle rendering this data.
125
123
126
124
```
127
125
src/routes/[name]/+page.server.ts
128
126
src/routes/[name]/+page.svelte
129
127
```
130
128
131
-
There is something neat and unique about this route. I am sure you noticed the `[name]` inserted as a folder name. This allows us to have a named route parameter. We could have used anything as the `name` here, however we want to be able to route to `localhost:5173/Ingenia` and see our dinosaur and since that is the name I've used the parameter `name`.
129
+
There is something neat and unique about this route. I am sure you noticed the `[name]` inserted as a folder name. This allows us to have a named route parameter. We could have used anything as the `name`, however we want to be able to route to `localhost:5173/Ingenia` and see our dinosaur and since that is the name I've used the parameter `name`.
132
130
133
131
With that explained now we can access this without our server loader to get our dino and send it to the page!
134
132
@@ -164,7 +162,7 @@ This is a very simple page, feel free to spruce up the styles here or add your o
164
162
<h1>{page.status}: {page.error?.message}</h1>
165
163
```
166
164
167
-
We simply want to show that something went wrong and with the `page` exposed by SvelteKit we can show the status code thrown and if there was a message attached to the error.
165
+
We simply want to show that something went wrong and with the `page` exposed by SvelteKit, we can show the status code thrown and if there was a message attached to the error.
168
166
169
167
Now with that pesky error distraction handled, pun intended, we can get back to showing our individual dinosaur!
170
168
@@ -179,15 +177,15 @@ Now with that pesky error distraction handled, pun intended, we can get back to
179
177
<p>{data.description}</p>
180
178
```
181
179
182
-
Sorry for the simplicity of styling here, but you can see here we still get the type safety knowing a `name` and `description` will exist on our data and we can render it!
180
+
Starting to work on this page you can see we still get the type safety knowing a `name` and `description` will exist on our data and we can render it!
183
181
184
-
However there is another problem if you navigate to this page, either by clicking on one of the links on the main page or by manually adding the dinosaur name to the URL we have no way of getting back!
182
+
However, there is another problem if you navigate to this page, either by clicking on one of the links on the main page or by manually adding the dinosaur name to the URL we have no way of getting back!
185
183
186
184
### Layouts
187
185
188
-
We want to have a standard layout so that our pages can share different information or links. This can be achieved through `+layout.svelte` pages lets go ahead and update the one up at the root of the `routes` directory.
186
+
We want to have a standard layout so that our pages can share different information or links. This can be achieved through `+layout.svelte` pages. Lets go ahead and update the one up at the root of the `routes` directory.
189
187
190
-
There are a few things we want to achieve here:
188
+
Here are a few things we want to achieve:
191
189
192
190
1. Allow users to navigate to the home page
193
191
2. Show the awesome docs for Deno and SvelteKit
@@ -218,17 +216,17 @@ There are a few things we want to achieve here:
218
216
</footer>
219
217
```
220
218
221
-
We are seeing `{@render children()}` for the first time here. All it does is works as an "outlet" if you are coming from the React world to just render whatever other child page may need to be output there.
219
+
As you see, we are seeing `{@render children()}` for the first time. This just works as an "outlet" if you are coming from the React world to render whatever other child page may need to be output.
222
220
223
-
Now if you go back to your application you can see our heading `h1` has a link to go back to the home page!
221
+
Going back to your application you can see our heading `h1` has a link to go back to the home page.
224
222
225
223
### Advanced routing, search parameters, and styling
226
224
227
-
We don't want to render all of the dinos at a single time as that is too much to scroll through. We want our users to be able to search and click through pages of dinosaurs. This will also showcase another awesome Svelte 5 feature, snippets!
225
+
We don't want to render all of the dinos at a single time; as that is too much to scroll through. We want our users to be able to search and click through pages of dinosaurs, which will also showcase another awesome Svelte 5 feature, snippets!
228
226
229
227
Lets open our main page and its server page to make a few changes.
230
228
231
-
Previously we were just returning an array version of our dinos lets allow users to search them and add some pagination logic.
229
+
Previously we were returning an array version of our dinos, lets allow users to search them and add some pagination logic.
Wuuf that was a lot of work and with it out of the way lets get some pagination and search inputs added to the UI!
296
+
Wuuf, that was a lot of work, and with it out of the way lets get some pagination and search inputs added to the UI!
299
297
300
298
```svelte
301
299
<script lang="ts">
@@ -406,10 +404,12 @@ Wuuf that was a lot of work and with it out of the way lets get some pagination
406
404
407
405
Notice for the input we use `defaultValue={data.q ?? ''}` so that when it is rendered in the UI we don't get `undefined` or `null` showing.
408
406
409
-
With snippets you can create re-useable parts of Svelte code for easier rendering. `{#snippet pageButton(...)}` allows us to define the section to be rendered. Then we can use it and pass the required type safe parameters using `{@render pageButton(...)}`. You can see this for all of the pagination buttons.
407
+
With snippets you can create re-useable parts of Svelte code for easier rendering. `{#snippet pageButton(...)}` allows us to define the section to be rendered. We can then use it and pass the required type safe parameters using `{@render pageButton(...)}`. You can see this for all of the pagination buttons.
410
408
411
-
Another neat Svelte trick is that whenever we have `<style>` defined on the page that is scoped only to the file it is used in. So we are able to add these classes knowing that it will not effect any of our other files if they also used that styling.
409
+
Another neat Svelte trick is whenever `<style>`is defined on the page, it is scoped only to the file it is used in. So we are able to add these classes knowing that it will not affect any of our other files if they also used that styling.
412
410
413
411
I have updated some of the styling to make it more pleasant to look at, but I know you have great taste and are free to make it look however you'd like!
414
412
415
-
<!-- TODO: Add video of application running app_showcase -->
0 commit comments