Wagtail Header & Footer Scripts
A reusable Wagtail app for managing header and footer scripts across different sites using Wagtail Settings. It also supports adding page-specific header and footer scripts.
Features
- Add header/footer scripts per site
- Add header/footer scripts specific to individual pages
- Use Wagtail settings and model clustering
- Toggle scripts on/off
- Render scripts using custom template tags
- Supports easy integration into Wagtail pages via models
Installation
pip install wagtail-headers-footers
Add to INSTALLED_APPS
INSTALLED_APPS = [
...
"wagtail.contrib.settings",
"wagtail_headers_footers",
]
Add context processor to your settings
TEMPLATES = [
{
...
"OPTIONS": {
"context_processors": [
...
"wagtail.contrib.settings.context_processors.settings",
],
},
},
]
Migrate Wagtail H/F
python manage.py migrate wagtail_headers_footers
Usage
Add Site-wide scripts
Go to Settings > Headers & Footers in the Wagtail Admin to manage your scripts.
Add page-specific scripts
For page-specific headers and footers, you can add them by inheriting the following in your page models:
from wagtail.models import Page
from wagtail_headers_footers.models import PageHeaderFooterScriptsMixin
class HomePage(PageHeaderFooterScriptsMixin, Page):
content_panels = Page.content_panels + PageHeaderFooterScriptsMixin.header_footer_panels
Don't forget to make migrations and migrate if neccessory.
Go to Pages in the Wagtail Admin to manage your page-specific scripts.
Add to your templates
Add the following code to your base template where you want to render the scripts:
{% load header_footer_tags %}
<head>
...
{% render_header_scripts %}
...
</head>
<body>
...
{% render_footer_scripts %}
...
</body>
This will render both the site-wide and page-specific header/footer scripts dynamically.
Testing
python -m unittest discover tests
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for wagtail-headers-footers 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wagtail_headers_footers-0.1.3.tar.gz | 8.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wagtail_headers_footers-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.5 kB
