Callback prop type inference fix (#64)

* Fix for callback prop type inference. * add changeset * Documentation fixes.
embellishing · Jul 13, 2024 · 096c9e9 · 096c9e9
1 parent 831d97e
commit 096c9e9
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 5 deletions.
diff --git a/.changeset/dull-sheep-hug.md b/.changeset/dull-sheep-hug.md
@@ -0,0 +1,5 @@
+---
+"@embellish/react": patch
+---
+
+Type inference fix for callback props.
diff --git a/docs/api/react.callbackpropfix.md b/docs/api/react.callbackpropfix.md
@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@embellish/react](./react.md) &gt; [CallbackPropFix](./react.callbackpropfix.md)
+
+## CallbackPropFix type
+
+Fixes type inference for callback props, e.g. `onClick`<!-- -->.
+
+**Signature:**
+
+```typescript
+export declare type CallbackPropFix<T> = T extends any ? T : never;
+```
+
+## Remarks
+
+See [microsoft/TypeScript\#44596 (comment)](https://github.com/microsoft/TypeScript/issues/44596#issuecomment-1447648600)<!-- -->.
+
diff --git a/docs/api/react.componentprops.md b/docs/api/react.componentprops.md
@@ -37,11 +37,13 @@ Partial<{
     ? P[PropName]
     : never;
 }>,
-> = Omit<
+> = CallbackPropFix<
+Omit<
 JSX.LibraryManagedAttributes<Is, ComponentPropsWithRef<Is>>,
 keyof OwnProps
+>
 > &
 OwnProps;
 ```
-**References:** [ValidConditionName](./react.validconditionname.md)<!-- -->, [Condition](./react.condition.md)<!-- -->, [ComponentPropsWithRef](./react.componentpropswithref.md)
+**References:** [ValidConditionName](./react.validconditionname.md)<!-- -->, [Condition](./react.condition.md)<!-- -->, [CallbackPropFix](./react.callbackpropfix.md)<!-- -->, [ComponentPropsWithRef](./react.componentpropswithref.md)
 
diff --git a/docs/api/react.md b/docs/api/react.md
@@ -123,6 +123,17 @@ Description
 Creates a branded type to add a unique symbol for type differentiation.
 
 
+</td></tr>
+<tr><td>
+
+[CallbackPropFix](./react.callbackpropfix.md)
+
+
+</td><td>
+
+Fixes type inference for callback props, e.g. `onClick`<!-- -->.
+
+
 </td></tr>
 <tr><td>
 

diff --git a/packages/react/src/component.d.ts b/packages/react/src/component.d.ts
@@ -45,6 +45,17 @@ export interface ComponentOptions<P, C extends string, DefaultIs> {
   fallback?: "revert-layer" | "unset";
 }
 
+/**
+ * Fixes type inference for callback props, e.g. `onClick`.
+ *
+ * @remarks
+ * See
+ * {@link https://github.com/microsoft/TypeScript/issues/44596#issuecomment-1447648600 | microsoft/TypeScript#44596 (comment)}.
+ *
+ * @public
+ */
+export type CallbackPropFix<T> = T extends any ? T : never;
+
 /**
  * Component props
  *
@@ -84,9 +95,11 @@ export type ComponentProps<
           ? P[PropName]
           : never;
     }>,
-> = Omit<
-  JSX.LibraryManagedAttributes<Is, ComponentPropsWithRef<Is>>,
-  keyof OwnProps
+> = CallbackPropFix<
+  Omit<
+    JSX.LibraryManagedAttributes<Is, ComponentPropsWithRef<Is>>,
+    keyof OwnProps
+  >
 > &
   OwnProps;
 

diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts
@@ -14,6 +14,7 @@ export type {
   ValidConditionName,
 } from "@embellish/core";
 export type {
+  CallbackPropFix,
   Component,
   ComponentProps,
   ComponentOptions,