Customize the PDF Search Highlight Color 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 SearchHighlightColorExample: Example {
12

13
    override init() {
14
        super.init()
15
            title = "Custom Inline Search Highlight Color"
16
            contentDescription = "Changes the search highlight color for inline search to blue via UIAppearance."
17
            category = .viewCustomization
18
            priority = 50
19
    }
20

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

24
        // We use a custom subclass of the PDFViewController to avoid polluting other examples, since UIAppearance can't be reset to the default.
25
        SearchHighlightView.appearance(whenContainedInInstancesOf: [CustomColoredSearchHighlightPDFViewController.self]).selectionBackgroundColor = UIColor.blue.withAlphaComponent(0.5)
26

27
        let pdfController = CustomColoredSearchHighlightPDFViewController(document: document) {
28
            $0.searchMode = .inline
29
        }
30

31
        // Automatically start search.
32
        DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
33
            pdfController.search(for: "Nutrient", options: nil, sender: nil, animated: true)
34
        }
35

36
        return pdfController
37
    }
38
}
39

40
// Custom empty subclass of the PDFViewController to avoid polluting other examples, since UIAppearance can't be reset to the default.
41
private class CustomColoredSearchHighlightPDFViewController: PDFViewController {
42
}
43

44
class ModalSearchHighlightColorExample: Example {
45

46
    override init() {
47
        super.init()
48
        title = "Custom Modal Search Highlight Color"
49
        contentDescription = "Changes the search highlight color to red in SearchViewController."
50
        category = .viewCustomization
51
        priority = 49
52
    }
53

54
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
55
        let document = AssetLoader.document(for: .welcome)
56

57
        let pdfController = PDFViewController(document: document) {
58
            $0.overrideClass(SearchViewController.self, with: CustomHighlightSearchViewController.self)
59
        }
60

61
        // Automatically start search.
62
        DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
63
            pdfController.search(for: "Nutrient", options: nil, sender: nil, animated: true)
64
        }
65

66
        return pdfController
67
    }
68
}
69

70
private class CustomHighlightSearchViewController: SearchViewController {
71

72
    override init(document: Document?) {
73
        super.init(document: document)
74
        highlightColor = .red
75
    }
76
}