react-native-pdf-sdk 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +24 -0
- package/LICENSE +21 -0
- package/PdfSdk.podspec +32 -0
- package/README.md +270 -2
- package/android/CMakeLists.txt +24 -0
- package/android/build.gradle +132 -0
- package/android/gradle.properties +4 -0
- package/android/src/main/AndroidManifest.xml +1 -0
- package/android/src/main/cpp/cpp-adapter.cpp +9 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/HybridPdfDocument.kt +72 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/HybridPdfSdk.kt +17 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/HybridPdfView.kt +194 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfDocumentLayout.kt +109 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfFailure.kt +36 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfPageSource.kt +141 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfSdkPackage.kt +35 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfSourceLoader.kt +117 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfSurface.kt +839 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfTileStore.kt +210 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/PdfViewport.kt +255 -0
- package/android/src/main/java/com/margelo/nitro/pdfsdk/TileGrid.kt +276 -0
- package/ios/HybridPdfDocument.swift +71 -0
- package/ios/HybridPdfSdk.swift +10 -0
- package/ios/HybridPdfView.swift +202 -0
- package/ios/PdfDocumentLayout.swift +174 -0
- package/ios/PdfFailure.swift +46 -0
- package/ios/PdfImageCache.swift +83 -0
- package/ios/PdfPageSource.swift +221 -0
- package/ios/PdfScrollPlan.swift +108 -0
- package/ios/PdfSourceLoader.swift +120 -0
- package/ios/PdfSurface.swift +711 -0
- package/ios/PdfTileCanvas.swift +148 -0
- package/ios/PdfTileGrid.swift +518 -0
- package/ios/PdfTileStore.swift +346 -0
- package/ios/PdfViewport.swift +200 -0
- package/lib/commonjs/PdfView.js +149 -0
- package/lib/commonjs/PdfView.js.map +1 -0
- package/lib/commonjs/document.js +38 -0
- package/lib/commonjs/document.js.map +1 -0
- package/lib/commonjs/index.js +26 -0
- package/lib/commonjs/index.js.map +1 -0
- package/lib/commonjs/package.json +1 -0
- package/lib/commonjs/specs/PdfSdk.nitro.js +6 -0
- package/lib/commonjs/specs/PdfSdk.nitro.js.map +1 -0
- package/lib/commonjs/specs/PdfView.nitro.js +6 -0
- package/lib/commonjs/specs/PdfView.nitro.js.map +1 -0
- package/lib/module/PdfView.js +143 -0
- package/lib/module/PdfView.js.map +1 -0
- package/lib/module/document.js +34 -0
- package/lib/module/document.js.map +1 -0
- package/lib/module/index.js +5 -0
- package/lib/module/index.js.map +1 -0
- package/lib/module/specs/PdfSdk.nitro.js +4 -0
- package/lib/module/specs/PdfSdk.nitro.js.map +1 -0
- package/lib/module/specs/PdfView.nitro.js +4 -0
- package/lib/module/specs/PdfView.nitro.js.map +1 -0
- package/lib/typescript/src/PdfView.d.ts +65 -0
- package/lib/typescript/src/PdfView.d.ts.map +1 -0
- package/lib/typescript/src/document.d.ts +22 -0
- package/lib/typescript/src/document.d.ts.map +1 -0
- package/lib/typescript/src/index.d.ts +6 -0
- package/lib/typescript/src/index.d.ts.map +1 -0
- package/lib/typescript/src/specs/PdfSdk.nitro.d.ts +60 -0
- package/lib/typescript/src/specs/PdfSdk.nitro.d.ts.map +1 -0
- package/lib/typescript/src/specs/PdfView.nitro.d.ts +131 -0
- package/lib/typescript/src/specs/PdfView.nitro.d.ts.map +1 -0
- package/nitro.json +40 -0
- package/nitrogen/generated/.gitattributes +1 -0
- package/nitrogen/generated/android/PdfSdk+autolinking.cmake +87 -0
- package/nitrogen/generated/android/PdfSdk+autolinking.gradle +27 -0
- package/nitrogen/generated/android/PdfSdkOnLoad.cpp +84 -0
- package/nitrogen/generated/android/PdfSdkOnLoad.hpp +34 -0
- package/nitrogen/generated/android/c++/JFunc_void_PdfErrorEvent.hpp +80 -0
- package/nitrogen/generated/android/c++/JFunc_void_PdfLoadEvent.hpp +77 -0
- package/nitrogen/generated/android/c++/JFunc_void_PdfPageEvent.hpp +77 -0
- package/nitrogen/generated/android/c++/JFunc_void_PdfTapEvent.hpp +77 -0
- package/nitrogen/generated/android/c++/JFunc_void_PdfZoomEvent.hpp +77 -0
- package/nitrogen/generated/android/c++/JHybridNativePdfViewSpec.cpp +266 -0
- package/nitrogen/generated/android/c++/JHybridNativePdfViewSpec.hpp +92 -0
- package/nitrogen/generated/android/c++/JHybridPdfDocumentSpec.cpp +87 -0
- package/nitrogen/generated/android/c++/JHybridPdfDocumentSpec.hpp +65 -0
- package/nitrogen/generated/android/c++/JHybridPdfSdkSpec.cpp +58 -0
- package/nitrogen/generated/android/c++/JHybridPdfSdkSpec.hpp +63 -0
- package/nitrogen/generated/android/c++/JPdfErrorCode.hpp +67 -0
- package/nitrogen/generated/android/c++/JPdfErrorEvent.hpp +63 -0
- package/nitrogen/generated/android/c++/JPdfFit.hpp +64 -0
- package/nitrogen/generated/android/c++/JPdfLoadEvent.hpp +65 -0
- package/nitrogen/generated/android/c++/JPdfPageEvent.hpp +61 -0
- package/nitrogen/generated/android/c++/JPdfPageSize.hpp +61 -0
- package/nitrogen/generated/android/c++/JPdfRenderRequest.hpp +86 -0
- package/nitrogen/generated/android/c++/JPdfTapEvent.hpp +65 -0
- package/nitrogen/generated/android/c++/JPdfViewSource.hpp +84 -0
- package/nitrogen/generated/android/c++/JPdfZoomEvent.hpp +61 -0
- package/nitrogen/generated/android/c++/views/JHybridNativePdfViewStateUpdater.cpp +108 -0
- package/nitrogen/generated/android/c++/views/JHybridNativePdfViewStateUpdater.hpp +49 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/Func_void_PdfErrorEvent.kt +80 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/Func_void_PdfLoadEvent.kt +80 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/Func_void_PdfPageEvent.kt +80 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/Func_void_PdfTapEvent.kt +80 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/Func_void_PdfZoomEvent.kt +80 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/HybridNativePdfViewSpec.kt +185 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/HybridPdfDocumentSpec.kt +65 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/HybridPdfSdkSpec.kt +54 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfErrorCode.kt +26 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfErrorEvent.kt +56 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfFit.kt +25 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfLoadEvent.kt +61 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfPageEvent.kt +56 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfPageSize.kt +56 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfRenderRequest.kt +86 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfSdkOnLoad.kt +35 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfTapEvent.kt +61 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfViewSource.kt +66 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/PdfZoomEvent.kt +56 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/views/HybridNativePdfViewManager.kt +80 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/pdfsdk/views/HybridNativePdfViewStateUpdater.kt +23 -0
- package/nitrogen/generated/ios/PdfSdk+autolinking.rb +62 -0
- package/nitrogen/generated/ios/PdfSdk-Swift-Cxx-Bridge.cpp +123 -0
- package/nitrogen/generated/ios/PdfSdk-Swift-Cxx-Bridge.hpp +474 -0
- package/nitrogen/generated/ios/PdfSdk-Swift-Cxx-Umbrella.hpp +88 -0
- package/nitrogen/generated/ios/PdfSdkAutolinking.mm +41 -0
- package/nitrogen/generated/ios/PdfSdkAutolinking.swift +38 -0
- package/nitrogen/generated/ios/c++/HybridNativePdfViewSpecSwift.cpp +11 -0
- package/nitrogen/generated/ios/c++/HybridNativePdfViewSpecSwift.hpp +209 -0
- package/nitrogen/generated/ios/c++/HybridPdfDocumentSpecSwift.cpp +11 -0
- package/nitrogen/generated/ios/c++/HybridPdfDocumentSpecSwift.hpp +105 -0
- package/nitrogen/generated/ios/c++/HybridPdfSdkSpecSwift.cpp +11 -0
- package/nitrogen/generated/ios/c++/HybridPdfSdkSpecSwift.hpp +86 -0
- package/nitrogen/generated/ios/c++/views/HybridNativePdfViewComponent.mm +187 -0
- package/nitrogen/generated/ios/swift/Func_void_PdfErrorEvent.swift +46 -0
- package/nitrogen/generated/ios/swift/Func_void_PdfLoadEvent.swift +46 -0
- package/nitrogen/generated/ios/swift/Func_void_PdfPageEvent.swift +46 -0
- package/nitrogen/generated/ios/swift/Func_void_PdfTapEvent.swift +46 -0
- package/nitrogen/generated/ios/swift/Func_void_PdfZoomEvent.swift +46 -0
- package/nitrogen/generated/ios/swift/Func_void_std__exception_ptr.swift +46 -0
- package/nitrogen/generated/ios/swift/Func_void_std__string.swift +46 -0
- package/nitrogen/generated/ios/swift/HybridNativePdfViewSpec.swift +70 -0
- package/nitrogen/generated/ios/swift/HybridNativePdfViewSpec_cxx.swift +438 -0
- package/nitrogen/generated/ios/swift/HybridPdfDocumentSpec.swift +57 -0
- package/nitrogen/generated/ios/swift/HybridPdfDocumentSpec_cxx.swift +173 -0
- package/nitrogen/generated/ios/swift/HybridPdfSdkSpec.swift +55 -0
- package/nitrogen/generated/ios/swift/HybridPdfSdkSpec_cxx.swift +148 -0
- package/nitrogen/generated/ios/swift/PdfErrorCode.swift +52 -0
- package/nitrogen/generated/ios/swift/PdfErrorEvent.swift +34 -0
- package/nitrogen/generated/ios/swift/PdfFit.swift +48 -0
- package/nitrogen/generated/ios/swift/PdfLoadEvent.swift +39 -0
- package/nitrogen/generated/ios/swift/PdfPageEvent.swift +34 -0
- package/nitrogen/generated/ios/swift/PdfPageSize.swift +34 -0
- package/nitrogen/generated/ios/swift/PdfRenderRequest.swift +129 -0
- package/nitrogen/generated/ios/swift/PdfTapEvent.swift +39 -0
- package/nitrogen/generated/ios/swift/PdfViewSource.swift +97 -0
- package/nitrogen/generated/ios/swift/PdfZoomEvent.swift +34 -0
- package/nitrogen/generated/shared/c++/HybridNativePdfViewSpec.cpp +51 -0
- package/nitrogen/generated/shared/c++/HybridNativePdfViewSpec.hpp +112 -0
- package/nitrogen/generated/shared/c++/HybridPdfDocumentSpec.cpp +24 -0
- package/nitrogen/generated/shared/c++/HybridPdfDocumentSpec.hpp +70 -0
- package/nitrogen/generated/shared/c++/HybridPdfSdkSpec.cpp +21 -0
- package/nitrogen/generated/shared/c++/HybridPdfSdkSpec.hpp +66 -0
- package/nitrogen/generated/shared/c++/PdfErrorCode.hpp +88 -0
- package/nitrogen/generated/shared/c++/PdfErrorEvent.hpp +89 -0
- package/nitrogen/generated/shared/c++/PdfFit.hpp +84 -0
- package/nitrogen/generated/shared/c++/PdfLoadEvent.hpp +91 -0
- package/nitrogen/generated/shared/c++/PdfPageEvent.hpp +87 -0
- package/nitrogen/generated/shared/c++/PdfPageSize.hpp +87 -0
- package/nitrogen/generated/shared/c++/PdfRenderRequest.hpp +112 -0
- package/nitrogen/generated/shared/c++/PdfTapEvent.hpp +91 -0
- package/nitrogen/generated/shared/c++/PdfViewSource.hpp +97 -0
- package/nitrogen/generated/shared/c++/PdfZoomEvent.hpp +87 -0
- package/nitrogen/generated/shared/c++/views/HybridNativePdfViewComponent.cpp +226 -0
- package/nitrogen/generated/shared/c++/views/HybridNativePdfViewComponent.hpp +130 -0
- package/nitrogen/generated/shared/json/NativePdfViewConfig.json +23 -0
- package/package.json +80 -4
- package/react-native.config.js +10 -0
- package/src/PdfView.tsx +221 -0
- package/src/document.ts +34 -0
- package/src/index.ts +16 -0
- package/src/specs/PdfSdk.nitro.ts +60 -0
- package/src/specs/PdfView.nitro.ts +149 -0
package/src/PdfView.tsx
ADDED
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
import { forwardRef, useCallback, useImperativeHandle, useMemo, useRef } from 'react';
|
|
2
|
+
import {
|
|
3
|
+
Platform,
|
|
4
|
+
StyleSheet,
|
|
5
|
+
View,
|
|
6
|
+
processColor,
|
|
7
|
+
type ColorValue,
|
|
8
|
+
type StyleProp,
|
|
9
|
+
type ViewStyle,
|
|
10
|
+
} from 'react-native';
|
|
11
|
+
import { callback, getHostComponent } from 'react-native-nitro-modules';
|
|
12
|
+
|
|
13
|
+
import ViewConfig from '../nitrogen/generated/shared/json/NativePdfViewConfig.json';
|
|
14
|
+
import type {
|
|
15
|
+
NativePdfViewMethods,
|
|
16
|
+
NativePdfViewProps,
|
|
17
|
+
PdfErrorEvent,
|
|
18
|
+
PdfFit,
|
|
19
|
+
PdfLoadEvent,
|
|
20
|
+
PdfPageEvent,
|
|
21
|
+
PdfTapEvent,
|
|
22
|
+
PdfViewSource,
|
|
23
|
+
PdfZoomEvent,
|
|
24
|
+
} from './specs/PdfView.nitro';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* What the view is handed when the caller says nothing.
|
|
28
|
+
*
|
|
29
|
+
* Every property the native view takes is required, and this is where the gaps
|
|
30
|
+
* are filled. The reason is not style: nitro reads a property as empty only
|
|
31
|
+
* when JavaScript passes `undefined`, while React hands native a `null`
|
|
32
|
+
* whenever a property is taken away, and the bridge throws on that. Required
|
|
33
|
+
* properties cannot be taken away, so `maxZoom={maybeUndefined}` is safe.
|
|
34
|
+
*/
|
|
35
|
+
const DECIDE = 0;
|
|
36
|
+
|
|
37
|
+
/** The gap between pages in PDF points, about a fifth of an inch. */
|
|
38
|
+
const DEFAULT_PAGE_GAP = 14;
|
|
39
|
+
|
|
40
|
+
const NativePdfView = getHostComponent<
|
|
41
|
+
NativePdfViewProps,
|
|
42
|
+
NativePdfViewMethods
|
|
43
|
+
>('NativePdfView', () => ViewConfig);
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Whether this platform has the viewer, which both of the ones React Native
|
|
47
|
+
* ships for do: Android draws it with `PdfRenderer`, iOS with `CGPDFDocument`.
|
|
48
|
+
*
|
|
49
|
+
* Worth asking before reaching for it all the same, so that a platform without
|
|
50
|
+
* it falls back rather than showing an empty box.
|
|
51
|
+
*/
|
|
52
|
+
export function isPdfViewAvailable(): boolean {
|
|
53
|
+
return Platform.OS === 'android' || Platform.OS === 'ios';
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface PdfViewProps {
|
|
57
|
+
/** A url or a local path, or the same with headers and a password. */
|
|
58
|
+
source: string | PdfViewSource;
|
|
59
|
+
/** Which page to show, zero based. Changing it scrolls there. */
|
|
60
|
+
page?: number;
|
|
61
|
+
/** How the document is sized when it opens. Defaults to `auto`. */
|
|
62
|
+
fit?: PdfFit;
|
|
63
|
+
/** How far it may be zoomed, as multiples of the zoom it opened at. */
|
|
64
|
+
minZoom?: number;
|
|
65
|
+
maxZoom?: number;
|
|
66
|
+
/** Where a double tap zooms to, as a multiple of the opening zoom. */
|
|
67
|
+
doubleTapZoom?: number;
|
|
68
|
+
/** The gap between pages, in PDF points. Defaults to 14. */
|
|
69
|
+
pageGap?: number;
|
|
70
|
+
/** The ground behind and between the pages. */
|
|
71
|
+
backdropColor?: ColorValue;
|
|
72
|
+
/** iOS only, since Android draws none. Defaults to true. */
|
|
73
|
+
scrollIndicators?: boolean;
|
|
74
|
+
style?: StyleProp<ViewStyle>;
|
|
75
|
+
|
|
76
|
+
onLoad?: (event: PdfLoadEvent) => void;
|
|
77
|
+
onPageChange?: (event: PdfPageEvent) => void;
|
|
78
|
+
onZoom?: (event: PdfZoomEvent) => void;
|
|
79
|
+
onError?: (event: PdfErrorEvent) => void;
|
|
80
|
+
/** A tap that was not part of a double tap. */
|
|
81
|
+
onTap?: (event: PdfTapEvent) => void;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export interface PdfViewHandle {
|
|
85
|
+
/** Zero based. */
|
|
86
|
+
goToPage: (page: number, animated?: boolean) => void;
|
|
87
|
+
/** A multiple of the zoom the document opened at. */
|
|
88
|
+
setZoom: (zoom: number, animated?: boolean) => void;
|
|
89
|
+
/**
|
|
90
|
+
* The share of the view drawn for the zoom it is shown at, between zero and
|
|
91
|
+
* one. For measuring the viewer rather than for building on.
|
|
92
|
+
*/
|
|
93
|
+
coverage: () => number;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* A PDF, drawn by the platform, in tiles.
|
|
98
|
+
*
|
|
99
|
+
* Everything that happens while a finger is on the screen happens in the native
|
|
100
|
+
* view: the zoom, the movement, the tile grid and the drawing are read from the
|
|
101
|
+
* same numbers in the same pass. JavaScript says which document and which page,
|
|
102
|
+
* and hears back what was found in it.
|
|
103
|
+
*
|
|
104
|
+
* ```tsx
|
|
105
|
+
* <PdfView
|
|
106
|
+
* source={{ uri: 'https://example.com/plan.pdf' }}
|
|
107
|
+
* onPageChange={({ page, pageCount }) => setLabel(`${page + 1} / ${pageCount}`)}
|
|
108
|
+
* style={StyleSheet.absoluteFill}
|
|
109
|
+
* />
|
|
110
|
+
* ```
|
|
111
|
+
*/
|
|
112
|
+
export const PdfView = forwardRef<PdfViewHandle, PdfViewProps>(
|
|
113
|
+
function PdfView(
|
|
114
|
+
{
|
|
115
|
+
source,
|
|
116
|
+
page = 0,
|
|
117
|
+
fit,
|
|
118
|
+
minZoom,
|
|
119
|
+
maxZoom,
|
|
120
|
+
doubleTapZoom,
|
|
121
|
+
pageGap,
|
|
122
|
+
backdropColor,
|
|
123
|
+
scrollIndicators,
|
|
124
|
+
style,
|
|
125
|
+
onLoad,
|
|
126
|
+
onPageChange,
|
|
127
|
+
onZoom,
|
|
128
|
+
onError,
|
|
129
|
+
onTap,
|
|
130
|
+
},
|
|
131
|
+
ref,
|
|
132
|
+
) {
|
|
133
|
+
const native = useRef<NativePdfViewMethods | null>(null);
|
|
134
|
+
|
|
135
|
+
/** Native hands the view over once; it is the same object from then on. */
|
|
136
|
+
const handleRef = useCallback((view: NativePdfViewMethods) => {
|
|
137
|
+
native.current = view;
|
|
138
|
+
}, []);
|
|
139
|
+
|
|
140
|
+
const plain = typeof source === 'string';
|
|
141
|
+
const uri = plain ? source : source.uri;
|
|
142
|
+
const password = plain ? undefined : source.password;
|
|
143
|
+
const cache = plain ? undefined : source.cache;
|
|
144
|
+
const headers = plain ? undefined : source.headers;
|
|
145
|
+
const headerNames = JSON.stringify(headers ?? null);
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Held steady across renders on purpose: the native view opens the document
|
|
149
|
+
* again whenever this changes, and an object literal in the caller's render
|
|
150
|
+
* body is a different object every time. The headers are compared by what
|
|
151
|
+
* is in them for the same reason.
|
|
152
|
+
*/
|
|
153
|
+
const resolved = useMemo<PdfViewSource>(
|
|
154
|
+
() => ({ uri, headers, password, cache }),
|
|
155
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
156
|
+
[uri, password, cache, headerNames],
|
|
157
|
+
);
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* Transparent when nothing was asked for, which is what the view drew
|
|
161
|
+
* before this property existed.
|
|
162
|
+
*/
|
|
163
|
+
const backdrop = useMemo(() => {
|
|
164
|
+
if (backdropColor == null) return 0;
|
|
165
|
+
const processed = processColor(backdropColor);
|
|
166
|
+
return typeof processed === 'number' ? processed : 0;
|
|
167
|
+
}, [backdropColor]);
|
|
168
|
+
|
|
169
|
+
useImperativeHandle(
|
|
170
|
+
ref,
|
|
171
|
+
() => ({
|
|
172
|
+
goToPage: (to: number, animated = true) => native.current?.goToPage(to, animated),
|
|
173
|
+
setZoom: (zoom: number, animated = true) => native.current?.setZoom(zoom, animated),
|
|
174
|
+
coverage: () => native.current?.coverage() ?? 0,
|
|
175
|
+
}),
|
|
176
|
+
[],
|
|
177
|
+
);
|
|
178
|
+
|
|
179
|
+
const handleLoad = useCallback((event: PdfLoadEvent) => onLoad?.(event), [onLoad]);
|
|
180
|
+
const handlePageChange = useCallback(
|
|
181
|
+
(event: PdfPageEvent) => onPageChange?.(event),
|
|
182
|
+
[onPageChange],
|
|
183
|
+
);
|
|
184
|
+
const handleZoom = useCallback((event: PdfZoomEvent) => onZoom?.(event), [onZoom]);
|
|
185
|
+
const handleError = useCallback((event: PdfErrorEvent) => onError?.(event), [onError]);
|
|
186
|
+
const handleTap = useCallback((event: PdfTapEvent) => onTap?.(event), [onTap]);
|
|
187
|
+
|
|
188
|
+
const flattened = useMemo(() => StyleSheet.flatten([styles.fill, style]), [style]);
|
|
189
|
+
|
|
190
|
+
if (!isPdfViewAvailable()) {
|
|
191
|
+
return <View style={flattened} />;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
return (
|
|
195
|
+
<NativePdfView
|
|
196
|
+
hybridRef={callback(handleRef)}
|
|
197
|
+
source={resolved}
|
|
198
|
+
page={page}
|
|
199
|
+
fit={fit ?? 'auto'}
|
|
200
|
+
minZoom={minZoom ?? DECIDE}
|
|
201
|
+
maxZoom={maxZoom ?? DECIDE}
|
|
202
|
+
doubleTapZoom={doubleTapZoom ?? DECIDE}
|
|
203
|
+
pageGap={pageGap ?? DEFAULT_PAGE_GAP}
|
|
204
|
+
backdropColor={backdrop}
|
|
205
|
+
scrollIndicators={scrollIndicators ?? true}
|
|
206
|
+
onLoad={callback(handleLoad)}
|
|
207
|
+
onPageChange={callback(handlePageChange)}
|
|
208
|
+
onZoom={callback(handleZoom)}
|
|
209
|
+
onError={callback(handleError)}
|
|
210
|
+
onTap={callback(handleTap)}
|
|
211
|
+
style={flattened}
|
|
212
|
+
/>
|
|
213
|
+
);
|
|
214
|
+
},
|
|
215
|
+
);
|
|
216
|
+
|
|
217
|
+
const styles = StyleSheet.create({
|
|
218
|
+
fill: {
|
|
219
|
+
flex: 1,
|
|
220
|
+
},
|
|
221
|
+
});
|
package/src/document.ts
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { NitroModules } from 'react-native-nitro-modules';
|
|
2
|
+
import type { PdfSdk, PdfDocument } from './specs/PdfSdk.nitro';
|
|
3
|
+
|
|
4
|
+
let canvas: PdfSdk | null = null;
|
|
5
|
+
|
|
6
|
+
function getCanvas(): PdfSdk {
|
|
7
|
+
if (canvas == null) {
|
|
8
|
+
canvas = NitroModules.createHybridObject<PdfSdk>('PdfSdk');
|
|
9
|
+
}
|
|
10
|
+
return canvas;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Opens a document to take pictures of pages: a thumbnail beside a filename, a
|
|
15
|
+
* preview in a list, a page to share.
|
|
16
|
+
*
|
|
17
|
+
* The viewer is `PdfView`, which draws its own pages and needs none of
|
|
18
|
+
* this. Takes a local path or a `file://` url, and throws for a file that is
|
|
19
|
+
* missing, malformed, or encrypted without the right password.
|
|
20
|
+
*
|
|
21
|
+
* ```ts
|
|
22
|
+
* const document = openPdfDocument(path);
|
|
23
|
+
* const size = document.getPageSize(0);
|
|
24
|
+
* const png = await document.renderToFile({
|
|
25
|
+
* page: 0,
|
|
26
|
+
* outWidth: 200,
|
|
27
|
+
* outHeight: Math.round((200 * size.height) / size.width),
|
|
28
|
+
* });
|
|
29
|
+
* document.close();
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export function openPdfDocument(path: string, password?: string): PdfDocument {
|
|
33
|
+
return getCanvas().open(path, password);
|
|
34
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export { PdfView, isPdfViewAvailable } from './PdfView';
|
|
2
|
+
export type { PdfViewProps, PdfViewHandle } from './PdfView';
|
|
3
|
+
|
|
4
|
+
export { openPdfDocument } from './document';
|
|
5
|
+
export type { PdfSdk, PdfDocument, PdfPageSize, PdfRenderRequest } from './specs/PdfSdk.nitro';
|
|
6
|
+
|
|
7
|
+
export type {
|
|
8
|
+
PdfErrorCode,
|
|
9
|
+
PdfErrorEvent,
|
|
10
|
+
PdfFit,
|
|
11
|
+
PdfLoadEvent,
|
|
12
|
+
PdfPageEvent,
|
|
13
|
+
PdfTapEvent,
|
|
14
|
+
PdfViewSource,
|
|
15
|
+
PdfZoomEvent,
|
|
16
|
+
} from './specs/PdfView.nitro';
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import type { HybridObject } from 'react-native-nitro-modules';
|
|
2
|
+
|
|
3
|
+
/** A page's size in PDF points, a point being a 72nd of an inch. */
|
|
4
|
+
export interface PdfPageSize {
|
|
5
|
+
width: number;
|
|
6
|
+
height: number;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* One drawing job: which part of which page to draw, and how large the
|
|
11
|
+
* resulting image should be.
|
|
12
|
+
*
|
|
13
|
+
* The region is given in the page's own points with the origin at its top left
|
|
14
|
+
* corner, and the output size in pixels. Nothing outside the region is drawn,
|
|
15
|
+
* so the cost of a job follows the size of the image asked for, not the size of
|
|
16
|
+
* the page.
|
|
17
|
+
*/
|
|
18
|
+
export interface PdfRenderRequest {
|
|
19
|
+
/** Zero based. */
|
|
20
|
+
page: number;
|
|
21
|
+
/** The region of the page. The whole page when left out. */
|
|
22
|
+
x?: number;
|
|
23
|
+
y?: number;
|
|
24
|
+
width?: number;
|
|
25
|
+
height?: number;
|
|
26
|
+
/** The image's size in pixels. */
|
|
27
|
+
outWidth: number;
|
|
28
|
+
outHeight: number;
|
|
29
|
+
/** Where to write the PNG. A file in the cache directory when left out. */
|
|
30
|
+
path?: string;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* An open PDF file, for taking pictures of pages: a thumbnail beside a filename,
|
|
35
|
+
* a preview in a list, a page to share.
|
|
36
|
+
*
|
|
37
|
+
* The file stays open until `close` is called, so a document that has left the
|
|
38
|
+
* screen should be closed.
|
|
39
|
+
*/
|
|
40
|
+
export interface PdfDocument extends HybridObject<{ android: 'kotlin'; ios: 'swift' }> {
|
|
41
|
+
readonly pageCount: number;
|
|
42
|
+
|
|
43
|
+
getPageSize(page: number): PdfPageSize;
|
|
44
|
+
|
|
45
|
+
/** Draws the request into a PNG file and answers where it was written. */
|
|
46
|
+
renderToFile(request: PdfRenderRequest): Promise<string>;
|
|
47
|
+
|
|
48
|
+
close(): void;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export interface PdfSdk extends HybridObject<{ android: 'kotlin'; ios: 'swift' }> {
|
|
52
|
+
/**
|
|
53
|
+
* Opens a PDF from a local file path or a `file://` url.
|
|
54
|
+
*
|
|
55
|
+
* Throws when the file is missing or malformed. A document that needs a
|
|
56
|
+
* password to open needs one here: Android can only take it from API 35, and
|
|
57
|
+
* throws for encrypted documents before that.
|
|
58
|
+
*/
|
|
59
|
+
open(path: string, password?: string): PdfDocument;
|
|
60
|
+
}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
HybridView,
|
|
3
|
+
HybridViewMethods,
|
|
4
|
+
HybridViewProps,
|
|
5
|
+
} from 'react-native-nitro-modules';
|
|
6
|
+
|
|
7
|
+
/** Where a document comes from. */
|
|
8
|
+
export interface PdfViewSource {
|
|
9
|
+
/**
|
|
10
|
+
* A local file path, a `file://` url, an `http(s)` url the view fetches and
|
|
11
|
+
* keeps, or on Android a `content://` url.
|
|
12
|
+
*/
|
|
13
|
+
uri: string;
|
|
14
|
+
/** Sent with the request when the document is fetched over http. */
|
|
15
|
+
headers?: Record<string, string>;
|
|
16
|
+
/** For a document that needs one to open. */
|
|
17
|
+
password?: string;
|
|
18
|
+
/** Keep a fetched document on disk for next time. Defaults to true. */
|
|
19
|
+
cache?: boolean;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* How a document is sized when it opens, which is also what a zoom of 1 means.
|
|
24
|
+
*
|
|
25
|
+
* `auto` fits the width, unless the first page is a strip rather than a page,
|
|
26
|
+
* in which case it fills the height instead: a building's formwork plan is one
|
|
27
|
+
* sheet thirteen metres wide, and fitted to the width that is a line across the
|
|
28
|
+
* middle of the screen.
|
|
29
|
+
*/
|
|
30
|
+
export type PdfFit = 'auto' | 'width' | 'height' | 'page';
|
|
31
|
+
|
|
32
|
+
export type PdfErrorCode =
|
|
33
|
+
/** There is nothing at that path or url. */
|
|
34
|
+
| 'notFound'
|
|
35
|
+
/** The document is encrypted and the password was wrong or missing. */
|
|
36
|
+
| 'password'
|
|
37
|
+
/** The file is not a PDF, or is one this platform will not open. */
|
|
38
|
+
| 'unsupported'
|
|
39
|
+
/** The document could not be fetched. */
|
|
40
|
+
| 'network'
|
|
41
|
+
| 'unknown';
|
|
42
|
+
|
|
43
|
+
export interface PdfLoadEvent {
|
|
44
|
+
pageCount: number;
|
|
45
|
+
/** The first page's size in PDF points, a point being a 72nd of an inch. */
|
|
46
|
+
width: number;
|
|
47
|
+
height: number;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface PdfPageEvent {
|
|
51
|
+
/** Zero based. */
|
|
52
|
+
page: number;
|
|
53
|
+
pageCount: number;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface PdfZoomEvent {
|
|
57
|
+
/** A multiple of the zoom the document opened at. */
|
|
58
|
+
zoom: number;
|
|
59
|
+
/** Screen points to the PDF point, which is what the zoom works out to. */
|
|
60
|
+
scale: number;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export interface PdfErrorEvent {
|
|
64
|
+
code: PdfErrorCode;
|
|
65
|
+
message: string;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface PdfTapEvent {
|
|
69
|
+
/** Where the tap landed in the view, in screen points. */
|
|
70
|
+
x: number;
|
|
71
|
+
y: number;
|
|
72
|
+
/** The page under it, zero based. */
|
|
73
|
+
page: number;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* What the view is told, with nothing left out.
|
|
78
|
+
*
|
|
79
|
+
* Every property here is required, and the wrapper in `PdfView.tsx` fills in
|
|
80
|
+
* whatever the caller left off. That is not how a nitro spec would normally be
|
|
81
|
+
* written, and the reason is worth knowing: nitro reads an optional property as
|
|
82
|
+
* empty only when JavaScript passes `undefined`
|
|
83
|
+
* (`JSIConverter+Optional.hpp`), while React hands native a `null` whenever a
|
|
84
|
+
* property is taken away. So `maxZoom={maybeUndefined}` would throw inside the
|
|
85
|
+
* bridge rather than mean what it says. Required properties with a value that
|
|
86
|
+
* stands for "left to the viewer" cannot be taken away, so they cannot throw.
|
|
87
|
+
*/
|
|
88
|
+
export interface NativePdfViewProps extends HybridViewProps {
|
|
89
|
+
source: PdfViewSource;
|
|
90
|
+
/** Which page the document opens at, and scrolls to when it changes. Zero based. */
|
|
91
|
+
page: number;
|
|
92
|
+
fit: PdfFit;
|
|
93
|
+
/**
|
|
94
|
+
* How far the document may be zoomed, as multiples of the zoom it opened at.
|
|
95
|
+
* Zero means the viewer decides: out until the widest page fits the screen,
|
|
96
|
+
* and in until a PDF point is about thirteen screen points, which on a
|
|
97
|
+
* drawing at 1:50 is where a dimension written along a beam becomes
|
|
98
|
+
* comfortable to read.
|
|
99
|
+
*/
|
|
100
|
+
minZoom: number;
|
|
101
|
+
maxZoom: number;
|
|
102
|
+
/** Where a double tap zooms to, as a multiple of the opening zoom. Zero to decide. */
|
|
103
|
+
doubleTapZoom: number;
|
|
104
|
+
/** The gap between pages in PDF points. */
|
|
105
|
+
pageGap: number;
|
|
106
|
+
/** The ground behind and between the pages, as a processed colour. */
|
|
107
|
+
backdropColor: number;
|
|
108
|
+
/** iOS only, since Android draws none. */
|
|
109
|
+
scrollIndicators: boolean;
|
|
110
|
+
|
|
111
|
+
onLoad?: (event: PdfLoadEvent) => void;
|
|
112
|
+
/**
|
|
113
|
+
* The page the reader is on: the one under the middle of the view. Sent when
|
|
114
|
+
* it changes, not on every scrolled pixel.
|
|
115
|
+
*/
|
|
116
|
+
onPageChange?: (event: PdfPageEvent) => void;
|
|
117
|
+
/**
|
|
118
|
+
* Sent a few times a second while the zoom is moving, and once more when it
|
|
119
|
+
* stops. A pinch changes the zoom on every frame, and a listener that renders
|
|
120
|
+
* on every frame would keep JavaScript busy for the whole gesture.
|
|
121
|
+
*/
|
|
122
|
+
onZoom?: (event: PdfZoomEvent) => void;
|
|
123
|
+
onError?: (event: PdfErrorEvent) => void;
|
|
124
|
+
/** A tap that was not part of a double tap. */
|
|
125
|
+
onTap?: (event: PdfTapEvent) => void;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export interface NativePdfViewMethods extends HybridViewMethods {
|
|
129
|
+
goToPage(page: number, animated: boolean): void;
|
|
130
|
+
/** Zooms about the middle of the view. `zoom` is a multiple of the opening zoom. */
|
|
131
|
+
setZoom(zoom: number, animated: boolean): void;
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* The share of the view that has been drawn for the zoom it is shown at,
|
|
135
|
+
* between zero and one. What is left is covered by something coarser. Meant
|
|
136
|
+
* for measuring the viewer rather than for building on.
|
|
137
|
+
*/
|
|
138
|
+
coverage(): number;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* The same viewer on both platforms: the arithmetic that decides what is drawn
|
|
143
|
+
* is written twice, once in Kotlin and once in Swift, from the same numbers.
|
|
144
|
+
*/
|
|
145
|
+
export type NativePdfView = HybridView<
|
|
146
|
+
NativePdfViewProps,
|
|
147
|
+
NativePdfViewMethods,
|
|
148
|
+
{ android: 'kotlin'; ios: 'swift' }
|
|
149
|
+
>;
|