Skip to content

Commit c7a195a

Browse files
authored
docs: note embedded mode limitations (#11555)
related #11545
1 parent b440214 commit c7a195a

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

packages/kit/src/exports/public.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,7 @@ export interface KitConfig {
349349
};
350350
/**
351351
* Whether or not the app is embedded inside a larger app. If `true`, SvelteKit will add its event listeners related to navigation etc on the parent of `%sveltekit.body%` instead of `window`, and will pass `params` from the server rather than inferring them from `location.pathname`.
352+
* Note that it is generally not supported to embed multiple SvelteKit apps on the same page and use client-side SvelteKit features within them (things such as pushing to the history state assume a single instance).
352353
* @default false
353354
*/
354355
embedded?: boolean;

packages/kit/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,7 @@ declare module '@sveltejs/kit' {
331331
};
332332
/**
333333
* Whether or not the app is embedded inside a larger app. If `true`, SvelteKit will add its event listeners related to navigation etc on the parent of `%sveltekit.body%` instead of `window`, and will pass `params` from the server rather than inferring them from `location.pathname`.
334+
* Note that it is generally not supported to embed multiple SvelteKit apps on the same page and use client-side SvelteKit features within them (things such as pushing to the history state assume a single instance).
334335
* @default false
335336
*/
336337
embedded?: boolean;

0 commit comments

Comments
 (0)