npmpackage.info

ngx-order-pipe

▼ Angular 5+ orderBy pipe

3.0.0

239

MIT

TypeScript

1.05 kB

7,150,034 2.7

Installations

npm install ngx-order-pipe

Developer Guide

BETA

Typescript

No

Module System

ESM

Node Version

20.4.0

NPM Version

9.7.2 Score

96.8

Supply Chain

100

Quality

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

94

Closed

24

Merged

66

Issues

Open

1

Total

84

Closed

83

Releases

3.0.0

Updated on May 18, 2024

2.2.0

Updated on Dec 11, 2021

2.1.2

Updated on Nov 21, 2021

2.1.1

Updated on Oct 10, 2020

2.1.0

Updated on Aug 12, 2020

2.0.4

Updated on Sep 09, 2019

View All 24 releases

Contributors

Unable to fetch Contributors

View All 10 Contributors

Languages

TypeScript

HTML

JavaScript

SCSS

TypeScript (77.78%)

HTML (14.78%)

JavaScript (4.83%)

SCSS (2.61%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

VadimDez

Download Statistics

Total Downloads

7,150,034

Last Day

3,526

Last Week

21,497

Last Month

89,930

Last Year

996,250

GitHub Statistics

MIT License

239 Stars

334 Commits

56 Forks

11 Watchers

7 Branches

10 Contributors

Updated on Feb 04, 2025

Bundle Size

2.66 kB

Minified

1.05 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

3.0.0

Package Id

ngx-order-pipe@3.0.0

Unpacked Size

51.64 kB

Size

12.46 kB

File Count

NPM Version

9.7.2

Node Version

20.4.0

Published on

May 18, 2024

Total Downloads

Cumulative downloads

Total Downloads

7,150,034

Last Day

-11.2%

3,526

Compared to previous day

Last Week

-2.5%

21,497

Compared to previous week

Last Month

32.6%

89,930

Compared to previous month

Last Year

-15.6%

996,250

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

tslib

Angular 5+ Order Pipe

Order your collection by a field

Demo page

https://vadimdez.github.io/ngx-order-pipe/

or see code example

https://stackblitz.com/edit/ngx-order-pipe

Install

npm install ngx-order-pipe --save

For Angular lower than 5 use version 1.1.3

Setup

In case you're using systemjs - see configuration here. Otherwise skip this part.

Usage

In HTML template

1{{ collection | orderBy: expression : reverse : caseInsensitive : comparator }}

Arguments

Param	Type	Default Value	Details
collection	`array` or `object`		The collection or object to sort
expression	`string` or `string array`		The key or collection of keys to determinate order
reverse (optional)	`boolean`	false	Reverse sorting order
caseInsensitive (optional)	`boolean`	false	Case insensitive compare for sorting
comparator (optional)	`Function`		Custom comparator function to determine order of value pairs. Example: `(a, b) => { return a > b ? 1 : -1; }` `See how to use comparator`

Import OrderModule to your module

1import { NgModule } from '@angular/core';
2import { BrowserModule  } from '@angular/platform-browser';
3import { AppComponent } from './app';
4
5import { OrderModule } from 'ngx-order-pipe';
6
7@NgModule({
8  imports: [BrowserModule, OrderModule],
9  declarations: [AppComponent],
10  bootstrap: [AppComponent]
11})
12export class AppModule {}
13

And use pipe in your component

1import { Component } from '@angular/core';
2
3@Component({
4  selector: 'example',
5  template: `
6    <ul>
7      <li *ngFor="let item of array | orderBy: order">
8        {{ item.name }}
9      </li>
10    </ul> 
11  `
12})
13
14export class AppComponent {
15  array: any[] = [{ name: 'John'} , { name: 'Mary' }, { name: 'Adam' }];
16  order: string = 'name';
17}

Deep sorting

Use dot separated path for deep properties when passing object.

1<div>{{ { prop: { list: [3, 2, 1] } } | orderBy: 'prop.list' | json }}</div>

Result:

1<div>{ prop: { list: [1, 2, 3] } }</div>

Use OrderPipe in the component

Import OrderPipe to your component:

1import { OrderPipe } from 'ngx-order-pipe';

Add OrderPipe to the constructor of your component and you're ready to use it:

1constructor(private orderPipe: OrderPipe) {
2  console.log(this.orderPipe.transform(this.array, this.order)); // both this.array and this.order are from above example AppComponent
3}

Case insensitive / Case sensitive

Case insensitive flag is the third parameter passed to the pipe. Can be true to make comparison case insensitive and false to make comparison case sensitive. By default value is set to false.

Make case insensitive order (Third parameter is true)

1<li *ngFor="let item of array | orderBy: order : false : true">
2  {{ item.name }}
3</li>

Switching third parameter to false will do case sensitive comparison to order collection:

1<li *ngFor="let item of array | orderBy: order : false : false">
2  {{ item.name }}
3</li>

Donation

If this project help you reduce time to develop, you can give me a cup of tea :)

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.7

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to ngx-order-pipe

ngx-order-by

1.0.4

Order by multpile fields and directions pipe for Angular >= 2

ng-custom-pipe

1.2.1

An Angular Library, that gives you a hussle free experience on data operation using pipes