Merge pull request #2 from run-llama/feat/llama-pdf-viewer

feat: llama pdf viewer

packages/react-pdf/.eslintignore → .eslintignore

@@ -1,2 +1,3 @@
 dist
 node_modules
+sample

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+  "extends": "wojtekmaj/react",
+  "rules": {
+    "@typescript-eslint/consistent-type-definitions": "off",
+    "@typescript-eslint/no-use-before-define": "off",
+    "react-hooks/exhaustive-deps": "off",
+    "no-console": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "react/jsx-no-leaked-render": "off",
+    "jsx-a11y/click-events-have-key-events": "off",
+    "jsx-a11y/no-static-element-interactions": "off",
+    "react/no-array-index-key": "off"
+  }
+}

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        react: [18, 19]
+        react: [18]
 
     steps:
       - name: Checkout
@@ -122,46 +122,3 @@ jobs:
 
       - name: Run formatting
         run: yarn format
-
-  unit:
-    name: Unit tests (React ${{ matrix.react }})
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        react: [18, 19]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Cache Yarn cache
-        uses: actions/cache@v4
-        env:
-          cache-name: yarn-cache
-        with:
-          path: ~/.yarn/berry/cache
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ env.cache-name }}
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Install dependencies
-        run: yarn --immutable
-
-      - name: Override React version
-        if: ${{ matrix.react == 19 }}
-        run: |
-          npm pkg set resolutions.'@types/react'='npm:types-react@beta'
-          npm pkg set resolutions.'@types/react-dom'='npm:types-react-dom@beta'
-          yarn config set enableImmutableInstalls false
-          yarn up react@beta react-dom@beta
-
-      - name: Run tests (React ${{ matrix.react }})
-        run: yarn unit

.github/workflows/publish.yml

@@ -47,13 +47,11 @@ jobs:
       - name: Publish with latest tag
         if: github.event.release.prelease == false
         run: npm publish package.tgz --tag latest --provenance
-        working-directory: packages/react-pdf
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Publish with next tag
         if: github.event.release.prelease == true
         run: npm publish package.tgz --tag next --provenance
-        working-directory: packages/react-pdf
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -33,3 +33,7 @@ yarn-error.log
 **/.env
 **/.env.*
 !**/.env.example
+
+# sample app
+sample/*
+*.tgz

.prettierignore

@@ -1,3 +1,4 @@
 .cache
 .yarn
 yarnrc.yml
+dist

README.md

@@ -0,0 +1,59 @@
+React PDF viewer for LLM applications
+
+## Installation
+
+```bash
+npm install @llamaindex/pdf-viewer
+```
+
+## Usage
+
+```jsx
+import React from 'react';
+
+import { PDFViewer, PdfFocusProvider } from '@llamaindex/pdf-viewer';
+
+const file = {
+  id: 'sample-document',
+  url: 'https://d687lz8k56fia.cloudfront.net/sec-edgar-filings/0001045810/10-Q/0001045810-22-000147/filing-details.pdf',
+};
+
+function App() {
+  return (
+    <div className="AppContainer">
+      <PdfFocusProvider>
+        <PDFViewer file={file} />
+      </PdfFocusProvider>
+    </div>
+  );
+}
+```
+
+## Custom Styles
+
+```jsx
+<PdfFocusProvider>
+  <PDFViewer containerClassName="your-container-class-name" file={file} />
+</PdfFocusProvider>
+```
+
+## Multiple PDF Files
+
+```jsx
+<PdfFocusProvider>
+  <div className="your-layout-class-name">
+    <PDFViewer file={file1} />
+    <PDFViewer file={file2} />
+    <PDFViewer file={file3} />
+  </div>
+</PdfFocusProvider>
+```
+
+## Dependencies
+
+- react-pdf
+- @wojtekmaj/react-hooks
+- react-window
+- react-intersection-observer
+- lodash
+- fuse.js