Mate / Helper / Assistant of admin interfaces for Vue 2.6 / 2.7 / 3, extremely concise without losing flexibility.
管理后台伴侣 / 助手，用简洁而不失灵活的方式开发管理后台页面，可以集成进任意管理后台框架如 vue-vben-admin , vue-element-admin 中。 后台页面的特点是重复度高，如果提取公共代码又难以满足定制化需求，Admate 致力于解决这一痛点。
| 案例对比 | 技术栈 | 业务代码量（字符数） |
|---|---|---|
| 常规增删查改页面 | Vue 2 + ElementUI | 13,330 |
| 常规增删查改页面 | Vue 2 + ElementUI + Admate | 约 5,000 |
| 对接支付宝进件 | Vue 2 + ElementUI | 89,293 （表单部分） |
| 对接微信进件 | Vue 2 + ElementUI + Admate | 38,718 （表单部分） |
| 电商后台的商品管理 | Vue 2 + ElementUI | 425,885 |
| 电商后台的商品管理 | Vue 2 + ElementUI + Admate | 235,979 |
vueaxiosnpm add admate
npm add admate
npm add admate @vue/composition-api
Quasar@1（应该）不支持 Vite，暂无示例
PrimeVue@2（应该）不支持 Vite，暂无示例
useAdmate({
// Axios 或 Axios 实例
// 用于调用接口
axios,
})
useAdmate({
// Axios 配置
axiosConfig: {
// 读取列表
getList: {
method: 'GET',
},
// 新增一条记录（submitForm 在新增时调用）
c: {
method: 'POST',
},
// 读取一条记录（openForm 在查看、编辑时调用）
r: {
method: 'GET',
},
// 编辑一条记录（submitForm 在编辑时调用）
u: {
method: 'PUT',
},
// 删除一条记录
d: {
method: 'DELETE',
},
// 启用一条记录
enable: {
method: 'PUT',
},
// 禁用一条记录
disable: {
method: 'PUT',
},
// 变更一条记录的状态
updateStatus: {
method: 'PUT',
},
},
})
useAdmate({
// axiosConfig 中各个接口的 URL 前缀
urlPrefix: '',
})
// 示例: URL 前缀不统一
useAdmate({
urlPrefix: 'somepage',
axiosConfig: {
r: {
// 如果某个接口的前缀不是 'somepage'，可以在 URL 前面加斜线，即可忽略该前缀
url: '/anotherpage/selectOne',
},
}
})
如果接口地址需要进行动态拼接
<!-- 示例 -->
// 配置
const { openForm, d, enable, disable, updateStatus } = useAdmate({
axiosConfig: {
// 读取列表
getList: payload => ({
method: 'GET',
url: 'module/' + payload.xxx
}),
// 读取一条记录（openForm 在查看、编辑时调用）
r: payload => ({
method: 'GET',
url: 'module/' + payload.id
}),
// 编辑一条记录（submitForm 在编辑时调用）
u: payload => ({
method: 'PUT',
url: 'module/' + payload.id
}),
// 删除一条记录
d: payload => ({
method: 'DELETE',
url: 'module/' + payload.id
}),
// 启用一条记录
enable: payload => ({
method: 'PUT',
url: 'module/' + payload.id
}),
// 禁用一条记录
disable: payload => ({
method: 'PUT',
url: 'module/' + payload.id
}),
// 变更一条记录的状态
updateStatus: payload => ({
method: 'PUT',
url: 'module/' + payload.id
}),
}
})
// 使用
openForm({ id: 1 }, 'config')
d({ id: 1 }, 'config')
enable({ id: 1 }, 'config')
disable({ id: 1 }, 'config')
updateStatus({ id: 1 }, 'config')
Axios 的 data 默认以 application/json 作为 MIME type，如果你需要使用 multipart/form-data:
给你的 Axios 配置 transformRequest、headers['Content-Type']
getList、openForm、d、updateStatus、enable、disable、submitForm 的参数 1 均支持 FormData 类型
<!-- 示例: 局部配置 -->
<template>
<el-table>
<el-table-column label="操作">
<template #default="{ row: { id } }">
<el-button @click="r(FormData.from({ id }))">
查看
</el-button>
<el-button @click="u(FormData.from({ id }))">
编辑
</el-button>
<el-button @click="d(FormData.from({ id }))">
删除
</el-button>
</template>
</el-table-column>
</el-table>
<el-dialog>
<template #footer>
<el-button @click="() => submitForm(FormData.from(form.data))">
确 定
</el-button>
</template>
</el-dialog>
</template>
<script setup>
import { jsonToFormData, pickDeepBy } from 'kayran'
import useAdmateAdapter from '@/utils/useAdmateAdapter'
// 过滤 list.value.filter 并转换为 FormData 格式
FormData.from = (json) => {
const formData = new FormData()
for (const k in json) {
if (![NaN, null, undefined].includes(json[k])) {
formData.append(k, json[k])
}
}
return formData
}
useAdmateAdapter({
getListProxy(getList, trigger) {
getList(FormData.from(list.value.filter))
},
})
const FormData = window.FormData
</script>
list.filter
useAdmate({
list: {
// 可以在这里提供筛选参数的默认值
filter: {
[list.pageNumberKey]: 1,
},
// 必填
// 页码的参数名
pageNumberKey: undefined,
},
})
useAdmate({
list: {
watchFilter: false,
}
})
useAdmate({
list: {
watchFilter: true, // 默认值
// 防抖间隔，单位毫秒
// 如果筛选参数不含 input 类型，可以设置为 0，即不防抖
// 翻页不会触发防抖
// watchFilter 开启时有效
debounceInterval: 300, // 默认值
}
})
list.data
useAdmate({
list: {
// 列表数据
data: [],
// 指定接口返回值中列表数据所在的位置
// 支持属性名如 'data'，属性路径如 'data.records'
// 还支持 function，如 response => response.data
dataAt: undefined,
// 指定接口返回值中记录总数所在的位置
// 支持属性名如 'total'，属性路径如 'data.total'
// 还支持 function，如 response => response.total + 1
totalAt: undefined,
}
})
list.loading
axiosConfig.getList 被调用时值为 true，否则为 false
<!-- 示例 -->
<template>
<el-table v-loading="list.loading" />
</template>
<script setup>
import useAdmate from 'admate'
const { list } = useAdmate()
function handleTable() {
list.value.loading = true
Vue.prototype.$POST('').finally(() => {
list.value.loading = false
})
}
</script>
获取列表，在首次进入页面、列表筛选参数改变、单条记录增删查改后会被调用
const {
/**
* PS: 以下为原始 getList 的函数签名，如果你配置了 getListProxy，则以 getListProxy 为准
*
* @param {any} [payload = list.filter]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* @returns {Promise<any>} 接口返回值
*/
getList
} = useAdmate()
getList() // 手动读取
你可以使用 getListProxy 来代理 getList，以便在 getList 前后做一些操作，或改变 getList 的行为
useAdmate({
/**
* @param {Function} getList 被代理的原始 getList
* @param {string} trigger 调用动机 可能的值: 'init' 'pageNumberChange' 'filterChange' 'c' 'r' 'u' 'd' 'updateStatus' 'enable' 'disable'
*/
getListProxy(getList, trigger) {},
})
// 示例: 获取列表之前，校验参数
useAdmate({
getListProxy(getList, trigger) {
if (trigger === 'filterChange') {
listFilterRef.value.validate().then(() => {
getList()
})
}
else {
getList()
}
},
})
// 示例: 单条记录操作成功后，弹出提示
useAdmate({
getListProxy(getList, trigger) {
getList()
if (['c', 'u', 'd', 'updateStatus', 'enable', 'disable'].includes(trigger)) {
currentInstance.value.$message.success('操作成功')
}
},
})
// 示例: 读取列表后，修改列表数据
const { list } = useAdmate({
getListProxy(getList, trigger) {
getList().then((response) => {
// response 为 axiosConfig.getList 的接口返回值
list.data = response.data?.filter(v => !v.disabled)
})
},
})
表单默认是对话框的风格，但也支持独立页面的风格
对比
form.show: boolean
form.data
useAdmate({
form: {
// 可以在这里提供表单数据的默认值
data: {},
// 在查看、编辑表单时，可能需要调用接口（axiosConfig.r）回显表单的数据
// dataAt 用于指定接口返回值中表单数据所在的位置
// 支持属性名如 'data'，属性路径如 'data.detail'
// 还支持 function，如 response => response.data
dataAt: undefined,
// 接口（axiosConfig.r）返回值与 form.data 合并的方式
mergeData: 'deep',
},
})
mergeData:
'deep': 深合并（默认）'shallow': 浅合并(newFormData: any) => any: 自定义合并方式false: 不合并，直接替换为什么默认是深合并？
在 Vue 2 中，template 不支持 ?. 语法，要在 template 中判空，代码写起来会非常冗余，通常的做法是在 data 中声明空对象
比如给 form.data 提供默认值:
<template>
{{ form.data.a.b.c }}
</template>
<script setup>
import useAdmate from 'admate'
const { form } = useAdmate({
form: {
data: {
a: {
b: {}
}
}
}
})
</script>
如果 axiosConfig.r 的返回值为:
{ a: {} }
如果与默认值浅合并后将得到:
{ a: {} } —— 默认值中的对象b丢失了，引发空指针异常。
如果与默认值深合并后将得到:
{ a: { b: {} } } —— 代码正常工作。
// 示例: 自定义合并方式
import { mergeWith } from 'lodash'
const defaultFormData = () => ({
a: {
b: {}
}
})
const { form } = useAdmate({
form: {
data: defaultFormData(),
// 接口返回值中嵌套的对象可能为 null，会覆盖默认值中的空对象
mergeData(
// 接口返回值在通过 form.dataAt 计算过后的值
newFormData
) {
// Vue 3 中不需要赋值，mergeWith 的改动是响应式的
form.data = mergeWith(
defaultFormData(),
newFormData,
(oldObj, newObj) => [undefined, null].includes(newObj) ? oldObj : undefined
)
},
},
})
form.status: StatusType
打开表单，提交时会调用 axiosConfig.c
const { form, openForm } = useAdmate()
// 将表单形态设置为“新增”，然后打开表单
form.status = 'c'
openForm()
表单的初始数据不是空白，而是复制一条已有的记录
复制新增属于一种交叉状态，这种情况没有必要专门增加一种表单形态，可以借助一个辅助变量如 isCopy，用 isCopy && form.status ==='c' 来判断是不是复制新增，然后给 openForm 传参即可回显。
打开表单，并调用 axiosConfig.r 回显表单内容
const { form, openForm } = useAdmate()
// 将表单形态设置为“查看”，然后打开表单
form.status = 'r'
/**
* PS: 以下为原始 openForm 的函数签名，如果你配置了 openFormProxy ，则以 openFormProxy 为准
*
* @param {any} [payload] 如果 payload 不为空，则会调用 axiosConfig.r
* @param {'data'|'params'|'config'|'cache'} [payloadAs] 指定 payload 的用途
* 'data': 将 payload 用作请求配置的 `data` 参数（请求方式为 POST / PATCH / PUT / DELETE 时默认）
* 'params': 将 payload 用作请求配置的 `params` 参数（请求方式为 GET / HEAD 时默认）
* 'config': 将 payload 仅用于构建请求配置（详见 RESTful 章节）
* 'cache': 将 payload 直接用作表单数据（不调用读取单条记录的接口）
* @returns {Promise<any>} axiosConfig.r 的返回值
*/
openForm()
打开表单，并调用 axiosConfig.r 回显表单内容，提交时会调用 axiosConfig.u
const { form, openForm } = useAdmate()
// 将表单形态设置为“编辑”，然后打开表单
form.status = 'u'
/**
* PS: 以下为原始 openForm 的函数签名，如果你配置了 openFormProxy，则以 openFormProxy 为准
*
* @param {any} [payload] 如果 payload 不为空，则会调用 axiosConfig.r
* @param {'data'|'params'|'config'|'cache'} [payloadAs] 指定 payload 的用途
* 'data': 将 payload 用作请求配置的 `data` 参数（请求方式为 POST / PATCH / PUT / DELETE 时默认）
* 'params': 将 payload 用作请求配置的 `params` 参数（请求方式为 GET / HEAD 时默认）
* 'config': 将 payload 仅用于构建请求配置（详见 RESTful 章节）
* 'cache': 将 payload 直接用作表单数据（不调用读取单条记录的接口）
* @returns {Promise<any>} axiosConfig.r 的返回值
*/
openForm()
const {
/**
* @param {any} [payload]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* 'data': 将 payload 用作请求配置的 `data` 参数（请求方式为 POST / PATCH / PUT / DELETE 时默认）
* 'params': 将 payload 用作请求配置的 `params` 参数（请求方式为 GET / HEAD 时默认）
* 'config': 将 payload 仅用于构建请求配置（详见 RESTful 章节）
* @returns {Promise<any>} axiosConfig.d 的返回值
*/
d
} = useAdmate()
状态变更有两种方式:
<!-- 方式一: 使用 updateStatus -->
<template>
<el-table>
<el-table-column label="操作" align="center">
<template #default="{ row: { id, status } }">
<el-switch @change="updateStatus({ id, status: status ^ 1 })" />
</template>
</el-table-column>
</el-table>
</template>
<script setup>
import useAdmate from 'admate'
const {
/**
* @param {any} [payload]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* 'data': 将 payload 用作请求配置的 `data` 参数（请求方式为 POST / PATCH / PUT / DELETE 时默认）
* 'params': 将 payload 用作请求配置的 `params` 参数（请求方式为 GET / HEAD 时默认）
* 'config': 将 payload 仅用于构建请求配置（详见 RESTful 章节）
* @returns {Promise<any>} axiosConfig.updateStatus 的返回值
*/
updateStatus,
} = useAdmate()
</script>
<!-- 方式二: 使用 enable 和 disable -->
<template>
<el-table>
<el-table-column label="操作" align="center">
<template #default="{ row: { id, status } }">
<el-switch @change="[enable, disable][status]({ id })" />
</template>
</el-table-column>
</el-table>
</template>
<script setup>
import useAdmate from 'admate'
const {
/**
* @param {any} [payload]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* 'data': 将 payload 用作请求配置的 `data` 参数（请求方式为 POST / PATCH / PUT / DELETE 时默认）
* 'params': 将 payload 用作请求配置的 `params` 参数（请求方式为 GET / HEAD 时默认）
* 'config': 将 payload 仅用于构建请求配置（详见 RESTful 章节）
* @returns {Promise<any>} axiosConfig.enable 的返回值
*/
enable,
/**
* @param {any} [payload]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* 'data': 将 payload 用作请求配置的 `data` 参数（请求方式为 POST / PATCH / PUT / DELETE 时默认）
* 'params': 将 payload 用作请求配置的 `params` 参数（请求方式为 GET / HEAD 时默认）
* 'config': 将 payload 仅用于构建请求配置（详见 RESTful 章节）
* @returns {Promise<any>} axiosConfig.disable 的返回值
*/
disable
} = useAdmate()
</script>
打开表单，函数签名要分情况:
你可以使用 openFormProxy 来代理 openForm，以便在 openForm 前后做一些操作，或改变 openForm 的行为
useAdmate({
/**
* @param {Function} openForm 被代理的原始 openForm
* @returns {Promise<object> | object | void} object 为打开表单后 form 的终态
*/
openFormProxy(openForm) {},
})
// 示例: 回显表单后，修改表单数据
const { form } = useAdmate({
openFormProxy(openForm) {
// 新增时 openForm 没有返回值
return new Promise((resolve, reject) => {
openForm()?.then((response) => {
// response 为 axiosConfig.r 的接口返回值
// 修改表单数据
form.data.status = 1
resolve()
}).catch(() => {
reject()
})
})
},
})
// 示例: 回显表单后，清除校验
useAdmate({
openFormProxy(openForm) {
return new Promise((resolve, reject) => {
openForm()?.finally(() => {
formRef.value.clearValidate()
}).then(() => {
resolve()
}).catch(() => {
reject()
})
})
},
})
// 示例: 回显表单后，自定义表单的开闭和读取状态
useAdmate({
openFormProxy(openForm) {
return new Promise((resolve, reject) => {
// 可以在 finally 中 resolve
openForm().then(() => {
// 回显成功后，默认停止加载
resolve({
loading: false,
})
}).catch(() => {
// 回显失败后，默认关闭表单并停止加载
reject({
show: false,
loading: false,
})
})
})
}
})
// 也可以返回一个对象（如果没有异步操作）
useAdmate({
openFormProxy(openForm) {
return {
loading: false
}
}
})
form.loading
axiosConfig.r 被调用时值为 true，否则为 false
不能将该值当作表单回显结束的标志，因为复用列表数据时不会调用 axiosConfig.r
<!-- 示例 -->
<template>
<el-dialog>
<el-form v-loading="form.loading" />
</el-dialog>
</template>
<script setup>
import useAdmate from 'admate'
const { form } = useAdmate()
</script>
提交表单，新增时调用 axiosConfig.c，编辑时调用 axiosConfig.u
const {
/**
* PS: 以下为原始 submitForm 的函数签名，如果你配置了 submitFormProxy ，则以 submitFormProxy 为准
*
* @param {any} [payload = form.data]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* @returns {Promise<any>} 接口返回值
*/
submitForm
} = useAdmate()
你可以使用 submitFormProxy 来代理 submitForm，以便在 submitForm 前后做一些操作，或改变submitForm的行为
useAdmate({
/**
* @param {Function} submitForm 被代理的原始 submitForm
* @returns {Promise<object> | object | void} object 为提交表单后 form 的终态
*/
submitFormProxy(submitForm) {}
})
// 示例: 指定提交参数
submitForm({
...form.data,
status: 1,
})
// submitForm 被代理时
useAdmate({
submitFormProxy(submitForm) {
return new Promise((resolve, reject) => {
submitForm({
...form.data,
status: 1,
}).then(() => {
resolve()
}).catch(() => {
reject()
})
})
}
})
// 示例: 提交前校验表单
useAdmate({
submitFormProxy(submitForm) {
return new Promise((resolve, reject) => {
formRef.value.validate().then(() => {
submitForm().then(() => {
resolve()
}).catch(() => {
reject()
})
})
})
}
})
// 示例: 提交表单后，自定义表单的开闭和提交状态
// 返回一个 promise
useAdmate({
submitFormProxy(submitForm) {
return new Promise((resolve, reject) => {
formRef.value.validate().then(() => {
submitForm().then(() => {
// 提交成功后，默认关闭表单，并停止加载
resolve({
show: false,
submitting: false,
})
}).catch(() => {
// 提交失败后，默认仅停止加载
reject({
show: true,
submitting: false,
})
})
})
})
}
})
// 也可以返回一个对象（如果没有异步操作）
useAdmate({
submitFormProxy(submitForm) {
return {
show: false,
submitting: false,
}
}
})
form.submitting
axiosConfig.c 或 axiosConfig.u 被调用时值为 true，否则为 false
<!-- 示例 -->
<template>
<el-dialog>
<template #footer>
<el-button :loading="form.submitting">
确 定
</el-button>
</template>
</el-dialog>
</template>
<script setup>
import useAdmate from 'admate'
const { form } = useAdmate()
</script>
// 示例: 适配层提供 afterGetList
useAdmateAdapter({}, {
afterGetList (response, trigger) {
// 可访问 this（组件实例）
}
}
watch(() => form.value.show, (n) => {
if (n) {
// 打开表单
}
})
// 示例: 适配层提供 afterOpenForm
useAdmateAdapter({}, {
afterOpenForm(res) {
// res 为接口返回值（新增时为空）
// 可访问 this（组件实例）
}
})
// 示例: 适配层提供 afterRetrieve
// 新增时不触发
useAdmateAdapter({}, {
afterRetrieve(res) {
// res 为接口返回值
// 可访问 this（组件实例）
}
})
// 示例: 适配层提供 beforeSubmit
useAdmateAdapter({}, {
beforeSubmit(form) {
// 可访问 this（组件实例）
}
})
// 示例: 适配层提供 afterSubmit
useAdmateAdapter({}, {
afterSubmit(res) {
// res 为接口返回值
// 可访问 this（组件实例）
}
})
watch(() => form.value.show, (n) => {
if (!n) {
// 关闭表单
}
})
type StatusType = '' | 'c' | 'r' | 'u' | string
将表单抽离为子组件
操作单条记录时，跳转到专用的表单页面，操作完毕后返回
表单默认打开，且无法关闭，通常用于列表中只有一条数据，故列表被省略的场景
嵌套其它也使用 Admate 的页面
各版本详细改动请参考 release notes 。
PR welcome! 💗
npm add pnpm @cloydlau/scripts -g; pnpm i
启动
pnpm dev3pnpm dev2.7pnpm dev2.6FAQs
Admin CRUD frontend meta framework for Vue 2/3, extremely concise without losing flexibility.
The npm package admate receives a total of 15 weekly downloads. As such, admate popularity was classified as not popular.
We found that admate demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.