0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs/reference/panel_api.md
Matt Westcott 5521e3b59f Update panel templates for new designs (EditHandler rewrite)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-08-05 10:36:52 +02:00

38 lines
834 B
Markdown

# Panel API
```{eval-rst}
.. module:: wagtail.admin.panels
```
## `Panel`
```{eval-rst}
.. autoclass:: Panel
.. automethod:: bind_to_model
.. automethod:: on_model_bound
.. automethod:: clone
.. automethod:: clone_kwargs
.. automethod:: get_form_options
.. automethod:: get_form_class
.. automethod:: get_bound_panel
.. autoproperty:: clean_name
```
## `BoundPanel`
```{eval-rst}
.. autoclass:: wagtail.admin.panels.Panel.BoundPanel
In addition to the standard template component functionality (see :ref:`creating_template_components`), this provides the following attributes and methods:
.. autoattribute:: panel
.. autoattribute:: instance
.. autoattribute:: request
.. autoattribute:: form
.. autoattribute:: prefix
.. automethod:: id_for_label
.. automethod:: is_shown
```