TPPDF

Swift Cocoapods Carthage iOS License

Travis Codacy codebeat codecov

TPPDF is a fast PDF builder for iOS using simple commands to create advanced documents!

FeaturesCommunicationExampleUsageInstallationCreditsLicense

Features

  • [x] Page header and footer
  • [x] Dynamic content layout with page alignment
  • [x] Support for tables and cell alignment
  • [x] Attributed strings
  • [x] Custom spacing
  • [x] Image support
  • [x] Horizontal line separators
  • [x] Custom indentation
  • [x] Custom top offset (good for layered rendering)
  • [x] Pagination
  • [x] Image caption
  • [x] Compress images
  • [x] Custom image size fit
  • [x] Images in the header and footer
  • [x] Horizontal line separators in the header and footer
  • [x] Generate PDF files directly to handle large PDF files (Details)
  • [x] PDF metadata
  • [x] Custom table styling
  • [x] Multi-column sections
  • [ ] Documentation

Communication

  • If you need help, use Stack Overflow. (Tag ‘TPPDF’)
  • If you’d like to ask a general question, use Stack Overflow.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

Example

To run the example project, run pod try TPPDF

Installation

Requirements

Language Branch Pod version Xcode version iOS version
Swift 5 master >= 1.4.x Xcode 10.2+ iOS 8.3+
Swift 4.2 swift-4.2 >= 1.3.x Xcode 10.0+ iOS 8.3+
Swift 4.1 swift-4.1 >= 1.0.x Xcode 9.3 iOS 8.3+
Swift 3.0 swift-3.0 >= 0.2.x Xcode 8 iOS 8.0+
Swift 2.3 swift-2.3 0.1.5 Xcode 8, Xcode 7.3.x iOS 8.0+
Swift 2.2 swift-2.2 0.1.4 Xcode 7.3.x iOS 8.0+

Bleed development version can be found on the develop branch.

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate TPPDF into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'TPPDF'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate TPPDF into your Xcode project using Carthage, specify it in your Cartfile:

github "techprimate/TPPDF" ~> 1.4

Run carthage update to build the framework and drag the built TPPDF.framework into your Xcode project

Swift Package Manager

Swift Package Manager is now supported for iOS. macOS support is a requested feature and work-in-progress. Linux support is not available, as UIKit is not available on linux.

Manual Installation

As Xcode project configurations are getting pretty complex, it is recommended to use a dependency manager. If you still want to add TPPDF manually, please see issue #97.

Apps using TPPDF

If you are using TPPDF in your app and want to be listed here, simply create a pull request or let me know on twitter or via github. I am always curious who is using my projects :)

ChatHistory - by techprimate

ChatHistory

Hikingbook - by Zheng-Xiang Ke

Hikingbook

Bug Journal - by David Johnson

Bug Journal

Energy Tracker - by Stefan Nebel

Energy Tracker

Credits

TPPDF is created and maintained by Philip Niedertscheider, founder of techprimate.

techprimate.com twitter facebook facebook

Contributors

Please consider backing this project by using the following link:

Back This Project

We want to thank all contributors for their effort!

License

TPPDF is available under the MIT license. See the LICENSE file for more info.