Interface IYText

Abstract interface to define Shared Models that can be bound to a text editor using any existing Yjs-based editor binding.

Hierarchy

Implemented by

Properties

awareness changed disposed isDisposed source undoManager ysource

Methods

canRedo canUndo clearUndoHistory dispose getSource redo setSource transact undo updateSource

Properties

Readonly awareness

awareness: null | Awareness

Shareable awareness

Readonly changed

changed: ISignal<IYText, SourceChange>

The changed signal.

Readonly disposed

disposed: ISignal<IYText, void>

A signal emitted when the object is disposed.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

source

source: string

Text

Readonly undoManager

undoManager: null | UndoManager

Undo manager

Readonly ysource

ysource: YText

Shareable text

Methods

canRedo

canUndo

clearUndoHistory

dispose

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

getSource

redo

setSource

transact

  • Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.

    Parameters

    • f: (() => void)

      Transaction to execute

        • (): void

        • Returns void

    • Optional undoable: boolean

      Whether to track the change in the action history or not (default true)

    Returns void

undo

updateSource

  • Replace content from start to end with value.

    Parameters

    • start: number
    • end: number
    • Optional value: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc