Generic Structure

TextField

A control that displays an editable text interface.

Declaration

struct TextField<Label> where Label : View

Overview

You can customize the appearance and interaction of a text field using a TextFieldStyle instance. The system resolves this configuration at runtime. Each platform provides a default style that reflects the platform style, but you can provide a new style that redefines all text field instances within a particular environment.

Topics

Creating a TextField View

init(LocalizedStringKey, text: Binding<String>, onEditingChanged: (Bool) -> Void, onCommit: () -> Void)
Available when Label is Text.
init<S>(S, text: Binding<String>, onEditingChanged: (Bool) -> Void, onCommit: () -> Void)
Available when Label is Text.
init<T>(LocalizedStringKey, value: Binding<T>, formatter: Formatter, onEditingChanged: (Bool) -> Void, onCommit: () -> Void)
Available when Label is Text.
init<S, T>(S, value: Binding<T>, formatter: Formatter, onEditingChanged: (Bool) -> Void, onCommit: () -> Void)
Available when Label is Text.
typealias TextField.Body

Styling Text Fields

struct PlainTextFieldStyle
struct RoundedBorderTextFieldStyle
struct SquareBorderTextFieldStyle
struct DefaultTextFieldStyle
protocol TextFieldStyle

A specification for the appearance and interaction of a text field.

Implementing a Custom View

var body: View

Setting the Size of a View

func frame(width: CGFloat?, height: CGFloat?, alignment: Alignment) -> View

Positions the view within an invisible frame with the specified size.

func frame(minWidth: CGFloat?, idealWidth: CGFloat?, maxWidth: CGFloat?, minHeight: CGFloat?, idealHeight: CGFloat?, maxHeight: CGFloat?, alignment: Alignment) -> View

Positions the view within an invisible frame with the specified width and height.

func fixedSize() -> View

Fixes the view at its ideal size.

func fixedSize(horizontal: Bool, vertical: Bool) -> View

Fixes the view at its ideal size in the specified dimensions.

Specifying the Relative Size of a View

func layoutPriority(Double) -> View

Sets the priority by which a parent layout should apportion space to the child.

Setting the Position of a View

func position(CGPoint) -> View

Fixes the center of the view at the specified point in its parent’s coordinate space.

func position(x: CGFloat, y: CGFloat) -> View

Fixes the center of the view at the specified coordinates in its parent’s coordinate space.

func offset(CGSize) -> View

Offsets the view by the horizontal and vertical distances in the given size.

func offset(x: CGFloat, y: CGFloat) -> View

Offsets the view by the specified horizontal and vertical distances.

func edgesIgnoringSafeArea(Edge.Set) -> View

Extends the view out of the safe area on the specified edges.

func coordinateSpace<T>(name: T) -> View

Aligning Views

func alignmentGuide(HorizontalAlignment, computeValue: (ViewDimensions) -> CGFloat) -> View

Sets the view’s horizontal alignment.

func alignmentGuide(VerticalAlignment, computeValue: (ViewDimensions) -> CGFloat) -> View

Sets the view’s vertical alignment.

Adjusting the Padding of a View

func padding(CGFloat) -> View

Pads the view along all edge insets by the specified amount.

func padding(EdgeInsets) -> View

Pads the view using the specified edge insets.

func padding(Edge.Set, CGFloat?) -> View

Pads the view using the specified edge insets.

Setting the Foreground or Background of a View

func overlay<Overlay>(Overlay, alignment: Alignment) -> View

Layers a secondary view in front of the view.

func foregroundColor(Color?) -> View

Sets the color that the view uses for foreground elements.

func background<Background>(Background, alignment: Alignment) -> View
func zIndex(Double) -> View

Controls the display order of overlapping views.

Setting the Border of a View

func border<S>(S, width: CGFloat) -> View

Adds a border to the view with the specified style and width.

Masking and Clipping Views

func clipped(antialiased: Bool) -> View

Clips the view to its bounding rectangular frame.

func clipShape<S>(S, style: FillStyle) -> View

Sets a clipping shape for the view.

func cornerRadius(CGFloat, antialiased: Bool) -> View

Clips the view to its bounding frame, with the specified corner radius.

func mask<Mask>(Mask) -> View

Scaling Views

func scaledToFill() -> View

Scales the view to fill its parent.

func scaledToFit() -> View

Scales the view to fit its parent.

func scaleEffect(CGFloat, anchor: UnitPoint) -> View
func scaleEffect(CGSize, anchor: UnitPoint) -> View
func scaleEffect(x: CGFloat, y: CGFloat, anchor: UnitPoint) -> View
func aspectRatio(CGFloat?, contentMode: ContentMode) -> View

