chore(doc): Add link to pagination limitations (#2379)

Fix #2274
algolia · Sep 25, 2017 · 2ceafab · 2ceafab
1 parent ab7f48c
commit 2ceafab
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/src/connectors/pagination/connectPagination.js b/src/connectors/pagination/connectPagination.js
@@ -38,6 +38,9 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
  * **Pagination** connector provides the logic to build a widget that will let the user
  * choose the current page of the results.
  *
+ * When using the pagination with Algolia, you should be aware that the engine won't provide you pages
+ * beyond the 1000th hits by default. You can find more information on the [Algolia documentation](https://www.algolia.com/doc/guides/searching/pagination/#pagination-limitations).
+ *
  * @type {Connector}
  * @param {function(PaginationRenderingOptions, boolean)} renderFn Rendering function for the custom **Pagination** widget.
  * @return {function(CustomPaginationWidgetOptions)} Re-usable widget factory for a custom **Pagination** widget.

diff --git a/src/widgets/pagination/pagination.js b/src/widgets/pagination/pagination.js
@@ -112,6 +112,10 @@ pagination({
  * only to display more items. The *show more* pattern is usually prefered
  * because it is simpler to use, and it is more convenient in a mobile context.
  * See the infinite hits widget, for more informations.
+ *
+ * When using the pagination with Algolia, you should be aware that the engine won't provide you pages
+ * beyond the 1000th hits by default. You can find more information on the [Algolia documentation](https://www.algolia.com/doc/guides/searching/pagination/#pagination-limitations).
+ *
  * @type {WidgetFactory}
  * @category navigation
  * @param {PaginationWidgetOptions} $0 Options for the Pagination widget.