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.

Sign up for GitHub

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

Replace data-sveltekit-prefetch/prefetch(...)/prefetchRoutes(...) #7776

Merged
merged 34 commits into from
Nov 28, 2022
Merged

Replace data-sveltekit-prefetch/prefetch(...)/prefetchRoutes(...) #7776

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
7aec177
rename prefetch -> preload and prefetchRoutes -> prepare, tweak prepa…
Rich-Harris Nov 22, 2022
ed76835
rename data-sveltekit-prefetch to data-sveltekit-preload
Rich-Harris Nov 22, 2022
8ef3787
update migration guide
Rich-Harris Nov 22, 2022
b527f88
various
Rich-Harris Nov 22, 2022
cf31708
shuffle some things around
Rich-Harris Nov 22, 2022
bca2620
refactor a tiny bit
Rich-Harris Nov 22, 2022
30df4fe
fix
Rich-Harris Nov 23, 2022
2b940ff
implement data-sveltekit-prepare
Rich-Harris Nov 23, 2022
ff05f38
make it slightly more self-contained
Rich-Harris Nov 23, 2022
5eac541
keyboard events
Rich-Harris Nov 23, 2022
44a6f32
named constants
Rich-Harris Nov 23, 2022
c8c0332
handle malformed URLs
Rich-Harris Nov 23, 2022
20068be
merge master
Rich-Harris Nov 26, 2022
8d8bf76
rename
Rich-Harris Nov 26, 2022
0a592bf
use data-sveltekit-preload-code and data-sveltekit-preload-data
Rich-Harris Nov 26, 2022
b2ae571
rename stuff
Rich-Harris Nov 26, 2022
b5cec95
fix
Rich-Harris Nov 26, 2022
3920671
docs
Rich-Harris Nov 27, 2022
d0ab6b9
missed a spot
Rich-Harris Nov 27, 2022
09028cb
changesets
Rich-Harris Nov 27, 2022
bb356d9
clarification
Rich-Harris Nov 27, 2022
cfe78b2
fix migration guide
Rich-Harris Nov 27, 2022
e3428a2
tidy up
Rich-Harris Nov 27, 2022
bd470a3
feat: Typing improvements to preload PR (#7841)
elliott-with-the-longest-name-on-github Nov 28, 2022
3338a6d
Update documentation/docs/30-advanced/30-link-options.md
Rich-Harris Nov 28, 2022
d483848
move up explanation of mobile behaviour
Rich-Harris Nov 28, 2022
5f3a7aa
clarify
Rich-Harris Nov 28, 2022
8abb732
Merge branch 'gh-7289' of github.com:sveltejs/kit into gh-7289
Rich-Harris Nov 28, 2022
e69e30a
Update packages/kit/src/runtime/client/client.js
Rich-Harris Nov 28, 2022
9fde16c
change "page" to "eager"
Rich-Harris Nov 28, 2022
eae754a
Merge branch 'gh-7289' of github.com:sveltejs/kit into gh-7289
Rich-Harris Nov 28, 2022
bb73d82
make side-effecty
Rich-Harris Nov 28, 2022
6e32028
oops
Rich-Harris Nov 28, 2022
2553a9d
fix docs
Rich-Harris Nov 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use data-sveltekit-preload-code and data-sveltekit-preload-data
  • Loading branch information
@Rich-Harris
Rich-Harris committed Nov 26, 2022
commit 0a592bff74fe6c55d832fd38edaced6c055ee0c9
2 changes: 1 addition & 1 deletion packages/create-svelte/templates/default/src/app.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width" />
%sveltekit.head%
</head>
<body data-sveltekit-preload>
<body data-sveltekit-preload-data>
<div style="display: contents">%sveltekit.body%</div>
</body>
</html>
12 changes: 6 additions & 6 deletions packages/kit/src/runtime/client/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ export function find_anchor(element, base) {
}

if (a) {
if (preload === null) preload = element.getAttribute('data-sveltekit-preload');
if (prepare === null) prepare = element.getAttribute('data-sveltekit-prepare');
if (preload === null) preload = element.getAttribute('data-sveltekit-preload-data');
if (prepare === null) prepare = element.getAttribute('data-sveltekit-preload-code');
if (noscroll === null) noscroll = element.getAttribute('data-sveltekit-noscroll');
if (reload === null) reload = element.getAttribute('data-sveltekit-reload');

if (__SVELTEKIT_DEV__) {
validate(element, 'data-sveltekit-preload', preload, ['', 'off', 'tap', 'hover']);
validate(element, 'data-sveltekit-preload', prepare, [
validate(element, 'data-sveltekit-preload-data', preload, ['', 'off', 'tap', 'hover']);
validate(element, 'data-sveltekit-preload-data', prepare, [
'',
'off',
'tap',
Expand All @@ -99,8 +99,8 @@ export function find_anchor(element, base) {
'page'
]);

validate(element, 'data-sveltekit-preload', noscroll, ['', 'off']);
validate(element, 'data-sveltekit-preload', reload, ['', 'off']);
validate(element, 'data-sveltekit-preload-data', noscroll, ['', 'off']);
validate(element, 'data-sveltekit-preload-data', reload, ['', 'off']);
}
}

Expand Down
6 changes: 3 additions & 3 deletions packages/kit/test/apps/basics/src/routes/data-sveltekit/preload/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a id="one" href="/data-sveltekit/preload/target" data-sveltekit-preload>one</a>
<a id="one" href="/data-sveltekit/preload/target" data-sveltekit-preload-data>one</a>

<div data-sveltekit-preload>
<div data-sveltekit-preload-data>
<a id="two" href="/data-sveltekit/preload/target">two</a>
<a id="three" href="/data-sveltekit/preload/target" data-sveltekit-preload="off">three</a>
<a id="three" href="/data-sveltekit/preload/target" data-sveltekit-preload-data="off">three</a>
</div>
2 changes: 1 addition & 1 deletion packages/kit/test/apps/basics/test/client.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1049,7 +1049,7 @@ test.describe.serial('Invalidation', () => {
});

test.describe('data-sveltekit attributes', () => {
test('data-sveltekit-preload', async ({ baseURL, page }) => {
test('data-sveltekit-preload-data', async ({ baseURL, page }) => {
/** @type {string[]} */
const requests = [];
page.on('request', (r) => requests.push(r.url()));
Expand Down
2 changes: 1 addition & 1 deletion packages/kit/test/apps/options/source/pages/preloading/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<a data-sveltekit-preload href="/path-base/preloading/preloaded">click me</a>
<a data-sveltekit-preload-data href="/path-base/preloading/preloaded">click me</a>
2 changes: 1 addition & 1 deletion packages/kit/types/ambient.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ declare module '$app/navigation' {
* 1. ensuring that the code for the page is loaded, and
* 2. calling the page's load function with the appropriate options.
*
* This is the same behaviour that SvelteKit triggers when the user taps or mouses over an `<a>` element with `data-sveltekit-preload`.
* This is the same behaviour that SvelteKit triggers when the user taps or mouses over an `<a>` element with `data-sveltekit-preload-data`.
* If the next navigation is to `href`, the values returned from load will be used, making navigation instantaneous.
* Returns a Promise that resolves when the preload is complete.
*
Expand Down
2 changes: 1 addition & 1 deletion sites/kit.svelte.dev/src/lib/docs/Contents.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{#each section.pages as { title, path }}
<li>
<a
data-sveltekit-preload
data-sveltekit-preload-data
class="page"
class:active={path === $page.url.pathname}
href={path}
Expand Down
2 changes: 1 addition & 1 deletion sites/kit.svelte.dev/src/lib/search/SearchResultList.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
{#each results as result, i}
<li>
<a
data-sveltekit-preload
data-sveltekit-preload-data
href={result.href}
on:click={() => dispatch('select', { href: result.href })}
data-has-node={result.node ? true : undefined}
Expand Down
6 changes: 3 additions & 3 deletions sites/kit.svelte.dev/src/routes/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
of an SPA
</p>

<a data-sveltekit-preload href="/docs" class="cta">read the docs</a>
<a data-sveltekit-preload-data href="/docs" class="cta">read the docs</a>
</div>

<div slot="three">
Expand All @@ -51,7 +51,7 @@
support and more
</p>

<a data-sveltekit-preload href="/docs" class="cta">read the docs</a>
<a data-sveltekit-preload-data href="/docs" class="cta">read the docs</a>
</div>

<div class="description" slot="what">
Expand All @@ -78,7 +78,7 @@ cd my-app
npm install
npm run dev -- --open</code
></pre>
<a data-sveltekit-preload href="/docs" class="cta">get started</a>
<a data-sveltekit-preload-data href="/docs" class="cta">get started</a>
</div>
</Blurb>
</div>
Expand Down