Toolbar

Properties:
Name Type Attributes Description
leftBarButtonItems Toolbar.ToolbarItems <optional>
 The bar buttons to display on the left side of the navigation bar (iOS only).
rightBarButtonItems Toolbar.ToolbarItems <optional>
 The bar buttons to display on the right side of the navigation bar (iOS only).
toolbarMenuItems Toolbar.ToolbarItems <optional>
 The toolbar buttons to display on the toolbar (Android only).
Source:

Members

(static, readonly) DefaultToolbarButton :string

The stock toolbar buttons available to display on the PSPDFKit toolbar.
Type:
  • string
Properties:
Name Type Description
CLOSE_BUTTON_ITEM string
OUTLINE_BUTTON_ITEM string
SEARCH_BUTTON_ITEM string
THUMBNAILS_BUTTON_ITEM string
DOCUMENT_EDITOR_BUTTON_ITEM string
PRINT_BUTTON_ITEM string
OPEN_IN_BUTTON_ITEM string
EMAIL_BUTTON_ITEM string
MESSAGE_BUTTON_ITEM string
ANNOTATION_BUTTON_ITEM string
BOOKMARK_BUTTON_ITEM string
BRIGHTNESS_BUTTON_ITEM string
ACTIVITY_BUTTON_ITEM string
SETTINGS_BUTTON_ITEM string
READER_VIEW_BUTTON_ITEM string
ANNOTATION_LIST_BUTTON_ITEM string
SHARE_BUTTON_ITEM string
Source:

(static, readonly) PDFViewMode :string

The available view modes when setting the bar buttons on iOS.
Type:
  • string
Properties:
Name Type Description
VIEW_MODE_DOCUMENT string Set the toolbar buttons when the Document is visible.
VIEW_MODE_THUMBNAILS string Set the toolbar buttons when thumbnails are visible.
VIEW_MODE_DOCUMENT_EDITOR string Set the toolbar buttons when thumbnails and page editing options are visible.
Source:

Type Definitions

ToolbarItem

A toolbar item used to display a custom button on the toolbar.
Properties:
Name Type Attributes Description
id string The unique identifier for the custom toolbar button. This will be used to identify the button in the onCustomToolbarButtonTapped callback. On Android the ID needs to be specified as a resource item inside your application's ids.xml file.
image string The image name (iOS) or resource ID (Android) for the toolbar button. Images must be included in the application bundle on iOS and specified as a drawable resource on Android.
title string <optional>
 The title of the toolbar button (Android only).
showAsAction boolean <optional>
 Whether the toolbar button should be displayed on the main toolbar, and not in the drop down menu (Android only).
applyTemplate boolean <optional>
 Whether the icon should be rendered using the system's tint color to match the color scheme of other toolbar buttons. Set this to false if your icon already contains color information that should be preserved.
Source:

ToolbarItems

The toolbar buttons that should be displayed on the toolbar.
Properties:
Name Type Attributes Description
buttons Array.<(string|Toolbar.ToolbarItem)> An array of buttons that should be displayed on the toolbar. The buttons can be either stock toolbar buttons, custom toolbar buttons, or a combination of both.
viewMode string <optional>
 The viewMode for which the toolbar buttons should be set (iOS only).
animated string <optional>
 Whether the toolbar button change should be animated when they are set (iOS only).
Source: