@vvfx/sdk 0.2.2-beta.3 → 0.2.2-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/config.d.ts +16 -0
- package/dist/html-overlay/manager.d.ts +42 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +552 -42
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +552 -42
- package/dist/index.mjs.map +1 -1
- package/dist/layer-order.d.ts +7 -0
- package/dist/sdk.d.ts +14 -0
- package/dist/types.d.ts +15 -16
- package/package.json +2 -2
- package/dist/html-overlay/auto-height-runtime.test.d.ts +0 -1
- package/dist/html-overlay/manager.test.d.ts +0 -1
- package/dist/html-overlay/overlay-transform.test.d.ts +0 -1
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export type SDKCanvasLayers = {
|
|
2
|
+
container: HTMLElement;
|
|
3
|
+
playerContainer?: HTMLElement;
|
|
4
|
+
htmlOverlayLayer?: HTMLElement;
|
|
5
|
+
gestureCanvas?: HTMLElement;
|
|
6
|
+
};
|
|
7
|
+
export declare function orderSDKCanvasLayers({ container, playerContainer, htmlOverlayLayer, gestureCanvas, }: SDKCanvasLayers): void;
|
package/dist/sdk.d.ts
CHANGED
|
@@ -99,6 +99,7 @@ export declare class SDK {
|
|
|
99
99
|
on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput" | "undoRedoChange" | "maskGizmoUndoRedoChange" | "pictureCutGizmoUndoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextClick" | "videoPlay" | "itemCreate" | "cardItemTransformChange" | "viewLost" | "viewRebuildFinish">(eventName: E, listener: import("@galacean/effects").EventEmitterListener<SDKEvents[E]>, options?: import("@galacean/effects").EventEmitterOptions) => () => void;
|
|
100
100
|
initPlayer(mode: SDKMode): void;
|
|
101
101
|
setSDKMode(mode: SDKMode): void;
|
|
102
|
+
private syncCanvasLayerOrder;
|
|
102
103
|
private getInitParam;
|
|
103
104
|
private initExporter;
|
|
104
105
|
private initSDK;
|
|
@@ -513,6 +514,19 @@ export declare class SDK {
|
|
|
513
514
|
* @returns HTML 渲染配置
|
|
514
515
|
*/
|
|
515
516
|
resolveCardHTML(item: CardItem): CardHTML | undefined;
|
|
517
|
+
/**
|
|
518
|
+
* @description 按 cardType 从注册表解析卡片类型配置。
|
|
519
|
+
* @param item 卡片元素
|
|
520
|
+
* @returns 卡片类型配置
|
|
521
|
+
*/
|
|
522
|
+
resolveCardTypeConfig(item: CardItem): CardTypeConfig | undefined;
|
|
523
|
+
/**
|
|
524
|
+
* @description 重新解析并挂载指定卡片的 HTML 内容。
|
|
525
|
+
* @description 当 inline/document 内容依赖 extension 或外部状态变化时,可调用此方法刷新 DOM。
|
|
526
|
+
* @param id 卡片元素 ID
|
|
527
|
+
* @returns 是否成功触发刷新
|
|
528
|
+
*/
|
|
529
|
+
refreshCardHTML(id: string): boolean;
|
|
516
530
|
/**
|
|
517
531
|
* @description 创建卡片元素
|
|
518
532
|
* @description 底层以透明 SpriteItem 形式渲染,支持 cardType 属性
|
package/dist/types.d.ts
CHANGED
|
@@ -204,6 +204,17 @@ export type CardHTMLShellContent = {
|
|
|
204
204
|
*/
|
|
205
205
|
render: CardHTMLShellRenderer;
|
|
206
206
|
};
|
|
207
|
+
export type CardHTMLRootStyle = Record<string, string | number | undefined>;
|
|
208
|
+
export type CardHTMLRootConfig = {
|
|
209
|
+
/**
|
|
210
|
+
* @description 追加到 HTML 内容根节点的 className。
|
|
211
|
+
*/
|
|
212
|
+
className?: string;
|
|
213
|
+
/**
|
|
214
|
+
* @description 应用到 HTML 内容根节点的内联样式。
|
|
215
|
+
*/
|
|
216
|
+
style?: CardHTMLRootStyle;
|
|
217
|
+
};
|
|
207
218
|
/**
|
|
208
219
|
* @description Card HTML 覆盖层配置。
|
|
209
220
|
*/
|
|
@@ -216,6 +227,10 @@ export type CardHTML = {
|
|
|
216
227
|
* @description HTML 外壳,用于定制承载 content 的容器。
|
|
217
228
|
*/
|
|
218
229
|
shell?: CardHTMLShellContent;
|
|
230
|
+
/**
|
|
231
|
+
* @description HTML 内容根节点样式配置,用于按内容实例设置 className 或内联 style。
|
|
232
|
+
*/
|
|
233
|
+
root?: CardHTMLRootConfig;
|
|
219
234
|
};
|
|
220
235
|
/**
|
|
221
236
|
* @description Card 卡片元素属性
|
|
@@ -225,14 +240,6 @@ export type CardItemProperty = BaseItemProperty & {
|
|
|
225
240
|
* @description 卡片类型(动态配置,需通过 SDK.registerCardType/registerCardTypes 注册)
|
|
226
241
|
*/
|
|
227
242
|
cardType: string;
|
|
228
|
-
/**
|
|
229
|
-
* @description 是否根据 HTML 挂载内容的自然高度自动更新卡片高度
|
|
230
|
-
*/
|
|
231
|
-
autoHeight?: boolean;
|
|
232
|
-
/**
|
|
233
|
-
* @description HTML 内容是否跟随卡片 scale 缩放,关闭后 HTML 按最终显示尺寸重新布局
|
|
234
|
-
*/
|
|
235
|
-
autoScale?: boolean;
|
|
236
243
|
};
|
|
237
244
|
/**
|
|
238
245
|
* @description Frame 画板元素布局模式
|
|
@@ -970,14 +977,6 @@ export type CardCreateInfo = {
|
|
|
970
977
|
* @description 卡片元素像素高度
|
|
971
978
|
*/
|
|
972
979
|
height: number;
|
|
973
|
-
/**
|
|
974
|
-
* @description 是否根据 HTML 挂载内容的自然高度自动更新卡片高度
|
|
975
|
-
*/
|
|
976
|
-
autoHeight?: boolean;
|
|
977
|
-
/**
|
|
978
|
-
* @description HTML 内容是否跟随卡片 scale 缩放,关闭后 HTML 按最终显示尺寸重新布局
|
|
979
|
-
*/
|
|
980
|
-
autoScale?: boolean;
|
|
981
980
|
/**
|
|
982
981
|
* @description 卡片元素位置
|
|
983
982
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vvfx/sdk",
|
|
3
3
|
"description": "TODO",
|
|
4
|
-
"version": "0.2.2-beta.
|
|
4
|
+
"version": "0.2.2-beta.5",
|
|
5
5
|
"main": "./dist/index.mjs",
|
|
6
6
|
"module": "./dist/index.js",
|
|
7
7
|
"types": "./dist/index.d.ts",
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"prebuild": "pnpm clean",
|
|
69
69
|
"build": "pnpm build:declaration && pnpm build:module",
|
|
70
70
|
"build:module": "rollup -c --bundleConfigAsCjs",
|
|
71
|
-
"build:declaration": "tsc -
|
|
71
|
+
"build:declaration": "tsc -p tsconfig.build.json",
|
|
72
72
|
"clean": "rimraf dist *.tsbuildinfo",
|
|
73
73
|
"test": "vitest run"
|
|
74
74
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|