# 自定义按钮

自定义按钮也叫action，是ModelAdmin中的actions一员。

django admin 默认提供了自定义按钮的支持，但是样式、图标均不可自定义，simplepro在django admin 自定义action的基础上增加了样式、图标、按钮类型自定义。

# 定义例子


      @admin.register(Employe)
class EmployeAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'gender', 'idCard', 'phone', 'birthday', 'department', 'enable', 'create_time')
   
    # 增加自定义按钮
    actions = ['make_copy', 'custom_button']

    def custom_button(self, request, queryset):
        pass

    # 显示的文本，与django admin一致
    custom_button.short_description = '测试按钮'
    # icon，参考element-ui icon与https://fontawesome.com
    custom_button.icon = 'fas fa-audio-description'

    # 指定element-ui的按钮类型，参考https://element.eleme.cn/#/zh-CN/component/button
    custom_button.type = 'danger'

    # 给按钮追加自定义的颜色
    custom_button.style = 'color:black;'

    def make_copy(self, request, queryset):
        pass
    make_copy.short_description = '复制员工'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 字段

字段	类型	说明
enable	boolean	默认是否可点击，默认为False，需要勾选数据后才可点击
icon	string	按钮图标，参考https://element.eleme.cn/#/zh-CN/component/icon与https://fontawesome.com，把class 复制进来即可
type	string	按钮类型，参考：https://element.eleme.cn/#/zh-CN/component/button
style	string	自定义css样式
confirm	string	弹出确认框

enable说明如果为True，默认可以直接点击进行操作，然后调用admin中的方法。只不过queryset是个空的。其他操作与其他类型一致。

def message_test(self, request, queryset):
    messages.add_message(request, messages.SUCCESS, '操作成功123123123123')
    messages.add_message(request, messages.ERROR, '操作成功123123123123')
    messages.add_message(request, messages.DEBUG, '操作成功123123123123')
    messages.add_message(request, messages.WARNING, '操作成功123123123123')
    messages.add_message(request, messages.INFO, '操作成功123123123123')

message_test.short_description = '消息测试'

# 设置按钮默认是否可点击，如果默认可点击，获取到的queryset将会是一个空的
message_test.enable = True

1
2
3
4
5
6
7
8
9
10
11

# 方法

simplepro在自定义actions的基础上进行了扩展，入参和出参与django admin不同。

# 入参

入参是只request.POST中收到的参数

字段	类型	说明
action	string	该值是用于simplepro路由使用，可以不予理会
all	string	取值0和1，0未全部选择，1全部选中
key	string	自定义按钮的方法名
ids	string	逗号分隔的选中的id，如果all=1，该值没有

# 出参

出参是指自定义按钮方法体返回的数据

例子：

def test(self, request, queryset):
    return {
        'state': False,
        'msg': '用户关联的数据还没有删除！'
    }

1
2
3
4
5

# 字段说明

字段	类型	说明
state	boolean	true成功，false失败
msg	string	前台通知框的信息