https://github.com/modulr/mdr-angular-select2
Select2 for Angular
https://github.com/modulr/mdr-angular-select2
Last synced: 8 months ago
JSON representation
Select2 for Angular
- Host: GitHub
- URL: https://github.com/modulr/mdr-angular-select2
- Owner: modulr
- License: mit
- Created: 2015-12-10T01:54:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-10-01T14:58:42.000Z (over 7 years ago)
- Last Synced: 2025-08-11T03:40:03.172Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 8
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular Select2
Angular Select2 is an Angularjs component that can replacement for select boxes.
## Features
- Uses the native Angularjs scope for data binding
- Fast and lightweight
- Remote and local data support
- Big data support
## Requirements
- [Angularjs](https://angularjs.org/)
- [Bootstrap 3.](http://getbootstrap.com/)
- [Selec2.](https://select2.github.io/)
## Quick start
Several quick start options are available:
- [Download the latest release](https://github.com/Modulr/mdr-angular-select2/archive/master.zip)
- Clone the repo: `git clone https://github.com/Modulr/mdr-angular-select2.git`.
- Install with [Bower](http://bower.io/): `bower install mdr-angular-select2`.
- Install with [npm](https://www.npmjs.com): `npm install mdr-angular-select2`.
## What's included
```
mdr-angular-select2/
dist/
├── mdr-select2.js
└── mdr-select2.min.js
```
## Documentation
### Usage
##### Load JS
```html
```
##### Code
```js
angular.module('MyApp', ['mdr.select2'])
```
##### HTML View or Templates
> Basic Directive
```html
```
> Complete Directive (All attributes)
```html
```
### API
##### Attributes
Attribute | Type | Description
--- | --- | ---
url | `string` | *Is the path where you get list of items.*
src | `array` | *Collection of objects.*
options | `string` | *Dynamically generate a list of elements.*
model | `object` | *Get model selected (Output).*
selected | `object` | *Set select value by track (Input).*
allow-clear | `boolean` | *If required clear selection the component is marked as true.*
placeholder | `string` | *Text into placeholder.*
disabled | `boolean` | *If required disable the component is marked as true.*
required | `boolean` | *If is required the component is marked as true.*
## How to contribute
All contributions are very welcome, We love it. There are several ways to help out:
- Create an [issue](https://github.com/Modulr/mdr-angular-select2/issues) on GitHub, if you have found a bug
- Write test cases for open bug issues
- Write patches for open bug/feature issues, preferably with test cases included
- Contribute to the documentation
There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
If you want to making changes Better avoid working directly on the `master` branch, to avoid conflicts if you pull in updates from origin, so, if make your contribution under the branch [`dev`](https://github.com/Modulr/mdr-angular-select2/tree/dev), into folder `src/`.
## Community
- Implementation help may be found at Stack Overflow (tagged [`mdr-select2`](http://stackoverflow.com/questions/tagged/mdr-select2)).
## Creators
[@AlfredoBarronC](https://twitter.com/AlfredoBarronC)
## Copyright and license
Code and documentation (c) Copyright 2015 Modulr. Code published under [license MIT](https://github.com/Modulr/mdr-angular-select2/blob/master/LICENSE)