Interface: Toolbar
Groups all the API actions related to the toolbar UI of the Viewer.
toolbar
button
button:
object
Groups all the API actions related to toolbar buttons.
addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to a toolbar button click event.
Parameters
• eventName: "clicked"
The event name to listen for (e.g., 'clicked').
• fn
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.toolbar.button.addEventListener('clicked', () => { console.log('callback') });
clicked()
clicked: (
componentName,payload?) =>void
Triggered when a toolbar button is clicked.
Parameters
• componentName: string
The name of the component (button) clicked.
• payload?: unknown
Optional payload with additional information the component needs.
Returns
void
Example
PdfToolsViewerApi.toolbar.button.clicked('icon-button-print')
hasEventListener()
hasEventListener: (
eventName) =>boolean
Checks if an event listener is already attached to a toolbar button click event.
Parameters
• eventName: "clicked"
The event name to check (e.g., 'clicked').
Returns
boolean
true if the event listener is attached, otherwise false.
Example
const hasEvent = PdfToolsViewerApi.toolbar.button.hasEventListener('clicked');
overrideButtonBehavior()
overrideButtonBehavior: (
viewerEl,buttonName,customBehavior) =>void
Overrides the default behavior of a button with a custom callback.
Parameters
• viewerEl: PdfToolsViewer
The Viewer DOM element.
• buttonName: "pdftools-icon-button-save"
The name of the button to override.
• customBehavior
A callback function defining the new behavior of the button.
Returns
void
fitMode
fitMode:
object
Groups all the API actions related to the fit mode of the toolbar.
addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to the fit mode update event.
Parameters
• eventName: "updated"
The event name to listen for (e.g., 'updated').
• fn
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.toolbar.fitMode.addEventListener('updated', () => { console.log('callback') });
updated()
updated: (
fitMode) =>void
Triggered when the fit mode is updated.
Parameters
• fitMode: FitMode
The updated fit mode value.
Returns
void
Example
PdfToolsViewerApi.toolbar.fitMode.updated(FitMode.FitWidth);
hamburgerMenu
hamburgerMenu:
object
Groups all the API actions related to the hamburger menu.
addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to the hamburger menu visibility toggle event.
Parameters
• eventName: "toggleVisibility"
The event name to listen for (e.g., 'toggleVisibility').
• fn
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.toolbar.hamburgerMenu.addEventListener('toggleVisiblity', () => { console.log('callback') });
toggleVisibility()
toggleVisibility: (
visible?) =>void
Toggles the visibility of the hamburger menu.
Parameters
• visible?: boolean
Whether the menu should be visible (default is false).
Returns
void
Example
PdfToolsViewerApi.toolbar.hamburgerMenu.toggleVisibility(true);
pageMode
pageMode:
object
Groups all the API actions related to the page mode of the toolbar.
addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to the page mode update event.
Parameters
• eventName: "updated"
The event name to listen for (e.g., 'updated').
• fn
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.toolbar.pageMode.addEventListener('updated', () => { console.log('callback') });
updated()
updated: (
pageMode) =>void
Triggered when the page mode is updated.
Parameters
• pageMode: PageLayoutMode
The updated page mode value.
Returns
void
Example
PdfToolsViewerApi.toolbar.pageMode.updated(PageLayoutMode.OneColumn);
zoom
zoom:
object
Groups all the API actions related to the zoom functionality of the toolbar.
addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to the zoom level update event.
Parameters
• eventName: "updated"
The event name to listen for (e.g., 'updated').
• fn
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.toolbar.zoom.addEventListener('updated', () => { console.log('callback') });
updated()
updated: (
zoom) =>void
Triggered when the zoom level is updated.
Parameters
• zoom: number
The updated zoom value (between 0 and 1).
Returns
void
Example
PdfToolsViewerApi.toolbar.zoom.updated(0.5);