Django-Jet项目自定义仪表盘模块开发指南-优快云博客

Django-Jet项目自定义仪表盘模块开发指南

django-jet Modern responsive template for the Django admin interface with improved functionality. We are proud to announce completely new Jet. Please check out Live Demo 项目地址: https://gitcode.com/gh_mirrors/dj/django-jet

概述

Django-Jet作为Django的现代化管理界面，提供了强大的仪表盘功能。本文将详细介绍如何在Django-Jet中创建自定义仪表盘模块，帮助开发者扩展管理后台的功能展示。

模块开发步骤

1. 继承基础模块类

首先需要创建一个继承自DashboardModule的子类。建议在应用目录下创建dashboard_modules.py文件：

from jet.dashboard.modules import DashboardModule
from myapp.models import MyModel

class CustomModule(DashboardModule):
    title = '自定义模块'
    template = 'myapp/dashboard_modules/custom.html'
    limit = 5
    
    def init_with_context(self, context):
        self.children = MyModel.objects.all()[:self.limit]

关键属性说明：

title: 模块显示标题
template: 模块使用的模板路径
limit: 数据展示条数限制
init_with_context: 初始化方法，用于加载数据

2. 添加可配置选项（可选）

如需让模块支持后台配置，需要实现以下内容：

from django import forms

class CustomSettingsForm(forms.Form):
    display_style = forms.ChoiceField(
        label='显示样式',
        choices=(('list', '列表'), ('grid', '网格'))
    )

class CustomModule(DashboardModule):
    # ...其他属性...
    settings_form = CustomSettingsForm
    
    def settings_dict(self):
        return {'display_style': self.display_style}
    
    def load_settings(self, settings):
        self.display_style = settings.get('display_style', 'list')

3. 创建模块模板

在指定路径创建HTML模板文件，模块实例会以module变量传入模板：

<div class="custom-module">
    <h3>{{ module.title }}</h3>
    <ul>
        {% for item in module.children %}
            <li>{{ item.name }}</li>
        {% empty %}
            <li>暂无数据</li>
        {% endfor %}
    </ul>
</div>

模板开发技巧：

可使用Django模板标签和过滤器
建议保持与Jet一致的UI风格
添加适当的CSS类名以便样式控制

4. 添加模块视图（可选）

如需为模块添加自定义视图：

# dashboard_modules_views.py
from django.urls import path
from jet.dashboard import dashboard

def custom_view(request):
    # 视图逻辑
    pass

dashboard.urls.register_urls([
    path('custom-action/', custom_view, name='custom-action'),
])

注意：需要在主URL配置前导入视图文件：

# urls.py
from myapp import dashboard_modules_views  # 必须放在前面
from django.urls import include, path

urlpatterns = [
    path('jet/dashboard/', include('jet.dashboard.urls')),
    # 其他URL配置...
]