@thatkid02/react-native-pdf-viewer 0.0.1

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 thatkid02
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/PdfViewer.podspec

@@ -0,0 +1,28 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "PdfViewer"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/thatkid02/react-native-pdf-viewer.git", :tag => "#{s.version}" }
+
+  s.source_files = [
+    "ios/**/*.{h,m,mm,swift}",
+    "cpp/**/*.{hpp,cpp}",
+  ]
+
+  s.dependency 'React-jsi'
+  s.dependency 'React-callinvoker'
+
+  load 'nitrogen/generated/ios/PdfViewer+autolinking.rb'
+  add_nitrogen_files(s)
+
+  install_modules_dependencies(s)
+end

package/README.md

@@ -0,0 +1,290 @@
+# react-native-pdf-viewer
+
+High-performance PDF viewer for React Native, built with [Nitro Modules](https://nitro.margelo.com/) for native rendering performance.
+
+## Features
+
+✅ **High-performance PDF rendering** with native APIs (PDFKit on iOS, PdfRenderer on Android)  
+✅ **Pinch-to-zoom and pan gestures** - Smooth, native gesture handling  
+✅ **Thumbnail generation** for page previews  
+✅ **Local and remote PDF support** (file://, http://, https://)  
+✅ **Page navigation** with events  
+✅ **TypeScript support** - Full type safety  
+✅ **Memory efficient** - Virtualizes pages, only renders visible content  
+✅ **iOS-specific layouts** - Horizontal scroll and paging modes  
+
+## Platform Support
+
+| Feature | Android | iOS | Notes |
+|---------|---------|-----|-------|
+| Local Files (file://) | ✅ | ✅ | |
+| Remote URLs (http/https) | ✅ | ✅ | Prefer HTTPS in production |
+| Zoom Controls | ✅(2 scale) | ✅ | |
+| Page Navigation | ✅ | ✅ | |
+| Horizontal Scroll | ❌ | ✅ | iOS only |
+| Paging Mode | ❌ | ✅ | iOS only |
+| Thumbnail Generation | ✅ | ✅ | Async on both platforms |
+
+## Installation
+
+```sh
+npm install react-native-pdf-viewer react-native-nitro-modules
+```
+
+> `react-native-nitro-modules` is required as this library relies on [Nitro Modules](https://nitro.margelo.com/).
+
+## Usage
+
+### Basic Example
+
+```tsx
+import { PdfViewerView } from 'react-native-pdf-viewer';
+
+export default function App() {
+  return (
+    <PdfViewerView
+      source="https://example.com/document.pdf"
+      style={{ flex: 1 }}
+      onLoadComplete={(event) => {
+        console.log('PDF loaded:', event.pageCount, 'pages');
+      }}
+      onError={(event) => {
+        console.error('PDF error:', event.message);
+      }}
+    />
+  );
+}
+```
+
+### Advanced Example with All Features
+
+```tsx
+import React, { useRef } from 'react';
+import { View, Button, StyleSheet } from 'react-native';
+import { PdfViewerView, type PdfViewer } from 'react-native-pdf-viewer';
+
+export default function AdvancedPdfViewer() {
+  const pdfRef = useRef<PdfViewer>(null);
+  
+  const handleLoadComplete = (event) => {
+    console.log(`PDF loaded: ${event.pageCount} pages`);
+    console.log(`Page size: ${event.pageWidth}x${event.pageHeight}`);
+    
+    // Generate thumbnails for all pages
+    pdfRef.current?.generateAllThumbnails();
+  };
+  
+  const handlePageChange = (event) => {
+    console.log(`Current page: ${event.page + 1} of ${event.pageCount}`);
+  };
+  
+  const handleScaleChange = (event) => {
+    console.log(`Zoom scale: ${event.scale}`);
+  };
+  
+  const handleThumbnailGenerated = (event) => {
+    console.log(`Thumbnail for page ${event.page}: ${event.uri}`);
+  };
+  
+  const goToPage = (page: number) => {
+    pdfRef.current?.goToPage(page);
+  };
+  
+  const zoomIn = () => {
+    pdfRef.current?.setScale(2.0);
+  };
+  
+  return (
+    <View style={styles.container}>
+      <PdfViewerView
+        ref={pdfRef}
+        source="https://example.com/document.pdf"
+        style={styles.pdf}
+        // Layout options
+        spacing={16}
+        enableZoom={true}
+        minScale={0.5}
+        maxScale={5.0}
+        // iOS-only options
+        horizontal={false} // iOS only
+        enablePaging={false} // iOS only
+        // Loading indicator
+        showsActivityIndicator={true}
+        // Event handlers
+        onLoadComplete={handleLoadComplete}
+        onPageChange={handlePageChange}
+        onScaleChange={handleScaleChange}
+        onThumbnailGenerated={handleThumbnailGenerated}
+        onError={(event) => console.error(event.message)}
+        onLoadingChange={(event) => console.log('Loading:', event.isLoading)}
+      />
+      
+      <View style={styles.controls}>
+        <Button title="Go to Page 5" onPress={() => goToPage(4)} />
+        <Button title="Zoom In" onPress={zoomIn} />
+      </View>
+    </View>
+  );
+}
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+  },
+  pdf: {
+    flex: 1,
+  },
+  controls: {
+    flexDirection: 'row',
+    justifyContent: 'space-around',
+    padding: 16,
+  },
+});
+```
+
+### Loading Local Files
+
+```tsx
+<PdfViewerView
+  source="file:///path/to/document.pdf"
+  style={{ flex: 1 }}
+/>
+```
+
+### iOS-Specific Features
+
+```tsx
+// Horizontal scrolling (iOS only)
+<PdfViewerView
+  source="https://example.com/document.pdf"
+  horizontal={true}
+  style={{ flex: 1 }}
+/>
+
+// Paging mode with swipe transitions (iOS only)
+<PdfViewerView
+  source="https://example.com/document.pdf"
+  enablePaging={true}
+  style={{ flex: 1 }}
+/>
+```
+
+## API Reference
+
+### Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `source` | `string` | - | PDF source URI (file://, http://, https://) |
+| `spacing` | `number` | `8` | Space between pages in pixels |
+| `enableZoom` | `boolean` | `true` | Enable pinch-to-zoom gestures |
+| `minScale` | `number` | `0.5` | Minimum zoom scale |
+| `maxScale` | `number` | `4.0` | Maximum zoom scale |
+| `showsActivityIndicator` | `boolean` | `true` | Show loading indicator |
+| `horizontal` | `boolean` | `false` | Horizontal scroll (iOS only) |
+| `enablePaging` | `boolean` | `false` | Enable paging mode (iOS only) |
+| `onLoadComplete` | `(event) => void` | - | Called when PDF loads |
+| `onPageChange` | `(event) => void` | - | Called when page changes |
+| `onScaleChange` | `(event) => void` | - | Called when zoom changes |
+| `onError` | `(event) => void` | - | Called on error |
+| `onThumbnailGenerated` | `(event) => void` | - | Called when thumbnail is ready |
+| `onLoadingChange` | `(event) => void` | - | Called when loading state changes |
+
+### Methods
+
+Access methods via ref:
+
+```tsx
+const pdfRef = useRef<PdfViewer>(null);
+
+// Navigate to specific page (0-indexed)
+pdfRef.current?.goToPage(pageIndex);
+
+// Set zoom scale
+pdfRef.current?.setScale(2.0);
+
+// Generate thumbnail for specific page
+pdfRef.current?.generateThumbnail(pageIndex);
+
+// Generate thumbnails for all pages
+pdfRef.current?.generateAllThumbnails();
+```
+
+### Events
+
+#### LoadCompleteEvent
+```typescript
+{
+  pageCount: number;    // Total number of pages
+  pageWidth: number;    // Width of first page
+  pageHeight: number;   // Height of first page
+}
+```
+
+#### PageChangeEvent
+```typescript
+{
+  page: number;         // Current page index (0-based)
+  pageCount: number;    // Total pages
+}
+```
+
+#### ScaleChangeEvent
+```typescript
+{
+  scale: number;        // Current zoom scale
+}
+```
+
+#### ErrorEvent
+```typescript
+{
+  message: string;      // Error description
+  code: string;         // Error code (e.g., "FILE_NOT_FOUND")
+}
+```
+
+#### ThumbnailGeneratedEvent
+```typescript
+{
+  page: number;         // Page index
+  uri: string;          // File URI of thumbnail image
+}
+```
+
+## Performance
+
+- **Memory efficient**: Virtualizes pages, only renders visible content
+- **Smooth scrolling**: 60 FPS on most devices
+- **Large PDFs**: Tested with 500+ page documents
+- **Smart caching**: Automatic memory management with LRU cache
+
+## Troubleshooting
+
+### PDF fails to load from URL
+
+Ensure the URL is accessible and returns a valid PDF. For production apps, always use HTTPS URLs for security.
+
+### Out of memory errors on large PDFs
+
+The library automatically manages memory, but for very large documents at high zoom levels:
+- Limit `maxScale` to reduce memory usage
+- The Android implementation dynamically reduces quality at high zoom levels
+
+### iOS horizontal/paging mode not working
+
+These features are iOS-only. On Android, the viewer always uses vertical scrolling.
+
+## Contributing
+
+- [Development workflow](CONTRIBUTING.md#development-workflow)
+- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
+- [Code of conduct](CODE_OF_CONDUCT.md)
+
+## License
+
+MIT
+
+---
+
+Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

package/android/CMakeLists.txt

@@ -0,0 +1,24 @@
+project(pdfviewer)
+cmake_minimum_required(VERSION 3.9.0)
+
+set(PACKAGE_NAME pdfviewer)
+set(CMAKE_VERBOSE_MAKEFILE ON)
+set(CMAKE_CXX_STANDARD 20)
+
+# Define C++ library and add all sources
+add_library(${PACKAGE_NAME} SHARED src/main/cpp/cpp-adapter.cpp)
+
+# Add Nitrogen specs :)
+include(${CMAKE_SOURCE_DIR}/../nitrogen/generated/android/pdfviewer+autolinking.cmake)
+
+# Set up local includes
+include_directories("src/main/cpp" "../cpp")
+
+find_library(LOG_LIB log)
+
+# Link all libraries together
+target_link_libraries(
+        ${PACKAGE_NAME}
+        ${LOG_LIB}
+        android # <-- Android core
+)

package/android/build.gradle

@@ -0,0 +1,121 @@
+buildscript {
+  ext.PdfViewer = [
+    kotlinVersion: "2.0.21",
+    minSdkVersion: 24,
+    compileSdkVersion: 36,
+    targetSdkVersion: 36,
+    ndkVersion: "27.1.12297006"
+  ]
+
+  ext.getExtOrDefault = { prop ->
+    if (rootProject.ext.has(prop)) {
+      return rootProject.ext.get(prop)
+    }
+
+    return PdfViewer[prop]
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.7.2"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+  }
+}
+
+def reactNativeArchitectures() {
+  def value = rootProject.getProperties().get("reactNativeArchitectures")
+  return value ? value.split(",") : ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+apply from: '../nitrogen/generated/android/pdfviewer+autolinking.gradle'
+
+apply plugin: "com.facebook.react"
+
+android {
+  namespace "com.margelo.nitro.pdfviewer"
+
+  compileSdkVersion getExtOrDefault("compileSdkVersion")
+  ndkVersion getExtOrDefault("ndkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrDefault("minSdkVersion")
+    targetSdkVersion getExtOrDefault("targetSdkVersion")
+
+    externalNativeBuild {
+      cmake {
+        cppFlags "-frtti -fexceptions -Wall -fstack-protector-all"
+        arguments "-DANDROID_STL=c++_shared", "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON"
+        abiFilters (*reactNativeArchitectures())
+
+        buildTypes {
+          debug {
+            cppFlags "-O1 -g"
+          }
+          release {
+            cppFlags "-O2"
+          }
+        }
+      }
+    }
+  }
+
+  externalNativeBuild {
+    cmake {
+      path "CMakeLists.txt"
+    }
+  }
+
+  packagingOptions {
+    excludes = [
+      "META-INF",
+      "META-INF/**",
+      "**/libc++_shared.so",
+      "**/libfbjni.so",
+      "**/libjsi.so",
+      "**/libfolly_json.so",
+      "**/libfolly_runtime.so",
+      "**/libglog.so",
+      "**/libhermes.so",
+      "**/libhermes-executor-debug.so",
+      "**/libhermes_executor.so",
+      "**/libreactnative.so",
+      "**/libreactnativejni.so",
+      "**/libturbomodulejsijni.so",
+      "**/libreact_nativemodule_core.so",
+      "**/libjscexecutor.so"
+    ]
+  }
+
+  buildFeatures {
+    buildConfig true
+    prefab true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lint {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+}
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation project(":react-native-nitro-modules")
+  implementation "androidx.recyclerview:recyclerview:1.3.2"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/cpp/cpp-adapter.cpp

@@ -0,0 +1,6 @@
+#include <jni.h>
+#include "pdfviewerOnLoad.hpp"
+
+JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void*) {
+  return margelo::nitro::pdfviewer::initialize(vm);
+}

package/android/src/main/java/com/margelo/nitro/pdfviewer/HybridPdfViewer.kt

@@ -0,0 +1,169 @@
+package com.margelo.nitro.pdfviewer
+
+import android.view.View
+import androidx.annotation.Keep
+import com.facebook.proguard.annotations.DoNotStrip
+import com.facebook.react.uimanager.ThemedReactContext
+
+/**
+ * HybridPdfViewer that extends the Nitrogen-generated HybridPdfViewerSpec.
+ * This wraps DocumentViewer and connects it to the Nitro interface.
+ */
+@DoNotStrip
+@Keep
+class HybridPdfViewer(private val reactContext: ThemedReactContext) : HybridPdfViewerSpec() {
+    
+    companion object {
+        private const val TAG = "HybridPdfViewer"
+        
+        init {
+            if (BuildConfig.DEBUG) {
+                android.util.Log.d(TAG, "HybridPdfViewer class initializing...")
+            }
+            // Load native library before HybridPdfViewerSpec is initialized
+            pdfviewerOnLoad.initializeNative()
+            if (BuildConfig.DEBUG) {
+                android.util.Log.d(TAG, "Native library loaded successfully")
+            }
+        }
+    }
+    
+    private val documentViewer = PdfViewer(reactContext)
+    
+    init {
+        if (BuildConfig.DEBUG) {
+            android.util.Log.d(TAG, "HybridPdfViewer instance created")
+        }
+    }
+    
+    override val view: View
+        get() = documentViewer
+    
+    // Connect DocumentViewer callbacks to Nitro callbacks
+    init {
+        documentViewer.onLoadCompleteCallback = { pageCount, pageWidth, pageHeight ->
+            onLoadComplete?.invoke(LoadCompleteEvent(
+                pageCount = pageCount.toDouble(),
+                pageWidth = pageWidth.toDouble(),
+                pageHeight = pageHeight.toDouble()
+            ))
+        }
+        
+        documentViewer.onPageChangeCallback = { page, pageCount ->
+            onPageChange?.invoke(PageChangeEvent(
+                page = page.toDouble(),
+                pageCount = pageCount.toDouble()
+            ))
+        }
+        
+        documentViewer.onScaleChangeCallback = { scale ->
+            onScaleChange?.invoke(ScaleChangeEvent(
+                scale = scale.toDouble()
+            ))
+        }
+        
+        documentViewer.onErrorCallback = { message, code ->
+            onError?.invoke(ErrorEvent(
+                message = message,
+                code = code
+            ))
+        }
+        
+        documentViewer.onThumbnailGeneratedCallback = { page, uri ->
+            onThumbnailGenerated?.invoke(ThumbnailGeneratedEvent(
+                page = page.toDouble(),
+                uri = uri
+            ))
+        }
+        
+        documentViewer.onLoadingChangeCallback = { isLoading ->
+            onLoadingChange?.invoke(LoadingChangeEvent(
+                isLoading = isLoading
+            ))
+        }
+    }
+    
+    // MARK: - Nitro Properties
+    
+    override var source: String? = null
+        set(value) {
+            if (BuildConfig.DEBUG) {
+                android.util.Log.d("HybridPdfViewer", "Setting source: $value")
+            }
+            field = value
+            documentViewer.sourceUri = value
+        }
+    
+    // Note: horizontal and enablePaging are iOS-only features, but we keep them
+    // here to match the interface. They have no effect on Android.
+    override var horizontal: Boolean? = null
+        set(value) {
+            field = value
+            // No-op on Android - always uses vertical scroll
+        }
+    
+    override var enablePaging: Boolean? = null
+        set(value) {
+            field = value
+            // No-op on Android - paging not supported
+        }
+    
+    override var spacing: Double? = null
+        set(value) {
+            field = value
+            value?.let { documentViewer.spacing = it.toFloat() }
+        }
+    
+    override var enableZoom: Boolean? = null
+        set(value) {
+            field = value
+            value?.let { documentViewer.enableZoom = it }
+        }
+    
+    override var minScale: Double? = null
+        set(value) {
+            field = value
+            value?.let { documentViewer.minScale = it.toFloat() }
+        }
+    
+    override var maxScale: Double? = null
+        set(value) {
+            field = value
+            value?.let { documentViewer.maxScale = it.toFloat() }
+        }
+    
+    override var showsActivityIndicator: Boolean? = null
+        set(value) {
+            field = value
+            value?.let { documentViewer.showsActivityIndicator = it }
+        }
+    
+    // Event callbacks - these are set by Nitro
+    override var onLoadComplete: ((event: LoadCompleteEvent) -> Unit)? = null
+    override var onPageChange: ((event: PageChangeEvent) -> Unit)? = null
+    override var onScaleChange: ((event: ScaleChangeEvent) -> Unit)? = null
+    override var onError: ((event: ErrorEvent) -> Unit)? = null
+    override var onThumbnailGenerated: ((event: ThumbnailGeneratedEvent) -> Unit)? = null
+    override var onLoadingChange: ((event: LoadingChangeEvent) -> Unit)? = null
+    
+    // MARK: - Nitro Methods
+    
+    override fun goToPage(page: Double) {
+        documentViewer.goToPage(page.toInt())
+    }
+    
+    override fun setScale(scale: Double) {
+        documentViewer.setScale(scale.toFloat())
+    }
+    
+    override fun generateThumbnail(page: Double) {
+        if (BuildConfig.DEBUG) {
+            android.util.Log.d("HybridPdfViewer", "generateThumbnail called for page: $page")
+        }
+        documentViewer.generateThumbnail(page.toInt())
+    }
+    
+    override fun generateAllThumbnails() {
+        documentViewer.generateAllThumbnails()
+    }
+}