Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Sep 25, 2017
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e518ea8
chore(doc): Add link to pagination limitations
Sep 22, 2017
91104e2
Merge branch 'develop' into fix/2274
bobylito Sep 25, 2017
dd2e14b
Merge branch 'develop' into fix/2274
bobylito Sep 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/connectors/pagination/connectPagination.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions src/widgets/pagination/pagination.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down