网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

自定义组件开发指南

更新时间:2024-11-13 GMT+08:00
分享

在这个快速发展的前端开发时代中,组件化是构建可维护和可扩展应用程序的关键。

本章节帮助您了解自定义模板结构及开发流程。

模板结构介绍

  • public文件夹通常是用来存放Web应用程序的静态资源。
  • src文件夹是用来存放源代码文件,它包含assets和components两个子文件夹。
    • assets:作为存放项目特定资源的地方。
    • components:用来存放应用程序的组件代码,如自定义的类、服务、工具类等。

模板文件介绍

所有的自定义组件都在src/components文件夹里面内开发,模板内提供了两个预置模板componentA和componentB,可直接在模板基础上进行开发,如需更多可复制添加。

图1 默认组件

components都包含三个文件,一个index.js,一个*.vue文件和一个componentBundle.json文件,其中index.js和componentBundle.json这两个文件名字不可更改。

图2 components文件夹
  • componentBundle.json:用于定义一组组件的元数据,包括组件的配置、依赖关系、版本信息等。
  • index.js:作为应用程序的入口文件,即程序启动时首先执行的脚本。
  • *.vue:用于定义Vue组件,包括模板(HTML)、脚本(JavaScript)和样式(CSS)。

组件协议结构规范

组件协议结构规范用于描述组件的关键信息和配置项,对应组件的components字段。

表1 组件协议结构规范

字段

说明

类型

name

组件名称,以“i18n”形式配置。

Object

component

组件名。

String

icon

组件图标。

String

screenshot

快照。

String

description

组件介绍描述。

String

npm

组件NPM包信息,会根据此描述引入npm源组件。

Object

npm.package

npm包名。

-

npm.exportName

需要从npm包中import的名称。

-

npm.version

package的版本。

-

npm.destructuring

是否以结构方式import。

-

npm.script

ESModule格式的JS文件CDN地址。

String

npm.css

样式文件CDN地址。

String

group

组件分组。

String

schema

组件元数据(定义属性、事件等)。

Object

configure

组件的属性信息。

Object

version

组件版本。

Object

组件元数据结构规范

组件元数据规范用于描述组件的对外API:属性、事件等,对应组件的schema字段。

表2 组件元数据结构规范

字段

说明

类型

properties

组件暴露的配置属性。

Array <Object>

events

组件暴露的事件。

Object

组件暴露配置属性项结构(properties[0])。

表3 配置属性项结构

字段

说明

类型

label

配置分类名。

Object

description

配置分类描述。

Object

collapse

配置项超出数量时收缩展示。

Object

content

属性项。

Array

content[0].property

配置的组件属性名称。

string

content[0].type

属性值的类型。

string

content[0].defaultValue

属性值的默认值。

string| boolean | number

content[0].label

展示的属性配置label

Object

content[0].cols

-

-

content[0].rules

属性值的校验规则。

Array

content[0].labelPosition

配置面板文本定位。

string

content[0].hidden

是否展示该属性配置。

boolean

content[0].required

是否必须配置该属性项。

boolean

content[0].readOnly

该属性项是否只读。

boolean

content[0].disabled

是否禁用配置该属性项。

boolean

content[0].widget

配置属性值的渲染组件和props。

Object

content[0].device

使用该属性的设备e.g. pc端,移动端,可选:pc,mobile。

string

widget.component

使用哪个组件来配置属性值,比如可选:MetaInput MetaSelect。

string

widget.props

属性值组件的props。

Object

使用模板开发样例

