Preview: Vendure Core (columbia)

Previewvendurehq/vendure/columbia

Preview: Vendure Core (columbia) | Vendure Docs

Tsx

const { form, submitHandler } = useGeneratedForm({ document: setDraftOrderCustomFieldsDocument, varName: undefined, entity: entity, setValues: entity => {   return {     orderId: entity.id,     input: {       customFields: entity.customFields,     },   }; },});

Signature

function useGeneratedForm<T extends TypedDocumentNode<any, any>, VarName extends keyof VariablesOf<T> | undefined, E extends Record<string, any> = Record<string, any>>(options: GeneratedFormOptions<T, VarName, E>): void

Signature

interface GeneratedFormOptions<T extends TypedDocumentNode<any, any>, VarName extends keyof VariablesOf<T> | undefined = 'input', E extends Record<string, any> = Record<string, any>> {    document?: T;    varName?: VarName;    entity: E | null | undefined;    customFieldConfig?: any[];    extendSchema?: (schema: ZodObject<any>) => ZodTypeAny;    setValues: (        entity: NonNullable<E>,    ) => WithLooseCustomFields<        VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>    >;    onSubmit?: (        values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>,    ) => void;}

document

propertyT

The document to use to generate the form.

varName

propertyVarName

The name of the variable to use in the document.

entity

propertyE | null | undefined

The entity to use to generate the form.

customFieldConfig

propertyany[]

extendSchema

property(schema: ZodObject<any>) => ZodTypeAnyv3.7.0

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

property

(         entity: NonNullable<E>,     ) => WithLooseCustomFields<         VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>     >

onSubmit

property( values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>, ) => void

UseGeneratedForm

useGeneratedForm