Skip to content

配置说明

微应用包含两个主要配置文件:app.config.jscomponents.config.js

应用配置 (app.config.js)

定义微应用的基础信息、权限和国际化支持。

基础配置

参数类型必填说明
authorstring作者标识,用于生成组件标签名前缀,不能含特殊符号
microAppIdstring应用唯一标识,格式为 作者-应用名
versionstring版本号,遵循语义化版本规范
entrystring入口文件路径,如 'main.js'
iconstring应用图标文件名(位于 public 目录)

应用信息 (appInfo)

用于配置应用的国际化信息,支持多语言显示。

国际化信息

语言标识符遵循 IETF BCP 47 标准:

  • zh-CN - 简体中文
  • en-US - 英语
  • zh-TW - 繁体中文
  • ja-JP - 日语
  • ko-KR - 韩语

语言标识对应的参数:

参数类型必填说明
appNamestring应用名称
descriptionstring-应用描述
networkDescriptionstring-网络请求说明

权限配置 (permissions)

声明应用所需的权限,如网络请求、数据节点等。详见 权限声明

网络域名白名单 (networkDomains)

当声明 network 权限时,必须配置允许访问的域名白名单。详见 权限声明

数据节点配置 (dataNodes)

配置应用的持久化数据存储节点。详见 数据节点

完整示例

javascript
export default {
  // 基础信息
  author: 'hslr',
  microAppId: 'hslr-weather',
  version: '1.0.0',
  entry: 'main.js',
  icon: 'logo.png',

  // 国际化信息
  appInfo: {
    'zh-CN': {
      appName: '天气',
      description: '查看各地天气数据',
      networkDescription: '首次安装后下载必要的配置数据'
    },
    'en-US': {
      appName: 'Weather',
      description: 'View weather data worldwide',
      networkDescription: 'Download necessary config data on first run'
    }
  },

  // 权限配置
  permissions: [
    'network',     // 网络权限
    'dataNode'     // 数据节点权限
  ],

  // 网络域名白名单
  networkDomains: [
    'api.example.com'
  ],

  // 数据节点配置
  dataNodes: {
    // 节点名
    config: {
      scope: 'app',
      isPublic: true
    }
  }
};

组件配置 (components.config.js)

注册页面和小部件组件。

完整示例

javascript
import HelloWorldConfig from '../src/components/widgetConfig.js';
import HelloWorldWidget from '../src/components/widget.js';

export default {
  // 页面注册
  pages: {
    'hello-world-config': {
      component: HelloWorldConfig,
      background: 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)',
      headerTextColor: '#ffffff'
    }
  },

  // 小部件注册
  widgets: {
    'hello-world-widget': {
      component: HelloWorldWidget,
      configComponentName: 'hello-world-config',
      size: ['1x1', '1x2', '2x1', '2x2', '2x4', '1xfull'],
      background: '',
    },
  },
};

页面组件类型

微应用的页面组件分为两种类型:

类型标识说明
小部件配置组件config会在添加小部件时作为引导添加页面打开,或通过小部件右键菜单「小部件配置」打开
首页面组件main会在同一微应用列表处统一入口打开(暂未实现统一入口),或在微应用内任意处使用 this.api.window.open("主页面名称") 打开

可通过 type 字段指定页面类型,默认为 config

页面配置参数

参数类型必填说明
componentclass页面组件类
backgroundstring-背景样式(CSS background 属性)
headerTextColorstring-头部文字颜色
typestring-页面类型,可选值:main(主页面)、config(小部件配置页面),默认为 config

小部件配置参数

参数类型必填说明
componentclass小部件组件类
configComponentNamestring-对应的配置页面名称(配置后会在添加组件、小部件的右键菜单打开页面配置组件的窗口)
sizestring[]支持的网格尺寸
backgroundstring-默认背景颜色

支持的网格尺寸

尺寸说明(行x列)适用场景
1x11格×1格迷你组件
1x21格×2格纵向窄卡片
2x12格×1格横向窄卡片
2x22格×2格标准卡片
2x42格×4格大卡片
1xfull1格×全屏宽全屏宽度展示

命名规范

  • microAppId:使用 作者-功能 格式,如 hslr-weather
  • 页面名称:使用小写字母和连字符,如 weather-config
  • 小部件名称:使用小写字母和连字符,如 weather-widget

Released under the MIT License.