-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #22
- Loading branch information
Showing
1 changed file
with
60 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,63 @@ | ||
| # ng2-select2 [](https://badge.fury.io/js/ng2-select2) [](https://opensource.org/licenses/mit-license.php) | ||
| # Angular wrapper for Select2 (ng2-select2) | ||
|
|
||
| Select 2 wrapper for angular (version 2.x.x and up) | ||
| [](https://badge.fury.io/js/ng2-select2) [](https://opensource.org/licenses/mit-license.php) | ||
|
|
||
| [Plunker](https://embed.plnkr.co/P2qvUyGA8fTlFXXKHSuB/) with implementation of npm package. | ||
| For Angular version 2.x.x and up | ||
|
|
||
| [Demo](https://nejczdovc.github.io/ng2-select2/) of the wrapper. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| For this plugin to work you need to add two javascript libraries to your project | ||
| - [Jquery](https://jquery.com/download/) | ||
| - [Select2](https://select2.github.io/) | ||
|
|
||
| First option and **preferred one** is to add libraries to your package builder. | ||
| - You can find example of how to add libraries to the Angular CLI in [demo branch](https://github.com/NejcZdovc/ng2-select2/blob/demo/angular-cli.json#L24-L25). | ||
| - You can also add it to [webpack directly](https://stackoverflow.com/questions/28969861/managing-jquery-plugin-dependency-in-webpack#answer-2898947). | ||
|
|
||
| Second option is to include libraries into your html head: | ||
|
|
||
| ``` | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Ng2Select2Demo</title> | ||
| <base href="/"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <link rel="icon" type="image/x-icon" href="favicon.ico"> | ||
| <script src="./assets/jquery.min.js"></script> | ||
| <script src="./assets/select2.min.js"></script> | ||
| </head> | ||
| ``` | ||
|
|
||
| ## Installation | ||
|
|
||
| Add package to your project `npm i -S ng2-select2` (this will save package to your `dependencies` in `package.json`) | ||
|
|
||
|
|
||
| ## Basic implementation | ||
|
|
||
| 1) Add declaration to [NgModule](https://github.com/NejcZdovc/ng2-select2/blob/demo/src/app/app.module.ts#L15) | ||
| ``` | ||
| @NgModule({ | ||
| declarations: [ | ||
| ...., | ||
| Select2Component | ||
| ], | ||
| ... | ||
| }) | ||
| ``` | ||
|
|
||
| 2) Add it to your [template](https://github.com/NejcZdovc/ng2-select2/blob/demo/src/app/app.component.html#L6). You need to define `startValue` and `startData` in your `.ts` file. | ||
|
|
||
| Example for [startData](https://github.com/NejcZdovc/ng2-select2/blob/demo/src/app/app.component.ts#L16) via [service](https://github.com/NejcZdovc/ng2-select2/blob/demo/src/services/data.service.ts#L50). | ||
| Example for [startValue] (https://github.com/NejcZdovc/ng2-select2/blob/demo/src/app/app.component.ts#L11). | ||
|
|
||
| ``` | ||
| <select2 [value]="startValue" [data]="startData"></select2> | ||
| ``` | ||
|
|
||
|
|
||
| ## Demo | ||
|
|
||
| You can view a live demo [here](https://nejczdovc.github.io/ng2-select2/) or check out [demo branch](https://github.com/NejcZdovc/ng2-select2/tree/demo) where you can find source of this demo created with Angular CLI. |