wagtail-modelchooser 4.0.1

安装

使用pip安装

pip install wagtail-modelchooser

然后将它添加到您的INSTALLED_APPS

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

它与Wagtail 4.0及更高版本兼容。对于旧版本的Wagtail，请检查该软件包的早期版本。

快速入门

要启用您模型的选择器，您必须注册该模型。对于简单情况，使用@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

然后，您可以在编辑处理定义中使用FieldPanel，或者在StreamField定义中使用ModelChooserBlock

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'),
    ]

自定义选项

如果您想自定义模型选择器模态的内容或行为，您有多种选择。以下是一些示例来展示这些选项。

如果您想在弹出窗口中添加一个额外的过滤器字段，您可能可以这样操作

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

由于 wagtailmodelchooser 主要基于已在Wagtail中找到的 ChooserViewSet 功能，如果您希望进行更深入的定制，建议直接使用该功能。