@uniformdev/canvas-react 19.165.2-alpha.0 → 19.167.2-alpha.3

package/dist/index.d.mts

@@ -10,7 +10,7 @@ import { RichTextNode } from '@uniformdev/richtext';
  * all enhancers have been applied.
  */
 type ComponentProps<TProps = unknown> = TProps & {
-    component: ComponentInstance;
+    component: ComponentInstance | RootComponentInstance;
 };
 /**
  * Function that maps a Canvas component instance to its React component to render it.
@@ -313,24 +313,26 @@ declare function useUniformCurrentComposition(): UniformCompositionContextValue;
 declare function UniformComposition<TRenderProps = unknown>({ data, behaviorTracking, children, resolveRenderer, contextualEditingEnhancer, contextualEditingDefaultPlaceholder, }: UniformCompositionProps<TRenderProps>): React$1.JSX.Element;
 
 type UniformPlaygroundDecorator = (props: {
-    /** The rendered component instance, needs to wrapped and rendered by the decorator */
+    /** The rendered component instance, needs to be wrapped and rendered by the decorator */
     children: React$1.ReactNode;
     /** The component instance data */
     data: ComponentInstance | RootComponentInstance;
 }) => React$1.ReactElement;
 type UniformPlaygroundProps = {
     /**
-     * Allows wrapping the playground in custom components.
-     * Useful to customize the playground to allow previewing the components in realistic scenarios
-     * (e.g. different background color, different parent size)
+     * Allows wrapping the playground in custom layouts.
+     * Useful to customize the playground to allow previewing the patterns in realistic scenarios
+     * (e.g. wrap the pattern in a specific layout, show a background color selector, parent size selector, etc.)
      * @deprecated This feature is not stable yet and might be changed or removed in a minor release. Do not use it in production environments.
      */
     decorators?: UniformPlaygroundDecorator[];
-} & Omit<UniformCompositionProps, 'data'>;
+    /** @deprecated This prop is not supported anymore. */
+    children?: ReactNode;
+} & Omit<UniformCompositionProps, 'data' | 'children'>;
 /**
- * Playground where you can freely live preview your components and pattern.
+ * Playground where you can freely live preview your components and patterns.
  */
-declare const UniformPlayground: ({ resolveRenderer, decorators, contextualEditingEnhancer, behaviorTracking, contextualEditingDefaultPlaceholder, children, }: UniformPlaygroundProps) => React$1.JSX.Element;
+declare const UniformPlayground: ({ resolveRenderer, decorators, contextualEditingEnhancer, behaviorTracking, contextualEditingDefaultPlaceholder, }: UniformPlaygroundProps) => React$1.JSX.Element;
 
 type RichTextComponentProps<TNode extends RichTextNode = RichTextNode> = {
     node: TNode;

package/dist/index.d.ts

@@ -10,7 +10,7 @@ import { RichTextNode } from '@uniformdev/richtext';
  * all enhancers have been applied.
  */
 type ComponentProps<TProps = unknown> = TProps & {
-    component: ComponentInstance;
+    component: ComponentInstance | RootComponentInstance;
 };
 /**
  * Function that maps a Canvas component instance to its React component to render it.
@@ -313,24 +313,26 @@ declare function useUniformCurrentComposition(): UniformCompositionContextValue;
 declare function UniformComposition<TRenderProps = unknown>({ data, behaviorTracking, children, resolveRenderer, contextualEditingEnhancer, contextualEditingDefaultPlaceholder, }: UniformCompositionProps<TRenderProps>): React$1.JSX.Element;
 
 type UniformPlaygroundDecorator = (props: {
-    /** The rendered component instance, needs to wrapped and rendered by the decorator */
+    /** The rendered component instance, needs to be wrapped and rendered by the decorator */
     children: React$1.ReactNode;
     /** The component instance data */
     data: ComponentInstance | RootComponentInstance;
 }) => React$1.ReactElement;
 type UniformPlaygroundProps = {
     /**
-     * Allows wrapping the playground in custom components.
-     * Useful to customize the playground to allow previewing the components in realistic scenarios
-     * (e.g. different background color, different parent size)
+     * Allows wrapping the playground in custom layouts.
+     * Useful to customize the playground to allow previewing the patterns in realistic scenarios
+     * (e.g. wrap the pattern in a specific layout, show a background color selector, parent size selector, etc.)
      * @deprecated This feature is not stable yet and might be changed or removed in a minor release. Do not use it in production environments.
      */
     decorators?: UniformPlaygroundDecorator[];
-} & Omit<UniformCompositionProps, 'data'>;
+    /** @deprecated This prop is not supported anymore. */
+    children?: ReactNode;
+} & Omit<UniformCompositionProps, 'data' | 'children'>;
 /**
- * Playground where you can freely live preview your components and pattern.
+ * Playground where you can freely live preview your components and patterns.
  */
