Get started integrating Apryse Flutter SDK

Welcome to Apryse. This guide will help you integrate a free trial of the Apryse Flutter SDK into your Flutter Project. Your free trial includes unlimited trial usage and support from solution engineers.

iOS & Flutter PDF library integration

See here for the get started guide for using the Apryse Flutter SDK on Android.

This guide will help you integrate a free trial of the Apryse SDK into your iOS applications using Flutter. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

  • Flutter >= 1.0.0

No trial license key required.

The trial of Apryse Mobile SDK does not require a trial key. A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Integrate

For simplicity, the following guide is based on a boilerplate Flutter app and uses Git Diff syntax to represent lines that have been added to or removed from the app. Please follow these Flutter get started guides to install, set up an editor, and create a Flutter Project if you are a first time Flutter developer

  1. Initialize the project by running the command:

sh

1flutter create myapp
  1. Add the following dependency to your Flutter project in myapp/pubspec.yaml:
    • If you want to use our null safe package from pub.dev:

shell

1dependencies:
2 flutter:
3 sdk: flutter
4+ pdftron_flutter:
  • If you want to use our null safe package from GitHub:

shell

1dependencies:
2 flutter:
3 sdk: flutter
4+ pdftron_flutter:
5+ git:
6+ url: git://github.com/ApryseSDK/pdftron-flutter.git
  1. Navigate to your myapp folder:and run the following command to get the required packages:

sh

1cd myapp

sh

1flutter packages get
  1. Open myapp/ios/Podfile and make these changes:

sh

1# Uncomment this line to define a global platform for your project
2- # platform :ios, '9.0'
3+ platform :ios, "10.0"
4 target 'Runner' do
5 # ...
6+ # Apryse Pods
7+ pod 'PDFNet', podspec: 'https://www.pdftron.com/downloads/ios/cocoapods/xcframeworks/pdfnet/latest.podspec'
8 # ...
9 end
  1. Run this command to ensure integration process is successful:

sh

1flutter build ios --no-codesign

Next step

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales