@uniformdev/canvas-react 19.46.1-alpha.8 → 19.47.1-alpha.11

package/dist/core.d.mts

@@ -0,0 +1,41 @@
+import { ComponentInstance } from '@uniformdev/canvas';
+import React from 'react';
+
+type ParameterTextValue = string | undefined;
+type PureUniformTextProps = {
+    /**
+     * The name of the  HTML tag to render.
+     * @default "span"
+     */
+    as?: React.ElementType;
+    /** The ID of the parameter. */
+    parameterId: string;
+    /** The component that contains the parameter. */
+    component: ComponentInstance;
+    skipCustomRendering: boolean;
+    isContextualEditing: boolean;
+    /**
+     * When set to true, it adds `whiteSpace: 'pre-wrap'` to the styles of the root element to allow the rendering of line breaks.
+     * @default false
+     */
+    isMultiline?: boolean;
+    /**
+     * Sets the value to show in Canvas editor when the parameter value is empty.
+     * Can be a static string, or a function to generate the placeholder out of parameter info.
+     * @default undefined
+     */
+    placeholder?: string | ((parameter: {
+        id: string;
+    }) => string | undefined);
+    /**
+     * A function to customize the rendering of the parameter value. Useful to format the value before rendering it.
+     * @default "(value) => value"
+     */
+    render?: (value: ParameterTextValue) => React.ReactNode;
+} & Omit<React.HTMLAttributes<HTMLSpanElement>, 'children' | 'placeholder'>;
+/**
+ * Renders text parameters. Offers inline editing capability out of the box.
+ */
+declare const PureUniformText: ({ as: Tag, parameterId, component, skipCustomRendering, isContextualEditing, isMultiline, placeholder, render, ...props }: PureUniformTextProps) => React.JSX.Element | null;
+
+export { PureUniformText, PureUniformTextProps };

package/dist/core.d.ts

@@ -0,0 +1,41 @@
+import { ComponentInstance } from '@uniformdev/canvas';
+import React from 'react';
+
+type ParameterTextValue = string | undefined;
+type PureUniformTextProps = {
+    /**
+     * The name of the  HTML tag to render.
+     * @default "span"
+     */
+    as?: React.ElementType;
+    /** The ID of the parameter. */
+    parameterId: string;
+    /** The component that contains the parameter. */
+    component: ComponentInstance;
+    skipCustomRendering: boolean;
+    isContextualEditing: boolean;
+    /**
+     * When set to true, it adds `whiteSpace: 'pre-wrap'` to the styles of the root element to allow the rendering of line breaks.
+     * @default false
+     */
+    isMultiline?: boolean;
+    /**
+     * Sets the value to show in Canvas editor when the parameter value is empty.
+     * Can be a static string, or a function to generate the placeholder out of parameter info.
+     * @default undefined
+     */
+    placeholder?: string | ((parameter: {
+        id: string;
+    }) => string | undefined);
+    /**
+     * A function to customize the rendering of the parameter value. Useful to format the value before rendering it.
+     * @default "(value) => value"
+     */
+    render?: (value: ParameterTextValue) => React.ReactNode;
+} & Omit<React.HTMLAttributes<HTMLSpanElement>, 'children' | 'placeholder'>;
+/**
+ * Renders text parameters. Offers inline editing capability out of the box.
+ */
+declare const PureUniformText: ({ as: Tag, parameterId, component, skipCustomRendering, isContextualEditing, isMultiline, placeholder, render, ...props }: PureUniformTextProps) => React.JSX.Element | null;
+
+export { PureUniformText, PureUniformTextProps };

package/dist/core.js

