@gembox/pdfviewer 2026.5.101 → 2026.5.103

package/dist/es/pdfviewer.d.ts

@@ -1,42 +1,2235 @@
-import { ApplicationContext } from "./models/application-context.ts";
-export interface ViewerOptions {
-    container: HTMLElement | string;
-    initialDocument?: string | Uint8Array | ArrayBuffer | null;
-    theme?: "light" | "dark" | "red" | "dark-red" | "blue" | "dark-blue" | "green" | "dark-green" | null;
-    visibility?: VisibilityOptions | null;
-    localization?: "en" | "de" | "es" | NestedMessages | null;
-    digitalSigning?: DigitalSignatureOptions | null;
-}
-export interface VisibilityOptions {
-    sideMenu?: boolean | null;
-    open?: boolean | null;
-    download?: boolean | null;
-    print?: boolean | null;
-    pageNavigation?: boolean | null;
-    zoom?: boolean | null;
-    panMode?: boolean | null;
-    search?: boolean | null;
-}
-export interface DigitalSignatureOptions {
-    serverUrl: string;
-    autoDownload?: boolean | null;
-    apiPassword?: string | null;
-}
-export interface NestedMessages {
-    [key: string]: string | NestedMessages;
-}
-export declare class GemBoxPdfViewer {
-    private applicationContext;
-    private static releaseDate;
-    private static licensing;
-    constructor(applicationContext: ApplicationContext);
-    open(document: string | Uint8Array | ArrayBuffer): Promise<void>;
-    static setLicense(licenseKey: string): void;
-    private static validate;
-    static create(options: ViewerOptions): Promise<GemBoxPdfViewer>;
-    setZoom(zoom: number | "fitPage" | "fitWidth"): void;
-    setCurrentPage(page: number): void;
-    getCurrentPage(): number;
-    getPageCount(): number;
-    search(text: string | null): void;
-}
+/**
+ * Represents an annotation in a PDF document.
+ */
+export declare interface Annotation {
+    /**
+     * Gets the index of the page where this annotation is located.
+     *
+     * @remarks
+     * This value represents the zero-based index of the page in the PDF document.
+     */
+    readonly pageIndex: number;
+    /**
+     * Gets the type of this annotation.
+     *
+     * @remarks
+     * The annotation type categorizes the annotation (e.g. e-signature).
+     */
+    readonly type: AnnotationType;
+    /**
+     * Gets the name or title of this annotation.
+     *
+     * @remarks
+     * This is typically a short descriptive label for the annotation.
+     */
+    readonly name: string;
+    /**
+     * Gets the description or content of this annotation.
+     *
+     * @remarks
+     * This contains the main text or content associated with the annotation.
+     */
+    readonly description: string;
+}
+
+/**
+ * Represents an event that is emitted when a new annotation has been successfully created.
+ *
+ * @remarks
+ * This event is fired after the annotation has been added to the document,
+ * providing access to the fully initialized annotation object.
+ */
+export declare interface AnnotationCreatedEvent extends ViewerEvent {
+    readonly annotation: Annotation;
+}
+
+/**
+ * Represents an event that is emitted when a new annotation is being created.
+ *
+ * @remarks
+ * This event is fired before the annotation is actually added to the document,
+ * allowing listeners to modify or cancel the creation process through the annotation options.
+ */
+export declare interface AnnotationCreatingEvent extends ViewerEvent {
+    annotation: AnnotationOptions;
+}
+
+/**
+ * AnnotationEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ *
+ * @remarks
+ * This interface defines the types of events that can be emitted by the annotations system,
+ * including events for when annotations are being created and when they have been successfully created.
+ */
+export declare interface AnnotationEventMap {
+    /**
+     * Event emitted when a new annotation is being created.
+     *
+     * @remarks
+     * This event is fired before the annotation is actually added to the document,
+     * allowing listeners to modify or cancel the creation process through the annotation options.
+     */
+    annotationCreating: AnnotationCreatingEvent;
+    /**
+     * Event emitted when a new annotation has been successfully created.
+     *
+     * @remarks
+     * This event is fired after the annotation has been added to the document,
+     * providing access to the fully initialized annotation object.
+     */
+    annotationCreated: AnnotationCreatedEvent;
+}
+
+/**
+ * Represents options for creating or modifying an annotation.
+ *
+ * @remarks
+ * This interface defines the properties needed to configure an annotation,
+ * including its location, type, appearance, and content.
+ */
+export declare interface AnnotationOptions {
+    /**
+     * Gets the index of the page where this annotation is located.
+     *
+     * @remarks
+     * This value represents the zero-based index of the page in the PDF document.
+     */
+    readonly pageIndex: number;
+    /**
+     * Gets or sets the type of this annotation.
+     *
+     * @remarks
+     * The annotation type categorizes the annotation (e.g., text, highlight, underline).
+     */
+    readonly type: AnnotationType;
+    /**
+     * Gets or sets the name or title of this annotation.
+     *
+     * @remarks
+     * This is typically a short descriptive label for the annotation.
+     */
+    name: string;
+    /**
+     * Gets or sets the description or content of this annotation.
+     *
+     * @remarks
+     * This contains the main text or content associated with the annotation.
+     */
+    description: string;
+    /**
+     * Gets or sets the height of this annotation in points.
+     *
+     * @remarks
+     * This value represents the vertical dimension of the annotation on the page.
+     */
+    height: number;
+}
+
+/**
+ * Provides functionality for managing and interacting with PDF annotations.
+ *
+ * @remarks
+ * This class handles the creation, management, and events related to PDF annotations.
+ * It provides access to all annotations in the document through the `items` property
+ * and manages various annotation services including electronic signatures.
+ */
+export declare class Annotations implements EventElement<AnnotationEventMap> {
+    /** @inheritdoc */
+    addEventListener<K extends keyof AnnotationEventMap>(type: K, listener: (event: AnnotationEventMap[K]) => void): void;
+    /**
+     * Gets all annotations in the document.
+     *
+     * @remarks
+     * This read-only property returns an array of all annotations currently present in the PDF document.
+     * The returned array is immutable and cannot be modified directly. Use the appropriate annotation
+     * creation methods to add new annotations to the document.
+     */
+    get items(): ReadonlyArray<Annotation>;
+}
+
+/**
+ * Represents the types of annotations that can be added to a PDF document.
+ *
+ * @remarks
+ * This enum defines the various annotation types supported by the PDF viewer.
+ */
+export declare enum AnnotationType {
+    /**
+     * Represents a free text annotation.
+     *
+     * @remarks
+     * This annotation type is used for adding free text to PDF documents.
+     */
+    FREETEXT,
+    /**
+     * Represents an electronic signature annotation.
+     *
+     * @remarks
+     * This annotation type is used for adding electronic signatures to PDF documents.
+     */
+    ESIGNATURE,
+    /**
+     * Represents a hand drawing annotation.
+     *
+     * @remarks
+     * This annotation type is used for adding hand drawing to PDF documents.
+     */
+    HANDDRAWING
+}
+
+/**
+ * Represents the automatic zoom mode value.
+ *
+ * @remarks
+ * This constant is used to indicate that the zoom level should be automatically determined by the viewer.
+ */
+export declare const automatic = "automatic";
+
+/**
+ * Represents a basic button component that can emit events and be clicked.
+ *
+ * @remarks
+ * This abstract class provides the foundation for creating button components in the PDF viewer.
+ */
+export declare abstract class BasicButtonUI implements VisibilityElement, EventElement<ButtonEventMap> {
+    /**
+     * Simulates a click on the button.
+     *
+     * @returns A promise that resolves when the click operation is complete.
+     *
+     * @remarks
+     * This method emits a `buttonClicking` event. If the event's default action is not prevented,
+     * it calls the abstract `onClick` method to handle the actual click logic.
+     */
+    click(): Promise<void>;
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /** @inheritdoc */
+    addEventListener<K extends keyof ButtonEventMap>(type: K, listener: (event: ButtonEventMap[K]) => void): void;
+}
+
+/**
+ * Represents an event that is emitted when a button is clicked.
+ *
+ * @remarks
+ * This interface defines the structure of the `buttonClicking` event, which includes a reference
+ * to the button that was clicked through the `source` property.
+ */
+export declare interface ButtonClickingEvent extends ViewerEvent {
+    /**
+     * The button that was clicked.
+     */
+    readonly source: BasicButtonUI;
+}
+
+/**
+ * ButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ *
+ * @remarks
+ * This interface defines the types of events that can be emitted by a button component.
+ */
+export declare interface ButtonEventMap {
+    /**
+     * Event fired when a button is clicked.
+     */
+    buttonClicking: ButtonClickingEvent;
+}
+
+export declare namespace constants {
+    export {
+        automatic,
+        pageFit,
+        pageWidth,
+        zoomPercentageDropdownValues
+    }
+}
+
+/**
+ * Defines the cursor modes available in the PDF viewer.
+ *
+ * @remarks
+ * The cursor mode determines how the mouse or touch interactions work with the PDF document.
+ */
+export declare enum CursorMode {
+    /**
+     * Text selection mode. Allows selecting and copying text from the PDF document.
+     */
+    TextSelection = 0,
+    /**
+     * Draggable mode. Allows dragging the PDF document with mouse or touch instead of text selection.
+     */
+    Draggable = 1
+}
+
+/**
+ * Represents an event that is emitted when a digital signing operation completes successfully.
+ *
+ * @remarks
+ * This event contains the signed PDF document data that can be loaded back into the viewer.
+ */
+export declare interface DigitallySignedEvent extends ViewerEvent {
+    readonly documentBytes: ArrayBuffer;
+}
+
+/**
+ * Represents the digital signature panel in the PDF viewer's side panel.
+ *
+ * @remarks
+ * This class provides configuration options for the digital signature panel,
+ * including title, description, and button text. It controls whether the panel is visible or hidden.
+ */
+export declare class DigitalSignatureUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /**
+     * The title of the digital signature section on the side panel.
+     *
+     * @remarks
+     * This property controls the title shown for digital signature on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    get title(): string | undefined;
+    /**
+     * The title of the digital signature section on the side panel.
+     *
+     * @param value - The title text to display, or undefined to clear it.
+     *
+     * @remarks
+     * This property controls the title shown for digital signature on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    set title(value: string | undefined);
+    /**
+     * The description of the digital signature section on the side panel.
+     *
+     * @remarks
+     * This property controls the description shown below the title on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    get description(): string | undefined;
+    /**
+     * The description of the digital signature section on the side panel.
+     *
+     * @param value - The description text to display, or undefined to clear it
+     *
+     * @remarks
+     * This property controls the description shown below the title on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    set description(value: string | undefined);
+    /**
+     * The text of the button for the digital signature section on the side panel.
+     *
+     * @remarks
+     * This property controls the text shown on the button on the side panel that triggers the signature action.
+     * When the value is `undefined`, the default translation is used.
+     */
+    get buttonText(): string | undefined;
+    /**
+     * The text of the button for the digital signature section on the side panel.
+     *
+     * @param value - The button text to display, or undefined to clear it
+     *
+     * @remarks
+     * This property controls the text shown on the button on the side panel that triggers the signature action.
+     * When the value is `undefined`, the default translation is used.
+     */
+    set buttonText(value: string | undefined);
+}
+
+/**
+ * Represents the configuration options for the digital signature panel in the PDF viewer.
+ *
+ * @remarks
+ * This interface defines the properties that control the visibility and appearance of the
+ * digital signature panel, which allows users to sign PDF documents electronically.
+ */
+export declare interface DigitalSignatureUIOptions {
+    /**
+     * Gets or sets a value indicating whether the digital signature panel is visible.
+     * Defaults to true if not specified.
+     */
+    isVisible?: boolean;
+    /**
+     * Gets or sets the title text displayed in the digital signature panel.
+     */
+    title?: string;
+    /**
+     * Gets or sets the description text displayed in the digital signature panel.
+     */
+    description?: string;
+    /**
+     * Gets or sets the text displayed on the sign button in the digital signature panel.
+     */
+    buttonText?: string;
+}
+
+/**
+ * Provides functionality for digitally signing PDF documents.
+ *
+ * @remarks
+ * This class handles the digital signing process, including communication with a signing server,
+ * event handling for signing operations, and management of signing appearance options.
+ */
+export declare class DigitalSigning implements EventElement<DigitalSigningEventMap> {
+    /**
+     * Gets or sets the URL of the digital signing server.
+     *
+     * @remarks
+     * This property specifies the endpoint where PDF documents will be sent for digital signing.
+     */
+    serverUrl: string;
+    /**
+     * Gets or sets the API password used to authenticate with the digital signing server.
+     *
+     * @remarks
+     * This password is sent as a Bearer token in the Authorization header when making requests to the signing server.
+     * If not set, the user will be prompted to enter a password during the signing process.
+     */
+    apiPassword?: string;
+    /**
+     * Gets or sets whether the signed document should be automatically downloaded after successful signing.
+     *
+     * @remarks
+     * When set to true, the signed PDF will be downloaded to the user's device upon completion of the signing process. Defaults to true.
+     */
+    autoDownload: boolean;
+    /**
+     * Gets or sets the appearance annotation for the digital signature.
+     *
+     * @remarks
+     * This property allows customization of how the digital signature appears in the PDF document.
+     */
+    appearance?: Annotation;
+    /** @inheritdoc */
+    addEventListener<K extends keyof DigitalSigningEventMap>(type: K, listener: (event: DigitalSigningEventMap[K]) => void): void;
+    /**
+     * Initiates the digital signing process for the current PDF document.
+     *
+     * @param password - Optional password to override the default API password for this signing operation.
+     * @returns A promise that resolves when the signing process is complete.
+     *
+     * @remarks
+     * <ul>
+     *    <li>Extracts the current PDF document data.</li>
+     *    <li>Emits a digitalSigning event to allow customization.</li>
+     *    <li>Sends the document to the signing server.</li>
+     *    <li>Handles the signed document response.</li>
+     *    <li>Loads the signed PDF back into the viewer.</li>
+     * </ul>
+     */
+    sign(password?: string): Promise<void>;
+}
+
+/**
+ * Represents an event that is emitted when a digital signing operation is initiated.
+ *
+ * @remarks
+ * This event contains the PDF document data and optional appearance information for the signature.
+ */
+export declare interface DigitalSigningEvent extends ViewerEvent {
+    /**
+     * Gets the raw bytes of the PDF document to be signed.
+     *
+     * @remarks
+     * This property contains the binary data that will be sent to the signing server for digital signature processing.
+     */
+    readonly documentBytes: ArrayBuffer;
+    /**
+     * Gets or sets optional appearance information for the digital signature.
+     *
+     * @remarks
+     * This property can be used to specify how the signature should appear in the PDF document.
+     */
+    appearanceAnnotation?: Annotation;
+}
+
+/**
+ * DigitalSigningEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ *
+ * @remarks
+ * This interface defines the types of events that can be emitted during the digital signing process,
+ * including the initial signing request and the completion of the signing operation.
+ */
+export declare interface DigitalSigningEventMap {
+    /**
+     * Event emitted when the digital signing process is initiated.
+     *
+     * @remarks
+     * This event contains the PDF document data and optional appearance information before sending to the signing server.
+     */
+    digitalSigning: DigitalSigningEvent;
+    /**
+     * Event emitted when the digital signing process completes successfully.
+     *
+     * @remarks
+     * This event contains the signed PDF document data that can be loaded back into the viewer after successful signing.
+     */
+    digitallySigned: DigitallySignedEvent;
+}
+
+/**
+ * Represents options for digital signing functionality in the PDF viewer.
+ *
+ * @remarks
+ * These options configure the connection to a digital signing service and control
+ * whether signed documents are automatically downloaded after signing.
+ */
+export declare interface DigitalSigningOptions {
+    /**
+     * The URL of the server that provides digital signing services.
+     *
+     * @remarks
+     * This should be the endpoint where the PDF viewer will send documents for signing.
+     */
+    serverUrl: string;
+    /**
+     * The API password required to authenticate with the digital signing service.
+     *
+     * @remarks
+     * This password is used to authorize requests to the signing server.
+     * If not set, the user will be prompted to enter a password during the signing process.
+     */
+    apiPassword?: string;
+    /**
+     * Optional flag indicating whether signed documents should be automatically downloaded.
+     *
+     * @remarks
+     * When set to true, the viewer will automatically download and display the signed document
+     * after the signing process completes. Defaults to true if not specified.
+     */
+    autoDownload?: boolean;
+}
+
+/**
+ * Represents a download button in the PDF viewer toolbar that allows users to download the current document.
+ *
+ * @remarks
+ * This button triggers the download of the currently loaded PDF document when clicked, providing specific behavior for document downloading.
+ */
+export declare class DownloadButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the download button in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the download button is visible.
+ * It provides a simple way to enable or disable the ability to download the current PDF document from the viewer.
+ */
+export declare interface DownloadButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents the available values that can be displayed in dropdown menus for zoom options.
+ *
+ * @remarks
+ * This type includes constants for page fit and page width, as well as predefined zoom percentage values from the constants module.
+ */
+export declare type DropdownValues = typeof constants.pageFit | typeof constants.pageWidth | (typeof constants.zoomPercentageDropdownValues)[number];
+
+/**
+ * Represents the e-signature element in the PDF viewer's side panel.
+ *
+ * @remarks
+ * This class provides functionality for configuring and displaying an e-signature element,
+ * including title, description, and button text.
+ */
+export declare class ESignatureUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /**
+     * The title of the e-signature section on the side panel.
+     *
+     * @remarks
+     * This property controls the title shown for e-signature on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    get titleText(): string;
+    /**
+     * The title of the e-signature section on the side panel.
+     *
+     * @param value - The title text to display.
+     *
+     * @remarks
+     * This property controls the title shown for e-signature on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    set titleText(value: string | undefined);
+    /**
+     * The description of the e-signature section on the side panel.
+     *
+     * @remarks
+     * This property controls the description shown below the title on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    get descriptionText(): string;
+    /**
+     * The description of the e-signature section on the side panel.
+     *
+     * @param value - The description text to display.
+     *
+     * @remarks
+     * This property controls the description shown below the title on the side panel.
+     * When the value is `undefined`, the default translation is used.
+     */
+    set descriptionText(value: string | undefined);
+    /**
+     * The text of the button for the e-signature section on the side panel.
+     *
+     * @remarks
+     * This property controls the text shown on the button on the side panel that opens e-signature popup.
+     * When the value is `undefined`, the default translation is used.
+     */
+    get buttonText(): string;
+    /**
+     * The text of the button for the e-signature section on the side panel.
+     *
+     * @param value - The button text to display.
+     *
+     * @remarks
+     * This property controls the text shown on the button on the side panel that opens e-signature popup.
+     * When the value is `undefined`, the default translation is used.
+     */
+    set buttonText(value: string | undefined);
+}
+
+/**
+ * Represents options for configuring the electronic signature feature in the PDF viewer.
+ *
+ * @remarks
+ * These options control the visibility and appearance of the electronic signature UI element,
+ * allowing customization of labels, descriptions, and button text.
+ */
+export declare interface ESignatureUIOptions {
+    /**
+     * Gets or sets whether the electronic signature panel is visible. Defaults to true if not specified.
+     */
+    isVisible?: boolean;
+    /**
+     * Gets or sets the title displayed in the electronic signature panel.
+     */
+    title?: string;
+    /**
+     * Gets or sets the description text shown in the electronic signature panel.
+     */
+    description?: string;
+    /**
+     * Gets or sets the text displayed on the signature button.
+     */
+    buttonText?: string;
+}
+
+/**
+ * An event-emitting interface that allows for type-safe event handling.
+ *
+ * @typeParam TEventMap - A dictionary type representing the mapping of event names (strings).
+ * to their corresponding event data types. Each key in TEventMap represents an event name,
+ * and its value represents the type of data associated with that event.
+ *
+ * @remarks
+ * This interface provides a generic way to handle events with strongly-typed event data.
+ * It supports both synchronous and asynchronous event listeners, allowing for flexible
+ * event handling patterns.
+ */
+export declare interface EventElement<TEventMap extends {
+    [key: string]: any;
+}> {
+    /**
+     * Adds an event listener for the specified event type.
+     *
+     * @param type - The event type/name to listen for.
+     * @param listener - The callback function that will be invoked when the event is emitted.
+     *
+     * @remarks
+     * Multiple listeners can be registered for the same event type.
+     * The listener will be called with the strongly-typed event data when the event is emitted.
+     */
+    addEventListener<K extends keyof TEventMap & string>(type: K, listener: (event: TEventMap[K]) => void): void;
+}
+
+/**
+ * Provides access to various features available in the PDF viewer.
+ *
+ * @remarks
+ * This class contains references to feature modules that handle specific aspects of PDF viewing and manipulation,
+ * such as annotations, digital signing, zoom controls, page navigation, and search functionality.
+ */
+export declare class Features {
+    /**
+     * Gets the annotations feature module.
+     *
+     * @remarks
+     * Provides functionality for working with PDF annotations including highlighting, underlining, sticky notes, etc.
+     */
+    readonly annotations: Annotations;
+    /**
+     * Gets the digital signing feature module (if enabled).
+     *
+     * @remarks
+     * Provides functionality for digitally signing PDF documents. This property is optional and only available when
+     * digital signing is configured in the viewer options.
+     */
+    readonly digitalSigning?: DigitalSigning;
+    /**
+     * Gets the zoom feature module.
+     *
+     * @remarks
+     * Provides functionality for zooming and scaling the PDF document view.
+     */
+    readonly zoom: Zoom;
+    /**
+     * Gets the page navigation feature module.
+     *
+     * @remarks
+     * Provides functionality for navigating between pages in the PDF document.
+     */
+    readonly page: PageNavigation;
+    /**
+     * Gets the search feature module.
+     *
+     * @remarks
+     * Provides functionality for searching text within the PDF document.
+     */
+    readonly search: Search;
+}
+
+/**
+ * Represents the configuration options for various features available in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides access to configure different features such as digital signing functionality.
+ * It allows you to enable or disable specific features and customize their behavior.
+ */
+export declare interface FeaturesOptions {
+    /**
+     * Gets or sets the options for digital signing functionality.
+     *
+     * @remarks
+     * This property configures the connection to a digital signing service and controls whether signed documents are automatically downloaded after signing.
+     * If not set, the digital signing feature will not be available.
+     */
+    digitalSigning?: DigitalSigningOptions;
+}
+
+export declare class FreeText {
+    get fontSize(): number;
+    set fontSize(value: number);
+}
+
+/**
+ * Represents the free text annotation component in the PDF viewer's toolbar.
+ *
+ * @remarks
+ * This class provides functionality for configuring and managing free text annotations,
+ * including visibility control, font size, color settings, and an add button for creating new annotations.
+ */
+export declare class FreeTextUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+}
+
+/**
+ * Represents options for configuring the free text annotation feature in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the free text annotation controls are visible.
+ * It allows users to enable or disable the ability to add and configure free text annotations in the viewer.
+ */
+export declare interface FreeTextUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents the main PDF viewer class that provides functionality for displaying and interacting with PDF documents.
+ */
+export declare class GemBoxPdfViewer {
+    /**
+     * Gets the features available in the PDF viewer.
+     *
+     * @remarks
+     * This property provides access to various features such as annotations, digital signing, zoom, page navigation, and search functionality.
+     */
+    readonly features: Features;
+    /**
+     * Gets the user interface components of the PDF viewer.
+     *
+     * @remarks
+     * This property provides access to UI elements like theme, toolbar, and side panel configuration.
+     */
+    readonly ui: UI;
+    /**
+     * Opens a PDF document for viewing.
+     *
+     * @param document - The PDF document to open, which can be a string (URL or base64), Uint8Array, or ArrayBuffer.
+     * @returns A promise that resolves when the document is successfully loaded and rendered.
+     *
+     * @remarks
+     * This method loads the specified PDF document into the viewer. The document can be provided as:
+     * <ul>
+     *   <li>A URL string pointing to a PDF file.</li>
+     *   <li>A base64 encoded string representing the PDF content.</li>
+     *   <li>A Uint8Array containing the raw PDF bytes.</li>
+     *   <li>An ArrayBuffer containing the raw PDF data.</li>
+     * </ul>
+     */
+    open(document: string | Uint8Array | ArrayBuffer): Promise<void>;
+    /**
+     * Sets the license (serial) key for the GemBox.PdfViewer.
+     *
+     * @param licenseKey - The serial key to use for licensing.
+     *
+     * @remarks
+     * <para>You should call this method before creating any PDF Viewer instance.</para>
+     * <para>Key can only be set once (if you try to set another key, it will be ignored).</para>
+     * <para>The best place to call this method is during application initialization, before calling `GemBoxPdfViewer.create()`.</para>
+     * <para>Valid serial key has multiple groups of alphanumeric characters, separated with dashes.</para>
+     * <para>To use the assembly in free limited mode, use `FREE-LIMITED-KEY` as `licenseKey`.</para>
+     */
+    static setLicense(licenseKey: string): void;
+    /**
+     * Creates a new instance of the PDF viewer and initializes it with the specified options.
+     *
+     * @param options - The configuration options for the PDF viewer.
+     * @returns A promise that resolves to a new GemBoxPdfViewer instance.
+     *
+     * @remarks
+     * This static method creates and initializes a new PDF viewer instance. It:
+     * <ul>
+     *   <li>Validates the license key.</li>
+     *   <li>Sets up the Vue application.</li>
+     *   <li>Initializes worker threads for PDF processing.</li>
+     *   <li>Mounts the viewer to the specified container element.</li>
+     * </li>
+     *
+     * The options parameter allows you to configure various aspects of the viewer including UI elements, features, and initial document.
+     */
+    static create(options: ViewerOptions): Promise<GemBoxPdfViewer>;
+}
+
+/**
+ * Represents the hand drawing annotation component in the PDF viewer's toolbar.
+ *
+ * @remarks
+ * This class provides functionality for configuring and managing hand-drawn annotations,
+ * including visibility control, color, thickness, opacity settings, and an add button for creating new drawings.
+ */
+export declare class HandDrawingUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+}
+
+/**
+ * Represents options for configuring the hand drawing annotation feature in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the hand drawing annotation controls are visible.
+ * It allows users to enable or disable the ability to add and configure hand-drawn annotations in the viewer.
+ */
+export declare interface HandDrawingUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents nested message structures where each key can map to either a string or another nested messages object.
+ *
+ * @remarks
+ * This type is commonly used for localization and internationalization purposes, allowing for hierarchical message structures.
+ */
+export declare type NestedMessages = {
+    [key: string]: string | NestedMessages;
+};
+
+/**
+ * Represents a button in the PDF viewer toolbar that navigates to the next page of the document.
+ *
+ * @remarks
+ * This button allows users to move forward through the pages of the loaded PDF document, providing specific behavior for page navigation.
+ */
+export declare class NextPageButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that navigates to the next search match.
+ *
+ * @remarks
+ * This button allows users to move to the next occurrence of their search query within the document,
+ * providing specific behavior for search navigation.
+ */
+export declare class NextSearchButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that opens file dialog for loading PDF documents.
+ *
+ * @remarks
+ * This button allows users to select and open PDF files from their local system,
+ * providing specific behavior for file selection and loading.
+ */
+export declare class OpenButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the open button in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the open button is visible.
+ * It provides a simple way to enable or disable the ability to open new PDF documents in the viewer.
+ */
+export declare interface OpenButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Event triggered when changing pages in a PDF document.
+ *
+ * @remarks
+ * This event provides access to both previous and target page numbers during navigation,
+ * allowing listeners to cancel or modify the page change before it occurs.
+ */
+export declare interface PageChangingEvent extends ViewerEvent {
+    /**
+     * Gets the zero-based index of the page that was previously active before navigation.
+     *
+     * @remarks
+     * This property represents the page index (zero-based) from which the navigation originated.
+     */
+    readonly previousPage: number;
+    /**
+     * The target page index (zero-based index). Can be modified to change the destination page.
+     */
+    page: number;
+}
+
+/**
+ * PageEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ *
+ * @remarks
+ * This interface defines the structure of events that can be emitted by the Page class,
+ * specifically the pageChanging event which is triggered when the current page is about to change.
+ */
+export declare interface PageEventMap {
+    /**
+     * Event triggered when the current page is about to change.
+     *
+     * @remarks
+     * This event is emitted before navigating to a new page, allowing listeners to cancel
+     * or modify the navigation. The event contains information about both the previous and target pages.
+     */
+    pageChanging: PageChangingEvent;
+}
+
+/**
+ * Represents the page fit zoom mode value.
+ *
+ * @remarks
+ * This constant is used to indicate that the zoom level should fit the entire page within the viewport.
+ */
+export declare const pageFit = "pageFit";
+
+/**
+ * Represents an event that is fired when the input value has changed and page navigation occurs.
+ *
+ * @remarks
+ * This event provides read-only access to the target page number after validation.
+ */
+export declare interface PageInputChangedEvent extends ViewerEvent {
+    /**
+     * The target page number (entered as 1-based number) that has been applied.
+     */
+    readonly pageNumber: number;
+}
+
+/**
+ * Represents an event that is fired when the input value is about to change.
+ *
+ * @remarks
+ * This event can be prevented to stop the page navigation from occurring.
+ */
+export declare interface PageInputChangingEvent extends ViewerEvent {
+    /**
+     * The page number string that is about to be applied.
+     */
+    value: string;
+}
+
+/**
+ * Provides functionality for managing and navigating through pages in a PDF document.
+ *
+ * @remarks
+ * This class handles page navigation, including setting the current page, moving to next/previous pages,
+ * and emitting events when page changes occur. It extends EventElement to support event-based communication.
+ */
+export declare class PageNavigation implements EventElement<PageEventMap> {
+    /** @inheritdoc */
+    addEventListener<K extends keyof PageEventMap>(type: K, listener: (event: PageEventMap[K]) => void): void;
+    /**
+     * Gets the total number of pages in the currently loaded PDF document.
+     *
+     * @remarks
+     * This property returns the count of pages available in the document. The value is updated
+     * automatically when a new document is loaded or when the page count changes.
+     */
+    get numberOfPages(): number;
+    /**
+     * Gets the current page index that is being displayed.
+     *
+     * @remarks
+     * This property returns the zero-based index of the currently active page. The value is updated
+     * automatically when navigation occurs or when a new page is set programmatically.
+     */
+    get currentPage(): number;
+    /**
+     * Sets the current page to display in the PDF viewer.
+     *
+     * @param page - The page index to navigate to (zero-based index).
+     *
+     * @remarks
+     * This method changes the currently displayed page. It validates that the requested page index
+     * is within bounds before attempting to change pages. If the page index is invalid, the method
+     * returns without making any changes.
+     *
+     * The method emits a pageChanging event before changing the page, allowing listeners to cancel
+     * or modify the navigation. If the event is not prevented, the current page index is updated.
+     * The method also handles the case where the page index is out of bounds and prevents invalid navigation.
+     */
+    setCurrentPage(page: number): void;
+    /**
+     * Navigates to the next page in the PDF document.
+     *
+     * @remarks
+     * This convenience method increments the current page index by 1 and calls setPage internally.
+     * If already on the last page, this method has no effect.
+     */
+    nextPage(): void;
+    /**
+     * Navigates to the previous page in the PDF document.
+     *
+     * @remarks
+     * This convenience method decrements the current page index by 1 and calls setPage internally.
+     * If already on the first page, this method has no effect.
+     */
+    previousPage(): void;
+}
+
+/**
+ * PageNavigationFieldEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ */
+export declare interface PageNavigationFieldEventMap {
+    /**
+     * Event fired when the input value is about to change.
+     */
+    inputChanging: PageInputChangingEvent;
+    /**
+     * Event fired when the input value has changed and page navigation occurs.
+     */
+    inputChanged: PageInputChangedEvent;
+}
+
+/**
+ * Represents a field in the PDF viewer toolbar that allows users to navigate to specific pages by entering page numbers.
+ *
+ * @remarks
+ * This component provides functionality for direct page navigation through user input, handling page number changes and validation.
+ */
+export declare class PageNavigationFieldUI implements VisibilityElement, EventElement<PageNavigationFieldEventMap> {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /** @inheritdoc */
+    addEventListener<K extends keyof PageNavigationFieldEventMap>(type: K, listener: (event: PageNavigationFieldEventMap[K]) => void): void;
+    /**
+     * Sets the input value and handles page navigation.
+     *
+     * @param value - The page number string to navigate to.
+     */
+    setInput(value: string): void;
+}
+
+/**
+ * Represents page navigation controls for the viewer toolbar.
+ */
+export declare class PageNavigationUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+}
+
+/**
+ * Represents options for configuring the page navigation controls in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the page navigation controls are visible.
+ * It provides a simple way to enable or disable the ability to navigate between pages in the viewer.
+ */
+export declare interface PageNavigationUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents the page width zoom mode value.
+ *
+ * @remarks
+ * This constant is used to indicate that the zoom level should fit the page width within the viewport.
+ */
+export declare const pageWidth = "pageWidth";
+
+/**
+ * Represents a button in the PDF viewer toolbar that enables pan mode for document navigation.
+ *
+ * @remarks
+ * This button allows users to switch to pan mode, which enables dragging and panning through the document,
+ * providing specific behavior for cursor mode switching.
+ */
+export declare class PanModeButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the pan mode button in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the pan mode button is visible.
+ * It provides a simple way to enable or disable the ability to switch to pan mode in the viewer.
+ */
+export declare interface PanModeButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that navigates to the previous page of the document.
+ *
+ * @remarks
+ * This button allows users to move backward through the pages of the loaded PDF document, providing specific behavior for page navigation.
+ */
+export declare class PreviousPageButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that navigates to the previous search match.
+ *
+ * @remarks
+ * This button allows users to move to the previous occurrence of their search query within the document,
+ * providing specific behavior for search navigation.
+ */
+export declare class PreviousSearchButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that allows users to print the current document.
+ *
+ * @remarks
+ * This button triggers the printing functionality for the currently loaded PDF document when clicked,
+ * providing specific behavior for document printing.
+ */
+export declare class PrintButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the print button in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the print button is visible.
+ * It provides a simple way to enable or disable the ability to print the current PDF document from the viewer.
+ */
+export declare interface PrintButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents an event that is fired when the search query has changed and text searching occurs.
+ *
+ * @remarks
+ * This event provides read-only access to the search query after validation.
+ */
+export declare interface QueryChangedEvent extends ViewerEvent {
+    /**
+     * The search query that has been applied.
+     */
+    readonly value: string;
+}
+
+/**
+ * Represents an event that is fired when the search query is about to change.
+ *
+ * @remarks
+ * This event can be prevented to stop the search from occurring.
+ */
+export declare interface QueryChangingEvent extends ViewerEvent {
+    /**
+     * The search query that is about to be applied.
+     */
+    value: string;
+}
+
+/**
+ * Provides search functionality for finding text within PDF documents.
+ *
+ * @remarks
+ * The Search class enables users to search for specific text within a PDF document,
+ * navigate between search results, and receive notifications about search progress
+ * through events. It integrates with the underlying PDF.js library to perform
+ * the actual search operations.
+ */
+export declare class Search implements EventElement<SearchEventMap> {
+    /** @inheritdoc */
+    addEventListener<K extends keyof SearchEventMap>(type: K, listener: (event: SearchEventMap[K]) => void): void;
+    /**
+     * Gets the current search query text.
+     *
+     * @remarks
+     * This property returns the text that is currently being searched for in the document.
+     */
+    get query(): string;
+    /**
+     * Gets the current position in the search results.
+     *
+     * @remarks
+     * This property returns the index of the currently selected search result (zero-based).
+     */
+    get currentMatch(): number;
+    /**
+     * Gets the total number of search matches found.
+     *
+     * @remarks
+     * This property returns the total count of all matches for the current search query.
+     */
+    get matchCount(): number;
+    /**
+     * Starts a new search operation with the specified query.
+     *
+     * @param query - The text to search for in the document. If undefined or empty, any active search is cancelled and cleared.
+     *
+     * @remarks
+     * This method initiates a search for the specified query text. It emits a {@link SearchStartingEvent}
+     * before performing the search, allowing listeners to cancel the operation if needed.
+     * If the query is undefined or empty, it cancels any active search and clears the search state.
+     */
+    search(query: string | undefined): void;
+    /**
+     * Navigates to the next search match in the document.
+     *
+     * @remarks
+     * This method moves the selection to the next occurrence of the current search query.
+     * If there are no more matches after the current position, this method has no effect.
+     */
+    nextMatch(): void;
+    /**
+     * Navigates to the previous search match in the document.
+     *
+     * @remarks
+     * This method moves the selection to the previous occurrence of the current search query.
+     * If there are no matches before the current position, this method has no effect.
+     */
+    previousMatch(): void;
+    /**
+     * Ends the current search operation and clears all search state.
+     *
+     * @remarks
+     * This method stops any active search, clears the query text, resets the match counter,
+     * and hides the search UI elements. It should be called when search is no longer needed.
+     */
+    clear(): void;
+}
+
+/**
+ * Event emitted when a search operation is cancelled.
+ *
+ * @remarks
+ * This event is fired when an active search is cancelled, either by the user
+ * or programmatically. It indicates that no search results are currently available.
+ */
+export declare interface SearchCancelledEvent {
+}
+
+/**
+ * Event emitted when a search operation completes.
+ *
+ * @remarks
+ * This event is fired after a search operation finishes, containing information about
+ * the search results including the query text, current match position, and total matches found.
+ */
+export declare interface SearchCompletedEvent {
+    /**
+     * The search query text that was used to find matches in the document.
+     *
+     * @remarks
+     * This property contains the actual query string that was searched for,
+     * allowing consumers of this event to know what text produced the results.
+     */
+    readonly query: string;
+    /**
+     * The current position/index of the selected search match (0-based).
+     *
+     * @remarks
+     * This property indicates which specific match is currently highlighted or selected
+     * in the document. It's useful for tracking navigation through search results.
+     */
+    readonly currentPosition: number;
+    /**
+     * The total number of matches found for the search query.
+     *
+     * @remarks
+     * This property provides the complete count of all occurrences of the search term
+     * throughout the entire document, allowing UI elements to display progress information.
+     */
+    readonly matchCount: number;
+}
+
+/**
+ * SearchEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ *
+ * @remarks
+ * This interface defines the types of events that can be emitted during search operations,
+ * including when a search starts, is cancelled, or completes.
+ */
+export declare interface SearchEventMap {
+    /**
+     * Event emitted when a search operation is starting.
+     *
+     * @remarks
+     * This event is fired before the actual search begins, allowing listeners to cancel
+     * or modify the search operation. The event contains the query text that will be searched for.
+     */
+    searchStarting: SearchStartingEvent;
+    /**
+     * Event emitted when a search operation is cancelled.
+     *
+     * @remarks
+     * This event is fired when an active search is cancelled, either by the user
+     * or programmatically. It indicates that no search results are currently available.
+     */
+    searchCancelled: SearchCancelledEvent;
+    /**
+     * Event emitted when a search operation completes.
+     *
+     * @remarks
+     * This event is fired after a search operation finishes, containing information about
+     * the search results including the query text, current match position, and total matches found.
+     */
+    searchCompleted: SearchCompletedEvent;
+}
+
+/**
+ * SearchFieldEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ */
+export declare interface SearchFieldEventMap {
+    /**
+     * Event fired when the search query is about to change.
+     */
+    queryChanging: QueryChangingEvent;
+    /**
+     * Event fired when the search query has changed and text searching occurs.
+     */
+    queryChanged: QueryChangedEvent;
+}
+
+/**
+ * Represents a field in the PDF viewer toolbar that allows users to search for text within documents.
+ *
+ * @remarks
+ * This component provides functionality for text searching through user input, handling search queries and validation.
+ */
+export declare class SearchFieldUI implements VisibilityElement, EventElement<SearchFieldEventMap> {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /** @inheritdoc */
+    addEventListener<K extends keyof SearchFieldEventMap>(type: K, listener: (event: SearchFieldEventMap[K]) => void): void;
+    /**
+     * Sets the search query and handles text searching.
+     *
+     * @param value - The search query string to find in the document.
+     */
+    setQuery(value: string): void;
+}
+
+/**
+ * Event emitted when a search operation is starting.
+ *
+ * @remarks
+ * This event is fired before the actual search begins, allowing listeners to cancel
+ * or modify the search operation. The event contains the query text that will be searched for.
+ */
+export declare interface SearchStartingEvent extends ViewerEvent {
+    /**
+     * The search query text that will be searched for in the document.
+     *
+     * @remarks
+     * This property contains the text that users want to find within the PDF document.
+     */
+    query: string;
+}
+
+/**
+ * Represents search controls for the viewer toolbar.
+ */
+export declare class SearchUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+}
+
+/**
+ * Represents options for configuring the search functionality in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the search button is visible.
+ * It provides a simple way to enable or disable the search feature in the viewer.
+ */
+export declare interface SearchUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents a button that toggles the visibility of the side panel in the PDF viewer.
+ *
+ * @remarks
+ * This button handles side panel visibility toggling.
+ * When clicked, it emits an event to toggle the side panel's visibility state.
+ */
+export declare class SidePanelButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the side panel button in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the side panel button is visible.
+ * It provides a simple way to enable or disable the ability to access the side panel from the viewer.
+ */
+export declare interface SidePanelButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents the different types of panels that can be displayed in the side panel.
+ *
+ * @remarks
+ * This enum defines the available panel types for the side panel component, including
+ * thumbnails, bookmarks, and signature panels.
+ */
+export declare enum SidePanelType {
+    /**
+     * The thumbnail panel type.
+     *
+     * @remarks
+     * Displays thumbnail images of all pages in the PDF document.
+     */
+    THUMBNAIL = 1,
+    /**
+     * The bookmarks panel type.
+     *
+     * @remarks
+     * Displays a hierarchical list of bookmarks/outline items from the PDF document.
+     */
+    BOOKMARKS = 2
+}
+
+/**
+ * Represents the side panel component of the PDF viewer.
+ *
+ * @remarks
+ * This class manages the side panel UI element, including its visibility, pinned state,
+ * and the currently active panel type (thumbnails, bookmarks, etc.).
+ */
+export declare class SidePanelUI implements VisibilityElement {
+    /**
+     * Gets the digital signature component of the side panel.
+     *
+     * @remarks
+     * This property provides access to the digital signature functionality and configuration.
+     */
+    readonly digitalSignature: DigitalSignatureUI;
+    /**
+     * Gets the electronic signature component of the side panel.
+     *
+     * @remarks
+     * This property provides access to the electronic signature functionality and configuration.
+     */
+    readonly eSignature: ESignatureUI;
+    /**
+     * The value indicating whether the side panel is visible.
+     *
+     * @remarks
+     * When setting this property to false, the panel will be unpinned and reset to show thumbnails.
+     */
+    get isVisible(): boolean;
+    /**
+     * The value indicating whether the side panel is visible.
+     *
+     * @remarks
+     * When setting this property to false, the panel will be unpinned and reset to show thumbnails.
+     *
+     * @param value - The boolean value to set for visibility
+     */
+    set isVisible(value: boolean);
+    /**
+     * The value indicating whether the side panel is pinned open.
+     *
+     * @remarks
+     * When pinned, the side panel remains visible even when not actively used. When unpinned,
+     * the panel will close automatically after inactivity.
+     */
+    get isPinned(): boolean;
+    /**
+     * The value indicating whether the side panel is pinned open.
+     *
+     * @param value - The boolean value to set for pinned state
+     */
+    set isPinned(value: boolean);
+    /**
+     * The active {@link SidePanelType} for the side panel.
+     *
+     * @remarks
+     * This property determines which sub-panel is currently being displayed within
+     * the side panel, such as thumbnails or bookmarks.
+     */
+    get activeSidePanelType(): SidePanelType;
+    /**
+     * The active {@link SidePanelType} for the side panel.
+     *
+     * @param value - The {@link SidePanelType} to set as active
+     *
+     * @remarks
+     * This property determines which sub-panel is currently being displayed within
+     * the side panel, such as thumbnails or bookmarks.
+     */
+    set activeSidePanelType(value: SidePanelType);
+}
+
+/**
+ * Represents configuration options for the side panel in the PDF viewer.
+ *
+ * @remarks
+ * The side panel provides access to additional features like electronic signatures and digital signatures.
+ * This interface allows you to control the visibility of the side panel and configure the available features.
+ */
+export declare interface SidePanelUIOptions {
+    /**
+     * Gets or sets a value indicating whether the side panel is visible.
+     * Defaults to false if not specified.
+     */
+    isVisible?: boolean;
+    /**
+     * Gets or sets options for electronic signature functionality on the side panel.
+     */
+    eSignature?: ESignatureUIOptions;
+    /**
+     * Gets or sets options for digital signature functionality on the side panel.
+     */
+    digitalSignature?: DigitalSignatureUIOptions;
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that opens the signature panel for digital signing and e-signature.
+ *
+ * @remarks
+ * This button allows users to access digital signature and e-signature functionality,
+ * enabling them to add e-signatures and sign documents electronically.
+ */
+export declare class SignatureButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the signature button in the PDF viewer toolbar.
+ *
+ * @remarks
+ * This interface provides control over whether the signature button is visible.
+ * It provides a simple way to enable or disable the ability to add electronic signatures or signing the PDF document from the viewer.
+ */
+export declare interface SignatureButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that enables text selection mode.
+ *
+ * @remarks
+ * This button allows users to switch to text selection mode, which enables selecting and copying text from the document,
+ * providing specific behavior for cursor mode switching.
+ */
+export declare class TextSelectionButtonUI extends BasicButtonUI {
+}
+
+/**
+ * Represents options for configuring the text selection button in the PDF viewer toolbar.
+ *
+ * @remarks
+ * This interface provides control over whether the text selection button is visible.
+ * It provides a simple way to enable or disable the ability to switch to text selection in the viewer.
+ */
+export declare interface TextSelectionButtonUIOptions extends VisibilityOption {
+}
+
+/**
+ * Represents the available theme options for the PDF viewer UI.
+ *
+ * @remarks
+ * Themes control the color scheme and appearance of the viewer interface. Available themes include light, dark, and various colored variants.
+ */
+export declare type Theme = "light" | "dark" | "red" | "dark-red" | "blue" | "dark-blue" | "green" | "dark-green";
+
+/**
+ * Represents the toolbar component in the PDF viewer that contains various buttons and controls for document interaction.
+ */
+export declare class ToolbarUI {
+    /**
+     * Gets the side panel button that toggles the visibility of the side panel.
+     */
+    readonly sidePanelButton: SidePanelButtonUI;
+    /**
+     * Gets the open button that allows users to select and open PDF files from their local system.
+     */
+    readonly openButton: OpenButtonUI;
+    /**
+     * Gets the download button that triggers the download of the currently loaded PDF document.
+     */
+    readonly downloadButton: DownloadButtonUI;
+    /**
+     * Gets the print button that initiates the printing functionality for the current document.
+     */
+    readonly printButton: PrintButtonUI;
+    /**
+     * Gets the signature button that opens the digital signature panel for electronic signing.
+     */
+    readonly signatureButton: SignatureButtonUI;
+    /**
+     * Gets the free text annotation controls for adding and configuring free text annotations.
+     *
+     * @remarks
+     * The free text controls allow users to add, edit, and customize free text annotations in PDF documents.
+     */
+    readonly freeText: FreeTextUI;
+    /**
+     * Gets the hand drawing annotation controls for adding and configuring freehand drawings.
+     *
+     * @remarks
+     * The hand drawing controls allow users to create, edit, and customize freehand drawings in PDF documents.
+     */
+    readonly handDrawing: HandDrawingUI;
+    /**
+     * Gets the text selection button that enables text selection mode for copying text from the document.
+     */
+    readonly textSelectionButton: TextSelectionButtonUI;
+    /**
+     * Gets the pan mode button that enables dragging and panning through the document.
+     */
+    readonly panModeButton: PanModeButtonUI;
+    /**
+     * Gets the zoom controls that manage document magnification.
+     *
+     * @remarks
+     * The zoom controls appear as buttons, field, and dropdown in the toolbar
+     * and control the zoom level of the PDF document.
+     */
+    readonly zoom: ZoomUI;
+    /**
+     * Gets the page navigation controls for moving between pages in the document.
+     *
+     * @remarks
+     * The navigation controls appear as buttons in the toolbar and control the visual
+     * representation of which page is currently displayed in the HTML view.
+     */
+    readonly pageNavigation: PageNavigationUI;
+    /**
+     * Gets the search controls for finding text within the document.
+     *
+     * @remarks
+     * The search controls appear as input fields and buttons in the toolbar and control
+     * the visual highlighting of search results within the HTML-rendered PDF content.
+     */
+    readonly search: SearchUI;
+}
+
+/**
+ * Configuration options for the toolbar in the PDF viewer.
+ *
+ * @remarks
+ * This interface defines all available toolbar buttons and their configuration options,
+ * allowing customization of which buttons or elements appear and how they behave. Each property is optional,
+ * enabling selective inclusion of toolbar functionality based on application requirements.
+ */
+export declare interface ToolbarUIOptions {
+    /**
+     * Options for the side panel button in the toolbar.
+     */
+    sidePanelButton?: SidePanelButtonUIOptions;
+    /**
+     * Options for the open button in the toolbar.
+     */
+    openButton?: OpenButtonUIOptions;
+    /**
+     * Options for the download button in the toolbar.
+     */
+    downloadButton?: DownloadButtonUIOptions;
+    /**
+     * Options for the print button in the toolbar.
+     */
+    printButton?: PrintButtonUIOptions;
+    /**
+     * Options for the signature button in the toolbar.
+     */
+    signatureButton?: SignatureButtonUIOptions;
+    /**
+     * All page navigation options including first, previous, next, and last page buttons.
+     */
+    pageNavigation?: PageNavigationUIOptions;
+    /**
+     * All zooming options including zoom in, zoom out, and fit width/height buttons.
+     */
+    zoom?: ZoomUIOptions;
+    /**
+     * Options for the text selection button in the toolbar.
+     */
+    textSelectionButton?: TextSelectionButtonUIOptions;
+    /**
+     * Options for the pan mode button in the toolbar.
+     */
+    panModeButton?: PanModeButtonUIOptions;
+    /**
+     * Options for the search functionality in the toolbar.
+     */
+    search?: SearchUIOptions;
+    /**
+     * Options for the free text annotation feature in the toolbar.
+     *
+     * @remarks
+     * This property configures the visibility and behavior of free text annotation controls,
+     * allowing users to add and customize free text annotations in PDF documents.
+     */
+    freeText?: FreeTextUIOptions;
+    /**
+     * Options for the hand drawing annotation feature in the toolbar.
+     *
+     * @remarks
+     * This property configures the visibility and behavior of hand drawing annotation controls,
+     * allowing users to add and customize freehand drawings in PDF documents.
+     */
+    handDrawing?: HandDrawingUIOptions;
+}
+
+/**
+ * Provides access to user interface components and configuration options for the PDF viewer.
+ *
+ * @remarks
+ * This class contains references to UI elements that can be customized, including theme settings,
+ * toolbar configuration, and side panel options.
+ */
+export declare class UI {
+    /**
+     * Gets or sets the theme for the PDF viewer.
+     *
+     * @remarks
+     * Controls the color scheme of the viewer.
+     * Predefined theme from {@link Theme} can be picked to match your application's color palette.
+     * Defaults to "light".
+     */
+    readonly theme?: Theme;
+    /**
+     * Gets the toolbar component of the PDF viewer.
+     *
+     * @remarks
+     * Provides access to toolbar configuration and functionality, including buttons for common actions
+     * like opening files, printing, zooming, and navigating through pages.
+     */
+    readonly toolbar: ToolbarUI;
+    /**
+     * Gets the side panel component of the PDF viewer.
+     *
+     * @remarks
+     * Controls the side panel that typically contains additional functionality such as layers,
+     * outlines, thumbnails, and other navigation aids.
+     */
+    readonly sidePanel: SidePanelUI;
+}
+
+/**
+ * Options for configuring the user interface of the PDF viewer.
+ *
+ * @remarks
+ * This interface provides configuration options for the PDF viewer's user interface, including
+ * theme, toolbar, localization, and side panel settings. These options allow you to customize
+ * the appearance and behavior of the viewer to match your application's design requirements.
+ */
+export declare interface UIOptions {
+    /**
+     * Gets or sets the theme for the PDF viewer user interface.
+     *
+     * @remarks
+     * This property allows you to configure the visual appearance of the viewer. The theme can be customized to match your application's design.
+     */
+    theme?: Theme;
+    /**
+     * Gets or sets the toolbar options for the PDF viewer.
+     *
+     * @remarks
+     * This property provides configuration options for the toolbar, including which buttons to display and their layout.
+     */
+    toolbar?: ToolbarUIOptions;
+    /**
+     * Gets or sets the localization options for the PDF viewer.
+     *
+     * @remarks
+     * This property allows you to specify the language for the user interface. You can use predefined languages ("en", "de", "es")
+     * or provide custom localized messages through a {@link NestedMessages} object.
+     */
+    localization?: "en" | "de" | "es" | NestedMessages;
+    /**
+     * Gets or sets the side panel options for the PDF viewer.
+     *
+     * @remarks
+     * This property provides configuration options for the side panel, including which panels to display and their initial state.
+     * The side panel provides access to additional features like electronic signatures and digital signatures.
+     */
+    sidePanel?: SidePanelUIOptions;
+}
+
+/**
+ * Represents an event that is fired when the zoom level has changed and been applied.
+ *
+ * @remarks
+ * This event provides read-only access to the selected zoom level after validation.
+ */
+export declare interface ValueChangedEvent extends ViewerEvent {
+    /**
+     * The zoom level that has been applied.
+     */
+    readonly value: DropdownValues;
+}
+
+/**
+ * Represents an event that is fired when the zoom level is about to change.
+ *
+ * @remarks
+ * This event can be prevented to stop the zoom level from being applied.
+ */
+export declare interface ValueChangingEvent extends ViewerEvent {
+    /**
+     * The zoom level that is about to be applied.
+     */
+    value: DropdownValues;
+}
+
+/**
+ * Represents a base event interface for the PDF viewer that provides functionality
+ * similar to the standard DOM Event interface, allowing events to be canceled.
+ *
+ * @remarks
+ * This interface defines the core event handling capabilities including:
+ * <ul>
+ *   <li>The ability to check if an event's default action has been prevented.</li>
+ *   <li>The ability to prevent the default action of an event.</li>
+ * </ul>
+ */
+export declare interface ViewerEvent {
+    /**
+     * Gets a value indicating whether the event's default action has been canceled.
+     *
+     * @remarks
+     * The **`defaultPrevented`** read-only property returns `true` if the call to Event.preventDefault()
+     * canceled the event, otherwise it returns `false`.
+     */
+    readonly defaultPrevented: boolean;
+    /**
+     * Cancels the event if it is cancelable, without stopping further propagation of the event.
+     *
+     * @remarks
+     * This method call indicates that the event's default action should be prevented.
+     * If the event is not cancelable, this method has no effect.
+     * The event can be prevented to stop the default behavior from occurring.
+     */
+    preventDefault(): void;
+}
+
+/**
+ * Represents the configuration options for the PDF viewer.
+ *
+ * @remarks
+ * This interface defines the various settings that can be used to customize the behavior and appearance of the PDF viewer when it's created.
+ */
+export declare interface ViewerOptions {
+    /**
+     * The container element where the PDF viewer will be mounted.
+     *
+     * @remarks
+     * Can be either an {@link HTMLElement} reference or id selector as {@link string} (e.g., "#myContainer").
+     * If the container cannot be found using the provided selector, an error will be thrown.
+     */
+    container: HTMLElement | string;
+    /**
+     * The initial PDF document to load when the viewer is created.
+     *
+     * @remarks
+     * This is an optional property. If not provided, the viewer will be created without a loaded document.
+     * This can be:
+     * <ul>
+     *   <li>A URL string pointing to a PDF file.</li>
+     *   <li>A base64 encoded string representing the PDF content.</li>
+     *   <li>A Uint8Array containing the raw PDF bytes.</li>
+     *   <li>An ArrayBuffer containing the raw PDF data.</li>
+     * </ul>
+     * If the document cannot be loaded, the promise will reject with an error.
+     */
+    initialDocument?: string | Uint8Array | ArrayBuffer;
+    /**
+     * Configuration options for the user interface components.
+     *
+     * @remarks
+     * Allows customization of UI elements like theme, toolbar, and side panel configuration.
+     */
+    ui?: UIOptions;
+    /**
+     * Configuration options for various features such as annotations, digital signing, zoom, page navigation, and search functionality.
+     *
+     * @remarks
+     * Controls which features are enabled and how they behave in the PDF viewer.
+     */
+    features?: FeaturesOptions;
+}
+
+/**
+ * Represents an element that supports visibility capabilities.
+ *
+ * @remarks
+ * This interface provides functionality to get and update the visibility of the element.
+ * It allows controlling whether the element is displayed or hidden in the UI.
+ */
+export declare interface VisibilityElement {
+    /**
+     * The current visibility state of the element.
+     *
+     * @remarks
+     * This property returns true if the element is currently visible, false otherwise.
+     * The value is updated automatically when the visibility changes.
+     */
+    get isVisible(): boolean;
+    /**
+     * The current visibility state of the element.
+     *
+     * @param value - The new visibility state (true to show, false to hide).
+     */
+    set isVisible(value: boolean);
+}
+
+/**
+ * Represents options for controlling the visibility of PDF viewer elements.
+ *
+ * @remarks
+ * This interface provides a simple way to control whether certain UI elements or features should be visible in the PDF viewer.
+ */
+export declare interface VisibilityOption {
+    /**
+     * Gets or sets whether the element is visible.
+     *
+     * @remarks
+     * When set to true, the element will be displayed. When false, the element will be hidden.
+     * If not specified, defaults to true (visible).
+     */
+    isVisible?: boolean;
+}
+
+/**
+ * Provides zoom functionality for the PDF viewer.
+ *
+ * @remarks
+ * The Zoom class manages zoom operations including setting zoom levels, handling zoom events,
+ * and providing access to current zoom state.
+ */
+export declare class Zoom implements EventElement<ZoomEventMap> {
+    /** @inheritdoc */
+    addEventListener<K extends keyof ZoomEventMap>(type: K, listener: (event: ZoomEventMap[K]) => void): void;
+    /**
+     * Gets the current zoom level.
+     */
+    get zoomLevel(): ZoomLevel;
+    /**
+     * Sets the zoom level for the PDF viewer.
+     *
+     * @param value - The zoom level to set (e.g., "automatic", "pageFit", or a percentage value).
+     *
+     * @remarks
+     * This method changes the zoom level of the PDF viewer. It emits zoomChanging and zoomChanged events,
+     * allowing listeners to respond to the zoom change. The zoomLevel parameter can be:
+     * <ul>
+     *   <li>A predefined zoom level like "automatic", "pageFit", or "pageWidth".</li>
+     *   <li>A numeric value representing a percentage (e.g., 150 for 150%).</li>
+     * </ul>
+     */
+    set zoomLevel(value: ZoomLevel);
+    /**
+     * Zooms the PDF viewer by a relative scale factor.
+     *
+     * @param scale - The relative scale factor to apply (e.g., 1.2 for 20% zoom in, 0.8 for 20% zoom out).
+     *
+     * @remarks
+     * This method adjusts the current zoom level by multiplying it with the provided scale factor.
+     * For example, a scale of 1.5 will increase the zoom by 50%, while a scale of 0.75 will decrease
+     * the zoom by 25%.
+     */
+    zoomRelative(scale: number): void;
+}
+
+/**
+ * Represents an event that is emitted when the zoom level has changed.
+ *
+ * @remarks
+ * This interface defines the properties available in a zoom changed event,
+ * including the previous and current zoom levels. This event is emitted after
+ * the zoom operation has been completed successfully.
+ */
+export declare interface ZoomChangedEvent extends ViewerEvent {
+    /**
+     * The zoom level before the change.
+     */
+    readonly zoomLevelBefore: ZoomLevel;
+    /**
+     * The zoom level after the change.
+     */
+    readonly zoomLevelAfter: ZoomLevel;
+}
+
+/**
+ * Represents an event that is emitted when the zoom level is about to change.
+ *
+ * @remarks
+ * This interface defines the properties available in a zoom changing event,
+ * including the current and future zoom levels. The zoomLevelAfter property can be modified
+ * by event listeners to change the target zoom level.
+ */
+export declare interface ZoomChangingEvent extends ViewerEvent {
+    /**
+     * The zoom level before the change.
+     */
+    readonly zoomLevelBefore: ZoomLevel;
+    /**
+     * The target zoom level that can be modified by event listeners.
+     */
+    zoomLevelAfter: ZoomLevel;
+}
+
+/**
+ * ZoomDropdownEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ */
+export declare interface ZoomDropdownEventMap {
+    /**
+     * Event fired when the zoom level is about to change.
+     */
+    valueChanging: ValueChangingEvent;
+    /**
+     * Event fired when the zoom level has changed and been applied.
+     */
+    valueChanged: ValueChangedEvent;
+}
+
+/**
+ * Represents a dropdown in the PDF viewer toolbar that allows users to select different zoom levels.
+ *
+ * @remarks
+ * This component provides functionality for zoom level selection through user input, handling zoom changes and validation.
+ */
+export declare class ZoomDropdownUI implements VisibilityElement, EventElement<ZoomDropdownEventMap> {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /** @inheritdoc */
+    addEventListener<K extends keyof ZoomDropdownEventMap>(type: K, listener: (event: ZoomDropdownEventMap[K]) => void): void;
+    /**
+     * Selects a zoom level from the dropdown.
+     *
+     * @param value - The zoom level to apply
+     */
+    select(value: DropdownValues): void;
+    /**
+     * Whether the dropdown is opened or closed.
+     */
+    get isOpened(): boolean;
+    /**
+     * Whether the dropdown is opened or closed.
+     *
+     * @param value - The visibility state to set.
+     */
+    set isOpened(value: boolean);
+    /**
+     * Toggles the open/closed state of the dropdown.
+     */
+    toggleOpen(): void;
+}
+
+/**
+ * ZoomEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ *
+ * @remarks
+ * This interface defines the types of events that can be emitted by the Zoom class,
+ * including zoom changing and zoom changed events.
+ */
+export declare interface ZoomEventMap {
+    zoomChanging: ZoomChangingEvent;
+    zoomChanged: ZoomChangedEvent;
+}
+
+/**
+ * ZoomInButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ */
+export declare interface ZoomInButtonEventMap {
+    /**
+     * Event fired when the zoom in button is clicked.
+     */
+    click: ZoomInClickEvent;
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that increases the magnification level of the document view.
+ *
+ * @remarks
+ * This component provides functionality for zooming in on the document, handling zoom changes with before/after information.
+ */
+export declare class ZoomInButtonUI implements VisibilityElement, EventElement<ZoomInButtonEventMap> {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /** @inheritdoc */
+    addEventListener<K extends keyof ZoomInButtonEventMap>(type: K, listener: (event: ZoomInButtonEventMap[K]) => void): void;
+    /**
+     * Increases the zoom level by one step.
+     *
+     * @remarks
+     * This method calculates the next appropriate zoom level based on predefined steps and
+     * emits {@link ZoomInClickEvent} before applying the change.
+     */
+    click(): Promise<void>;
+}
+
+/**
+ * Represents an event that is fired when the zoom in button is clicked.
+ *
+ * @remarks
+ * This event provides read-only access to the current zoom level and allows modification of the target
+ * zoom level before it's applied. The event can be prevented to stop the zoom operation entirely.
+ */
+export declare interface ZoomInClickEvent extends ViewerEvent {
+    /**
+     * The current zoom level before the change.
+     */
+    readonly zoomLevelBefore: number;
+    /**
+     * The target zoom level after the change. This value can be modified to customize the zoom operation.
+     */
+    zoomLevelAfter: number;
+}
+
+/**
+ * Represents the zoom level that can be applied to the PDF viewer.
+ *
+ * @remarks
+ * Zoom levels can be specified as a numeric value (percentage) or using predefined constants for automatic fitting, page fit, or page width.
+ */
+export declare type ZoomLevel = number | typeof constants.automatic | typeof constants.pageFit | typeof constants.pageWidth;
+
+/**
+ * ZoomOutButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated
+ * or used directly. It maps event names to their corresponding event object types and
+ * is consumed by addEventListener to ensure correct typing of listener callbacks.
+ */
+export declare interface ZoomOutButtonEventMap {
+    /**
+     * Event fired when the zoom out button is clicked.
+     */
+    click: ZoomOutClickEvent;
+}
+
+/**
+ * Represents a button in the PDF viewer toolbar that decreases the magnification level of the document view.
+ *
+ * @remarks
+ * This component provides functionality for zooming out on the document, handling zoom changes with before/after information.
+ */
+export declare class ZoomOutButtonUI implements VisibilityElement, EventElement<ZoomOutButtonEventMap> {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+    /** @inheritdoc */
+    addEventListener<K extends keyof ZoomOutButtonEventMap>(type: K, listener: (event: ZoomOutButtonEventMap[K]) => void): void;
+    /**
+     * Decreases the zoom level by one step.
+     *
+     * @remarks
+     * This method calculates the previous appropriate zoom level based on predefined steps and
+     * emits {@link ZoomOutClickEvent} before applying the change.
+     */
+    click(): Promise<void>;
+}
+
+/**
+ * Represents an event that is fired when the zoom out button is clicked.
+ *
+ * @remarks
+ * This event provides read-only access to the current zoom level and allows modification of the target
+ * zoom level before it's applied. The event can be prevented to stop the zoom operation entirely.
+ */
+export declare interface ZoomOutClickEvent extends ViewerEvent {
+    /**
+     * The current zoom level before the change.
+     */
+    readonly zoomLevelBefore: number;
+    /**
+     * The target zoom level after the change. This value can be modified to customize the zoom operation.
+     */
+    zoomLevelAfter: number;
+}
+
+/**
+ * Represents the default zoom percentage values for the dropdown menu.
+ *
+ * @remarks
+ * This array contains the standard zoom percentages available in the viewer's zoom dropdown.
+ */
+export declare const zoomPercentageDropdownValues: readonly [25, 50, 75, 100, 150, 200, 300, 400, 500];
+
+/**
+ * Represents zoom controls for the viewer toolbar.
+ */
+export declare class ZoomUI implements VisibilityElement {
+    /** @inheritdoc */
+    get isVisible(): boolean;
+    /** @inheritdoc */
+    set isVisible(value: boolean);
+}
+
+/**
+ * Represents options for configuring the zoom controls in the PDF viewer.
+ *
+ * @remarks
+ * This interface provides control over whether the zoom controls are visible.
+ * It provides a simple way to enable or disable the zoom functionality in the viewer.
+ */
+export declare interface ZoomUIOptions extends VisibilityOption {
+}
+