encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-27 08:29:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Extend logout drop down for customizations

Browse Source
This commit is contained in:
Petri Riihikallio 2021-08-10 15:22:32 +03:00
parent cdd53c7de9
commit 7153911d62
2 changed files with 53 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/topics/browsable-api.md
View File

@ -88,7 +88,9 @@ All of the standard [Bootstrap components][bcomponents] are available.
The browsable API makes use of the Bootstrap tooltips component. Any element with the `js-tooltip` class and a `title` attribute has that title content will display a tooltip on hover events.
### Login Template
### Customizing Authentication
#### Login Template
To add branding and customize the look-and-feel of the login template, create a template called `login.html` and add it to your project, eg: `templates/rest_framework/login.html`. The template should extend from `rest_framework/login_base.html`.
@ -102,6 +104,39 @@ You can add your site name or branding by including the branding block:
You can also customize the style by adding the `bootstrap_theme` or `style` block similar to `api.html`.
#### Login/Logout Button
The Login/Logout functionality comes from userlinks block from 'base.html' and 'admin.html' templates. If you want to remove it then you can just override the block in both templates:
{% extends "rest_framework/base.html" %}
{% block userlinks %}
{% endblock %}
If you want to extend the logout drop down menu then add the following to both project templates:
{% extends "rest_framework/base.html" %}
{% load rest_framework %}
{% block userlinks %}
{% if user.is_authenticated %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
{{ user }}
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href='#profile'>My Profile</a></li> <! –– Customization ––>
<li><a href='#messages'>My Messages</a></li> <! –– Customization ––>
<li role="separator" class="divider"></li> <! –– Customization ––>
<li>{% optional_logout request %}</li>
</ul>
</li>
{% else %}
<li>{% optional_login request %}</li>
{% endif %}
{% endblock %}
### Advanced Customization
#### Context

29
rest_framework/templatetags/rest_framework.py
View File

@ -120,27 +120,32 @@ def optional_docs_login(request):
@register.simple_tag
def optional_logout(request, user):
def optional_logout(request, user=""):
"""
Include a logout snippet if REST framework's logout view is in the URLconf.
"""
try:
logout_url = reverse('rest_framework:logout')
except NoReverseMatch:
snippet = format_html('<li class="navbar-text">{user}</li>', user=escape(user))
snippet = format_html('<li class="navbar-text">{user}</li>', user=escape(user) or 'logged in')
return mark_safe(snippet)
snippet = """<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
{user}
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href='{href}?next={next}'>Log out</a></li>
</ul>
</li>"""
snippet = format_html(snippet, user=escape(user), href=logout_url, next=escape(request.path))
if user:
snippet = """<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
{user}
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href='{href}?next={next}'>Log out</a></li>
</ul>
</li>"""
# snippet = format_html(snippet, user=escape(user), href=logout_url, next=escape(request.path))
else:
snippet = "<a href='{href}?next={next}'>Log out</a>"
# snippet = format_html(snippet, href=logout_url, next=escape(request.path))
snippet = format_html(snippet, user=escape(user), href=logout_url, next=escape(request.path))
return mark_safe(snippet)