mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

2020-08-10 18:06:51 +01:00

2.9 KiB

Raw Blame History

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
SearchHeader component	v3.9.0	Active	2020-19-06

SearchHeader component

Displays a button opening a menu designed to filter a document list.

Basic usage

app.component.html

<adf-document-list
    ...
    ...> 
    <adf-custom-header-filter-template>
        <ng-template let-col>
            <adf-search-header [col]="col"
                                [currentFolderNodeId]="currentFolderId"
                                [maxItems]="pagination?.maxItems"
                                [skipCount]="pagination?.skipCount"
                                (update)="onFilterUpdate($event)"
                                (clear)="onAllFilterCleared()">
            </adf-search-header>
        </ng-template>
    </adf-custom-header-filter-template>
</adf-document-list>

app.config.json

This component is designed to be used as transcluded inside the document list component. With the good configurations it will allow the user to filter the data displayed by that component.

Class members

Properties

Name	Type	Default value	Description
col	`DataColumn`		The column the filter will be applied on.
currentFolderNodeId	`string`		The id of the current folder of the document list.
maxItems	`number`		Maximum number of search results to show in a page.
skipCount	`number`		The offset of the start of the page within the results list.
sorting	`string`	null	The sorting to apply to the the filter.
value	`any`		(optional) Initial filter value to sort .

Events

Name	Type	Description
clear	`EventEmitter<any>`	Emitted when the last of all the filters is cleared.
selection	`EventEmitter<Map<string, string>>`	Emitted when a filter value is selected
update	`EventEmitter<NodePaging>`	Emitted when the result of the filter is received from the API.

2.9 KiB Raw Blame History