多维表格侧边栏插件开发指南

插件介绍

「插件」是多维表格推出的一个灵活、便捷的开放能力，你可以开发自定义插件，或使用共享插件，从而快速地完成重复任务、构建更强大的业务系统。详细介绍可见使用多维表格插件。

常见使用场景

•

根据自定义逻辑批量的处理记录（如删除重复记录等）

•

根据自定义逻辑批量的处理列数据（如查找替换、URL 转附件等）

•

基于多维表格数据开发一个自定义功能（如抽奖、导出内嵌图片的 Excel 等）

•
基于数据读写能力，将您的数据写入到多维表格后进行处理，或将数据处理后上传到您的业务系统。​

如需开发「连接器插件」，可查看​多维表格「连接器插件」开发者指南 ，连接器插件可以实现从外部数据同步到多维表格的功能。​

交流群

如有插件相关的反馈和需求，请加入以下社群讨论；如果你还不会写代码，可以入群提插件需求。​

准备工作

•

注册 Replit 账号 https://replit.com（可选，或者直接clone github 上模板（见下文中的“模板”）即可）。Replit 是一个在线、协同编程环境，你可以直接在浏览器中编写和运行代码，它支持多种语言，包括且不限于 JavaScript、Node.js、Python、Golang 等。

📌

只需一个有效的 URL 地址，你就能轻松使用我们的插件了。虽然这里我们以 Replit 平台为例，但无论是 Vercel、Github、localhost，还是你自己的服务器，只要部署了服务，我们的插件都能支持运行。​

前端插件与服务端插件的区别

读写多维表格数据

渲染页面与用户交互

关闭插件或多维表格后仍可运行

前端插件

✅

❌

服务端插件

✅

❌

✅

前后端结合插件

✅

前端插件

模板

多维表格提供了一系列的模板帮助你快速开发：

纯前端模板

仅使用前端 JS

如果你准备开发表单UI，或者你是非前端开发同学，想降低 UI 搭建成本，建议使用以下模板：​

UIBuilder 模板，github地址入口为src/runUIBuilder.tsx文件，具体使用方法见UIBuilder 模板使用指南

如果你有前端开发经验则可以使用以下模板来自由搭建 UI：

HTML 模板，github地址入口为 src/index.ts 文件

React 模板，github地址入口为 src/App.tsx 文件

Vue 模板，github地址入口为src/App.vue文件

前后端组合模板

nextjs无法静态部署，如需官方部署，请优先使用其他的模板。​

Nextjs 模板，前端入口为 pages/index.tsx 文件，服务端入口为pages/api目录下的文件

💡

请根据你的业务场景和技术栈，选择对应的模板然后点击右上角的 Fork 按钮将模板 Fork 到你的 Replit 账号内进行开发​

开发你的第一个前端插件

跟随指南我们将会初始化一个新增一行记录的前端插件，其功能如视频所示：​

多维表格侧边栏插件开发指南​

多维表格侧边栏插件开发指南