Skip to content

keepworks/KWVerificationCodeView

Repository files navigation

KWVerificationCodeView

Build Status Version License Platform

A customisable verification code view with built in validation. Can be used for one time passwords (OTPs), email verification codes etc.

Screenshot

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

  • iOS 12 or later
  • Swift 5.0
  • Latest Xcode

Installation

KWVerificationCodeView is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "KWVerificationCodeView"

Or for Swift 4.2 support use

pod "KWVerificationCodeView", '0.3.0'

Or for Swift 4 use:

pod "KWVerificationCodeView", '0.2.0'

Usage

Add a UIView in your Storyboard and change the class to KWVerificationCodeView. You can set the properties in the Attributes Inspector and see a live preview:

Interface Builder Screenshot

The properties which can be directly set in the Attributes Inspector and their default values are as follows:

  • Underline Color - Dark Gray Color

  • Underline Selected Color - Black Color

  • Text Color - Dark Text Color

  • Digits - 4

  • Text Size - 24.0

  • Text Font - System Font

  • Text Field Background Color - Clear Color

  • Text Field Tint Color - Blue Color

  • Dark Keyboard - Default Keyboard Appearance

Customizable properties

  • keyboardType - Sets the keyboard type (Defaults to Number Pad when not set)

    verificationCodeView.keyboardType = UIKeyboardType.emailAddress
    

Variables

The KWVerificationCodeView has the following variables:

isTappable: Bool

Makes the KWVerficationCodeView tappable. Default value is false

Methods

The KWVerificationCodeView has the following methods:

hasValidCode() -> Bool

Returns true when the entered code is valid.

getVerificationCode() -> String

Returns the validation code.

set(code: String)

Set verification code programatically by passing code as a string

focus()

Focus on First Text Field

clear()

Clears the verification code view and first field becomes first responder

Protocols

KWVerificationCodeViewDelegate

KWVerificationCodeViewDelegate protocol has the following method:

didChangeVerificationCode()

Notifies that the text in KWVerificationCodeView has been changed. This is especially useful in situations where you have to enable the submit button only if the verification code is valid.

Author

KeepWorks, [email protected]

Credits

KWVerificationCodeView is owned and maintained by KeepWorks.

N|Solid

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/keepworks/KWVerificationCodeView.

License

KWVerificationCodeView is available under the MIT License. See the License file for more info.