Skip to content

Latest commit

 

History

History
104 lines (90 loc) · 3.91 KB

File metadata and controls

104 lines (90 loc) · 3.91 KB
title description template last_updated redirect_from related
Table Column Type List
This document provides details about the Table Column Type List in the Components Library.
concept-topic-template
Jan 11, 2024
/docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-list.html
/docs/scos/dev/front-end-development/202204.0/marketplace/table-design/table-column-type-extension/table-column-type-list.html
/docs/scos/dev/front-end-development/202404.0/marketplace/table-design/table-column-type-extension/table-column-type-list.html
title link
Table Column Type extension
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html
title link
Table Column Type Autocomplete
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html
title link
Table Column Type Button Action
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html
title link
Table Column Type Chip
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html
title link
Table Column Type Date
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html
title link
Table Column Type Dynamic
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html
title link
Table Column Type Image
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html
title link
Table Column Type Input
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html
title link
Table Column Type Select
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html
title link
Table Column Type Text
docs/dg/dev/frontend-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html

This document explains the Table Column Type List in the Components library.

Overview

Table Column List is an Angular Component that provides a list of Table Column components with defined types via the table-column-renderer component and displays two columns by default, with the rest appearing in the @spryker/popover component.

Check out an example usage of the Table Column List in the @spryker/table config:

<spy-table
    [config]="{
        ...,
        columns: [
            ...,
            {
                id: 'sku',
                title: 'sku',
                type: 'list',
                typeOptions: {
                    limit: 2,
                    type: 'text',
                    typeOptions: {
                        text: '${displayValue}',
                    },
                },
            },
            ...,
        ],
    }"
>
</spy-table>

Component registration

Register the component:

declare module '@spryker/table' {
    interface TableColumnTypeRegistry {
        list: TableColumnListConfig;
    }
}

@NgModule({
    imports: [
        TableModule.forRoot(),
        TableModule.withColumnComponents({
            list: TableColumnListComponent,
        }),
        TableColumnListModule,
    ],
})
export class RootModule {}

Interfaces

Below you can find interfaces for the Table Column List:

interface TableColumnListConfigInner {
    type?: string;
    typeOptions?: Object;
    typeChildren?: TableColumnListConfigInner[];
}

interface TableColumnListConfig extends TableColumnListConfigInner {
    limit: number; // 2 - by default
}