sp-combo/README.md

# Angular sp-combo - Multiselect, Multiline and Autocomplete

# SpCombo

# Angular sp-combo -  Multiselect, Multiline and Autocomplete


## Features
- [x] Multiline
- [x] Show Multi Fields
- [x] Custom binding to property or object
- [x] Custom option, label, header and footer templates
- [x] Virtual Scroll support with large data sets (>5000 items).
- [x] Infinite scroll
- [x] Keyboard navigation
- [x] Multiselect
- [x] Flexible autocomplete with client/server filtering
- [x] Custom search
- [x] Custom tags
- [x] Append to
- [x] Group items
- [x] Output events
- [x] Accessibility
- [x] Good base functionality test coverage
- [x] Themes 

## Warning
Library is under active development.

## Getting started
### Step 1: Install `sp-combo`:

#### NPM
```shell
npm install --save sp-combo
```

### Step 2: Import the SpComboModule and angular FormsModule module:
```js
import { SpComboModule } from 'sp-combo';
import { FormsModule } from '@angular/forms';

@NgModule({
  declarations: [AppComponent],
  imports: [SpComboModule, FormsModule],
  bootstrap: [AppComponent]
})
export class AppModule {}
```

### Step 3: Include a theme: 

```scss
@import "~sp-combo/themes/default.theme.css";
// ... or 
@import "~sp-combo/themes/material.theme.css";

```