Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #95

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −10
Open

Update README.md #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Angular Advanced Searchbox
[![Build Status](https://travis-ci.org/dnauck/angular-advanced-searchbox.png?branch=master)](https://travis-ci.org/dnauck/angular-advanced-searchbox)

A directive for AngularJS providing a advanced visual search box.
A directive for AngularJS providing an advanced visual search box.

### [DEMO](http://dnauck.github.io/angular-advanced-searchbox/)

### Usage

Include with bower
Include with Bower

```sh
bower install angular-advanced-searchbox
Expand All @@ -22,7 +22,7 @@ The bower package contains files in the ```dist/```directory with the following

Files with the ```min``` suffix are minified versions to be used in production. The files with ```-tpls``` in their name have the directive template bundled. If you don't need the default template use the ```angular-paginate-anything.min.js``` file and provide your own template with the ```templateUrl``` attribute.

Load the javascript and css and declare your Angular dependency
Load the JavaScript and CSS, and declare your Angular dependency

```html
<!-- dependency includes -->
Expand Down Expand Up @@ -112,7 +112,7 @@ param can be a scope variable as well as a hard-coded string.
</tr>
<tr>
<td>searchThrottleTime</td>
<td>Specifies the time in milliseconds to wait for changes in the ui until the ng-model is updated. Default is 1000ms.</td>
<td>Specifies the time in milliseconds to wait for changes in the UI until the ng-model is updated. Default is 1000ms.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -161,27 +161,27 @@ $scope.$on('advanced-searchbox:modelUpdated', function (event, model) {
<tbody>
<tr>
<td>key</td>
<td>Unique key of the search parameter that is used for the ng-model value.</td>
<td>A unique key of the search parameter that is used for the ng-model value.</td>
<td>string</td>
</tr>
<tr>
<td>name</td>
<td>User friendly display name of the search parameter.</td>
<td>A user friendly display name of the search parameter.</td>
<td>string</td>
</tr>
<tr>
<td>placeholder</td>
<td>Specifies a short hint in the parameter search box</td>
<td>Specifies a short hint in the parameter search box.</td>
<td>string</td>
</tr>
<tr>
<td>allowMultiple</td>
<td>Should multiple search parameters of the same key allowed? Output type changes to array of values. Default is false.</td>
<td>Should multiple search parameters of the same key allowed? Output type changes to an array of values. Default is false.</td>
<td>boolean</td>
</tr>
<tr>
<td>suggestedValues</td>
<td>An array of suggested search values, e.g. ['Berlin', 'London', 'Paris']</td>
<td>An array of suggested search values, e.g. ['Berlin', 'London', 'Paris'].</td>
<td>string[]</td>
</tr>
<tr>
Expand All @@ -200,4 +200,4 @@ $scope.availableSearchParams = [
{ key: "city", name: "City", placeholder: "City...", restrictToSuggestedValues: true, suggestedValues: ['Berlin', 'London', 'Paris'] }
{ key: "email", name: "E-Mail", placeholder: "E-Mail...", allowMultiple: true },
];
```
```