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: allow link options to be set to true and false #10039

Merged
merged 3 commits into from May 26, 2023

Conversation

GitRowin
Copy link
Contributor

@GitRowin GitRowin commented May 25, 2023

Closes #9396

Requires this and this to be updated if the SvelteKit maintainers are okay with merging this.

Please don't delete this checklist! 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
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

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

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@changeset-bot
Copy link

changeset-bot bot commented May 25, 2023

🦋 Changeset detected

Latest commit: 9a9f6b9

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Minor

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

@Rich-Harris
Copy link
Member

Thank you! I'm in favour of this change, though we should probably also update these docs to recommend "false" instead of "off": https://kit.svelte.dev/docs/link-options#disabling-options

I also wonder if we should (non-breakingly) deprecate "off" in favour of "false", in other words print a warning when encountering it? This would make it easy to remove off in future, instead of allowing multiple ways of doing the same thing.

@Rich-Harris
Copy link
Member

On second thoughts, we should release a version of SvelteKit that respects "false", then update HTMLAttributes accordingly, then deprecate off, otherwise people might get a warning telling them to make an update that will cause a red squiggly. So I think this PR is good to go as-is

@Rich-Harris
Copy link
Member

opened sveltejs/svelte#8638

@GitRowin
Copy link
Contributor Author

I am in favor of deprecating off sooner or later. It makes the link options less confusing ("Is there a difference between off and false?") and more consistent ("Why does off exist but not on?").

The off value is probably not used that frequently, so it shouldn't cause much annoyance.

@Rich-Harris Rich-Harris merged commit 86dd16c into sveltejs:master May 26, 2023
13 checks passed
@github-actions github-actions bot mentioned this pull request May 26, 2023
@GitRowin GitRowin deleted the attribute-true branch May 27, 2023 10:38
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.

Accept 'true' as a valid value for data-sveltekit-noscroll
2 participants