ng-filter-pipe
v1.0.4
Published
`ng-filter-pipe` is a powerful, simple, and customizable pipe for filtering arrays in Angular applications. It allows you to exclude specific keys during the filter process.
Downloads
6
Readme
ng-filter-pipe
ng-filter-pipe
is a powerful, simple, and customizable pipe for filtering arrays in Angular applications. It allows you to exclude specific keys during the filter process.
Demo
You can try out the demo of this package using StackBlitz:
Or visit the live web version:
Installation
To install the ng-filter-pipe
library, use the following command:
npm install ng-filter-pipe
Importing the Pipe
After installing, import NgFilterPipeModule
into your desired module:
import { NgFilterPipeModule } from 'ng-filter-pipe';
@NgModule({
...
imports: [
NgFilterPipeModule,
...
],
...
})
export class YourModule { }
Usage
Use the filter
pipe in your templates as follows:
<div *ngFor="let item of items | filter : searchTerm : ['excludedProp1', 'excludedProp2']">
<!-- item will only be included if it contains the search term, ignoring excluded properties -->
</div>
Parameters
The filter
pipe accepts three parameters:
items
: The array of items to be filtered.term
: The search term by which to filter the items.excludes
: (Optional) An array of strings, each a key that should be excluded from the filtering process.
Support
For issues, feature requests, or contributions, please open a GitHub issue or submit a pull request. We appreciate your feedback and support.
License
This project is licensed under the terms of the MIT license. See the LICENSE file for details.