feat: add url_anchor parameter

Author: Gagaro

bootstrap_pagination/templatetags/bootstrap_pagination.py

@@ -17,7 +17,7 @@ def strToBool(val):
     return val.lower() == "true"
 
 
-def get_page_url(page_num, current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params):
+def get_page_url(page_num, current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor):
     """
     Helper function to return a valid URL string given the template tag parameters
     """
@@ -44,6 +44,9 @@ def get_page_url(page_num, current_app, url_view_name, url_extra_args, url_extra
     if (len(url_get_params) > 0):
         url += '?' + url_get_params.urlencode()
 
+    if (url_anchor):
+        url += '#' + url_anchor
+
     return url
 
 
@@ -78,14 +81,15 @@ def render(self, context):
         url_extra_args = kwargs.get("url_extra_args", [])
         url_extra_kwargs = kwargs.get("url_extra_kwargs", {})
         url_get_params = kwargs.get("url_get_params", context['request'].GET)
+        url_anchor = kwargs.get("url_anchor", None)
 
         previous_page_url = None
         if page.has_previous():
-            previous_page_url = get_page_url(page.previous_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            previous_page_url = get_page_url(page.previous_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
 
         next_page_url = None
         if page.has_next():
-            next_page_url = get_page_url(page.next_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            next_page_url = get_page_url(page.next_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
 
         return get_template("bootstrap_pagination/pager.html").render(
             Context({
@@ -146,6 +150,7 @@ def render(self, context):
         url_extra_args = kwargs.get("url_extra_args", [])
         url_extra_kwargs = kwargs.get("url_extra_kwargs", {})
         url_get_params = kwargs.get("url_get_params", context['request'].GET)
+        url_anchor = kwargs.get("url_anchor", None)
 
         # Generage our viewable page range
         page_count = page.paginator.num_pages
@@ -176,24 +181,24 @@ def render(self, context):
         # Generate our URLs (page range + special urls for first, previous, next, and last)
         page_urls = []
         for curpage in page_range:
-            url = get_page_url(curpage, context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            url = get_page_url(curpage, context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
             page_urls.append((curpage, url))
 
         first_page_url = None
         if current_page >= 1:
-            first_page_url = get_page_url(1, context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            first_page_url = get_page_url(1, context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
 
         last_page_url = None
         if current_page <= page_count:
-            last_page_url = get_page_url(page_count, context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            last_page_url = get_page_url(page_count, context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
 
         previous_page_url = None
         if page.has_previous():
-            previous_page_url = get_page_url(page.previous_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            previous_page_url = get_page_url(page.previous_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
 
         next_page_url = None
         if page.has_next():
-            next_page_url = get_page_url(page.next_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params)
+            next_page_url = get_page_url(page.next_page_number(), context.current_app, url_view_name, url_extra_args, url_extra_kwargs, url_param_name, url_get_params, url_anchor)
 
         return get_template("bootstrap_pagination/pagination.html").render(
             Context({
@@ -278,7 +283,7 @@ def bootstrap_paginate(parser, token):
                          number will be overwritten. Use this to preserve
                          filters.
 
-
+        url_anchor - The anchor to use in URLs. Defaults to None.
     """
     bits = token.split_contents()
     if len(bits) < 2:
@@ -345,6 +350,8 @@ def bootstrap_pager(parser, token):
         url_get_params - The other get parameters to pass, only the page
                          number will be overwritten. Use this to preserve
                          filters.
+
+        url_anchor - The anchor to use in URLs. Defaults to None.
     """
     bits = token.split_contents()
     if len(bits) < 2: