Skip to content

breaking: add $props.bindable() #10804

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
wants to merge 20 commits into from
Closed

breaking: add $props.bindable() #10804

wants to merge 20 commits into from

Conversation

dummdidumm
Copy link
Member

@dummdidumm dummdidumm commented Mar 14, 2024

closes #10768
closes #10711

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 Mar 14, 2024

⚠️ No Changeset found

Latest commit: 6f8a451

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@dummdidumm dummdidumm changed the title Props bindable breaking: add $props.bindable() Mar 14, 2024
@@ -0,0 +1,4 @@
<script>
let { x } = $props();
x.y = 1;
Copy link
Member Author

@dummdidumm dummdidumm Mar 15, 2024

Choose a reason for hiding this comment

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

yay or nay for throwing a compiler error in this case? The argument against it would be setters on a class, but I'm wondering how big of a deal it really is to make the prop bindable in that case, since this will in the vast majority of cases guide people towards the right outcome. Another argument for keeping it is that besides the runtime error telling you that you can't bind: to a prop when it's not declared with $props.bindable() is the only runtime error you get. When mutating a prop, you'll only get the "you better not mutate this" warning.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ugh .. if we keep the compiler error then we need to have a SvelteKit release veeery soon after it, because, as you can see, the site won't build right now since we're getting a compiler error for our generated root.svelte.

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.

Explicit bindings with $props.bindable() Svelte 5: Allow updating the value of restProps properties if they are bind to
1 participant