Querying Lists Easily with ListService

ListService is a utility service to provide an easy pagination, sorting, and search implementation.

Getting Started

ListService is not provided in root. The reason is, this way, it will clear any subscriptions on component destroy. You may use the optional LIST_QUERY_DEBOUNCE_TIME token to adjust the debounce behavior.

import { ListService } from '@abp/ng.core';
import { BookDto } from '../models';
import { BookService } from '../services';

  /* class metadata here */
  providers: [
    // [Required]

    // [Optional]
    // Provide this token if you want a different debounce time.
    // Default is 300. Cannot be 0. Any value below 100 is not recommended.
    { provide: LIST_QUERY_DEBOUNCE_TIME, useValue: 500 },
  template: `
class BookComponent {
  items: BookDto[] = [];
  count = 0;

    public readonly list: ListService,
    private bookService: BookService,
  ) {}

  ngOnInit() {
    // A function that gets query and returns an observable
    const bookStreamCreator = query => this.bookService.getList(query);

      response => {
        this.items = response.items;
        this.count = response.count;
        // If you use OnPush change detection strategy,
        // call detectChanges method of ChangeDetectorRef here.
    ); // Subscription is auto-cleared on destroy.

Noticed list is public and readonly? That is because we will use ListService properties directly in the component's template. That may be considered as an anti-pattern, but it is much quicker to implement. You can always use public component properties instead.

Place ListService properties into the template like this:

  [abpLoading]="list.isLoading$ | async"

<ng-template #tableHeader>
    <th (click)="nameSort.sort('name')">
      {{ '::Name' | abpLocalization }}

<ng-template #tableBody let-data>
    <td>{{ }}</td>

Usage with Observables

You may use observables in combination with AsyncPipe of Angular instead. Here are some possibilities:

  book$ = this.list.hookToQuery(query => this.bookService.getListByInput(query));
<!-- simplified representation of the template -->

  [value]="(book$ | async)?.items || []"
  [totalRecords]="(book$ | async)?.totalCount"



  books$: Observable<BookDto[]>;

  bookCount$: Observable<number>;

  ngOnInit() {
    this.list.hookToQuery((query) => GetBooks(query))).subscribe();
<!-- simplified representation of the template -->

  [value]="books$ | async"
  [totalRecords]="bookCount$ | async"

How to Refresh Table on Create/Update/Delete

ListService exposes a get method to trigger a request with the current query. So, basically, whenever a create, update, or delete action resolves, you can call this.list.get(); and it will call hooked stream creator again. DeleteBook(id)).subscribe(this.list.get);


  .subscribe(() => {

    // Other subscription logic here

How to Implement Server-Side Search in a Table

ListService exposes a filter property that will trigger a request with the current query and the given search string. All you need to do is to bind it to an input element with two-way binding.

<!-- simplified representation -->

<input type="text" name="search" [(ngModel)]="list.filter">
Was this page helpful?
Please make a selection.
Thank you for your valuable feedback!

Please note that although we cannot respond to feedback, our team will use your comments to improve the experience.

In this document
Mastering ABP Framework Book
Mastering ABP Framework

This book will help you gain a complete understanding of the framework and modern web application development techniques.