Skip to content

Commit a47e079

Browse files
committed
updarte docs
1 parent 10f1552 commit a47e079

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/api/advanced_configuration.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,45 @@ Versioning modifies how the admin of the :term:`content model <content model>` w
179179
),
180180
]
181181
182+
grouper_admin_mixin
183+
++++++++++++++++++++
184+
This option allows you to customize the admin interface for the
185+
:term:`grouper model <grouper model>` by providing a custom ModelAdmin mixin.
186+
By default, versioning uses the standard admin, but you can override or extend
187+
its behavior using this setting.
188+
189+
To use, define your mixin class and set it on the `VersionableItem`:
190+
191+
.. code-block:: python
192+
193+
# some_app/cms_config.py
194+
from cms.app_base import CMSAppConfig
195+
from djangocms_versioning.datastructures import VersionableItem
196+
197+
class CustomGrouperAdminMixin:
198+
# Override ModelAdmin methods or attributes as needed
199+
def has_delete_permission(self, request, obj=None):
200+
return False
201+
202+
class SomeCMSConfig(CMSAppConfig):
203+
djangocms_versioning_enabled = True
204+
versioning = [
205+
VersionableItem(
206+
....,
207+
grouper_admin_mixin=CustomGrouperAdminMixin,
208+
),
209+
]
210+
211+
This mixin will be applied to the admin for the grouper model registered by
212+
versioning, allowing you to customize permissions, list display, or any other
213+
admin behavior.
214+
215+
Selecting the string ``"__default__"`` will use the
216+
:class:`djangocms_versioning.admin.DefaultGrouperVersioningAdminMixin`
217+
which combines the functionality of the
218+
:class:`djangocms_versioning.admin.StateIndicatorMixin` and the
219+
:class:`djangocms_versioning.admin.ExtendedGrouperVersionAdminMixin.
220+
182221
extended_admin_field_modifiers
183222
++++++++++++++++++++++++++++++
184223
These allow for the alteration of how a field is displayed, by providing a method,

0 commit comments

Comments
 (0)