mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 13:44:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Fixed #25513 -- Extracted admin pagination to Paginator.get_elided_page_range().

Browse source
This commit is contained in:
Nick Pope 2020-08-06 11:43:42 +02:00 • committed by Carlton Gibson
parent f35840c196
commit 0a306f7da6
6 changed files with 215 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/ref/paginator.txt
View file

@ -78,9 +78,40 @@ Methods
Returns a :class:`Page` object with the given 1-based index. Raises
:exc:`InvalidPage` if the given page number doesn't exist.
.. method:: Paginator.get_elided_page_range(number, *, on_each_side=3, on_ends=2)
.. versionadded:: 3.2
Returns a 1-based list of page numbers similar to
:attr:`Paginator.page_range`, but may add an ellipsis to either or both
sides of the current page number when :attr:`Paginator.num_pages` is large.
The number of pages to include on each side of the current page number is
determined by the ``on_each_side`` argument which defaults to 3.
The number of pages to include at the beginning and end of page range is
determined by the ``on_ends`` argument which defaults to 2.
For example, with the default values for ``on_each_side`` and ``on_ends``,
if the current page is 10 and there are 50 pages, the page range will be
``[1, 2, '…', 7, 8, 9, 10, 11, 12, 13, '…', 49, 50]``. This will result in
pages 4, 5, and 6 to the left of and 8, 9, and 10 to the right of the
current page as well as pages 1 and 2 at the start and 49 and 50 at the
end.
Raises :exc:`InvalidPage` if the given page number doesn't exist.
Attributes
----------
.. attribute:: Paginator.ELLIPSIS
.. versionadded:: 3.2
A translatable string used as a substitute for elided page numbers in the
page range returned by :meth:`~Paginator.get_elided_page_range`. Default is
``'…'``.
.. attribute:: Paginator.count
The total number of objects, across all pages.