From e02f08b41d8c5adaac41812810f9fcbb86bb04a4 Mon Sep 17 00:00:00 2001 From: Pavel Holec Date: Fri, 18 Aug 2023 08:56:47 +0200 Subject: [PATCH] Update TextField comment --- Sources/Orbit/Components/InputField.swift | 2 ++ Sources/Orbit/Support/TextFields/TextField.swift | 11 ++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/Sources/Orbit/Components/InputField.swift b/Sources/Orbit/Components/InputField.swift index d60d4a74725..78a012e1323 100644 --- a/Sources/Orbit/Components/InputField.swift +++ b/Sources/Orbit/Components/InputField.swift @@ -5,6 +5,8 @@ import UIKit /// /// When you have additional information or helpful examples, include prompt text to help users along. /// +/// The custom Orbit version of ``TextField`` component is used internally. +/// /// - Note: [Orbit definition](https://orbit.kiwi/components/inputfield/) /// - Important: Component expands horizontally unless prevented by `fixedSize` modifier. public struct InputField: View, TextFieldBuildable { diff --git a/Sources/Orbit/Support/TextFields/TextField.swift b/Sources/Orbit/Support/TextFields/TextField.swift index ec033e2cac3..11e2f891096 100644 --- a/Sources/Orbit/Support/TextFields/TextField.swift +++ b/Sources/Orbit/Support/TextFields/TextField.swift @@ -1,7 +1,16 @@ import SwiftUI import UIKit -/// Orbit wrapper over `UITextField` with larger touch area and action handling. +/// Orbit control that displays an editable text interface, a replacement for native `TextField` component. +/// +/// The component uses UIKit implementation to support these feature for older iOS versions: +/// - focus changes +/// - UITextField event handling +/// - full UITextField configuration +/// - font and text override +/// - larger and configurable touch area +/// +/// The component is compatible with native `@FocusState` modifier to support focus changes in later iOS versions. public struct TextField: UIViewRepresentable, TextFieldBuildable { @Environment(\.identifier) private var identifier