Add comment

Author: torkelo

packages/scenes/src/core/SceneComponentWrapper.tsx

@@ -32,6 +32,9 @@ function EmptyRenderer<T>(_: SceneComponentProps<T>): React.ReactElement | null
   return null;
 }
 
+/**
+ * If this or any parent has componentWrapper then return and use that
+ */
 function getComponentWrapper(sceneObject: SceneObject): SceneComponentCustomWrapper | undefined {
   if (sceneObject.componentWrapper) {
     return sceneObject.componentWrapper;

packages/scenes/src/core/types.ts

@@ -72,7 +72,10 @@ export interface SceneObject<TState extends SceneObjectState = SceneObjectState>
   /** This abstraction declares URL sync dependencies of a scene object. **/
   readonly urlSync?: SceneObjectUrlSyncHandler<TState>;
 
-  /** Component wrapper, can be used to for edit modes, to wrap some objecs in an edit wrappers */
+  /**
+   * Component wrapper, can be used to for edit modes, to wrap objects in an edit wrappers. This component wrapper will
+   * be used for all children of this object (unless they specify their own wrapper).
+   **/
   readonly componentWrapper?: SceneComponentCustomWrapper;
 
   /** Subscribe to state changes */