ngx-dual-listbox / Angular dual list box

Demo

https://ouracademy.github.io/ngx-dual-listbox/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

A dual list box component for Angular 2+

Installation

Install through npm:

npm install --save ngx-dual-listbox

Then include in your apps module:

import { NgModule } from '@angular/core';
import { NgxDualListboxModule } from 'ngx-dual-listbox';

@NgModule({
  imports: [
    NgxDualListboxModule.forRoot()
  ]
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: `
    <ngx-dual-listbox [items]="items" [(selectedItems)]="selectedItems">
    </ngx-dual-listbox>
  `
})
export class MyComponent {
  items: any[] = [
    { id: 1, name: 'Movie 1', url: '' },
    { id: 2, name: 'Movie 2', url: '' },
    { id: 3, name: 'Movie 3', url: '' },
    { id: 4, name: 'Movie 4', url: '' },
    { id: 5, name: 'Movie 5', url: '' }
  ];

  selectedItems: any[] = [{ id: 1, name: 'Movie 1', url: '' }];
}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/ngx-dual-listbox/bundles/ngx-dual-listbox.umd.js"></script>
<script>
    // everything is exported ngxDualListbox namespace
</script>

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://ouracademy.github.io/ngx-dual-listbox/docs/

Development

Prepare your environment

• Install Node.js and NPM
• Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

• Bump the version in package.json (once the module hits 1.0 this will become automatic)

  npm run release

License

MIT