Custom PDF Page Labels in the Sharing UI in Swift for iOS

1
//
2
//  Copyright © 2021-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
class PageLabelsInSharingExample: Example {
12

13
    override init() {
14
        super.init()
15

16
        title = "Show Page Labels in the Sharing UI"
17
        contentDescription = "Shows how to display page labels instead of page numbers in the sharing UI."
18
        category = .sharing
19
        priority = 900
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        let document = AssetLoader.document(for: .welcome)
24

25
        let pdfViewController = PDFViewController(document: document) { mainConfiguration in
26
            mainConfiguration.sharingConfigurations = mainConfiguration.sharingConfigurations.map { sharingConfiguration in
27
                sharingConfiguration.configurationUpdated { sharingConfigurationBuilder in
28

29
                    /*
30
                     By default Nutrient displays page numbers in the sharing UI for picking a page range and
31
                     showing the selected pages. This ensures the UI is easy to understand for any document.
32
                     You can use `pageDescriptionProvider` and `selectedPagesDescriptionProvider` to customize
33
                     these strings. This example shows how to display the page labels set in the PDF instead.
34
                     */
35

36
                    sharingConfigurationBuilder.pageDescriptionProvider = { pageIndex, document in
37
                        document.pageLabelForPage(at: pageIndex, substituteWithPlainLabel: true)!
38
                    }
39

40
                    let originalSelectedPagesDescriptionProvider = sharingConfigurationBuilder.selectedPagesDescriptionProvider
41

42
                    sharingConfigurationBuilder.selectedPagesDescriptionProvider = { selectedPages in
43
                        switch selectedPages {
44
                        case .all, .annotated:
45
                            // Use the default Nutrient implementation.
46
                            return originalSelectedPagesDescriptionProvider(selectedPages)
47
                        case .current(let currentPageIndex, let document):
48
                            // Show the page label instead of the page number.
49
                            // Not shown here, but you should localize this string using NSLocalizedString.
50
                            return String.localizedStringWithFormat("Current Page (%@)", document.pageLabelForPage(at: currentPageIndex, substituteWithPlainLabel: true)!)
51
                        case .range(let selectedPageIndexes, let document):
52
                            // Show the page labels instead of the page numbers.
53
                            // Not shown here, but you should localize this string using NSLocalizedString.
54
                            // This only shows supporting a single range in the index set. In practice,
55
                            // the Nutrient UI only allows setting a single range for now so this is fine.
56
                            return String.localizedStringWithFormat(
57
                                "Pages %@–%@",
58
                                document.pageLabelForPage(at: PageIndex(selectedPageIndexes.first!), substituteWithPlainLabel: true)!,
59
                                document.pageLabelForPage(at: PageIndex(selectedPageIndexes.last!), substituteWithPlainLabel: true)!
60
                            )
61
                        }
62
                    }
63
                }
64
            }
65
        }
66

67
        return pdfViewController
68
    }
69
}