@react-fabric/form 1.0.0-beta.32 → 1.0.0-beta.34

package/src/builder/SchemaEditor.tsx

@@ -0,0 +1,457 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2025 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import {
+  Button,
+  Collapsable,
+  Content,
+  CoreIcons,
+  Footer,
+  Modal,
+  ToggleButtonGroup,
+  useOverlayService,
+} from "@react-fabric/core";
+import { type Elements } from "@react-fabric/core/dist/types/types";
+import { EMPTY_ARRAY } from "@react-fabric/utilities";
+import { Fragment, useCallback, useEffect, useRef, useState } from "react";
+import { Controller } from "../form/Controller";
+import { Form, type FormRef } from "../form/Form";
+import { ArrayInput } from "../input/ArrayInput";
+import { Checkbox } from "../input/Checkbox";
+import { DateInput } from "../input/DateInput";
+import { Field } from "../input/Field";
+import { HiddenInput } from "../input/Hidden";
+import { Input } from "../input/Input";
+import { Number } from "../input/Number";
+import { Select } from "../select/Select";
+import {
+  DATA_TYPES,
+  type DateSchema,
+  type DefaultSchema,
+  type FormSchema,
+  type NumberSchema,
+  type SchemaDef,
+  type StringSchema,
+  type ValueType,
+} from "../types/schema";
+
+interface Props {
+  schemaDef: FormSchema;
+  allowRemove?: boolean;
+  acceptableTypes?: DATA_TYPES[];
+
+  optionLists?: string[];
+
+  /**
+   * Footer actions
+   */
+  children?: Elements<JSX.Element> | Array<Elements<JSX.Element>>;
+
+  onChange: (schema: FormSchema) => void;
+}
+
+const CUSTOM_LIST = "--CUSTOM--";
+
+const SchemaField = ({
+  field,
+  getModel,
+  onRemove,
+  optionLists = EMPTY_ARRAY,
+  allowRemove,
+  onTypeChange,
+  acceptableTypes,
+}: {
+  field: string;
+  onRemove: () => void;
+  getModel: () => KeyValue;
+  onTypeChange: (val: KeyValue) => void;
+} & Omit<Props, "schemaDef" | "onChange">) => {
+  const [type, setType] = useState<DATA_TYPES>();
+  const [multiple, setMultiple] = useState(false);
+  const [hasOptions, setHasOptions] = useState(false);
+  const [customOptions, setCustomOptions] = useState(false);
+
+  const [OptionModal, openOptionModal] = useOverlayService((props) => (
+    <Modal {...props}>
+      <Content>
+        <ArrayInput name={`${field}.options`} onAdd={() => String("")}>
+          <Controller>
+            <Input />
+          </Controller>
+        </ArrayInput>
+      </Content>
+      <Footer
+        flex
+        justify="end"
+        className="sticky bottom-0 border-t bg-base px-6 py-2"
+      >
+        <Button variant="link" onClick={props.onClose}>
+          Close
+        </Button>
+      </Footer>
+    </Modal>
+  ));
+
+  useEffect(() => {
+    setTimeout(() => {
+      const model = getModel();
+      setType(model.datatype);
+      setMultiple(model.multiple);
+      setHasOptions(!!model.optionList);
+      setCustomOptions(model.optionList === CUSTOM_LIST);
+    }, 10);
+  }, []);
+
+  const handleTypeChange = useCallback((type: DATA_TYPES) => {
+    if (type) {
+      const modelRef = getModel();
+      let reset = {
+        datatype: type,
+        id: field,
+        label: modelRef.label,
+        defaultValue: modelRef.defaultValue,
+        required: modelRef.required,
+        multiple: type === DATA_TYPES.AVATAR ? false : modelRef.multiple,
+        minItems: modelRef.minItems,
+        maxItems: modelRef.maxItems,
+      } as DefaultSchema & ValueType;
+      if (type === DATA_TYPES.STRING) {
+        reset = Object.assign(reset, {
+          optionList: modelRef.optionList,
+          options: modelRef.options,
+          regex: modelRef.regex,
+        } as StringSchema);
+      } else if (type === DATA_TYPES.DATE) {
+        reset = Object.assign(reset, {
+          type: "date",
+        } as DateSchema);
+      } else if (type === DATA_TYPES.NUMBER || type === DATA_TYPES.RANGE) {
+        reset = Object.assign(reset, {
+          min: modelRef.min,
+          max: modelRef.max,
+          step: modelRef.step,
+        } as NumberSchema);
+      }
+      if (type === DATA_TYPES.AVATAR) {
+        setMultiple(false);
+      }
+      onTypeChange(reset);
+      setType(type);
+    }
+  }, []);
+
+  return (
+    <Collapsable key={field} open>
+      <div className="flex flex-nowrap group/field">
+        <span className="flex-1 truncate">{field}</span>
+        {allowRemove && (
+          <Button
+            size="sm"
+            color="danger"
+            variant="link"
+            aria-label="Delete"
+            stopPropagation
+            icon={CoreIcons.trash}
+            onClick={onRemove}
+            className="invisible group-hover/field:visible"
+          />
+        )}
+      </div>
+      <div className="flex flex-col gap-1 pb-4">
+        <Controller name={`${field}.id`}>
+          <HiddenInput hiddenValue={field} />
+        </Controller>
+        <Controller name={`${field}.datatype`}>
+          <Select
+            inline
+            label="Type"
+            placeholder="Data type"
+            options={acceptableTypes}
+            onChange={(val) => handleTypeChange(val as unknown as DATA_TYPES)}
+          />
+        </Controller>
+        <Controller name={`${field}.label`}>
+          <Input
+            inline
+            label="Label"
+            allowClear
+            placeholder="Label..."
+            decorateEndShowWhenEmpty
+            decorateEnd={
+              <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+            }
+          />
+        </Controller>
+        {type === DATA_TYPES.STRING && (
+          <Fragment>
+            <Controller name={`${field}.regex`}>
+              <Input
+                inline
+                label="Regex validation"
+                allowClear
+                placeholder="Regex value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+            <Field inline label="Option list">
+              <Controller name={`${field}.optionList`}>
+                <Select
+                  allowClear
+                  options={[CUSTOM_LIST, ...optionLists]}
+                  onChange={(v) => setCustomOptions(v === CUSTOM_LIST)}
+                />
+              </Controller>
+              {customOptions && (
+                <Button
+                  icon={CoreIcons.list}
+                  aria-label="Custom options"
+                  onClick={() => {
+                    void openOptionModal();
+                  }}
+                />
+              )}
+            </Field>
+            {OptionModal}
+          </Fragment>
+        )}
+        {type === DATA_TYPES.FILE && (
+          <Fragment>
+            <Controller name={`${field}.accept`}>
+              <Input
+                inline
+                label="Accept types"
+                allowClear
+                placeholder="Accept value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+          </Fragment>
+        )}
+        {[DATA_TYPES.NUMBER, DATA_TYPES.RANGE].includes(
+          type as unknown as DATA_TYPES,
+        ) && (
+          <Fragment>
+            <Controller name={`${field}.min`}>
+              <Number
+                inline
+                label="Min value"
+                allowClear
+                placeholder="Minimum value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+            <Controller name={`${field}.max`}>
+              <Number
+                inline
+                label="Max value"
+                allowClear
+                placeholder="Maximum value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+            <Controller name={`${field}.step`}>
+              <Number
+                inline
+                label="Step value"
+                allowClear
+                placeholder="Step value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+          </Fragment>
+        )}
+        {type === DATA_TYPES.DATE && (
+          <Fragment>
+            <Field inline label="Type" plain>
+              <Controller name={`${field}.type`}>
+                <ToggleButtonGroup value="" fullWidth className="flex-1">
+                  <Button className="flex-1" value="date">
+                    Date
+                  </Button>
+                  <Button className="flex-1" value="datetime">
+                    Date Time
+                  </Button>
+                </ToggleButtonGroup>
+              </Controller>
+            </Field>
+            <Controller name={`${field}.min`}>
+              <DateInput
+                inline
+                label="Min value"
+                allowClear
+                placeholder="Minimum value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+            <Controller name={`${field}.max`}>
+              <DateInput
+                inline
+                label="Max value"
+                allowClear
+                placeholder="Maximum value..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+          </Fragment>
+        )}
+        <Field label=" " inline plain>
+          <Controller name={`${field}.required`}>
+            <Checkbox label="Required" />
+          </Controller>
+          {type !== DATA_TYPES.AVATAR && (
+            <Controller name={`${field}.multiple`}>
+              <Checkbox label="Multiple" onChange={setMultiple} />
+            </Controller>
+          )}
+          {hasOptions && (
+            <Controller name={`${field}.allowCustom`}>
+              <Checkbox label="Allow custom value" />
+            </Controller>
+          )}
+        </Field>
+        {multiple && (
+          <Fragment>
+            <Controller name={`${field}.minItems`}>
+              <Number
+                inline
+                label="Min items"
+                allowClear
+                placeholder="Minimum items..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+            <Controller name={`${field}.maxItems`}>
+              <Number
+                inline
+                label="Max items"
+                allowClear
+                placeholder="Maximum items..."
+                decorateEndShowWhenEmpty
+                decorateEnd={
+                  <span className="text-sm text-muted/50 px-1">OPTIONAL</span>
+                }
+              />
+            </Controller>
+          </Fragment>
+        )}
+      </div>
+    </Collapsable>
+  );
+};
+
+export const SchemaEditor = ({
+  schemaDef,
+  allowRemove,
+  acceptableTypes,
+  optionLists = EMPTY_ARRAY,
+  children,
+  onChange,
+}: Props) => {
+  const formRef = useRef<FormRef<KeyValue>>(null);
+  const [schemaFields, setSchemaFields] = useState<string[]>([]);
+
+  useEffect(() => {
+    const schemaMap = Object.fromEntries(
+      schemaDef.map((schema) => [schema.id, schema]),
+    );
+
+    const currentModel: KeyValue = formRef.current?.getValues() ?? {};
+
+    const schema = Object.fromEntries(
+      Object.keys(schemaMap).map((field) => [
+        field,
+        currentModel[field] ?? schemaMap[field],
+      ]),
+    );
+    formRef.current?.setValues(schema);
+    setTimeout(() => {
+      setSchemaFields(Object.keys(schema));
+    }, 100);
+  }, [schemaDef]);
+
+  const handleChange = useCallback((model: KeyValue<SchemaDef>) => {
+    onChange?.(Object.values(model));
+  }, []);
+
+  const handleTypeChange = useCallback((field: string, val: KeyValue) => {
+    formRef.current?.setValue(field, val);
+  }, []);
+
+  const handleRemove = useCallback((field: string) => {
+    const newSchema: KeyValue = formRef.current?.getValues() ?? {};
+    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+    delete newSchema[field];
+    formRef.current?.setValues(newSchema);
+    setTimeout(() => {
+      setSchemaFields(Object.keys(newSchema));
+    }, 100);
+  }, []);
+
+  return (
+    <Form formRef={formRef} onSubmit={handleChange}>
+      <Content className="divide-y">
+        {schemaFields.map((field) => (
+          <SchemaField
+            key={field}
+            field={field}
+            allowRemove={allowRemove}
+            optionLists={optionLists}
+            onRemove={() => handleRemove(field)}
+            getModel={() => formRef.current?.getValues()[field]}
+            onTypeChange={(val: KeyValue) => handleTypeChange(field, val)}
+            acceptableTypes={acceptableTypes ?? Object.values(DATA_TYPES)}
+          />
+        ))}
+      </Content>
+      {children && (
+        <Footer flex className="border-t bg-base px-6 py-2">
+          {children}
+        </Footer>
+      )}
+    </Form>
+  );
+};

