Photosui

PhotosUI Documentation

Search these docs to answer questions about photo picker APIs.

Return Format

Always include: 1. Summary - Answer the question concisely 2. File paths - List relevant files for full details

Files

• photosui-index.md - Framework overview, Live Photo views
• photospicker.md - SwiftUI PhotosPicker for selecting photos

Navigation: PhotosUI

Structure

PhotosPicker

Available on: iOS 16.0+, iPadOS 16.0+, Mac Catalyst, macOS 13.0+, visionOS, watchOS 9.0+

A view that displays a Photos picker for choosing assets from the photo library.

@MainActor @preconcurrency struct PhotosPicker<Label> where Label : View

Overview

Use the Photos picker view to browse and select images and videos from the photo library. The view contains methods for single selection and multiple selection. For example, the following code displays a button that — when pressed — shows a picker in multiple selection mode.

import SwiftUI
import PhotosUI

struct PhotosSelector: View {
    @State var selectedItems: [PhotosPickerItem] = []

    var body: some View {
        PhotosPicker(selection: $selectedItems,
                     matching: .images) {
            Text("Select Multiple Photos")
        }
    }
}

When displaying the picker, you can use PHPickerFilter options to customize what it displays. For example, the following code displays images and excludes screenshots.

PhotosPicker(selection: $selectedItems,
             matching: .any(of: [.images, .not(.screenshots)])) {
    Text("Select Photos")
}

The selection results you get are placeholder objects. A PhotosPickerItem conforms to Transferable, and allows you to load a representation you request. To load a SwiftUI Image and track progress, use loadTransferable(type:completionHandler:)).

func loadTransferable(from imageSelection: PhotosPickerItem) -> Progress {
    return imageSelection.loadTransferable(type: Image.self) { result in
        DispatchQueue.main.async {
            guard imageSelection == self.imageSelection else { return }
            switch result {
            case .success(let image?):
                // Handle the success case with the image.
            case .success(nil):
                // Handle the success case with an empty value.
            case .failure(let error):
                // Handle the failure case with the provided error.
            }
        }
    }
}

A failure can occur when the system attempts to retrieve the data. For example, if the picker tries to download data from iCloud Photos without a network connection.

Important: Image only supports PNG file types through its Transferable conformance, so you need to create a custom Transferable model to support other image types. See Bringing Photos picker to your SwiftUI app to learn more.

Conforms To

• Sendable
• SendableMetatype
• View

Creating a picker

• init(selection:matching:preferredItemEncoding:label:)) Creates a picker that selects an item and optionally configures the types of items to show, item encoding, and label behavior.
• init(selection:maxSelectionCount:selectionBehavior:matching:preferredItemEncoding:label:)) Creates a picker that selects a collection of items and optionally configures the max selection count, selection behavior, types of items to show, item encoding, and label behavior.
• init(selection:matching:preferredItemEncoding:photoLibrary:label:)) Creates a picker that selects an item from the photo library you specify and optionally configures the types of items to show, item encoding, and label behavior.
• init(selection:maxSelectionCount:selectionBehavior:matching:preferredItemEncoding:photoLibrary:label:)) Creates a picker that selects a collection of items from the photo library you specify and optionally configures the max selection count, selection behavior, types of items to show, item encoding, and label behavior.

Creating a picker with a title

