Django Smart Selects 使用指南

Django Smart Selects 使用指南

django-smart-selectschained and grouped selects for django forms项目地址:https://gitcode.com/gh_mirrors/dj/django-smart-selects

项目介绍

Django-Smart-Selects 是一个用于处理 Django 模型中的链式字段选择的应用程序. 它支持在前端表单中动态更新下拉列表基于其他字段的选择, 从而简化了涉及到复杂关联模型的数据输入过程.

主要功能包括:

• 链式选择: 根据另一个选择框的选择来过滤下一级的选择框.
• 多选链式选择: 支持多对多关系的链式筛选.
• 分组选择: 对选项进行逻辑分组显示以提高可读性.

项目快速启动

要开始使用 Django-Smart-Selects, 遵循以下步骤:

安装

首先通过 pip 命令安装该包:

$ pip install django-smart-selects

接着确保将其添加到你的 Django 项目的 INSTALLED_APPS 中:

# settings.py
INSTALLED_APPS = [
    # ...
    'smart_selects',
]

设置 URL

为了使链式选择和多选链式选择能够正常工作, 你需要将 smart_selects 的 URLs 包含进你的项目 URLs 配置:

# urls.py
from django.conf.urls import url
from django.contrib import admin
from smart_selects import urls

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^chaining/', include(urls)),
]

在模板中使用

在模板中使用 Django 表单时无需额外配置即可使用 Django-Smart-Selects 功能.

应用案例和最佳实践

链式选择

假设我们有两个模型, Country 和 City, 其中 City 有一个外键指向 Country. 当我们在表单中需要填写城市的时候, 我们希望能够根据国家的选择自动填充相关的城市列表:

class City(models.Model):
    country = models.ForeignKey(Country)
    
    def __str__(self):
        return self.name

在视图或表单中可以这样使用:

<select name="country" id="id_country">
    {% for country in countries %}
        <option value="{{ country.pk }}">{{ country }}</option>
    {% endfor %}
</select>

<select name="city" data-model-name="app.City"
        data-chained-field="country"
        data-value="{{ city.id }}">
    <!-- 下拉列表将在页面加载时动态填充 -->
</select>

多选链式选择

对于涉及多对多关系的场景, 可使用类似的语法但需要指定 data-multiple="true" 来启用多选模式:

<!-- 原始的多选字段 -->
<select multiple name="category">
    <!-- 根据需要渲染所有类别 -->
</select>

<!-- 链接的多选字段 -->
<select multiple data-multiple="true" 
        data-model-name="app.ProductCategory"
        data-chained-field="category"
        data-value="{{ product.category_id }}">
    <!-- 这里将根据已经选定的分类动态填充产品类别 -->
</select>

分组选择

当某些选项应按特定方式进行分组显示时（例如, 将城市按所属国家分组）, 可以使用 GroupedForeignKey 实现分组效果:

from smart_selects.db_fields import GroupedForeignKey

class Location(models.Model):
    country = models.ForeignKey(Country)
    state = GroupedForeignKey(State, "country")
    
    def __str__(self):
        return f"{self.state} ({self.country})"

如此一来, 在表单中使用 state 字段时将看到一个按照其 country 属性自然分组的下拉菜单.

典型生态项目

尽管 Django-Smart-Selects 自身足够灵活适用于多种应用场景, 但它作为整个 Django 生态的一部分也受益于其他社区维护的开源组件. 这些组件可能包括但不限于:

• Django Admin Plus: 提供了增强版的 Django 后台管理界面, 并能与 Django-Smart-Selects 融合提升用户体验.
• Django Crispy Forms: 一种美化 Django 表单呈现的方式, 结合 Django-Smart-Selects 可以创建更直观且友好的界面设计.

综上所述, Django-Smart-Selects 不仅仅是一个独立的工具; 它是 Django 开发者生态系统中不可或缺的一环, 能够与其他工具和服务协同作用以构建更加丰富和高效的功能系统.

django-smart-selectschained and grouped selects for django forms项目地址:https://gitcode.com/gh_mirrors/dj/django-smart-selects