Changing the active class of a link with the twitter bootstrap css in python/flask

ID : 131308

viewed : 9

Tags : pythonclasstwitter-bootstrapflaskjinja2python

Top 5 Answer for Changing the active class of a link with the twitter bootstrap css in python/flask

vote vote

95

Have you looked at this ? https://jinja.palletsprojects.com/en/3.0.x/tricks/#highlighting-active-menu-items

Highlighting Active Menu Items

Often you want to have a navigation bar with an active navigation item. This is really simple to achieve. Because assignments outside of blocks in child templates are global and executed before the layout template is evaluated it’s possible to define the active menu item in the child template:

{% extends "layout.html" %} {% set active_page = "index" %} 

The layout template can then access active_page. Additionally it makes sense to define a default for that variable:

{% set navigation_bar = [     ('/', 'index', 'Index'),     ('/downloads/', 'downloads', 'Downloads'),     ('/about/', 'about', 'About') ] -%}  {% set active_page = active_page|default('index') -%} ... <ul id="navigation">     {% for href, id, caption in navigation_bar %}     <li{% if id == active_page %} class="active"{% endif     %}><a href="{{ href|e }}">{{ caption|e }}</a>     </li> {% endfor %} </ul> 
vote vote

83

Here is another simpler way if you have menus distributed all over the page. This way uses inline if statements to print out the class active.

<ul>  <li class="{{ 'active' if active_page == 'menu1' else '' }}"> <a href="/blah1">Link 1</a> </li>  <li class="{{ 'active' if active_page == 'menu2' else '' }}"> <a href="/blah2"> Link 2 </a> </li>  </ul> 

Class active is for highlighting

You still need to set the variable on every page to mark them

{% extends "master.html" %} {% set active_page = "menu1" %} 

or

{% set active_page = "menu2" %} 
vote vote

79

For jinja/flask/bootstrap users:

If you define your nav like they did in the blog example http://getbootstrap.com/examples/blog/ simply assign ids to your links that match your url_for arguments and you just need to modify the layout-template, the rest just works #magic.

<nav class="blog-nav">   <a id="allposts"  class="blog-nav-item" href="{{ url_for('allposts')}}">All Posts</a>   <a id="index"     class="blog-nav-item" href="{{ url_for('index')}}">Index</a>   <a id="favorites" class="blog-nav-item" href="{{ url_for('favorites')}}">Favorites</a> </nav> 

At the bottom of your base/layout template just add this

<script>   $(document).ready(function () {   $("#{{request.endpoint}}").addClass("active"); }) </script> 

and the right elements will be set active.

EDIT: If you have a layout with elements in a list, like this:

<nav class="blog-nav">   <ul class="nav navbar-nav">     <li>         <a id="allposts"  class="blog-nav-item" href="{{ url_for('allposts')}}">All Posts</a>     </li>     <li>         <a id="index"     class="blog-nav-item" href="{{ url_for('index')}}">Index</a>     </li>     <li>         <a id="favorites" class="blog-nav-item" href="{{ url_for('favorites')}}">Favorites</a>     </li>   </ul> </nav> 

use the parent() function to get the li element instead of the link.

<script>     $(document).ready(function () {     $("#{{request.endpoint}}").parent().addClass("active"); }) </script> 
vote vote

68

we can make class active by using jinja if statements

<ul class="nav navbar-nav">      <li class="{% if request.endpoint=='home' %}active{%endif %}"><a href="{{  url_for('home') }}">home</a></li>      <li class="{% if request.endpoint=='add_client' %}active{%endif %}"><a href="{{  url_for('add_client') }}">Add Report</a></li>     </li>   </ul> 
vote vote

56

I liked @philmaweb's approach, but there's really no reason to require duplicating the endpoint in the id of each element.

base.js:

$(document).ready(function () {     var scriptElement = $('#baseScript')[0];     var path = scriptElement.getAttribute('data-path');     $('a[href="'+path+'"]').addClass("active"); }); 

base.html

<script id="baseScript" src="{{ url_for('static', filename='js/base.js') }}" data-path="{{ request.path }}"></script> 

Why not just put this script inline? You could, of course, but allowing inline JS is a security nightmare. You should be using a CSP on your site (e.g. Flask-Talisman) which will not allow inline JS. With data-* attributes, it's not hard to do this in a secure way.

NB: If you have multiple links leading to the same, current page and you want only ONE of them to be marked "active"—then this approach may not work for you.

Top 3 video Explaining Changing the active class of a link with the twitter bootstrap css in python/flask

Related QUESTION?