DetailForms

@vendure/dashboard Sourcev3.4.0

Allows you to define custom input components for specific fields in detail forms. The pageId is already defined in the detail form extension, so only the blockId and field are needed.

Signature

interface DashboardDetailFormInputComponent {    blockId: string;    field: string;    component: DashboardFormComponent;}

blockId

propertystring

The ID of the block where this input component should be used.

field

propertystring

The name of the field where this input component should be used.

component

propertyDashboardFormComponent

The React component that will be rendered as the input. It should accept value, onChange, and other standard input props.

@vendure/dashboard Sourcev3.4.0

Allows you to extend existing detail forms (e.g. on the product detail or customer detail pages) with custom GraphQL queries, input components, and display components.

Signature

interface DashboardDetailFormExtensionDefinition {    pageId: string;    extendDetailDocument?: string | DocumentNode | (() => DocumentNode | string);    inputs?: DashboardDetailFormInputComponent[];}

pageId

propertystring

The ID of the page where the detail form is located, e.g. 'product-detail', 'order-detail'.

extendDetailDocument

propertystring | DocumentNode | (() => DocumentNode | string)

Extends the GraphQL query used to fetch data for the detail page, allowing you to add additional fields that can be used by custom input or display components.

inputs

propertyDashboardDetailFormInputComponent[]

Custom input components for specific fields in the detail form.