PasscodeLock
A Swift implementation of passcode lock for iOS with TouchID authentication.
Installation
PasscodeLock requires Swift 4.0 and Xcode 9
Carthage
Add the following line to your Cartfile
github "yankodimitrov/SwiftPasscodeLock"
Usage
-
Create an implementation of the
PasscodeRepositoryType
protocol. -
Create an implementation of the
PasscodeLockConfigurationType
protocol and set your preferred passcode lock configuration options. If you set themaximumInccorectPasscodeAttempts
to a number greather than zero when the user reaches that number of incorrect passcode attempts a notification with namePasscodeLockIncorrectPasscodeNotification
will be posted on the defaultNSNotificationCenter
. -
Create an instance of the
PasscodeLockPresenter
class. Next inside yourUIApplicationDelegate
implementation call it to present the passcode indidFinishLaunchingWithOptions
andapplicationDidEnterBackground
methods. The passcode lock will be presented only if your user has set a passcode. -
Allow your users to set a passcode by presenting the
PasscodeLockViewController
in.SetPasscode
state:
let configuration = ... // your implementation of the PasscodeLockConfigurationType protocol
let passcodeVC = PasscodeLockViewController(state: .SetPasscode, configuration: configuration)
presentViewController(passcodeVC, animated: true, completion: nil)
You can present the PasscodeLockViewController
in one of the four initial states using the LockState
enumeration options: .EnterPasscode
, .SetPasscode
, .ChangePasscode
, .RemovePasscode
.
Also you can set the initial passcode lock state to your own implementation of the PasscodeLockStateType
protocol.
Customization
Custom Design
The PasscodeLock will look for PasscodeLockView.xib
inside your app bundle and if it can't find it will load its default one, so if you want to have a custom design create a new xib
with the name PasscodeLockView
and set its owner to an instance of PasscodeLockViewController
class and module to PasscodeLock
.
Then connect the view
outlet to the view of your xib
file and make sure to connect the remaining IBOutlet
s and IBAction
s. Also make sure to set module to PasscodeLock
on all PasscodeSignPlaceholderView
and PasscodeSignButton
in the nib.
PasscodeLock comes with two view components: PasscodeSignPlaceholderView
and PasscodeSignButton
that you can use to create your own custom designs. Both classes are @IBDesignable
and @IBInspectable
, so you can see their appearance and change their properties right inside the interface builder:
Localization
Take a look at PasscodeLock/en.lproj/PasscodeLock.strings
for the localization keys. Here again the PasscodeLock will look for the PasscodeLock.strings
file inside your app bundle and if it can't find it will use the default localization file.
Demo App
The demo app comes with a simple implementation of the PasscodeRepositoryType
protocol that is using the NSUserDefaults to store an retrieve the passcode. In your real applications you will probably want to use the Keychain API. Keep in mind that the Keychain records will not be removed when your user deletes your app.