• init(_:selection:matching:preferredItemEncoding:)-7jbef) Creates a picker with a title key and selection, and optionally configures the types of items to show and item encoding behavior.
• init(_:selection:matching:preferredItemEncoding:)-48f7l) Creates a picker with a title and selection, and optionally configures the types of items to show and item encoding behavior.
• init(_:selection:maxSelectionCount:selectionBehavior:matching:preferredItemEncoding:)-8ac23) Creates a picker with a title key and selection, and optionally configures the max selection count, selection behavior, types of items to show, item encoding, and label behavior.
• init(_:selection:maxSelectionCount:selectionBehavior:matching:preferredItemEncoding:)-6m11r) Creates a picker with a title and selection, and optionally configures the max selection count, selection behavior, types of items to show, item encoding, and label behavior.
• init(_:selection:matching:preferredItemEncoding:photoLibrary:)-bu7c) Creates a picker with a title key and selection from the photo library you specify, and optionally configures the types of items to show, item encoding, and label behavior.
• init(_:selection:matching:preferredItemEncoding:photoLibrary:)-6bm2n) Creates a picker with a title and selection from the photo library you specify, and optionally configures the types of items to show, item encoding, and label behavior.
• init(_:selection:maxSelectionCount:selectionBehavior:matching:preferredItemEncoding:photoLibrary:)-5tpfd) Creates a picker with a title key and selection from the photo library you specify, and optionally configures the max selection count, selection behavior, types of items to show, item encoding, and label behavior.
• init(_:selection:maxSelectionCount:selectionBehavior:matching:preferredItemEncoding:photoLibrary:)-6fwsc) Creates a picker with a title and selection from the photo library you specify, and optionally configures the max selection count, selection behavior, types of items to show, item encoding, and label behavior.

Photos picker for SwiftUI

• Bringing Photos picker to your SwiftUI app Select media assets by using a Photos picker view that SwiftUI provides.
• Implementing an inline Photos picker Embed a system-provided, half-height Photos picker into your app’s view.
• PhotosPickerItem A type that represents an item you use with a Photos picker.
• PhotosPickerSelectionBehavior A type that describes how the Photos picker handles user selection.
• PhotosPickerStyle

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.

Navigation: PhotosUI

Shared photo library

• Delivering an Enhanced Privacy Experience in Your Photos App
• PHLivePhotoView

Choosing a Live Photo to Display

• var livePhoto: PHLivePhoto?

Managing Playback

• var playbackGestureRecognizer: UIGestureRecognizer
• var isMuted: Bool
• var audioVolume: Float

Responding to Playback Events

• var delegate: (any PHLivePhotoViewDelegate)?
• PHLivePhotoViewDelegate

Responding to Live Photos Playback Events

• func livePhotoView(PHLivePhotoView, canBeginPlaybackWith: PHLivePhotoViewPlaybackStyle) -> Bool)
• func livePhotoView(PHLivePhotoView, willBeginPlaybackWith: PHLivePhotoViewPlaybackStyle))
• func livePhotoView(PHLivePhotoView, didEndPlaybackWith: PHLivePhotoViewPlaybackStyle))
• func livePhotoView(PHLivePhotoView, extraMinimumTouchDurationFor: UITouch, with: PHLivePhotoViewPlaybackStyle) -> TimeInterval)

Manually Playing Live Photo Content

• func startPlayback(with: PHLivePhotoViewPlaybackStyle))
• func stopPlayback())
• func stopPlayback(animated: Bool))

Accessing User Interface Icons for Live Photos

• class func livePhotoBadgeImage(options: PHLivePhotoBadgeOptions) -> UIImage)
• var livePhotoBadgeView: NSView?

Setting the Content Mode

• var contentMode: PHLivePhotoViewContentMode
• PHLivePhotoViewContentMode

Content Modes

• case aspectFit
• case aspectFill

Initializers

• init?(rawValue: Int))

Constants

• PHLivePhotoViewPlaybackStyle

Constants

• case undefined
• case full
• case hint

Initializers

• init?(rawValue: Int))

• PHLivePhotoBadgeOptions

Initializers

• init(rawValue: UInt))

Constants

• static var liveOff: PHLivePhotoBadgeOptions
• static var overContent: PHLivePhotoBadgeOptions

Instance Properties

• var contentsRect: CGRect
• var intrinsicContentSize: CGSize

Photos picker for UIKit, AppKit

• Selecting Photos and Videos in iOS
• PHPickerViewController

Creating a picker

• convenience init(configuration: PHPickerConfiguration))
• PHPickerConfiguration

Creating a configuration

• init())
• init(photoLibrary: PHPhotoLibrary))

Filtering asset types

• var filter: PHPickerFilter?
• PHPickerFilter

