@netless/window-manager 0.4.70 → 0.4.71

package/src/index.ts

@@ -126,6 +126,15 @@ export type AppInitState = {
 
 export type CursorMovePayload = { uid: string; state?: "leave"; position: Position };
 
+export type CursorOptions = {
+    /**
+     * If `"custom"`, it will render the pencil / eraser cursor as a circle and shapes cursor as a cross.
+     *
+     * @default "default"
+     */
+    style?: "default" | "custom";
+};
+
 export type MountParams = {
     room: Room | Player;
     container?: HTMLElement;
@@ -137,17 +146,22 @@ export type MountParams = {
     collectorStyles?: Partial<CSSStyleDeclaration>;
     overwriteStyles?: string;
     cursor?: boolean;
+    cursorOptions?: CursorOptions;
     debug?: boolean;
     disableCameraTransform?: boolean;
     prefersColorScheme?: TeleBoxColorScheme;
     applianceIcons?: ApplianceIcons;
     fullscreen?: boolean;
     polling?: boolean;
+    supportTeachingAidsPlugin?: boolean;
 };
 
 export const reconnectRefresher = new ReconnectRefresher({ emitter: internalEmitter });
 
-export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any> implements PageController {
+export class WindowManager
+    extends InvisiblePlugin<WindowMangerAttributes, any>
+    implements PageController
+{
     public static kind = "WindowManager";
     public static displayer: Displayer;
     public static wrapper?: HTMLElement;
@@ -156,6 +170,7 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     public static container?: HTMLElement;
     public static debug = false;
     public static containerSizeRatio = DEFAULT_CONTAINER_RATIO;
+    public static supportTeachingAidsPlugin?: boolean;
     private static isCreated = false;
 
     public version = __APP_VERSION__;
@@ -187,6 +202,7 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     public static async mount(params: MountParams): Promise<WindowManager> {
         const room = params.room;
         WindowManager.container = params.container;
+        WindowManager.supportTeachingAidsPlugin = params.supportTeachingAidsPlugin;
         const containerSizeRatio = params.containerSizeRatio;
         const debug = params.debug;
 
@@ -246,7 +262,12 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
         manager.appManager = new AppManager(manager);
         manager.appManager.polling = params.polling || false;
         manager._pageState = new PageStateImpl(manager.appManager);
-        manager.cursorManager = new CursorManager(manager.appManager, Boolean(cursor), params.applianceIcons);
+        manager.cursorManager = new CursorManager(
+            manager.appManager,
+            Boolean(cursor),
+            params.cursorOptions,
+            params.applianceIcons
+        );
         if (containerSizeRatio) {
             manager.containerSizeRatio = containerSizeRatio;
         }
@@ -293,16 +314,12 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
         manager: WindowManager,
         container: HTMLElement,
         params: {
-            chessboard?: boolean,
-            overwriteStyles?: string,
-            fullscreen?: boolean,
+            chessboard?: boolean;
+            overwriteStyles?: string;
+            fullscreen?: boolean;
         }
     ) {
-        const {
-            chessboard,
-            overwriteStyles,
-            fullscreen,
-        } = params;
+        const { chessboard, overwriteStyles, fullscreen } = params;
         if (!WindowManager.container) {
             WindowManager.container = container;
         }
@@ -578,7 +595,7 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
                 console.warn(`[WindowManager]: index ${index} out of range`);
                 return false;
             }
-            return this.appManager.removeSceneByIndex(needRemoveIndex);;
+            return this.appManager.removeSceneByIndex(needRemoveIndex);
         } else {
             return false;
         }
@@ -626,7 +643,10 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
      *
      * 返回一个用于撤销此监听的函数
      */
-    public onAppEvent(kind: string, listener: (args: { kind: string, appId: string, type: string, value: any }) => void): () => void {
+    public onAppEvent(
+        kind: string,
+        listener: (args: { kind: string; appId: string; type: string; value: any }) => void
+    ): () => void {
         return internalEmitter.on(`custom-${kind}` as any, listener);
     }
 
@@ -750,6 +770,17 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
         }
     }
 
+    public get cursorStyle(): "default" | "custom" {
+        return this.cursorManager?.style || "default";
+    }
+
+    public set cursorStyle(value: "default" | "custom") {
+        if (!this.cursorManager) {
+            throw new Error("[WindowManager]: cursor is not enabled, please set { cursor: true }.");
+        }
+        this.cursorManager.style = value;
+    }
+
     public get mainViewSceneIndex(): number {
         return this._pageState?.index || 0;
     }
@@ -979,8 +1010,8 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     }
 
     public refresh() {
-       this._refresh();
-       this.appManager?.dispatchInternalEvent(Events.Refresh);
+        this._refresh();
+        this.appManager?.dispatchInternalEvent(Events.Refresh);
     }
 
     /** @inner */
@@ -994,7 +1025,9 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
 
     public setContainerSizeRatio(ratio: number) {
         if (!isNumber(ratio) || !(ratio > 0)) {
-            throw new Error(`[WindowManager]: updateContainerSizeRatio error, ratio must be a positive number. but got ${ratio}`);
+            throw new Error(
+                `[WindowManager]: updateContainerSizeRatio error, ratio must be a positive number. but got ${ratio}`
+            );
         }
         WindowManager.containerSizeRatio = ratio;
         this.containerSizeRatio = ratio;

package/src/style.css

@@ -53,7 +53,6 @@
     height: 100%;
 }
 
-
 .netless-window-manager-cursor-pencil-image {
     width: 26px;
     height: 26px;

package/src/typings.ts

@@ -88,3 +88,8 @@ export type { SceneState, SceneDefinition, View, AnimationMode, Displayer, Room,
 export type { Storage, StorageStateChangedEvent, StorageStateChangedListener } from "./App/Storage";
 export * from "./Page";
 export * from "./Utils/error";
+
+export type AppPayload = {
+    appId: string,
+    view: View
+}