vendure/docs/docs/reference/admin-ui-api/list-detail-views/base-list-component.md

---

title: "BaseListComponent" isDefaultIndex: false

generated: true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

BaseListComponent

This is a base class which implements the logic required to fetch and manipulate a list of data from a query which returns a PaginatedList type.

It is normally used in combination with the DataTable2Component.

class BaseListComponent<ResultType, ItemType, VariableType extends Record<string, any> = any> implements OnInit, OnDestroy {
    searchTermControl = new FormControl('');
    selectionManager = new SelectionManager<any>({
        multiSelect: true,
        itemsAreEqual: (a, b) => a.id === b.id,
        additiveMode: true,
    });
    result$: Observable<ResultType>;
    items$: Observable<ItemType[]>;
    totalItems$: Observable<number>;
    itemsPerPage$: Observable<number>;
    currentPage$: Observable<number>;
    protected destroy$ = new Subject<void>();
    protected refresh$ = new BehaviorSubject<undefined>(undefined);
    protected visibleCustomFieldColumnChange$ = new Subject<
        Array<DataTableCustomFieldColumnComponent<any>>
    >();
    constructor(router: Router, route: ActivatedRoute)
    setQueryFn(listQueryFn: ListQueryFn<ResultType>, mappingFn: MappingFn<ItemType, ResultType>, onPageChangeFn?: OnPageChangeFn<VariableType>, defaults?: { take: number; skip: number }) => ;
    refreshListOnChanges(streams: Array<Observable<any>>) => ;
    setPageNumber(page: number) => ;
    setItemsPerPage(perPage: number) => ;
    setVisibleColumns(columns: Array<DataTable2ColumnComponent<any>>) => ;
    refresh() => ;
    setQueryParam(hash: { [key: string]: any }, options?: { replaceUrl?: boolean; queryParamsHandling?: QueryParamsHandling }) => ;
    setQueryParam(key: string, value: any, options?: { replaceUrl?: boolean; queryParamsHandling?: QueryParamsHandling }) => ;
    setQueryParam(keyOrHash: string | { [key: string]: any }, valueOrOptions?: any, maybeOptions?: { replaceUrl?: boolean; queryParamsHandling?: QueryParamsHandling }) => ;
}

• Implements: OnInit, OnDestroy

### searchTermControl ### selectionManager ### result$ ### items$ ### totalItems$ ### itemsPerPage$ ### currentPage$ ### destroy$ ### refresh$ ### visibleCustomFieldColumnChange$ ### constructor BaseListComponent`} /> ### setQueryFn `} /> Sets the fetch function for the list being implemented. ### refreshListOnChanges `} /> Accepts a list of Observables which will trigger a refresh of the list when any of them emit. ### setPageNumber `} /> Sets the current page number in the url. ### setItemsPerPage `} /> Sets the number of items per page in the url. ### setVisibleColumns `} /> ### refresh `} /> Re-fetch the current page of results. ### setQueryParam `} /> ### setQueryParam `} /> ### setQueryParam `} />