UIOptions Interface

Namespace:
@gembox/pdfviewer
Assembly:
@gembox/pdfviewer

Options for configuring the user interface of the PDF viewer.

export declare interface UIOptions
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.

Fields

theme

Gets or sets the theme for the PDF viewer user interface.

theme?: "light" | "dark" | "red" | "dark-red" | "blue" | "dark-blue" | "green" | "dark-green";
Remarks

This property allows you to configure the visual appearance of the viewer. The theme can be customized to match your application's design.

toolbar

Gets or sets the toolbar options for the PDF viewer.

toolbar?: ToolbarUIOptions;
Field Value
ToolbarUIOptions
Remarks

This property provides configuration options for the toolbar, including which buttons to display and their layout.

localization

Gets or sets the localization options for the PDF viewer.

localization?: "en" | "de" | "es" | NestedMessages;
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 NestedMessages object.

sidePanel

Gets or sets the side panel options for the PDF viewer.

sidePanel?: SidePanelUIOptions;
Field Value
SidePanelUIOptions
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.