Constrains the view’s dimensions to the specified aspect ratio.

func aspectRatio(CGSize, contentMode: ContentMode) -> View

Constrains the view’s dimensions to the aspect ratio of the specified size.

func imageScale(Image.Scale) -> View

Sets the scale of images inside the view.

Rotating and Transforming Views

func rotationEffect(Angle, anchor: UnitPoint) -> View
func rotation3DEffect(Angle, axis: (x: CGFloat, y: CGFloat, z: CGFloat), anchor: UnitPoint, anchorZ: CGFloat, perspective: CGFloat) -> View
func projectionEffect(ProjectionTransform) -> View
func transformEffect(CGAffineTransform) -> View

Adjusting Text in a View

func keyboardType(UIKeyboardType) -> View
func font(Font?) -> View

Sets the default font for text in the view.

func lineLimit(Int?) -> View

Sets the maximum number of lines that text can occupy in the view.

func lineSpacing(CGFloat) -> View

Sets the amount of space between lines of text in the view.

func multilineTextAlignment(TextAlignment) -> View
func minimumScaleFactor(CGFloat) -> View

Sets the minimum amount that text scales down to fit the available space.

func truncationMode(Text.TruncationMode) -> View

Sets the truncation mode for lines of text that are too long to fit in the available space.

func allowsTightening(Bool) -> View

Sets whether text can compress the space between characters when necessary to fit text in a line.

func textContentType(UITextContentType?) -> View
func textContentType(WKTextContentType?) -> View
func flipsForRightToLeftLayoutDirection(Bool) -> View

Sets whether the view flips its contents horizontally when the layout direction is right-to-left.

func autocapitalization(UITextAutocapitalizationType) -> View
func disableAutocorrection(Bool?) -> View

Adding Animations to a View

func animation(Animation?) -> View

Applies the given animation to all animatable values within the view.

func animation<V>(Animation?, value: V) -> View

Applies the given animation to the view when the specified value changes.

func transition(AnyTransition) -> View

Associates a transition with the view.

Customizing Accessibility Labels of a View

func accessibility(hidden: Bool) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(identifier: String) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(label: Text) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(value: Text) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(sortPriority: Double) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>

Customizing Accessibility Interactions of a View

func accessibility(activationPoint: UnitPoint) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(activationPoint: CGPoint) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(hint: Text) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibilityAction(AccessibilityActionKind, () -> Void) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibilityAction(named: Text, () -> Void) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibilityAdjustableAction((AccessibilityAdjustmentDirection) -> Void) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibilityScrollAction((Edge) -> Void) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>

Customizing Accessibility Navigation of a View

func accessibility(addTraits: AccessibilityTraits) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibility(removeTraits: AccessibilityTraits) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func accessibilityElement(children: AccessibilityChildBehavior) -> View

Handling View Taps and Gestures

func gesture<T>(T, including: GestureMask) -> View
func onTapGesture(count: Int, perform: () -> Void) -> View
func onLongPressGesture(minimumDuration: Double, maximumDistance: CGFloat, pressing: ((Bool) -> Void)?, perform: () -> Void) -> View
func highPriorityGesture<T>(T, including: GestureMask) -> View
func simultaneousGesture<T>(T, including: GestureMask) -> View
func digitalCrownRotation<V>(Binding<V>) -> View

Tracks Digital Crown rotations by updating the specified binding.

func digitalCrownRotation<V>(Binding<V>, from: V, through: V, by: V.Stride?, sensitivity: DigitalCrownRotationalSensitivity, isContinuous: Bool, isHapticFeedbackEnabled: Bool) -> View

Tracks Digital Crown rotations by updating the specified binding.

func itemProvider(Optional<() -> NSItemProvider?>) -> View

Provides a closure that vends the drag representation to be used for a particular data element.

func transaction((inout Transaction) -> Void) -> View

Applies the given transaction mutation function to all transactions used within the view.

Handling View Events

func onAppear(perform: (() -> Void)?) -> View

Adds an action to perform when the view appears.

func onDisappear(perform: (() -> Void)?) -> View

Adds an action to perform when the view disappears.

func onCommand(Selector, perform: (() -> Void)?) -> View
func onCopyCommand(perform: (() -> [NSItemProvider])?) -> View
func onCutCommand(perform: (() -> [NSItemProvider])?) -> View
func onDeleteCommand(perform: (() -> Void)?) -> View
func onExitCommand(perform: (() -> Void)?) -> View
func onMoveCommand(perform: ((MoveCommandDirection) -> Void)?) -> View
func onPasteCommand(of: [String], perform: ([NSItemProvider]) -> Void) -> View
func onPasteCommand<Payload>(of: [String], validator: ([NSItemProvider]) -> Payload?, perform: (Payload) -> Void) -> View
func onPlayPauseCommand(perform: (() -> Void)?) -> View
func onReceive<P>(P, perform: (P.Output) -> Void) -> View

