管理后台伴侣，用简洁而不失灵活的方式开发管理后台页面，可以集成进任意管理后台框架如 vue-vben-admin , vue-element-admin 中。
🎉 在生产实践中，Admate 经受住了对接微信进件的考验。
| 案例对比 | 技术栈 | 业务代码量 （表单部分） | Bug 数量 （表单部分） |
|---|---|---|---|
| 对接支付宝进件 | Vue 2 + ElementUI | 89293 字符 | 19 个 |
| 对接微信进件 | Vue 2 + ElementUI + Admate | 38718 字符 | 10 个 |
| 案例对比 | 技术栈 | 业务代码量 （整个页面） |
|---|---|---|
| 常规增删查改页面 | Vue 2 + ElementUI | 13330 字符 |
| 常规增删查改页面 | Vue 2 + ElementUI + Admate | 不是特别复杂的不会过万，简单点的三千字符可以搞定 |
https://www.npmjs.com/package/admate/v/0.5.4
将链接末尾替换为你想要查看的版本号即可
npm add admate vue@3 axios
# 2.7
npm add admate vue@2 axios
# 2.6及以下版本
npm add admate vue@2.6 axios @vue/composition-api
使用代码生成器生成页面模板
代码生成器不是必须的，它只是帮你省去从 YApi 复制字段名至代码中这一烦人步骤
目前仅支持 element-ui
安装 Chrome / Edge 插件 YApi2Code，或使用离线版：
下载离线包后解压
打开浏览器扩展程序，并开启开发者模式
点击加载已解压的扩展程序，选择解压后的文件夹
访问 YApi，选中相应模块的查询列表接口
点击浏览器右上角运行插件
点击生成代码，代码将被复制至剪贴板
创建页面文件 xxx.vue，粘贴代码
Vuetify@3 仍处于 Alpha 阶段，只有少量组件可用，暂无示例
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: {
// 查询一条记录（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>
import useAdmate from 'admate'
import { jsonToFormData, pickDeepBy } from 'kayran'
export default {
setup: () => {
// 过滤参数并转换为 FormData
// 此处示例为将过滤方法绑定到 window.FormData，方便其他地方使用
FormData.from = data => jsonToFormData(pickDeepBy(data, (v, k) => ![NaN, null, undefined].includes(v)))
// 直接转换为 FormData
//FormData.from = jsonToFormData
const admate = useAdmate({
getListProxy (getList, trigger) {
getList(FormData.from(list.filter))
},
})
return {
...admate,
r: (...args) => {
admate.form.status = 'r'
admate.openForm(...args)
},
u: (...args) => {
admate.form.status = 'u'
admate.openForm(...args)
},
FormData
}
}
}
</script>
list.filter
useAdmate({
list: {
// 可以在这里提供筛选参数的默认值
filter: {
[list.pageNumberKey]: 1,
},
// 必填
// 页码的参数名
pageNumberKey: undefined,
},
})
如果你的参数筛选项中包含 el-checkbox 组件，则必须在 data 中声明其初始值，否则将导致无法正确重置（element-ui 的 Bug）
<!-- 示例 -->
<template>
<el-form ref="listFilterRef" :model="list.filter" inline>
<el-form-item prop="effect">
<el-checkbox
v-model="list.filter.effect"
label="生效"
border
/>
</el-form-item>
<el-button @click="reset">重置</el-button>
</el-form>
</template>
<script>
import useAdmate from 'admate'
export default {
setup: () => useAdmate({
urlPrefix: '',
list: {
filter: {
effect: null
}
}
}),
}
</script>
查询 按钮触发
useAdmate({
list: {
watchFilter: false,
}
})
useAdmate({
list: {
watchFilter: true, // 默认值
// 节流间隔，单位毫秒
// 如果筛选参数不含 input 类型，可以设置为 0，即不节流
// 翻页不会触发节流
// watchFilter开启时有效
throttleInterval: 500, // 默认值
}
})
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>
import useAdmate from 'admate'
export default {
setup: () => {
const { list } = useAdmate()
return { list }
},
methods: {
handleTable () {
this.list.loading = true
this.$POST('').finally(() => {
this.list.loading = false
})
}
}
}
</script>
getList ：获取列表，在首次进入页面、列表筛选参数改变、单条记录增删查改后会被调用
const {
/**
* PS：以下为原始 getList 的函数签名，如果你配置了 getListProxy，则以 getListProxy 为准
*
* @param {any} [payload = list.filter]
* @param {'data'|'params'|'config'} [payloadAs] 指定 payload 的用途
* @returns {Promise<any>} 接口返回值
*/
getList
} = useAdmate()
getList() // 手动查询
getListProxy：你可以使用 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(caller)) {
currentInstance.value.$message.success('操作成功')
}
},
})
// 示例：获取列表后，修改列表数据
const { list } = useAdmate({
getListProxy (getList, trigger) {
getList().then(response => {
// response 为 axiosConfig.getList 的接口返回值
list.data = response.data?.filter(v => !v.disabled)
})
},
})
打开表单，提交时会调用 axiosConfig.c
const { form, openForm } = useAdmate()
// 将表单形态设置为“新增”，然后打开表单
form.status = 'c'
openForm()
打开表单，并调用 axiosConfig.r 回显表单内容
const { form, openForm } = useAdmate()
// 将表单形态设置为“查看”，然后打开表单
form.status = 'r'
/**
* PS：以下为原始 openForm 的函数签名，如果你配置了 openFormProxy ，则以 openFormProxy 为准
*
* @param {any} [payload]
* @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]
* @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 slot-scope="{ row: { id, status } }">
<el-switch @change="updateStatus({ id, status: status^1 })"/>
</template>
</el-table-column>
</el-table>
</template>
<script>
import useAdmate from 'admate'
export default {
setup: () => {
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()
return { updateStatus }
}
}
</script>
<!-- 方式二：使用 enable 和 disable -->
<template>
<el-table>
<el-table-column label="操作" align="center">
<template slot-scope="{ row: { id, status } }">
<el-switch @change="[enable,disable][status]({id})"/>
</template>
</el-table-column>
</el-table>
</template>
<script>
import useAdmate from 'admate'
export default {
setup: () => {
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()
return { enable, disable }
}
}
</script>
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>
import useAdmate from 'admate'
export default {
setup: () => {
const { form } = useAdmate({
form: {
data: {
a: {
b: {}
}
}
}
})
return { form }
}
}
</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.show: 表单是否打开
可能的值：
falsetrueform.status: 表单的形态
可能的值：
'c' 新增'r' 查看'u' 编辑'' 关闭form.show 为 false 时，form.status 为 ''
表单默认是对话框的形式，但也支持表单是独立页面 的情况
两种表单形式对比：
form.loading
axiosConfig.r 被调用时值为 true，否则为 false
不能将该值当作表单回显结束的标志，因为复用列表数据时不会调用 axiosConfig.r
<!-- 示例 -->
<template>
<el-dialog>
<el-form v-loading="form.loading"/>
</el-dialog>
</template>
<script>
import useAdmate from 'admate'
export default {
setup: () => {
const { form } = useAdmate()
return { form }
}
}
</script>
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>
import useAdmate from 'admate'
export default {
setup: () => {
const { form } = useAdmate()
return { form }
}
}
</script>
openForm ：打开表单，函数签名要分情况：
openFormProxy：你可以使用 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
}
}
})
submitForm ：提交表单，新增时调用 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：你可以使用 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,
}
}
})
将表单抽离为子组件
操作单条记录时，跳转到专用的表单页面，操作完毕后返回
表单默认打开，且无法关闭，通常用于列表中只有一条数据，故列表被省略的场景
嵌套其它也使用 Admate 的页面
FAQs
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
Michigan TypeScript founder Dmitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
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.