vantezzen/auto-form

🌟 A React component that automatically creates a @shadcn/ui form based on a zod schema.

Hi, I'm Bennett! I'm a software developer from Germany developing web-apps and other web-based projects. I open-source a lot of my software so you can see it here on GitHub .

🚀 Some interesting open-source projects I'm working on:

• Skip Silence (Source): A browser extension that skips silent parts of a video
• blymp.io (Source): Transfer files in your browser using Peer-to-peer technologies
• minimalpedia (Source): A minimalistic frontend for Wikipedia using React
• Cauldron.js: Run a Minecraft Server in your browser

🌍 Find me on the web:

• You can find my full portfolio on https://vantezzen.io/
• You can find me on Twitter

auto-form's Issues

onChange not getting fired on any field

Hey! Awesome library, saves a bunch of time.

However, I am facing this issue while I am trying to display the photos selected by the user through a file input.

 fieldConfig={{
                images: {
                    description: "Upload images",
                    fieldType: "file",
                    inputProps: {
                        multiple: true,
                        accept: "image/*",
                        onChange: (e) => {
                            console.log({ e })
                        },
                    }
                },

onChange is not getting fired on this or any other field. How can I fix this?

Property 'innerType' does not exist on type 'ZodAnyDef'.

great component. works smoothly locally but but not deploying due to two issues in the auto-form.tsx

1. Property 'innerType' does not exist on type 'ZodAnyDef'.
2. Property 'schema' does not exist on type 'ZodAnyDef'.

related to line 62 and 66:

"function getBaseSchema(schema: z.ZodAny): z.ZodAny {
if ("innerType" in schema._def) {

return getBaseSchema(schema._def.innerType as z.ZodAny);

}
if ("schema" in schema._def) {

return getBaseSchema(schema._def.schema as z.ZodAny);

}
return schema;
}"

Building on Next.js 13 using Shadcn Taxonomy. Any ideas how to fix?

globals.css don't work

I followed the docs but my globals.css don't work, I don't have any styles

Confirm password does not work

const formSchema = z
	.object({
		password: z.string(),
		confirm: z.string(),
	})
	.refine((data) => data.password === data.confirm, {
		message: 'Passwords must match.',
		path: ['confirm'],
	});

			<AutoForm
				formSchema={formSchema}
				fieldConfig={{
					password: {
						inputProps: {
							type: 'password',
							placeholder: '••••••••',
						},
					},
					confirm: {
						inputProps: {
							type: 'password',
							placeholder: '••••••••',
						},
					},
				}}
			>

Throws this error

How to use with shadcn dialogue/modal?

And when we click on the "submit button" it also closes the modal

bug: nativeEnums don't pass validation (including demo)

Basically, nativeEnums are broken now; I see this issue also on the demo page:

Dependencies for nested fields

Hey! I am trying to implement a rather complex form and would like to apply dependencies on nested fields. Here's a sample schema:

 inventory: z
    .array(
      z.object({
        size: z.enum([
          "XXS",
          "XS",
          "S",
          "M",
          "L",
          "XL",
          "XXL",
          "XXXL",
          "Free Size",
          "One Size",
          "Custom",
        ]),
        customSize: z.string().optional(),
        measurements: z.object({
          bust: z.number().optional(),
          waist: z.number().optional(),
        }),
        variant: z.array(
          z.object({
            name: z.string(),
            quantity: z.number(),
            price: z.number(),
          }),
        ),
      }),
    )

What i am trying to do is show and hide the custom size field depending upon the current value of the size select. The docs do not mention how to name the dependencies when dealing with nested fields.

Grateful for any help.

String Arrays Support

Hi there,
First of all thanks for the great tool which you developed. For my case, I need AutoForm to support String Arrays. which unfortunately, I couldn't figure out how to do it.

The field is as below:

highlights: z
      .array(
        z
          .string()
          .describe(
            "e.g. Increased profits by 20% from 2011-2012 through viral advertising"
          )
      )
      .describe("Specify multiple accomplishments")
      .optional(),

reset form

is there a way to reset form value ? or get form instance ?

Lookup Field ?

Would it be possible to create a select with data from an api?
Something similar to a lookup field.

feature request: introduce fieldRender

Alternatively, you can pass a React component to the fieldType property to use a custom component.

overloading fieldType to render the component when you pass a function is not very nice
ideally we could have fieldRender or similar.
I know naming is hard, but this Render suffix is well established naming pattern. Also overloaded fields often give weird typescript errors.

Default value priority

I've hit a situation where I define the values in the schema, which is stored in a static file, but I want to override the default values via fieldConfig.inputProps which I feel should get priority

I would suggest the following change here:

auto-form/src/components/ui/auto-form/utils.ts

Line 105 in 0143f43

if (

Instead of

if (
        (defaultValue === null || defaultValue === "") &&
        fieldConfig?.[key]?.inputProps
      ) {
        defaultValue = (fieldConfig?.[key]?.inputProps as unknown as any)
          .defaultValue;
      }

I would change this to:

if ((fieldConfig?.[key]?.inputProps as unknown as any)?.defaultValue) {
        defaultValue = (fieldConfig?.[key]?.inputProps as unknown as any)
          .defaultValue
      }

This way the inputProps will get the highest prio and override the schema default value. What do you think @vantezzen ?

Zod optional field with default value become required

Hi,
I don't kown why i have a optional field in my zod schema when i put a default value for edit action.
My field become required but i don't want that because it's filled by my model value or empty,
so why it's required ?
Am i doing something wrong ?
Thanks

fieldConfig type safety for nested fields (z.object)

Hi, I have been doing some experiments with this form and have come across this problem:
When I use only 1 level of fields, without any z.object in my schema, the autocomplete and type validation for fieldConfig works fine, but when I use some nested fields and objects in my schema, the autocompletion is lost.
Consider this schema:
`z.object({
group1: z.object({
username: z.string({
required_error: 'Username is required.',
}),

    password: z.string({
        required_error: 'Password is required.',
    }),
}),

});`
If I now try to put set some irrelevant property to fieldConfig, there is no warning:

The expected behavior would be to throw a type error, as in the flat schema case:

Is it because typescript is not able to correctly resolve the recursion type to FieldConfigItem ?

Also, I was wondering what approach you would recommend for extending the configuration options for the objects. I would like to be able to choose from more rendering components than just Accordion, but am not sure what is the best path to take. The best solution would be something type-safe.

Anyway, thanks for this great idea of schema based form !

isRequired is not correct

        const isRequired =
          zodInputProps.required ??
          fieldConfigItem.inputProps?.required ??
          false;

  ------------->
       const isRequired =
          zodInputProps.required  ||
          fieldConfigItem.inputProps?.required ||
          false;

a = b ?? c
?? means : if b is null or undefined then c, not include 'false'

required_error message never shows

First, thanks for this project.

I don't know if I'm doing something wrong but the required_error message is never shown for me. Native browser error does.

const formSchema = z.object({
        email: z.
            string({
                required_error: "Veuillez renseigner votre e-mail.",
            })
            .email({
                message: "E-mail incorrect.",
            })
    });

Am I doing something wrong ?

Email format check error works as intended and display the red message.

Array support?

Would be nice to support ZodArray type. React Hook Form has a useFieldArray hook to help add, remove, etc.

Select field with combobox implementation

First of all, great work here! You (and shadcn) are making huge difference for React beginners like me to create prototypes.

It will be really cool to have a searchable select (combobox) especially for API use-cases where large number of results can be returned.

setup code formatter

Would advise to setup a formatter such as Prettier

Not having one makes contributing harder.
You either have to receive everyone's personal formatting in each PR, or have to save without formatting

array of objects with .optional fails with Uncaught TypeError: Cannot read properties of undefined (reading '_def')

example:

    failSchema: z.array(z.object({
           ...
          }),
      )
      .optional()

onValuesChange not working properly for nested objects, and arrays.

I noticed that onValuesChange is not getting called until the nested object is valid. Example:

On page.tsx

"use client"
import { useState } from "react"
import z from "zod"

import { AutoForm } from 'ui';

const schema = z.object({
  field: z.string(),
  objField: z.object({
      nested: z.string(),
      nested2: z.boolean()
   })
});

export default function Page() {
  const [values, setValues] = useState<Partial<z.infer<typeof schema>>>({})

  function updateValues(data: Partial<z.infer<typeof schema>>){
    console.log(values)
    setValues(data)
  }

  return (
    <>
      <AutoForm
        onValuesChange={updateValues}
        values={values}
        formSchema={schema}
      />
    </>
  );
}

When updating nested but not nested2, onValuesChange is not called since nested2 is required. Maybe it's not a bug, but I would like to get track of every change in the form.

License Addition

📄 License Addition

Description

This repository currently doesn't have a license. Adding a license is essential to clearly define the terms under which the code can be used, modified, or distributed.

Suggested Solution

1. Determine the most appropriate license for this project. Some popular options include MIT, GPL, and Apache 2.0.
2. Add the selected license file to the root of the repository.
3. Update the README to reference the license.

Additional Context

A clear license can encourage contributions by providing clarity on code usage and distribution. Without a license, users and contributors might be hesitant to interact with the project due to legal ambiguities.

Please let me know your thoughts or if there's a specific license you have in mind for this project.

Perhaps a support for useFormState and useFormStatus would be great

I love this lib.

I would love it even more if we would have support for the new useFormState and useFormStatus hooks. It would make this library very convenient for the Nextjs users that use server actions.

autoform <select>, not correctly emitting onValuesChange onParsedValuesChange

i am using zod.enum and when renderng the I the onValuesChange or onParsedValuesChange are emitting the old value and not the new one

feature request: allow to overload the label in fieldConfig

ATM I can only set field description there

question: Is there a way to render into grid?

I have tried just slapping className='grid grid-cols-2 gap-4' onto Autoform but no luck.
Is there a way to achieve grid layout?

Array values in nested object aren't loaded

The AutoFormArray component has a bug in it's hook usage that leads to arrays inside nested objects to not load values.

Original version:

const { fields, append, remove } = useFieldArray({ control: form.control, name, });

Solution:

const { fields, append, remove } = useFieldArray({ control: form.control, name: path.join(".") });

Side note, @vantezzen i'd love to collaborate with you on this repo (mainly fixing the rough edges i find and adding support for translations) but i'm not the best expert in using git. Feel free to let me know if we can have a talk!

Forms

Cannot load array default value

Hi, i have a problem to load array default value. My code like this:

datevisits: z
      .array(
        z.object({
          date: z.date().optional(),
          time: z
            .string()
            .regex(
              /^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$/,
              "Time must be in format HH:MM (24 hours format)"
            )
            .optional(),
        })
      )
      .describe("Date Visits")
      .default(data.date_visits || []),

the data.date_visits will have value like this:

data.data.date_visits = data.data.date_visits.map((item: any) => {
            return {
              date: new Date(item.date),
              time: moment(item.date).format("HH:mm"),
            };
          });

The page loaded, but the date visits value are not set, and when i try to add date visits, date and string field are vanished.

Conditional Logics for Forms

Feature Suggestion

Description

I'd like to propose a new feature that enables Conditional Logics for Forms in the AutoForms component. This feature would allow users to dynamically render fields based on predefined rules within the AutoForms component.

Technical Details

Implementation Suggestions

To implement this feature, we can follow these steps:

1. Define Condition Rules: Within the AutoForms component, users can define condition rules that specify when a field should be displayed or hidden based on the values of other fields.

2. Evaluate Conditions: When a user interacts with the form (e.g., by typing in an input field), the AutoForms component will evaluate the condition rules to determine if any fields should be dynamically rendered or hidden.

3. Dynamic Rendering: If a condition evaluates to true, the corresponding field will be dynamically rendered; if it evaluates to false, the field will be hidden.

4. React State Management: Use React state (e.g., useState or useReducer) to manage the dynamic rendering of fields based on the condition rules.

5. Update Form State: Ensure that the form state accurately reflects the values of all visible fields, even if some are dynamically rendered based on conditions.

Additional Notes

This feature would greatly enhance the flexibility and customization options available to users of the AutoForms component. It would allow for more dynamic and context-aware form rendering.

Looking forward to your feedback on this suggestion!

Best regards,

optional() for enums breaks the app

For example, this would break the app

color: z.enum(['red', 'green', 'blue']).optional()

Resulting in:

TypeError: Cannot read properties of undefined (reading 'map')

// components\ui\auto-form.tsx (409:20) @ map
  407 | </SelectTrigger>
  408 | <SelectContent>
> 409 |   {values.map((value: any) => (
      |          ^
  410 |     <SelectItem value={value} key={value}>
  411 |       {value}
  412 |     </SelectItem>

Props must be serializable for client components

This issue occurs in the date-picker ui component at the setDate prop when using it in Next.js 13.4.

"use client"
...
export function DatePicker({ date, setDate }: { date?: Date; setDate: (date?: Date) => void }) {
...

setDate can not be of type (date?: Date) => void

feature request: be able to reorder fields

I am generating schemas from drizzle tables so I don't control order of fields. Would be awesome to be able to reorder in fieldconfig

enum error

use enum problem
The label's for attribute doesn't match any element id. This might prevent the browser from correctly autofilling the form and accessibility tools from working correctly.
To fix this issue, make sure the label's for attribute references the correct id of a form field.

Clever way to add the possibility to set a specific variant for a field ?

As the title says, I need to use different variant of an Input throughout the project.
Is their a good (and easy) way to achieve that ?

Clear form input on submit

How to clear the input after submiting the stuff?

<AutoForm formSchema={formSchema} onSubmit={addTodo}>
    <AutoFormSubmit />
</AutoForm>

const [todos, setTodos] = useState([] as Todo[]);
  const [done, _setDone] = useState(false);
  const [loading, setLoading] = useState(true);

  const loadTodos = () => {
    const storedTodos = JSON.parse(localStorage.getItem("todos") || "[]");
    setTodos(storedTodos);
    setLoading(false);
  };

  useEffect(() => {
    loadTodos(); // Appel de la fonction pour charger les todos depuis le stockage local
  }, []);

  function addTodo(event: TodoFormResult) {
    // Add the new todo to the list
    const newTodo = { text: event.todo, done, id: Date.now() };
    const updatedTodos = [...todos, newTodo];
    setTodos(updatedTodos);

    // Save the updated list to local storage
    localStorage.setItem("todos", JSON.stringify(updatedTodos));
  }

How to catch autoForm errors?

I wanted to display the errors of the messages that I put in the validation in the schema, does anyone know how to do it ?

'ParentElement' cannot be used as a JSX component.

Trying to add to NextJS project creating using the latest shadcn template project but receiving this error in the auto-form.tsx component. 'ParentElement' cannot be used as a JSX component.

Support nativeEnum

Would be nice if nativeEnums could default to a Select alongside regular enums

Select Component eum with custom data limitation

Thanks first of all for creating this awesome project!
While trying to integrate autoform into a project of mine, I came across a limitation of the select field.

The Problem

I have some data from a api that gets fetched on pageload with custom data.
It looks something like this:

const users = [{
id: '123',
name: 'hello'
},
{
id: '789,
name: 'world'
}]

I want to display the name of the field in the select menu, and when submitting it should pass the id.

label = name
value = id

In the docs I found this sentence:

// Keep in mind that zod will validate and return the enum labels, not the enum values!

I am not sure why this is, but this seems very unintuitive, especially when working with values that are not just simple 'one value' enums.

Solution?

Is there a way to work around this? Or even improve the Code to allow for the value to be validated not the label?
Or using a different (custom) datatype, an array of objects with label & value attributes for example

[Bug] Deletion doesn't work properly in Array Support

Just tried the Array Support on the demo website.

When I deleted the first entry this happened:

You can see the first entry is this there but the second one was 'delete'. If you look closely you can see it only removed it from the ui not the json underneath. After clicking the add button again it magically reappears.

After testing with 3 entries, it looks like the delete button always (no matter witch entry) deletes the last entry (from the ui only)

Improvement Proposal

Hello,

Just discovered your autoform component and it is great !

May I ask if it would be possible to include a "hidden" optional field.
In my casse, it would be usefull so that the schema can contain information ,but it should be sent in secret by the browser :)

Also, would it be possible to put two inputs on the same row for example? :) (like on the image below )

if object is .optional() auto-form breaks

if i have a form like:

// ❌
const schema = z.object({
  a: z.string(),
  b: z.object({
    x: z.string(),
  }).optional(),
});

autoform breaks, if i remove .optional it works

 // ✅
export const testSchema = z.object({
  a: z.string(),
  b: z.object({
    x: z.string(),
  }),
});

Ignore certain zod field while generating the form

Is there a feature to let you ignore certain fields in the zod schema while generating the form?

For example:

<AutoForm 
    formSchema={formSchema}
    ignoreFields={["foo", "bar"]}>

</AutoForm>

Uncontrolled to controlled warning

I'm getting this warning in the console. Wondering if there's a fix for this that doesn't involve controlling the field state and passing that in as a value prop? The warning is stating that the field value has an initial uncontrolled state of null or undefined and is changing to a controlled field when the value changes.

Warning: A component is changing an uncontrolled input to be controlled. This is likely caused by the value changing from undefined to a defined value, which should not happen. Decide between using a controlled or uncontrolled input element for the lifetime of the component.

How Update existing values from defaultValues ?

It is not possible to make the modification because the form does not support the existing data

React.forwardRef()

When I create a form that is in Dialog:

When I open Dialog, I get an error/warning in the console:

Warning: Function components cannot be given refs. Attempts to access this ref will fail. Did you mean to use React.forwardRef()?

Do I need to react to it, or can it be ignored?

Creating a name package ?

Have you thought about providing an npm package for auto-form? 😊

Maybe not make all the components available, or maybe make it possible to override them to have custom ones?