pub struct Editor { /* private fields */ }Expand description
Multi-paragraph editor backed by a shared [TextBuffer] signal.
Edits update the supplied signal synchronously. The default uses
[EditorConfig::default], automatic layout, and no initial selection. The
retained widget is focusable, supports multiline keyboard/IME input, and
has a 320×180 logical-pixel intrinsic cap/height before constraints. Wheel
input preserves native horizontal and vertical axes, while Shift maps a
vertical wheel delta to horizontal scrolling when wrapping is disabled.
Editing and keyboard navigation keep the caret inside a safe visible region
on both axes and preserve three visible lines below it by default. A caret
already in that region never moves the viewport. Pointer clicks never move
the viewport; pointer selection auto-scrolls only after leaving the visible
text area.
This generic editor intentionally does not paint a visual scrollbar.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::Editor;
let editor = Editor::new(State::new(TextBuffer::from_string("hello")));
let _ = editor;Implementations§
Source§impl Editor
impl Editor
Sourcepub fn width(self, value: impl Into<Length>) -> Self
pub fn width(self, value: impl Into<Length>) -> Self
Sets preferred width from a logical-pixel or length value.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).width(24.0);
let _ = widget;Sourcepub fn height(self, value: impl Into<Length>) -> Self
pub fn height(self, value: impl Into<Length>) -> Self
Sets preferred height from a logical-pixel or length value.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).height(24.0);
let _ = widget;Sourcepub fn min_width(self, value: impl Into<Length>) -> Self
pub fn min_width(self, value: impl Into<Length>) -> Self
Sets the minimum width bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_width(12.0);
let _ = widget;Sourcepub fn max_width(self, value: impl Into<Length>) -> Self
pub fn max_width(self, value: impl Into<Length>) -> Self
Sets the maximum width bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_width(32.0);
let _ = widget;Sourcepub fn min_height(self, value: impl Into<Length>) -> Self
pub fn min_height(self, value: impl Into<Length>) -> Self
Sets the minimum height bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_height(12.0);
let _ = widget;Sourcepub fn max_height(self, value: impl Into<Length>) -> Self
pub fn max_height(self, value: impl Into<Length>) -> Self
Sets the maximum height bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_height(32.0);
let _ = widget;Sourcepub fn fill(self) -> Self
pub fn fill(self) -> Self
Sets both preferred axes to parent fill.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill();
let _ = widget;Sourcepub fn fill_width(self) -> Self
pub fn fill_width(self) -> Self
Sets preferred width to parent fill.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_width();
let _ = widget;Sourcepub fn fill_height(self) -> Self
pub fn fill_height(self) -> Self
Sets preferred height to parent fill.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_height();
let _ = widget;Sourcepub fn margin(self, value: f32) -> Self
pub fn margin(self, value: f32) -> Self
Sets uniform outer margin in logical pixels.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).margin(4.0);
let _ = widget;Sourcepub fn padding(self, value: f32) -> Self
pub fn padding(self, value: f32) -> Self
Sets uniform inner padding in logical pixels.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).padding(4.0);
let _ = widget;Sourcepub fn flex_grow(self) -> Self
pub fn flex_grow(self) -> Self
Sets flex-grow weight to one.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow();
let _ = widget;Sourcepub fn flex_grow_by(self, value: f32) -> Self
pub fn flex_grow_by(self, value: f32) -> Self
Sets a dimensionless flex-grow weight.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow_by(2.0);
let _ = widget;Sourcepub fn flex_shrink(self, value: f32) -> Self
pub fn flex_shrink(self, value: f32) -> Self
Sets a dimensionless flex-shrink weight.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_shrink(1.0);
let _ = widget;Sourcepub fn flex_basis(self, value: impl Into<Length>) -> Self
pub fn flex_basis(self, value: impl Into<Length>) -> Self
Sets the preferred main-axis flex basis.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_basis(20.0);
let _ = widget;Sourcepub fn align_self(self, value: AlignItems) -> Self
pub fn align_self(self, value: AlignItems) -> Self
Overrides cross-axis alignment for this flex item.
§Examples
use ailloli_ui_core::{style::AlignItems, IconId};
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).align_self(AlignItems::Center);
let _ = widget;Source§impl Editor
impl Editor
Sourcepub fn new(buffer: impl Into<Signal<TextBuffer>>) -> Self
pub fn new(buffer: impl Into<Signal<TextBuffer>>) -> Self
Creates an editor bound to shared rope-buffer state.
A standalone [ailloli_ui_runtime::component::State] is convenient for examples; component code may
pass a context-owned [Signal] so edits schedule invalidation.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::Editor;
let editor = Editor::new(State::new(TextBuffer::new()));
let _ = editor;Sourcepub fn style(self, style: EditorStyle) -> Self
pub fn style(self, style: EditorStyle) -> Self
Replaces editor colors and logical-pixel metrics.
§Examples
use ailloli_ui_editor::EditorStyle;
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::Editor;
let editor = Editor::new(State::new(TextBuffer::new())).style(EditorStyle::default());
let _ = editor;Sourcepub fn wrap_mode(self, wrap_mode: EditorWrapMode) -> Self
pub fn wrap_mode(self, wrap_mode: EditorWrapMode) -> Self
Selects soft wrapping or horizontal no-wrap behavior.
§Examples
use ailloli_ui_editor::EditorWrapMode;
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::Editor;
let editor = Editor::new(State::new(TextBuffer::new())).wrap_mode(EditorWrapMode::NoWrap);
let _ = editor;Sourcepub fn initial_selection(self, anchor: usize, caret: usize) -> Self
pub fn initial_selection(self, anchor: usize, caret: usize) -> Self
Sets initial anchor/caret UTF-8 byte offsets.
Both values are independently clamped to buffer length when the retained component is first built. They are not ordered or validated as UTF-8 character boundaries and do not overwrite later retained selection state.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::Editor;
let editor = Editor::new(State::new(TextBuffer::from_string("hello"))).initial_selection(0, 5);
let _ = editor;Sourcepub fn caret_follow_margin_lines(self, lines: f32) -> Self
pub fn caret_follow_margin_lines(self, lines: f32) -> Self
Sets the visible-line safety margin kept below the revealed caret.
The default is three lines. The margin applies to edits, paste, undo, redo, IME changes, and keyboard navigation. Reveal always adds only the distance by which the caret crosses the safe boundary; pointer clicks never request caret following. Negative values become zero and non-finite values restore the default.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::Editor;
let editor = Editor::new(State::new(TextBuffer::new()))
.caret_follow_margin_lines(5.0);
let _ = editor;