# Base 基础模块

# Pages 页面

路由地址 说明
/403 您无权访问此页面
/404 找不到您要查找的页面
/500 糟糕,出了点问题
/502 马上回来
/login 登录

# Views 视图

标题 路由地址 模块名 图标
个人中心 /my/info
用户列表 /sys/user sys.user icon-user
菜单列表 /sys/menu sys.menu icon-menu
角色列表 /sys/role sys.role icon-common
任务列表 /sys/task sys.task icon-menu
状态监控 /sys/perf sys.perf icon-warn
参数列表 /sys/param sys.param icon-menu
请求日志 /sys/log sys.log icon-log
插件列表 /plugin plugin icon-menu

# Methods 导出方法

方法名称 说明 参数
iconList svg 图标列表
checkPerm 权限判断 perm / { or: perms } / { and: perms }
import { iconList, checkPerm } from "@/cool/modules/base";

# Directives 指令

指令名称 说明 参数
permission 权限判断 perm / { or: perms } / { and: perms }
<!-- 是否包含该权限 -->
<el-button v-permission="$service.system.user.permission.add"></el-button>

<!-- 是否全部满足指定条件 -->
<el-button
	v-permission="{
        and: [$service.system.user.permission.add, $service.system.user.permission.update]
    }"
></el-button>

# Filters 过滤器

过滤名称 说明
default_avatar 默认头像
default_name 默认名称

# Service 服务

服务名称 说明
common 通用
common.uploadMode 文件上传模式
common.upload 文件上传,如果模式是 cloud,返回对应参数
common.userLogout 用户退出
common.userInfo 用户信息
common.userUpdate 用户信息修改
common.permMenu 菜单及权限信息
open 开放
open.login 登录
open.captcha 图片验证码
open.refreshToken 刷新 token
system 系统
system.dept 组织架构
system.dept.order 组织架构排序
system.menu 菜单
system.role 权限
system.user 用户
system.user.move 用户移动
system.info 系统信息
system.task 系统任务
system.log 系统日志
system.log.clear 清空日志
system.log.get-keep 获取保存天数
system.log.set-keep 设置保存天数
system.param 系统参数

# Store getters

服务名称 说明
appInfo 应用信息
conf 应用配置
browser 浏览器信息
menuCollapse 左侧菜单是否收起
modules cool 模块信息
menuGroup 树形菜单列表
menuList 左侧菜单
routes 视图路由
permission 权限列表
processList 窗口列表
userInfo 用户信息
token 授权标识

# Store Actions

服务名称 说明
appLoad 加载权限及用户信息
permMenu 设置菜单、权限
userLogin 用户登录
userLogout 用户退出
userInfo 用户信息
userRemove 用户移除,删除 token, 菜单

# Store Mutations

服务名称 说明 参数
COLLAPSE_MENU 收起左侧菜单 boolean
SET_USERINFO 设置用户信息 user
SET_TOKEN 设置授权标识 token
CLEAR_TOKEN 移除授权标识
CLEAR_USER 移除用户信息

# Components 组件

# cl-avatar

头像

# 参数

参数 说明 类型 可选值 默认值
src 资源地址 string
size 尺寸 string large / medium / small large
shape 形状 string circle / square circle
<cl-avatar src="https://" />

# cl-dept-check

组织架构选择

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 array
title 标题 string

# Methods

参数 说明 参数
refresh 刷新列表
<cl-dept-check></cl-dept-check>

# cl-dept-move

组织架构人员移动

# Methods

参数 说明 参数
toMove 移动 ids:用户 id
<cl-dept-move></cl-dept-move>

# cl-dept-tree

组织架构树形列表

# 参数

参数 说明 类型 可选值 默认值
drag 是否能拖动布局 boolean true
level 组织层级 number 99

# Methods

参数 说明 参数
refresh 刷新列表

# Emits

参数 说明 回调参数
list-change 列表发送改变时触发 list
row-click 行点击时触发 {item, ids}
user-add 用户新增时触发 user
<cl-dept-tree></cl-dept-tree>

# cl-menu-slider

侧边菜单导航

<cl-menu-slider></cl-menu-slider>

# cl-menu-file

菜单文件选择

自动查找 /src/viewssrc/cool/modules/**/views 下的 .{vue|js} 文件,生成路径列表。

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值,菜单文件路径 string
<cl-menu-file></cl-menu-file>

# cl-menu-icons

菜单图标选择

读取 /src/icons/svg 下的文件

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
<cl-menu-icons></cl-menu-icons>

# cl-menu-perms

菜单权限选择

根据 service 下的 permission 控制,不显示对应的权限,则没有使用 @Permission 装饰器

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
<cl-menu-perms></cl-menu-perms>

# cl-menu-topbar

顶栏菜单导航

<cl-menu-topbar></cl-menu-topbar>

# cl-menu-tree

菜单树形列表

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
<cl-menu-tree></cl-menu-tree>

# cl-process

窗口进程

<cl-process></cl-process>

# cl-role-select

角色选择

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
<cl-role-select></cl-role-select>

# cl-role-perms

角色权限选择

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
title 标题 string
<cl-role-perms></cl-role-perms>

# cl-route-nav

路由导航,面包屑

<cl-route-nav></cl-route-nav>

# icon-svg

svg 图标

# 参数

参数 说明 类型 可选值 默认值
name 图标名称 string
size 尺寸 string
<icon-svg></icon-svg>

# cl-editor-quill

quill 富文本编辑

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
height 高度 string
width 宽度 string
options codemirror 选项 object
<cl-editor-quill></cl-editor-quill>

# cl-codemirror

代码编辑器

# 参数

参数 说明 类型 可选值 默认值
value / v-model 绑定值 string
height 高度 string
width 宽度 string
options codemirror 选项 object
<cl-codemirror></cl-codemirror>