FUISignatureCaptureController

@MainActor
open class FUISignatureCaptureController : UIViewController

This view controller is to host a signature capture view for user to sign.

Here is a code snippet how to use this FUISignatureCaptureController.


let signatureCaptureController = FUISignatureCaptureController.createInstance()
signatureCaptureController.delegate = self
let navController = signatureCaptureController.navigationController ?? UINavigationController(rootViewController: signatureCaptureController)
navController.modalPresentationStyle = .formSheet
self.navigationController?.present(navController, animated: true, completion: nil)

Theming

Supported TEXT class paths:

fdlFUISignatureCaptureController_title {}

Supported TEXT properties:

font-color: (Color)
font-style: (UIFontTextStyle)

Supported BarButtonItem class paths:

fdlFUISignatureCaptureController_cancelButtonItem
fdlFUISignatureCaptureController_clearButtonItem
fdlFUISignatureCaptureController_doneButtonItem
fdlFUISignatureCaptureController_closeButtonItem
fdlFUISignatureCaptureController_reenterSignatureButtonItem

Supported UIBarButtonItem properties:

font-color { -disabled } (Color)
font-style: { -disabled } (UIFontTextStyle)
image { -disabled } (Image)

Supported UINavigationBar class paths:

fdlFUISignatureCaptureController_navigationBar

Supported UINavigationBar properties:

background-color: (Color)

Supported UIToolBar class paths:

fdlFUISignatureCaptureController_toolBar

Supported UIToolBar properties:

background-color: (Color)

  • The FUISignatureCaptureView for this FUISignatureCaptureController.

    Declaration

    Swift

    @IBOutlet
@MainActor
weak public private(set) var signatureCaptureView: FUISignatureCaptureView! { get }

  • Set usesCompactSignature to true to remove signature whitespace

    Declaration

    Swift

    @MainActor
open var usesCompactSignature: Bool? { get set }

  • The Cancel button on the navigation bar.

    This button is shown when user enter the signature. Tapping this button to indicate that user cancels the signing.

    Declaration

    Swift

    @IBOutlet
@MainActor
public private(set) var cancelButton: UIBarButtonItem! { get }

  • The “Done” button on the navigation bar.

    This button is shown when user enters the signature. Tapping this button to indicate that user has finished entering the signature.

    Declaration

    Swift

    @IBOutlet
@MainActor
public private(set) var doneButton: UIBarButtonItem! { get }

  • The “Clear” button on the bottom of the screen.

    This button is shown when user enters the signature. Tapping this button to clear the drawing on the signature pad for user to start entering signature from blank again.

    Declaration

    Swift

    @IBOutlet
@MainActor
public private(set) var clearButton: UIBarButtonItem! { get }

  • The “Close” botton on the navigation bar.

    This button is shown when displaying a saved signature image. Tapping this button will invoke the delegate’s didCancelSignatureCaptureController. The developer should close this controller.

    Declaration

    Swift

    @MainActor
public private(set) var closeButton: UIBarButtonItem { get }

  • The “Re-Enter Signature” button on the bottom of the screen.

    This button is shown when displaying a saved signature image. Tapping this button will change the controller to display the blank signature capture drawing pad for user to enter signature.

    Declaration

    Swift

    @MainActor
public private(set) var reenterSignatureButton: UIBarButtonItem { get }

  • The FUISignatureCaptureControllerDelegate for this FUISignatureCaptureController.

    Declaration

    Swift

    @MainActor
open weak var delegate: FUISignatureCaptureControllerDelegate?

  • Creates an instance of FUISignatureCaptureController.

    Declaration

    Swift

    @MainActor
public class func createInstance() -> FUISignatureCaptureController

    Return Value

    The newly created FUISignatureCaptureController instance.