Code Monkey home page Code Monkey logo

angular-sorting-component's Introduction

Angular: Reusable orderBy component using Observables

A fairly simple sorting component for sorting data lists.

How-to use

1. Installation

npm install angular-sorting-component

Import the module where needed. If you use SystemJS you first have to import node_modules/angular-sorting-component/dist/angular-sorting-component.umd.js.

import { Ng2SortModule } from 'angular-sorting-component';

@NgModule({
  imports: [
    Ng2SortModule
  ]
})

2. Usage

The component needs the dataToSort and sortingValues directives to function.

Base component

<ng2-sort-component [dataToSort]="data" [sortingValues]="sortingValues"></ng2-sort-component>

dataToSort: Object[]

This is the instance that will be sorted.

sortingValues: SortingValue

Expects an array of values that will be sorted, the label that will be presented and their type.

export interface SortingValue {
    value: string;
    type: string;
    label: string;
}

Optional directives

customClasses: string

Add the classes that you want on the input field.

defaultSortingValue: string

If no default sorting value is chosen, the component will default to the first item in the sortingValue array.

2. Options

Example

Install the Angular CLI and run ng serve in the example folder to check it out.

cd example
npm install
ng serve // npm install angular-cli -g if it's not yet installed

angular-sorting-component's People

Contributors

serdiuk avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.