Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 3 KB

README.md

File metadata and controls

103 lines (68 loc) · 3 KB
Raw

react-secure-pdf-viewer-mngo

This library is available at react-secure-pdf-viewer-mngo

Demo

pdf.mngo.in

Brief:

A JavaScript React Library (npm package) to open any pdf (password protected or non-protected both) having thumbnail, jump to page, zoom features and security features like

  1. ✅ block right click
  2. ✅ disable user select
  3. ✅ block download
  4. ✅ block getting pdf url by inspecting elements
  5. ✅ block printing of the page/pdf
  6. ❌ screenshot
  7. ❌ screen recording
  8. ✅ open pdf in pdf viewer using the given password programmatically

Screenshots:

screenshot 1

screenshot 2

Usage

<MNgoSecurePDFViewer
    theming={{ [key: string]: string }}
    loadingRenderer={string | ReactElement}
    errorRenderer={string | ReactElement}
    securityOptions=={{ [key: string]: boolean }}
    pdfUrl={string}
    pdfPassword={string}
    compHeight={string}
/>

props example

  1. theming different classes to override different style of elements

           {
            pdfComponentClassName: string
            toolbarClassName: string
            toolbarSegClassName: string
            toolBarBtnClassName: string
            pdfViewerClassName: string
            pdfPageClassName: string
            pdfThumbContainerClassName: string
            pdfThumbPageClassName: string
       }

  2. loadingRenderer string or DOM element to show while pdf is loading

  3. errorRenderer string or DOM element to show when pdf failed to load

  4. securityOptions by default all security options are enabled,

            {
            blockRightClick: boolean, // by default true
            blockUserSelection: boolean, // by default true
            blockPrint: boolean, // by default true
            blockDownload: boolean, // by default true
       }

  5. pdfUrl url (internal or extneral) of the pdf to open

  6. pdfPassword password of the pdf if, the pdf is password protected

  7. compHeight height of the component

Installation

  1. npm install
  2. npm start

Available Scripts

In the project directory, you can run

npm start

Runs the app in the development mode Open http://localhost:5173 to view it in the browser.

npm run lib-build

it is for final package build which create dist folder.

npm publish

to publish the project on npm

Note: do npm run lib-build before npm publish because it publishes dist folder as defined as key main, module, files in package.json, and do not forget to login in npm using npm login

npm run build-publish

this command make build of the project and publishes it, basically it is combination of npm run lib-build and npm publish

License

All rights reserved under MNgo.