mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
Code Issues Releases Wiki Activity
5e560a7e1d
wagtail/docs/reference/panel_api.md
Sage Abdullah d696009a36 Revamp panel types documentation and other docs that reference it 
This removes the parameters that come from the base Panel class (e.g.
heading, classname, etc.) from the specific panel types to avoid
repetition. Instead, these parameters are properly documented in the
separate "Panel customisation" section. They are also explicitly listed
in the Panel API reference.
2023-04-18 02:49:04 +01:00

1.0 KiB
Raw Blame History

Panel API

.. module:: wagtail.admin.panels

This document describes the reference API for the base Panel and the BoundPanel classes that are used to render Wagtail's panels. For available panel types and how to use them, see .

Panel

.. 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


.. 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