Skip to content
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.

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

feat: add PageProps to $./types #12967

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/spotty-jars-kiss.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': major
---

Add 'PageProps' to './$types'
28 changes: 28 additions & 0 deletions documentation/docs/02-runes/05-$props.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Append to the end of page -->
### PageProps

For defining types of `$props` rune in `page.svelte`, you would normally do the following

```svelte
<!--- file: page.svelte --->
<script>
import { PageData } from './$types';

interface Props {
data: PageData;
}

let { data }: Props = $props();
</script>
```

If you don't want to write this for every page, you can do the following instead

```svelte
<!--- file: page.svelte --->
<script>
import { PageProps } from './$types';

let { data }: PageProps = $props();
</script>
```
6 changes: 6 additions & 0 deletions packages/kit/src/core/sync/write_types/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,12 @@ function process_node(node, outdir, is_page, proxies, all_pages_have_load = true

exports.push(`export type ${prefix}Data = ${data};`);

exports.push(
`export type ${prefix}Props = { data: ${prefix}Data; ${
node.server && is_page ? 'form: ActionData; ' : ''
Copy link
Author

Choose a reason for hiding this comment

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

Pretty dumb way to write this I know. I could've pushed this in the nested if above but I just thought writing it below PageData would be more intuitive. Also, didn't know how to add children in LayoutProps since I can't write import("svelte").Snippet as svelte isn't included.

}};`
);

return { declarations, exports, proxies };

/**
Expand Down
Loading