Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hollyoops/reactiveform
A simple and validatable form for Swift and SwiftUI
https://github.com/hollyoops/reactiveform
combine form reactive swift5 swiftui validation
Last synced: 2 days ago
JSON representation
A simple and validatable form for Swift and SwiftUI
- Host: GitHub
- URL: https://github.com/hollyoops/reactiveform
- Owner: hollyoops
- License: mit
- Created: 2021-12-23T03:46:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-12T16:22:14.000Z (over 2 years ago)
- Last Synced: 2024-04-14T13:04:42.566Z (6 months ago)
- Topics: combine, form, reactive, swift5, swiftui, validation
- Language: Swift
- Homepage:
- Size: 76.2 KB
- Stars: 41
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReactiveForm
[](https://github.com/hollyoops/ReactiveForm/actions/workflows/main.yml) [](https://codecov.io/gh/hollyoops/ReactiveForm)
A flexible and extensible forms with easy-to-use validation. This library build for `SwiftUI` and inspired by [Reactive forms of Angular](https://angular.io/guide/reactive-forms).
## Installation
- [**Swift Package Manager**](https://swift.org/package-manager/)
1. In Xcode, open your project and navigate to **File** → **Swift Packages** → **Add Package Dependency...**
2. Paste the repository URL (`https://github.com/hollyoops/ReactiveForm.git`) and finish import
- [**CocoaPods**](https://cocoapods.org)
ReactiveForm is available through CocoaPods. To install it, simply add the following code to your Podfile:
```ruby
pod 'ReactiveForm'
```
## Usage
### Define fields with property wrapper
```swift
import SwiftUI
import ReactiveForm
class ProfileForm: ObservableForm {
@FormField(validators: [.required])
var name = ""
@FormField(validators: [.required, .email])
var email = ""
}
struct ContentView: View {
@StateObject var form = ProfileForm()
var body: some View {
Form {
TextField("Name", text: $form.firstName)
if form.$name.isInValid {
Text("Please fill a name.")
.foregroundColor(.red)
}
TextField("Email", text: $form.email)
if form.$email.isInValid {
Text("Please fill a valid email")
.foregroundColor(.red)
}
}
}
}
```
### Customize validator
```swift
let stringValidator = Validator { stringValue: String -> Bool
// some check logic
return true
}
class ProfileForm: ObservableForm {
@FormField(validators: [.required, stringValidator])
var name = ""
}
```
### Creating a form model
You are not a big fan of property wrapper, you can build a form using ``ObservableForm`` and ``FormControl``.
```swift
class ProfileForm: ObservableForm {
var name = FormControl("", validators: [.required])
var email = FormControl("", validators: [.required, .email])
}
```
### Validating manually
For some case, you may need to manually call `validate` rather than validate on change
```swift
class ProfileForm: ObservableForm {
@FormField("", validators: [.required], type: .manually)
var name: String
@FormField("", validators: [.email], type: .manually)
var email: String
}
struct ContentView: View {
@StateObject var form = ProfileForm()
var body: some View {
Form {
TextField("Name", text: $form.name.pendingValue)
if form.$name.errors[.required] {
Text("Please fill a name.")
.foregroundColor(.red)
}
TextField("Email", text: $form.email.pendingValue)
if form.$email.errors[.email] {
Text("Please fill a valid email.")
.foregroundColor(.red)
}
Button(action: submit) {
Text("Submit")
}
}
}
func submit() {
// You can call `validate` manually
form.validate()
if form.isValid {
print(form)
}
}
}
```
### Use Dirty to check form status
You can use `isDirty` & `isPristine` to check where form is edited.
One possible scenario is when page appear you don't want to show error util form is edited.
```swift
class SettingsForm: ObservableForm {
var name = FormControl("", validators: [.required], type: .manually)
var email = FormControl("", validators: [.email], type: .manually)
}
struct ContentView: View {
@StateObject var form = SettingsForm()
var body: some View {
Form {
TextField("Name", text: $form.name.value)
if form.name.isDirty && form.name.errors[.required] {
Text("Please fill a name.")
.foregroundColor(.red)
}
TextField("Email", text: $form.email.value)
if form.email.isDirty && form.email.errors[.email] {
Text("Please fill a valid email.")
.foregroundColor(.red)
}
Button(action: submit) {
Text("Submit")
}
.disabled(form.isInvalid)
}
}
}
```
## Documentation
[](https://app.netlify.com/sites/frosty-yonath-df6e87/deploys)
[Docs for ReactiveForm](https://frosty-yonath-df6e87.netlify.app/documentation/).
## License
[MIT](LICENSE)