Changed the signature of createComponentExtension to include null

Signed-off-by: Brian Leathem <bleathem@netflix.com>
backstage · Mar 18, 2021 · d4f2eba · d4f2eba
1 parent 98e95f7
commit d4f2eba
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/packages/core-api/src/extensions/extensions.tsx b/packages/core-api/src/extensions/extensions.tsx
@@ -60,15 +60,18 @@ export function createRoutableExtension<
   });
 }
 
+// We do not use ComponentType as the return type, since it doesn't let us convey the children prop.
+// ComponentType inserts children as an optional prop whether the inner component accepts it or not,
+// making it impossible to make the usage of children type safe.
 export function createComponentExtension<
-  T extends (props: any) => JSX.Element
+  T extends (props: any) => JSX.Element | null
 >(options: { component: ComponentLoader<T> }): Extension<T> {
   const { component } = options;
   return createReactExtension({ component });
 }
 
 export function createReactExtension<
-  T extends (props: any) => JSX.Element
+  T extends (props: any) => JSX.Element | null
 >(options: {
   component: ComponentLoader<T>;
   data?: Record<string, unknown>;