1.0.5 • Published 2 years ago

ngx-list-search v1.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

NgxListSearch

Coverage Status

About

Angular list search drop in component to provide searching on MatList, MatActionList and MatSelectionList MatList

Usage

Install ngx-list-search in your project:

npm install ngx-list-search

Import NgxListSearchModule e.g. in your app.module.ts:

import { MatListModule } from '@angular/material/list';
import { NgxListSearchModule } from 'ngx-list-search';

@NgModule({
  imports: [
    ...
    MatListModule,
    NgxListSearchModule
  ],
})
export class AppModule {}

Use the ngx-list-search component inside a mat-list element:

<mat-list>
    <ngx-list-search></ngx-list-search>
    <mat-list-item *ngFor="let item of items">
        {{ item }}
    </mat-list-item>
</mat-list>

Demo

To see a working demo, please visit https://ngx-list-search.com/

Limitations

All searchable items must be in the DOM and not rendered with virtual scrolling.