Skip to content

Commit 155ce52

Browse files
committed
update docs
1 parent 2455168 commit 155ce52

File tree

5 files changed

+44
-4
lines changed

5 files changed

+44
-4
lines changed
Loading

docs/en/guide.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ top menu,default is `[]`,will show nothing
8787
> Tips: Top menu will not show icon,only support secondary menu max
8888
8989
## ModelAdmin
90-
external ModelAdmin in django
90+
### external ModelAdmin in django
9191

9292
- make table filter support `select2` in `change_list` page
9393
- custom search field placeholder for `change_list` page
@@ -109,6 +109,24 @@ effect
109109

110110
![modeladmin](../assets/images/modeladmin.png)
111111

112+
### Custom Filters
113+
#### DateRangeFilter
114+
115+
example:
116+
```python title='rap/admin.py'
117+
from adminlteui.admin import ModelAdmin
118+
from adminlteui.filters import DateRangeFilter
119+
120+
class AutomationTaskRecordAdmin(CommonAdmin, ModelAdmin):
121+
list_display = ('id', 'automation', 'account', 'status', 'start_time',
122+
'end_time', 'update_time')
123+
list_filter = ('automation__project', 'automation__source',
124+
'status', ('start_time', DateRangeFilter), ('end_time', DateRangeFilter))
125+
126+
```
127+
effect:
128+
![adminlte_date_range_filter](../assets/images/adminlte_date_range_filter.png)
129+
112130
## Widgets
113131

114132
### AdminlteSelect
@@ -146,4 +164,4 @@ class CollectorAdmin(admin.ModelAdmin):
146164
```
147165
effect:
148166

149-
![adminlte_select](../assets/images/adminlte_select_multiple.png)
167+
![adminlte_select_multiple](../assets/images/adminlte_select_multiple.png)

docs/en/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ INSTALLED_APPS = [
5353
## Features
5454

5555
- [Custom General Option](/django-adminlte-ui/2.x/guide/#basic-info)
56+
- [ModelAdmin](/django-adminlte-ui/2.x/guide/#modeladmin)
5657
- [Widgets](/django-adminlte-ui/2.x/guide/#widgets)
5758
- [Custom Menu](/django-adminlte-ui/2.x/guide/#menu)
5859

docs/zh/guide.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ class MyAdminlteConfig(AdminlteConfig):
8787
> Tips: 顶部菜单将不显示Icon,并且最多显示二级菜单,多余的将被隐藏
8888
8989
## ModelAdmin
90-
扩展django的ModelAdmin
90+
### 扩展django的ModelAdmin
9191

9292
-`change_list`页面的table过滤器支持`select2`
9393
- 自定义`change_list`页面搜索框的placeholder提示
@@ -109,6 +109,26 @@ class CollectorModelAdmin(ModelAdmin):
109109

110110
![modeladmin](../assets/images/modeladmin.png)
111111

112+
### Filters过滤器
113+
#### DateRangeFilter
114+
115+
基于datarangepicker的时间范围过滤器
116+
117+
示例:
118+
```python title='rap/admin.py'
119+
from adminlteui.admin import ModelAdmin
120+
from adminlteui.filters import DateRangeFilter
121+
122+
class AutomationTaskRecordAdmin(CommonAdmin, ModelAdmin):
123+
list_display = ('id', 'automation', 'account', 'status', 'start_time',
124+
'end_time', 'update_time')
125+
list_filter = ('automation__project', 'automation__source',
126+
'status', ('start_time', DateRangeFilter), ('end_time', DateRangeFilter))
127+
128+
```
129+
效果图:
130+
![adminlte_date_range_filter](../assets/images/adminlte_date_range_filter.png)
131+
112132
## Widgets组件
113133

114134
### AdminlteSelect
@@ -146,4 +166,4 @@ class CollectorAdmin(admin.ModelAdmin):
146166
```
147167
效果图:
148168

149-
![adminlte_select](../assets/images/adminlte_select_multiple.png)
169+
![adminlte_select_multiple](../assets/images/adminlte_select_multiple.png)

docs/zh/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ INSTALLED_APPS = [
5353
## 功能
5454

5555
- [自定义属性](/django-adminlte-ui/2.x/zh/guide/#_4)
56+
- [ModelAdmin扩展](/django-adminlte-ui/2.x/zh/guide/#modeladmin)
5657
- [Widget组件](/django-adminlte-ui/2.x/zh/guide/#widgets)
5758
- [自定义菜单](/django-adminlte-ui/2.x/zh/guide/#_5)
5859

0 commit comments

Comments
 (0)