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

docs: Fixes swapped logic for readonly function bindings #15162

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

a-theriault
Copy link

@a-theriault a-theriault commented Jan 31, 2025

Read-only bindings should have the SET value assigned to null, not the GET.

e.g. this:
<input type="checkbox" bind:indeterminate={null, () => true} />

...fails, while this:

<input type="checkbox" bind:indeterminate={() => true, null} />

...works as expected.
(note: ts doesn't love this, prefers: <input type="checkbox" bind:indeterminate={() => true, () => null} />)

Question: should I also add explicit wording for bind:indeterminate since it no longer works without explicitly defining a getter/setter:

<input type="checkbox" bind:indeterminate={true} />

Fails.

<input type="checkbox" bind:indeterminate={() => true, null} />

is the only way this binding currently works in Svelte5.

Alternatively, should support for indeterminate={true} be a feat: ticket?

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.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

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

Read-only bindings should have the SET value assigned to null, not the get.

Question: should I add a line-item for bind:indeterminate since it no longer works without explicitly defining a getter/setter, e.g.

<input type="checkbox" bind:indeterminate={true, null} />

is the only way this binding currently works in Svelte5.
Copy link

changeset-bot bot commented Jan 31, 2025

⚠️ No Changeset found

Latest commit: 664b9fe

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

@a-theriault a-theriault changed the title Fixes swapped logic for readonly function bindings docs: Fixes swapped logic for readonly function bindings Jan 31, 2025
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.

1 participant