Skip to main content

Model choosers for Wagtail admin

Project description

A plugin for Wagtail that provides a ModelChooserPanel and ModelChooserBlock 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 1.4 and upwards.

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 ModelChooserPanel 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, StreamFieldPanel
from wagtailmodelchooser.blocks import ModelChooserBlock
from wagtailmodelchooser.edit_handlers import ModelChooserPanel

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

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

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

    content_panels = [
        StreamFieldPanel('body'),
    ]

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-2.0.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

wagtail_modelchooser-2.0.0-py2.py3-none-any.whl (12.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for wagtail-modelchooser-2.0.0.tar.gz
Algorithm Hash digest
SHA256 8bb660ce840a53a58ece599dd3692d01857dc6c456aecd612d32b53e89c1c073
MD5 ad0236f201bec865f9d761829d48af25
BLAKE2b-256 03002e0f8ecff80ce5fd0d6086a36f85dbb522731a35f170e9d0f68d2b8a980b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wagtail_modelchooser-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ecbc24d0cd0f55fd8ab0c98e4dc39ed6f18060a6a03522a538223ac3cb1308af
MD5 564aa8c9fcef2a787eff9b4c7cfef23a
BLAKE2b-256 62e54bd309331c2b63174ac2bc161725f6da1e7bb3e1d257d19ce2b19563b0e8

See more details on using hashes here.

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