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 Snippet type #9584

Merged
merged 2 commits into from
Nov 21, 2023
Merged

feat: add Snippet type #9584

merged 2 commits into from
Nov 21, 2023

Conversation

dummdidumm
Copy link
Member

Intended usage is something like this:

let { banner } = $props<{ banner: Snippet<boolean> }>();

Language tools will adjust its output to type all snippets as a Snippet<..> variable, which guards against people passing in regular functions to snippet props.

related to #9447

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Copy link

changeset-bot bot commented Nov 21, 2023

🦋 Changeset detected

Latest commit: 6fdd8a6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Nov 21, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
svelte-5-preview ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2023 2:19pm

@Rich-Harris Rich-Harris merged commit 1003acc into main Nov 21, 2023
8 checks passed
@Rich-Harris Rich-Harris deleted the snippet-type branch November 21, 2023 15:52
@aradalvand
Copy link

aradalvand commented Nov 23, 2023

@dummdidumm Is there a reason the Snippet type doesn't allow more than a single parameter? Isn't that a bit of an arbitrary limitation?

@dummdidumm
Copy link
Member Author

dummdidumm commented Nov 23, 2023

Because only one parameter is allowed due to how code generation works. You can use destructuring to get the same result as having multiple arguments. It's also consistent with $props that way which might refactoring a bit easier if you decide to turn a snippet into a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants