You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-19Lines changed: 25 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@ This wrapper requires a valid license of PSPDFKit. Licenses are per platform. Yo
6
6
7
7
This wrapper exposes the most often used APIs from PSPDFKit. Many of our partners end up forking this wrapper and adding some custom code to achieve even greater integration with their products, using native code.
8
8
9
+
Windows is not currently supported, please use the previous version [1.24.9](https://github.com/PSPDFKit/react-native/releases/tag/1.24.9) instead.
10
+
9
11
#### Announcements
10
12
11
13
-[Announcement blog post](https://pspdfkit.com/blog/2016/react-native-module/)
@@ -305,10 +307,9 @@ For a more detailed description of toolbar customizations, refer to our Customiz
305
307
- Android SDK
306
308
- Android Build Tools 23.0.1 (React Native)
307
309
- Android Build Tools 28.0.3 (PSPDFKit module)
308
-
- Android Gradle plugin >= 3.2.1
309
-
- PSPDFKit >= 5.0.1
310
-
- react-native for example app >= 0.59.2
311
-
- react-native for Catalog app >= 0.57.8
310
+
- Android Gradle plugin >= 3.4.1
311
+
- PSPDFKit >= 5.4.2
312
+
- react-native >= 0.60.4
312
313
313
314
#### Getting Started
314
315
@@ -319,15 +320,12 @@ Let's create a simple app that integrates PSPDFKit and uses the react-native-psp
319
320
3. Step into your newly created app folder: `cd YourApp`.
320
321
4. Add `react-native-pspdfkit` module from GitHub: `yarn add github:PSPDFKit/react-native`.
321
322
5. Install all the dependencies for the project: `yarn install`. (Because of a [bug](https://github.com/yarnpkg/yarn/issues/2165) you may need to clean `yarn`'s cache with `yarn cache clean` before.)
322
-
6. Link module `react-native-pspdfkit`: `react-native link react-native-pspdfkit`.
323
-
7. <aid="step-7"></a>Add PSPDFKit repository to `YourApp/android/build.gradle` so PSPDFKit library can be downloaded:
323
+
6. <aid="step-7"></a>Add PSPDFKit repository to `YourApp/android/build.gradle` so PSPDFKit library can be downloaded:
324
324
325
325
```diff
326
326
allprojects {
327
327
repositories {
328
328
mavenLocal()
329
-
google()
330
-
jcenter()
331
329
+ maven {
332
330
+ url 'https://customers.pspdfkit.com/maven/'
333
331
+ credentials {
@@ -339,11 +337,18 @@ Let's create a simple app that integrates PSPDFKit and uses the react-native-psp
339
337
// All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
8. PSPDFKit targets modern platforms, so you'll have to set the `minSdkVersion` to 19. In `YourApp/android/build.gradle`:
351
+
7. PSPDFKit targets modern platforms, so you'll have to set the `minSdkVersion` to 19. In `YourApp/android/build.gradle`:
347
352
348
353
```diff
349
354
...
@@ -358,7 +363,7 @@ Let's create a simple app that integrates PSPDFKit and uses the react-native-psp
358
363
...
359
364
```
360
365
361
-
9. We will also need to enable MultiDex support. In `YourApp/android/app/build.gradle`:
366
+
8. We will also need to enable MultiDex support. In `YourApp/android/app/build.gradle`:
362
367
363
368
```diff
364
369
...
@@ -373,7 +378,7 @@ Let's create a simple app that integrates PSPDFKit and uses the react-native-psp
373
378
...
374
379
```
375
380
376
-
10. <aid="step-10"></a>Enter your PSPDFKit license key into `YourApp/android/app/src/main/AndroidManifest.xml` file:
381
+
9. <aid="step-10"></a>Enter your PSPDFKit license key into `YourApp/android/app/src/main/AndroidManifest.xml` file:
377
382
378
383
```diff
379
384
<application>
@@ -386,7 +391,7 @@ Let's create a simple app that integrates PSPDFKit and uses the react-native-psp
386
391
</application>
387
392
```
388
393
389
-
11. Set primary color. In `YourApp/android/app/src/main/res/values/styles.xml` replace
394
+
10. Set primary color. In `YourApp/android/app/src/main/res/values/styles.xml` replace
390
395
391
396
```xml
392
397
<!-- Customize your theme here. -->
@@ -398,16 +403,15 @@ with
398
403
<itemname="colorPrimary">#3C97C9</item>
399
404
```
400
405
401
-
12. <aid="step-12"></a>Replace the default component from `YourApp/App.js` with a simple touch area to present a PDF document from the local device filesystem:
406
+
11. <aid="step-12"></a>Replace the default component from `YourApp/App.js` with a simple touch area to present a PDF document from the local device filesystem:
14. Your app is now ready to launch. From `YourApp` directory run `react-native run-android`.
483
+
13. Your app is now ready to launch. From `YourApp` directory run `react-native run-android`.
480
484
481
485
```bash
482
486
react-native run-android
@@ -650,6 +654,8 @@ Shows the pdf `document` from the local device filesystem, or your app's assets.
650
654
651
655
### Windows UWP
652
656
657
+
Windows UWP is not currently supported, the following integration steps are for wrapper version [1.24.9](https://github.com/PSPDFKit/react-native/releases/tag/1.24.9).
0 commit comments