Skip to content

Commit df06dd3

Browse files
authored
Merge branch 'opentiny:develop' into feat/materials
2 parents 511deaf + 4e93aa6 commit df06dd3

109 files changed

Lines changed: 437 additions & 542 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

designer-demo/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "designer-demo",
33
"private": true,
4-
"version": "2.6.0-rc.0",
4+
"version": "2.7.0-rc.0",
55
"type": "module",
66
"scripts": {
77
"dev": "cross-env vite",

packages/design-core/public/i18n-mock/i18n-template-for-batch-import.zip renamed to designer-demo/public/i18n-template-for-batch-import.zip

File renamed without changes.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
- [前后端启动联调(Java服务端)](./development-getting-started/debugging-of-java-backend.md)
4949
- 更新日志
5050
- [更新日志](./changelog/changelog.md)
51-
- [v2.6升级指南](./changelog/v2.6-upgrade-guide.md)
51+
- [v2.7升级指南](./changelog/v2.7-upgrade-guide.md)
5252
- 解决方案
5353
- [Java服务端部署](./solutions/server-deployment-solution-java.md)
5454
- [Node.js服务端部署](./solutions/server-deployment-solution.md)

docs/api/frontend-api/globalService-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
默认值:true
1919

20-
描述:defaultGlobalService 会读取 app 信息,根据 app 的信息配置网页的标题为:`${app.name}-TinyEditor设计器`
20+
描述:defaultGlobalService 会读取 app 信息,根据 app 的信息配置网页的标题为:`${app.name} —— TinyEngine 前端可视化设计器`
2121

2222
如果需要自定义标题,可以设置为 false。然后通过 document.title 来设置标题
2323

docs/api/frontend-api/material-api.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,6 @@ const material = useMaterial().getMaterial('ComponentName')
129129
// 生成组件节点
130130
const node = useMaterial().generateNode({ type: 'component', component: 'Button' })
131131

132-
// 注册新区块
133-
await useMaterial().registerBlock('blockName')
134-
135132
// 刷新物料
136133
await useMaterial().refreshMaterial()
137134
```

docs/api/frontend-api/preview-api.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,64 @@
11
# 页面预览相关配置项
22

3+
## 在页面预览入口添加物料配置
4+
5+
> **⚠️ Breaking Change (v2.6)**
6+
> 在 v2.6 版本中,我们对页面预览配置进行了破坏性调整,现在需要在物料入口 `preview.js` 中直接配置物料信息,不再通过 URL 参数传递物料相关的 script 和 css 资源。
7+
8+
### 基本配置
9+
10+
`preview.js` 文件中,需要在注册表的 `engine.config` 配置中添加 `material` 属性:
11+
12+
```javascript
13+
import { initPreview, META_SERVICE, HttpService } from '@opentiny/tiny-engine'
14+
15+
// 其他配置...
16+
17+
const registry = {
18+
[META_SERVICE.Http]: HttpService,
19+
'engine.config': {
20+
id: 'engine.config',
21+
theme: 'light',
22+
// 新增:物料配置
23+
material: ['/mock/bundle.json']
24+
}
25+
}
26+
27+
initPreview({
28+
registry
29+
})
30+
```
31+
32+
### 配置说明
33+
34+
- `material`:物料包配置数组,支持配置多个物料包
35+
- 每个物料包可以是一个 JSON 文件路径,包含物料的元数据、组件定义、样式等信息
36+
- 物料包的资源(script、css)会根据配置自动加载,无需在 URL 中传递
37+
38+
### 多物料包配置示例
39+
40+
```javascript
41+
const registry = {
42+
[META_SERVICE.Http]: HttpService,
43+
'engine.config': {
44+
id: 'engine.config',
45+
theme: 'light',
46+
// 配置多个物料包
47+
material: [
48+
'/mock/bundle.json', // 基础物料包
49+
'/custom/business-bundle.json', // 业务物料包
50+
'/third-party/ui-bundle.json' // 第三方物料包
51+
]
52+
}
53+
}
54+
```
55+
56+
### 迁移指南
57+
58+
如果您从 v2.5 或更早版本升级到 v2.6,请按以下步骤进行迁移:
59+
60+
1.`preview.js``engine.config` 中添加 `material` 配置
61+
2. 确保物料包 JSON 文件路径正确且可访问
362

463
## 配置预览页面的跳转 url
564

docs/catalog.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
"name": "changelog",
8888
"articles": [
8989
{ "title": "更新日志", "name": "changelog.md" },
90-
{ "title": "v2.6升级指南", "name": "v2.6-upgrade-guide.md" }
90+
{ "title": "v2.7升级指南", "name": "v2.7-upgrade-guide.md" }
9191
]
9292
},
9393
{

docs/changelog/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# 更新日志
22

3-
## v2.6
3+
## v2.7
44

55
### 升级指南
66

7-
[v2.6 升级指南](./v2.6-upgrade-guide.md)
7+
[v2.7 升级指南](./v2.7-upgrade-guide.md)
88

99
### What's Change
1010

@@ -22,7 +22,7 @@
2222

2323
#### 📚 Documentation
2424

25-
- 新增 [v2.6 升级指南](./v2.6-upgrade-guide.md)
25+
- 新增 [v2.7 升级指南](./v2.7-upgrade-guide.md)
2626
- 新增 [新注册表](../extension-capabilities-overview/new-registry.md) 文档
2727
- 新增 [注册表高级配置](../extension-capabilities-overview/new-registry-advanced.md) 文档
2828

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# v2.6 升级指南
1+
# v2.7 升级指南
22

3-
> 本文档为 v2.6 版本的升级指南,主要介绍了 v2.6 版本的主要新特性、升级步骤和注意事项。
3+
> 本文档为 v2.7 版本的升级指南,主要介绍了 v2.7 版本的主要新特性、升级步骤和注意事项。
44
>
5-
> 升级前请先阅读 [v2.6 更新日志](./changelog.md),了解 v2.6 版本的变更内容。
5+
> 升级前请先阅读 [v2.7 更新日志](./changelog.md),了解 v2.7 版本的变更内容。
66
77
## 主要变更内容
88

99
### 1. 注册表声明方式变更
1010

11-
v2.6 版本对注册表的声明方式进行了重大调整,采用了基于唯一 ID 的新注册方式,使配置更加灵活和精确。
11+
v2.7 版本对注册表的声明方式进行了重大调整,采用了基于唯一 ID 的新注册方式,使配置更加灵活和精确。
1212

1313
#### 旧版注册表方式
1414

@@ -74,15 +74,15 @@ const register = {
7474
3. 移除不需要的插件时,将其值设置为 `false`
7575
4. 添加新插件时,确保使用与官方插件不同的唯一 ID
7676

77-
> **重要提示⚠️**:v2.6 开始,如果对原插件没有改动(配置、替换、删除),则不需要在注册表中进行声明,因为官方内置了全量的注册表。
77+
> **重要提示⚠️**:v2.7 开始,如果对原插件没有改动(配置、替换、删除),则不需要在注册表中进行声明,因为官方内置了全量的注册表。
7878
7979
详细内容请参考 [新注册表](../extension-capabilities-overview/new-registry.md)
8080

8181
## API 变更
8282

8383
### @opentiny/tiny-engine-meta-register 包 API 变化
8484

85-
v2.6 版本对 `@opentiny/tiny-engine-meta-register` 包的 API 进行了重大重构,以下是主要变化:
85+
v2.7 版本对 `@opentiny/tiny-engine-meta-register` 包的 API 进行了重大重构,以下是主要变化:
8686

8787
#### 移除的 API
8888

@@ -190,7 +190,7 @@ await initHotfixRegistry({
190190

191191
### registryPath 配置
192192

193-
**重要说明⚠️**:v2.6 版本开始,为了使注册表的 tree-shaking 功能正常工作,您需要在 `vite.config.js` 中配置 `registryPath` 参数。
193+
**重要说明⚠️**:v2.7 版本开始,为了使注册表的 tree-shaking 功能正常工作,您需要在 `vite.config.js` 中配置 `registryPath` 参数。
194194

195195
```javascript
196196
// vite.config.js
@@ -217,7 +217,7 @@ export default defineConfig((configEnv) => {
217217

218218
### 2. 布局(layout)变更
219219

220-
v2.6 版本对布局配置进行了优化,使布局更加灵活可配置。
220+
v2.7 版本对布局配置进行了优化,使布局更加灵活可配置。
221221

222222
#### 布局配置变更
223223

@@ -272,7 +272,7 @@ export default {
272272

273273
#### 3.1 插件 `align` 配置的废弃
274274

275-
在 v2.6 版本中,插件的 `align` 配置属性已被废弃,不再作为定位插件位置的方式。新版本中应使用 `layoutConfig``relativeLayoutConfig` 来定位插件。
275+
在 v2.7 版本中,插件的 `align` 配置属性已被废弃,不再作为定位插件位置的方式。新版本中应使用 `layoutConfig``relativeLayoutConfig` 来定位插件。
276276

277277
旧版写法:
278278
```javascript
@@ -317,7 +317,7 @@ const register = {
317317

318318
#### 3.2 插件 `type: setting` 配置的废弃
319319

320-
在 v2.6 版本中,右侧设置面板插件不再使用 `type: 'setting'` 来标识,而是统一使用插件 ID 来区分。
320+
在 v2.7 版本中,右侧设置面板插件不再使用 `type: 'setting'` 来标识,而是统一使用插件 ID 来区分。
321321

322322
旧版写法:
323323
```javascript
@@ -363,7 +363,7 @@ const register = {
363363

364364
### 4. 注册表热修复功能
365365

366-
v2.6 版本新增了注册表热修复(hotfix)功能,可以通过覆盖官方插件的特定函数或模板,实现紧急 bug 修复,而不需要等待官方版本发布。
366+
v2.7 版本新增了注册表热修复(hotfix)功能,可以通过覆盖官方插件的特定函数或模板,实现紧急 bug 修复,而不需要等待官方版本发布。
367367

368368
```javascript
369369
// hotfix 注册表示例
@@ -390,7 +390,7 @@ export default {
390390

391391
## 其他改进
392392

393-
- **默认注册表内置**:v2.6 版本内置了全量的默认注册表,如果对原插件没有改动(配置、替换、删除),则不需要在注册表中进行声明。
393+
- **默认注册表内置**:v2.7 版本内置了全量的默认注册表,如果对原插件没有改动(配置、替换、删除),则不需要在注册表中进行声明。
394394

395395
## 升级步骤建议
396396

docs/extension-capabilities-overview/new-registry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 注册表(新)
22

3-
⚠️注意:该文档仅适用于 TinyEngine v2.6+ 版本,如果需要了解旧的注册表配置方式,请参考 [旧注册表](./registry.md)
3+
⚠️注意:该文档仅适用于 TinyEngine v2.7+ 版本,如果需要了解旧的注册表配置方式,请参考 [旧注册表](./registry.md)
44

55
## 什么是注册表
66

@@ -56,7 +56,7 @@ const register = {
5656
通过这种基于ID的注册方式,可以更精细地控制平台的各个部分,实现添加、替换或移除特定功能,而不需要重新配置整个注册表结构。
5757

5858

59-
注意⚠️:v2.6 开始,如果对原插件没有改动(配置、替换、删除),则不需要在注册表中进行声明,因为官方内置了全量的注册表:
59+
注意⚠️:v2.7 开始,如果对原插件没有改动(配置、替换、删除),则不需要在注册表中进行声明,因为官方内置了全量的注册表:
6060

6161
官方默认的全局注册表,请参考 [默认注册表](https://github.com/opentiny/tiny-engine/blob/develop/packages/design-core/registry.js)
6262

0 commit comments

Comments
 (0)