-declare const UniformPlayground: ({ resolveRenderer, decorators, contextualEditingEnhancer, behaviorTracking, contextualEditingDefaultPlaceholder, children, }: UniformPlaygroundProps) => React$1.JSX.Element;
+declare const UniformPlayground: ({ resolveRenderer, decorators, contextualEditingEnhancer, behaviorTracking, contextualEditingDefaultPlaceholder, }: UniformPlaygroundProps) => React$1.JSX.Element;
 
 type RichTextComponentProps<TNode extends RichTextNode = RichTextNode> = {
     node: TNode;

package/dist/index.esm.js

@@ -611,8 +611,7 @@ var UniformPlayground = ({
   decorators = [],
   contextualEditingEnhancer,
   behaviorTracking,
-  contextualEditingDefaultPlaceholder,
-  children
+  contextualEditingDefaultPlaceholder
 }) => {
   const { composition, isContextualEditing } = useUniformContextualEditing({
     initialCompositionValue: EMPTY_COMPOSITION4,
@@ -629,21 +628,13 @@ var UniformPlayground = ({
         behaviorTracking,
         resolveRenderer,
         contextualEditingDefaultPlaceholder
-      },
-      children
+      }
     ));
     decorators.forEach((Decorator) => {
       component = /* @__PURE__ */ React8.createElement(Decorator, { data: composition }, component);
     });
     return component;
-  }, [
-    children,
-    resolveRenderer,
-    decorators,
-    composition,
-    behaviorTracking,
-    contextualEditingDefaultPlaceholder
-  ]);
+  }, [resolveRenderer, decorators, composition, behaviorTracking, contextualEditingDefaultPlaceholder]);
   return /* @__PURE__ */ React8.createElement(
     UniformCompositionContext.Provider,
     {
@@ -739,8 +730,7 @@ var TextRichTextNode = ({ node }) => {
 // src/components/UniformRichText/UniformRichTextNode.tsx
 function UniformRichTextNode({ node, ...props }) {
   var _a;
-  if (!isRichTextNode(node))
-    return null;
+  if (!isRichTextNode(node)) return null;
   let NodeRenderer = (_a = props.resolveRichTextRenderer) == null ? void 0 : _a.call(props, node);
   if (typeof NodeRenderer === "undefined") {
     NodeRenderer = resolveRichTextDefaultRenderer(node);
@@ -779,8 +769,7 @@ var UniformRichText = React18.forwardRef(function UniformRichText2({ parameterId
     return (_a = componentData == null ? void 0 : componentData.parameters) == null ? void 0 : _a[parameterId];
   }, [componentData, parameterId]);
   const value = useMemo3(() => parameter == null ? void 0 : parameter.value, [parameter]);
-  if (!value || !isRichTextValue(value) || isRichTextValueConsideredEmpty(value))
-    return null;
+  if (!value || !isRichTextValue(value) || isRichTextValueConsideredEmpty(value)) return null;
   return Tag === null ? /* @__PURE__ */ React18.createElement(UniformRichTextNode, { node: value.root, resolveRichTextRenderer }) : /* @__PURE__ */ React18.createElement(
     Tag,
     {

package/dist/index.js

@@ -643,8 +643,7 @@ var UniformPlayground = ({
   decorators = [],
   contextualEditingEnhancer,
   behaviorTracking,
-  contextualEditingDefaultPlaceholder,
-  children
+  contextualEditingDefaultPlaceholder
 }) => {
   const { composition, isContextualEditing } = useUniformContextualEditing({
     initialCompositionValue: import_canvas8.EMPTY_COMPOSITION,
@@ -661,21 +660,13 @@ var UniformPlayground = ({
         behaviorTracking,
         resolveRenderer,
         contextualEditingDefaultPlaceholder
-      },
-      children
+      }
     ));
     decorators.forEach((Decorator) => {
       component = /* @__PURE__ */ import_react8.default.createElement(Decorator, { data: composition }, component);
     });
     return component;
-  }, [
-    children,
-    resolveRenderer,
-    decorators,
-    composition,
-    behaviorTracking,
-    contextualEditingDefaultPlaceholder
-  ]);
+  }, [resolveRenderer, decorators, composition, behaviorTracking, contextualEditingDefaultPlaceholder]);
   return /* @__PURE__ */ import_react8.default.createElement(
     UniformCompositionContext.Provider,
     {
@@ -764,8 +755,7 @@ var TextRichTextNode = ({ node }) => {
 // src/components/UniformRichText/UniformRichTextNode.tsx
 function UniformRichTextNode({ node, ...props }) {
   var _a;
-  if (!(0, import_richtext4.isRichTextNode)(node))
-    return null;
+  if (!(0, import_richtext4.isRichTextNode)(node)) return null;
   let NodeRenderer = (_a = props.resolveRichTextRenderer) == null ? void 0 : _a.call(props, node);
   if (typeof NodeRenderer === "undefined") {
     NodeRenderer = resolveRichTextDefaultRenderer(node);
@@ -804,8 +794,7 @@ var UniformRichText = import_react18.default.forwardRef(function UniformRichText
     return (_a = componentData == null ? void 0 : componentData.parameters) == null ? void 0 : _a[parameterId];
   }, [componentData, parameterId]);
   const value = (0, import_react18.useMemo)(() => parameter == null ? void 0 : parameter.value, [parameter]);
-  if (!value || !(0, import_richtext5.isRichTextValue)(value) || (0, import_richtext5.isRichTextValueConsideredEmpty)(value))
-    return null;
+  if (!value || !(0, import_richtext5.isRichTextValue)(value) || (0, import_richtext5.isRichTextValueConsideredEmpty)(value)) return null;
   return Tag === null ? /* @__PURE__ */ import_react18.default.createElement(UniformRichTextNode, { node: value.root, resolveRichTextRenderer }) : /* @__PURE__ */ import_react18.default.createElement(
     Tag,
     {

package/dist/index.mjs

@@ -611,8 +611,7 @@ var UniformPlayground = ({
   decorators = [],
   contextualEditingEnhancer,
   behaviorTracking,
-  contextualEditingDefaultPlaceholder,
-  children
+  contextualEditingDefaultPlaceholder
 }) => {
   const { composition, isContextualEditing } = useUniformContextualEditing({
     initialCompositionValue: EMPTY_COMPOSITION4,
@@ -629,21 +628,13 @@ var UniformPlayground = ({
         behaviorTracking,
         resolveRenderer,
         contextualEditingDefaultPlaceholder
-      },
-      children
+      }
     ));
     decorators.forEach((Decorator) => {
       component = /* @__PURE__ */ React8.createElement(Decorator, { data: composition }, component);
     });
     return component;
-  }, [
-    children,
-    resolveRenderer,
-    decorators,
-    composition,
-    behaviorTracking,
-    contextualEditingDefaultPlaceholder
-  ]);
+  }, [resolveRenderer, decorators, composition, behaviorTracking, contextualEditingDefaultPlaceholder]);
   return /* @__PURE__ */ React8.createElement(
     UniformCompositionContext.Provider,
     {
@@ -739,8 +730,7 @@ var TextRichTextNode = ({ node }) => {
 // src/components/UniformRichText/UniformRichTextNode.tsx
 function UniformRichTextNode({ node, ...props }) {
   var _a;
-  if (!isRichTextNode(node))
-    return null;
+  if (!isRichTextNode(node)) return null;
   let NodeRenderer = (_a = props.resolveRichTextRenderer) == null ? void 0 : _a.call(props, node);
   if (typeof NodeRenderer === "undefined") {
     NodeRenderer = resolveRichTextDefaultRenderer(node);
@@ -779,8 +769,7 @@ var UniformRichText = React18.forwardRef(function UniformRichText2({ parameterId
     return (_a = componentData == null ? void 0 : componentData.parameters) == null ? void 0 : _a[parameterId];
   }, [componentData, parameterId]);
   const value = useMemo3(() => parameter == null ? void 0 : parameter.value, [parameter]);
-  if (!value || !isRichTextValue(value) || isRichTextValueConsideredEmpty(value))
-    return null;
+  if (!value || !isRichTextValue(value) || isRichTextValueConsideredEmpty(value)) return null;
   return Tag === null ? /* @__PURE__ */ React18.createElement(UniformRichTextNode, { node: value.root, resolveRichTextRenderer }) : /* @__PURE__ */ React18.createElement(
     Tag,
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-react",
-  "version": "19.165.2-alpha.0+323887559d",
+  "version": "19.167.2-alpha.3+d42f32a982",
   "description": "React SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -45,10 +45,10 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.165.2-alpha.0+323887559d",
-    "@uniformdev/context": "19.165.2-alpha.0+323887559d",
-    "@uniformdev/context-react": "19.165.2-alpha.0+323887559d",
-    "@uniformdev/richtext": "19.165.2-alpha.0+323887559d"
+    "@uniformdev/canvas": "19.167.2-alpha.3+d42f32a982",
+    "@uniformdev/context": "19.167.2-alpha.3+d42f32a982",
+    "@uniformdev/context-react": "19.167.2-alpha.3+d42f32a982",
+    "@uniformdev/richtext": "19.167.2-alpha.3+d42f32a982"
   },
   "peerDependencies": {
     "react": ">= 16 || 17 || 18",
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "323887559d1bdc7432f91d305afaec90b98f660f"
+  "gitHead": "d42f32a98294c96f55a29c10c7c461c5327f56f3"
 }