开发规范
本文主要介绍项目文件及组件的必备属性。
文件概览
对于package.json,只需要关注以下属性。
{
"name": "mycoms",
"version": "1",
"description": "我的组件包",
"filename": "remoteEntry.js",
"exposes": {
"Demo1": "./src/app/demo1/demo1.component.ts",
"Demo2": "./src/app/demo2/demo2.component.ts"
},
…
}
组件模板为单包多组件,每次创建一个新的组件之后,必须手动在exposes中定义要导出的组件路径。
组件目录如下:
默认组件为html、css、ts分离。
组件属性
属性 | 类型 | 描述 | |
---|---|---|---|
基础 | attr | ComponentAttr | 组件的基本属性,包括宽高、透明度、翻转等。 |
样式 | config | GuiConfigs | 组件样式的 GUI 配置项。 |
options | ComponentOptions | 组件样式的默认值,GUI 表单可以改变 options。 | |
数据 | apis | ComponentApis | 组件数据的 API 配置,包括处理方法及字段定义。 |
data | ComponentData | 组件的静态数据,也是初始化数据。 | |
交互 | events | ComponentEvents | 组件可触发的事件。 |
actions | ComponentActions | 组件可执行的动作(函数)。 |
组件钩子
钩子函数 | 类型 | 说明 |
---|---|---|
init | () => void | 组件初始化时被调用。 |
destroy | () => void | 组件销毁时被调用。 |
render | (data: any, options?: any) => void | 组件的数据渲染方法,在 apis 属性中定义。 |
updateOptions | (options: any) => void | GUI 配置项更新时调用。 |
resize | (width?: number, height?: number) => void | 组件尺寸变更时调用。 |