AnyFormatKit 使用教程

AnyFormatKit 使用教程

AnyFormatKitSimple text formatting in Swift项目地址:https://gitcode.com/gh_mirrors/an/AnyFormatKit

1. 项目介绍

AnyFormatKit 是一个用于 Swift 的简单文本格式化库。它支持多种文本格式化需求，如电话号码格式化、货币格式化等。AnyFormatKit 提供了灵活的 API，使得开发者可以轻松地将格式化功能集成到他们的应用程序中。

2. 项目快速启动

2.1 安装 AnyFormatKit

使用 CocoaPods 安装

在你的 Podfile 中添加以下行：

pod 'AnyFormatKit', '~> 2.5.2'

然后运行以下命令：

$ pod install

使用 Swift Package Manager 安装

在你的 Swift 包管理器配置文件中添加以下依赖：

dependencies: [
    .package(url: "https://github.com/luximetr/AnyFormatKit.git", from: "2.5.2")
]

2.2 基本使用

导入 AnyFormatKit 并使用 DefaultTextInputFormatter 进行文本格式化：

import AnyFormatKit

// 创建格式化器
let phoneFormatter = DefaultTextInputFormatter(textPattern: "### (###) ###-##-##")

// 创建文本输入控制器
let phoneInputController = TextFieldInputController()
textField.delegate = phoneInputController
phoneInputController.formatter = phoneFormatter

// 获取格式化后的文本
let formattedText = phoneFormatter.format("51013442551") // 输出: "+51 (013) 442-55-11"

3. 应用案例和最佳实践

3.1 电话号码格式化

在许多应用程序中，电话号码的格式化是一个常见的需求。使用 AnyFormatKit，你可以轻松地实现这一功能：

let phoneFormatter = DefaultTextInputFormatter(textPattern: "### (###) ###-##-##")
let formattedPhoneNumber = phoneFormatter.format("51013442551") // 输出: "+51 (013) 442-55-11"

3.2 货币格式化

AnyFormatKit 还支持货币格式化，适用于金融类应用：

let currencyFormatter = DefaultTextInputFormatter(textPattern: "#,###.##")
let formattedAmount = currencyFormatter.format("1234567.89") // 输出: "1,234,567.89"

4. 典型生态项目

AnyFormatKit 是一个独立的库，主要用于文本格式化。它不依赖于其他特定的生态项目，但可以与其他 UI 组件库（如 SwiftUI 或 UIKit）结合使用，以增强用户体验。

4.1 与 SwiftUI 结合使用

AnyFormatKit 提供了 SwiftUI 版本，名为 AnyFormatKitSwiftUI。你可以通过以下方式集成：

import SwiftUI
import AnyFormatKitSwiftUI

struct ContentView: View {
    @State var text = ""

    var body: some View {
        FormatTextField(
            unformattedText: $text,
            textPattern: "### (###) ###-##-##"
        )
    }
}

4.2 与 UIKit 结合使用

对于 UIKit 项目，你可以直接使用 AnyFormatKit 提供的 DefaultTextInputFormatter 和 TextFieldInputController 来实现文本格式化。

import UIKit
import AnyFormatKit

class ViewController: UIViewController, UITextFieldDelegate {
    let phoneFormatter = DefaultTextInputFormatter(textPattern: "### (###) ###-##-##")

    override func viewDidLoad() {
        super.viewDidLoad()
        let textField = UITextField()
        textField.delegate = self
        view.addSubview(textField)
    }

    func textField(_ textField: UITextField, shouldChangeCharactersIn range: NSRange, replacementString string: String) -> Bool {
        let result = phoneFormatter.formatInput(currentText: textField.text ?? "", range: range, replacementString: string)
        textField.text = result.formattedText
        return false
    }
}

通过以上步骤，你可以轻松地将 AnyFormatKit 集成到你的项目中，并实现各种文本格式化需求。

AnyFormatKitSimple text formatting in Swift项目地址:https://gitcode.com/gh_mirrors/an/AnyFormatKit