Creating Filters

• static func playbackStyle(PHAsset.PlaybackStyle) -> PHPickerFilter)
• [static func all(of: [PHPickerFilter]) -> PHPickerFilter](/documentation/photosui/phpickerfilter-swift.struct/all(of:))
• static func not(PHPickerFilter) -> PHPickerFilter)

Getting Filter Types

• static let bursts: PHPickerFilter
• static let cinematicVideos: PHPickerFilter
• static let depthEffectPhotos: PHPickerFilter
• static let images: PHPickerFilter
• static let livePhotos: PHPickerFilter
• static let panoramas: PHPickerFilter
• static let screenRecordings: PHPickerFilter
• static let screenshots: PHPickerFilter
• static let slomoVideos: PHPickerFilter
• static let timelapseVideos: PHPickerFilter
• static let videos: PHPickerFilter
• [static func any(of: [PHPickerFilter]) -> PHPickerFilter](/documentation/photosui/phpickerfilter-swift.struct/any(of:))

Type Properties

• static let spatialMedia: PHPickerFilter

Selecting the preferred asset representation

• var preferredAssetRepresentationMode: PHPickerConfiguration.AssetRepresentationMode
• PHPickerConfiguration.AssetRepresentationMode

Constants

• case automatic
• case compatible
• case current

Preselecting assets

• [var preselectedAssetIdentifiers: [String]](/documentation/photosui/phpickerconfiguration-swift.struct/preselectedassetidentifiers)

Setting the selection limit

• var selectionLimit: Int
• var selection: PHPickerConfiguration.Selection
• PHPickerConfigurationSelection

Selection methods

• case `default`
• case ordered
• case continuous
• case continuousAndOrdered

Initializers

• init?(rawValue: Int))

• PHPickerConfiguration.Selection

Selection methods

• case `default`
• case ordered
• case continuous
• case continuousAndOrdered

Customizing picker appearance and behavior

• var mode: PHPickerMode
• PHPickerMode

Laying out photos

• static var compact: PHPickerMode
• static let `default`: PHPickerMode

• var disabledCapabilities: PHPickerCapabilities
• PHPickerCapabilities

Specifying features

• static var collectionNavigation: PHPickerCapabilities
• static var selectionActions: PHPickerCapabilities
• static var search: PHPickerCapabilities
• static var sensitivityAnalysisIntervention: PHPickerCapabilities
• static var stagingArea: PHPickerCapabilities

Creating a capability

• init(rawValue: UInt))

• var edgesWithoutContentMargins: NSDirectionalRectEdge
• PHPickerConfiguration.Update

Creating an update object

• init())

Adjusting selection limits

• var selectionLimit: Int?

Adjusting content margins

• var edgesWithoutContentMargins: NSDirectionalRectEdge?

Managing the configuration

• var configuration: PHPickerConfiguration
• func updatePicker(using: PHPickerConfiguration.Update))

Setting content position and scale

• func scrollToInitialPosition())
• func zoomIn())
• func zoomOut())

Responding to user selection

• var delegate: (any PHPickerViewControllerDelegate)?
• PHPickerViewControllerDelegate

Instance Methods

• [func picker(PHPickerViewController, didFinishPicking: [PHPickerResult])](/documentation/photosui/phpickerviewcontrollerdelegate-5yntc/picker(_:didfinishpicking:))

• PHPickerResult

Inspecting the Result

• var assetIdentifier: String?
• let itemProvider: NSItemProvider

Deselecting assets

• [func deselectAssets(withIdentifiers: [String])](/documentation/photosui/phpickerviewcontroller/deselectassets(withidentifiers:))

Reordering assets

• func moveAsset(withIdentifier: String, afterAssetWithIdentifier: String?))

• PHPickerViewControllerDelegate

Instance Methods

• [func picker(PHPickerViewController, didFinishPicking: [PHPickerResult])](/documentation/photosui/phpickerviewcontrollerdelegate-5yntc/picker(_:didfinishpicking:))

• PHPickerConfiguration