@@ -0,0 +1,90 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/core.ts
+var core_exports = {};
+__export(core_exports, {
+  PureUniformText: () => PureUniformText
+});
+module.exports = __toCommonJS(core_exports);
+
+// src/components/PureUniformText.tsx
+var import_react = __toESM(require("react"));
+
+// src/helpers/getParameterAttributes.ts
+var import_canvas = require("@uniformdev/canvas");
+var getParameterAttributes = (options) => {
+  return {
+    ...(0, import_canvas.getParameterAttributes)(options),
+    suppressContentEditableWarning: true
+  };
+};
+
+// src/components/PureUniformText.tsx
+var PureUniformText = ({
+  as: Tag = "span",
+  parameterId,
+  component,
+  skipCustomRendering,
+  isContextualEditing,
+  isMultiline = false,
+  placeholder,
+  render = (value) => value,
+  ...props
+}) => {
+  var _a;
+  const parameter = (_a = component == null ? void 0 : component.parameters) == null ? void 0 : _a[parameterId];
+  const value = parameter == null ? void 0 : parameter.value;
+  if (!parameter) {
+    return null;
+  }
+  if (!isContextualEditing) {
+    return /* @__PURE__ */ import_react.default.createElement(Tag, { style: isMultiline ? { whiteSpace: "pre-wrap" } : {}, ...props }, render(value));
+  }
+  const computedPlaceholder = typeof placeholder === "function" ? placeholder({ id: parameterId }) : placeholder;
+  return /* @__PURE__ */ import_react.default.createElement(
+    Tag,
+    {
+      ...props,
+      ...getParameterAttributes({
+        component,
+        id: parameterId,
+        isMultiline
+      }),
+      "data-uniform-parameter-type": "text",
+      "data-uniform-placeholder": computedPlaceholder,
+      style: isMultiline ? { whiteSpace: "pre-wrap" } : {}
+    },
+    skipCustomRendering ? value : render(value)
+  );
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PureUniformText
+});

package/dist/core.mjs

@@ -0,0 +1,55 @@
+// src/components/PureUniformText.tsx
+import React from "react";
+
+// src/helpers/getParameterAttributes.ts
+import {
+  getParameterAttributes as defaultGetParameterAttributes
+} from "@uniformdev/canvas";
+var getParameterAttributes = (options) => {
+  return {
+    ...defaultGetParameterAttributes(options),
+    suppressContentEditableWarning: true
+  };
+};
+
+// src/components/PureUniformText.tsx
+var PureUniformText = ({
+  as: Tag = "span",
+  parameterId,
+  component,
+  skipCustomRendering,
+  isContextualEditing,
+  isMultiline = false,
+  placeholder,
+  render = (value) => value,
+  ...props
+}) => {
+  var _a;
+  const parameter = (_a = component == null ? void 0 : component.parameters) == null ? void 0 : _a[parameterId];
+  const value = parameter == null ? void 0 : parameter.value;
+  if (!parameter) {
+    return null;
+  }
+  if (!isContextualEditing) {
+    return /* @__PURE__ */ React.createElement(Tag, { style: isMultiline ? { whiteSpace: "pre-wrap" } : {}, ...props }, render(value));
+  }
+  const computedPlaceholder = typeof placeholder === "function" ? placeholder({ id: parameterId }) : placeholder;
+  return /* @__PURE__ */ React.createElement(
+    Tag,
+    {
+      ...props,
+      ...getParameterAttributes({
+        component,
+        id: parameterId,
+        isMultiline
+      }),
+      "data-uniform-parameter-type": "text",
+      "data-uniform-placeholder": computedPlaceholder,
+      style: isMultiline ? { whiteSpace: "pre-wrap" } : {}
+    },
+    skipCustomRendering ? value : render(value)
+  );
+};
+export {
+  PureUniformText
+};

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import React$1, { Key, ReactNode, PropsWithChildren } from 'react';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
 import { ComponentInstance, RootComponentInstance, UpdateCompositionMessage, getParameterAttributes as getParameterAttributes$1, SubscribeToCompositionOptions } from '@uniformdev/canvas';
 export { GetParameterAttributesProps, createUniformApiEnhancer } from '@uniformdev/canvas';
