Skip to content

Commit 23d3484

Browse files
committed
update README
1 parent c920dc3 commit 23d3484

File tree

6 files changed

+92
-2
lines changed

6 files changed

+92
-2
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,22 @@ python manage.py migrate django_admin_settings
6969
## general_option
7070
![general_option](./images/general_option.jpg)
7171

72+
## menu list
73+
74+
![menu list](./images/menu-list.png)
75+
76+
77+
# features
78+
79+
- [Custom General Option](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#general-option)
80+
- [Widgets](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#widgets)
81+
- [Custom Menu](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#menu)
82+
83+
# TODO
84+
85+
- Custom Dashboard
86+
87+
7288
# Thanks
7389

7490
- [AdminLTE](https://github.com/ColorlibHQ/AdminLTE)

docs/about.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# ChangeLog
22

3+
## [v1.3.0](https://github.com/wuyue92tree/django-adminlte-ui/releases/tag/1.3.0b1)
4+
5+
- add exchange_menu logic with permission limit;
6+
- add message when call exchange menu;
7+
- update docs.
8+
9+
## [v1.3.0b1](https://github.com/wuyue92tree/django-adminlte-ui/releases/tag/1.3.0b1)
10+
11+
- update models, content_type option add null=True;
12+
- add js logic for menu;
13+
- add exchange_menu logic without permission limit.
14+
315
## [v1.3.0b0](https://github.com/wuyue92tree/django-adminlte-ui/releases/tag/1.3.0b0)
416

517
- add treebeard as menu depends;

docs/guide.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ before custom option, you should known what adminlte has used.
4444
- site_header
4545
- site_logo
4646
- welcome_sign
47+
- USE_CUSTOM_MENU
4748

4849
## Widgets
4950

@@ -110,4 +111,50 @@ effect:
110111

111112
## Menu
112113

113-
developing ...
114+
Custom your menu depends on database && treebeard.
115+
116+
`depth 2` only, more will not effective now.
117+
118+
### Menu Setting
119+
120+
Exchange Menu by click the `Exchange Menu` button
121+
122+
![menu list](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/menu-list.png?raw=true)
123+
124+
### Menu Form
125+
126+
![menu form](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/menu-form.png?raw=true)
127+
128+
- name: The menu name
129+
- position: The position of your custom menu, default `left`
130+
- link_type:
131+
1. internal: django urls
132+
2. external: third part urls
133+
3. divide: link divide, like app verbose_name.
134+
- link:
135+
1. `admin:index`: django url name, recommend.
136+
2. `/admin/`: django internal url, if you use i18n url, it's not a good choice.
137+
3. `http://`: outside url
138+
- icon: [icon](https://adminlte.io/themes/AdminLTE/pages/UI/icons.html)
139+
- content_type: Use for permission control, if user don't have permission to access the `app_label:model` in content_type, it will be skipped.
140+
- valid: This menu item effective only when the valid is True.
141+
- treebeard option: for order.
142+
143+
### get django url name for link
144+
145+
```
146+
147+
╰─$ python manage.py shell
148+
Python 3.6.6 (default, Sep 29 2018, 19:18:41)
149+
Type 'copyright', 'credits' or 'license' for more information
150+
IPython 7.5.0 -- An enhanced Interactive Python. Type '?' for help.
151+
152+
In [1]: from django.urls import resolve
153+
154+
In [2]: resolve('/zh-hans/admin/video/parsed/')
155+
Out[2]: ResolverMatch(func=django.contrib.admin.options.changelist_view, args=(), kwargs={},
156+
url_name=video_parsed_changelist, app_names=['admin'], namespaces=['admin'], route=zh-hans/admin/video/parsed/)
157+
158+
```
159+
160+
django url name = namespaces:url_name

docs/index.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ INSTALLED_APPS = [
4747
```
4848
python manage.py migrate django_admin_settings
4949
```
50-
## screen shot
50+
## Screen shot
5151

5252
### login page
5353
![login](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/login.jpg?raw=true)
@@ -64,6 +64,21 @@ python manage.py migrate django_admin_settings
6464
### general_option
6565
![general_option](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/general_option.jpg?raw=true)
6666

67+
### menu list
68+
![menu list](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/menu-list.png?raw=true)
69+
70+
71+
## Features
72+
73+
- [Custom General Option](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#general-option)
74+
- [Widgets](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#widgets)
75+
- [Custom Menu](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#menu)
76+
77+
## Todo
78+
79+
- Custom Dashboard
80+
81+
6782
## Thanks
6883

6984
- [AdminLTE](https://github.com/ColorlibHQ/AdminLTE)

images/menu-form.png

55.9 KB
Loading

images/menu-list.png

574 KB
Loading

0 commit comments

Comments
 (0)