Creating a configuration

• init())
• init(photoLibrary: PHPhotoLibrary))

Filtering asset types

• var filter: PHPickerFilter?
• PHPickerFilter

Creating Filters

• static func playbackStyle(PHAsset.PlaybackStyle) -> PHPickerFilter)
• [static func all(of: [PHPickerFilter]) -> PHPickerFilter](/documentation/photosui/phpickerfilter-swift.struct/all(of:))
• static func not(PHPickerFilter) -> PHPickerFilter)

Getting Filter Types

• static let bursts: PHPickerFilter
• static let cinematicVideos: PHPickerFilter
• static let depthEffectPhotos: PHPickerFilter
• static let images: PHPickerFilter
• static let livePhotos: PHPickerFilter
• static let panoramas: PHPickerFilter
• static let screenRecordings: PHPickerFilter
• static let screenshots: PHPickerFilter
• static let slomoVideos: PHPickerFilter
• static let timelapseVideos: PHPickerFilter
• static let videos: PHPickerFilter
• [static func any(of: [PHPickerFilter]) -> PHPickerFilter](/documentation/photosui/phpickerfilter-swift.struct/any(of:))

Type Properties

• static let spatialMedia: PHPickerFilter

Selecting the preferred asset representation

• var preferredAssetRepresentationMode: PHPickerConfiguration.AssetRepresentationMode
• PHPickerConfiguration.AssetRepresentationMode

Constants

• case automatic
• case compatible
• case current

Preselecting assets

• [var preselectedAssetIdentifiers: [String]](/documentation/photosui/phpickerconfiguration-swift.struct/preselectedassetidentifiers)

Setting the selection limit

• var selectionLimit: Int
• var selection: PHPickerConfiguration.Selection
• PHPickerConfigurationSelection

Selection methods

• case `default`
• case ordered
• case continuous
• case continuousAndOrdered

Initializers

• init?(rawValue: Int))

• PHPickerConfiguration.Selection

Selection methods

• case `default`
• case ordered
• case continuous
• case continuousAndOrdered

Customizing picker appearance and behavior

• var mode: PHPickerMode
• PHPickerMode

Laying out photos

• static var compact: PHPickerMode
• static let `default`: PHPickerMode

• var disabledCapabilities: PHPickerCapabilities
• PHPickerCapabilities

Specifying features

• static var collectionNavigation: PHPickerCapabilities
• static var selectionActions: PHPickerCapabilities
• static var search: PHPickerCapabilities
• static var sensitivityAnalysisIntervention: PHPickerCapabilities
• static var stagingArea: PHPickerCapabilities

Creating a capability

• init(rawValue: UInt))

• var edgesWithoutContentMargins: NSDirectionalRectEdge
• PHPickerConfiguration.Update

Creating an update object

• init())

Adjusting selection limits

• var selectionLimit: Int?

Adjusting content margins

• var edgesWithoutContentMargins: NSDirectionalRectEdge?

• PHPickerFilter

Creating Filters

• static func playbackStyle(PHAsset.PlaybackStyle) -> PHPickerFilter)
• [static func all(of: [PHPickerFilter]) -> PHPickerFilter](/documentation/photosui/phpickerfilter-swift.struct/all(of:))
• static func not(PHPickerFilter) -> PHPickerFilter)

Getting Filter Types

• static let bursts: PHPickerFilter
• static let cinematicVideos: PHPickerFilter
• static let depthEffectPhotos: PHPickerFilter
• static let images: PHPickerFilter
• static let livePhotos: PHPickerFilter
• static let panoramas: PHPickerFilter
• static let screenRecordings: PHPickerFilter
• static let screenshots: PHPickerFilter
• static let slomoVideos: PHPickerFilter
• static let timelapseVideos: PHPickerFilter
• static let videos: PHPickerFilter
• [static func any(of: [PHPickerFilter]) -> PHPickerFilter](/documentation/photosui/phpickerfilter-swift.struct/any(of:))

Type Properties

• static let spatialMedia: PHPickerFilter

