Merge branch 'develop' into fix/2274

algolia · Sep 25, 2017 · dd2e14b · dd2e14b
2 parents 91104e2 + 6be0989
commit dd2e14b
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/widgets/hits/hits.js b/src/widgets/hits/hits.js
@@ -63,7 +63,7 @@ hits({
 /**
  * @typedef {Object} HitsTemplates
  * @property {string|function(object):string} [empty=''] Template to use when there are no results.
- * @property {string|function(object):string} [item=''] Template to use for each result. This template will receive an object containing a single record.
+ * @property {string|function(object):string} [item=''] Template to use for each result. This template will receive an object containing a single record. The record will have a new property `__hitIndex` for the position of the record in the list of displayed hits.
  * @property {string|function(object):string} [allItems=''] Template to use for the list of all results. (Can't be used with `item` template). This template will receive a complete SearchResults result object, this object contains the key hits that contains all the records retrieved.
  */