https://github.com/ibrahimawadhamid/wagtail_blocks

A Collection of awesome Wagtail CMS stream-field blocks and Charts.
https://github.com/ibrahimawadhamid/wagtail_blocks

Last synced: 10 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ibrahimawadhamid/wagtail_blocks
• Owner: ibrahimawadhamid
• License: mit
• Created: 2019-03-31T07:20:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T07:01:04.000Z (6 months ago)
• Last Synced: 2024-10-29T01:19:51.184Z (14 days ago)
• Language: HTML
• Homepage: https://wagtail-blocks.readthedocs.io
• Size: 7.19 MB
• Stars: 76
• Watchers: 4
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wagtail - Wagtail Blocks - A Collection of awesome Wagtail CMS stream-field blocks and Charts. (Apps / StreamField)

README

        
# wagtail_blocks ![wagtail](https://img.shields.io/badge/CMS-Wagtail-green.svg)

[![PyPI](https://img.shields.io/pypi/v/wagtail-blocks.svg)](https://pypi.python.org/pypi/wagtail-blocks) ![Build](https://img.shields.io/pypi/status/wagtail-blocks.svg) [![Documentation Status](https://readthedocs.org/projects/wagtail-blocks/badge/?version=latest)](https://wagtail-blocks.readthedocs.io/en/latest/?badge=latest) ![PyPI - License](https://img.shields.io/pypi/l/wagtail-blocks.svg)

![Downloads](https://static.pepy.tech/badge/wagtail-blocks) ![Downloads Month](https://static.pepy.tech/badge/wagtail-blocks/month) ![Downloads Week](https://static.pepy.tech/badge/wagtail-blocks/week)

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

*Check out [Awesome Wagtail](https://github.com/springload/awesome-wagtail) for more awesome packages and resources from the Wagtail community.*

## Quickstart

You must have your [Wagtail](https://wagtail.io/) project up and running:

```sh

pip install wagtail_blocks

```

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

```python

'wagtailfontawesomesvg',

'wagtail_blocks',

```

## Sample Usage

```python

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

```html

{% for block in page.body %}

    {% include_block block with block_id=block.id %}

{% endfor %}

```

## Available Blocks

Check Showcase for [Standard Blocks](docs/showcase/standard-blocks.md) or [Charts](docs/showcase/chart.md) or [Maps](docs/showcase/map.md)

![streamfield](docs/showcase/screenshots/streamfield-v5.PNG)

- 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 < 6.0

- Bootstrap 4