• PHPickerResult

Inspecting the Result

• var assetIdentifier: String?
• let itemProvider: NSItemProvider

Photos picker for SwiftUI

• Bringing Photos picker to your SwiftUI app
• Implementing an inline Photos picker
• PhotosPicker

Creating a picker

• init(selection: Binding<PhotosPickerItem?>, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, label: () -> Label))
• [init(selection: Binding<[PhotosPickerItem]>, maxSelectionCount: Int?, selectionBehavior: PhotosPickerSelectionBehavior, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, label: () -> Label)](/documentation/photosui/photospicker/init(selection:maxselectioncount:selectionbehavior:matching:preferreditemencoding:label:))
• init(selection: Binding<PhotosPickerItem?>, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, photoLibrary: PHPhotoLibrary, label: () -> Label))
• [init(selection: Binding<[PhotosPickerItem]>, maxSelectionCount: Int?, selectionBehavior: PhotosPickerSelectionBehavior, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, photoLibrary: PHPhotoLibrary, label: () -> Label)](/documentation/photosui/photospicker/init(selection:maxselectioncount:selectionbehavior:matching:preferreditemencoding:photolibrary:label:))

Creating a picker with a title

• init(LocalizedStringKey, selection: Binding<PhotosPickerItem?>, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy)-7jbef)
• init<S>(S, selection: Binding<PhotosPickerItem?>, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy)-48f7l)
• [init(LocalizedStringKey, selection: Binding<[PhotosPickerItem]>, maxSelectionCount: Int?, selectionBehavior: PhotosPickerSelectionBehavior, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy)](/documentation/photosui/photospicker/init(_:selection:maxselectioncount:selectionbehavior:matching:preferreditemencoding:)-8ac23)
• [init<S>(S, selection: Binding<[PhotosPickerItem]>, maxSelectionCount: Int?, selectionBehavior: PhotosPickerSelectionBehavior, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy)](/documentation/photosui/photospicker/init(_:selection:maxselectioncount:selectionbehavior:matching:preferreditemencoding:)-6m11r)
• init(LocalizedStringKey, selection: Binding<PhotosPickerItem?>, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, photoLibrary: PHPhotoLibrary)-bu7c)
• init<S>(S, selection: Binding<PhotosPickerItem?>, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, photoLibrary: PHPhotoLibrary)-6bm2n)
• [init(LocalizedStringKey, selection: Binding<[PhotosPickerItem]>, maxSelectionCount: Int?, selectionBehavior: PhotosPickerSelectionBehavior, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, photoLibrary: PHPhotoLibrary)](/documentation/photosui/photospicker/init(_:selection:maxselectioncount:selectionbehavior:matching:preferreditemencoding:photolibrary:)-5tpfd)
• [init<S>(S, selection: Binding<[PhotosPickerItem]>, maxSelectionCount: Int?, selectionBehavior: PhotosPickerSelectionBehavior, matching: PHPickerFilter?, preferredItemEncoding: PhotosPickerItem.EncodingDisambiguationPolicy, photoLibrary: PHPhotoLibrary)](/documentation/photosui/photospicker/init(_:selection:maxselectioncount:selectionbehavior:matching:preferreditemencoding:photolibrary:)-6fwsc)

• PhotosPickerItem

Creating a picker item

• init(itemIdentifier: String))

Inspecting a picker item

• var itemIdentifier: String?
• [var supportedContentTypes: [UTType]](/documentation/photosui/photospickeritem/supportedcontenttypes)

Getting an encoding policy

• PhotosPickerItem.EncodingDisambiguationPolicy

Getting standard encoding policies

• static let automatic: PhotosPickerItem.EncodingDisambiguationPolicy
• static let current: PhotosPickerItem.EncodingDisambiguationPolicy
• static let compatible: PhotosPickerItem.EncodingDisambiguationPolicy

Loading the provider’s contents

• func loadTransferable<T>(type: T.Type) async throws -> sending T?)
• func loadTransferable<T>(type: T.Type, completionHandler: (Result<T?, any Error>) -> Void) -> Progress)