本示例中的imgbutton组件是使用nodejs开发前端的组件。以下若无特殊说明,均基于VSCode工具,按照imgbutton组件的功能点来介绍自定义组件的开发过程。

  1. 下载自定义组件模板,将自定义组件模板包解压。
  2. 修改工程定义文件“package.json”,将“name”修改成“imgbutton-package”,“version”修改为“0.0.1”,保存并退出。

    图3 修改包名及版本

  3. 修改src文件夹下的“components”文件夹及文件名,将“componentA”改为“imgButton”,如图所示。

    图4 修改文件夹及文件名

  4. 打开“componentBundle.json”文件,文件包含两个字段components和snippets。

    • components字段为一个对象,描述组件的关键信息和配置项。

      例如:编写组件的注册信息,包括组件的名称、文件路径、版本号等。

      "id": 1,
          "version": "2.4.2",//组件版本号
          "name": {
            "zh_CN": "img组件A" // 属性显示名称
          },
          "component": "imgButton",//组件名
          "icon": "custom-component",//组件图标
          "description": "图像按钮",//组件介绍描述
          "doc_url": "",
          "screenshot": "",
          "tags": "",
          "keywords": "",
          "dev_mode": "proCode",
          "npm": {
            "package": "",
            "version": "",
            "script": "",
            "css": "",
            "dependencies": null,
            "exportName": "imgButton"//需要从npm包中import的名称
          },

      编写组件元数据,例如:组件属性、事件等。

      "schema": {
            "properties": [
              {
                "name": "0",
                "label": {
                  "zh_CN": "基础属性"// 属性显示名称
                },
                "content": [
                  {
                    "property": "size",
                    "label": {
                      "text": {
                        "zh_CN": "size"// 属性显示名称
                      }
                    },
                    "description": {
                      "zh_CN": "尺寸"
                    },
                    "required": true,
                    "readOnly": false,
                    "disabled": false,
                    "cols": 12,
                    "labelPosition": "top",
                    "type": "string",
                    "defaultValue": "default",// 默认值
                    "widget": {
                      "component": "MetaSelect",
                      "props": {
                        "options": [
                          {
                            "label": "large",
                            "value": "large"
                          },
                          {
                            "label": "default",
                            "value": "default"
                          },
                          {
                            "label": "small",
                            "value": "small"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "property": "text",
                    "label": {
                      "text": {
                        "zh_CN": "type"// 属性显示名称
                      }
                    },
                    "description": {
                      "zh_CN": "类型"
                    },
                    "required": true,
                    "readOnly": false,
                    "disabled": false,
                    "cols": 12,
                    "labelPosition": "top",
                    "type": "string",
                    "defaultValue": "我是图像组件A",// 默认值
                    "widget": {
                      "component": "MetaInput",
                      "props": {}
                    }
                  }
                ],
                "description": {
                  "zh_CN": ""
                }
              }
            ],
            "events": {
              "onClick": {
                "label": {
                  "zh_CN": "点击时触发"// 事件名称
                },
                "description": {
                  "zh_CN": "点击时触发"// 事件描述信息
                },
                "type": "event",// 事件的type为event
                "functionInfo": {
                  "params": [],
                  "returns": {}
                },
                "defaultValue": ""
              }
            }
          }
      编写组件属性额外信息,例如:是否是容器,是否支持循环,是否支持快渲染等。
       "configure": {
            "loop": true,// 是否支持循环
            "condition": true,// 是否在画布中渲染
            "styles": true,
            "isContainer": true,//是否为容器
            "isModal": false,
            "isPopper": false,
            "nestingRule": {
              "childWhitelist": "",
              "parentWhitelist": "",
              "descendantBlacklist": "",
              "ancestorWhitelist": ""
            },
            "isNullNode": false,
            "isLayout": false,
            "rootSelector": "",
            "shortcuts": {
              "properties": [
                "type",
                "size"
              ]
            },
            "contextMenu": {
              "actions": [
                "copy",
                "remove",
                "insert",
                "updateAttr",
                "bindEevent",
                "createBlock"
              ],
              "disable": []
            },
            "invalidity": [
              ""
            ],
            "clickCapture": true,
            "framework": "Vue"
          },
    • snippets字段为一个对象,其中snippets.group为该自定义组件的分组标识。不同的组件可以拥有相同的group。
      "snippets": {
          "group": "自定义组件分类标题",
          "componentSnippets": {
            "name": {
              "zh_CN": "img组件A"
            },
            "icon": "custom-component",
            "screenshot": "",
            "snippetName": "imgButton",
            "schema": {
              "children": [
                {
                  "componentName": "Text",
                  "props": {
                    "text": "按钮文本"
                  }
                }
              ]
            }
          }
        }

    components和snippets字段更多的协议请参考物料资产包协议

  5. 打开imgButton.vue文件。开发实际的imgButton组件,确保可以在componentBundle.json中被引用。

    例如:
    // <template> 标签内编写组件的 HTML 结构。
    <template>
      <div :class="['show',size]">
        <h2>
          {{ text }}
        </h2>
        <Button :class="size" type="primary">这个是图像按钮组件</Button>
      </div>
    </template>
    
    // <script> 标签内定义组件的逻辑,包括组件名称、数据等。
    <script>
    export default {
      props: {
        size: {
          type: String,
          default: 'default'
        },
        text: {
          type: String,
          default: '我是img组件A'
        }
      }
    }
    </script>
    
    // <style> 标签内编写组件的 CSS 样式。
    <style scoped lang="less">
    h2 {
      color: red;
    }
    .show {
      color: #f99;
      padding-bottom: 50px;
    }
    
    .small {
      font-size: 12px;
    }
    
    .default {
      font-size: 16px;
    }
    
    .large {
      font-size: 18px;
    }
    </style>

  6. 修改应用开发工具控件定义文件,src\components\imgButton\index.js,将控件定义文件中的“componentA”修改为“imgButton”,“TestA”修改为“imgButton”,修改后效果如下图所示。

    图5 修改定义文件

  7. 修改main.js文件,确保导出组件成功,“componentA”修改为“imgButton”,“TestA”修改为“imgButton”,修改后效果如下图所示。

    图6 修改main.js文件

  8. 开发完成后,执行构建,例如,使用VSCode执行npm run build命令进行构建。

    说明:

    如果执行命令时提示找不到,请先使用“npm install”安装依赖。

    构建完成后将在本地生成压缩包,即开发完成的组件物料包。
    图7 执行构建

    打包的物料包会取根目录package.json里面的name和version进行命名压缩包名字,格式为“name+version”。例如,name为“imgbutton-package”,version为“0.0.1”,则压缩包名称为“imgbutton-package-0.0.1”。

    图8 命名规则
    图9 生成物料包

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容