Add explanatory comment for omitting prefix

WordPress · Aug 2, 2021 · fa1d387 · fa1d387
1 parent 11956d9
commit fa1d387
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/components/src/input-control/types.ts b/packages/components/src/input-control/types.ts
@@ -64,6 +64,13 @@ export interface InputBaseProps extends BaseProps, FlexProps {
 
 export interface InputControlProps
 	extends Omit< InputBaseProps, 'children' >,
+		/**
+		 * The `prefix` prop in `PolymorphicComponentProps< InputFieldProps, 'input', false >` comes from the
+		 * `HTMLInputAttributes` and clashes with the one from `InputBaseProps`. So we have to omit it from
+		 * `PolymorphicComponentProps< InputFieldProps, 'input', false >` in order that `InputBaseProps[ 'prefix' ]`
+		 * be the only prefix prop. Otherwise it tries to do a union of the two prefix properties and you end up
+		 * with an unresolvable type.
+		 */
 		Omit<
 			PolymorphicComponentProps< InputFieldProps, 'input', false >,
 			'stateReducer' | 'prefix'