@plasmicpkgs/antd5 0.0.28 → 0.0.30

package/skinny/registerForm.js

@@ -1,13 +1,95 @@
 import { usePlasmicCanvasContext, DataProvider, repeatedElement } from '@plasmicapp/host';
-import Form from 'antd/lib/form';
-import FormItem from 'antd/lib/form/FormItem';
-import FormList from 'antd/lib/form/FormList';
+import Form from 'antd/es/form';
+import FormItem from 'antd/es/form/FormItem';
+import FormList from 'antd/es/form/FormList';
 import equal from 'fast-deep-equal';
-import React from 'react';
+import React, { isValidElement, cloneElement } from 'react';
+import classNames from 'classnames';
 import { r as registerComponentHelper, o as omit } from './utils-91b47110.js';
 import '@plasmicapp/host/registerComponent';
 import '@plasmicapp/host/registerGlobalContext';
 
+var __defProp$1 = Object.defineProperty;
+var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
+var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
+var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$1 = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp$1.call(b, prop))
+      __defNormalProp$1(a, prop, b[prop]);
+  if (__getOwnPropSymbols$1)
+    for (var prop of __getOwnPropSymbols$1(b)) {
+      if (__propIsEnum$1.call(b, prop))
+        __defNormalProp$1(a, prop, b[prop]);
+    }
+  return a;
+};
+const isBrowser = typeof window !== "undefined";
+const NONE = Symbol("NONE");
+isBrowser ? React.useLayoutEffect : React.useEffect;
+function mergeProps(props, ...restProps) {
+  if (restProps.every((rest) => Object.keys(rest).length === 0)) {
+    return props;
+  }
+  const result = __spreadValues$1({}, props);
+  for (const rest of restProps) {
+    for (const key of Object.keys(rest)) {
+      result[key] = mergePropVals(key, result[key], rest[key]);
+    }
+  }
+  return result;
+}
+function updateRef(ref, value) {
+  if (!ref) {
+    return;
+  }
+  if (typeof ref === "function") {
+    ref(value);
+  } else {
+    if (!Object.isFrozen(ref)) {
+      ref.current = value;
+    }
+  }
+}
+function mergeRefs(...refs) {
+  return (value) => {
+    for (const ref of refs) {
+      updateRef(ref, value);
+    }
+  };
+}
+function mergePropVals(name, val1, val2) {
+  if (val1 === NONE || val2 === NONE) {
+    return null;
+  } else if (val1 == null) {
+    return val2;
+  } else if (val2 == null) {
+    return val1;
+  } else if (name === "className") {
+    return classNames(val1, val2);
+  } else if (name === "style") {
+    return __spreadValues$1(__spreadValues$1({}, val1), val2);
+  } else if (name === "ref") {
+    return mergeRefs(val1, val2);
+  } else if (typeof val1 !== typeof val2) {
+    return val2;
+  } else if (name.startsWith("on") && typeof val1 === "function") {
+    return (...args) => {
+      let res;
+      if (typeof val1 === "function") {
+        res = val1(...args);
+      }
+      if (typeof val2 === "function") {
+        res = val2(...args);
+      }
+      return res;
+    };
+  } else {
+    return val2;
+  }
+}
+
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
 var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
