Skip to content

Commit

Permalink
update docs and version
Browse files Browse the repository at this point in the history
  • Loading branch information
mizzao committed Feb 28, 2014
1 parent 939d50d commit 7467e0e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
5 changes: 3 additions & 2 deletions History.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## vNEXT
## v0.1.1

* Increased z-index on autocomplete container (#8).
* Added jquery-migrate package to temporarily support caret position operations on Meteor 0.7.1.2 (this will be fixed in the future).

## v1.0
## v0.1.0

* First release.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ Template.foo.settings = function() {
- `field`: the field of the collection that the rule will match against
- `template`: the template that should be used to render each list item. The template will be passed the entire matched document as a data context, so render list items as fancily as you would like. For example, it's usually helpful to see metadata for matches as in the pictures above.

**Simple autocompletion**: If you only need to autocomplete over a single collection and want to match the entire field, specify a `rules` array with a single object where `token` is the empty string: `''`. This is a little janky, but it works - you can offer any suggestions for improvement [here](https://github.com/mizzao/meteor-autocomplete/issues/4).

An autocomplete template is just a normal Meteor template that is passed in the matched document. For example, if you were matching on `Meteor.users` and you just wanted to display the username, you can do something very simple, and display the same field:

```
Expand Down Expand Up @@ -119,7 +121,7 @@ This (using normal Bootstrap classes) will cause the user to show up in orange f

### Known Issues

- Empty list (and css shadow) renders if rule activated but no matches (a reactivity headache otherwise, requires some though to rewrite)
- Empty list (and css shadow) renders if rule activated but no matches (a reactivity headache otherwise, requires some thought to rewrite)
- Cursor position may be incorrect on a focus
- Regexp only matches from beginning to cursor position in word (done in jquery-sew, could use rewrite)
- Escape key behavior copied from jquery-sew but it's rather vacuous
Expand Down
2 changes: 1 addition & 1 deletion smart.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"description": "text input autocomplete using Meteor collections",
"homepage": "https://github.com/mizzao/meteor-autocomplete",
"author": "Andrew Mao (https://github.com/mizzao/)",
"version": "0.1.0",
"version": "0.1.1",
"git": "https://github.com/mizzao/meteor-autocomplete.git",
"packages": {
"jquery-migrate": ""
Expand Down

0 comments on commit 7467e0e

Please sign in to comment.