Attributes

AttributeTypeDefaultDescription
srcstring""URL of the PDF document
pagenumber1Current page (1-based)
zoomstring"fit-width"Zoom level or mode (fit-width, fit-page, auto, or a number)
modestringautoColor scheme: light or dark. Omit for auto-detection
viewstring"single"View mode: single or continuous
show-toolbarbooleantrueShow/hide the toolbar
show-thumbnailsbooleanfalseShow the thumbnail sidebar
show-searchbooleanfalseShow the search bar
no-downloadbooleanfalseHide the download button
no-printbooleanfalseHide the print button
titlestring""Title shown in the toolbar
lazybooleanfalseDefer loading until visible

Properties

PropertyTypeDescription
srcstringGet/set PDF URL
pagenumberGet/set current page number
zoomstringGet/set zoom level
modestringGet/set color mode
viewstringGet/set view mode
showToolbarbooleanWhether toolbar is visible (read-only)
showThumbnailsbooleanWhether thumbnails are shown (read-only)
showSearchbooleanWhether search is open (read-only)
noDownloadbooleanWhether download is disabled (read-only)
noPrintbooleanWhether print is disabled (read-only)
viewerTitlestringTitle text (read-only)
lazybooleanWhether lazy loading is on (read-only)

Methods

MethodReturnsDescription
nextPage()voidNavigate to next page
prevPage()voidNavigate to previous page
goToPage(n)voidNavigate to page n
getPageCount()numberGet total page count
getCurrentPage()numberGet current page number
zoomIn()voidZoom in one step
zoomOut()voidZoom out one step
setZoom(level)voidSet zoom level or mode
setData(source)PromiseLoad from ArrayBuffer, Uint8Array, or File
openFile()voidOpen file picker dialog
download()PromiseDownload the PDF
print()PromisePrint the PDF
search(query)PromiseSearch for text
clearSearch()voidClear search results
toggleFullscreen()voidToggle fullscreen mode
toggleThumbnails()voidToggle thumbnail sidebar
toggleSearch()voidToggle search bar

Events

EventDetailDescription
pdf-loaded{ url, pageCount, title }PDF document loaded successfully
pdf-load-error{ url, error }PDF failed to load
page-change{ page, previousPage, pageCount }Page navigation occurred
zoom-change{ zoom, previousZoom }Zoom level changed
view-change{ view }View mode changed
file-opened{ name, size }File opened via drag-drop or picker

CSS Custom Properties

PropertyDefault (light)Description
--pdf-viewer-bg#ffffffComponent background
--pdf-viewer-toolbar-bg#f6f8faToolbar background
--pdf-viewer-border-color#d1d5daBorder color
--pdf-viewer-text-color#24292ePrimary text color
--pdf-viewer-text-muted#586069Secondary text color
--pdf-viewer-accent-color#2563ebAccent/interactive color
--pdf-viewer-hover-bg#f3f4f6Hover background
--pdf-viewer-content-bg#e8e8e8Viewport background
--pdf-viewer-sidebar-bg#f0f0f0Sidebar background
--pdf-viewer-sidebar-width200pxSidebar width
--pdf-viewer-toolbar-height40pxToolbar height
--pdf-viewer-font-familysystem-uiFont family
--pdf-viewer-shadowsubtle shadowPage shadow

CSS Parts

PartDescription
toolbarThe toolbar area
contentThe PDF viewport/content area
sidebarThe thumbnail sidebar
searchThe search bar

Keyboard Shortcuts

KeyAction
Left / Up / PageUpPrevious page
Right / Down / PageDownNext page
HomeFirst page
EndLast page
+ / =Zoom in
-Zoom out
0Reset to fit-width
Ctrl+F / Cmd+FToggle search
EscapeClose search / exit fullscreen