+import { PureUniformTextProps } from './core.mjs';
 import { RichTextNode } from '@uniformdev/richtext';
 
 /**
@@ -41,38 +42,11 @@ type ComponentStore = {
  **/
 declare function DefaultNotImplementedComponent(props: ComponentProps): React$1.JSX.Element | null;
 
-type ParameterTextValue = string | undefined;
-type UniformTextProps = {
-    /**
-     * The name of the  HTML tag to render.
-     * @default "span"
-     */
-    as?: React$1.ElementType;
-    /** The ID of the parameter. */
-    parameterId: string;
-    /**
-     * When set to true, it adds `whiteSpace: 'pre-wrap'` to the styles of the root element to allow the rendering of line breaks.
-     * @default false
-     */
-    isMultiline?: boolean;
-    /**
-     * Sets the value to show in Canvas editor when the parameter value is empty.
-     * Can be a static string, or a function to generate the placeholder out of parameter info.
-     * @default undefined
-     */
-    placeholder?: string | ((parameter: {
-        id: string;
-    }) => string | undefined);
-    /**
-     * A function to customize the rendering of the parameter value. Useful to format the value before rendering it.
-     * @default "(value) => value"
-     */
-    render?: (value: ParameterTextValue) => React$1.ReactNode;
-} & Omit<React$1.HTMLAttributes<HTMLSpanElement>, 'children' | 'placeholder'>;
+type UniformTextProps = Omit<PureUniformTextProps, 'skipCustomRendering' | 'isContextualEditing'>;
 /**
  * Renders text parameters. Offers inline editing capability out of the box.
  */
