Skip to content

docs: disable data-sveltekit-preload-data with "off" instead of false#10460

Closed
alesvaupotic wants to merge 1 commit into
sveltejs:masterfrom
alesvaupotic:patch-1
Closed

docs: disable data-sveltekit-preload-data with "off" instead of false#10460
alesvaupotic wants to merge 1 commit into
sveltejs:masterfrom
alesvaupotic:patch-1

Conversation

@alesvaupotic

@alesvaupotic alesvaupotic commented Jul 31, 2023

Copy link
Copy Markdown

Late versions of Kit prefer off over false, as in:

Unexpected value for preload-data — should be one of "", "off", "tap", "hover"

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

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:.

@alesvaupotic
Disabling preload data with "off" instead of "false"
079f86c 
Late versions of Kit prefer off over false, as in:

Unexpected value for preload-data — should be one of "", "off", "tap", "hover"
@changeset-bot

changeset-bot Bot commented Jul 31, 2023

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 079f86c

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

@teemingc

teemingc commented Aug 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

There are currently plans to deprecate the "off" option in favour of "false" according to sveltejs/svelte#8638 and #10039

That being said, it seems odd that the preload link options do not accept "false" at the moment (despite the docs saying they do). Maybe they should? But what setting would take place if the value is "true"?

kit/packages/kit/src/runtime/client/utils.js

Lines 33 to 34 in 4e62135

'preload-code': ['', 'off', 'tap', 'hover', 'viewport', 'eager'],
'preload-data': ['', 'off', 'tap', 'hover'],

@gtm-nayan gtm-nayan changed the title Disabling preload data with "off" instead of "false" docs: Disabling preload data with "off" instead of "false" Aug 2, 2023
@benmccann benmccann changed the title docs: Disabling preload data with "off" instead of "false" docs: disable data-sveltekit-preload-data with "off" instead of false Aug 2, 2023
@benmccann benmccann added the documentation Improvements or additions to documentation label Aug 2, 2023
benmccann
benmccann requested changes Aug 10, 2023
View reviewed changes

@benmccann benmccann left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agree it'd be better to accept false than update the docs

@benmccann benmccann removed the documentation Improvements or additions to documentation label Aug 10, 2023
@alesvaupotic

alesvaupotic commented Aug 11, 2023

Copy link
Copy Markdown
Author

False or off, as long as it behaves as documented without shouting at developer. :)

@teemingc teemingc mentioned this pull request Aug 14, 2023
Merged
5 tasks
dummdidumm pushed a commit that referenced this pull request Dec 12, 2023
@teemingc @benmccann
fix: add "false" value to preload link options (#10555)
b320e1e 
closes #10460

---------

Co-authored-by: Ben McCann <[email protected]>
@alesvaupotic alesvaupotic deleted the patch-1 branch December 12, 2023 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benmccann benmccann benmccann requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alesvaupotic @teemingc @benmccann