Handling View Hover and Focus

func onHover(perform: (Bool) -> Void) -> View

Adds an action to perform when the user moves the pointer over or away from the view’s frame.

func focusable(Bool, onFocusChange: (Bool) -> Void) -> View

Specifies if the view is focusable and, if so, adds an action to perform when the view comes into focus.

Supporting Drag and Drop in Views

func onDrag(() -> NSItemProvider) -> View

Activates the view as the source of a drag and drop operation.

func onDrop(of: [String], delegate: DropDelegate) -> View

Defines the destination of a drag and drop operation with the same size and position as the view using behavior controlled by the given delegate.

func onDrop(of: [String], isTargeted: Binding<Bool>?, perform: ([NSItemProvider], CGPoint) -> Bool) -> View

Defines the destination of a drag and drop operation with the same size and position as the view by handling dropped content and the drop location with the specified closure.

func onDrop(of: [String], isTargeted: Binding<Bool>?, perform: ([NSItemProvider]) -> Bool) -> View

Defines the destination for a drag and drop operation with the same size and position as the view by handling dropped content with the specified closure.

Adopting View Color Schemes

func colorScheme(ColorScheme) -> View

Sets the view’s color scheme.

func preferredColorScheme(ColorScheme?) -> View
func accentColor(Color?) -> View

Sets the accent color for the view and the views it contains.

Applying Blurs and Shadows to a View

func blur(radius: CGFloat, opaque: Bool) -> View

Applies a Gaussian blur to the view.

func shadow(color: Color, radius: CGFloat, x: CGFloat, y: CGFloat) -> View

Adds a shadow to the view.

Applying Graphical Effects to a View

func opacity(Double) -> View

Sets the transparency of the view.

func brightness(Double) -> View

Brightens the view by the specified amount.

func contrast(Double) -> View

Sets the contrast and separation between similar colors in the view.

func colorInvert() -> View

Inverts the colors in the view.

func colorMultiply(Color) -> View

Adds a color multiplication effect to the view.

func blendMode(BlendMode) -> View

Sets the blend mode for compositing the view with overlapping views.

func compositingGroup() -> View

Wraps the view in a compositing group.

func drawingGroup(opaque: Bool, colorMode: ColorRenderingMode) -> View

Composites the view’s contents into an offscreen image before final display.

func saturation(Double) -> View

Adjusts the color saturation of the view.

func grayscale(Double) -> View

Adds a grayscale effect to the view.

func hueRotation(Angle) -> View

Applies a hue rotation effect to the view.

func luminanceToAlpha() -> View

Adds a luminance to alpha effect to the view.

Styling Control Views

func buttonStyle<S>(S) -> View
func buttonStyle<S>(S) -> View
func datePickerStyle<S>(S) -> View
func menuButtonStyle<S>(S) -> View
func pickerStyle<S>(S) -> View
func textFieldStyle<S>(S) -> View
func toggleStyle<S>(S) -> View
func defaultWheelPickerItemHeight(CGFloat) -> View

Sets the default wheel-style picker item height.

func controlSize(ControlSize) -> View

Configuring a List View

func listStyle<S>(S) -> View
func listRowInsets(EdgeInsets?) -> View

Sets the inset to be applied to the view when placed in a list.

func listRowBackground<V>(V?) -> View

Sets a view behind the view when placed in a list.

func listRowPlatterColor(Color?) -> View

Sets the color to apply to the system cell platter of the view when placed in a list.

func tag<V>(V) -> View

Sets a tag for the view in order to differentiate it from a list of view options.

Configuring Navigation and Status Bar Views

func navigationViewStyle<S>(S) -> View
func navigationBarTitle(LocalizedStringKey) -> View
func navigationBarTitle<S>(S) -> View
func navigationBarTitle(Text) -> View
func navigationBarTitle(LocalizedStringKey, displayMode: NavigationBarItem.TitleDisplayMode) -> View
func navigationBarTitle(Text, displayMode: NavigationBarItem.TitleDisplayMode) -> View
func navigationBarHidden(Bool) -> View
func statusBar(hidden: Bool) -> View

Configuring Navigation and Tab Bar Item Views

func navigationBarItems<L>(leading: L) -> View
func navigationBarItems<L, T>(leading: L, trailing: T) -> View
func navigationBarItems<T>(trailing: T) -> View
func navigationBarBackButtonHidden(Bool) -> View
func tabItem<V>(() -> V) -> View