-declare const UniformText: ({ as: Tag, parameterId, isMultiline, placeholder, render, ...props }: UniformTextProps) => React$1.JSX.Element | null;
+declare const UniformText: ({ as: tag, parameterId, isMultiline, placeholder, render, ...props }: UniformTextProps) => React$1.JSX.Element | null;
 
 type UniformComponentProps<TRenderProps = unknown> = {
     /** The data of the component instance */
@@ -257,6 +231,7 @@ type UniformCompositionContextValue = {
     behaviorTracking?: UniformCompositionProps['behaviorTracking'];
     isContextualEditing: boolean;
 };
+declare const UniformCompositionContext: React$1.Context<UniformCompositionContextValue>;
 /**
  * Gets the data of the closest `<UniformComposition />` ancestor.
  */
@@ -268,6 +243,24 @@ declare function useUniformCurrentComposition(): UniformCompositionContextValue;
  */
 declare function UniformComposition<TRenderProps = unknown>({ data, behaviorTracking, children, resolveRenderer, contextualEditingEnhancer, contextualEditingDefaultPlaceholder, }: UniformCompositionProps<TRenderProps>): React$1.JSX.Element;
 
+type UniformPlaygroundDecorator = (options: {
+    children: React$1.ReactNode;
+    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)
+     * @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'>;
+/**
+ * Playground where you can freely live preview your components and pattern.
+ */
+declare const UniformPlayground: ({ resolveRenderer, decorators, contextualEditingEnhancer, behaviorTracking, contextualEditingDefaultPlaceholder, children, }: UniformPlaygroundProps) => React$1.JSX.Element;
+
 type RichTextComponentProps<TNode extends RichTextNode = RichTextNode> = {
     node: TNode;
 };
@@ -404,4 +397,4 @@ declare const createComponentStoreResolver: (options: {
     defaultComponent?: React$1.ComponentType<ComponentProps<any>>;
 }) => RenderComponentResolver;
 
-export { ComponentProps, ComponentStore, CustomSlotChildRenderFunc, DefaultNotImplementedComponent, NOT_IMPLEMENTED_COMPONENT, RenderComponentResolver, RenderRichTextComponentResolver, RichTextComponentProps, RichTextRendererComponent, SystemRenderConfig, SystemRenderFunction, UniformComponent, UniformComponentContextValue, UniformComponentProps, UniformComposition, UniformCompositionProps, UniformRichText, UniformRichTextNode, UniformRichTextNodeProps, UniformRichTextProps, UniformSlot, UniformSlotProps, UniformSlotWrapperComponentProps, UniformText, UniformTextProps, UseCompositionEventEffectOptions, UseUniformContextualEditingProps, UseUniformContextualEditingStateProps, componentStore, componentStoreResolver, createComponentStore, createComponentStoreResolver, getParameterAttributes, registerUniformComponent, useCompositionEventEffect, useUniformContextualEditing, useUniformContextualEditingState, useUniformCurrentComponent, useUniformCurrentComposition };
+export { ComponentProps, ComponentStore, CustomSlotChildRenderFunc, DefaultNotImplementedComponent, NOT_IMPLEMENTED_COMPONENT, RenderComponentResolver, RenderRichTextComponentResolver, RichTextComponentProps, RichTextRendererComponent, SystemRenderConfig, SystemRenderFunction, UniformComponent, UniformComponentContextValue, UniformComponentProps, UniformComposition, UniformCompositionContext, UniformCompositionProps, UniformPlayground, UniformPlaygroundDecorator, UniformPlaygroundProps, UniformRichText, UniformRichTextNode, UniformRichTextNodeProps, UniformRichTextProps, UniformSlot, UniformSlotProps, UniformSlotWrapperComponentProps, UniformText, UniformTextProps, UseCompositionEventEffectOptions, UseUniformContextualEditingProps, UseUniformContextualEditingStateProps, componentStore, componentStoreResolver, createComponentStore, createComponentStoreResolver, getParameterAttributes, registerUniformComponent, useCompositionEventEffect, useUniformContextualEditing, useUniformContextualEditingState, useUniformCurrentComponent, useUniformCurrentComposition };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import React$1, { Key, ReactNode, PropsWithChildren } from 'react';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
 import { ComponentInstance, RootComponentInstance, UpdateCompositionMessage, getParameterAttributes as getParameterAttributes$1, SubscribeToCompositionOptions } from '@uniformdev/canvas';
 export { GetParameterAttributesProps, createUniformApiEnhancer } from '@uniformdev/canvas';
+import { PureUniformTextProps } from './core.js';
 import { RichTextNode } from '@uniformdev/richtext';
 
 /**
@@ -41,38 +42,11 @@ type ComponentStore = {
  **/
 declare function DefaultNotImplementedComponent(props: ComponentProps): React$1.JSX.Element | null;
 
-type ParameterTextValue = string | undefined;
-type UniformTextProps = {
-    /**
-     * The name of the  HTML tag to render.
-     * @default "span"
-     */
-    as?: React$1.ElementType;
-    /** The ID of the parameter. */
-    parameterId: string;
-    /**
-     * When set to true, it adds `whiteSpace: 'pre-wrap'` to the styles of the root element to allow the rendering of line breaks.
-     * @default false
-     */
-    isMultiline?: boolean;
-    /**
-     * Sets the value to show in Canvas editor when the parameter value is empty.
-     * Can be a static string, or a function to generate the placeholder out of parameter info.
-     * @default undefined
-     */
-    placeholder?: string | ((parameter: {
-        id: string;
-    }) => string | undefined);
-    /**
-     * A function to customize the rendering of the parameter value. Useful to format the value before rendering it.
-     * @default "(value) => value"
-     */
-    render?: (value: ParameterTextValue) => React$1.ReactNode;
-} & Omit<React$1.HTMLAttributes<HTMLSpanElement>, 'children' | 'placeholder'>;
+type UniformTextProps = Omit<PureUniformTextProps, 'skipCustomRendering' | 'isContextualEditing'>;
 /**
  * Renders text parameters. Offers inline editing capability out of the box.
  */
-declare const UniformText: ({ as: Tag, parameterId, isMultiline, placeholder, render, ...props }: UniformTextProps) => React$1.JSX.Element | null;
+declare const UniformText: ({ as: tag, parameterId, isMultiline, placeholder, render, ...props }: UniformTextProps) => React$1.JSX.Element | null;
 
 type UniformComponentProps<TRenderProps = unknown> = {
     /** The data of the component instance */
@@ -257,6 +231,7 @@ type UniformCompositionContextValue = {
     behaviorTracking?: UniformCompositionProps['behaviorTracking'];
     isContextualEditing: boolean;
 };
+declare const UniformCompositionContext: React$1.Context<UniformCompositionContextValue>;
 /**
  * Gets the data of the closest `<UniformComposition />` ancestor.
  */
@@ -268,6 +243,24 @@ declare function useUniformCurrentComposition(): UniformCompositionContextValue;
  */
 declare function UniformComposition<TRenderProps = unknown>({ data, behaviorTracking, children, resolveRenderer, contextualEditingEnhancer, contextualEditingDefaultPlaceholder, }: UniformCompositionProps<TRenderProps>): React$1.JSX.Element;
 
+type UniformPlaygroundDecorator = (options: {
+    children: React$1.ReactNode;
+    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)
+     * @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'>;
+/**
+ * Playground where you can freely live preview your components and pattern.
+ */
+declare const UniformPlayground: ({ resolveRenderer, decorators, contextualEditingEnhancer, behaviorTracking, contextualEditingDefaultPlaceholder, children, }: UniformPlaygroundProps) => React$1.JSX.Element;
+
 type RichTextComponentProps<TNode extends RichTextNode = RichTextNode> = {
     node: TNode;
 };
@@ -404,4 +397,4 @@ declare const createComponentStoreResolver: (options: {
     defaultComponent?: React$1.ComponentType<ComponentProps<any>>;
 }) => RenderComponentResolver;
 
-export { ComponentProps, ComponentStore, CustomSlotChildRenderFunc, DefaultNotImplementedComponent, NOT_IMPLEMENTED_COMPONENT, RenderComponentResolver, RenderRichTextComponentResolver, RichTextComponentProps, RichTextRendererComponent, SystemRenderConfig, SystemRenderFunction, UniformComponent, UniformComponentContextValue, UniformComponentProps, UniformComposition, UniformCompositionProps, UniformRichText, UniformRichTextNode, UniformRichTextNodeProps, UniformRichTextProps, UniformSlot, UniformSlotProps, UniformSlotWrapperComponentProps, UniformText, UniformTextProps, UseCompositionEventEffectOptions, UseUniformContextualEditingProps, UseUniformContextualEditingStateProps, componentStore, componentStoreResolver, createComponentStore, createComponentStoreResolver, getParameterAttributes, registerUniformComponent, useCompositionEventEffect, useUniformContextualEditing, useUniformContextualEditingState, useUniformCurrentComponent, useUniformCurrentComposition };
+export { ComponentProps, ComponentStore, CustomSlotChildRenderFunc, DefaultNotImplementedComponent, NOT_IMPLEMENTED_COMPONENT, RenderComponentResolver, RenderRichTextComponentResolver, RichTextComponentProps, RichTextRendererComponent, SystemRenderConfig, SystemRenderFunction, UniformComponent, UniformComponentContextValue, UniformComponentProps, UniformComposition, UniformCompositionContext, UniformCompositionProps, UniformPlayground, UniformPlaygroundDecorator, UniformPlaygroundProps, UniformRichText, UniformRichTextNode, UniformRichTextNodeProps, UniformRichTextProps, UniformSlot, UniformSlotProps, UniformSlotWrapperComponentProps, UniformText, UniformTextProps, UseCompositionEventEffectOptions, UseUniformContextualEditingProps, UseUniformContextualEditingStateProps, componentStore, componentStoreResolver, createComponentStore, createComponentStoreResolver, getParameterAttributes, registerUniformComponent, useCompositionEventEffect, useUniformContextualEditing, useUniformContextualEditingState, useUniformCurrentComponent, useUniformCurrentComposition };