跳至主要內容

demo 配置

Thisky大约 3 分钟

demo 配置

{
  "name": "小组件",
  "summary": "这是天天工作台前端同学开发的项目。",
  "author": "天天工作台前端同学",
  "package": "com.thisky.tt",
  "version": "1.0.0",
  "logo": "/tcs.png",
  "modules": {
    "card": [
      {
        "entry": "/tcs.html",
        "size": "8x8",
        "preview": "/tcs.png"
      }
    ]
  }
}

配置开发须知

所有路径的配置都是需要填写 / 开头的相对路径

基础配置

必填项

属性名类型说明参考属性值
namestring项目名称
summarystring简短的一两句项目描述。
authorstring项目作者
versionstring项目的版本号,格式为:大版本号.次版本号.修订号1.0.0
logostring项目 logo
packagestring项目包名,唯一值,重复会进行覆盖。com.thisky.ttopen in new window
uidnumber在天天工作台注册后拿到的唯一用户 ID

可选项

属性名类型说明参考属性值
introducestring详细完整的项目介绍,支持 MD 格式
communitynumber填写社群 ID 后,主应用的导航栏会增加一个类似聊天的图标,用户可以直接点击此图标进入对应社群。
请先自行创建社群。
社群 ID
forum(等小胡对接)number填写元社区 ID 后,主应用的导航栏,左上角应用名称——>鼠标经过会展示信息,用户可以直接点击此图标进入对应社群。
请先自行创建社群。
元社区 ID
group(等金龙对接)number填写交流群 ID 后,主应用的导航栏,左上角应用名称——>左侧应用名称——>鼠标经过会展示信息,用户可以直接点击此图标进入对应社群。
请先自行创建交流群。
开发者交流群 ID
projectUrlstring主应用的导航栏,左上角应用名称——>关于,展示可访问你填写的项目地址

modules 模块配置

以下参数均填写需要在 modules 下

主应用 main object (可选)

必填项

属性名是否必传类型说明参考属性值
entry必选string需要打开的文件,默认通过 / 获取相对路径文件,同时支持 http 和 https 协议,开发时推荐使用自己的本地 url本地开发 http://localhost:5173/open in new window
编译后 /index.html
线上环境 https://xxxx.xxxxopen in new window
width必选string支持 px 和 % 两个单位100px
height必选string支持 px 和 % 两个单位100%

可选项

属性名是否必传类型说明参考属性值
config可选object应用配置对象,不常用可控参数都会存放于此
scroll可选boolean自带的滚动条,设置为 false 则不开启滚动条

config 可选项

暂无功能

属性名是否必传类型说明参考属性值

组件 card array (可选)

一个对象代表一个组件配置

必填项

属性名类型说明参考属性值
entrystring同主应用配置
sizestring默认卡片大小,只支持 偶数 x 偶数 的格式2x2 或者 4x4
previewstring卡片预览图,推荐尺寸 80*120

可选项

属性名类型说明参考属性值
modalboolean为 false 时,禁用小组件以弹窗形式打开
sizeListarray同时支持的卡片大小["8x8", "8x4", "4x4"]
resizeboolean可拖拽更改卡片大小
namestring组件显示的名称,不填取项目名称
scrollboolean自带的滚动条,设置为 false 则不开启滚动条
configobject组件的配置对象,不常用可控参数都会存放于此

config 可选项

暂无功能

属性名类型说明参考属性值

这个是模板,提供编译者复制

属性名类型说明参考属性值