You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 17, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,39 +92,39 @@ Finally, make sure that you have the request context processor enabled:
92
92
93
93
-**range** - Defines the maximum number of page links to show
94
94
-**show_prev_next** - Boolean. Defines whether or not to show the Previous and Next
95
-
links. (Accepts "true" or "false")
95
+
links. (Accepts `"true"` or `"false"`)
96
96
-**previous_label** - The label to use for the Previous link
97
97
-**next_label** - The label to use for the Next link
98
98
-**show_first_last** - Boolean. Defines whether or not to show the First and Last links.
99
-
(Accepts "true" or "false")
99
+
(Accepts `"true"` or `"false"`)
100
100
-**first_label** - The label to use for the First page link
101
101
-**last_label** - The label to use for the Last page link
102
102
-**show_index_range** - Boolean, defaults to "false". If "true" shows index range of items instead of page numbers in the paginator. For example, if paginator is configured for 50 items per page, show_index_range="true" will display [1-50, 51-100, **101-150**, 151-200, 201-250, etc.] rather than [1, 2, **3**, 4, 5, etc.].
103
-
-**url_view_name** - A named URL reference (such as one that might get passed inti the URL
103
+
-**url_view_name** - A named URL reference (such as one that might get passed into the URL
104
104
template tag) to use as the URL template. Must be resolvable by the
105
-
reverse() function. **If this option is not specified, the tag simply
106
-
uses a relative url such as "?page=1" which is fine in most situations**
107
-
-**url_param_name** - Determines the name of the GET parameter for the page number. Th
108
-
default is "page". If no **url_view_name** is defined, this string
109
-
is appended to the url as "?{{url_param_name}}=1".
105
+
`reverse()` function. **If this option is not specified, the tag simply
106
+
uses a relative url such as `?page=1` which is fine in most situations**
107
+
-**url_param_name** - Determines the name of the `GET` parameter for the page number. The
108
+
default is `"page"`. If no **url_view_name** is defined, this string
109
+
is appended to the url as `?{{url_param_name}}=1`.
110
110
-**url_extra_args** - **Only valid when url_view_name is set.** Additional arguments to
111
-
pass into reverse() to resolve the URL.
112
-
-**url_extra_kwargs** - **Only valid when url_view_name is set.** Additional named
113
-
arguments to pass into reverse() to resolve the URL. Additionally,
111
+
pass into `reverse()` to resolve the URL.
112
+
-**url_extra_kwargs** - **Only valid when `url_view_name` is set.** Additional named
113
+
arguments to pass into `reverse()` to resolve the URL. Additionally,
114
114
the template tag will add an extra parameter to this for the
115
115
page, as it is assumed that if given a url_name, the page will
116
116
be a named variable in the URL regular expression. In this case,
117
-
the **url_param_name** continues to be the string used to represent
118
-
the name. That is, by default, **url_param_name** is equal to "page"
119
-
and thus it is expected that there is a named "page" argument in the
120
-
URL referenced by **url_view_name**. This allows us to use pretty
121
-
pagination URLs such as "/page/1"
117
+
the `url_param_name` continues to be the string used to represent
118
+
the name. That is, by default, `url_param_name` is equal to `page`
119
+
and thus it is expected that there is a named `page` argument in the
120
+
URL referenced by `url_view_name`. This allows us to use pretty
121
+
pagination URLs such as `/page/1`
122
122
-*extra_pagination_classes* - A space separated list of CSS class names that
123
-
will be added to the top level <ul> HTML element.
123
+
will be added to the top level `<ul>` HTML element.
124
124
In particular, this can be utilized in Bootstrap 4
125
125
installations to add the appropriate alignment
126
126
classes from Flexbox utilities: eg:
127
-
justify-content-center
127
+
`justify-content-center`
128
128
129
129
130
130
**Basic Usage**
@@ -195,28 +195,28 @@ simply provides a Previous and Next link.
195
195
-**next_title** - Defines the link title for the next link
196
196
-**centered** - Boolean. Defines whether or not the links are centered. Defaults to false.
197
197
(Accepts "true" or "false")
198
-
-**url_view_name** - A named URL reference (such as one that might get passed inti the URL
198
+
-**url_view_name** - A named URL reference (such as one that might get passed into the URL
199
199
template tag) to use as the URL template. Must be resolvable by the
200
-
reverse() function. **If this option is not specified, the tag simply
201
-
uses a relative url such as "?page=1" which is fine in most situations**
202
-
-**url_param_name** - Determines the name of the GET parameter for the page number. Th
203
-
default is "page". If no **url_view_name** is defined, this string
204
-
is appended to the url as "?{{url_param_name}}=1".
205
-
-**url_extra_args** - **Only valid when url_view_name is set.** Additional arguments to
206
-
pass into reverse() to resolve the URL.
207
-
-**url_extra_kwargs** - **Only valid when url_view_name is set.** Additional named
208
-
arguments to pass into reverse() to resolve the URL. Additionally,
200
+
`reverse()` function. **If this option is not specified, the tag simply
201
+
uses a relative url such as `?page=1` which is fine in most situations**
202
+
-**url_param_name** - Determines the name of the `GET` parameter for the page number. Th
203
+
default is `"page"`. If no `url_view_name` is defined, this string
204
+
is appended to the url as `?{{url_param_name}}=1`.
205
+
-**url_extra_args** - **Only valid when `url_view_name` is set.** Additional arguments to
206
+
pass into `reverse()` to resolve the URL.
207
+
-**url_extra_kwargs** - **Only valid when `url_view_name` is set.** Additional named
208
+
arguments to pass into `reverse()` to resolve the URL. Additionally,
209
209
the template tag will add an extra parameter to this for the
210
210
page, as it is assumed that if given a url_name, the page will
211
211
be a named variable in the URL regular expression. In this case,
212
-
the **url_param_name** continues to be the string used to represent
213
-
the name. That is, by default, **url_param_name** is equal to "page"
214
-
and thus it is expected that there is a named "page" argument in the
215
-
URL referenced by **url_view_name**. This allows us to use pretty
216
-
pagination URLs such as "/page/1"
217
-
-**url_anchor** - The anchor to use in URLs. Defaults to None
212
+
the `url_param_name` continues to be the string used to represent
213
+
the name. That is, by default, `url_param_name` is equal to `"page"`
214
+
and thus it is expected that there is a named `page` argument in the
215
+
URL referenced by `url_view_name`. This allows us to use pretty
216
+
pagination URLs such as `/page/1`
217
+
-**url_anchor** - The anchor to use in URLs. Defaults to `None`
218
218
-*extra_pager_classes* - A space separated list of CSS class names that will be added
219
-
to the top level <ul> HTML element. This could be used to, as an
219
+
to the top level `<ul>` HTML element. This could be used to, as an
220
220
example, add a class to prevent the pager from showing up when
0 commit comments