Commented: environment methods.

Author: oscbyspro

Sources/DiffableTextKitXUIKit/Environment+AutocorrectionDisabled.swift

@@ -12,23 +12,49 @@
 import SwiftUI
 
 //*============================================================================*
-// MARK: * Environment x Autocorrection Disabled [...]
+// MARK: * Environment x Autocorrection Disabled
 //*============================================================================*
+//=----------------------------------------------------------------------------=
+// MARK: + Keys
+//=----------------------------------------------------------------------------=
 
 @usableFromInline enum DiffableTextViews_AutocorrectionDisabled: EnvironmentKey {
     @usableFromInline static let defaultValue: Bool = false
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + Values
+//=----------------------------------------------------------------------------=
+
 extension EnvironmentValues {
     @inlinable var diffableTextViews_autocorrectionDisabled: Bool {
         get { self[DiffableTextViews_AutocorrectionDisabled.self] }
         set { self[DiffableTextViews_AutocorrectionDisabled.self] = newValue }
     }
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + View
+//=----------------------------------------------------------------------------=
+
 public extension View {
-    @inlinable func diffableTextViews_autocorrectionDisabled(_  disabled: Bool = true) -> some View {
-        environment(\.diffableTextViews_autocorrectionDisabled, disabled)
+    
+    /// Sets whether to disable autocorrection for diffable text views.
+    ///
+    /// It is similar to `View/autocorrectionDisabled(_:)`.
+    ///
+    /// ```
+    /// DiffableTextField("Text", value: $text, style: .normal)
+    ///     .diffableTextViews_autocorrectionDisabled(true)
+    /// ```
+    ///
+    /// **Notes**
+    ///
+    /// - The default value is `false`.
+    /// - This method was added for consistency.
+    ///
+    @inlinable func diffableTextViews_autocorrectionDisabled(_ disabled: Bool = true) -> some View {
+        self.environment(\.diffableTextViews_autocorrectionDisabled, disabled)
     }
 }
 

Sources/DiffableTextKitXUIKit/Environment+Font.swift

@@ -12,23 +12,54 @@
 import SwiftUI
 
 //*============================================================================*
-// MARK: * Environment x Font [...]
+// MARK: * Environment x Font
 //*============================================================================*
+//=----------------------------------------------------------------------------=
+// MARK: + Keys
+//=----------------------------------------------------------------------------=
 
 @usableFromInline enum DiffableTextViews_Font: EnvironmentKey {
     @usableFromInline static let defaultValue: DiffableTextFont? = nil
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + Values
+//=----------------------------------------------------------------------------=
+
 extension EnvironmentValues {
     @inlinable var diffableTextViews_font: DiffableTextFont? {
         get { self[DiffableTextViews_Font.self] }
         set { self[DiffableTextViews_Font.self] = newValue }
     }
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + View
+//=----------------------------------------------------------------------------=
+
 public extension View {
-    @inlinable func diffableTextViews_font(_  font: DiffableTextFont?) -> some View {
-        environment(\.diffableTextViews_font, font)
+    
+    /// Sets the default font for text in diffable text views.
+    ///
+    /// It is similar to `View/font(_:)` but uses a SwiftUI-esque system font type.
+    ///
+    /// ```
+    /// DiffableTextField("Monospaced", value: $value, style: style)
+    ///     .diffableTextViews_font(.body.monospaced())
+    /// ```
+    ///
+    /// Monospaced fonts are recommended because they make as-you-type formatting
+    /// more visually predictable. Sometimes it does not matter much, however. As-you-type
+    /// formatting with trailing text alignment works fine with just about any font,
+    /// because then the caret and/or selection does not jump around as much.
+    ///
+    /// **Notes**
+    ///
+    /// - The default value is `DiffableTextFont.body`.
+    /// - It is not yet possible to convert `SwiftUI.Font` to `UIKit.UIFont`.
+    ///
+    @inlinable func diffableTextViews_font(_ font: DiffableTextFont?) -> some View {
+        self.environment(\.diffableTextViews_font, font)
     }
 }
 

Sources/DiffableTextKitXUIKit/Environment+ForegroundColor.swift

@@ -12,23 +12,49 @@
 import SwiftUI
 
 //*============================================================================*
-// MARK: * Environment x Foreground Color [...]
+// MARK: * Environment x Foreground Color
 //*============================================================================*
+//=----------------------------------------------------------------------------=
+// MARK: + Keys
+//=----------------------------------------------------------------------------=
 
 @usableFromInline enum DiffableTextViews_ForegroundColor: EnvironmentKey {
     @usableFromInline static let defaultValue: Color? = nil
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + Values
+//=----------------------------------------------------------------------------=
+
 extension EnvironmentValues {
     @inlinable var diffableTextViews_foregroundColor: Color? {
         get { self[DiffableTextViews_ForegroundColor.self] }
         set { self[DiffableTextViews_ForegroundColor.self] = newValue }
     }
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + View
+//=----------------------------------------------------------------------------=
+
 public extension View {
-    @inlinable func diffableTextViews_foregroundColor(_  color: Color?) -> some View {
-        environment(\.diffableTextViews_foregroundColor, color)
+    
+    /// Sets the text color of diffable text views.
+    ///
+    /// It is similar to `View/foregroundColor(_:)`.
+    ///
+    /// ```
+    /// DiffableTextField("Amount", value: $amount, style: .number)
+    ///     .diffableTextViews_foregroundColor(amount > 100 ? .red : nil)
+    /// ```
+    ///
+    /// **Notes**
+    ///
+    /// - The default value is `Color.primary`.
+    /// - The `View/foregroundColor(_:)` environment value is inaccessible.
+    ///
+    @inlinable func diffableTextViews_foregroundColor(_ color: Color?) -> some View {
+        self.environment(\.diffableTextViews_foregroundColor,  color)
     }
 }
 

Sources/DiffableTextKitXUIKit/Environment+KeyboardType.swift

@@ -12,23 +12,49 @@
 import SwiftUI
 
 //*============================================================================*
-// MARK: * Environment x Keyboard Type [...]
+// MARK: * Environment x Keyboard Type
 //*============================================================================*
+//=----------------------------------------------------------------------------=
+// MARK: + Keys
+//=----------------------------------------------------------------------------=
 
 @usableFromInline enum DiffableTextViews_KeyboardType: EnvironmentKey {
     @usableFromInline static let defaultValue: UIKeyboardType = .default
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + Values
+//=----------------------------------------------------------------------------=
+
 extension EnvironmentValues {
     @inlinable var diffableTextViews_keyboardType: UIKeyboardType {
         get { self[DiffableTextViews_KeyboardType.self] }
         set { self[DiffableTextViews_KeyboardType.self] = newValue }
     }
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + View
+//=----------------------------------------------------------------------------=
+
 public extension View {
-    @inlinable func diffableTextViews_keyboardType(_  type: UIKeyboardType) -> some View {
-        environment(\.diffableTextViews_keyboardType, type)
+    
+    /// Sets the keyboard type for diffable text views.
+    ///
+    /// It is similar to `View/keyboardType(_:)`.
+    ///
+    /// ```
+    /// TextField("Amount", value: $amount, style: .currency("USD"))
+    ///     .keyboardType(.decimalPad)
+    /// ```
+    ///
+    /// **Notes**
+    ///
+    /// - The default value is `UIKeyboardType.default`.
+    /// - The `View/keyboardType(_:)` environment value is inaccessible.
+    ///
+    @inlinable func diffableTextViews_keyboardType(_ type: UIKeyboardType) -> some View {
+        self.environment(\.diffableTextViews_keyboardType, type)
     }
 }
 

Sources/DiffableTextKitXUIKit/Environment+MultilineTextAlignment.swift

@@ -12,23 +12,49 @@
 import SwiftUI
 
 //*============================================================================*
-// MARK: * Environment x Multiline Text Alignment [...]
+// MARK: * Environment x Multiline Text Alignment
 //*============================================================================*
+//=----------------------------------------------------------------------------=
+// MARK: + Keys
+//=----------------------------------------------------------------------------=
 
 @usableFromInline enum DiffableTextViews_MultilineTextAlignment: EnvironmentKey {
     @usableFromInline static let defaultValue: TextAlignment = .leading
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + Values
+//=----------------------------------------------------------------------------=
+
 extension EnvironmentValues {
     @inlinable var diffableTextViews_multilineTextAlignment: TextAlignment {
         get { self[DiffableTextViews_MultilineTextAlignment.self] }
         set { self[DiffableTextViews_MultilineTextAlignment.self] = newValue }
     }
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + View
+//=----------------------------------------------------------------------------=
+
 public extension View {
-    @inlinable func diffableTextViews_multilineTextAlignment(_  alignment: TextAlignment) -> some View {
-        environment(\.diffableTextViews_multilineTextAlignment, alignment)
+    
+    /// Sets the alignment of text a diffable text view.
+    ///
+    /// It is similar to `View/multilineTextAlignment(_:)`.
+    ///
+    /// ```
+    /// DiffableTextField("Amount", value: $value, style: .number)
+    ///     .multilineTextAlignment(.trailing)
+    /// ```
+    ///
+    /// **Notes**
+    ///
+    /// - The default value is `TextAlignment.leading`.
+    /// - This method was added for consistency.
+    ///
+    @inlinable func diffableTextViews_multilineTextAlignment(_ alignment: TextAlignment) -> some View {
+        self.environment(\.diffableTextViews_multilineTextAlignment, alignment)
     }
 }
 

Sources/DiffableTextKitXUIKit/Environment+OnSubmit.swift

@@ -31,10 +31,23 @@ public extension View {
 
     /// Adds an action to perform when the user submits a value to this view.
     ///
-    /// DiffableTextViews trigger this action when the user hits the return key.
+    /// It is similar to `View/onSubmit(_:)`.
     ///
-    @inlinable func diffableTextViews_onSubmit(_  action: (() -> Void)?) -> some View {
-        environment(\.diffableTextViews_onSubmit, action.map(Trigger.init))
+    /// ```
+    /// DiffableTextField("Username", text: $username, style: .normal)
+    ///     .onSubmit {
+    ///         guard model.validate() else { return }
+    ///         model.login()
+    ///     }
+    /// ```
+    ///
+    /// **Notes**
+    ///
+    /// - The action triggers when the user hits the return key.
+    /// - The `View/onSubmit(_:)` environment value is inaccessible.
+    ///
+    @inlinable func diffableTextViews_onSubmit(_ action: (() -> Void)?) -> some View {
+        self.environment(\.diffableTextViews_onSubmit, action.map(Trigger.init))
     }
 }
 

Sources/DiffableTextKitXUIKit/Environment+SubmitLabel.swift

@@ -12,23 +12,49 @@
 import SwiftUI
 
 //*============================================================================*
-// MARK: * Environment x Submit Label [...]
+// MARK: * Environment x Submit Label
 //*============================================================================*
+//=----------------------------------------------------------------------------=
+// MARK: + Keys
+//=----------------------------------------------------------------------------=
 
 @usableFromInline enum DiffableTextViews_SubmitLabel: EnvironmentKey {
     @usableFromInline static let defaultValue: UIReturnKeyType = .default
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + Values
+//=----------------------------------------------------------------------------=
+
 extension EnvironmentValues {
     @inlinable var diffableTextViews_submitLabel: UIReturnKeyType {
         get { self[DiffableTextViews_SubmitLabel.self] }
         set { self[DiffableTextViews_SubmitLabel.self] = newValue }
     }
 }
 
+//=----------------------------------------------------------------------------=
+// MARK: + View
+//=----------------------------------------------------------------------------=
+
 public extension View {
-    @inlinable func diffableTextViews_submitLabel(_  label: UIReturnKeyType) -> some View {
-        environment(\.diffableTextViews_submitLabel, label)
+    
+    /// Sets the submit label for diffable text views.
+    ///
+    /// It is similar to `View/submitLabel(_:)`.
+    ///
+    /// ```
+    /// DiffableTextField("Prints on submit...", value: $value, style: style)
+    ///     .diffableTextViews_submitLabel(.return)
+    /// ```
+    ///
+    /// **Notes**
+    ///
+    /// - The default value is `UIReturnKeyType.default`.
+    /// - The `View/submitLabel(_:)` environment value is inaccessible.
+    ///
+    @inlinable func diffableTextViews_submitLabel(_ label: UIReturnKeyType) -> some View {
+        self.environment(\.diffableTextViews_submitLabel, label)
     }
 }