API Reference y_ex v0.7.3
View SourceModules
Yex is wrapper library for the Yjs CRDT library.
A shareable Array-like type that supports efficient insert/delete of elements at any position. This module provides functionality for collaborative array manipulation with support for concurrent modifications and automatic conflict resolution.
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 that supports concurrent modifications with automatic conflict resolution. This module provides functionality for collaborative key-value pair management with support for nested shared types and JSON compatibility.
Event when Map type changes
A preliminary map representation used for initializing map content. This module provides functionality for creating map content before it is inserted into a shared document.
Protocol for converting shared types to their preliminary representations. This is useful for serialization and data transfer between different parts of the system.
The SharedType protocol defines the behavior of shared types in Yex. This module provides functionality for observing changes to shared types, including arrays, maps, text, and XML nodes.
A sticky index provides position references that are unaffected by document changes, based on the Yjs model. It maintains its relative position when placed before or after specific characters or elements.
Provides subscription functionality for monitoring changes in shared types. This module implements features for observing changes in documents and other shared types, and receiving notifications when changes occur.
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. This module provides functionality for collaborative text editing with support for rich text formatting.
Event when Text type changes
A preliminary text representation used for initializing text content. This module provides functionality for creating text content with formatting before it is inserted into a shared document.
Represents a Y.UndoManager instance.
Options for creating an UndoManager.
Defines a protocol for XML node operations. This protocol provides basic navigation and string conversion functionality for XML nodes.
A shared type that represents an XML node. Provides functionality for manipulating XML elements including child nodes, attributes, and navigation.
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 XML nodes. Provides functionality for manipulating XML fragments including child nodes and navigation.
A preliminary xml fragment. It can be used to early initialize the contents of a XmlFragment.
A shared type that represents an XML text node. Extends Y.Text to provide functionality for manipulating text content within XML nodes, including text formatting and navigation.
Event when Text type changes
A preliminary xml text. It can be used to early initialize the contents of a XmlText.