Skip to content

Commit

Permalink
(chore): update readme and release notes for the 0.3.3 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Guy Brand committed Oct 27, 2016
1 parent c94a2e1 commit f020c77
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 38 deletions.
109 changes: 74 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ 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)
Expand Down Expand Up @@ -35,9 +37,12 @@ ion-autocomplete
- [Template data](#template-data)
- [Loading icon](#loading-icon)
- [Manage externally](#manage-externally)
- [Selected items](#selected-items)
- [Clear on select](#clear-on-select)
- [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)
Expand Down Expand Up @@ -103,7 +108,7 @@ To use the `ion-autocomplete` directive in single select mode you need set the `
<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" max-selected-items="1" />
```

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:
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
<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" />
Expand Down Expand Up @@ -291,25 +296,31 @@ You are able to set the `max-selected-items` attribute to any number to set the
<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" ng-model="model" max-selected-items="3" />
```

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
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
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);
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);
console.log(callback.selectedItems);

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

Expand All @@ -322,7 +333,7 @@ Then you get a callback object with the clicked/selected item and the selected i

### 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
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:
Expand All @@ -331,13 +342,16 @@ Define the callback in your scope:
```javascript
$scope.removedMethod = function (callback) {
// print out the removed item
console.log(callback.item);
console.log(callback.item);

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

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

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

Expand All @@ -350,16 +364,16 @@ 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
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
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:
Expand All @@ -368,7 +382,7 @@ 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
// 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;
Expand All @@ -392,17 +406,20 @@ Note that the parameter for the `model-to-item-method` needs to be named `modelV

### 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
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) {
$scope.cancelButtonClickedMethod = function (callback) {
// print out the component id
console.log(callback.componentId);

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

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

Expand All @@ -415,15 +432,15 @@ 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 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
<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" ng-model="model" component-id="component1" />`
```

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
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
Expand Down Expand Up @@ -462,13 +479,13 @@ You are also able to set an own template for the autocomplete component (default
<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" ng-model="model" template-url="templates/template.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))
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,
> 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
Expand All @@ -480,8 +497,8 @@ like in the following example:

### Template data

If you change the template with the `template-url` and want to pass in additional data then you are able to set
the `template-data` attribute on the directive. If you for example have a `templateData.testData` expression in your own
If you change the template with the `template-url` and want to pass in additional data then you are able to set
the `template-data` attribute on the directive. If you for example have a `templateData.testData` expression in your own
template like this:
```html
...
Expand All @@ -503,13 +520,13 @@ Then the expression in your template gets resolved properly.

### Loading icon

If you want to display a loading icon when the `items-method` promise gets resolved then you need to set the `loading-icon`
attribute to a value given by the Ionic spinner: http://ionicframework.com/docs/api/directive/ionSpinner. Then the spinner should
be shown at the right side of the search input field.
If you want to display a loading icon when the `items-method` promise gets resolved then you need to set the `loading-icon`
attribute to a value given by the Ionic spinner: http://ionicframework.com/docs/api/directive/ionSpinner. Then the spinner should
be shown at the right side of the search input field.

### Manage externally

To manage the `ion-autocomplete` component externally means that you need to handle when the search modal is shown. To enable this functionality
To manage the `ion-autocomplete` component externally means that you need to handle when the search modal is shown. To enable this functionality
you need to set the `manage-externally` attribute to `true` and then you can call the `showModal()` method on the controller. Here an example:

```javascript
Expand All @@ -525,16 +542,24 @@ this.clickButton = function () {
}
```

Then you will need to click on the button to open the search modal. This functionality is useful if the user wants to edit the selected item inside the
Then you will need to click on the button to open the search modal. This functionality is useful if the user wants to edit the selected item inside the
input field after she/he selected the item/s.

### Selected items

If you want to clear the selected items programmatically, then you are able to set the `selected-items` attribute with a two way binded model value which then gets updated
If you want to clear the selected items programmatically, then you are able to set the `selected-items` attribute with a two way binded model value which then gets updated
when the items get selected. If you want to clear them just set the given model value to an empty array.

Please *do not* use it for pre populating the selected items. For this use the standard `ng-model` value and [the `model-to-item-method`](#the-model-to-item-method).

### Clear on select

This option is to clear the search input when an item is selected. You need to set it to `true` as in the following example to enable this functionality:

```javascript
<input ion-autocomplete type="text" class="ion-autocomplete" autocomplete="off" ng-model="model" clear-on-select="true" />
```

## Using expressions in value keys

All value keys are parsed with the Angular `$parse` service such that you are able to use expressions like in the following
Expand Down Expand Up @@ -564,9 +589,9 @@ name attribute of the child object:
## Debouncing

If you want to debounce the search input field request, then you are able to set the `ng-model-options` attribute on the input field where you define the `ion-autocomplete`
directive. These options will then be added to the search input field. Be aware that when you add a debounce the update of the model value will also be debounced the
directive. These options will then be added to the search input field. Be aware that when you add a debounce the update of the model value will also be debounced the
same amount as the request to the `items-method`. Here a small example:

```html
<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" ng-model="model" ng-model-options="{debounce:1000}" />
```
Expand All @@ -581,6 +606,20 @@ $scope.$on('$destroy', function () {
});
```

# Guidelines to report an issue

Please follow these rules when you create an issue here in Github:

1. Have a meaningful title of the issue.
2. Describe exactly how to reproduce the issue and create a Codepen based on the [demo](#demo) Codepen which reproduces the issue.
3. Show how you configured the directive with all the options.
4. Write down the Ionic version you use and which version of the directive.

These steps are needed to be able to analyze the issue properly without asking much questions. It is also useful for others when the issues
exactly describe what the problem is and in which environment it happened.

For feature request please add a proper title and describe it as much as possible and also tell about the requirement you have.

# Release notes

Check them here: [Release notes](https://github.com/guylabs/ion-autocomplete/blob/master/RELEASENOTES.md)
Expand Down
18 changes: 15 additions & 3 deletions RELEASENOTES.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Release notes of ion-autocomplete

## Version 0.3.3

* Tag: [0.3.3](https://github.com/guylabs/ion-autocomplete/tree/v0.3.3)
* Release: [ion-autocomplete-0.3.3.zip](https://github.com/guylabs/ion-autocomplete/archive/v0.3.3.zip)

### Changes

* Several bugs are fixed.
* New `clearOnSelect` option - [#186](https://github.com/guylabs/ion-autocomplete/pull/186)
* The `maxSelectedItems` option is now two way binded allowing for dynamic values - [#140](https://github.com/guylabs/ion-autocomplete/issues/140)
* Added a new property `selectedItemsArray` to the callback responses - [#115](https://github.com/guylabs/ion-autocomplete/issues/115)

## Version 0.3.2

* Tag: [0.3.2](https://github.com/guylabs/ion-autocomplete/tree/v0.3.2)
Expand Down Expand Up @@ -32,7 +44,7 @@ is now returned as object and not as an array with one element. If you use a cus

* As of version `0.3.1` the `multiple-select` attribute has been dropped in favor of the `max-selected-items` attribute.
Please have a look at the documentation here https://github.com/guylabs/ion-autocomplete#the-max-selected-items on how to migrate this.
* The `search-items` attribute has been removed as now the initialization of the `search-items` is done in the `items-method`. See the
* The `search-items` attribute has been removed as now the initialization of the `search-items` is done in the `items-method`. See the
new documentation here https://github.com/guylabs/ion-autocomplete#the-items-method.

## Version 0.3.0
Expand All @@ -49,8 +61,8 @@ new documentation here https://github.com/guylabs/ion-autocomplete#the-items-met

### Migration notes

* As of version `0.3.0` the component does not support the element restriction anymore, such that you are just able to
use the attribute restriction on all your elements. This means that you need to convert all `<ion-autocomplete ... />`
* As of version `0.3.0` the component does not support the element restriction anymore, such that you are just able to
use the attribute restriction on all your elements. This means that you need to convert all `<ion-autocomplete ... />`
tags to the following tag: `<input ion-autocomplete type="text" readonly="readonly" class="ion-autocomplete" autocomplete="off" ... />`

## Version 0.2.3
Expand Down

0 comments on commit f020c77

Please sign in to comment.