• PhotosPickerSelectionBehavior

Getting standard selection behaviors

• static let `default`: PhotosPickerSelectionBehavior
• static let ordered: PhotosPickerSelectionBehavior

Type Properties

• static let continuous: PhotosPickerSelectionBehavior
• static let continuousAndOrdered: PhotosPickerSelectionBehavior

• PhotosPickerStyle

Type Properties

• static let compact: PhotosPickerStyle
• static let inline: PhotosPickerStyle
• static let presentation: PhotosPickerStyle

Live Photos

• Displaying Live Photos

Photo Editing Extensions

• Creating Photo Editing Extensions
• PHContentEditingController

Working with Adjustment Data

• func canHandle(PHAdjustmentData) -> Bool)

Performing an Edit

• func startContentEditing(with: PHContentEditingInput, placeholderImage: UIImage))
• func finishContentEditing(completionHandler: (PHContentEditingOutput?) -> Void))

Canceling an Edit

• var shouldShowCancelConfirmation: Bool
• func cancelContentEditing())

macOS Photos Project Extensions

• Creating a Slideshow Project Extension for Photos
• PHProject
• PHProjectInfo

Determining Project Type

• var projectType: PHProjectType
• PHProjectType

Initializing a Project Type

• init(String))
• init(rawValue: String))

Defining a Project Type

• static let undefined: PHProjectType

• var creationSource: PHProjectInfo.CreationSource
• [var sections: [PHProjectSection]](/documentation/photosui/phprojectinfo/sections)
• PHProjectTypeDescription

Creating a Project Type Description

• convenience init(projectType: PHProjectType, title: String, description: String?, image: NSImage?))
• [init(projectType: PHProjectType, title: String, description: String?, image: NSImage?, subtypeDescriptions: [PHProjectTypeDescription])](/documentation/photosui/phprojecttypedescription/init(projecttype:title:description:image:subtypedescriptions:))
• [init(projectType: PHProjectType, title: String, attributedDescription: NSAttributedString?, image: NSImage?, subtypeDescriptions: [PHProjectTypeDescription])](/documentation/photosui/phprojecttypedescription/init(projecttype:title:attributeddescription:image:subtypedescriptions:))
• init(projectType: PHProjectType, title: String, description: String?, image: NSImage?, canProvideSubtypes: Bool))
• init(projectType: PHProjectType, title: String, attributedDescription: NSAttributedString?, image: NSImage?, canProvideSubtypes: Bool))

Describing a Project Type

• var projectType: PHProjectType
• var localizedTitle: String
• var localizedDescription: String?
• var localizedAttributedDescription: NSAttributedString?
• var image: NSImage?
• [var subtypeDescriptions: [PHProjectTypeDescription]](/documentation/photosui/phprojecttypedescription/subtypedescriptions)
• var canProvideSubtypes: Bool

• PHProjectTypeDescriptionDataSource

Providing Required Fields

• [func subtypes(for: PHProjectType) -> [PHProjectTypeDescription]](/documentation/photosui/phprojecttypedescriptiondatasource/subtypes(for:))
• func typeDescription(for: PHProjectType) -> PHProjectTypeDescription?)
• func footerText(forSubtypesOf: PHProjectType) -> NSAttributedString?)

Responding to Removal

• func extensionWillDiscardDataSource())

• PHProjectTypeDescriptionInvalidator

Invalidating a Project Type

• func invalidateTypeDescription(for: PHProjectType))
• func invalidateFooterText(forSubtypesOf: PHProjectType))

• PHProjectInfo.CreationSource

Project Sources

• case undefined
• case userSelection
• case album
• case memory
• case moment
• case project
• case projectBook
• case projectCalendar
• case projectCard
• case projectPrintOrder
• case projectSlideshow
• case projectExtension

Initializers

• init?(rawValue: Int))

Creating a Project from an Apple Print Product

• var brandingEnabled: Bool
• var pageNumbersEnabled: Bool
• var productIdentifier: String?
• var themeIdentifier: String?

