Skip to content
This repository has been archived by the owner on Jan 6, 2022. It is now read-only.

Latest commit

 

History

History
64 lines (42 loc) · 2.21 KB

README.rst

File metadata and controls

64 lines (42 loc) · 2.21 KB

No longer maintained: Features have been merged into Wagtail see 2.13 Release Notes.

Wagtail React StreamField

Drop-in replacement for the StreamField in Wagtail.

This work was funded thanks to a Kickstarter campaign!

It relies on react-streamfield, a React package created for the occasion.

This work is currently in beta phase and will in the end be merged in Wagtail. You should be careful and manually check that it works for your own StreamField and report any bug you find.

Requirements

Wagtail 2.6 or above.

Getting started

It’s really easy to setup, like most NoriPyt packages:

  • pip install wagtail-react-streamfield
  • Add 'wagtail_react_streamfield', to your INSTALLED_APPS before 'wagtail.admin', 'wagtail.images', 'wagtail.docs' & 'wagtail.snippets'

That’s it!

Usage

wagtail-react-streamfield has the same class API as the regular StreamField. What changes:

Meta attributes (or passed to __init__)

closed
Set to True to close all blocks of this type when loading the page. Defaults to False.

Screenshots

https://raw.github.com/noripyt/wagtail-react-streamfield/master/wagtail-react-streamfield-screenshot-1.png

https://raw.github.com/noripyt/wagtail-react-streamfield/master/wagtail-react-streamfield-screenshot-2.png

https://raw.github.com/noripyt/wagtail-react-streamfield/master/wagtail-react-streamfield-screenshot-3.png