Enabling & customising InspectView
¶
The InspectView
is disabled by default, as it’s not often useful for most
models. However, if you need a view that enables users to view more detailed
information about an instance without the option to edit it, you can easily
enable the inspect view by setting inspect_view_enabled=True
on your
ModelAdmin
class.
When InspectView
is enabled, an ‘Inspect’ button will automatically appear for each row in
your index / listing view, linking to a new page that shows a list of
field values for that particular object.
By default, all ‘concrete’ fields (where the field value is stored as a column
in the database table for your model) will be shown. You can customise what
values are displayed by adding the following attributes to your ModelAdmin
class:
ModelAdmin.inspect_view_fields
¶
Expected value: A list or tuple, where each item is the name of a field
or attribute on the instance that you’d like InspectView
to render.
A sensible value will be rendered for most field types.
If you have wagtail.images
installed, and the value happens to be an
instance of wagtailimages.models.Image
(or a custom model that subclasses
wagtailimages.models.AbstractImage
), a thumbnail of that image will be
rendered.
If you have wagtail.documents installed, and the value happens to be an
instance of wagtaildocs.models.Document (or a custom model that subclasses
wagtaildocs.models.AbstractDocument
), a link to that document will be
rendered, along with the document title, file extension and size.
ModelAdmin.inspect_view_fields_exclude
¶
Expected value: A list or tuple, where each item is the name of a field
that you’d like to exclude from InspectView
Note: If both inspect_view_fields
and inspect_view_fields_exclude
are set, inspect_view_fields_exclude
will be ignored.
ModelAdmin.inspect_view_extra_css
¶
Expected value: A list of path names of additional stylesheets to be added
to the InspectView
See the following part of the docs to find out more: Adding additional stylesheets and/or JavaScript
ModelAdmin.inspect_view_extra_js
¶
Expected value: A list of path names of additional js files to be added
to the InspectView
See the following part of the docs to find out more: Adding additional stylesheets and/or JavaScript
ModelAdmin.inspect_template_name
¶
Expected value: The path to a custom template to use for InspectView
See the following part of the docs to find out more: Overriding templates
ModelAdmin.inspect_view_class
¶
Expected value: A custom view
class to replace
modeladmin.views.InspectView
See the following part of the docs to find out more: Overriding views