UseGeneratedForm

changedFields

The set of top-level input field names the user actually changed relative to the loaded entity (plus non-nullable fields which are always included). undefined when creating a new entity (there is no baseline to diff against).

document

The document to use to generate the form.

varName

The name of the variable to use in the document.

entity

The entity to use to generate the form.

customFieldConfig

extendSchema

Refines the auto-generated Zod schema before it is passed to the form resolver. Use this to declare the fields which must actually be filled in by the user.

The generated schema is derived from the GraphQL input type, which only expresses nullability — and nullability tells you nothing about whether a value is required:

• A non-nullable field may still be legitimately empty. String! means "not null", not "not empty", and a non-nullable ID! such as CreateFacetValueInput.facetId may be supplied by the page in transformCreateInput rather than by the user.
• A nullable field may still be required by the server. CreateChannelInput. defaultCurrencyCode is nullable, yet ChannelService.create rejects the input unless it is set.

Note that this is read once, when the schema is first built: it is held in a ref so that an inline arrow function does not replace the resolver on every render.

Example

extendSchema: schema =>    schema.extend({        code: z.string().min(1, { message: t`This field is required` }),    }),

setValues

startingValues

The starting values to apply on top of the default values when there is no entity. They count as unsaved changes. The form resets whenever they change, so values such as new Date() should not be recreated on every render.

onSubmit