> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/core/get-started/readme/info/catalyst.md). # Mac Catalyst PDF SDK Explore Apryse’s Mac Catalyst PDF SDK for seamless document viewing, editing, and annotation on macOS and iOS apps. Trust Apryse's fully supported SDK used by startups, governments, and Fortune 500 co ## Mac Catalyst PDF SDK ![](https://3779731113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fziw3GiL98Xfj63F3He8h%2Fuploads%2Fgit-blob-fd4b91175ebb1e2c4490e8ae68601fe2a1528cee%2F51c649fc7d4e08c8f93798798a17867962abd7a3-1500x937.png?alt=media) *Above: the MacReader sample app showing the `_NSToolbar_` on the macOS window, as well as the UIMenus provided by `_PTDocumentController_`.* Apryse’s Mac Catalyst PDF SDK comes with simple-to-use Objective-C and Swift APIs to bring document viewing, creating, searching, annotation, and editing capabilities to native MacOS and iOS apps. Our goal with Mac Catalyst is for our existing iOS UI to be as close as possible to the native AppKit look and feel -- without sacrificing functionality or the convenience of using a single API for iOS and macOS. We are continuously improving the library, so stay tuned for exciting new features. Please [get in touch](https://docs.apryse.com) with us. Apryse’s fully supported SDK is trusted by thousands of innovative startups, governments, and Fortune 500 businesses (see [customers](https://apryse.com/customers)). Apryse technology is built from the ground up and is not dependent on any external third-party open-source software. ### What is Mac Catalyst Mac Catalyst is an exciting technology from Apple that makes it incredibly easy to build a state-of-the-art Mac app by porting an existing iOS application. Your Apryse SDK-based Catalyst apps can be released via the Mac App Store or by simply sharing a binary. You can also use Apryse macOS [Electron](/web/get-started/libraries-and-frameworks/electron.md) if you need a Mac app that runs on an older macOS release (prior to macOS 10.15 Catalina). ### The Apryse SDK for Mac Catalyst The [`PTDocumentController`](https://sdk.apryse.com/api/ios/Classes/PTDocumentViewController.html) shows a PDF viewer and annotator complete with controls such as an annotation toolbar, page layout controls, bookmarks, thumbnail viewer, etc. All of its component pieces are part of the Tools framework, and this class packages them into one easy to use view controller. The `PTDocumentController` in our Catalyst SDK also provides a ready-made [`NSToolbar`](https://developer.apple.com/appkit/nstoolbar/) which provides convenient access to many of the built-in controls described above. The toolbar is available as a property on the document view controller: `documentController.macToolbar`. ## Integrating the Apryse SDK into your Catalyst application The Apryse SDK can easily be integrated into your Catalyst apps. XCFrameworks for both the PDFNet framework and Tools UI framework are included in the Apryse SDK for iOS. The SDK can be integrated by CocoaPods, Swift Package Manager, or by manually integrating the XCFrameworks into your Xcode project. Please see the [Getting Started](/ios/get-started/integration.md) guide for more information. ### Viewing a Document in Catalyst To show a `PTDocumentController`, override the `viewDidAppear()` method in your `UIViewController` class and then open the documentController using: {% tabs %} {% tab title="Swift" %} {% code lineNumbers="true" %} ```swift //Import the PDFNet and Tools libraries import PDFNet import Tools override func viewDidAppear(_ animated: Bool) { // Create a PTDocumentController let documentController = PTDocumentController() // Conform to the `PTDocumentControllerDelegate` protocol documentController.delegate = self; // The PTDocumentController must be in a navigation controller before a document can be opened let navigationController = UINavigationController(rootViewController: documentController) // Open a file from URL. let fileURL: URL = URL(string:"https://pdftron.s3.amazonaws.com/downloads/pl/sample.pdf")! documentController.openDocument(with: fileURL) // Show navigation (and document) controller. self.present(navigationController, animated: true, completion: nil) } ``` {% endcode %} {% endtab %} {% tab title="Obj-C" %} {% code lineNumbers="true" %} ```objc //Import the PDFNet and Tools libraries #import #import - (void)viewDidAppear:(BOOL)animated { // Create a PTDocumentController PTDocumentController *documentController = [[PTDocumentController alloc] init]; // Conform to the `PTDocumentControllerDelegate` protocol documentController.delegate = self; // The PTDocumentController must be in a navigation controller before a document can be opened UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:documentController]; // Open a file from URL. NSURL *fileURL = [[NSURL alloc] initWithString:@"https://pdftron.s3.amazonaws.com/downloads/pl/sample.pdf"]; [documentController openDocumentWithURL:fileURL]; // Show navigation (and document) controller. [self presentViewController:navigationController animated:YES completion:nil]; } ``` {% endcode %} {% endtab %} {% endtabs %} To show the `PTDocumentController`'s `NSToolbar`, make the view controller conform to the `PTDocumentControllerDelegate` protocol and implement the delegate method, `documentControllerDidOpenDocument:documentController`. {% tabs %} {% tab title="Swift" %} {% code lineNumbers="true" %} ```swift // Set the toolbar in the `documentControllerDidOpenDocument:documentController` delegate method func documentControllerDidOpenDocument(_ documentController: PTDocumentController) { #if targetEnvironment(macCatalyst) if let window = UIApplication.shared.windows.first, let windowScene = window.windowScene { if let titlebar = windowScene.titlebar { let toolbar = documentController.macToolbar titlebar.toolbar = toolbar } } #endif } ``` {% endcode %} {% endtab %} {% tab title="Obj-C" %} {% code lineNumbers="true" %} ```objc // Set the toolbar in the `documentControllerDidOpenDocument:documentController` delegate method - (void)documentControllerDidOpenDocument:(PTDocumentController *)documentController { #if TARGET_OS_MACCATALYST UIWindowScene *windowScene = [UIApplication sharedApplication].windows.firstObject.windowScene; windowScene.titlebar.titleVisibility = UITitlebarTitleVisibilityHidden; windowScene.titlebar.toolbar = documentController.macToolbar; #endif } ``` {% endcode %} {% endtab %} {% endtabs %} In addition, the view controller also provides a set of [`UIMenus`](https://developer.apple.com/uikit/uimenu/) which you can use to provide quick access to certain actions and view modes in the menu bar of your Catalyst app. To use these menus in your app you can use these menus in the `buildMenuWithBuilder:` method in your `AppDelegate`. See [this guide](https://developer.apple.com/uikit/uicommand/adding_menus_and_shortcuts_to_the_menu_bar_and_user_interface/) from Apple for more information about the `UIMenuSystem`. {% hint style="info" %} **The \`AppDelegate\` will need a reference to an instance of the \`PTDocumentController\` class to use its menus.** {% endhint %} {% tabs %} {% tab title="Swift" %} {% code lineNumbers="true" %} ```swift override func buildMenu(with builder: UIMenuBuilder) { super.buildMenu(with: builder) // Make sure the App Delegate has a valid reference to a `PTDocumentController` object if documentController == nil { return } /** The View Modes menu contains actions for setting the view mode on the document * e.g. Continuous scroll, single page mode, facing page mode. */ let viewModesMenu:UIMenu = documentController.viewModesMenu // The Additional View menu contains actions for toggling reader mode or displaying the annotation toolbar let additionalViewMenu:UIMenu = documentController.additionalViewMenu /** The Navigation Lists menu contains actions for displaying navigation lists in the side panel: * Table of Contents (document outline), Annotations list, User Bookmarks list, or the thumbnails browser. */ let navigationListsMenu:UIMenu = documentController.navigationListsMenu // The Navigate Doc menu contains actions for navigating the document let navigateDocMenu:UIMenu = documentController.navigateDocMenu // The Annotate menu contains actions for adding annotations to the document let annotateMenu:UIMenu = documentController.annotateMenu guard builder.system == .main else { return } builder.insertChild(viewModesMenu, atStartOfMenu: .view) builder.insertChild(navigationListsMenu, atStartOfMenu: .view) builder.insertChild(additionalViewMenu, atStartOfMenu: .view) builder.insertSibling(annotateMenu, afterMenu: .view) builder.insertSibling(navigateDocMenu, afterMenu: .view) } ``` {% endcode %} {% endtab %} {% tab title="Obj-C" %} {% code lineNumbers="true" %} ```objc -(void)buildMenuWithBuilder:(id)builder { [super buildMenuWithBuilder:builder]; // Make sure the App Delegate has a valid reference to a `PTDocumentController` object if (self.documentController == nil) { return; } /** The View Modes menu contains actions for setting the view mode on the document * e.g. Continuous scroll, single page mode, facing page mode. */ UIMenu *viewModesMenu = self.documentController.viewModesMenu; // The Additional View menu contains actions for toggling reader mode or displaying the annotation toolbar UIMenu *additionalViewMenu = self.documentController.additionalViewMenu; /** The Navigation Lists menu contains actions for displaying navigation lists in the side panel: * Table of Contents (document outline), Annotations list, User Bookmarks list, or the thumbnails browser. */ UIMenu *navigationListsMenu = self.documentController.navigationListsMenu; // The Navigate Doc menu contains actions for navigating the document UIMenu *navigateDocMenu = self.documentController.navigateDocMenu; // The Annotate menu contains actions for adding annotations to the document UIMenu *annotateMenu = self.documentController.annotateMenu; [builder insertChildMenu:viewModesMenu atStartOfMenuForIdentifier:UIMenuView]; [builder insertChildMenu:navigationListsMenu atStartOfMenuForIdentifier:UIMenuView]; [builder insertChildMenu:additionalViewMenu atStartOfMenuForIdentifier:UIMenuView]; [builder insertSiblingMenu:annotateMenu afterMenuForIdentifier:UIMenuView]; [builder insertSiblingMenu:navigateDocMenu afterMenuForIdentifier:UIMenuView]; } ``` {% endcode %} {% endtab %} {% endtabs %} #### Menu Actions and Keyboard Shortcuts | annotateMenu | | navigationListsMenu | | viewModesMenu | | additionalViewMenu | | navigateDocMenu | | | ------------- | --- | ------------------- | --- | ----------------- | -- | ------------------ | --- | --------------- | --- | | Highlight | ^⌘H | Table of Contents | ⌥⌘3 | Continuous Scroll | ⌘1 | Annotation Toolbar | ⌘⇧A | Up | ↑ | | Underline | ^⌘U | Annotation List | ⌥⌘4 | Single Page | ⌘2 | Reader Mode | ⌘⇧R | Down | ↓ | | Strikethrough | ^⌘S | Bookmarks List | ⌥⌘5 | Two Pages | ⌘3 | | | First Page | ⌘↑ | | Rectangle | ^⌘R | Thumbnails | ⌥⌘6 | | | | | Last Page | ⌘↓ | | Ellipse | ^⌘O | | | | | | | Go to Page | ⌥⌘G | | Line | ^⌘L | | | | | | | | | | Arrow | ^⌘A | | | | | | | | | | Polygon | | | | | | | | | | | Polyline | | | | | | | | | | | Drawing | ^⌘I | | | | | | | | | | Text | ^⌘T | | | | | | | | | | Note | ^⌘N | | | | | | | | | | Signature | ^⌘X | | | | | | | | | ### MacReader Sample App The `MacReader` sample app included in the download package demonstrates how to integrate the Apryse SDK into your app. The sample can be found in the `Samples` directory in the SDK [download](https://docs.apryse.com/downloads/ios/dmg/PDFNet.dmg). ![](https://3779731113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fziw3GiL98Xfj63F3He8h%2Fuploads%2Fgit-blob-75d9f0eb84822bebd1264ce0c02afeea443ae628%2F39d55bba89e27ddbee58f20fa0eeb62709cf44ea-1060x1400.png?alt=media) *Above: the MacReader sample app showing the annotation context menu which is activated by right-clicking (control-clicking) or performing a two-finger tap gesture on the document.* macOS dark mode is also supported: | Light Mode | Dark Mode | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ![](https://3779731113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fziw3GiL98Xfj63F3He8h%2Fuploads%2Fgit-blob-7d8c4a1a11510c387a51e17cde28ad27c77fc95c%2Fdd23c345c89b78cf0f309403790efc8564e03b98-1181x1400.png?alt=media) | ![](https://3779731113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fziw3GiL98Xfj63F3He8h%2Fuploads%2Fgit-blob-ac84dc14d1b5c266b22dfdbc4e316bf971cc886a%2F60a324d27e139fb68bbfd65e925dc09c9c22986e-1181x1400.png?alt=media) | ### Unique Functionality * Direct MS Office document viewing and conversion * Fully customizable open source UI to improve app engagement * Document reflow to increase readability and accessibility on mobile * File streaming to view remote and complex documents faster * Night mode to improve viewing in low-light environments * And much more... ### File Type Support * PDF, PDF/A * DOC, DOCX, XLSX, XLS, PPTX, PPT (no MS Office licenses or software is required) * JPG, HEIF, BMP, TIF, PNG, SVG, EMF, GIF * PAGES, KEYNOTE, NUMBERS * RTF, TXT * HTML * XPS ### OS Support * **macOS Catalina (10.15+)** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.apryse.com/core/get-started/readme/info/catalyst.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.