docs: fix ComponentProps info (#13827)

* docs: fix ComponentProps info closes #13770 * fix
sveltejs · Oct 23, 2024 · c603553 · c603553
1 parent 2d69a64
commit c603553
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/packages/svelte/src/index.d.ts b/packages/svelte/src/index.d.ts
@@ -210,9 +210,11 @@ export type ComponentEvents<Comp extends SvelteComponent> =
  * import MyComponent from './MyComponent.svelte';
  *
  * // Errors if these aren't the correct props expected by MyComponent.
- * const props: ComponentProps<MyComponent> = { foo: 'bar' };
+ * const props: ComponentProps<typeof MyComponent> = { foo: 'bar' };
  * ```
  *
+ * > [!NOTE] In Svelte 4, you would do `ComponentProps<MyComponent>` because `MyComponent` was a class.
+ *
  * Example: A generic function that accepts some component and infers the type of its props:
  *
  * ```ts

diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts
@@ -207,9 +207,11 @@ declare module 'svelte' {
 	 * import MyComponent from './MyComponent.svelte';
 	 *
 	 * // Errors if these aren't the correct props expected by MyComponent.
-	 * const props: ComponentProps<MyComponent> = { foo: 'bar' };
+	 * const props: ComponentProps<typeof MyComponent> = { foo: 'bar' };
 	 * ```
 	 *
+	 * > [!NOTE] In Svelte 4, you would do `ComponentProps<MyComponent>` because `MyComponent` was a class.
+	 *
 	 * Example: A generic function that accepts some component and infers the type of its props:
 	 *
 	 * ```ts