!readme-header

---

PDFSlick for React is a library which enables viewing of and interaction with PDF documents in React apps.
It's build on top of Mozilla's PDF.js, and utilises Zustand to provide a reactive store for the loaded documents.

Getting started with PDFSlick for React

To get started with React run:

``shell
npm install @pdfslick/react


yarn add @pdfslick/react

You can start using PDFSlick with the usePDFSlick() hook, like with the following basic example:

`jsx
import { usePDFSlick } from "@pdfslick/react";
import PDFNavigation from "./yourcomponents/PDFNavigation";

//
// It is required to include PDFSlick's CSS styles once
// you can do it in your main App.tsx for example
//
import "@pdfslick/react/dist/pdf_viewer.css";

type PDFViewerComponentProps = {
pdfFilePath: string,
};

const PDFViewerComponent = ({ pdfFilePath }: PDFViewerComponent) => {
const { viewerRef, usePDFSlickStore, PDFSlickViewer } = usePDFSlick(
pdfFilePath,
{
scaleValue: "page-fit",
}
);

/*
Access the store with usePDFSlickStore() hook — you can pass is
as a prop to other components (like with below)
Toolbars, Sidebars, components which render thumbnails etc.
and use it as here to get and react on
PDF document's and viewer's properties and changes
*/
const scale = usePDFSlickStore((s) => s.scale);
const numPages = usePDFSlickStore((s) => s.numPages);
const pageNumber = usePDFSlickStore((s) => s.pageNumber);

return (


export default PDFViewerComponent;
`

Provided with the PDF Document path and PDFSlick options object, the usePDFSlick() hook returns an object consisting (among the other things) of:

- PDFSlickViewer is the PDF Viewer component used for viewing the PDF document
- viewerRef is the ref callback that is provided as a prop to the component
- usePDFSlickStore` enables using PDFSlick store within your React components

More on using PDFSlick with React | Checkout the React Examples

Author

PDFSlick was conceived and developed, and is currently maintained by Vancho Stojkov, who embarked on this project with the vision of simplifying PDF integration for modern web frameworks, leveraging the power of PDF.js while providing a developer-friendly API.

Thanks

- Vane Kosturanov for designing the logo
- VS Code Icons for the icons used throughout the examples