View Source API Reference y_ex v0.7.1

Modules

Yex

Yex is wrapper library for the Yjs CRDT library.

A shareable Array-like type that supports efficient insert/delete of elements at any position.

Event when Array type changes

A preliminary array. It can be used to early initialize the contents of a Array.

Awareness is an optional feature that works well together with Yjs.

Document module.

Document options.

Define a Yex.DocServer process.

Provides the State struct and functions to manage the internal state of Yex.DocServer.

A shareable Map type.

Event when Map type changes

A preliminary map. It can be used to early initialize the contents of a Map.

The SharedType protocol defines the behavior of shared types in Yex.

A sticky index is based on the Yjs model and is not affected by document changes. E.g. If you place a sticky index before a certain character, it will always point to this character. If you place a sticky index at the end of a type, it will always point to the end of the type. A numeric position is often unsuited for user selections, because it does not change when content is inserted before or after.

A subscription .

Yex.Sync provides functions to handle the synchronization protocol for Yex documents.

This process handles messages for yjs protocol sync and awareness. https://github.com/yjs/y-protocols

Persistence behavior for SharedDoc

A shareable type that is optimized for shared editing on text.

Event when Text type changes

A preliminary text. It can be used to early initialize the contents of a Text.

Represents a Y.UndoManager instance.

Options for creating an UndoManager.

A shared type that represents an XML node

A preliminary xml element. It can be used to early initialize the contents of a XmlElement.

Event when XMLFragment/Element type changes

A shared type to manage a collection of Y.Xml* Nodes

A preliminary xml fragment. It can be used to early initialize the contents of a XmlFragment.

Extends Y.Text to represent a Y.Xml node.

Event when Text type changes

A preliminary xml text. It can be used to early initialize the contents of a XmlText.