Configuring Context Menu Views

func contextMenu<MenuItems>(ContextMenu<MenuItems>?) -> View

Attaches a contextual menu and its children to the view.

func contextMenu<MenuItems>(menuItems: () -> MenuItems) -> View

Attaches a contextual menu to the view.

Configuring Touch Bar Views

func touchBar<Content>(TouchBar<Content>) -> View

Sets the touch bar and its content to be shown in the Touch Bar when applicable.

func touchBarItemPrincipal(Bool) -> View

Sets the view as having special significance to the TouchBar.

func touchBarCustomizationLabel(Text) -> View

Sets a user-visible string identifying the view’s functionality.

func touchBarItemPresence(TouchBarItemPresence) -> View

Sets the behavior of the view when being customized by the user.

Hiding and Disabling Views

func hidden() -> View

Hides the view.

func disabled(Bool) -> View

Adds a condition for whether users can interact with the view.

func deleteDisabled(Bool) -> View

Adds a condition for whether the view’s view hierarchy is deletable.

func moveDisabled(Bool) -> View

Adds a condition for whether the view's view hierarchy is movable.

Setting View Preferences

func preference<K>(key: K.Type, value: K.Value) -> View

Sets a value to return for the given preference key when accessed by ancestors.

func transformPreference<K>(K.Type, (inout K.Value) -> Void) -> View

Sets a callback to return a value for the given preference key when accessed by ancestors.

func anchorPreference<A, K>(key: K.Type, value: Anchor<A>.Source, transform: (Anchor<A>) -> K.Value) -> View
func transformAnchorPreference<A, K>(key: K.Type, value: Anchor<A>.Source, transform: (inout K.Value, Anchor<A>) -> Void) -> View

Responding to View Preferences

func onPreferenceChange<K>(K.Type, perform: (K.Value) -> Void) -> View

Adds an action to perform when the specified preference key’s value changes.

func backgroundPreferenceValue<Key, T>(Key.Type, (Key.Value) -> T) -> View

Uses the specified preference value from the view to produce another view as a background to the first view.

func overlayPreferenceValue<Key, T>(Key.Type, (Key.Value) -> T) -> View

Uses the specified preference value from the view to produce another view as an overlay atop the first view.

Setting the Environment Values of a View

func environment<V>(WritableKeyPath<EnvironmentValues, V>, V) -> View

Sets the environment value indicated by a key path to the given value.

func environmentObject<B>(B) -> View
func transformEnvironment<V>(WritableKeyPath<EnvironmentValues, V>, transform: (inout V) -> Void) -> View

Transforms the environment value indicated by a key path with the given function.

Configuring a View for Hit Testing

func allowsHitTesting(Bool) -> View
func contentShape<S>(S, eoFill: Bool) -> View

Defines the content shape for hit testing.

Configuring View Previews

func previewDevice(PreviewDevice?) -> View

Overrides the device for a preview.

func previewDisplayName(String?) -> View

Provides a user visible name shown in the editor.

func previewLayout(PreviewLayout) -> View

Overrides the size of the container for the preview.

Inspecting Views

func id<ID>(ID) -> View

Implementing View Modifiers

func modifier<T>(T) -> ModifiedContent<TextField<Label>, T>

Instance Methods

func accessibility(selectionIdentifier: AnyHashable) -> ModifiedContent<TextField<Label>, AccessibilityAttachmentModifier>
func actionSheet(isPresented: Binding<Bool>, content: () -> ActionSheet) -> View
func actionSheet<T>(item: Binding<T?>, content: (T) -> ActionSheet) -> View
func alert(isPresented: Binding<Bool>, content: () -> Alert) -> View
func alert<Item>(item: Binding<Item?>, content: (Item) -> Alert) -> View
func horizontalRadioGroupLayout() -> View
func labelsHidden() -> View
func popover<Content>(isPresented: Binding<Bool>, attachmentAnchor: PopoverAttachmentAnchor, arrowEdge: Edge, content: () -> Content) -> View
func popover<Item, Content>(item: Binding<Item?>, attachmentAnchor: PopoverAttachmentAnchor, arrowEdge: Edge, content: (Item) -> Content) -> View
func sheet<Content>(isPresented: Binding<Bool>, onDismiss: (() -> Void)?, content: () -> Content) -> View
func sheet<Item, Content>(item: Binding<Item?>, onDismiss: (() -> Void)?, content: (Item) -> Content) -> View
func touchBar<Content>(content: () -> Content) -> View

Relationships

Conforms To

See Also

Text

struct Text

A view that displays one or more lines of read-only text.

struct SecureField

A control into which the user securely enters private text.

struct Font

An environment-dependent font.