@netless/app-slide 0.2.17 → 0.2.18

package/dist/SlideController/index.d.ts

@@ -15,11 +15,16 @@ export interface SlideControllerOptions {
     onTransitionEnd: () => void;
     onError: (args: {
         error: Error;
+        index: number;
     }) => void;
+    onRenderError?: (error: Error, pageIndex: number) => void;
+    showRenderError?: boolean;
 }
 export declare class SlideController {
     readonly context: SlideControllerOptions["context"];
     readonly slide: Slide;
+    readonly showRenderError: boolean;
+    readonly onRenderError?: (error: Error, pageIndex: number) => void;
     private readonly room?;
     private readonly player?;
     private readonly sideEffect;
@@ -30,7 +35,7 @@ export declare class SlideController {
     private syncStateOnceFlag;
     private visible;
     private savedIsFrozen;
-    constructor({ context, anchor, onPageChanged, onTransitionStart, onTransitionEnd, onError, }: SlideControllerOptions);
+    constructor({ context, anchor, onPageChanged, onTransitionStart, onTransitionEnd, onError, onRenderError, showRenderError, }: SlideControllerOptions);
     ready: boolean;
     private resolveReady;
     readonly readyPromise: Promise<void>;

package/dist/SlideDocsViewer/index.d.ts

@@ -29,8 +29,9 @@ export declare class SlideDocsViewer {
     protected renderSlideContainer(): HTMLDivElement;
     protected renderWhiteboardView(): HTMLDivElement;
     mount(): this;
-    protected onError: ({ error }: {
+    protected onError: ({ error, index }: {
         error: Error;
+        index: number;
     }) => void;
     protected onRenderEnd: () => void;
     protected refreshPages: () => void;

package/dist/index.d.ts

@@ -3,7 +3,8 @@ import type { ISlideConfig } from "@netless/slide";
 import type { Attributes, MagixEvents } from "./typings";
 import type { AddHooks, FreezableSlide } from "./utils/freezer";
 import { Slide } from "@netless/slide";
-import { DefaultUrl } from "./SlideController";
+import { DefaultUrl, SlideController } from "./SlideController";
+import { SlideDocsViewer } from "./SlideDocsViewer";
 import { apps, FreezerLength, addHooks } from "./utils/freezer";
 export type { PreviewParams } from "./SlidePreviewer";
 export { SlidePreviewer, default as previewSlide } from "./SlidePreviewer";
@@ -12,6 +13,7 @@ export { Slide };
 export declare const usePlugin: (plugin: any) => any;
 export declare const version: string;
 export { DefaultUrl, apps, FreezerLength, addHooks };
+export { setFreezerLength, getFreezerLength, onCreated, onDestroyed } from "./utils/freezer";
 export interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "navigatorDelegate" | "fixedFrameSize" | "logger"> {
     /** show debug controller */
     debug?: boolean;
@@ -29,13 +31,19 @@ export interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCac
     autoResolution?: boolean;
     /** 1~4, default: 3 */
     maxResolutionLevel?: number;
+    /** custom error handler */
+    onRenderError?: (error: Error, pageIndex: number) => void;
+    /** whether to show an overlay of error message @default: true */
+    showRenderError?: boolean;
 }
 export interface ILogger {
     info?(msg: string): void;
     error?(msg: string): void;
     warn?(msg: string): void;
 }
-export interface Controller {
+export interface AppResult {
+    viewer: () => SlideDocsViewer | null;
+    controller: () => SlideController | null | undefined;
     slide: () => Slide | undefined;
     position: () => [page: number, pageCount: number] | undefined;
     nextStep: () => boolean;
@@ -44,5 +52,5 @@ export interface Controller {
     prevPage: () => boolean;
     jumpToPage: (page: number) => boolean;
 }
-declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, Controller>;
+declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult>;
 export default SlideApp;