ContextQMD
Back to Vendure

DataTableComponentConfig

docs/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx

3.6.31.3 KB
Original Source
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table-custom-component.service.ts" sourceLine="54" packageName="@vendure/admin-ui" />

Configures a CustomDetailComponent to be placed in the given location.

ts
interface DataTableComponentConfig {
    tableId: DataTableLocationId;
    columnId: DataTableColumnId;
    component: Type<CustomColumnComponent>;
    providers?: Provider[];
}
<div className="members-wrapper">

tableId

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

The location in the UI where the custom component should be placed.

columnId

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

The column in the table where the custom component should be placed.

component

<MemberInfo kind="property" type={Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>} />

The component to render in the table cell. This component should implement the CustomColumnComponent interface.

providers

<MemberInfo kind="property" type={Provider[]} />

</div>