wagtail-sb-structblock 0.4.0

Tabbed interface for Wagtail's struct blocks with settings fields.

Wagtail SB Struct Block

Tabbed interface for Wagtail's struct blocks with settings fields.

Package to render Wagtail StructBlock with a tabbed interface to distinguish between content fields and settings fields, improving the editor experience.

✨ Features

• Tabbed Interface: Cleanly separate content fields from settings fields.
• Easy Configuration: Simple to use by subclassing and defining settings_fields in Meta.
• Modern Stack: Built for modern Python (3.11+) and up to date Django/Wagtail versions.

📋 Requirements

• Python 3.11 or higher
• Wagtail 5.2 or higher
• Django 4.2 or higher

📦 Installation

Using pip

pip install wagtail-sb-structblock

Using uv

uv add wagtail-sb-structblock

🚀 Usage

Add wagtail_sb_structblock to your INSTALLED_APPS settings:

INSTALLED_APPS = [
  # ...
  "wagtail_sb_structblock",
  # ...
]

In your struct blocks must inherit from wagtail_sb_structblock.blocks.StructBlock and you must specify the settings_fields in your Meta class.

from wagtail.blocks import CharBlock
from wagtail_sb_structblock.blocks import StructBlock

class EnhancedHTMLBlock(StructBlock):
    text = CharBlock()
    html_attrs = CharBlock()

    class Meta:
        settings_fields = [
            "html_attrs",
        ]

Include it in your stream field and your model so you can use a tabbed interface for your struct block.

🛠️ Development

Check out our Contribution Guide for details on setting up your development environment, running tests, and submitting pull requests.

The project uses uv for dependency management, ruff for linting, and tox for multi-environment testing.

📜 Changelog

See the CHANGELOG.md for a history of changes.

👥 Contributors

See our list of contributors.

📄 License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.