Add a Custom Free Text Input Accessory in Swift for iOS

1
//
2
//  Copyright © 2019-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
/// Demonstrates how to configure `PDFViewController` to use a custom `inputAccessoryView` when
12
/// creating or editing `FreeTextAnnotation`. In addition, it draws attention to the key sources
13
/// of mistakes that would lead to visual glitches or no visible `inputAccessoryView` at all.
14
class CustomFreeTextInputAccessoryExample: Example {
15
    override init() {
16
        super.init()
17

18
        title = "Custom Free Text inputAccessory"
19
        category = .annotations
20
    }
21

22
    /// A FreeTextAnnotationView that installs a custom `inputAccessoryView` for editing the text of
23
    /// its annotation.
24
    ///
25
    /// The custom view is useless but very visible.
26
    class UselessInputAccessoryFreeTextAnnotationView: FreeTextAnnotationView {
27

28
        override func textViewForEditing() -> UITextView {
29
            let textView = super.textViewForEditing()
30
            // UIKit will only adjust the size if we help it a bit
31
            let uselessAccessory = UIView(frame: CGRect(origin: .zero, size: CGSize(width: 0, height: 42)))
32
            uselessAccessory.autoresizingMask = .flexibleWidth
33

34
            // For an accessory view that uses autolayout, like UIToolbar, the above would be:
35
            // let uselessAccessory = UIToolbar()
36
            // uselessAccessory.translatesAutoresizingMaskIntoConstraints = false
37

38
            // shine bright like a diamond…
39
            uselessAccessory.backgroundColor = .cyan
40

41
            // install the accessory view
42
            #if !os(visionOS)
43
            textView.inputAccessoryView = uselessAccessory
44
            #endif
45

46
            return textView
47
        }
48
    }
49

50
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController? {
51
        let document = AssetLoader.document(for: .annualReport)
52
        return PDFViewController(document: document) {
53
            // register our custom class
54
            $0.overrideClass(FreeTextAnnotationView.self, with: UselessInputAccessoryFreeTextAnnotationView.self)
55

56
            /*
57
             If we do not set this to false, Nutrient’s default accessory view will be installed in
58
             a way that makes it impossible to replace without visual glitches.
59
             */
60
            $0.freeTextAccessoryViewEnabled = false
61
        }
62
    }
63
}