The template uses Jinja2 template engine and by default looks for a templates/sqladmin directory in your project.

If your templates/sqladmin directory has the default template files like list.html or create.html then they will be used. Otherwise you can create custom templates and use them.

Customizing templates

As the first step you should create a templates/sqladmin directory in you project.

Since Jinja2 is modular, you can override your specific template file and do your changes. For example you can create a custom_details.html file which overrides the details.html from SQLAdmin and in the content block it adds custom HTML tags:

Example

custom_details.html

{% extends "sqladmin/details.html" %}
{% block content %}
    {{ super() }}
    <p>Custom HTML</p>
{% endblock %}

admin.py

class UserAdmin(ModelView, model=User):
    details_template = "custom_details.html"

Overriding default templates

If you need to change one of the existing default templates in SQLAdmin such that it affects multiple pages, you can do so by copying the existing template from templates/sqladmin into your templates/sqladmin directory. It will then be used instead of the one in the package. For example if there is some Javascript you want to run on every page you may want to do it in layout.html like so:

Example

myproject/templates/sqladmin/layout.html

...
</div>
</div>
{% endblock %}

{% block tail %}
<script type="text/javascript">
    console.log('hello world');
</script>
{% endblock %}

Customizing Jinja2 environment

You can add custom environment options to use it on your custom templates. First set up a project:

from sqladmin import Admin
from starlette.applications import Starlette


app = Starlette()
admin = Admin(app, engine)

Then you can add your environment options:

Adding filters

def datetime_format(value, format="%H:%M %d-%m-%y"):
    return value.strftime(format)

admin.templates.env.filters["datetime_format"] = datetime_format

Usage in templates:

{{ article.pub_date|datetimeformat }}
{{ article.pub_date|datetimeformat("%B %Y") }}

Adding tests

import math

def is_prime(n):
    if n == 2:
        return True

    for i in range(2, int(math.ceil(math.sqrt(n))) + 1):
        if n % i == 0:
            return False

    return True

admin.templates.env.tests["prime"] = is_prime

Usage in templates:

{% if value is prime %}
    {{ value }} is a prime number
{% else %}
    {{ value }} is not a prime number
{% endif %}

Adding globals

def value_is_filepath(value: Any) -> bool:
    return isinstance(value, str) and os.path.isfile(value)

admin.templates.env.globals["value_is_filepath"] = value_is_filepath

Usage in templates:

{% if value_is_filepath(value) %}
    {{ value }} is file path
{% else %}
    {{ value }} is not file path
{% endif %}