vue3-pdf-app
v1.0.3TypeScript
Vue 3 PDF viewer
10.1K/weekUpdated 3 years agoMITUnpacked: 25.0 MB
Published by stellR42
npm install vue3-pdf-appVue3 Pdf App
Vue 3 PDF viewer based on Mozilla's PDFJS. Forked from https://github.com/sandanat/vue-pdf-app.
100% PDFJS functionality:
- zoom
- open
- download
- rotate
- text selection
- search panel
- pdf document password
- thumbnail, outline, attachments, annotation layers
Easily localized configurable toolbar
Toolbar custom UI
Cross-browser support
Color customization
Buttons icons customization
Light/dark themes
Built-in typescript support
!pdf sample
Live demo
FAQ
Installation
``
npm install vue3-pdf-app
`
Usage
`vue
`
API
$3
- Type: string | null | ArrayBuffer | TypedArray
- Required: false
- Usage:
`vue
`
$3
- Description: true renames document title to pdf file name.
- Type: boolean
- Required: false
- Default: false
- Usage:
`vue
`
$3
- Type: "dark" | "light"
- Required: false
- Usage:
`vue
`
$3
- Description: when pdf is passed like an array buffer default download file name is document.pdf. Set this prop to override it.
- Type: string
- Required: false
- Usage:
`vue
`
$3
- Description: default page scale.
- Type: number | "page-actual"| "page-width"| "page-height"| "page-fit"| "auto"
- Required: false
- Usage:
`vue
// 20%
`
$3
- Description: pdfjs stores last viewed page of a file in window.localStorage.getItem("pdfjs.history"). Specify the prop to override it.
- Type: number
- Required: false
- Usage:
`vue
`
$3
- Description: toolbar configuration. Toolbar is available by default. Specify false for buttons or whole group of buttons to disable them.
- Type: toolbar config (see below)
- Required: false
- Default: toolbar config
- Usage:
`vue
`
Config specification
!Config legend
{
sidebar: {
viewThumbnail: true,
viewOutline: true,
viewAttachments: true,
},
secondaryToolbar: {
secondaryPresentationMode: true,
secondaryOpenFile: true,
secondaryPrint: true,
secondaryDownload: true,
secondaryViewBookmark: true,
firstPage: true,
lastPage: true,
pageRotateCw: true,
pageRotateCcw: true,
cursorSelectTool: true,
cursorHandTool: true,
scrollVertical: true,
scrollHorizontal: true,
scrollWrapped: true,
spreadNone: true,
spreadOdd: true,
spreadEven: true,
documentProperties: true,
},
toolbar: {
toolbarViewerLeft: {
findbar: true,
previous: true,
next: true,
pageNumber: true,
},
toolbarViewerRight: {
presentationMode: true,
openFile: true,
print: true,
download: true,
viewBookmark: true,
},
toolbarViewerMiddle: {
zoomOut: true,
zoomIn: true,
scaleSelectContainer: true,
},
},
errorWrapper: true,
};
$3
- Description: If default toolbar UI doesn't suit you it is possible to build custom toolbar. The prop contains elements ID to which to bind functionality. If element ID is specified in this prop appropriate button will be hidden in a default toolbar. May not work with UI framework components. That is because pdfjs internally manages attributes specific to a certain HTML element (for instance pdfjs toggles disabled attribute of a button but it won't if a div is used instead of a button). So it is better to use native HTML element specified as recommended in ID config specification below. Four slots are specially designed to build custom toolbar (are situated near a pdf page): viewer-header, viewer-prepend, viewer-append, viewer-footer (refer slots API). It is also possible to use other slots or elements outside vue-pdf-app.
- Type: ID config (see below)
- Required: false
- Usage:
`vue
`
ID config specification
{
cursorHandTool?: string; // <button> is recommended
cursorSelectTool?: string; // <button> is recommended
documentProperties?: string; // <button> is recommended
download?: string; // <button> is recommended
findbar?: string; // <div> is recommended
findEntireWord?: string; // <input type="checkbox"> is recommended
findHighlightAll?: string; // <input type="checkbox"> is recommended
findMessage?: string; // <span> is recommended
findInput?: string; // <input type="text"> is recommended
findMatchCase?: string; // <input type="checkbox"> is recommended
findNext?: string; // <button> is recommended
findPrevious?: string; // <button> is recommended
findResultsCount?: string; // <span> is recommended
firstPage?: string; // <button> is recommended
lastPage?: string; // <button> is recommended
nextPage?: string; // <button> is recommended
numPages?: string; // total pages qty. <span> is recommended
openFile?: string; // <button> is recommended
pageNumber?: string; // input for page number. <input type="number"> is recommended
pageRotateCcw?: string; // <button> is recommended
pageRotateCw?: string; // <button> is recommended
presentationMode?: string; // <button> is recommended
previousPage?: string; // <button> is recommended
print?: string; // <button> is recommended
scrollHorizontal?: string; // <button> is recommended
scrollVertical?: string; // <button> is recommended
scrollWrapped?: string; // <button> is recommended
sidebarToggle?: string; // <button> is recommended
spreadEven?: string; // <button> is recommended
spreadNone?: string; // <button> is recommended
spreadOdd?: string; // <button> is recommended
toggleFindbar?: string; // <button> is recommended
viewAttachments?: string; // <button> is recommended
viewBookmark?: string; // <a> tag is recommended
viewOutline?: string; // <button> tag is recommended
viewThumbnail?: string; // <button> tag is recommended
zoomIn?: string; // <button> tag is recommended
zoomOut?: string; // <button> tag is recommended
}
> ℹ️ Note that elements must be in HTML document by the time vue-pdf-app is mounting (use v-show instead of v-if directive if necessary). Otherwise an error occurs.
$3
- Description: emitted only once when Pdfjs library is binded to vue component. Can be used to set Pdfjs config before pdf document opening.
- Arguments:
- PDFViewerApplication - pdf application
- Usage:
`vue
`
$3
- Description: emitted when pdf is opened but pages are not rendered.
- Arguments:
- PDFViewerApplication - pdf application
- Usage:
`vue
`
$3
- Description: emitted when pdf document pages are rendered. Can be used to set default pages scale, for instance.
- Arguments:
- PDFViewerApplication - pdf application
- Usage:
`vue
`
> ℹ️ Events are triggered in the following order after-created (once) => open => pages-rendered
$3
#### Slot names
- toolbar-left-prepend
- toolbar-left-append
- toolbar-middle-prepend
- toolbar-middle-append
- toolbar-right-prepend
- toolbar-right-append
- toolbar-sidebar-prepend
- toolbar-sidebar-append
- secondary-toolbar-prepend
- secondary-toolbar-append
- footer
- viewer-header: slot before viewer-prepend slot. Can be used to build custom toolbar.
- viewer-prepend: slot before viewerContainer div. Can be used to build custom toolbar.
- viewer-append: slot after viewerContainer div. Can be used to build custom toolbar.
- viewer-footer: slot after viewer-append slot. Can be used to build custom toolbar.
#### Slot props
Each slot has props:
1. toggleTheme
Type: (): void.
Description: toggle theme handler
1. isSidebarHidden
Type: boolean
Description: state of a sidebar (visible or hidden). Can be used to manage visibility of custom Attachments, Outline and Thumbnail buttons
1. isFindbarHidden
Type: boolean
Description: state of a findbar (visible or hidden). Can be used to manage visibility of custom findbar
`vue
`
Color customization
Colors of the pdf viewer are customized via custom css properties:
`html
`
Custom css properties specification
Property
Applied to selectors
Description
--pdf-app-background-color
.pdf-app
Background color for root pdf container
--pdf-button-hover-font-color
.pdf-app .toolbarButton:hover
.pdf-app .toolbarButton:focus
.pdf-app .dropdownToolbarButton:hover
.pdf-app .secondaryToolbarButton:hover
.pdf-app .secondaryToolbarButton:focus
Hover color for buttons of toolbar and secondary toolbar
--pdf-button-toggled-color
.pdf-app .toolbarButton.toggled
.pdf-app .splitToolbarButton.toggled > .toolbarButton.toggled
.pdf-app .secondaryToolbarButton.toggled
.pdf-app .outlineItemToggler:hover
.pdf-app .outlineItemToggler:hover + a
.pdf-app .outlineItemToggler:hover ~ .outlineItems
.pdf-app .outlineItem > a:hover
.pdf-app .attachmentsItem > button:hover
Background color for toggleable buttons when selected, outline items on hover, attachment items on hover
--pdf-dialog-button-color
.pdf-app .dialog .overlayButton
--pdf-dialog-button-font-color
.pdf-app .dialog .overlayButton
--pdf-error-more-info-color
.pdf-app #errorMoreInfo
--pdf-error-more-info-font-color
.pdf-app #errorMoreInfo
--pdf-error-wrapper-color
.pdf-app #errorWrapper
--pdf-find-input-placeholder-font-color
.pdf-app #findInput::placeholder
--pdf-find-message-font-color
.pdf-app #findMsg
--pdf-find-results-count-color
.pdf-app #findResultsCount
--pdf-find-results-count-font-color
.pdf-app #findResultsCount
--pdf-horizontal-toolbar-separator-color
.pdf-app .horizontalToolbarSeparator
--pdf-input-color
.pdf-app .toolbarField
--pdf-input-font-color
.pdf-app .toolbarField
--pdf-loading-bar-color
.pdf-app #loadingBar .progress
--pdf-loading-bar-secondary-color
.pdf-app #loadingBar .progress.indeterminate .glimmer
--pdf-not-found-color
.pdf-app #findInput.notFound
--pdf-overlay-container-color
.pdf-app #overlayContainer
Background color for overlay container of dialogs
--pdf-overlay-container-dialog-color
.pdf-app #overlayContainer > .container > .dialog
Background color for document properties, password, print dialogs
--pdf-overlay-container-dialog-font-color
.pdf-app #overlayContainer > .container > .dialog
Font color for document properties, password, print dialogs
--pdf-overlay-container-dialog-separator-color
.pdf-app .dialog .separator
--pdf-sidebar-content-color
.pdf-app #sidebarContent
Background color for sidebar
--pdf-split-toolbar-button-separator-color
.pdf-app .splitToolbarButtonSeparator
.pdf-app .verticalToolbarSeparator
--pdf-thumbnail-selection-ring-selected-color
.pdf-app .thumbnail.selected > .thumbnailSelectionRing
Border color for selected thumbnail
--pdf-thumbnail-selection-ring-color
.pdf-app a:focus > .thumbnail > .thumbnailSelectionRing
.pdf-app .thumbnail:hover > .thumbnailSelectionRing
Border color for thumbnail on hover and focus
--pdf-toolbar-color
.pdf-app #toolbarContainer
.pdf-app .findbar
.pdf-app .secondaryToolbar
.pdf-app .doorHanger:after
.pdf-app .doorHangerRight:after
.pdf-app .dropdownToolbarButton > select
.pdf-app .dropdownToolbarButton > select > option
Background color for toolbar, findbar, secondary toolbar, page scale dropdown
--pdf-toolbar-font-color
.pdf-app .toolbarButton
.pdf-app .dropdownToolbarButton
.pdf-app .secondaryToolbarButton
.pdf-app .dropdownToolbarButton > select
.pdf-app .toolbarLabel
.pdf-app .outlineItem > a
.pdf-app .attachmentsItem > button
Font color for toolbar, findbar, secondary toolbar, page scale dropdown, attachments name
--pdf-toolbar-sidebar-color
.pdf-app #toolbarSidebar
Icons customization
To use default icons import "vue3-pdf-app/dist/icons/main.css";.
To use custom icons you have to implement icons.css:
`css
.vue-pdf-app-icon::before,
.vue-pdf-app-icon::after {
font-family: "your font family";
}
.vue-pdf-app-icon.zoom-out::before {
content: "icon code";
}
`
Light/dark themes
Algorithm of theme apply
Toggle theme button is not implemented by default.
It's up to you to decide where to place it.
The button can be implemented with slots:
`vue
`
Localized panel
English is the default language for panel.
Use in your html for localization.
See localization file examples.
Examples
$3
PDFJS is a huge package (see the library size table above).
So use lazy loading to split your bundle into small pieces.
`vue
`
$3
You can interact with pdfjs library when pdf is opened via open event.
`vue
PDF info:
{{ item.name }}: {{ item.value }}
``