KeyboardAvoider 项目技术文档
安装指南
使用 Swift Package Manager 安装
- 创建一个
Package.swift
文件。 - 在
Package.swift
文件中添加以下内容:
import PackageDescription
let package = Package(
name: "TestProject",
dependencies: [
.package(url: "https://github.com/michaelhenry/KeyboardAvoider.git", from: "1.0.0")
]
)
使用 Cocoapods 安装
- 在项目的
Podfile
文件中添加以下内容:
target 'MyApp' do
pod 'KeyboardAvoider', '~> 1.0'
end
- 运行
pod install
命令进行安装。
项目的使用说明
基本使用
在 SwiftUI 中使用 KeyboardAvoider
可以自动滚动到当前的 TextField
,并避免键盘遮挡输入框。
import KeyboardAvoider
KeyboardAvoider {
// ... 你的视图,包含 TextFields
}
示例:
KeyboardAvoider {
VStack {
TextField("First name", text: self.$firstname)
TextField("Last name", text: self.$lastname)
TextField("Email", text: self.$email)
TextField("Password", text: self.$password)
TextField("Confirm password", text: self.$password)
Button("Sign Up") {
}
Button("Already have an account?") {
}
}
.padding(.horizontal, 16.0)
}
非滚动视图使用
如果你不希望视图可滚动,可以直接在主视图上应用 .avoidKeyboard()
修饰符。
VStack {
TextField("First name", text: self.$firstname)
TextField("Last name", text: self.$lastname)
TextField("Email", text: self.$email)
TextField("Password", text: self.$password)
TextField("Confirm password", text: self.$password)
Button("Sign Up") {
}
Button("Already have an account?") {
}
}
.avoidKeyboard()
项目API使用文档
KeyboardAvoider
- 描述: 一个用于 SwiftUI 的键盘避免器,自动滚动到当前的
TextField
。 - 使用方法:
KeyboardAvoider { // 你的视图,包含 TextFields }
.avoidKeyboard()
- 描述: 应用于视图的修饰符,避免键盘遮挡输入框。
- 使用方法:
VStack { // 你的视图,包含 TextFields } .avoidKeyboard()
项目安装方式
使用 Swift Package Manager
- 创建
Package.swift
文件。 - 添加依赖项:
import PackageDescription
let package = Package(
name: "TestProject",
dependencies: [
.package(url: "https://github.com/michaelhenry/KeyboardAvoider.git", from: "1.0.0")
]
)
使用 Cocoapods
- 在
Podfile
文件中添加:
target 'MyApp' do
pod 'KeyboardAvoider', '~> 1.0'
end
- 运行
pod install
命令。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考