• PHProjectExtensionContext

Accessing the Project and the Photo Library

• var project: PHProject
• var photoLibrary: PHPhotoLibrary

Updating Assets

• func showEditor(for: PHAsset))
• func updatedProjectInfo(from: PHProjectInfo?, completion: (PHProjectInfo?) -> Void) -> Progress)

• PHProjectElement

Subclassing Project Elements

• PHProjectAssetElement

Characterizing an Asset Element

• var annotation: String
• var cloudAssetIdentifier: PHCloudIdentifier
• var cropRect: CGRect
• [var regionsOfInterest: [PHProjectRegionOfInterest]](/documentation/photosui/phprojectassetelement/regionsofinterest)
• var horizontallyFlipped: Bool
• var verticallyFlipped: Bool

• PHProjectTextElement

Describing a Text Element

• var text: String
• var attributedText: NSAttributedString?
• var textElementType: PHProjectTextElement.ElementType
• PHProjectTextElement.ElementType

Types of Text Elements

• case body
• case title
• case subtitle

Initializers

• init?(rawValue: Int))

• PHProjectJournalEntryElement

Describing a Journal Entry

• var date: Date
• var assetElement: PHProjectAssetElement?
• var textElement: PHProjectTextElement?

• PHProjectMapElement

Pinpointing the Map

• var mapType: MKMapType
• var centerCoordinate: CLLocationCoordinate2D
• var heading: CLLocationDirection
• var pitch: CGFloat
• var altitude: CLLocationDistance
• [var annotations: [any MKAnnotation]](/documentation/photosui/phprojectmapelement/annotations)

Describing Project Elements

• var weight: Double
• var placement: CGRect

• PHProjectSection

Determining Section Contents

• var title: String
• [var sectionContents: [PHProjectSectionContent]](/documentation/photosui/phprojectsection/sectioncontents)
• PHProjectSectionContent

Determining Content Properties

• [var elements: [PHProjectElement]](/documentation/photosui/phprojectsectioncontent/elements)
• var numberOfColumns: Int
• var aspectRatio: Double
• [var cloudAssetIdentifiers: [PHCloudIdentifier]](/documentation/photosui/phprojectsectioncontent/cloudassetidentifiers)
• var backgroundColor: NSColor?

Defining the Section Type

• var sectionType: PHProjectSection.SectionType
• PHProjectSection.SectionType

Section Types

• case undefined
• case cover
• case content
• case auxiliary

Initializers

• init?(rawValue: Int))

• PHProjectRegionOfInterest

Identifying Regions of Interest

• PHProjectRegionOfInterest.Identifier

Initializing an Identifier

• init(String))
• init(rawValue: String))

Determining Region Properties

• var rect: CGRect
• var identifier: PHProjectRegionOfInterest.Identifier
• var weight: Double
• var quality: Double

• PHProjectChangeRequest
• PHProjectExtensionController

Tracking the Project Extension Life Cycle

• func beginProject(with: PHProjectExtensionContext, projectInfo: PHProjectInfo, completion: ((any Error)?) -> Void))
• func finishProject(completionHandler: () -> Void))
• func resumeProject(with: PHProjectExtensionContext, completion: ((any Error)?) -> Void))
• func typeDescriptionDataSource(for: PHProjectCategory, invalidator: any PHProjectTypeDescriptionInvalidator) -> any PHProjectTypeDescriptionDataSource)

Defining Supported Project Types

• [var supportedProjectTypes: [PHProjectTypeDescription]](/documentation/photosui/phprojectextensioncontroller/supportedprojecttypes)

• PHProjectCategory

Creating a Project Category

• init(rawValue: String))

Designating Type Properties

• static let book: PHProjectCategory
• static let calendar: PHProjectCategory
• static let card: PHProjectCategory
• static let prints: PHProjectCategory
• static let slideshow: PHProjectCategory
• static let wallDecor: PHProjectCategory
• static let other: PHProjectCategory
• static let undefined: PHProjectCategory

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.