wagtail_blocks

Build PyPI - License

Downloads Downloads Month Downloads Week

A Collection of awesome Wagtail CMS stream-field blocks and Charts.

Check out Awesome Wagtail for more awesome packages and resources from the Wagtail community.

Quickstart

You must have your Wagtail project up and running:

pip install wagtail_blocks

Add the following enteries to your settings.py in the INSTALLED_APPS section:

'wagtailfontawesomesvg',
'wagtail_blocks',

Sample Usage

from wagtail.fields import StreamField
from wagtail.admin.panels import FieldPanel

from wagtail_blocks.blocks import (
    HeaderBlock,
    ListBlock,
    ImageTextOverlayBlock,
    CroppedImagesWithTextBlock,
    ListWithImagesBlock,
    ThumbnailGalleryBlock,
    ChartBlock,
    MapBlock,
    ImageSliderBlock,
)

class HomePage(Page):
    body = StreamField([
        ('header', HeaderBlock()),
        ('list', ListBlock()),
        ('image_text_overlay', ImageTextOverlayBlock()),
        ('cropped_images_with_text', CroppedImagesWithTextBlock()),
        ('list_with_images', ListWithImagesBlock()),
        ('thumbnail_gallery', ThumbnailGalleryBlock()),
        ('chart', ChartBlock()),
        ('map', MapBlock()),
        ('image_slider', ImageSliderBlock()),
    ], blank=True, use_json_field=True)

    content_panels = Page.content_panels + [
        FieldPanel("body"),
    ]

For HomePage template, blocks should be rendered with IDs to function properly

{% for block in page.body %}
    {% include_block block with block_id=block.id %}
{% endfor %}

Available Blocks

Check Showcase for Standard Blocks or Charts or Maps

streamfield

Header (H1, H2, H3, H4, H5, H6)
List (Unordered List)
Image with Text Overlay
Cropped Images with Text
List with Images and Links
Thumbnail Gallery
Image Slider
Chart (Bar - Pie - Line - Area - Radar)
Map (Marker with rich text description)

Supported Versions

Python 3.8 and higher
Wagtail 4.1 and higher
Bootstrap 4

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_blocks-1.0.1.tar.gz (122.4 kB view details)

Uploaded Aug 7, 2023 Source

File details

Details for the file wagtail_blocks-1.0.1.tar.gz.

File metadata

Download URL: wagtail_blocks-1.0.1.tar.gz
Upload date: Aug 7, 2023
Size: 122.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for wagtail_blocks-1.0.1.tar.gz
Algorithm	Hash digest
SHA256	`211b1b5331ce75be3c3bc50a3a797f332ceba60b58f97c8c7e3f8310efe2e141`
MD5	`a1b4392fb998af4e2b4e11b2534c2c9b`
BLAKE2b-256	`7d6f230eb648ad448295617b4e73492b820936b51a1f5f5a80366b591c310927`