saltfish
Version:
An interactive video-guided tour system for web applications
44 lines • 1.29 kB
TypeScript
export interface ErrorDisplayOptions {
message?: string;
title?: string;
}
/**
* ErrorDisplay component provides a user-friendly error overlay within the player
* instead of completely replacing the player content with basic error text.
*/
export declare class ErrorDisplay {
private errorOverlay;
private container;
private options;
private isVisible;
constructor(container: HTMLElement, options?: ErrorDisplayOptions);
/**
* Creates the error display overlay with message
*/
private createErrorDisplay;
/**
* Shows the error display with optional new message and options
*/
show(newOptions?: Partial<ErrorDisplayOptions>): void;
/**
* Hides the error display
*/
hide(): void;
/**
* Updates the error display options and content
*/
updateOptions(newOptions: Partial<ErrorDisplayOptions>): void;
/**
* Gets user-friendly error message based on error type
*/
static getErrorMessage(error: Error | string, errorType?: string): string;
/**
* Checks if the error display is currently visible
*/
isShowing(): boolean;
/**
* Destroys the error display and cleans up resources
*/
destroy(): void;
}
//# sourceMappingURL=ErrorDisplay.d.ts.map