https://github.com/pdf-viewer-react/starter-rp-next-ts
React PDF Starter toolkit with Nextjs + TypeScript
https://github.com/pdf-viewer-react/starter-rp-next-ts
nextjs pdf-viewer pdf-viewer-react pdfjs pdfjs-dist react-pdf react-pdf-viewer reactjs typescript
Last synced: 11 months ago
JSON representation
React PDF Starter toolkit with Nextjs + TypeScript
- Host: GitHub
- URL: https://github.com/pdf-viewer-react/starter-rp-next-ts
- Owner: pdf-viewer-react
- Created: 2025-02-07T05:12:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T10:51:43.000Z (12 months ago)
- Last Synced: 2025-02-28T14:37:03.736Z (12 months ago)
- Topics: nextjs, pdf-viewer, pdf-viewer-react, pdfjs, pdfjs-dist, react-pdf, react-pdf-viewer, reactjs, typescript
- Language: TypeScript
- Homepage: https://www.react-pdf.dev
- Size: 87.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React PDF Starter Toolkit in Next.js and TypeScript
Welcome to the React PDF Starter Toolkit! This repository provides a comprehensive guide on integrating React PDF with Nextjs and TypeScript. It showcases how React PDF can be integrated and rendered as part of a Next.js project.
## Table of Contents
- [Usage](#usage)
- [Project Setup](#project-setup)
- [Running the Example Project](#running-the-example-project)
- [Examples](#examples)
## Usage
### Project Setup
1. **Clone the Repository**: If you haven't already, clone the repository and navigate into the project directory.
```bash
git clone https://github.com/reactpdf/starter-rp-next-ts.git
cd starter-rp-next-ts
```
2. **Install Dependencies**: Install the necessary dependencies using npm, yarn, pnpm or bun.
```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```
### Running the Example Project
This repository includes an example project to demonstrate React PDF in action.
1. **Start the Development Server**: Use the following command to start the development server
```bash
npm run dev
# or
yarn dev
# or
pnpm run dev
# or
bun run dev
```
2. **Open in Browser**: Open your browser and navigate to `http://localhost:3000` (or the port specified in your terminal) to see the example project in action
### Using the React PDF Component
Once the example project is running, you can explore the source code to see how the React PDF component is integrated. Here is a brief overview:
1. **Import the component**: Import the desired React PDF component into your codes
```tsx
import {
RPProvider,
RPDefaultLayout,
RPPages,
RPProviderProps,
RPLayoutProps,
} from "@pdf-viewer/react";
interface Props {
showToolbar?: boolean;
providerProps?: RPProviderProps;
defaultLayoutProps?: RPLayoutProps;
}
const AppPdfViewer = (props: Props) => {
const { showToolbar = true, providerProps, defaultLayoutProps } = props;
return (
{showToolbar ? (
) : (
)}
);
};
export default PdfViewer;
```
2. **Import Config Component**: Import the Config component
```tsx
import { RPConfig, RPConfigProps } from "@pdf-viewer/react";
import { FC } from "react";
const AppProviders: FC = ({ children }) => (
{children}
);
export default AppProviders;
```
3. **Disable SSR for AppPdfViewer**: Disable SSR for the AppPdfViewer component by using `dynamic` from `next/dynamic` and set `ssr: false`
```tsx
"use client";
import dynamic from "next/dynamic";
export const LazyAppPdfViewer = dynamic(() => import("./AppPdfViewer"), {
ssr: false,
});
```
4. **Disable SSR for AppProviders**: Disable SSR for AppProviders by using `dynamic` from `next/dynamic` and set `ssr: false`
```tsx
"use client";
import dynamic from "next/dynamic";
export const LazyAppProviders = dynamic(() => import("./AppProviders"), {
ssr: false,
});
```
5. **Use the LazyPdfConfig component in layout**: Add the React PDF component to your page
```jsx
import "./globals.css";
import { LazyAppProviders } from "./components/LazyAppProviders";
export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode,
}>) {
return (
{children}
);
}
```
6. **Use the LazyAppPdfViewer component in page**: Add the React PDF component to your page
```jsx
import { LazyAppPdfViewer } from "./components/LazyAppPdfViewer";
export default function Home() {
return (
RP Starter Toolkit: Nextjs + Javascript
Default Toolbar
Without Toolbar
Mobile
);
}
```
## Examples
For more examples, please refer to the `src/App.jsx` file in this repository:
- Default Toolbar
- Without Toolbar
- Mobile View
_Remark: If you would like more examples, feel free open an issue._
For more configurations, please check the [documentation](https://docs.react-pdf.dev) site.
---
Thank you for using React PDF! We hope this toolkit helps you build amazing Next.js applications. If you have any questions or need further assistance on this example, please feel free to open an issue. Happy coding!