Skip to content

feat: preview support auto update #1261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
- [全局布局API](./api/frontend-api/global-layout-api.md)
- [物料API](./api/frontend-api/material-api.md)
- [设置面板API](./api/frontend-api/settings-panel-api.md)
- [预览API](./api/frontend-api/preview-api.md)
- 后端API
- [AI功能接口](./api/backend-api/ai-function-api.md)
- [应用管理](./api/backend-api/app-management.md)
Expand Down
65 changes: 65 additions & 0 deletions docs/api/frontend-api/preview-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 页面预览相关配置项


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

默认跳转逻辑(不配置):
- dev 本地开发:跳转到 preview.html。比如跳转到: `http://localhost:8090/preview.html?...`
- 生产环境:跳转到 /preview,比如跳转到: `https://opentiny.design/preview?...`

如果二次开发平台想要跳转到不同的路由,则可以进行配置:

### 直接配置 url

适用场景:仅修改跳转 url,不修改 query 查询字符串部分,比如:

```javascript
import { Preview } from '@opentiny/tiny-engine'
export default {
toolbars: [
[Preview, { options: { ...Preview.options, previewUrl: import.meta.env.MODE.includes('prod') ? 'http://tiny-engine-preview.com/customPreview' : '' } }]
]
}
```

配置完成之后,在生产环境,TinyEngine 会增加必要的 query部分,然后跳转到配置的 url,比如:`http://tiny-engine-preview.com/customPreview?tenant=1&id=1&...`。

### 使用配置函数

适用场景:需要增加自定义修改 query。可定制性高

例如:
```javascript
import { Preview } from '@opentiny/tiny-engine'
export default {
toolbars: [
[
Preview,
{
options: {
...Preview.options,
previewUrl: (originUrl, query) => {
// 这里我们增加了自定义的 query: `test=1`
return `http://tiny-engine-preview.com/customPreview?test=1&${query}`
}
}
}
]
]
}
```

## 热更新可配置开关

我们在 v2.5 版本中增加预览页面自动刷新的支持,如果您的业务中不需要预览页面自动刷新的热更新功能,可以在注册表中配置 `previewHotReload` 关掉:

```javascript
// preview.js

initPreview({
registry: {
config: { id: 'engine.config', theme: 'light', previewHotReload: false },
// ... other config
}
})
```
3 changes: 2 additions & 1 deletion docs/catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,8 @@
{ "title": "画布API", "name": "canvas-api.md" },
{ "title": "全局布局API", "name": "global-layout-api.md" },
{ "title": "物料API", "name": "material-api.md" },
{ "title": "设置面板API", "name": "settings-panel-api.md" }
{ "title": "设置面板API", "name": "settings-panel-api.md" },
{ "title": "预览API", "name": "preview-api.md" }
]
},
{
Expand Down
Loading