@jx-common/wx

小程序前端公共组件库

安装方式

npm install @jx-common/wx --save

使用方式

使用jx前缀，作为标识。

"usingComponents": {
    "jx-category-selector": "@jx-common/wx/components/category-selector"
}

服务使用方式

import $storage from "@jx-common/wx/service/storage";

组件清单

|-  components/
|-  |-  base-picker/            通用picker选择器
|-  |-  base-search-input/      基础搜索框
|-	|-	category-selector/		类别选择组件
|-	|-	icon/					图标组件
|-	|-	image-preview/			图片(拍照)上传/预览组件
|-	|-	time-period-selector/	时间周期选择器
|-  |-  ...
|-  service/
|-  |-  storage/                缓存服务
|-  |-  ...

API文档生成

在执行 npm run watch时，会扫描/src/plugin/目录下代码的注释。并将可识别的注释缓存，项目启动后填充到文档组件中。

只能识别 /* …. */注释。

*注释格式对齐规范，否则可能出现预期之外的错误；

Properties

输入属性可扫描注解如下

    /**
     * 说明
     *
     * @desc 描述
     * @type 类型
     * @default 默认值
     */
    columns: {
    ...
    },

Events

输出属性可扫描注解如下

在事件发射上面加上注解，必须以 triggerEvent: [eventName] 起头。

/**
 * triggerEvent: eventName
 *
 * 说明
 * @desc 描述
 * @return 输出值类型
 */
this.triggerEvent('eventName', value);