A customizable React component to render PDF documents in a flipbook-style viewer — perfect for brochures, magazines, and interactive documents. ## Features
npm install react-pdf-flipbook-viewer
bash
npm install react-pdf-flipbook-viewer
`
or with yarn
`bash
yarn add react-pdf-flipbook-viewer
`
Tailwind Setup
This Library requires Tailwindcss. Add the following line to your tailwind.config.js :
`js
module.exports = {
content: [
'./node_modules/react-pdf-flipbook-viewer/*/.{js,ts,jsx,tsx}',
],
}
`
Usage
This is a basic Example using nextjs:
`tsx
'use client';
import {FlipbookViewer} from 'react-pdf-flipbook-viewer'
import React from 'react'
const Page = () => {
return (
)
}
export default Page
`
Components
$3
| Prop | Type | Description |
|---------------|-----------|--------------------------------------------------|
| pdfUrl | string | URL of the PDF document to be displayed. |
| shareUrl | string | URL to be used for sharing the document. |
| className | string | Additional CSS classes for styling. |
| disableShare| boolean | Flag to disable the share button. |
Local Development
You can run the following to setup a development environment:
`bash
git clone https://github.com/Timeler1/react-pdf-flipbook-viewer
cd react-pdf-flipbook-viewer
npm install
npm run build
`
You can use yalc` to test changes locally in another project.