wagtail/docs/reference/viewsets.md

(viewsets_reference)=

Viewsets

Viewsets are Wagtail's mechanism for defining a group of related admin views with shared properties, as a single unit.

ViewSet

.. autoclass:: wagtail.admin.viewsets.base.ViewSet

   .. autoattribute:: name
   .. autoattribute:: url_prefix
   .. autoattribute:: url_namespace
   .. automethod:: on_register
   .. automethod:: get_urlpatterns
   .. automethod:: get_url_name
   .. autoattribute:: icon
   .. autoattribute:: menu_icon

      Defaults to :attr:`icon`.

   .. autoattribute:: menu_label
   .. autoattribute:: menu_name
   .. autoattribute:: menu_order
   .. autoattribute:: menu_url

      Defaults to the first URL returned by :meth:`get_urlpatterns`.

   .. autoattribute:: menu_item_class
   .. autoattribute:: menu_hook
   .. autoattribute:: add_to_admin_menu
   .. autoattribute:: add_to_settings_menu
   .. automethod:: get_menu_item

ViewSetGroup

.. autoclass:: wagtail.admin.viewsets.base.ViewSetGroup

   .. attribute:: items
      :value: ()

      A list or tuple of :class:`~wagtail.admin.viewsets.base.ViewSet` classes or instances to be grouped together.

   .. autoattribute:: menu_icon
   .. autoattribute:: menu_label
   .. autoattribute:: menu_name
   .. autoattribute:: menu_order
   .. autoattribute:: menu_item_class
   .. autoattribute:: add_to_admin_menu
   .. automethod:: get_menu_item

ModelViewSet

.. autoclass:: wagtail.admin.viewsets.model.ModelViewSet

   .. attribute:: model

   Required; the model class that this viewset will work with. The ``model_name`` will be used
   as the URL prefix and namespace, unless these are specified explicitly via the :attr:`~.ViewSet.name`, :attr:`~.ViewSet.url_prefix` or
   :attr:`~.ViewSet.url_namespace` attributes.

   .. attribute:: form_fields

   A list of model field names that should be included in the create / edit forms.

   .. attribute:: exclude_form_fields

   Used in place of :attr:`form_fields` to indicate that all of the model's fields except the ones listed here should appear in the create / edit forms. Either ``form_fields`` or ``exclude_form_fields`` must be supplied (unless :meth:`get_form_class` is being overridden).

   .. automethod:: get_form_class
   .. automethod:: get_edit_handler
   .. automethod:: get_permissions_to_register

   .. autoattribute:: menu_label

      Defaults to the title-cased version of the model's
      :attr:`~django.db.models.Options.verbose_name_plural`.

   .. autoattribute:: add_to_reference_index
   .. autoattribute:: ordering
   .. autoattribute:: list_per_page
   .. autoattribute:: list_display
   .. autoattribute:: list_export
   .. autoattribute:: list_filter
   .. autoattribute:: filterset_class
   .. autoattribute:: export_headings
   .. autoattribute:: export_filename
   .. autoattribute:: search_fields
   .. autoattribute:: search_backend_name
   .. autoattribute:: copy_view_enabled
   .. autoattribute:: inspect_view_enabled
   .. autoattribute:: inspect_view_fields
   .. autoattribute:: inspect_view_fields_exclude
   .. autoattribute:: index_view_class
   .. autoattribute:: add_view_class
   .. autoattribute:: edit_view_class
   .. autoattribute:: delete_view_class
   .. autoattribute:: usage_view_class
   .. autoattribute:: history_view_class
   .. autoattribute:: copy_view_class
   .. autoattribute:: inspect_view_class
   .. autoattribute:: template_prefix
   .. autoattribute:: index_template_name
   .. autoattribute:: index_results_template_name
   .. autoattribute:: create_template_name
   .. autoattribute:: edit_template_name
   .. autoattribute:: delete_template_name
   .. autoattribute:: history_template_name
   .. autoattribute:: inspect_template_name

