A collection of reusable, production-ready content blocks for Wagtail CMS, styled with Tailwind CSS and daisyUI.
Project description
wagtail-tw-blocks
Overview
wagtail-tw-blocks is a collection of reusable, production-ready content blocks for Wagtail CMS, styled with Tailwind CSS and daisyUI. It provides a set of common UI components—ready to drop into your StreamField—so you can build rich, modern page layouts without reinventing the wheel.
Available blocks
- Accordion (Collapse): Expandable/collapsible sections for FAQs or structured content.
- Alert: Highlight important messages or status updates.
- Carousel: Image or content slider with responsive design.
- Code: Syntax-highlighted code snippets for technical content (Requires
highlight.jsandclipboard.jsto be included in your page). - Diff: Side-by-side or inline difference highlighting for image comparisons.
- FAB: Floating Action Button with multiple action items.
- Hover Gallery: Image gallery with hover effects.
- List: Ordered lists with custom styling.
- Steps: Step-by-step process indicators.
- Tabs: Tabbed content sections.
- Timeline: Chronological event listings.
- Toast: Temporary notification messages.
Installation
pip install wagtail-tw-blocks
Configuration
Add wagtail_blocks to your INSTALLED_APPS after configuring your Wagtail settings:
# project/settings.py
INSTALLED_APPS = [
"wagtail_blocks",
# ...
]
Available settings
You can customize the behavior of wagtail-tw-blocks by adding the following settings to your Django settings file:
# project/settings.py
# Extend or override the default programming languages for the CodeBlock
WAGTAIL_BLOCKS_PROGRAMMING_LANGUAGES = [
('python', 'Python'),
('javascript', 'JavaScript'),
('html', 'HTML'),
('css', 'CSS'),
('java', 'Java'),
('csharp', 'C#'),
('cpp', 'C++'),
('ruby', 'Ruby'),
('go', 'Go'),
('php', 'PHP'),
# ...
]
# Show or hide the programming language label in the CodeBlock
WAGTAIL_BLOCKS_SHOW_PROGRAMMING_LANGUAGE = True # Default is True
# Show or hide the copy button in the CodeBlock
WAGTAIL_BLOCKS_SHOW_COPY_BUTTON = True # Default is True
# Show or hide window control buttons in the CodeBlock
WAGTAIL_BLOCKS_SHOW_WINDOW_CONTROLS = True # Default is True
Usage example
# blog/models.py
from wagtail_blocks import blocks
from wagtail.admin.panels import FieldPanel
from wagtail.fields import StreamField
from wagtail.models import Page
from django.utils.translation import gettext_lazy as _
class Article(Page):
content = StreamField(
[
("accordion", blocks.AccordionBlock()),
("alert", blocks.AlertBlock()),
("carousel", blocks.CarouselBlock()),
("code", blocks.CodeBlock()),
("diff", blocks.DiffBlock()),
# ...
],
help_text=_("Article content"),
)
content_panels = Page.content_panels + [
FieldPanel("content"),
# ...
]
<!-- blog/base.html -->
<!doctype html>
<html data-theme="luxury">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Wagtail Blocks Usage Example</title>
<!--
Do not use in production.
See:
- https://tailwindcss.com/docs/installation
-->
<link href="https://cdn.jsdelivr.net/npm/daisyui@5" rel="stylesheet" type="text/css" />
<link href="https://cdn.jsdelivr.net/npm/daisyui@5/themes.css" rel="stylesheet" type="text/css" />
<script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>
<!-- Code highlighting for CodeBlock -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/highlight.min.js"></script>
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/github-dark.min.css"
/>
<script>hljs.highlightAll();</script>
<!-- If you already using TailwindCSS and daisyUI you can include -->
{% load static %}
<link href="{% static 'wagtail_blocks/css/styles.css' %}" rel="stylesheet" type="text/css" />
</head>
<body>
<!--
Requires TailwindCSS Typography plugin.
"@tailwindcss/typography": https://github.com/tailwindlabs/tailwindcss-typography
-->
<main class="prose mx-auto prose-sm prose-video:rounded-box xl:prose-lg 2xl:prose-xl prose-headings:text-primary prose-img:rounded-box prose-img:w-full">
{{ article.content }}
</main>
<!-- Lucide icons -->
<script src="https://unpkg.com/lucide@latest"></script>
<script>lucide.createIcons();</script>
<!-- For copy buttons in CodeBlock -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.11/clipboard.min.js"></script>
<script>const btns = new ClipboardJS(".btn-copy");</script>
</body>
</html>
Key features
- Modern design: Tailwind CSS + daisyUI styling for clean, responsive layouts.
- Multiple themes: All daisyUI themes included, with easy customization.
- CI/CD: GitHub Actions pipelines for automated testing and deployment.
- Dependency management: Poetry for reproducible, maintainable installs.
- Code formatting: Black for consistent, automatic formatting.
- Linting: Ruff for fast, comprehensive linting.
- Testing: Django test runner for unit and integration tests.
- Starter configs:
.gitignore,pyproject.toml, and other essentials included.
Extending
You can easily extend or customize the provided blocks by subclassing them. For example, to create a custom alert block with additional styles:
from wagtail_blocks import blocks
class CustomAlertBlock(blocks.AlertBlock):
class Meta:
template = "path/to/your/custom_alert_template.html"
icon = "warning"
label = "Custom Alert"
Contributing
We welcome community contributions. See the CONTRIBUTING guide for setup instructions, coding standards, and workflow. Opening an issue before major changes helps align on scope and direction.
Support
For questions, bug reports, or feature requests, open an issue or join the conversation in GitHub Discussions.
License
Licensed under the MIT License. See the LICENSE file for details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wagtail_tw_blocks-0.2.1.tar.gz.
File metadata
- Download URL: wagtail_tw_blocks-0.2.1.tar.gz
- Upload date:
- Size: 39.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.0 CPython/3.12.3 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e747bcd8284773680093fad37dbdf1d3d877e79cfca1cbb7b29ae9f2eacac6a3
|
|
| MD5 |
76bf8ab6b7a518c020cd64c66a2457f2
|
|
| BLAKE2b-256 |
307d751fd622c0644766711f4fd7d9097805f717d1791cfdbef6adbb703bd6fc
|
File details
Details for the file wagtail_tw_blocks-0.2.1-py3-none-any.whl.
File metadata
- Download URL: wagtail_tw_blocks-0.2.1-py3-none-any.whl
- Upload date:
- Size: 43.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.0 CPython/3.12.3 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e40bf0c8d7eb8eed754c551c052b9c41eae5ff1eb8de9e658153c1fc9270aa6a
|
|
| MD5 |
56b857069e393d35c45a6440821f68e7
|
|
| BLAKE2b-256 |
de2952a1ae8cf1d82cc974b5c2b4fbec6751c39365385f3d7bbe92c8cccec505
|
