mirror of
https://github.com/wassname/flask-security.git
synced 2026-06-27 16:10:11 +08:00
Matt Wright
96 lines
3.4 KiB
ReStructuredText
96 lines
3.4 KiB
ReStructuredText
Customizing Views
|
|
=================
|
|
|
|
Flask-Security bootstraps your application with various views for handling its
|
|
configured features to get you up and running as quick as possible. However,
|
|
you'll probably want to change the way these views look to be more in line with
|
|
your application's visual design.
|
|
|
|
|
|
Views
|
|
-----
|
|
|
|
Flask-Security is packaged with a default template for each view it presents to
|
|
a user. Templates are located within a subfolder named ``security``. The
|
|
following is a list of view templates:
|
|
|
|
* `security/forgot_password.html`
|
|
* `security/login_user.html`
|
|
* `security/register_user.html`
|
|
* `security/reset_password.html`
|
|
* `security/send_confirmation.html`
|
|
* `security/send_login.html`
|
|
|
|
Overriding these templates is simple:
|
|
|
|
1. Create a folder named ``security`` within your application's templates folder
|
|
2. Create a template with the same name for the template you wish to override
|
|
|
|
Each template is passed a template context object that includes the following,
|
|
including the objects/values that are passed to the template by the main
|
|
Flask application context processory:
|
|
|
|
* ``<template_name>_form``: A form object for the view
|
|
* ``security``: The Flask-Security extension object
|
|
|
|
To add more values to the template context you can specify a context processor
|
|
for all views or a specific view. For example::
|
|
|
|
security = Security(app, user_datastore)
|
|
|
|
# This processor is added to all templates
|
|
@security.context_processor
|
|
def security_context_processor():
|
|
return dict(hello="world")
|
|
|
|
# This processor is added to only the register view
|
|
@security.register_context_processor
|
|
def security_register_processor():
|
|
return dict(something="else")
|
|
|
|
The following is a list of all the available context processor decorators:
|
|
|
|
* ``context_processor``: All views
|
|
* ``forgot_password_context_processor``: Forgot password view
|
|
* ``login_context_processor``: Login view
|
|
* ``register_context_processor``: Register view
|
|
* ``reset_password_context_processor``: Reset password view
|
|
* ``send_confirmation_context_processor``: Send confirmation view
|
|
* ``send_login_context_processor``: Send login view
|
|
|
|
|
|
Emails
|
|
------
|
|
|
|
Flask-Security is also packaged with a default tempalte for each email that it
|
|
may send. Templates are located within the subfolder named ``security/mail``.
|
|
The following is a list of email templates:
|
|
|
|
* `security/mail/confirmation_instructions.html`
|
|
* `security/mail/confirmation_instructions.txt`
|
|
* `security/mail/login_instructions.html`
|
|
* `security/mail/login_instructions.txt`
|
|
* `security/mail/reset_instructions.html`
|
|
* `security/mail/reset_instructions.txt`
|
|
* `security/mail/reset_notice.html`
|
|
* `security/mail/reset_notice.txt`
|
|
* `security/mail/welcome.html`
|
|
* `security/mail/welcome.txt`
|
|
|
|
Overriding these templates is simple:
|
|
|
|
1. Create a folder named ``security`` within your application's templates folder
|
|
2. Create a folder named ``email`` within the ``security`` folder
|
|
3. Create a template with the same name for the template you wish to override
|
|
|
|
Each template is passed a template context object that includes values for any
|
|
links that are required in the email. If you require more values in the
|
|
templates you can specify an email context processor with the
|
|
``email_context_processor`` decorator. For example::
|
|
|
|
security = Security(app, user_datastore)
|
|
|
|
# This processor is added to all emails
|
|
@security.email_context_processor
|
|
def security_mail_processor():
|
|
return dict(hello="world") |