Customization Guide

class CaptionedImageBlock(StructBlock):
    """
    Custom `StructBlock` for utilizing images with associated caption and
    attribution data
    """
    image = ImageChooserBlock(required=True)
    caption = CharBlock(required=False)
    attribution = CharBlock(required=False)

    class Meta:
        icon = "image"
        template = "blocks/captioned_image_block.html"
        preview_value = {"attribution": "The Wagtail Bakery"}
        description = "An image with optional caption and attribution"

class HeadingBlock(StructBlock):
    """
    Custom `StructBlock` that allows the user to select h2 - h4 sizes for headers
    """
    heading_text = CharBlock(classname="title", required=True)
    size = ChoiceBlock(
        choices=[
            ("", "Select a header size"),
            ("h2", "H2"),
            ("h3", "H3"),
            ("h4", "H4"),
        ],
        blank=True,
        required=False,
    )

    class Meta:
        icon = "title"
        template = "blocks/heading_block.html"
        preview_value = {"heading_text": "Healthy bread types", "size": "h2"}
        description = "A heading with level two, three, or four"

class BlockQuote(StructBlock):
    """
    Custom `StructBlock` that allows the user to attribute a quote to the author
    """
    text = TextBlock()
    attribute_name = CharBlock(blank=True, required=False, label="e.g. Mary Berry")
    settings = ThemeSettingsBlock(collapsed=True)

    class Meta:
        icon = "openquote"
        template = "blocks/blockquote.html"
        preview_value = {
            "text": (
                "If you read a lot you're well read / "
                "If you eat a lot you're well bread."
            ),
            "attribute_name": "Willie Wagtail",
        }
        description = "A quote with an optional attribution"

class ThemeSettingsBlock(StructBlock):
    theme = ChoiceBlock(
        choices=[
            ("default", "Default"),
            ("highlight", "Highlight"),
        ],
        required=False,
        default="default",
    )
    text_size = ChoiceBlock(
        choices=[
            ("default", "Default"),
            ("large", "Large"),
        ],
        required=False,
        default="default",
    )

    class Meta:
        icon = "cog"
        label_format = "Theme: {theme}, Text size: {text_size}"

from wagtail import hooks

@hooks.register("register_icons")
def register_icons(icons):
    return icons + [
        "wagtailfontawesomesvg/solid/suitcase.svg",
        "wagtailfontawesomesvg/solid/utensils.svg",
    ]

from wagtail.admin.userbar import AccessibilityItem

class CustomAccessibilityItem(AccessibilityItem):
    axe_run_only = None

@hooks.register("construct_wagtail_userbar")
def replace_userbar_accessibility_item(request, items, page):
    items[:] = [
        CustomAccessibilityItem() if isinstance(item, AccessibilityItem) else item
        for item in items
    ]

from wagtail.snippets.views.snippets import SnippetViewSet
from wagtail.snippets.models import register_snippet

class PersonViewSet(SnippetViewSet):
    model = Person
    menu_label = "People"
    icon = "group"
    list_display = ("first_name", "last_name", "job_title", "thumb_image")
    list_export = ("first_name", "last_name", "job_title")
    filterset_class = PersonFilterSet

# Group multiple ViewSets
class BakerySnippetViewSetGroup(SnippetViewSetGroup):
    menu_label = "Bakery Misc"
    menu_icon = "utensils"
    menu_order = 300
    items = (PersonViewSet, FooterTextViewSet)

register_snippet(BakerySnippetViewSetGroup)

from wagtail.admin.viewsets.pages import PageListingViewSet
from django.utils.functional import classproperty

class BreadPageListingViewSet(PageListingViewSet):
    menu_icon = "folder-open-inverse"
    menu_label = "Bread pages"
    model = BreadPage
    filterset_class = BreadPageFilterSet

    @classproperty
    def columns(cls):
        # Replace the parent column with a custom origin column
        origin_column = Column("origin", sort_key="origin", width="12%")
        return [
            col if col.name != "parent" else origin_column for col in super().columns
        ]

from django_filters.filters import ModelChoiceFilter, ModelMultipleChoiceFilter
from wagtail.admin.views.pages.listing import PageFilterSet

class BreadPageFilterSet(PageFilterSet):
    origin = ModelChoiceFilter(
        queryset=Country.objects.all(),
        widget=RadioSelect
    )
    bread_type = ModelMultipleChoiceFilter(
        queryset=BreadType.objects.all(),
        widget=CheckboxSelectMultiple,
    )
    ingredients = ModelMultipleChoiceFilter(
        queryset=BreadIngredient.objects.all(),
        widget=CheckboxSelectMultiple,
    )

    class Meta:
        model = BreadPage
        fields = []

from wagtail.admin.viewsets.model import ModelViewSet

class CountryModelViewSet(ModelViewSet):
    model = Country
    ordering = "title"
    search_fields = ("title",)
    icon = "globe"
    inspect_view_enabled = True
    sort_order_field = "sort_order"  # Enables drag-and-drop

    panels = [
        FieldPanel("title"),
    ]