Getting started on visionOS

This guide will take you through the steps necessary to integrate PSPDFKit into a newly created visionOS application. By the end, you’ll be able to present a PDF document in the default PSPDFKit UI.

The frameworks we provide contain iOS, Mac Catalyst, iPadOS, and visionOS support bundled in XCFrameworks, which means we ship support for each of these platforms combined. The capabilities across all of these platforms are nearly identical, and our iOS documentation and API reference can be used when you’re implementing your visionOS application with PSPDFKit.

Requirements

• A computer running macOS

• The latest stable version of Xcode

Creating a New Xcode Project

1. Open Xcode and select File > New > Project… to create a new project for your application.

2. Select visionOS at the top and choose the App template for your project.

3. When prompted, enter your app name (PSPDFKit-Demo) and your organization identifier (com.example).

4. Click Next and select the location to save the project.

5. Click Create to finish.

Adding the PSPDFKit Swift Package

1. Open your application in Xcode and select your project’s Package Dependencies tab.

2. Copy the PSPDFKit Swift package repository URL into the search field:

https://github.com/PSPDFKit/PSPDFKit-SP

3. In the Dependency Rule fields, select Branch > master, and then click Add Package.

Using Branch > master will ensure you always use the latest available version of PSPDFKit. Alternatively, you can select Version > Up to Next Minor to update at your own pace.

After the package download completes, select Add Package.

PSPDFKit should now be listed under Swift Package Dependencies in the Xcode Project navigator.

Displaying a PDF

1. Add the PDF document you want to display to your application by dragging it into your project. On the dialog that’s displayed, select Finish to accept the default integration options. You can use this Quickstart Guide PDF as an example.

2. Import PSPDFKit and PSPDFKitUI at the top of your UIViewController subclass implementation:

import PSPDFKit
import PSPDFKitUI

@import PSPDFKit;
@import PSPDFKitUI;

3. Load your PDF document and display the view controller by implementing viewDidAppear(_:) in the ViewController.swift file like so:

override func viewDidAppear(_ animated: Bool) {
	super.viewDidAppear(animated)

	// Update to use your document name.
	let fileURL = Bundle.main.url(forResource: "Document", withExtension: "pdf")!
	let document = Document(url: fileURL)

	// The configuration closure is optional and allows additional customization.
	let pdfController = PDFViewController(document: document) {
			$0.isPageLabelEnabled = false
	}

	// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
	present(UINavigationController(rootViewController: pdfController), animated: true)
}

- (void)viewDidAppear:(BOOL)animated {
	[super viewDidAppear:animated];

	// Update to use your document name.
	NSURL *documentURL = [NSBundle.mainBundle URLForResource:@"Document" withExtension:@"pdf"];
	PSPDFDocument *document = [[PSPDFDocument alloc] initWithURL:documentURL];

	// The configuration object is optional and allows additional customization.
	PSPDFViewController *pdfController = [[PSPDFViewController alloc] initWithDocument:document configuration:[PSPDFConfiguration configurationWithBuilder:^(PSPDFConfigurationBuilder *builder) {
			builder.pageLabelEnabled = NO;
	}]];

	// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
	UINavigationController *navController = [[UINavigationController alloc] initWithRootViewController:pdfController];
	[self presentViewController:navController animated:YES completion:NULL];
}

PSPDFKit is provided as XCFrameworks that support iOS, Mac Catalyst, iPadOS, and visionOS. The capabilities across these platforms are generally identical, so when integrating PSPDFKit for visionOS, refer to our iOS API documentation and guides.

Next Steps

• Customize the UI and other SDK functionality.

• Take a look at our example projects to see common use cases.

• Add document collaboration via Instant.

• Add OCR support to recognize text in scanned documents.

This guide will take you through the steps necessary to integrate PSPDFKit into a newly created visionOS application. By the end, you’ll be able to present a PDF document in the default PSPDFKit UI.

The frameworks we provide contain iOS, Mac Catalyst, iPadOS, and visionOS support bundled in XCFrameworks, which means we ship support for each of these platforms combined. The capabilities across all of these platforms are nearly identical, and our iOS documentation and API reference can be used when you’re implementing your visionOS application with PSPDFKit.

Requirements

• A computer running macOS

• The latest stable version of Xcode

Creating a New Xcode Project

1. Open Xcode and select File > New > Project… to create a new project for your application.

2. Select visionOS at the top and choose the App template for your project.

3. When prompted, enter your app name (PSPDFKit-Demo) and your organization identifier (com.example).

4. Click Next and select the location to save the project.

5. Click Create to finish.

Adding the PSPDFKit XCFrameworks Manually

1. Download the latest DMG and mount it on your Mac.

2. Find PSPDFKit.xcframework and PSPDFKitUI.xcframework in the mounted DMG and copy them to your project directory next to the PSPDFKit-Demo.xcodeproj file.

3. Drag the newly copied PSPDFKit.xcframework and PSPDFKitUI.xcframework files into the Frameworks, Libraries, and Embedded Content section of your target.

