https://github.com/d-32/dmpasscode
:lock: Passcode screen with Touch ID support
https://github.com/d-32/dmpasscode
ios passcode touchid
Last synced: 14 days ago
JSON representation
:lock: Passcode screen with Touch ID support
- Host: GitHub
- URL: https://github.com/d-32/dmpasscode
- Owner: D-32
- License: mit
- Created: 2014-09-20T07:10:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-08-26T20:23:41.000Z (over 5 years ago)
- Last Synced: 2025-05-07T21:18:37.388Z (15 days ago)
- Topics: ios, passcode, touchid
- Language: Objective-C
- Homepage:
- Size: 795 KB
- Stars: 158
- Watchers: 6
- Forks: 39
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DMPasscode
[](https://travis-ci.org/D-32/DMPasscode)
[](http://cocoadocs.org/docsets/DMPasscode)
[](https://twitter.com/dylan36032)
A simple passcode screen that can be displayed manually. If Touch ID is available the user can skip the screen and instead use his fingerprint to unlock.
Can easily be customised to fit your design.
## Installation
DMPasscode is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
pod "DMPasscode"
If you're not using CocoaPods you'll find the source code files inside `Pod/Classes`. You'll also have to add the `DMPasscode.bundle` to your project.
## Usage
To run the example project, clone the repo, and run `pod install` from the Example directory first.
The class `DMPasscode` contains following methods:
+ (void)setupPasscodeInViewController:(UIViewController *)viewController completion:(PasscodeCompletionBlock)completion;
+ (void)showPasscodeInViewController:(UIViewController *)viewController completion:(PasscodeCompletionBlock)completion;
+ (void)removePasscode;
+ (BOOL)isPasscodeSet;
+ (void)setConfig:(DMPasscodeConfig *)config;
#### PasscodeCompletionBlock(BOOL success, NSError *error)
PasscodeCompletionBlock is a custom type of block provided to `DMPasscode` that returns values in the form of two parameters, a `BOOL success` and a `NSError *error`.
If `success`, then the user has successfully either setup their passcode, or successfully unlocked with their passcode.
If not `success`, then the user has either cancelled the passcode process, in which case `error` will be nil. Or the user has failed to unlock with their passcode, in
which case `error` will not be nil.
## Customisation
You can pass `DMPasscode` a configuration. Just create a new `DMPasscodeConfiguration`.
Following properties are available to customise the passcode screen:
animationsEnabled
backgroundColor
navigationBarBackgroundColor
navigationBarForegroundColor
statusBarStyle
fieldColor
emptyFieldColor
errorFont
errorBackgroundColor
errorForegroundColor
descriptionColor
inputKeyboardAppearance
instructionsFont
navigationBarTitle
navigationBarFont
navigationBarTitleColor