Data Transformer Collate Filter Text

Edit on GitHub

This document explains the Data Transformer Collate Filter Text service in the Components Library.

Overview

Data Transformer Collate Filter Text is an Angular Service that implements filtering to the text value of data based on configuration.

Check out an example usage of the Data Transformer Collate Filter Text in the @spryker/table config:

<spy-table
    [config]="{
        datasource: {
            ...,                                               
            transform: {
                ...,
                search: {
                    type: 'text',
                    propNames: ['col1', 'col2'],
                },
            },
        },
    }"
>
</spy-table>

Service registration

Register the service:

@NgModule({
    imports: [
        DataTransformerModule.withTransformers({
            collate: CollateDataTransformerService,
        }),
        CollateDataTransformer.withFilters({
            text: TextDataTransformerFilterService,
        }),
    ],
})
export class RootModule {}

Interfaces

Below you can find interfaces for the Data Transformer Collate Filter Text:

declare module '@spryker/data-transformer.collate' {
    interface DataTransformerFilterRegistry {
        text: TextDataTransformerFilterService;
    }
}

interface DataTransformerFilterConfig {
    type: string;
    propNames: string | string[];
}