Skip to content

TextArea

Edit multiline text with wrapping and caret scrolling.

On this page

Available with egui, Masonry and GPUI through the same public component API. Platform input and accessibility coverage still have alpha limits.

Usage

Replace src/App.iru in a scaffolded project with this complete file, then run cargo run. Keep the scaffold's main.rs and build.rs; this file includes its state, handlers and scoped styles.

src/App.iru
<view>
    <Column class="example">
        <Text text="Workspace notes" />
        <TextArea model:value={notes} placeholder="Write several lines" disabled={locked} class="editor" />
        <Checkbox label="Disable the editor" model:checked={locked} />
        <Text text={format!("Lines: {}", notes.lines().count())} />
        <Button text="Reset notes" @click={reset} class="action" />
    </Column>
</view>
<rust>
use inrux::prelude::*;

let notes: String = "First line\nSecond line".into();
let locked: bool = false;

/// Replace the controlled text, including a newline.
fn reset(state: &mut State, _: &Context<State>) {
    state.notes = "First line\nSecond line".into();
    state.locked = false;
}
</rust>
<style scoped>
.example {
    padding: 24px;
    gap: 16px;
}
.action {
    background: #b84200;
    color: white;
    padding: 12px;
    border-radius: 6px;
}
.action:hover {
    background: #913400;
}
.action:focus-visible {
    border-width: 2px;
    border-color: #262626;
}
.editor {
    height: 160px;
    width: 400px;
}
</style>

API Reference

Props

PropTypeDefaultDescription
valueString-like expressionRequired without model:valueControlled multiline value.
model:valueretained field: String or Signal<String>Not setTwo-way value binding; use instead of value.
placeholderString-like expression""Hint displayed when empty.
disabledboolfalsePrevent editing.

Common props

PropTypeDefaultDescription
idString-like expressionNot setStyle-selector identity; independent of retained mount identity.
classString-like expressionNot setWhitespace-separated stylesheet classes.
styleStyleNot setExplicit Rust style overrides for this node.
keyString-like expressionNot setRetained sibling identity; preserve it while reordering children.
widthSizeComponent styleExplicit width constraint; otherwise use the resolved style.
heightSizeComponent styleExplicit height constraint; otherwise use the resolved style.
paddingf32Component styleUniform padding in logical pixels; otherwise use the resolved style.
gapf32Component styleChild spacing in logical pixels; otherwise use the resolved style.

“Component style” means the attribute is omitted and the normal style cascade supplies the value. Application styles can override framework defaults.

Emits

EventPayloadDescription
@inputStringNew multiline value. Required without a model; a model listener runs after assignment.

Bind events with @event={handler}. Ordinary handlers receive &mut State and &Context<State>; controlled value handlers can also receive the listed payload. With model:value or model:checked, the setter runs before the optional model listener, which reads the updated state. Stateless children forward a typed Emit<T>.

Behavior

Enter inserts a newline. TextArea normalizes hard line separators to LF, wraps at the available width and scrolls vertically to reveal the caret. Tab moves focus instead of inserting indentation. There is no public resize handle or complete code-editor feature set.

Styling and limits

Use a separate textarea class when the single-line Input style has a short fixed height. Root dimensions and placeholder paint are overridable. Undo/redo, multilingual IME and full accessibility parity are not certified.

Read the detailed reference for validation and native integration details. The playgrounds include a working TextArea specimen with its surrounding state and reset controls.

Inrux · Built with Nuxt Content, IPEX, and Akaza UI.