aipage-custom-widget-template

aipage-custom-widget-template

aipage-editor H5自定义组件模板（vue2、react）

目录说明

• src: 自定义组件源码；
• src/vue-widget: vue技术栈组件源码；
• src/react-widget/info-card.jsx: 自定义组件内容文件；
• src/react-widget/plugin.jsx: 用于注册一个amis-editor插件，注册成功后编辑器左侧组件面板中会展示；
• src/react-widget/index.js: 用于注册一个amis渲染器，注册成功后编辑器画布区中才会正常展示自定义组件内容；
• src/xxx/assets: 存放自定义组件组件静态资源，比如 css、img等，此处存放的静态资源会经过webpack构建；
• src/preview.js: 用于本地预览自定义组件内容；
• amis.config.js: amis-widget-cli配置文件。

开发 aipage-editor 自定义组件 注意事项

• 开发小程序和快应用自定义组件时，静态资源（img、css等）请和自定义组件渲染器放同一个目录

开发说明

1. 安装依赖

$ npm i 或者 yarn

1. dev: 本地开发模式（带热更新）

dev开发模式：用于在本地editor中调试自定义组件。

$ npm run dev

1. preview: 组件预览模式（带热更新）

preview模式：用于预览自定义组件内容。

$ npm run preview

1. linkDebug: 外链调试（amis-saas中预览自定义组件）

linkDebug模式：用于在amis-saas中预览和调试自定义组件。

$ npm run linkDebug

1. build2lib: 构建自定义组件输出产物

build2lib模式：用于构建发布到 npm 中的文件，默认存放到 当前dist目录中。

$ npm run build2lib

1. package.json添加自定义组件信息，导入组件扩展包时需要

package.json 中添加 aipage-widgets 字段，用于放置当前自定义组件信息，有这个aipage-widgets 字段才能被识别为自定义组件扩展包。

  ...
    "aipage-widgets": [
    {
      "name": "vue-info-card", // 自定义组件名称，必填项
      "framework": "vue2", // 技术栈类型，非必填项，默认为 react 技术栈
      "type": "vue-info-card", // 自定义组件类型，必填项，同一应用下不允许有重复的自定义组件类型
      "entry": "/dist/infoCard.umd", // 自定义组件入口文件路径，必填项
      "files": [  // 自定义组件依赖资源文件路径，非必填项
        "/dist/infoCard.css"
      ],
      "editorPlugin": {  // amis-editor自定义插件信息
        "name": "vue-info-card-plugin", // 自定义插件名称，在编辑器左侧组件面板作为title展示，必填项
        "description": "信息展示卡片", // 自定义插件描述，在编辑器左侧组件面板作为描述信息展示，必填项
        "pluginEntry": "/dist/infoCardPlugin.umd", // 自定义插件的入口文件，必填项
        "tag": [  // 自定义插件的分类，必填项
          "自定义组件"
        ],
        "sort": 100 // 自定义插件的排序，非必填项
      }
    },
    ... // 其他自定义组件
  ],
  ...
}

1. 发布一个NPM组件扩展包

需要确保package.json中的name值唯一，version值不重复。

$ npm publish

1. 发布到制定的NPM仓库

打开NPM配置文件（src/.npmrc），配置为制定仓库地址即可。

配置项说明（amis-widget-cli）

请查看amis-widget-cli