Skip to main content

FormComponents

DashboardCustomFormComponent​

@vendure/dashboardform-components.ts
v3.4.0

Allows you to define custom form components for custom fields in the dashboard.

Signature
interface DashboardCustomFormComponent {
    id: string;
    component: DashboardFormComponent;
}

id​

property
string

A unique identifier for the custom form component. It is a good practice to namespace these IDs to avoid naming collisions, for example "my-plugin.markdown-editor".

component​

property
DashboardFormComponent

The React component that will be rendered as the custom form input.

DashboardCustomFormComponents​

@vendure/dashboardform-components.ts
v3.4.0

Interface for registering custom field components in the dashboard. For input and display components, use the co-located approach with detailForms.

Signature
interface DashboardCustomFormComponents {
    customFields?: DashboardCustomFormComponent[];
}

customFields​

property
DashboardCustomFormComponent[]

Custom form components for custom fields. These are used when rendering custom fields in forms.