1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
Templates
=========
Overridable templates
---------------------
``allauth`` ships many templates, viewable in the
`allauth/templates <https://github.com/pennersr/django-allauth/tree/master/allauth/templates>`__
directory.
For instance, the view corresponding to the ``account_login`` URL uses the
template ``account/login.html``. If you create a file with this name in your
code layout, it can override the one shipped with ``allauth``.
Template Tags
-------------
The following template tag libraries are available:
- ``account``: tags for dealing with accounts in general
- ``socialaccount``: tags focused on social accounts
Account Tags
************
Use ``user_display`` to render a user name without making assumptions on
how the user is represented (e.g. render the username, or first
name?)::
{% load account %}
{% user_display user %}
Or, if you need to use in a ``{% blocktrans %}``::
{% load account %}
{% user_display user as user_display %}
{% blocktrans %}{{ user_display }} has logged in...{% endblocktrans %}
Then, override the ``ACCOUNT_USER_DISPLAY`` setting with your project
specific user display callable.
Social Account Tags
*******************
Use the ``provider_login_url`` tag to generate provider specific login URLs::
{% load socialaccount %}
<a href="{% provider_login_url "openid" openid="https://www.google.com/accounts/o8/id" next="/success/url/" %}">Google</a>
<a href="{% provider_login_url "twitter" %}">Twitter</a>
Here, you can pass along an optional ``process`` parameter that
indicates how to process the social login. You can choose between
``login`` and ``connect``::
<a href="{% provider_login_url "twitter" process="connect" %}">Connect a Twitter account</a>
Furthermore, you can pass along an ``action`` parameter with value
``reauthenticate`` to indicate that you want the user to be re-prompted
for authentication even if they already signed in before. For now, this
is supported by Facebook, Google and Twitter only.
For Javascript based logins (e.g. when you enable the Facebook JS
SDK), you will need to make sure that the required Javascript is
loaded. The following tag loads all scripts for the enabled
providers::
{% providers_media_js %}
For easy access to the social accounts for a user use::
{% get_social_accounts user as accounts %}
Then::
{{accounts.twitter}} -- a list of connected Twitter accounts
{{accounts.twitter.0}} -- the first Twitter account
{% if accounts %} -- if there is at least one social account
Finally, social authentication providers configured for the current site
can be retrieved via::
{% get_providers as socialaccount_providers %}
Which will populate the ``socialaccount_providers`` variable in the
template context with a list of configured social authentication
providers. This supersedes the context processor used in version 0.21 and
below.
|
