Skip to content

Commit

Permalink
Update TextField comment
Browse files Browse the repository at this point in the history
  • Loading branch information
PavelHolec committed Aug 18, 2023
1 parent 0903f2e commit e02f08b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 2 additions & 0 deletions Sources/Orbit/Components/InputField.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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<Prefix: View, Suffix: View>: View, TextFieldBuildable {
Expand Down
11 changes: 10 additions & 1 deletion Sources/Orbit/Support/TextFields/TextField.swift
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit e02f08b

Please sign in to comment.