Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hminnovation/wagtailclearstream

A work-in-progress app to make Wagtail's StreamField more modular
https://github.com/hminnovation/wagtailclearstream

streamfield wagtail

Last synced: 2 months ago
JSON representation

A work-in-progress app to make Wagtail's StreamField more modular

Awesome Lists containing this project

README

        

Note: this project hasn't been updated since 2017 and is no longer maintained. It is likely to break with the latest version of Wagtail.

Wagtail Clear StreamField
============================
This is an amended version of Wagtail's StreamField interface that introduces a new class called `ClearField`

- Improved UI for nested StreamFields
- Always visible help text
- Confirmation on delete of StreamField items

![Screenshot](screenshot1.png)
![Screenshot](screenshot2.png)

Install
-------

- `pip install wagtailclearstream`
- Add `wagtailclearstream` to your installed apps
- Use `from wagtailclearstream import ClearBlock` to import
- Replace `StreamBlock` with `ClearBlock`

Examples
--------

### Separate blocks.py file

```
#blocks.py
from wagtailclearstream import ClearBlock

class GlobalStreamBlock(ClearBlock):
paragraph = RichTextBlock(
icon="pilcrow",
template="blocks/paragraph.html"
)
...

#models.py
from .blocks import GlobalStreamBlock

class ExamplePage(Page):
body = StreamField(
GlobalStreamBlock(), blank=True
)

content_panels = Page.content_panels + [
StreamFieldPanel('body'),
]
```