Displaying a PDF

1. Add the PDF document you want to display to your application by dragging it into your project. On the dialog that’s displayed, select Finish to accept the default integration options. You can use this Quickstart Guide PDF as an example.

2. Import PSPDFKit and PSPDFKitUI at the top of your UIViewController subclass implementation:

import PSPDFKit
import PSPDFKitUI

@import PSPDFKit;
@import PSPDFKitUI;

3. Load your PDF document and display the view controller by implementing viewDidAppear(_:) in the ViewController.swift file like so:

override func viewDidAppear(_ animated: Bool) {
	super.viewDidAppear(animated)

	// Update to use your document name.
	let fileURL = Bundle.main.url(forResource: "Document", withExtension: "pdf")!
	let document = Document(url: fileURL)

	// The configuration closure is optional and allows additional customization.
	let pdfController = PDFViewController(document: document) {
			$0.isPageLabelEnabled = false
	}

	// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
	present(UINavigationController(rootViewController: pdfController), animated: true)
}

- (void)viewDidAppear:(BOOL)animated {
	[super viewDidAppear:animated];

	// Update to use your document name.
	NSURL *documentURL = [NSBundle.mainBundle URLForResource:@"Document" withExtension:@"pdf"];
	PSPDFDocument *document = [[PSPDFDocument alloc] initWithURL:documentURL];

	// The configuration object is optional and allows additional customization.
	PSPDFViewController *pdfController = [[PSPDFViewController alloc] initWithDocument:document configuration:[PSPDFConfiguration configurationWithBuilder:^(PSPDFConfigurationBuilder *builder) {
			builder.pageLabelEnabled = NO;
	}]];

	// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
	UINavigationController *navController = [[UINavigationController alloc] initWithRootViewController:pdfController];
	[self presentViewController:navController animated:YES completion:NULL];
}

PSPDFKit is provided as XCFrameworks that support iOS, Mac Catalyst, iPadOS, and visionOS. The capabilities across these platforms are generally identical, so when integrating PSPDFKit for visionOS, refer to our iOS API documentation and guides.

Next Steps

• Customize the UI and other SDK functionality.

• Take a look at our example projects to see common use cases.

• Add document collaboration via Instant.

• Add OCR support to recognize text in scanned documents.

This guide will take you through the steps necessary to integrate PSPDFKit into your visionOS application. By the end, you’ll be able to present a PDF document in the default PSPDFKit UI.

The frameworks we provide contain iOS, Mac Catalyst, iPadOS, and visionOS support bundled in XCFrameworks, which means we ship support for each of these platforms combined. The capabilities across all of these platforms are nearly identical, and our iOS documentation and API reference can be used when you’re implementing your visionOS application with PSPDFKit.

Requirements

• A computer running macOS

• The latest stable version of Xcode

• A project that already builds on visionOS

Adding the PSPDFKit Swift Package

1. Open your application in Xcode and select your project’s Package Dependencies tab.

2. Copy the PSPDFKit Swift package repository URL into the search field:

https://github.com/PSPDFKit/PSPDFKit-SP

3. In the Dependency Rule fields, select Branch > master, and then click Add Package.

Using Branch > master will ensure you always use the latest available version of PSPDFKit. Alternatively, you can select Version > Up to Next Minor to update at your own pace.

After the package download completes, select Add Package.

PSPDFKit should now be listed under Swift Package Dependencies in the Xcode Project navigator.

Displaying a PDF

1. Add the PDF document you want to display to your application by dragging it into your project. On the dialog that’s displayed, select Finish to accept the default integration options. You can use this Quickstart Guide PDF as an example.

2. Import PSPDFKit and PSPDFKitUI at the top of your UIViewController subclass implementation:

import PSPDFKit
import PSPDFKitUI

@import PSPDFKit;
@import PSPDFKitUI;

3. Load your PDF document and display the view controller. This can be done in a button action handler, table view cell selection delegate, or similar:

// Update to use your document name.
let fileURL = Bundle.main.url(forResource: "Document", withExtension: "pdf")!
let document = Document(url: fileURL)

// The configuration closure is optional and allows additional customization.
let pdfController = PDFViewController(document: document) {
	$0.isPageLabelEnabled = false
}

// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
present(UINavigationController(rootViewController: pdfController), animated: true)

// Update to use your document name.
NSURL *documentURL = [NSBundle.mainBundle URLForResource:@"Document" withExtension:@"pdf"];
PSPDFDocument *document = [[PSPDFDocument alloc] initWithURL:documentURL];

// The configuration object is optional and allows additional customization.
PSPDFViewController *pdfController = [[PSPDFViewController alloc] initWithDocument:document configuration:[PSPDFConfiguration configurationWithBuilder:^(PSPDFConfigurationBuilder *builder) {
	builder.pageLabelEnabled = NO;
}]];

// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
UINavigationController *navController = [[UINavigationController alloc] initWithRootViewController:pdfController];
[self presentViewController:navController animated:YES completion:NULL];

