https://github.com/bcherny/angular-search
A lightweight Angular search widget
https://github.com/bcherny/angular-search
Last synced: 8 months ago
JSON representation
A lightweight Angular search widget
- Host: GitHub
- URL: https://github.com/bcherny/angular-search
- Owner: bcherny
- License: apache-2.0
- Created: 2014-12-02T19:58:40.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-03-16T16:59:54.000Z (over 8 years ago)
- Last Synced: 2024-12-17T03:03:17.108Z (10 months ago)
- Language: CoffeeScript
- Size: 97.7 KB
- Stars: 1
- Watchers: 19
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# angular-search [![Build Status][build]](https://travis-ci.org/bcherny/angular-search) [![Coverage Status][coverage]](https://coveralls.io/r/bcherny/angular-search)
[build]: https://img.shields.io/travis/bcherny/angular-search.svg?branch=master&style=flat-square
[coverage]: http://img.shields.io/coveralls/bcherny/angular-search.svg?branch=master&style=flat-square
A lightweight Angular search widget
## dependencies
- angular 1.x
## features
- lightweight
- configurable behavior
- supports both basic and pro user interactions
- Click the loupe icon, press the word "Enter", or press the [ENTER] key to search
- Press the "x" icon, or press the [ESC] key to clear a search
- supports any number of search instances on one page
- 100% test coverage
## installation
```bash
# using bower:
bower install --save angular-search
# .. or, using NPM:
npm install --save angular-search
```
## usage
```html
```
```js
angular
.module('demo', ['turn/search'])
.controller('mainCtrl', function ($scope) {
angular.extend($scope, {
searchText: '',
clear: function() {
$scope.searchText = '';
$scope.search();
},
search: function (param) {
...
}
});
});
```
## options
```html
class="size-medium"
disabled="foo"
param="searchText"
placeholder="Search"
search="fn($param)"
typeAhead="true"
>
```
## hacking on it
```bash
bower install
npm install
grunt watch
```
## running the demo
```bash
bower install
npm install
node server/index
```
then open demo/index.html in a browser
## running the tests
```bash
bower install
npm install
grunt test
```