package/src/form/Controller.tsx

@@ -46,7 +46,7 @@ export interface ControllerProps {
         disabled?: boolean;
         onBlur: () => void;
         onChange: (value: AnyObject) => void;
-        inputRef?: React.Ref<HTMLInputElement>;
+        ref?: React.Ref<HTMLInputElement>;
       }) => ReactElement);
 }
 
@@ -86,7 +86,7 @@ export const Controller = ({ name, children, ...rest }: ControllerProps) => {
           : children({
               ...field,
               ...rest,
-              inputRef: (el: AnyObject) => {
+              ref: (el: AnyObject) => {
                 el && ref(el);
               },
               readOnly: isSubmitting,

package/src/form/Form.tsx

@@ -23,7 +23,7 @@
 
 import { yupResolver } from "@hookform/resolvers/yup";
 import { useDebounce } from "@react-fabric/core";
-import { type yup } from "@react-fabric/utilities";
+import { EMPTY_OBJECT, type yup } from "@react-fabric/utilities";
 import {
   useCallback,
   useEffect,
@@ -47,6 +47,7 @@ export interface FormRef<K extends KeyValue> {
   submit: () => void;
   validate: () => Promise<boolean>;
   getValues: () => K;
+  removeField: (field: string) => void;
   setValue: (key: keyof K, value: AnyObject) => void;
   setValues: (values: K) => void;
 }
@@ -77,7 +78,7 @@ export const Form = <K extends KeyValue>({
   formRef,
   schema,
   children,
-  defaultValues,
+  defaultValues = EMPTY_OBJECT as K,
   onSubmit = DEFAULT_SUBMIT,
   onChange,
   ...rest
@@ -85,14 +86,11 @@ export const Form = <K extends KeyValue>({
   const ref = useRef<HTMLFormElement>(null);
   const form = useForm<K>({
     shouldFocusError: true,
+    shouldUnregister: true,
     resolver: schema && (yupResolver(schema) as AnyObject),
     defaultValues: defaultValues as DefaultValues<K>,
   });
 
-  useEffect(() => {
-    form.reset();
-  }, []);
-
   const [, startTransition] = useTransition();
   const changeHandler = useDebounce(onChange, [onChange]);
   useEffect(() => {
@@ -123,6 +121,8 @@ export const Form = <K extends KeyValue>({
       validate: async () => await form.trigger(),
       getValues: () => form.getValues(),
       setValues: (v) => setTimeout(() => form.reset(v), 50),
+      removeField: (field: AnyObject) =>
+        form.unregister(field, { keepDefaultValue: false, keepValue: false }),
       setValue: (k, v) =>
         setTimeout(
           () =>

package/src/hooks/useFormBuilder.tsx

@@ -21,38 +21,47 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+import { EmptyContent } from "@react-fabric/core";
 import { isEmpty, isNil, yup } from "@react-fabric/utilities";
 import { Fragment, useMemo } from "react";
 import { FormField } from "../builder/FormField";
-import { type FormSchema } from "../types/schema";
+import { type BaseSelectProps } from "../types";
+import { DATA_TYPES, type FormSchema, type SchemaDef } from "../types/schema";
 import { type UploadHandler } from "./useFileUploader";
 
-const makeYupField = (field: FormSchema) => {
-  let yupField: AnyObject = yup.string();
-  if (field.datatype === "schema") {
+const makeYupField = (field: SchemaDef) => {
+  let yupField: AnyObject = yup.string().trim();
+  if (field.datatype === DATA_TYPES.SCHEMA) {
     const child: yup.ObjectShape = Object.fromEntries(
       field.schema.map((field) => [field.id, makeYupField(field)]),
     );
     yupField = yup.object(child);
   }
-  if (field.datatype === "boolean") yupField = yup.boolean();
+  if (field.datatype === DATA_TYPES.BOOL) {
+    yupField = yup.boolean();
+    if (field.required)
+      yupField = yupField.test({
+        test: (value: boolean) => !!value,
+      });
+  }
   if (
-    field.datatype === "decimal" ||
-    field.datatype === "number" ||
-    field.datatype === "range"
+    field.datatype === DATA_TYPES.NUMBER ||
+    field.datatype === DATA_TYPES.RANGE
   ) {
     yupField = yup.number();
     !isNil(field.min) && (yupField = yupField.min(field.min));
     !isNil(field.max) && (yupField = yupField.max(field.max));
 
-    if (field.datatype === "range") yupField = yup.array(yupField);
+    if (field.datatype === DATA_TYPES.RANGE) yupField = yup.array(yupField);
   }
-  if (field.datatype === "string") {
-    field.options && (yupField = yupField.oneOf(field.options));
+  if (field.datatype === DATA_TYPES.STRING) {
+    field.options &&
+      !field.allowCustom &&
+      (yupField = yupField.oneOf(field.options));
     field.regex && (yupField = yupField.matches(new RegExp(field.regex)));
   }
 
-  if (field.datatype === "file") {
+  if (field.datatype === DATA_TYPES.FILE) {
     yupField = yup
       .object({
         filename: yup.string().required(),
@@ -83,13 +92,14 @@ const makeYupField = (field: FormSchema) => {
   return yupField.label(field.label);
 };
 
-export const useFormBuilder = (
-  schema: FormSchema[],
+export const useFormBuilder = <T extends AnyObject = string>(
+  schema: FormSchema,
   options: {
     prefix?: string;
     inline?: boolean;
     fileUrl?: (path: string) => string;
     uploadHandler?: UploadHandler;
+    optionLists?: KeyValue<BaseSelectProps<T>>;
   } = {},
 ) => {
   const filteredSchema = useMemo(
@@ -106,11 +116,12 @@ export const useFormBuilder = (
     <Fragment>
       {filteredSchema.map((field, idx) => (
         <div className="mb-4" key={field.id}>
-          {field.datatype === "schema" ? null : (
+          {field.datatype === DATA_TYPES.SCHEMA ? null : (
             <FormField
               {...field}
               autoFocus={idx === 0}
               fileUrl={options.fileUrl}
+              optionLists={options.optionLists}
               uploadHandler={options.uploadHandler}
               inline={options.inline}
               prefix={options.prefix}
@@ -118,6 +129,9 @@ export const useFormBuilder = (
           )}
         </div>
       ))}
+      {filteredSchema.length === 0 && (
+        <EmptyContent message="No schema defined" />
+      )}
     </Fragment>
   );
 

package/src/index.ts

@@ -26,15 +26,18 @@ import "./i18n";
 export { Controller } from "./form/Controller";
 export { Form, type FormRef } from "./form/Form";
 
+export { SchemaEditor } from "./builder/SchemaEditor";
+
 export { useFileUploader } from "./hooks/useFileUploader";
 export { useFormBuilder } from "./hooks/useFormBuilder";
 
-export { type FormSchema } from "./types/schema";
+export { DATA_TYPES, type FormSchema, type SchemaDef } from "./types/schema";
 
 export { ArrayInput } from "./input/ArrayInput";
 export { Checkbox } from "./input/Checkbox";
 export { ColorInput } from "./input/ColorInput";
 export { ColorPicker } from "./input/ColorPicker";
+export { DateInput } from "./input/DateInput";
 export { Field } from "./input/Field";
 export { FileInput } from "./input/File";
 export { HiddenInput } from "./input/Hidden";
@@ -43,7 +46,7 @@ export { Number } from "./input/Number";
 export { Password } from "./input/Password";
 export { Radio } from "./input/Radio";
 export { RadioGroup } from "./input/RadioGroup";
-export { Range } from "./input/Range";
+export { RangeSlider } from "./input/RangeSlider";
 export { Search } from "./input/Search";
 export { Slider } from "./input/Slider";
 export { Switch } from "./input/Switch";

package/src/input/Checkbox.tsx

@@ -34,7 +34,7 @@ import {
 } from "react";
 import { ErrorIcon } from "../internal/ErrorIcon";
 
-export interface CheckboxProps extends RefProp<HTMLInputElement> {
+interface CheckboxProps extends RefProp<HTMLInputElement> {
   /**
    * checkbox label
    */
@@ -50,8 +50,7 @@ export interface CheckboxProps extends RefProp<HTMLInputElement> {
   /**
    * on checked change
    */
-  onChange?: (checked: boolean | string | number) => void;
-
+  onChange?: (checked: boolean) => void;
   /**
    * disabled input
    */
@@ -94,6 +93,8 @@ export const Checkbox = ({
   width,
   icon,
   iconChecked,
+  // @ts-expect-error ignore
+  required,
   onChange,
   ...rest
 }: CheckboxProps) => {