Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guylabs/ion-autocomplete

A configurable Ionic directive for an autocomplete dropdown
https://github.com/guylabs/ion-autocomplete

autocomplete dropdown ionic search

Last synced: 27 days ago
JSON representation

A configurable Ionic directive for an autocomplete dropdown

Awesome Lists containing this project

README

        

ion-autocomplete
================
[![Build Status](https://travis-ci.org/guylabs/ion-autocomplete.svg?branch=master)](https://travis-ci.org/guylabs/ion-autocomplete)
[![Coverage Status](https://img.shields.io/coveralls/guylabs/ion-autocomplete.svg)](https://coveralls.io/r/guylabs/ion-autocomplete)
[![Bower version](https://badge.fury.io/bo/ion-autocomplete.svg)](http://badge.fury.io/bo/ion-autocomplete)
[![npm version](https://badge.fury.io/js/ion-autocomplete.svg)](http://badge.fury.io/js/ion-autocomplete)

> Configurable Ionic directive for an autocomplete dropdown.

:warning: Please follow the [Guidelines to report an issue](#guidelines-to-report-an-issue)

#Table of contents

- [Demo](#demo)
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Ionic compatibility](#ionic-compatibility)
- [Usage](#usage)
- [Configurable options](#configurable-options)
- [The `items-method`](#the-items-method)
- [The `items-method-value-key`](#the-items-method-value-key)
- [The `item-value-key`](#the-item-value-key)
- [The `item-view-value-key`](#the-item-view-value-key)
- [The `max-selected-items`](#the-max-selected-items)
- [The `items-clicked-method`](#the-items-clicked-method)
- [The `items-removed-method`](#the-items-removed-method)
- [External model](#external-model)
- [The `model-to-item-method`](#the-model-to-item-method)
- [The `cancel-button-clicked-method` (same as done button)](#the-cancel-button-clicked-method-same-as-done-button)
- [ComponentId](#component-id)
- [Placeholder](#placeholder)
- [Cancel button label](#cancel-button-label)
- [Select items label](#select-items-label)
- [Selected items label](#selected-items-label)
- [Template url](#template-url)
- [Template data](#template-data)
- [Loading icon](#loading-icon)
- [Manage externally](#manage-externally)
- [Selected items](#selected-items)
- [Clear on select](#clear-on-select)
- [Open and close CSS class ](#open-and-close-css-class)
- [Using expressions in value keys](#using-expressions-in-value-keys)
- [Debouncing](#debouncing)
- [Usage inside an Ionic modal](#usage-inside-an-ionic-modal)
- [Guidelines to report an issue](#guidelines-to-report-an-issue)
- [Release notes](#release-notes)
- [Acknowledgements](#acknowledgements)
- [License](#license)

# Demo

You can find a live demo on [Codepen](http://codepen.io/guylabs/pen/GJmwMw) or see it in action in the following image:

![Animated demo](https://github.com/guylabs/ion-autocomplete/raw/master/demo.gif)

# Introduction

For one of my private projects I needed an autocomplete component in Ionic. I searched a lot and found some plain Angular autocompletes, but these had too much other dependencies and mostly didn't look that good within Ionic. Then one day I stumbled upon the [ion-google-place](https://github.com/israelidanny/ion-google-place) project which was exactly what I was looking for, except that it was just working with the Google Places API. So I forked the project and made it configurable such that you can add the service you need. The differences between the ion-google-place project and the ion-autocomplete are listed in the features.

# Features

The ion-autocomplete component has the following features:
- Multiple selection support
- Configurable service which provides the items to list
- Allow to define the maximum number of selected items
- Configure what is stored in the model and what is seen in the list
- Configure the template used to show the autocomplete component
- Configure a callback when an item is clicked/removed
- Configure a callback when the cancel/done button is clicked
- Configure all labels used in the component

# Installation

1. Use bower to install the new module:
```bash
bower install ion-autocomplete --save
```
2. Import the `ion-autocomplete` javascript and css file into your HTML file:
```html

```
3. Add `ion-autocomplete` as a dependency on your Ionic app:
```javascript
angular.module('myApp', [
'ionic',
'ion-autocomplete'
]);
```

# Ionic compatibility

The ion-autocomplete component is running with the following Ionic versions:

ion-autocomplete version | Ionic version
------------------------ | -------------
0.0.2 - 0.1.2 | 1.0.0-beta.14
0.2.0 - 0.2.1 | 1.0.0-rc.3
0.2.2 - 0.2.3 | 1.0.0
0.3.0 - 0.3.1 | 1.1.0
0.3.2 - 0.3.3 | 1.1.1
0.4.0 - latest | 1.3.2

# Usage

To use the `ion-autocomplete` directive in single select mode you need set the `max-selected-items` attribute and add the following snippet to your template:
```html
//usage with the attribute restriction

```

If you want to use it in multiple select mode you do not need to add anything special, just the following snippet to your template:
```html
//usage with the attribute restriction

```

Check out the next chapter on how to configure the directive.

## Configurable options

### The `items-method`

You are able to pass in a callback method which gets called when the user changes the value of the search input field. This is
normally a call to the back end which retrieves the items for the specified query. Here is a small sample which will
return a static item of the query:

Define the callback in your scope:
```javascript
$scope.callbackMethod = function (query, isInitializing) {
return [query];
}
```

And set the items method on the directive:
```html

```

You are also able to return a promise from this callback method. For example:
```javascript
$scope.callbackMethod = function (query, isInitializing) {
return $http.get(endpoint);
}
```

Note that the parameter for the `callbackMethod` needs to be named `query`. Otherwise the callback will not get called properly.
If you want to also retrieve the [ComponentId](#component-id) then you need to add a second parameter called `componentId`:
```javascript
$scope.callbackMethod = function (query, isInitializing, componentId) {
if(componentId == "component1") {
return $http.get(endpoint1);
}
return [query];
}
```

If you want to pre populate the items which are shown when the modal is visible before the user enters a query then you can check the `isInitializing` flag of
the `items-method` as this is set to true if it is called for the initial items. Here is an example which shows the `test` item as an initial item:
```javascript
$scope.callbackMethod = function (query, isInitializing) {
if(isInitializing) {
// depends on the configuration of the `items-method-value-key` (items) and the `item-value-key` (name) and `item-view-value-key` (name)
return { items: [ { name: "test" } ] }
} else {
return $http.get(endpoint);
}
}
```

If you want to clear the list each time the user opens the modal then just return an empty array like in the following example:
```javascript
$scope.callbackMethod = function (query, isInitializing) {
if(isInitializing) {
// depends on the configuration of the `items-method-value-key` (items) and the `item-value-key` (name) and `item-view-value-key` (name)
return { items: [] }
} else {
return $http.get(endpoint);
}
}
```

And if you do not want that the searched items list gets modified then just return nothing as in this example:
```javascript
$scope.callbackMethod = function (query, isInitializing) {
if(!isInitializing) {
return $http.get(endpoint);
}
}
```

A common usage for the `items-method` is to use the [Google Map Geocode API](https://developers.google.com/maps/documentation/geocoding/intro?hl=de#Geocoding) for address suggestions.

To use Googles API you need to link the required library in your `index.html` file:
```html

```

In the `ion-autocomplete` input field you set the `items-method` to the below shown method `getAddressSuggestions` and set the value key to `formatted_address` to display the formatted address:
```html

```

To query Googles API you have to create a `Geocoder` instance and use the `queryString` as input and return the result object in a promise.
```javascript
var geocoder = new google.maps.Geocoder();

$scope.getAddressSuggestions(queryString){
var defer = $q.defer();
geocoder.geocode(
{address: queryString},
function (results, status) {
if (status == google.maps.GeocoderStatus.OK) { defer.resolve(results); }
else { defer.reject(results); }
}
);
return defer.promise;
}
```

### The `items-method-value-key`

You are able to set the `items-method-value-key` attribute which maps to a value of the returned data of the `items-method`. If for
example your callback method returns the following object:
```json
{
"items" : [ {
"name" : "item1"
},{
"name" : "item2"
},
...
]
}
```
Then when you do not specify the `items-method-value-key` there will be no list displayed when you search for items in
the search input field. You need to set the `items-method-value-key` to `items` such that the items are shown. If you right
away return an array of items then you do not need to set the `items-method-value-key`.

### The `item-value-key`

You are able to set the `item-value-key` attribute which maps to a value of the returned object from the `items-method`. The value
is then saved in the defined `ng-model`. Here an example:

The items method returns the following object:
```javascript
[
{
"id": "1",
"name": "Item 1",
...
}
...
]
```

And now you set the following `item-value-key`:
```html

```

Now when the user selects the `Item 1` from the list, then the value of the objects `id` is stored in the `ng-model`. If
no `item-value-key` is passed into the directive, the whole item object will be stored in the `ng-model`.

### The `item-view-value-key`

You are able to set the `item-view-value-key` attribute which maps to a value of the returned object from the `items-method`. The
value is then showed in both input fields. Here an example:

The `items-method` returns the following object:
```javascript
[
{
"id": "1",
"name": "Item 1",
...
}
...
]
```

And now you set the following `item-view-value-key`:
```html

```

Now when the user selects the `Item 1` from the list, then the value of the objects `name` is showed in both input fields. If
no `item-view-value-key` is passed into the directive, the whole item object will be showed in both input fields.

### The `max-selected-items`

You are able to set the `max-selected-items` attribute to any number to set the maximum selectable items inside the component. Here an example:
```html

```

Then the user is just able to select three items out of the returned items and also delete them again. The given `ng-model` is an
array if multiple items are selected.

You can also set a scope variable instead of a fixed value such that you can dynamically change the `max-selected-items` property according to your
requirements.

### The `items-clicked-method`

You are able to pass a function to the `items-clicked-method` attribute to be notified when an item is clicked. The name of the
parameter of the function must be `callback`. Here is an example:

Define the callback in your scope:
```javascript
$scope.clickedMethod = function (callback) {
// print out the selected item
console.log(callback.item);

// print out the component id
console.log(callback.componentId);

// print out the selected items if the multiple select flag is set to true and multiple elements are selected
console.log(callback.selectedItems);

// print out the selected items as an array
console.log(callback.selectedItemsArray);
}
```

And pass in the callback method in the directive:
```html

```

Then you get a callback object with the clicked/selected item and the selected items if you have multiple selected items (see [The `multiple-select`](#the-multiple-select)).

### The `items-removed-method`

You are able to pass a function to the `items-removed-method` attribute to be notified when an item is removed from a multi-select list. The name of the
parameter of the function must be `callback`. It is similar to items-clicked-method. This attribute has no defined behaviour for a single select list.

Here is an example:

Define the callback in your scope:
```javascript
$scope.removedMethod = function (callback) {
// print out the removed item
console.log(callback.item);

// print out the component id
console.log(callback.componentId);

// print out the selected items
console.log(callback.selectedItems);

// print out the selected items as an array
console.log(callback.selectedItemsArray);
}
```

And pass in the callback method in the directive:
```html

```

Then you get a callback object with the removed item and the selected items.

### External model

The two way binded external model (`external-model` attribute on the component) is used to prepopulate the selected items with the model value. The [`model-to-item-method`](#the-model-to-item-method) is used to get the view item to the model and then the item is selected in the
component. Be aware that the `external-model` is not updated by the component when an item is selected. It is just used to prepopulate or clear the selected items. If you need to get the current selected items you are able
to read the value of the `ng-model`. For an example have a look at the [`model-to-item-method`](#the-model-to-item-method) documentation.

If you need to clear the selected items then you are able to set the `external-model` to an empty array (another value is not clearing the selected items).

### The `model-to-item-method`

This method is used if you want to prepopulate the model of the `ion-autocomplete` component. The [external model](#external-model) needs
to have the same data as it would have when you select the items by hand. The component then takes the model values
and calls the specified `model-to-item-method` to resolve the item from the back end and select it such that it is preselected.

Here a small example:

Define the `model-to-item-method` and `external-model` in your scope:
```javascript
$scope.modelToItemMethod = function (modelValue) {

// get the full model item from the model value and return it. You need to implement the `getModelItem` method by yourself
// as this is just a sample. The method needs to retrieve the whole item (like the `items-method`) from just the model value.
var modelItem = getModelItem(modelValue);
return modelItem;
}
$scope.externalModel = ['test1', 'test2', 'test3'];
```

And set the `model-to-item-method` on the directive:
```html

```

You are also able to return a promise from this callback method. For example:
```javascript
$scope.modelToItemMethod = function (modelValue) {
return $http.get(endpoint + '?q=' + modelValue);
}
```

Note that the parameter for the `model-to-item-method` needs to be named `modelValue`. Otherwise the callback will not get called properly.

### The `cancel-button-clicked-method` (same as done button)

You are able to pass a function to the `cancel-button-clicked-method` attribute to be notified when the cancel/done button is clicked to close the modal. The name of the
parameter of the function must be `callback`. Here is an example:

Define the callback in your scope:
```javascript
$scope.cancelButtonClickedMethod = function (callback) {
// print out the component id
console.log(callback.componentId);

// print out the selected items
console.log(callback.selectedItems);

// print out the selected items as an array
console.log(callback.selectedItemsArray);
}
```

And pass in the callback method in the directive:
```html

```

Then you get a callback object with the selected items and the component id.

### Component Id

The component id is an attribute on the `ion-autocomplete` component which sets a given id to the component. This id is then returned in
the callback object of the [`items-clicked-method`](#the-items-clicked-method) and as a second parameter of the [`items-method`](#the-items-method).
Here an example:
```html
`
```

You are able to set this is on each component if you have multiple components built up in a ng-repeat where you do not want to have multiple `items-method`
for each component because you want to display other items in each component. You will also get it in the `items-clicked-method` callback object such that you just
need to define one callback method and you can distinguish the calls with the `componentId` attribute right inside the method.

### Placeholder

You are also able to set the placeholder on the input field and on the search input field if you add the `placeholder`
attribute to the directive:
```html
`
```

### Cancel button label

You are also able to set the cancel button label (defaults to `Cancel`) if you add the `cancel-label` attribute to the directive:
```html
`
```

### Select items label

You are also able to set the select items label (defaults to `Select an item...`) if you add the `select-items-label` attribute to the directive:
```html
`
```

### Selected items label

You are also able to set the selected items label (defaults to `Selected items:`) if you add the `selected-items-label` attribute to the directive:
```html
`
```

### Template url

You are also able to set an own template for the autocomplete component (defaults to `''`) if you add the `template-url` attribute to the directive:
```html
`
```

This way you are able to override the default template (the `template` variable [here](https://github.com/guylabs/ion-autocomplete/blob/master/src/ion-autocomplete.js#L68))
and use your own template. The component will use the default template if the `template-url` is not defined.

You are able to use all the configurable attributes as expressions in your template. I would advise to use the default template as base template
and then add your custom additions to it.

> Please also take care when you change how the items are shown or what method is called if an item is clicked,
> because changing this could make the component unusable.

You will need to set the proper `randomCssClass` for the outer most div container in your template and you can get the value by using the `{{viewModel.randomCssClass}}` expression
like in the following example:

```html