mirror
/
wagtail
kopia lustrzana https://github.com/wagtail/wagtail
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Add StreamField context to block examples

pull/6947/head
Matt Westcott 2021-03-23 18:23:51 +00:00 zatwierdzone przez Matt Westcott
rodzic 9f084fff6d
commit 3e2c928e2f
1 zmienionych plików z 42 dodań i 27 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

69
docs/reference/streamfield/blocks.rst
Wyświetl plik

@ -373,12 +373,15 @@ Structural block types
.. code-block:: python .. code-block:: python
('person', blocks.StructBlock([ body = StreamField([
('first_name', blocks.CharBlock()), # ...
('surname', blocks.CharBlock()), ('person', blocks.StructBlock([
('photo', ImageChooserBlock(required=False)), ('first_name', blocks.CharBlock()),
('biography', blocks.RichTextBlock()), ('surname', blocks.CharBlock()),
], icon='user')) ('photo', ImageChooserBlock(required=False)),
('biography', blocks.RichTextBlock()),
], icon='user')),
])
Alternatively, StructBlock can be subclassed to specify a reusable set of sub-blocks: Alternatively, StructBlock can be subclassed to specify a reusable set of sub-blocks:
@ -421,17 +424,23 @@ Structural block types
.. code-block:: python .. code-block:: python
('ingredients_list', blocks.ListBlock(blocks.CharBlock(label="Ingredient"))) body = StreamField([
# ...
('ingredients_list', blocks.ListBlock(blocks.CharBlock(label="Ingredient"))),
])
Any block type is valid as the sub-block type, including structural types: Any block type is valid as the sub-block type, including structural types:
.. code-block:: python .. code-block:: python
('ingredients_list', blocks.ListBlock(blocks.StructBlock([ body = StreamField([
('ingredient', blocks.CharBlock()), # ...
('amount', blocks.CharBlock(required=False)), ('ingredients_list', blocks.ListBlock(blocks.StructBlock([
]))) ('ingredient', blocks.CharBlock()),
('amount', blocks.CharBlock(required=False)),
]))),
])
The following additional option is available as either a keyword argument or a Meta class attribute: The following additional option is available as either a keyword argument or a Meta class attribute:
@ -444,17 +453,20 @@ Structural block types
.. code-block:: python .. code-block:: python
('carousel', blocks.StreamBlock( body = StreamField([
[ # ...
('image', ImageChooserBlock()), ('carousel', blocks.StreamBlock(
('quotation', blocks.StructBlock([ [
('text', blocks.TextBlock()), ('image', ImageChooserBlock()),
('author', blocks.CharBlock()), ('quotation', blocks.StructBlock([
])), ('text', blocks.TextBlock()),
('video', EmbedBlock()), ('author', blocks.CharBlock()),
], ])),
icon='cogs' ('video', EmbedBlock()),
)) ],
icon='cogs'
)),
])
As with StructBlock, the list of sub-blocks can also be provided as a subclass of StreamBlock: As with StructBlock, the list of sub-blocks can also be provided as a subclass of StreamBlock:
@ -490,12 +502,15 @@ Structural block types
:param form_classname: An HTML ``class`` attribute to set on the root element of this block as displayed in the editing interface. :param form_classname: An HTML ``class`` attribute to set on the root element of this block as displayed in the editing interface.
.. code-block:: python .. code-block:: python
:emphasize-lines: 4 :emphasize-lines: 6
('event_promotions', blocks.StreamBlock([ body = StreamField([
('hashtag', blocks.CharBlock()), # ...
('post_date', blocks.DateBlock()), ('event_promotions', blocks.StreamBlock([
], form_classname='event-promotions')) ('hashtag', blocks.CharBlock()),
('post_date', blocks.DateBlock()),
], form_classname='event-promotions')),
])
.. code-block:: python .. code-block:: python
:emphasize-lines: 6 :emphasize-lines: 6