Skip to main content

Model choosers for Wagtail admin

Project description

A plugin for Wagtail that provides convenience methods for setting up chooser modals for arbitrary models.

Installing

Install using pip:

pip install wagtail-modelchooser

Then add it to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'wagtailmodelchooser',
    # ...
]

It works with Wagtail 4.0 and upwards. For older versions of Wagtail check previous versions of the package.

Quick start

To enable the chooser for your model, you must register the model. For simple cases, decorate your model with @register_model_chooser:

from django.db import models

from wagtailmodelchooser import register_model_chooser


@register_model_chooser
class Author(models.Model):
    name = models.CharField(max_length=255)

    def __str__(self):
        # The ``str()`` of your model will be used in the chooser
        return self.name

You can then use either FieldPanel in an edit handler definition, or ModelChooserBlock in a StreamField definition:

from wagtail.wagtailcore.blocks import RichTextBlock
from wagtail.wagtailcore.fields import StreamField
from wagtail.wagtailcore.models import Page
from wagtail.wagtailadmin.edit_handlers import FieldPanel
from wagtailmodelchooser.blocks import ModelChooserBlock

class Book(Page):
    name = models.CharField(max_length=255)
    author = models.ForeignKey(Author)

    content_panels = [
        FieldPanel('name'),
        FieldPanel('author'),
    ]

class ContentPage(Page):
    body = StreamField([
        ('text', RichTextBlock()),
        ('author', ModelChooserBlock('books.Author')),
    ])

    content_panels = [
        StreamFieldPanel('body'),
    ]

Customisation options

If you want to customize the content or behaviour of the model chooser modal you have several options. These are illustrated through some examples below.

If you wanted to add an additional filter field to the popup, you might do that as follows:

from django.db import models

from wagtailmodelchooser import register_model_chooser, Chooser


class City(models.Model):
    name = models.CharField(max_length=255)
    capital = models.BooleanField()

    def __str__(self):
        # The ``str()`` of your model will be used in the chooser
        return self.name

@register_model_chooser
class CityChooser(Chooser):
    model = City
    modal_template = 'app_name/city_modal.html'
    modal_results_template = 'app_name/city_modal_results.html'

    def get_queryset(self, request):
        qs = super().get_queryset(request)
        if request.GET.get('capital'):
            qs = qs.filter(capital=request.GET.get('capital') == '0')

        return qs

Since wagtailmodelchooser is built largely on the ChooserViewSet functionality already found in Wagtail, if you wish to do deeper customisation it is recommended to use that feature directly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail-modelchooser-4.0.1.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

wagtail_modelchooser-4.0.1-py2.py3-none-any.whl (12.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wagtail-modelchooser-4.0.1.tar.gz.

File metadata

  • Download URL: wagtail-modelchooser-4.0.1.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for wagtail-modelchooser-4.0.1.tar.gz
Algorithm Hash digest
SHA256 ec1c9c7598cdc019683c7e93ed95b0acf1d32b9b24e8a564b8f373bf48a9ed36
MD5 a7f90b3fa3cf387c4ea85ac1456fce1f
BLAKE2b-256 cb161609db0fb3d7aaac1693424f6aafa6af90dbcd6f49295aae93739faeeabc

See more details on using hashes here.

Provenance

File details

Details for the file wagtail_modelchooser-4.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_modelchooser-4.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b7ea0fb81cdd7367ed90dff043289e264502d97a9297b7fb69c148a0a81cee6a
MD5 3b1c1e5f1d1946603edb89e0b709684a
BLAKE2b-256 6f62bf5d063ae5bd3e9ddfca750da1e22c3f57779a34ace1e864c672b580ad33

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page