From d216abf57f47903e3f6a3274c49b20a3c1a33c12 Mon Sep 17 00:00:00 2001 From: Simon Holthausen Date: Wed, 23 Oct 2024 20:46:55 +0200 Subject: [PATCH 1/3] chore: tweak MountOptions docs view wording tweaks, and most importantly mark `events` as deprecated - we don't want to encourage its use. --- packages/svelte/src/index.d.ts | 8 +++++--- packages/svelte/types/index.d.ts | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/packages/svelte/src/index.d.ts b/packages/svelte/src/index.d.ts index 81dc936147fa..00179d8db427 100644 --- a/packages/svelte/src/index.d.ts +++ b/packages/svelte/src/index.d.ts @@ -320,19 +320,21 @@ export type MountOptions = Record */ target: Document | Element | ShadowRoot; /** - * Optional node inside `target` and when specified, it is used to render the component immediately before it. + * Optional node inside `target`. When specified, it is used to render the component immediately before it. */ anchor?: Node; /** * Allows the specification of events. + * @deprecated Use callback props instead. */ events?: Record any>; /** - * Used to define context at the component level. + * Context that can be access via `getContext()` at the component level. */ context?: Map; /** - * Used to control transition playback on initial render. The default value is `true` to run transitions. + * Whether or not to play transitions on initial render. + * @default true */ intro?: boolean; } & ({} extends Props diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts index df4c04db0173..58bec3e06e5d 100644 --- a/packages/svelte/types/index.d.ts +++ b/packages/svelte/types/index.d.ts @@ -317,19 +317,21 @@ declare module 'svelte' { */ target: Document | Element | ShadowRoot; /** - * Optional node inside `target` and when specified, it is used to render the component immediately before it. + * Optional node inside `target`. When specified, it is used to render the component immediately before it. */ anchor?: Node; /** * Allows the specification of events. + * @deprecated Use callback props instead. */ events?: Record any>; /** - * Used to define context at the component level. + * Context that can be access via `getContext()` at the component level. */ context?: Map; /** - * Used to control transition playback on initial render. The default value is `true` to run transitions. + * Whether or not to play transitions on initial render. + * @default true */ intro?: boolean; } & ({} extends Props From cf0584e661604a016997d487532a7faaaa9f04ad Mon Sep 17 00:00:00 2001 From: Simon H <5968653+dummdidumm@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:54:49 +0200 Subject: [PATCH 2/3] Update packages/svelte/src/index.d.ts Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> --- packages/svelte/src/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/svelte/src/index.d.ts b/packages/svelte/src/index.d.ts index 00179d8db427..76ea112cd28b 100644 --- a/packages/svelte/src/index.d.ts +++ b/packages/svelte/src/index.d.ts @@ -329,7 +329,7 @@ export type MountOptions = Record */ events?: Record any>; /** - * Context that can be access via `getContext()` at the component level. + * Can be accessed via `getContext()` at the component level. */ context?: Map; /** From 6c3d46110bd548c601e51a333066ea95cf05a08e Mon Sep 17 00:00:00 2001 From: Simon H <5968653+dummdidumm@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:59:03 +0200 Subject: [PATCH 3/3] Update packages/svelte/types/index.d.ts --- packages/svelte/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts index 58bec3e06e5d..49ff2db8ceab 100644 --- a/packages/svelte/types/index.d.ts +++ b/packages/svelte/types/index.d.ts @@ -326,7 +326,7 @@ declare module 'svelte' { */ events?: Record any>; /** - * Context that can be access via `getContext()` at the component level. + * Can be accessed via `getContext()` at the component level. */ context?: Map; /**