tna-frontend-jinja 0.1.9

TNA Frontend Jinja templates

TNA Frontend Jinja

TNA Frontend Jinja templates are a Jinja implementation of the templates provided as part of TNA Frontend.

Quickstart for Flask projects

Use the Flask application's jinja_loader to allow templates included from either your app (in the below example called app) and the tna_frontend_jinja package.

Ensure you application is first on the list. This means you can overwrite the standard templates by creating a template with the same filename in your project.

from flask import Flask
from jinja2 import ChoiceLoader, PackageLoader


def create_app():
    app = Flask(__name__)

    app.jinja_loader = ChoiceLoader(
        [
            PackageLoader("app"),
            PackageLoader("tna_frontend_jinja"),
        ]
    )

Using the templates

{% from "components/button/macro.html" import tnaButton -%}

{{ tnaButton({
  'text': 'Save and continue'
}) }}

The options available to each component macro can be found in the National Archives Design System Components documentation.

The included templates are a like-for-like port, the only difference between the Nunjucks examples and their Jinja equivalents is having to quote key names, e.g. 'text' instead of text.

We test each component against its published component fixtures to ensure complete compatibility.

Compatibility with TNA Frontend

TNA Frontend Jinja	Compatible TNA Frontend versions
0.1.9	v0.1.33
0.1.8	v0.1.31, v0.1.32
0.1.7	v0.1.31, v0.1.32
0.1.6	v0.1.29-prerelease, v0.1.30
0.1.0–0.1.5	[latest from main branch when published]

Test the templates

python -m venv venv
python install -r test/requirements.txt
flask --app test run --debug --port 5000
node test-fixtures.mjs