@@ -27,18 +109,31 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 const PathContext = React.createContext({ relativePath: [], fullPath: [] });
 const InternalFormInstanceContext = React.createContext(void 0);
 const Internal = (props) => {
+  var _a, _b;
   const [form] = Form.useForm();
   const values = form.getFieldsValue(true);
   const lastValue = React.useRef(values);
   const childrenNode = typeof props.children === "function" ? props.children(values, form) : props.children;
   const fireOnValuesChange = () => {
-    var _a;
+    var _a2;
     const values2 = form.getFieldsValue(true);
     if (!equal(values2, lastValue.current)) {
-      (_a = props.extendedOnValuesChange) == null ? void 0 : _a.call(props, values2);
+      (_a2 = props.extendedOnValuesChange) == null ? void 0 : _a2.call(props, values2);
       lastValue.current = values2;
     }
   };
@@ -48,15 +143,18 @@ const Internal = (props) => {
   return /* @__PURE__ */ React.createElement(InternalFormInstanceContext.Provider, {
     value: {
       fireOnValuesChange,
-      forceRemount: () => props.setRemountKey((k) => k + 1)
+      forceRemount: () => props.setRemountKey((k) => k + 1),
+      formProps: props
     }
   }, /* @__PURE__ */ React.createElement(Form, __spreadProps(__spreadValues({}, props), {
     onValuesChange: (...args) => {
-      var _a, _b;
-      (_a = props.onValuesChange) == null ? void 0 : _a.call(props, ...args);
-      (_b = props.extendedOnValuesChange) == null ? void 0 : _b.call(props, args[1]);
+      var _a2, _b2;
+      (_a2 = props.onValuesChange) == null ? void 0 : _a2.call(props, ...args);
+      (_b2 = props.extendedOnValuesChange) == null ? void 0 : _b2.call(props, args[1]);
     },
-    form
+    form,
+    labelCol: ((_a = props.labelCol) == null ? void 0 : _a.horizontalOnly) && props.layout !== "horizontal" ? void 0 : props.labelCol,
+    wrapperCol: ((_b = props.wrapperCol) == null ? void 0 : _b.horizontalOnly) && props.layout !== "horizontal" ? void 0 : props.wrapperCol
   }), childrenNode));
 };
 function FormWrapper(props) {
@@ -70,7 +168,7 @@ function FormWrapper(props) {
 const COMMON_ACTIONS = [
   {
     type: "button-action",
-    label: "Append new Form.Item",
+    label: "Append new Form Item",
     onClick: ({ studioOps }) => {
       studioOps.appendToSlot({
         type: "component",
@@ -80,7 +178,7 @@ const COMMON_ACTIONS = [
   },
   {
     type: "button-action",
-    label: "Append new Form.Group",
+    label: "Append new Form Group",
     onClick: ({ studioOps }) => {
       studioOps.appendToSlot({
         type: "component",
@@ -90,7 +188,7 @@ const COMMON_ACTIONS = [
   },
   {
     type: "button-action",
-    label: "Append new Form.List",
+    label: "Append new Form List",
     onClick: ({ studioOps }) => {
       studioOps.appendToSlot({
         type: "component",
@@ -100,6 +198,33 @@ const COMMON_ACTIONS = [
   }
 ];
 function registerForm(loader) {
+  const colProp = (displayName, defaultValue) => ({
+    type: "object",
+    displayName,
+    advanced: true,
+    fields: {
+      span: {
+        type: "number",
+        displayName: "Grid columns",
+        description: "The number of grid columns to span (24 columns available)",
+        min: 1,
+        max: 24
+      },
+      offset: {
+        type: "number",
+        displayName: "Offset columns",
+        description: "Number of grid columns to skip from the left",
+        min: 0,
+        max: 23
+      },
+      horizontalOnly: {
+        type: "boolean",
+        displayName: "Horizontal only",
+        description: "Only apply to horizontal layout"
+      }
+    },
+    defaultValue
+  });
   registerComponentHelper(loader, FormWrapper, {
     name: "plasmic-antd5-form",
     displayName: "Form",
@@ -109,11 +234,33 @@ function registerForm(loader) {
         defaultValue: [
           {
             type: "component",
-            name: "plasmic-antd5-form-item"
+            name: "plasmic-antd5-form-item",
+            props: {
+              label: {
+                type: "text",
+                value: "Name"
+              },
+              name: "name",
+              children: {
+                type: "component",
+                name: "plasmic-antd5-input"
+              }
+            }
           },
           {
             type: "component",
-            name: "plasmic-antd5-form-item"
+            name: "plasmic-antd5-form-item",
+            props: {
+              label: {
+                type: "text",
+                value: "Message"
+              },
+              name: "message",
+              children: {
+                type: "component",
+                name: "plasmic-antd5-textarea"
+              }
+            }
           },
           {
             type: "default-component",
@@ -135,21 +282,51 @@ function registerForm(loader) {
       layout: {
         type: "choice",
         options: ["horizontal", "vertical", "inline"],
-        defaultValue: "horizontal"
+        defaultValue: "vertical"
+      },
+      labelAlign: {
+        type: "choice",
+        options: ["left", "right"],
+        defaultValueHint: "right",
+        advanced: true
       },
+      labelCol: colProp("Label layout", {
+        span: 8,
+        horizontalOnly: true
+      }),
+      wrapperCol: colProp("Field layout", {
+        span: 16,
+        horizontalOnly: true
+      }),
       colon: {
         type: "boolean",
-        description: `Configure the default value of colon for Form.Item. Indicates whether the colon after the label is displayed (only effective when prop layout is horizontal)`,
-        defaultValue: true,
+        description: `Show a colon after the label by default (only for horizontal layout)`,
+        defaultValueHint: true,
         advanced: true
       },
       requiredMark: {
-        displayName: "Show required fields?",
-        type: "boolean",
-        advanced: true
+        displayName: "Required/optional mark",
+        type: "choice",
+        options: [
+          {
+            value: "optional",
+            label: "Indicate optional fields"
+          },
+          {
+            value: true,
+            label: "Indicate required fields with asterisk"
+          },
+          {
+            value: false,
+            label: "Show no indicators"
+          }
+        ],
+        advanced: true,
+        defaultValueHint: true
       },
       extendedOnValuesChange: {
         type: "eventHandler",
+        displayName: "On values change",
         argTypes: [
           {
             name: "changedValues",
@@ -163,6 +340,7 @@ function registerForm(loader) {
       },
       onFinish: {
         type: "eventHandler",
+        displayName: "On submit",
         argTypes: [
           {
             name: "values",
@@ -172,6 +350,7 @@ function registerForm(loader) {
       },
       onFinishFailed: {
         type: "eventHandler",
+        displayName: "On invalid submit",
         argTypes: [
           {
             name: "data",
@@ -181,9 +360,9 @@ function registerForm(loader) {
       },
       validateTrigger: {
         type: "choice",
-        options: ["onSubmit", "onChange"],
+        options: ["onSubmit", "onChange", "onBlur"],
         multiSelect: true,
-        defaultValue: ["onChange"],
+        defaultValueHint: ["onChange"],
         advanced: true
       }
     },
@@ -251,40 +430,68 @@ const useFormItemFullName = (name) => {
   const pathCtx = React.useContext(PathContext);
   return typeof name === "object" ? [...pathCtx.fullPath, ...name] : typeof name === "string" ? [...pathCtx.fullPath, name] : void 0;
 };
+function useFormInstanceMaybe() {
+  return Form.useFormInstance();
+}
 function FormItemWrapper(props) {
-  var _a;
+  var _a, _b;
   const relativeFormItemName = useFormItemRelativeName(props.name);
   const fullFormItemName = useFormItemFullName(props.name);
   const rules = props.rules ? plasmicRulesToAntdRules(props.rules) : void 0;
   const inCanvas = !!usePlasmicCanvasContext();
   if (inCanvas) {
-    const form = Form.useFormInstance();
+    const form = useFormInstanceMaybe();
     const prevPropValues = React.useRef({
       initialValue: props.initialValue,
       name: props.name
     });
-    const { fireOnValuesChange, forceRemount } = (_a = React.useContext(InternalFormInstanceContext)) != null ? _a : {};
+    const internalFormCtx = React.useContext(InternalFormInstanceContext);
+    const { fireOnValuesChange, forceRemount } = internalFormCtx != null ? internalFormCtx : {};
+    (_a = props.setControlContextData) == null ? void 0 : _a.call(props, {
+      internalFormCtx
+    });
     React.useEffect(() => {
       if (prevPropValues.current.name !== props.name) {
         forceRemount == null ? void 0 : forceRemount();
       }
-      if (!fullFormItemName || form.getFieldValue(fullFormItemName) !== prevPropValues.current.initialValue) {
+      if (!fullFormItemName || (form == null ? void 0 : form.getFieldValue(fullFormItemName)) !== prevPropValues.current.initialValue) {
         return;
       }
-      form.setFieldValue(fullFormItemName, props.initialValue);
+      form == null ? void 0 : form.setFieldValue(fullFormItemName, props.initialValue);
       prevPropValues.current.initialValue = props.initialValue;
       fireOnValuesChange == null ? void 0 : fireOnValuesChange();
-    }, [props.initialValue, fullFormItemName]);
+    }, [form, props.initialValue, fullFormItemName]);
   }
-  return /* @__PURE__ */ React.createElement(FormItem, __spreadProps(__spreadValues({}, omit(props, "rules")), {
+  return /* @__PURE__ */ React.createElement(FormItem, __spreadValues(__spreadProps(__spreadValues({}, omit(props, "rules")), {
+    label: props.noLabel ? void 0 : props.label,
     name: relativeFormItemName,
     rules
-  }));
+  }), props.helpTextMode === "extra" ? { extra: props.help } : props.helpTextMode === "help" ? { help: (_b = props.help) != null ? _b : "" } : {}), props.customizeProps ? /* @__PURE__ */ React.createElement(FormItemForwarder, {
+    formItemProps: props
+  }) : props.children);
+}
+function FormItemForwarder(_a) {
+  var _b = _a, { formItemProps } = _b, props = __objRest(_b, ["formItemProps"]);
+  var _a2;
+  const status = Form.Item.useStatus();
+  const internalFormCtx = React.useContext(InternalFormInstanceContext);
+  const data = {
+    status: status.status
+  };
+  (_a2 = props.setControlContextData) == null ? void 0 : _a2.call(props, {
+    internalFormCtx,
+    status
+  });
+  return React.Children.map(formItemProps.children, (child, i) => {
+    var _a3;
+    const baseProps = __spreadValues(__spreadValues({}, (_a3 = child.props) != null ? _a3 : {}), props);
+    return i === 0 && isValidElement(child) ? cloneElement(child, mergeProps(baseProps, formItemProps.customizeProps(data, baseProps))) : child;
+  });
 }
 function registerFormItem(loader) {
   registerComponentHelper(loader, FormItemWrapper, {
     name: "plasmic-antd5-form-item",
-    displayName: "Form.Item",
+    displayName: "Form Item",
     parentComponentName: "plasmic-antd5-form",
     props: {
       label: {
@@ -311,12 +518,18 @@ function registerFormItem(loader) {
         type: "boolean"
       },
       rules: {
-        type: "formValidationRules",
-        displayName: "rules"
+        type: "formValidationRules"
+      },
+      noLabel: {
+        type: "boolean",
+        advanced: true
       },
       colon: {
         type: "boolean",
-        defaultValue: false,
+        defaultValueHint: (_ps, ctx) => {
+          var _a, _b;
+          return (_b = (_a = ctx == null ? void 0 : ctx.internalFormCtx) == null ? void 0 : _a.formProps.colon) != null ? _b : true;
+        },
         advanced: true
       },
       labelAlign: {
@@ -327,6 +540,66 @@ function registerFormItem(loader) {
       hidden: {
         type: "boolean",
         advanced: true
+      },
+      validateTrigger: {
+        type: "choice",
+        options: ["onSubmit", "onChange", "onBlur"],
+        multiSelect: true,
+        advanced: true
+      },
+      shouldUpdate: {
+        type: "boolean",
+        advanced: true,
+        displayName: "Always re-render",
+        description: "Form items normally only re-render when the corresponding form value changes, for performance. This forces it to always re-render."
+      },
+      helpTextMode: {
+        type: "choice",
+        displayName: "Help text",
+        options: [
+          {
+            value: "errors",
+            label: "Validation errors"
+          },
+          {
+            value: "extra",
+            label: "Custom help text and validation errors"
+          },
+          {
+            value: "help",
+            label: "Custom help text, no validation errors"
+          }
+        ],
+        defaultValueHint: "Show validation errors",
+        description: "What to show in the help text. Edit help text by editing the 'help' slot in the outline."
+      },
+      help: {
+        type: "slot",
+        hidden: (ps) => {
+          var _a;
+          return !["extra", "help"].includes((_a = ps.helpTextMode) != null ? _a : "");
+        },
+        hidePlaceholder: true
+      },
+      customizeProps: {
+        type: "function",
+        description: "Customize the props passed into the wrapped field component. Takes the current status ('success', 'warning', 'error', or 'validating').)",
+        argNames: ["fieldData"],
+        argValues: (_ps, ctx) => {
+          var _a;
+          return [
+            {
+              status: (_a = ctx == null ? void 0 : ctx.status) == null ? void 0 : _a.status
+            }
+          ];
+        },
+        advanced: true
+      },
+      noStyle: {
+        type: "boolean",
+        displayName: "Field only",
+        description: "Don't render anything but the wrapped field component - so no label, help text, validation error, etc.",
+        advanced: true
       }
     },
     importPath: "@plasmicpkgs/antd5/skinny/registerForm",
@@ -345,7 +618,7 @@ function FormGroup(props) {
 function registerFormGroup(loader) {
   registerComponentHelper(loader, FormGroup, {
     name: "plasmic-antd5-form-group",
-    displayName: "Form.Group",
+    displayName: "Form Group",
     parentComponentName: "plasmic-antd5-form",
     actions: COMMON_ACTIONS,
     props: {
@@ -387,7 +660,7 @@ const FormListWrapper = React.forwardRef(function FormListWrapper2(props, ref) {
   }), [operationsRef]);
   const inCanvas = !!usePlasmicCanvasContext();
   if (inCanvas) {
-    const form = Form.useFormInstance();
+    const form = useFormInstanceMaybe();
     const prevPropValues = React.useRef({
       initialValue: props.initialValue,
       name: props.name
@@ -398,7 +671,7 @@ const FormListWrapper = React.forwardRef(function FormListWrapper2(props, ref) {
         forceRemount == null ? void 0 : forceRemount();
       }
       if (fullFormItemName) {
-        form.setFieldValue(fullFormItemName, props.initialValue);
+        form == null ? void 0 : form.setFieldValue(fullFormItemName, props.initialValue);
         prevPropValues.current.initialValue = props.initialValue;
         fireOnValuesChange == null ? void 0 : fireOnValuesChange();
       }
@@ -426,33 +699,63 @@ function registerFormList(loader) {
   registerComponentHelper(loader, FormListWrapper, {
     name: "plasmic-antd5-form-list",
     parentComponentName: "plasmic-antd5-form",
-    displayName: "Form.List",
+    displayName: "Form List",
     actions: COMMON_ACTIONS,
     props: {
       children: {
         type: "slot",
         defaultValue: [
           {
-            type: "component",
-            name: "plasmic-antd5-form-item",
-            props: {
-              name: "item"
-            }
+            type: "hbox",
+            children: [
+              {
+                type: "component",
+                name: "plasmic-antd5-form-item",
+                props: {
+                  name: "firstName",
+                  label: {
+                    type: "text",
+                    value: "First name"
+                  },
+                  children: {
+                    type: "component",
+                    name: "plasmic-antd5-input"
+                  }
+                }
+              },
+              {
+                type: "component",
+                name: "plasmic-antd5-form-item",
+                props: {
+                  name: "lastName",
+                  label: {
+                    type: "text",
+                    value: "Last name"
+                  },
+                  children: {
+                    type: "component",
+                    name: "plasmic-antd5-input"
+                  }
+                }
+              }
+            ]
           }
         ]
       },
       name: {
         type: "string",
-        defaultValue: "list"
+        defaultValue: "guests"
       },
       initialValue: {
-        type: "object",
+        type: "array",
         defaultValue: [
           {
-            item: "Item 1"
+            firstName: "Jane",
+            lastName: "Doe"
           },
           {
-            item: "Item 2"
+            firstName: "John",
+            lastName: "Smith"
           }
         ]
       }