chore: tweak MountOptions docs (#13841)

A few wording tweaks, and most importantly mark `events` as deprecated - we don't want to encourage its use.
pull/13757/head
Simon H 11 months ago committed by GitHub
parent 134049f6d3
commit 44c8889291
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -320,19 +320,21 @@ export type MountOptions<Props extends Record<string, any> = Record<string, any>
*/ */
target: Document | Element | ShadowRoot; 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; anchor?: Node;
/** /**
* Allows the specification of events. * Allows the specification of events.
* @deprecated Use callback props instead.
*/ */
events?: Record<string, (e: any) => any>; events?: Record<string, (e: any) => any>;
/** /**
* Used to define context at the component level. * Can be accessed via `getContext()` at the component level.
*/ */
context?: Map<any, any>; context?: Map<any, any>;
/** /**
* 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; intro?: boolean;
} & ({} extends Props } & ({} extends Props

@ -317,19 +317,21 @@ declare module 'svelte' {
*/ */
target: Document | Element | ShadowRoot; 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; anchor?: Node;
/** /**
* Allows the specification of events. * Allows the specification of events.
* @deprecated Use callback props instead.
*/ */
events?: Record<string, (e: any) => any>; events?: Record<string, (e: any) => any>;
/** /**
* Used to define context at the component level. * Can be accessed via `getContext()` at the component level.
*/ */
context?: Map<any, any>; context?: Map<any, any>;
/** /**
* 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; intro?: boolean;
} & ({} extends Props } & ({} extends Props

Loading…
Cancel
Save