uniapp：插件开发指南

• 前言

• 一、前端组件

• 二、模板

• • 2.1、vue/nvue 页面模板

  • 2.2、项目模板

• 3、JS SDK

• 4、原生sdk

前言

=====================================================================

一、插件作者制作插件时，需注意以下几点：

1、前端建议使用scss预处理并引用uni.scss中的变量定义，保持各插件风格统一，方便插件使用者通过搭积木的方式开发整体风格一致的App。

2、遵循插件目录规范，其中比较重要的是确定插件使用名称，详细解释下方。

3、插件包中不需要包含 unpackage 目录。

4、插件包中不应该包含版本控制相关文件和目录，如 .git，.svn 等。

二、插件使用名称命名规范：

1、格式为：‘作者ID-插件名称’，示例：‘xiaoming-tag’，其中作者ID和插件名称只能包含英文、数字

2、作者ID由插件作者自定义，不能使用’DCloud’、'uni’等关键字，长度要求至少2位字符

3、插件名称需直观表达插件的作用，例如：tag、button等

Tips：

在不知道插件开发流程之前，可以参阅：https://blog.youkuaiyun.com/weixin_38633659/article/details/121939004。

一、前端组件

=========================================================================

我们以小明开发的tag组件（插件使用名称为：xiaoming-tag）为例，上传插件市场时，目录结构要求如下：

为保证代码简洁，上传插件时仅需包含必需的文件及目录。

若组件依赖三方组件，则需将三方组件一起打包上传；假设"xiaoming-tag"依赖小红开发的icon组件（xiaohong-icon），则发布"xiaoming-tag"插件时，目录结构要求如下：

Tips：

1、通用组件、nvue组件、目录结构要求相同

2、小程序组件的一级目录，名字需从 components 变更为 wxcomponents ，其它结构要求相同

3、不能包含根目录的 manifest.json、pages.json、App.vue、main.js 等文件

二、模板

=======================================================================

2.1、vue/nvue 页面模板

---

我们以小明开发的设置模板（xiaoming-setting）为例，上传插件市场时，目录结构要求如下：

若页面模板依赖其它组件，则需将依赖组件一起打包；假设"xiaoming-setting"依赖小红开发的list组件（xiaohong-list），则发布"xiaoming-setting"页面模板时，目录结构要求如下：

Tips：

1、vue 页面模板和 nvue 页面模板目录结构要求相同。

2、页面模板打包时需要包含 manifest.json、pages.json 等文件。

2.2、项目模板

---

项目模板无特殊要求，注意满足 uni-app 项目目录结构要求即可。

Tips：

1、项目模板打包时不需要包含 unpackage 目录；

2、项目模板打包时需要包含 manifest.json 文件。manifest.json 里不允许有 appid，包括 DCloud appid 或微信等三方 appid；

3、JS SDK

===========================================================================

开发JS SDK时，对目录结构无特殊要求，仅需将js文件命名为插件使用名称即可，例如：xiaoming-md5.js。