Skip to main content

Wagtailblock Register

Usage

Add in settings.py.

# Default WAGTAILBLOCK_COLLECTOR = "blocks"
WAGTAILBLOCK_COLLECTOR = "itemblocks"

String in WAGTAILBLOCK_COLLECTOR is a file. Default collector file is blocks.py.

Wagtailblock register will search for the file.

Add block to collector

Above each block in the collectors file add @register_block

Example:

from wagtailblock_register import register_block
from wagtail.core import blocks
from wagtail.images.blocks import ImageChooserBlock

@register_block
class ImageTextBlock(blocks.StructBlock):
    ...

Call all blocks in models.py

Example:

from wagtail.core.models import Page
from wagtail.core.fields import StreamField

from wagtailblock_register import call_blocks


class ContentPage(Page):
    body = StreamField(call_blocks(), null=True)
    ...

Group blocks

Add list_group with a group name to the block. This property will group your blocks in diffrent groups. The block will be in the group you defined. Default group is default. This property is usefull if you want to use multiple streamfields.

Example:

from wagtailblock_register import register_block
from wagtail.core import blocks
from wagtail.images.blocks import ImageChooserBlock

@register_block
class ImageTextBlock(blocks.StructBlock):
    list_group = "first"
    ...

Metadata

Release files for wagtailblock-register 1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtailblock-register 1.7
File Size Uploaded
wagtailblock-register-1.7.tar.gz 2.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wagtailblock-register 1.7
File Interpreter ABI Platform
wagtailblock_register-1.7-py3-none-any.whl Python 3 none any Details

Total release size: 6.5 kB

Release files / wagtailblock-register-1.7.tar.gz

Download URL wagtailblock-register-1.7.tar.gz
Size 2.9 kB
Tags Source
SHA-256 checksum
How to use checksums
9f8386677201b46db0e02270f19535f513c9a0e632dc58397c6759d4ccadc4fb
BLAKE2b-256 checksum
How to use checksums
fea9439513566f548da82df800b26ad2a8e45dc0817136f7474f66579749427d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Release files / wagtailblock_register-1.7-py3-none-any.whl

Download URL wagtailblock_register-1.7-py3-none-any.whl
Size 3.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5fcd3069f45bfc4711fa8bf4a3c31e90e3a940a074f3a01dce1c742fe22a4cbd
BLAKE2b-256 checksum
How to use checksums
f328af314d7e78f660fe2a734b48c3a6b5f8aa21a52abe60a5e188dd33c227f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Release history Release notifications | RSS feed

This release

1.7 This release

2 release files

1.6

2 release files

1.3

2 release files

1.2

2 release files

1.1

2 release files

1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page