Struct Editor

Source
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

Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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

Source

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;
Source

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;
Source

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;
Source

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;
Source

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;

Trait Implementations§

Source§

impl<A: 'static> IntoView<A> for Editor

Converts the builder into a retained editor component with flex/size hints.

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl LayoutExt for Editor

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl Freeze for Editor

§

impl !RefUnwindSafe for Editor

§

impl !Send for Editor

§

impl !Sync for Editor

§

impl Unpin for Editor

§

impl !UnwindSafe for Editor

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,