概述

PasscodeKit 是一个轻量级且易于使用的应用内密码实现方案,适用于 iOS。

安装

CocoaPods

CocoaPods 是一个适用于 Swift 和 Objective-C Cocoa 项目的依赖管理工具。

要将 PasscodeKit 库集成到您使用 CocoaPods 的 Xcode 项目中,请在您的 Podfile 文件中引用它,如下所示

pod 'PasscodeKit'

Swift Package Manager

Swift Package Manager 是一个用于管理 Swift 代码分发的工具。

要将 PasscodeKit 作为依赖项添加到您的项目中,请按照以下步骤操作

  1. 在 Xcode 中打开您的 Swift 项目。
  2. 导航到 File -> Add Package Dependencies...
  3. https://github.com/relatedcode/PasscodeKit.git 粘贴到搜索栏中。
  4. 选择您想要使用的版本,然后点击 Add Package

手动

如果您不想使用任何依赖管理器,您可以手动将 PasscodeKit 集成到您的项目中。只需将 PasscodeKit/Sources 文件夹中的所有 *.swift 文件复制到您的 Xcode 项目中。

系统要求

快速上手

要在您的代码库中激活 PasscodeKit,您需要在应用程序启动后立即启动它。最佳实践是在 AppDelegate 的 didFinishLaunchingWithOptions 方法中执行此操作。

PasscodeKit.start()

以下 PasscodeKitDelegate 方法可用于执行与 PasscodeKit 用户活动相关的操作。

func passcodeCheckedButDisabled()

func passcodeEnteredSuccessfully()

func passcodeMaximumFailedAttempts()

要启用、禁用密码功能或更改已保存的密码,您可以使用以下方法。

PasscodeKit.createPasscode(self)

PasscodeKit.changePasscode(self)

PasscodeKit.removePasscode(self)

自定义

以下设置可用于自定义与密码相关的用户体验。

PasscodeKit.passcodeLength = 4

PasscodeKit.allowedFailedAttempts = 3
PasscodeKit.textColor = .darkText
PasscodeKit.backgroundColor = .lightGray

PasscodeKit.failedTextColor = .white
PasscodeKit.failedBackgroundColor = .systemRed
PasscodeKit.titleEnterPasscode = "Enter Passcode"
PasscodeKit.titleCreatePasscode = "Create Passcode"
PasscodeKit.titleChangePasscode = "Change Passcode"
PasscodeKit.titleRemovePasscode = "Remove Passcode"

PasscodeKit.textEnterPasscode = "Enter your passcode"
PasscodeKit.textVerifyPasscode = "Verify your passcode"
PasscodeKit.textEnterOldPasscode = "Enter your old passcode"
PasscodeKit.textEnterNewPasscode = "Enter your new passcode"
PasscodeKit.textVerifyNewPasscode = "Verify your new passcode"
PasscodeKit.textFailedPasscode = "%d Failed Passcode Attempts"
PasscodeKit.textPasscodeMismatch = "Passcodes did not match. Try again."
PasscodeKit.textTouchIDAccessReason = "Please use Touch ID to unlock the app"

配置

PasscodeKit 支持 TouchID 和 FaceID。如果您正在使用 FaceID,请务必将 NSFaceIDUsageDescription 详细信息添加到您的 Info.plist 文件中。

许可证

MIT 许可证

版权所有 (c) 2023 Related Code

特此授权,免费授予任何人获得本软件和相关文档文件(“软件”)副本的许可,以不受限制地处理本软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利,并允许向已获得软件的人员授予该等许可,但须符合以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供,不提供任何形式的明示或暗示的保证,包括但不限于适销性、特定用途的适用性和不侵权的保证。在任何情况下,作者或版权持有人均不对任何索赔、损害或其他责任负责,无论是在合同诉讼、侵权诉讼或其他诉讼中,因本软件或本软件的使用或其他交易而产生、源于本软件或与之相关。