ModelViewSetGroup

.. autoclass:: wagtail.admin.viewsets.model.ModelViewSetGroup

   .. autoattribute:: menu_label

      If unset, defaults to the title-cased version of the model's
      :attr:`~django.db.models.Options.app_label` from the first viewset.

ChooserViewSet

.. autoclass:: wagtail.admin.viewsets.chooser.ChooserViewSet

   .. attribute:: model

   Required; the model class that this viewset will work with.

   .. autoattribute:: icon
   .. autoattribute:: choose_one_text
   .. autoattribute:: page_title
   .. autoattribute:: choose_another_text
   .. autoattribute:: edit_item_text
   .. autoattribute:: per_page
   .. autoattribute:: preserve_url_parameters
   .. autoattribute:: url_filter_parameters
   .. autoattribute:: choose_view_class
   .. autoattribute:: choose_results_view_class
   .. autoattribute:: chosen_view_class
   .. autoattribute:: chosen_multiple_view_class
   .. autoattribute:: create_view_class
   .. autoattribute:: base_widget_class
   .. autoattribute:: widget_class
   .. autoattribute:: widget_telepath_adapter_class
   .. autoattribute:: register_widget
   .. autoattribute:: base_block_class
   .. automethod:: get_block_class
   .. autoattribute:: creation_form_class
   .. autoattribute:: form_fields
   .. autoattribute:: exclude_form_fields
   .. autoattribute:: create_action_label
   .. autoattribute:: create_action_clicked_label
   .. autoattribute:: creation_tab_label
   .. autoattribute:: search_tab_label
   .. method:: get_object_list

      Returns a queryset of objects that are available to be chosen. By default, all instances of ``model`` are returned.

SnippetViewSet

.. autoclass:: wagtail.snippets.views.snippets.SnippetViewSet

   .. autoattribute:: model
   .. autoattribute:: chooser_per_page
   .. autoattribute:: admin_url_namespace
   .. autoattribute:: base_url_path
   .. autoattribute:: chooser_admin_url_namespace
   .. autoattribute:: chooser_base_url_path
   .. autoattribute:: index_view_class
   .. autoattribute:: add_view_class
   .. autoattribute:: edit_view_class
   .. autoattribute:: delete_view_class
   .. autoattribute:: usage_view_class
   .. autoattribute:: history_view_class
   .. autoattribute:: copy_view_class
   .. autoattribute:: inspect_view_class
   .. autoattribute:: revisions_view_class
   .. autoattribute:: revisions_revert_view_class
   .. autoattribute:: revisions_compare_view_class
   .. autoattribute:: revisions_unschedule_view_class
   .. autoattribute:: unpublish_view_class
   .. autoattribute:: preview_on_add_view_class
   .. autoattribute:: preview_on_edit_view_class
   .. autoattribute:: lock_view_class
   .. autoattribute:: unlock_view_class
   .. autoattribute:: chooser_viewset_class
   .. automethod:: get_queryset
   .. automethod:: get_edit_handler
   .. automethod:: get_index_template
   .. automethod:: get_index_results_template
   .. automethod:: get_create_template
   .. automethod:: get_edit_template
   .. automethod:: get_delete_template
   .. automethod:: get_history_template
   .. automethod:: get_inspect_template
   .. automethod:: get_admin_url_namespace
   .. automethod:: get_admin_base_path
   .. automethod:: get_chooser_admin_url_namespace
   .. automethod:: get_chooser_admin_base_path

SnippetViewSetGroup

.. autoclass:: wagtail.snippets.views.snippets.SnippetViewSetGroup

PageListingViewSet

.. autoclass:: wagtail.admin.viewsets.pages.PageListingViewSet

   .. autoattribute:: model
   .. autoattribute:: index_view_class
   .. autoattribute:: choose_parent_view_class
   .. autoattribute:: columns
   .. autoattribute:: filterset_class