uni-app插件开发指南汇总

插件作者制作插件时,需注意两点:
- 前端建议使用scss预处理并引用uni.scss中的变量定义,保持各插件风格统一,方便插件使用者通过搭积木的方式开发整体风格一致的App
- 遵循插件目录规范,其中比较重要的是确定插件使用名称,详细解释下方。

插件使用名称命名规范:
1. 格式为:'作者ID-插件名称',示例:'xiaoming-tag',其中作者ID和插件名称只能包含英文、数字
2. 作者ID由插件作者自定义,不能使用'DCloud'、'uni'等关键字,长度要求至少2位字符
3. 插件名称需直观表达插件的作用,例如:tag、button等

组件

\n

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

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

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

Tips:
- 通用组件、nvue组件、小程序组件目录结构要求相同。

模板

\n

vue/nvue 页面模板

\n

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

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

Tips:
- vue 页面模板和 nvue 页面模板目录结构要求相同。

项目模板

\n

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

JS SDK

\n

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

原生sdk

\n

Android开发参考:https://ask.dcloud.net.cn/article/35416
iOS开发参考:https://ask.dcloud.net.cn/article/35415

注意压缩包为标准zip格式,不要把rar等其他格式改名为zip


4 分享 关注
DCloud_UNI_mehaotian admin@liaosongfa.com sonicsunsky@qq.com lazywe@163.com
DCloud_MUI_CHB

DCloud_MUI_CHB 回复 新的一天

插件使用名称需和目录结构保持一致,按照你的附件,i-calendar 实际上是不能作为插件使用名称的,格式为:'作者ID-插件名称',作者ID目前要求至少2位字符。
0 赞 2019-01-07 15:12
lazywe@163.com

lazywe@163.com

尴尬
0 赞 2019-01-04 18:55
新的一天

新的一天

好恶心,上传搞了快一个小时就是无法上传,一直提示插件压缩包格式不正确
0 赞 2019-01-04 18:32
余红杰

余红杰 回复 DCloud_MUI_CHB

只有一个components的时候只需要压缩这个components文件,群里有人说了
0 赞 2018-12-29 18:50
DCloud_MUI_CHB

DCloud_MUI_CHB 回复 余红杰

你的目录看起来没问题,上传还有问题的话,可以把插件压缩包发邮件到service@dcloud.io,我们检查一下。
0 赞 2018-12-29 17:10
余红杰

余红杰

插件压缩包格式不正确。详情参考:https://ask.dcloud.net.cn/article/35408
每次都提示。这片文章有问题吧?
hj-dragabledrawer.zip 下目录:
-components
--hj-dragabledrawer
---hj-dragabledrawer.vue
1 赞 2018-12-29 13:04

要回复文章请先登录注册