Installation

1. Create a new Django project or cd to an existing project

2. pip install dj-angles

3. Edit TEMPLATES.loaders in settings.py. Note: you might need to remove APP_DIRS and add OPTIONS.loaders since it is not there by default (https://docs.djangoproject.com/en/stable/ref/templates/api/#django.template.loaders.cached.Loader).

# settings.py
from dj_angles import get_template_loaders

...
TEMPLATES = [{
  "BACKEND": "django.template.backends.django.DjangoTemplates",
  # "APP_DIRS": True,  # this cannot be specified if OPTIONS.loaders is explicitly set
  "DIRS": [],
  "OPTIONS": {
      "context_processors": [
          "django.template.context_processors.request",
          "django.template.context_processors.debug",
          "django.template.context_processors.static",
      ],
      "loaders": get_template_loaders(),
  },
}]

Note

get_template_loaders returns a list of template loaders to enable dj-angles. It automatically handles caching templates when DEBUG=False and integrates django-components, django-viewcomponent, django-bird, and django-template-partials template loaders if they are installed.

Template Tags

dj-angles includes regular Django template tags that can be used even if not using the dj-angles template loader. To enable them, add dj_angles to INSTALLED_APPS.

# settings.py

...
INSTALLED_APPS = [
    ...
    "dj_angles",
]

They can be loaded in any template by using {% load dj_angles %}. Or "dj_angles.templatetags.dj_angles" can be added to template built-ins in settings.py to make them available in all templates automatically.

# settings.py

...
TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [BASE_DIR / "templates"],
        "OPTIONS": {
            ...
            "builtins": [
                "dj_angles.templatetags.dj_angles",
            ],
        },
    },
]

Middleware

dj-angles includes middleware for checking the request method and whether the request is AJAX.

# settings.py

...
MIDDLEWARE = [
    ...
    "dj_angles.middleware.RequestMethodMiddleware",
    "dj_angles.middleware.RequestAJAXMiddleware",
]

Scripts

Add scripts for custom elements.

<!-- base.html -->
{% load dj_angles %}

{% dj_angles_scripts %}