Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
FormsApple

Textarea

Capture multiline native text with shared labeling, supporting copy, and error treatment.

Public APILumenTextareaApple / SwiftUISwift product: LumenUI

Apple availability

Supported native targets

Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.

iPhone · iOS 16+iPad · iPadOS 16+Mac · macOS 13+Apple Vision · visionOS 1+

Native example

Use Textarea

Use for multi-line freeform input. Prefer Text field for short single-line values and keep validation messages concise.

Textarea rendered in the iPhone simulator Lumen playground
Verified runtime captureiPhone simulator
swift
LumenTextarea(
    "Release notes",
    text: $notes,
    description: "Summarize the visible changes."
)

Reference

Public API

The primary shared and platform-specific options exposed by LumenTextarea.

APIValues or typeDefaultDescription
labelStringRequiredProvides the visible and accessible label.
textBinding<String>RequiredStores the controlled text value.
Binding setter(String) -> UnitRequiredUpdates the controlled text value.
descriptionString?nilAdds supporting input guidance.
errorMessageString?nilMarks and explains an invalid value.

Native behavior

Design and accessibility

When to use it

Use for multi-line freeform input. Prefer Text field for short single-line values and keep validation messages concise.

Accessibility

The native multiline editor keeps platform text-entry behavior, exposes its visible label, and presents supporting or error context without replacing the current value.

Shared component

Available on other platforms

React NativeAndroid / Compose
Apple docsSwiftUI package