summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLea Verou <lea@verou.me>2016-06-25 17:41:23 +0300
committerGitHub <noreply@github.com>2016-06-25 17:41:23 +0300
commit541e36a7a66d60ba70aa958d8f84bae3cf1e0b3f (patch)
tree4307b334c7cdb0c2d029b82fef5c5ab87c8978dc
parenta1b7bd359f1cb3fe1b97bcd899fb3f5ea0abed83 (diff)
parent147b384b10b6179f07fcc593be5958ec518ea074 (diff)
downloadawesomplete-541e36a7a66d60ba70aa958d8f84bae3cf1e0b3f.zip
awesomplete-541e36a7a66d60ba70aa958d8f84bae3cf1e0b3f.tar.gz
awesomplete-541e36a7a66d60ba70aa958d8f84bae3cf1e0b3f.tar.bz2
Merge pull request #16900 from jimf/document-event-params
Add docs for event params
-rw-r--r--index.html6
1 files changed, 3 insertions, 3 deletions
diff --git a/index.html b/index.html
index 7bc53d0..9dfab7c 100644
--- a/index.html
+++ b/index.html
@@ -297,12 +297,12 @@ We can also <strong>generate list items based on user's input</strong>. See E-ma
<tbody>
<tr>
<td><code>awesomplete-select</code></td>
- <td>The user has made a selection (either via pressing enter or clicking on an item), but it has not been applied yet.</td>
+ <td>The user has made a selection (either via pressing enter or clicking on an item), but it has not been applied yet. Callback will be passed an object with <code>text</code> (selected suggestion) and <code>origin</code> (DOM element) properties.</td>
<td>Yes. The selection will not be applied and the popup will not close.</td>
</tr>
<tr>
<td><code>awesomplete-selectcomplete</code></td>
- <td>The user has made a selection (either via pressing enter or clicking on an item), and it has been applied.</td>
+ <td>The user has made a selection (either via pressing enter or clicking on an item), and it has been applied. Callback will be passed an object with a <code>text</code> property containing the selected suggestion.</td>
<td>No</td>
</tr>
<tr>
@@ -317,7 +317,7 @@ We can also <strong>generate list items based on user's input</strong>. See E-ma
</tr>
<tr>
<td><code>awesomplete-highlight</code></td>
- <td>The highlighted item just changed (in response to pressing an arrow key or via an API call).</td>
+ <td>The highlighted item just changed (in response to pressing an arrow key or via an API call). Callback will be passed an object with a <code>text</code> property containing the highlighted suggestion.</td>
<td>No</td>
</tr>
</tbody>