Skip to main content

MarkdownEditor

Struct MarkdownEditor 

Source
pub struct MarkdownEditor { /* private fields */ }
Expand description

An Obsidian-style live-preview markdown editor. Create with cx.new(|cx| MarkdownEditor::new(cx)).

The text model is the unit-tested EditorModel (char-index cursor, anchor selection, coalesced undo); markdown structure comes from the pure block/inline/layout passes. Read-only editors render pure preview — selection, copy, and plain-click links still work.

Implementations§

Source§

impl MarkdownEditor

Source

pub fn new(cx: &mut Context<'_, Self>) -> Self

Source

pub fn value(self, text: &str) -> Self

Initial markdown text (text() is the getter).

Source

pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self

Dimmed hint shown while the document is empty and unfocused.

Source

pub fn read_only(self, read_only: bool) -> Self

Render pure preview: no caret, no edits, no syntax reveal. Selection, copy, and plain-click link activation still work.

Source

pub fn font_size(self, size: f32) -> Self

Base font size in px (default 15.0). Headings scale from it.

Source

pub fn rows(self, rows: usize) -> Self

Minimum height, as a number of paragraph lines.

Source

pub fn tab_size(self, n: usize) -> Self

Spaces inserted per list indent level (default 4).

Source

pub fn style(self, style: MarkdownStyle) -> Self

Per-editor visual overrides (see MarkdownStyle).

Source

pub fn set_style(&mut self, style: MarkdownStyle, cx: &mut Context<'_, Self>)

Replace the style at runtime (theme switches).

Source

pub fn text(&self) -> String

The current markdown text.

Source

pub fn set_text(&mut self, value: &str, cx: &mut Context<'_, Self>)

Replace the document, resetting cursor, selection, and history.

Source

pub fn focus_handle(&self) -> FocusHandle

The editor’s focus handle, so a host can focus it on open.

Source

pub fn model(&self) -> &EditorModel

Read access to the underlying EditorModel — cursor, selection, lines — for hosts building features over the buffer.

Source

pub fn edit<R>( &mut self, cx: &mut Context<'_, Self>, f: impl FnOnce(&mut EditorModel) -> R, ) -> R

Mutate the EditorModel directly. Emits MarkdownEditorEvent::Change when the text changed, keeps the caret visible, and repaints.

Source

pub fn bind( entity: &Entity<MarkdownEditor>, signal: &Signal<String>, cx: &mut App, )

Two-way bind this editor’s text to a Signal<String>. The signal is the source of truth; equality guards on both directions prevent update loops.

Source

pub fn toggle_task(&mut self, line: usize, cx: &mut Context<'_, Self>) -> bool

Toggle the checkbox on line if it is a task item, preserving the cursor. Returns whether the line was a task.

Trait Implementations§

Source§

impl EventEmitter<MarkdownEditorEvent> for MarkdownEditor

Source§

impl Render for MarkdownEditor

Source§

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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