Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
pspdfkit-cordova
Advanced tools
pspdfkit-cordova - npm Package Compare versions
Comparing version 1.0.13 to 1.0.14
@@ -9,6 +9,6 @@ # Cordova Plugin for PSPDFKit 9 for iOS | ||
| - Xcode 11.3.1 or later | ||
| - PSPDFKit 9.2.0 for iOS or later | ||
| - Xcode 11.5 or later | ||
| - PSPDFKit 9.4.0 for iOS or later | ||
| - Cordova >= 9.0.0 | ||
| - CocoaPods >= 1.8.1 | ||
| - CocoaPods >= 1.9.3 | ||
@@ -20,14 +20,12 @@ ## Installation | ||
| 1. Run `cordova plugin add https://github.com/PSPDFKit/PSPDFKit-Cordova.git` to install the `pspdfkit-cordova` plugin. | ||
| 2. Update your `Podfile`: `cd platforms/ios` and open your `Podfile` in a text editor. Make sure the platform is set to iOS 11 or later, and replace `YOUR_COCOAPODS_KEY_GOES_HERE` with your own CocoaPods Key. Your `Podfile` should look like this: | ||
| 2. Update your `Podfile`: `cd platforms/ios` and open your `Podfile` in a text editor. Make sure the platform is set to iOS 12 or later. Your `Podfile` should look like this: | ||
| ```diff | ||
| source 'https://github.com/CocoaPods/Specs.git' | ||
| - platform :ios, '9.0' | ||
| + platform :ios, '11.0' | ||
| - platform :ios, '10.0' | ||
| + platform :ios, '12.0' | ||
| use_frameworks! | ||
| target 'CordovaDemo' do | ||
| project 'CordovaDemo.xcodeproj' | ||
| - pod 'PSPDFKit', podspec: 'https://customers.pspdfkit.com/cocoapods/YOUR_COCOAPODS_KEY_GOES_HERE/pspdfkit/latest.podspec' | ||
| + pod 'PSPDFKit', podspec: 'https://customers.pspdfkit.com/cocoapods/USE_YOUR_OWN_COCOAPODS_KEY/pspdfkit/latest.podspec' | ||
| pod 'PSPDFKit', podspec: 'https://customers.pspdfkit.com/pspdfkit-ios/latest.podspec' | ||
| end | ||
@@ -40,6 +38,4 @@ ``` | ||
| **Important** If you’re an existing customer, you can find the CocoaPods and license keys in your [customer portal](https://customers.pspdfkit.com/). Otherwise, if you don’t already have PSPDFKit, [sign up for our 60-day trial](https://pspdfkit.com/try/) and you will receive an email with the instructions to get started. | ||
| 4. Install the Pods: run `pod install`. | ||
| 3. Install the Pods: run `pod install`. | ||
| ## Usage | ||
@@ -86,27 +82,14 @@ | ||
| this.receivedEvent('deviceready'); | ||
| // Set your license key here. | ||
| PSPDFKit.setLicenseKey("YOUR KEY"); | ||
| // Set your license key here. | ||
| PSPDFKit.setLicenseKey("YOUR KEY"); | ||
| // Show pdf with in single page mode. | ||
| PSPDFKit.present('pdf/document.pdf', { | ||
| pageMode: 'single', | ||
| }); | ||
| }, | ||
| // Update DOM on a Received Event | ||
| receivedEvent: function(id) { | ||
| var parentElement = document.getElementById(id); | ||
| var listeningElement = parentElement.querySelector('.listening'); | ||
| var receivedElement = parentElement.querySelector('.received'); | ||
| listeningElement.setAttribute('style', 'display:none;'); | ||
| receivedElement.setAttribute('style', 'display:block;'); | ||
| console.log('Received Event: ' + id); | ||
| } | ||
| }; | ||
| // Show pdf with in single page mode. | ||
| PSPDFKit.present('pdf/document.pdf', { | ||
| pageMode: 'single', | ||
| }); | ||
| }, | ||
| ``` | ||
| 4. `cd` into `Cordova-Demo` and run `cordova plugin add https://github.com/PSPDFKit/PSPDFKit-Cordova.git` to install the `pspdfkit-cordova` plugin. | ||
| 5. Open `config.xml` and change the deployment target to iOS 11 or later: | ||
| 5. Open `config.xml` and change the deployment target to iOS 12 or later: | ||
@@ -117,13 +100,12 @@ ```diff | ||
| <allow-intent href="itms-apps:*" /> | ||
| + <preference name="deployment-target" value="11.0" /> | ||
| + <preference name="deployment-target" value="12.0" /> | ||
| </platform> | ||
| ``` | ||
| 6. Use your CocoaPods Key: `open plugins/pspdfkit-cordova/plugin.xml` and replace `YOUR_COCOAPODS_KEY_GOES_HERE` with your own key. If you’re an existing customer, you can find the CocoaPods and license keys in your [customer portal](https://customers.pspdfkit.com/). Otherwise, if you don’t already have PSPDFKit, [sign up for our 60-day trial](https://pspdfkit.com/try/) and you will receive an email with the instructions to get started. | ||
| 7. Run `cordova platform add ios` to add the iOS platform. | ||
| 8. If your application is targeting iOS versions **prior to iOS 12.2** and your application **does not already contain any Swift code**, then you need to make sure Xcode bundles Swift standard libraries with your application distribution. To to so, open your target Build Settings and enable `Always Embed Swift Standard Libraries`: | ||
| 6. Run `cordova platform add ios` to add the iOS platform. | ||
| 7. If your application is targeting iOS versions **prior to iOS 12.2** and your application **does not already contain any Swift code**, then you need to make sure Xcode bundles Swift standard libraries with your application distribution. To to so, open your target Build Settings and enable `Always Embed Swift Standard Libraries`: | ||
|  | ||
| 9. Run the app: Open `platforms/ios/CordovaDemo.xcworkspace` in Xcode, then build and run, or run `cordova emulate ios` in the Terminal. | ||
| 8. Run the app: Open `platforms/ios/CordovaDemo.xcworkspace` in Xcode, then build and run, or run `cordova emulate ios` in the Terminal. | ||
@@ -136,4 +118,3 @@ #### New Ionic Project | ||
| 2. `cd` into `IonicDemo` and run `ionic cordova plugin add https://github.com/PSPDFKit/PSPDFKit-Cordova.git` to install the `pspdfkit-cordova` plugin. | ||
| 3. Add a sample PDF into your `www` directory: `www/pdf/document.pdf`. | ||
| 4. Open `config.xml` and change the deployment target to iOS 11 or later: | ||
| 3. Open `config.xml` and change the deployment target to iOS 12 or later: | ||
@@ -145,32 +126,29 @@ ```diff | ||
| + <allow-navigation href="*" /> | ||
| + <preference name="deployment-target" value="11.0" /> | ||
| + <preference name="deployment-target" value="12.0" /> | ||
| </platform> | ||
| ``` | ||
| 5. Use your CocoaPods Key: `open plugins/pspdfkit-cordova/plugin.xml` and replace `YOUR_COCOAPODS_KEY_GOES_HERE` with your own key. If you’re an existing customer, you can find the CocoaPods and license keys in your [customer portal](https://customers.pspdfkit.com/). Otherwise, if you don’t already have PSPDFKit, [sign up for our 60-day trial](https://pspdfkit.com/try/) and you will receive an email with the instructions to get started. | ||
| 4. Declare `PSPDFKit` in `src/declarations.d.ts` (create this file first): `declare var PSPDFKit: any;` | ||
| 5. Modifying `src/app/app.component.ts` to use the PSPDFKit plugin to Present a PDF: | ||
| 6. Declare `PSPDFKit` in `src/declarations.d.ts` (create this file first): `declare var PSPDFKit: any;` | ||
| 7. Modifying `src/app/app.component.ts` to use the PSPDFKit plugin to Present a PDF: | ||
| ```javascript | ||
| constructor(platform: Platform, statusBar: StatusBar, splashScreen: SplashScreen) { | ||
| platform.ready().then(() => { | ||
| // Okay, so the platform is ready and our plugins are available. | ||
| // Here you can do any higher level native things you might need. | ||
| statusBar.styleDefault(); | ||
| splashScreen.hide(); | ||
| PSPDFKit.setLicenseKey('YOUR KEY'); | ||
| PSPDFKit.present('pdf/document.pdf', {}); | ||
| }); | ||
| initializeApp() { | ||
| this.platform.ready().then(() => { | ||
| this.statusBar.styleDefault(); | ||
| this.splashScreen.hide(); | ||
| PSPDFKit.setLicenseKey('YOUR KEY'); | ||
| PSPDFKit.present('pdf/document.pdf', {}); | ||
| }); | ||
| } | ||
| ``` | ||
| 8. Run `ionic cordova platform add ios` to add the iOS platform. | ||
| 9. Run `ionic cordova prepare ios` to prepare iOS platform. | ||
| 10. If your application is targeting iOS versions **prior to iOS 12.2** and your application **does not already contain any Swift code**, then you need to make sure Xcode bundles Swift standard libraries with your application distribution. To to so, open your target Build Settings and enable `Always Embed Swift Standard Libraries`: | ||
| 6. Run `ionic cordova platform add ios` to add the iOS platform. | ||
| 7. Run `ionic cordova prepare ios` to prepare iOS platform. | ||
| 8. If your application is targeting iOS versions **prior to iOS 12.2** and your application **does not already contain any Swift code**, then you need to make sure Xcode bundles Swift standard libraries with your application distribution. To to so, open your target Build Settings and enable `Always Embed Swift Standard Libraries`: | ||
|  | ||
| 11. Run the app: Open `platforms/ios/MyApp.xcworkspace` in Xcode, then build and run, or run `ionic cordova emulate ios` in the Terminal. | ||
| 9. Add a sample PDF into your `platforms/ios/www` directory: `platforms/ios/www/pdf/document.pdf`. | ||
| 10. Run the app: Open `platforms/ios/MyApp.xcworkspace` in Xcode, then build and run, or run `ionic cordova emulate ios` in the Terminal. | ||
@@ -183,30 +161,5 @@ ## API | ||
| ### Problem: | ||
| ```sh | ||
| Using cordova-fetch for cordova-ios@^5.0.0 | ||
| Adding ios project... | ||
| Creating Cordova project for the iOS platform: | ||
| Path: platforms/ios | ||
| Package: com.pspdfkit.demo | ||
| Name: CordovaDemo | ||
| iOS project created with cordova-ios@5.0.1 | ||
| Installing "pspdfkit-cordova" for ios | ||
| Running command: pod install --verbose | ||
| Failed to install 'pspdfkit-cordova': Error: pod: Command failed with exit code 1 | ||
| at ChildProcess.whenDone (/Users/radazzouz/Downloads/Cordova-Demo/node_modules/cordova-common/src/superspawn.js:135:23) | ||
| at ChildProcess.emit (events.js:198:13) | ||
| at maybeClose (internal/child_process.js:982:16) | ||
| at Process.ChildProcess._handle.onexit (internal/child_process.js:259:5) | ||
| pod: Command failed with exit code 1 | ||
| ``` | ||
| ### Solution: | ||
| Use your CocoaPods Key: `open plugins/pspdfkit-cordova/plugin.xml` and replace `YOUR_COCOAPODS_KEY_GOES_HERE` with your own key. If you’re an existing customer, you can find the CocoaPods and license keys in your [customer portal](https://customers.pspdfkit.com/). Otherwise, if you don’t already have PSPDFKit, [sign up for our 60-day trial](https://pspdfkit.com/try/) and you will receive an email with the instructions to get started. | ||
| ### Problem: | ||
| ```sh | ||
| Error: Cannot find plugin.xml for plugin "PSPDFKit-Cordova". Please try adding it again. | ||
@@ -213,0 +166,0 @@ ``` |
| { | ||
| "name": "pspdfkit-cordova", | ||
| "version": "1.0.13", | ||
| "version": "1.0.14", | ||
| "description": "PSPDFKit Cordova Plugin for Android and iOS", | ||
@@ -5,0 +5,0 @@ "cordova": { |
| # PSPDFKit-Cordova | ||
| The official plugin to use PSPDFKit with Apache Cordova/PhoneGap/Ionic | ||
| The official plugin to use PSPDFKit with Apache Cordova/PhoneGap/Ionic. | ||
| ## Support, Issues and License Questions | ||
| PSPDFKit offers support for customers with an active SDK license via https://pspdfkit.com/support/request/ | ||
| Are you [evaluating our SDK](https://pspdfkit.com/try/)? That's great, we're happy to help out! To make sure this is fast, please use a work email and have someone from your company fill out our sales form: https://pspdfkit.com/sales/ | ||
| ## Installation and Integration Steps | ||
@@ -6,0 +12,0 @@ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by8.33%
78
Worsened metrics
- Total package byte prevSize
- decreased by-0.21%
1362408
No dependency changes