Merge pull request #6 from ricocrescenzio95/2-unify-formatter-and-par…

…seableformatstyle Unify formatter and parseableFormatStyle/Formatter
ricocrescenzio95 · Apr 15, 2022 · ea2c26c · ea2c26c
2 parents a5e9431 + 3a8ba92
commit ea2c26c
Show file tree

Hide file tree

Showing 5 changed files with 185 additions and 31 deletions.
diff --git a/SUITextFieldExample/SUITextFieldExample/ContentView.swift b/SUITextFieldExample/SUITextFieldExample/ContentView.swift
@@ -87,6 +87,7 @@ struct ContentView: View {
                         SUITextField(
                             value: $myDouble,
                             format: .number,
+                            formatPolicy: .onChange,
                             placeholder: AttributedString("Hey there")
                                 .mergingAttributes(AttributeContainer(placeholderAttributes))
                         )

diff --git a/Sources/SwiftUITextField/SwiftUITextField.docc/SUITextField.md b/Sources/SwiftUITextField/SwiftUITextField.docc/SUITextField.md
@@ -2,6 +2,25 @@
 
 ## Topics
 
+### Creating a text field with a string
+
+- ``SUITextField/init(text:placeholder:)-5btu0``
+- ``SUITextField/init(text:placeholder:)-7334w``
+- ``SUITextField/init(text:placeholder:)-9p6by``
+
+### Creating a text field with a value (iOS 15)
+
+- ``SUITextField/init(value:format:formatPolicy:placeholder:defaultValue:)-3i36v``
+- ``SUITextField/init(value:format:formatPolicy:placeholder:defaultValue:)-5fdb3``
+- ``SUITextField/init(value:format:formatPolicy:placeholder:)-9l23l``
+- ``SUITextField/init(value:format:formatPolicy:placeholder:)-2bhgs``
+- ``FormatPolicy``
+
+### Creating a text field with a value (pre-iOS 15)
+
+- ``SUITextField/init(value:formatter:formatPolicy:placeholder:defaultValue:)-3wopi``
+- ``SUITextField/init(value:formatter:formatPolicy:placeholder:defaultValue:)-1cub1``
+
 ### Modify style and behaviors
 
 - <doc:EnvironmentModifiers>

diff --git a/Sources/SwiftUITextField/SwiftUITextField.docc/SwiftUITextField.md b/Sources/SwiftUITextField/SwiftUITextField.docc/SwiftUITextField.md
@@ -84,7 +84,6 @@ formatters. Check all the provided initializers in ``SUITextField``!
 - ``ResponderState``
 - ``ResponderChainCoordinator``
 
-
 ### Miscellaneous 
 
 - ``CharacterReplacement``

diff --git a/Sources/SwiftUITextField/TextField/FormatPolicy.swift b/Sources/SwiftUITextField/TextField/FormatPolicy.swift
@@ -0,0 +1,20 @@
+//
+//  FormatPolicy.swift
+//  
+//
+//  Created by Rico Crescenzio on 15/04/22.
+//
+
+import Foundation
+
+/// Indicates when the bound value is updated on a ``SUITextField`` with format/formatter.
+///
+/// Policy can specify when the conversion is made, either during typing or when text field did end editing.
+public enum FormatPolicy {
+
+    /// Parses the text to bound value on every text insertion.
+    case onChange
+
+    /// Parses the text to bound value when text field end editing.
+    case onCommit
+}