Skip to content

快速开始

本指南将通过渐进式示例,帮助您快速掌握 CURD 组件库的使用方法。

📦 起步

安装依赖

bash
pnpm add @uozi-admin/curd @uozi-admin/request
bash
npm install @uozi-admin/curd @uozi-admin/request
bash
yarn add @uozi-admin/curd @uozi-admin/request

全局配置

main.ts 中添加配置:

ts
import { createApp } from 'vue'
import { createCurdConfig } from '@uozi-admin/curd'
import App from './App.vue'

const app = createApp(App)

// 使用默认配置
app.use(createCurdConfig())

app.mount('#app')

📚 示例

第一个示例:只读表格

让我们从最简单的数据表格开始:

loading

第二个示例:添加搜索

为表格添加搜索功能:

loading

第三个示例:完整 CRUD

添加新增、编辑、删除功能:

loading

第四个示例:高级定制

添加自定义渲染和高级功能:

loading

📖 下一步学习

恭喜完成快速入门!现在您可以:

深入学习基础知识

探索组件功能

学习高级特性

🆘 常见问题

API 格式不匹配怎么办?

如果后端 API 格式与标准不符,可以自定义配置:

ts
app.use(createCurdConfig({
  listApi: {
    paginationMap: {
      params: {
        current: 'page',
        pageSize: 'page_size'
      },
      response: {
        total: 'total',
        current: 'current_page'
      }
    }
  }
}))

如何自定义表单控件?

可以传入自定义 Vue 组件:

ts
{
  title: '自定义字段',
  dataIndex: 'custom',
  edit: {
    type:MyCustomComponent
  }
}

需要更多帮助?

开始您的 CURD 开发之旅吧!🎉

根据 Apache-2.0 许可发布。