ContextQMD
Back to Vendure

ReactCustomDetailComponentConfig

docs/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx

3.7.0989 B
Original Source
<GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />

Configures a React-based component to be placed in a detail page in the given location.

ts
interface ReactCustomDetailComponentConfig {
    locationId: CustomDetailComponentLocationId;
    component: ElementType;
    props?: Record<string, any>;
}
<div className="members-wrapper">

locationId

<MemberInfo kind="property" type={<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id#customdetailcomponentlocationid'>CustomDetailComponentLocationId</a>} />

The id of the detail page location in which to place the component.

component

<MemberInfo kind="property" type={ElementType} />

The React component to render.

props

<MemberInfo kind="property" type={Record<string, any>} />

Optional props to pass to the React component.

</div>