From 5a8c4edba586784ff5521c19bac82084aed32b75 Mon Sep 17 00:00:00 2001 From: Dan Swain Date: Tue, 12 Nov 2019 09:52:07 -0500 Subject: [PATCH] Documentation - add StreamFieldPanel to available panel types --- docs/reference/pages/panels.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/reference/pages/panels.rst b/docs/reference/pages/panels.rst index 0effad97be..445c744c3d 100644 --- a/docs/reference/pages/panels.rst +++ b/docs/reference/pages/panels.rst @@ -28,6 +28,23 @@ FieldPanel This parameter allows you to specify a :doc:`Django form widget ` to use instead of the default widget for this field type. +StreamFieldPanel +---------------- + +.. class:: StreamFieldPanel(field_name, classname=None, widget=None) + + This is the panel used for Wagtail's StreamField type (see :ref:`streamfield`). + + .. attribute:: FieldPanel.field_name + + This is the name of the class property used in your model definition. + + .. attribute:: FieldPanel.classname (optional) + + This is a string of optional CSS classes given to the panel which are used in formatting and scripted interactivity. By default, panels are formatted as inset fields. + + The CSS class ``full`` can be used to format the panel so it covers the full width of the Wagtail page editor. + MultiFieldPanel ---------------