update docs

wuyue92tree · Jul 5, 2023 · 155ce52 · 155ce52
1 parent 2455168
commit 155ce52
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 4 deletions.
diff --git a/docs/assets/images/adminlte_date_range_filter.png b/docs/assets/images/adminlte_date_range_filter.png
diff --git a/docs/en/guide.md b/docs/en/guide.md
@@ -87,7 +87,7 @@ top menu，default is `[]`，will show nothing
 > Tips: Top menu will not show icon，only support secondary menu max
 
 ## ModelAdmin
-external ModelAdmin in django
+### external ModelAdmin in django
 
 - make table filter support `select2` in `change_list` page
 - custom search field placeholder for `change_list` page
@@ -109,6 +109,24 @@ effect
 
 ![modeladmin](../assets/images/modeladmin.png)
 
+### Custom Filters
+#### DateRangeFilter
+
+example:
+```python title='rap/admin.py'
+from adminlteui.admin import ModelAdmin
+from adminlteui.filters import DateRangeFilter
+
+class AutomationTaskRecordAdmin(CommonAdmin, ModelAdmin):
+    list_display = ('id', 'automation', 'account', 'status', 'start_time',
+                    'end_time', 'update_time')
+    list_filter = ('automation__project', 'automation__source',
+                   'status', ('start_time', DateRangeFilter), ('end_time', DateRangeFilter))
+
+```
+effect:
+![adminlte_date_range_filter](../assets/images/adminlte_date_range_filter.png)
+
 ## Widgets
 
 ### AdminlteSelect
@@ -146,4 +164,4 @@ class CollectorAdmin(admin.ModelAdmin):
 ```
 effect:
 
-![adminlte_select](../assets/images/adminlte_select_multiple.png)
+![adminlte_select_multiple](../assets/images/adminlte_select_multiple.png)
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -53,6 +53,7 @@ INSTALLED_APPS = [
 ## Features
 
 - [Custom General Option](/django-adminlte-ui/2.x/guide/#basic-info)
+- [ModelAdmin](/django-adminlte-ui/2.x/guide/#modeladmin)
 - [Widgets](/django-adminlte-ui/2.x/guide/#widgets)
 - [Custom Menu](/django-adminlte-ui/2.x/guide/#menu)
 

diff --git a/docs/zh/guide.md b/docs/zh/guide.md
@@ -87,7 +87,7 @@ class MyAdminlteConfig(AdminlteConfig):
 > Tips: 顶部菜单将不显示Icon，并且最多显示二级菜单，多余的将被隐藏
 
 ## ModelAdmin
-扩展django的ModelAdmin
+### 扩展django的ModelAdmin
 
 - 让`change_list`页面的table过滤器支持`select2`
 - 自定义`change_list`页面搜索框的placeholder提示
@@ -109,6 +109,26 @@ class CollectorModelAdmin(ModelAdmin):
 
 ![modeladmin](../assets/images/modeladmin.png)
 
+### Filters过滤器
+#### DateRangeFilter
+
+基于datarangepicker的时间范围过滤器
+
+示例:
+```python title='rap/admin.py'
+from adminlteui.admin import ModelAdmin
+from adminlteui.filters import DateRangeFilter
+
+class AutomationTaskRecordAdmin(CommonAdmin, ModelAdmin):
+    list_display = ('id', 'automation', 'account', 'status', 'start_time',
+                    'end_time', 'update_time')
+    list_filter = ('automation__project', 'automation__source',
+                   'status', ('start_time', DateRangeFilter), ('end_time', DateRangeFilter))
+
+```
+效果图:
+![adminlte_date_range_filter](../assets/images/adminlte_date_range_filter.png)
+
 ## Widgets组件
 
 ### AdminlteSelect
@@ -146,4 +166,4 @@ class CollectorAdmin(admin.ModelAdmin):
 ```
 效果图:
 
-![adminlte_select](../assets/images/adminlte_select_multiple.png)
+![adminlte_select_multiple](../assets/images/adminlte_select_multiple.png)
diff --git a/docs/zh/index.md b/docs/zh/index.md
@@ -53,6 +53,7 @@ INSTALLED_APPS = [
 ## 功能
 
 - [自定义属性](/django-adminlte-ui/2.x/zh/guide/#_4)
+- [ModelAdmin扩展](/django-adminlte-ui/2.x/zh/guide/#modeladmin)
 - [Widget组件](/django-adminlte-ui/2.x/zh/guide/#widgets)
 - [自定义菜单](/django-adminlte-ui/2.x/zh/guide/#_5)