-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
fix: improve types for props when using Client-side component API #8950
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
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| 'svelte': major | ||
| --- | ||
|
|
||
| improve types for props when using Client-side component API | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
packages/svelte/test/types/component-constructor-options.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* eslint-disable @typescript-eslint/no-unused-vars */ | ||
| import { ComponentConstructorOptions } from '$runtime/internal/public.js'; | ||
|
|
||
| type NoProps = ComponentConstructorOptions; | ||
|
|
||
| const n1: NoProps = { | ||
| target: document.body | ||
| }; | ||
|
|
||
| const n2: NoProps = { | ||
| target: document.body, | ||
| // @ts-expect-error does not accept props | ||
| props: {} | ||
| }; | ||
|
|
||
| const n3: NoProps = { | ||
| target: document.body, | ||
| // @ts-expect-error does not accept any props | ||
| props: { | ||
| img: '' | ||
| } | ||
| }; | ||
|
|
||
| type Props = ComponentConstructorOptions<{ img: string }>; | ||
|
|
||
| // @ts-expect-error | ||
| const p1: Props = { | ||
| target: document.body | ||
| }; | ||
|
|
||
| const p2: Props = { | ||
| target: document.body, | ||
| // @ts-expect-error required prop is missing | ||
| props: {} | ||
| }; | ||
|
|
||
| const p3: Props = { | ||
| target: document.body, | ||
| props: { | ||
| img: '' | ||
| } | ||
| }; | ||
|
|
||
| type OptionalProps = ComponentConstructorOptions<{ img?: string }>; | ||
|
|
||
| const o1: OptionalProps = { | ||
| target: document.body | ||
| }; | ||
|
|
||
| const o2: OptionalProps = { | ||
| target: document.body, | ||
| props: {} | ||
| }; | ||
|
|
||
| const o3: OptionalProps = { | ||
| target: document.body, | ||
| props: { | ||
| img: '' | ||
| } | ||
| }; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be minor, unless its for svelte 5? 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just updated it because it is a breaking change ^^. So it belongs to version 5, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's correct. Marking this as draft so it's not accidentally merged early.