4. Build and run your application.

PSPDFKit is provided as XCFrameworks that support iOS, Mac Catalyst, iPadOS, and visionOS. The capabilities across these platforms are generally identical, so when integrating PSPDFKit for visionOS, refer to our iOS API documentation and guides.

Next Steps

• Customize the UI and other SDK functionality.

• Take a look at our example projects to see common use cases.

• Add document collaboration via Instant.

• Add OCR support to recognize text in scanned documents.

This guide will take you through the steps necessary to integrate PSPDFKit into your visionOS application. By the end, you’ll be able to present a PDF document in the default PSPDFKit UI.

The frameworks we provide contain iOS, Mac Catalyst, iPadOS, and visionOS support bundled in XCFrameworks, which means we ship support for each of these platforms combined. The capabilities across all of these platforms are nearly identical, and our iOS documentation and API reference can be used when you’re implementing your visionOS application with PSPDFKit.

Requirements

• A computer running macOS

• The latest stable version of Xcode

• A project that already builds on visionOS

Adding the PSPDFKit XCFrameworks Manually

1. Download the latest DMG and mount it on your Mac.

2. Find PSPDFKit.xcframework and PSPDFKitUI.xcframework in the mounted DMG and copy them to your project directory next to your .xcodeproj file.

3. Drag the newly copied PSPDFKit.xcframework and PSPDFKitUI.xcframework files into the Frameworks, Libraries, and Embedded Content section of your target.

Displaying a PDF

1. Add the PDF document you want to display to your application by dragging it into your project. On the dialog that’s displayed, select Finish to accept the default integration options. You can use this Quickstart Guide PDF as an example.

2. Import PSPDFKit and PSPDFKitUI at the top of your UIViewController subclass implementation:

import PSPDFKit
import PSPDFKitUI

@import PSPDFKit;
@import PSPDFKitUI;

3. Load your PDF document and display the view controller. This can be done in a button action handler, table view cell selection delegate, or similar:

// Update to use your document name.
let fileURL = Bundle.main.url(forResource: "Document", withExtension: "pdf")!
let document = Document(url: fileURL)

// The configuration closure is optional and allows additional customization.
let pdfController = PDFViewController(document: document) {
	$0.isPageLabelEnabled = false
}

// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
present(UINavigationController(rootViewController: pdfController), animated: true)

// Update to use your document name.
NSURL *documentURL = [NSBundle.mainBundle URLForResource:@"Document" withExtension:@"pdf"];
PSPDFDocument *document = [[PSPDFDocument alloc] initWithURL:documentURL];

// The configuration object is optional and allows additional customization.
PSPDFViewController *pdfController = [[PSPDFViewController alloc] initWithDocument:document configuration:[PSPDFConfiguration configurationWithBuilder:^(PSPDFConfigurationBuilder *builder) {
	builder.pageLabelEnabled = NO;
}]];

// Present the PDF view controller within a `UINavigationController` to show built-in toolbar buttons.
UINavigationController *navController = [[UINavigationController alloc] initWithRootViewController:pdfController];
[self presentViewController:navController animated:YES completion:NULL];

4. Build and run your application.

PSPDFKit is provided as XCFrameworks that support iOS, Mac Catalyst, iPadOS, and visionOS. The capabilities across these platforms are generally identical, so when integrating PSPDFKit for visionOS, refer to our iOS API documentation and guides.

Next Steps

• Customize the UI and other SDK functionality.

• Take a look at our example projects to see common use cases.

• Add document collaboration via Instant.

• Add OCR support to recognize text in scanned documents.

This guide will take you through the steps necessary to integrate PSPDFKit into your visionOS application. By the end, you’ll be able to present a PDF document in the default PSPDFKit UI.

The frameworks we provide contain iOS, Mac Catalyst, iPadOS, and visionOS support bundled in XCFrameworks, which means we ship support for each of these platforms combined. The capabilities across all of these platforms are nearly identical, and our iOS documentation and API reference can be used when you’re implementing your visionOS application with PSPDFKit.

Requirements

• A computer running macOS

• The latest stable version of Xcode

Cloning PSPDFKit Catalog

1. Open the terminal and change the current working directory. In this case, we’ll use the ~/Downloads directory:

cd ~/Downloads

2. Clone the PSPDFKit Catalog repository:

git clone https://github.com/PSPDFKit/pspdfkit-ios-catalog.git

3. Open the Catalog Xcode project (Catalog.xcodeproj):

open pspdfkit-ios-catalog/Catalog.xcodeproj/

4. Wait a few moments for the PSPDFKit Swift packages to download.

5. Build and run the Catalog on a visionOS simulator.

If you see any errors related to Swift Packages, use the File > Packages > Reset Package Caches menu option in Xcode.

Next Steps

• Customize the UI and other SDK functionality.

• Take a look at our example projects to see common use cases.

• Add document collaboration via Instant.

• Add OCR support to recognize text in scanned documents.