SearSuite
← All packages

API reference

@searsuite/sear-assembly-doc

Composable rich-document plugins for nodes, layout, inline styles, commands, and observations.

112 exportsderived from source

enumBoldTextStyleKeysource ↗
enum BoldTextStyleKey

Persisted style key owned by the bold text-style plugin.

enum memberBold
Bold: "bold"
enumFontFamilyTextStyleKeysource ↗
enum FontFamilyTextStyleKey

Persisted style key owned by the font-family text-style plugin.

enum memberFontFamily
FontFamily: "fontFamily"
enumFontSizeTextStyleKeysource ↗
enum FontSizeTextStyleKey

Persisted style key owned by the font-size text-style plugin.

enum memberFontSize
FontSize: "fontSize"
enumItalicTextStyleKeysource ↗
enum ItalicTextStyleKey
enum memberItalic
Italic: "italic"
enumStrikethroughTextStyleKeysource ↗
enum StrikethroughTextStyleKey
enum memberStrikethrough
Strikethrough: "strikethrough"
enumTextColorStyleKeysource ↗
enum TextColorStyleKey

Persisted style key owned by the text-color style plugin.

enum memberColor
Color: "color"
enumUnderlineTextStyleKeysource ↗
enum UnderlineTextStyleKey
enum memberUnderline
Underline: "underline"
classBoldTextStylePluginsource ↗
class BoldTextStylePlugin extends InlineTextStylePluginBase

Contributes bold rendering and bold document commands.

constructorconstructor
BoldTextStylePlugin(): BoldTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving BoldTextStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

classDocPluginsource ↗
class DocPlugin<StateType> extends Plugin<SearCoreDoc, NodeProperties, StateType>, PluginExtension<DocCommandBus, ObservationRegistry, SessionStateRegistry, DocRuntimeExtensionRegistry>

Convenience base class for a Plugin targeting createDocEditor().

constructorconstructor
DocPlugin<StateType>(__namedParameters: PluginSpec<StateType>): DocPlugin<StateType>

Creates a plugin with its stable identity and initial state.

__namedParameters: PluginSpec<StateType>
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodinitialize
initialize(context: DocPluginRuntimeContext): void

Prepares behavior that requires initialized Core state but must run before runtime effects.

context: DocPluginRuntimeContext
methodonEditorDestroy
onEditorDestroy(context: DocPluginRuntimeContext): void

Releases resources owned by this plugin before the Core is destroyed.

context: DocPluginRuntimeContext
methodregisterBlockFlows
registerBlockFlows(registry: RichTextBlockFlowRegistry): void

Registers plugin-owned top-level block flow resolvers.

registry: RichTextBlockFlowRegistry
methodregisterCapabilities
registerCapabilities(registry: DocRuntimeExtensionRegistry): void

Publishes typed runtime services owned by this document plugin.

registry: DocRuntimeExtensionRegistry
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterInlineStyleRenderers
registerInlineStyleRenderers(registry: RichTextRunRenderRegistry): void

Registers plugin-owned render behavior for styled text runs.

registry: RichTextRunRenderRegistry
methodregisterInlineStyles
registerInlineStyles(registry: RichTextInlineStyleRegistry): void

Registers plugin-owned inline text style readers and mutation policies.

registry: RichTextInlineStyleRegistry
methodregisterKeyboardHandlers
registerKeyboardHandlers(context: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

context: DocKeyboardHandlerRegistrationContext
methodregisterLineBoxes
registerLineBoxes(registry: RichTextLineBoxRegistry): void

Registers plugin-owned rich-text line box resolvers.

registry: RichTextLineBoxRegistry
methodregisterObservations
registerObservations(observations: ObservationRegistry): void

Registers typed state and event observations owned by this document plugin.

observations: ObservationRegistry
methodregisterSessionState
registerSessionState(registry: SessionStateRegistry): void

Registers local state that must survive an in-memory editor remount.

registry: SessionStateRegistry
methodstart
start(context: DocPluginRuntimeContext): void

Starts runtime behavior after the first document frame.

context: DocPluginRuntimeContext
methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers bindings required before this Doc plugin is instantiated.

context: DocPluginServiceContext
Inherited members 34

Inherited from Plugin.

classDocRuntimeExtensionRegistrysource ↗
class DocRuntimeExtensionRegistry extends RuntimeCapabilityRegistry

Registry of extension capabilities available to document plugins.

constructorconstructor
DocRuntimeExtensionRegistry(): DocRuntimeExtensionRegistry
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving the document runtime extension registry.

Inherited members 7

Inherited from RuntimeCapabilityRegistry.

classFontFamilyTextStylePluginsource ↗
class FontFamilyTextStylePlugin extends InlineTextStylePluginBase

Contributes font-family rendering and the set-font-family document command.

constructorconstructor
FontFamilyTextStylePlugin(): FontFamilyTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving FontFamilyTextStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
Inherited members 47

Inherited from InlineTextStylePluginBase.

classFontSizeTextStylePluginsource ↗
class FontSizeTextStylePlugin extends InlineTextStylePluginBase

Contributes font-size rendering and the set-font-size document command.

constructorconstructor
FontSizeTextStylePlugin(): FontSizeTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving FontSizeTextStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
Inherited members 47

Inherited from InlineTextStylePluginBase.

classInlineTextStylePluginBasesource ↗
class InlineTextStylePluginBase extends DocPlugin<null>

Shared lifecycle helper for concrete inline style plugins.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterInlineStyleRenderers
registerInlineStyleRenderers(registry: RichTextRunRenderRegistry): void

Registers plugin-owned render behavior for styled text runs.

registry: RichTextRunRenderRegistry
methodregisterInlineStyles
registerInlineStyles(registry: RichTextInlineStyleRegistry): void

Registers plugin-owned inline text style readers and mutation policies.

registry: RichTextInlineStyleRegistry
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

Inherited members 40

Inherited from DocPlugin.

classItalicTextStylePluginsource ↗
class ItalicTextStylePlugin extends InlineTextStylePluginBase

Contributes italic rendering, mutation, and keyboard commands.

constructorconstructor
ItalicTextStylePlugin(): ItalicTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

classParagraphPluginsource ↗
class ParagraphPlugin extends DocPlugin<null>

Registers paragraph and text node model support plus block-level commands.

constructorconstructor
ParagraphPlugin(): ParagraphPlugin

Creates a ParagraphPlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving ParagraphPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterBlockFlows
registerBlockFlows(registry: RichTextBlockFlowRegistry): void

Registers plugin-owned top-level block flow resolvers.

registry: RichTextBlockFlowRegistry
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
methodregisterLineBoxes
registerLineBoxes(registry: RichTextLineBoxRegistry): void

Registers plugin-owned rich-text line box resolvers.

registry: RichTextLineBoxRegistry
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers paragraph node model support owned by this plugin.

context: DocPluginServiceContext
Inherited members 37

Inherited from DocPlugin.

classRichTextLineBoxPluginsource ↗
class RichTextLineBoxPlugin extends DocPlugin<null>

Registers rich-text line box resolution for document layout.

constructorconstructor
RichTextLineBoxPlugin(): RichTextLineBoxPlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving RichTextLineBoxPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodregisterLineBoxes
registerLineBoxes(registry: RichTextLineBoxRegistry): void

Registers plugin-owned rich-text line box resolvers.

registry: RichTextLineBoxRegistry
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

Inherited members 43

Inherited from DocPlugin.

classStrikethroughTextStylePluginsource ↗
class StrikethroughTextStylePlugin extends InlineTextStylePluginBase

Contributes strikethrough rendering, mutation, and keyboard commands.

constructorconstructor
StrikethroughTextStylePlugin(): StrikethroughTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

classTablePluginsource ↗
class TablePlugin extends DocPlugin<null>

Contributes table model and insertion command without adding table knowledge to Core.

constructorconstructor
TablePlugin(): TablePlugin

Creates a TablePlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving TablePlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers table node model support owned by this plugin.

context: DocPluginServiceContext
Inherited members 40

Inherited from DocPlugin.

classTextColorStylePluginsource ↗
class TextColorStylePlugin extends InlineTextStylePluginBase

Contributes text-color rendering and mutation for text nodes.

constructorconstructor
TextColorStylePlugin(): TextColorStylePlugin

Creates a TextColorStylePlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving TextColorStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
Inherited members 47

Inherited from InlineTextStylePluginBase.

classUnderlineTextStylePluginsource ↗
class UnderlineTextStylePlugin extends InlineTextStylePluginBase

Contributes underline rendering, mutation, and keyboard commands.

constructorconstructor
UnderlineTextStylePlugin(): UnderlineTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

interfaceDocCaretStateCapabilitysource ↗
interface DocCaretStateCapability

Caret-state capability consumed by document plugins.

methodisVisible
isVisible(): boolean
methodreset
reset(): void
interfaceDocInputBindingRegistryCapabilitysource ↗
interface DocInputBindingRegistryCapability

Input-binding capability consumed by document plugins.

methodregisterKeyboardHandlers
registerKeyboardHandlers(handlers: KeyboardRouterHandlers): (): void
handlers: KeyboardRouterHandlers
methodregisterTextHandlers
registerTextHandlers(handlers: TextInputHandlers): (): void
handlers: TextInputHandlers
interfaceDocInteractionContentRectsource ↗
interface DocInteractionContentRect extends DocInteractionViewport

Current document content rectangle exposed to interaction plugins.

propertyx
readonly x: number
propertyy
readonly y: number
Inherited members 2

Inherited from DocInteractionViewport.

interfaceDocInteractionRuntimesource ↗
interface DocInteractionRuntime

View services exposed to document interaction plugins.

methodgetContentRect
getContentRect(): DocInteractionContentRect
methodgetRoot
getRoot(): unknown
methodgetViewport
getViewport(): DocInteractionViewport
methodreadRootViewOffset
readRootViewOffset(): { x: number; y: number }
methodresolveCursorFromPointer
resolveCursorFromPointer(input: DocPointerInput): DocCursorPos
input: DocPointerInput
methodsubscribePointerDrag
subscribePointerDrag(handlers: DocPointerDragHandlers): (): void
handlers: DocPointerDragHandlers
interfaceDocInteractionViewportsource ↗
interface DocInteractionViewport

Current document viewport model exposed to interaction plugins.

propertyheight
readonly height: number
propertywidth
readonly width: number
interfaceDocKeyboardHandlerRegistrationContextsource ↗
interface DocKeyboardHandlerRegistrationContext

Services available while a Doc plugin registers keyboard bindings.

propertybindings
readonly bindings: DocInputBindingRegistryCapability

Aggregates plugin-owned keyboard handlers for the host adapter.

propertycommands
readonly commands: DocCommandBus

Executes semantic editor commands from keyboard handlers.

interfaceDocPluginImplementationsource ↗
interface DocPluginImplementation<TPlugin>

Injectable DocPlugin class accepted by createDocEditor().

constructorconstructor
DocPluginImplementation(...args: never[]): TPlugin
args: never[]
propertysymbol
readonly symbol: symbol
methodregisterServices
registerServices(context: DocPluginServiceContext): void
context: DocPluginServiceContext
interfaceDocPluginRuntimesource ↗
interface DocPluginRuntime

Stable host capabilities supplied to a DocPlugin after editor assembly.

propertycommands
readonly commands: DocCommandBus

Command bus exposed by the document editor instance.

propertydocument
readonly document: { blockFlows: RichTextBlockFlowRegistry; core: SearCoreDoc; cursor: DocCursorManager; inlineStyles: RichTextInlineStyleRegistry; input: DocInputPlugin; layout: DocLayoutEngine; lineBoxes: RichTextLineBoxRegistry; nodes: DocNodeRegistry }

Rich-document domain services.

propertyevents
readonly events: { engine: EventEngine<NodeProperties>; registrar: EventRegistrar }

Event and hit-test services used by document interactions.

propertyextensions
readonly extensions: DocRuntimeExtensionRegistry

Extension capability registry for third-party document plugins.

propertyinput
readonly input: { keyboard: KeyboardRouter; pointer: PointerCapture; text: TextInput }

Host input adapters used by document editing commands.

propertyobservations
readonly observations: ObservationRegistry

Typed state and event observations owned by this editor instance.

propertyplatform
readonly platform: Platform

Platform adapter for timers, resize observation, and diagnostics.

propertyplugins
readonly plugins: PluginManager<SearCoreDoc, NodeProperties>

Ordered document plugin registry for this editor.

propertyrender
readonly render: { context: RenderContext; engine: DocRenderEngineCapability }

Document render services and visible context.

propertyscroll
readonly scroll: { manager: ScrollManager }

Scroll state shared by document layout and rendering.

propertysession
readonly session: SessionStateRegistry

Local remount state contributed by built-in and third-party plugins.

propertytextShaper
readonly textShaper: TextShaper

Text shaper used by document layout and rendering.

interfaceDocPluginRuntimeContextsource ↗
interface DocPluginRuntimeContext extends DocPluginSetupContext

Document setup capabilities plus the Core created by createDocEditor().

propertycore
readonly core: SearCoreDoc

Core document runtime.

Inherited members 2

Inherited from DocPluginSetupContext.

interfaceDocPluginServiceContextsource ↗
interface DocPluginServiceContext

Services available while createDocEditor() registers document plugins.

propertycontainer
readonly container: Container

DI container used by the document assembly root.

interfaceDocPluginSetupContextsource ↗
interface DocPluginSetupContext

Typed public services available before createDocEditor() starts Core.

propertycontainer
readonly container: Container

DI container used by the document assembly root.

propertyruntime
readonly runtime: DocPluginRuntime

Runtime services available to document plugins.

interfaceDocPointerDragHandlerssource ↗
interface DocPointerDragHandlers

Document pointer-drag lifecycle consumed by interaction plugins.

methodonEnd
onEnd(): void
methodonMove
onMove(input: DocPointerInput): void
input: DocPointerInput
methodonStart
onStart(input: DocPointerInput): void
input: DocPointerInput
interfaceDocPointerInputsource ↗
interface DocPointerInput

Pointer input used by document interaction plugins.

propertyviewX
readonly viewX: number
propertyviewY
readonly viewY: number
methodpreventDefault
preventDefault(): void
interfaceDocRenderEngineCapabilitysource ↗
interface DocRenderEngineCapability

Render-engine surface exposed to Doc plugins.

methodrender
render(pluginKey?: unknown): void
pluginKey: unknown
interfaceDocRenderLayoutServiceCapabilitysource ↗
interface DocRenderLayoutServiceCapability

Public layout-service surface exposed to Doc plugins and hosts.

methodgetLatestVirtualLayoutSummary
getLatestVirtualLayoutSummary(): DocVirtualLayoutSummary | null
methodreset
reset(): void
methodsubscribeVirtualLayoutSummary
subscribeVirtualLayoutSummary(listener: DocVirtualLayoutSummaryListener): (): void
listener: DocVirtualLayoutSummaryListener
interfaceDocVirtualLayoutSummarysource ↗
interface DocVirtualLayoutSummary

Public virtual layout summary exposed through the Doc layout-service capability.

propertyblockRender
readonly blockRender?: DocBlockRenderDebugSnapshot
propertycacheHits
readonly cacheHits: number
propertycacheMisses
readonly cacheMisses: number
propertycursorBlock
readonly cursorBlock: number | null
propertydocumentHeight
readonly documentHeight: number
propertyheightIndexUpdated
readonly heightIndexUpdated: boolean
propertyinitialLoadMs
readonly initialLoadMs?: number
propertymaterializedBlocks
readonly materializedBlocks: number
propertymaterializedIndexes
readonly materializedIndexes: string
propertymodel
readonly model: "reused" | "rebuilt"
propertyrangeEnd
readonly rangeEnd: number
propertyrangeStart
readonly rangeStart: number
propertyrenderPhase
readonly renderPhase?: DocVirtualLayoutRenderPhase
propertytimings
readonly timings: DocVirtualLayoutTimingSummary
propertytotalBlocks
readonly totalBlocks: number
interfaceDocVirtualLayoutTimingSummarysource ↗
interface DocVirtualLayoutTimingSummary

Timing summary reported by virtual document layout instrumentation.

propertycursorSelectionMs
readonly cursorSelectionMs: number
propertydocumentModelMs
readonly documentModelMs: number
propertyheightCorrectionMs
readonly heightCorrectionMs: number
propertymaterializeBlocksMs
readonly materializeBlocksMs: number
propertyrenderPrepareMode
readonly renderPrepareMode?: "full" | "viewport"
propertyrenderPrepareMs
readonly renderPrepareMs?: number
propertysnapshotCacheMs
readonly snapshotCacheMs: number
propertyviewportRangeMs
readonly viewportRangeMs: number
propertyvirtualLayoutTotalMs
readonly virtualLayoutTotalMs: number
interfaceInsertDocTableInputsource ↗
interface InsertDocTableInput

Input accepted by InsertDocTableCommand.

propertycolumns
readonly columns: number

Number of columns in the inserted table.

propertyrows
readonly rows: number

Number of rows in the inserted table.

interfaceInsertDocTextInputsource ↗
interface InsertDocTextInput

Input accepted by InsertDocTextCommand.

propertytext
readonly text: string

Text to insert at the current document selection.

interfaceLoadDocumentInputsource ↗
interface LoadDocumentInput

Input accepted by LoadDocumentCommand.

propertydocument
readonly document: RichDocNode[]

Rich-document content to load into the document editor.

interfaceMoveDocCursorInputsource ↗
interface MoveDocCursorInput

Input accepted by MoveDocCursorCommand.

propertydirection
readonly direction: DocCursorDirection

Direction for cursor movement.

propertyshiftKey
readonly shiftKey?: boolean

Whether the movement should extend the current selection.

interfaceSetDocBoldInputsource ↗
interface SetDocBoldInput

Input accepted by SetDocBoldCommand. A null or false value clears bold.

propertybold
readonly bold: boolean | null
interfaceSetDocCompositionInputsource ↗
interface SetDocCompositionInput

Input accepted by SetDocCompositionCommand.

propertycaretOffset
readonly caretOffset: number

Caret offset inside the composing text.

propertytext
readonly text: string

Current composing text emitted by the host input method.

interfaceSetDocFontFamilyInputsource ↗
interface SetDocFontFamilyInput

Input accepted by SetDocFontFamilyCommand. A null or empty value clears the font family.

propertyfontFamily
readonly fontFamily: string | null
interfaceSetDocFontSizeInputsource ↗
interface SetDocFontSizeInput

Input accepted by SetDocFontSizeCommand. A null or empty value clears the font size.

propertyfontSize
readonly fontSize: number | null
interfaceSetDocItalicInputsource ↗
interface SetDocItalicInput
propertyitalic
readonly italic: boolean | null
interfaceSetDocLineSpacingInputsource ↗
interface SetDocLineSpacingInput

Input accepted by SetDocLineSpacingCommand. Null clears the paragraph override.

propertylineSpacing
readonly lineSpacing: RichTextLineSpacing | null
interfaceSetDocParagraphSpacingAfterInputsource ↗
interface SetDocParagraphSpacingAfterInput

Input accepted by SetDocParagraphSpacingAfterCommand. Null clears the paragraph override.

propertyspacingAfter
readonly spacingAfter: number | null
interfaceSetDocSelectionInputsource ↗
interface SetDocSelectionInput

Input accepted by SetDocSelectionCommand.

propertyselection
readonly selection: DocSelection

Selection to make active in the document editor.

interfaceSetDocStrikethroughInputsource ↗
interface SetDocStrikethroughInput
propertystrikethrough
readonly strikethrough: boolean | null
interfaceSetDocTextColorInputsource ↗
interface SetDocTextColorInput

Input accepted by SetDocTextColorCommand. A null or empty value clears the text color.

propertycolor
readonly color: string | null
interfaceSetDocUnderlineInputsource ↗
interface SetDocUnderlineInput
propertyunderline
readonly underline: boolean | null
typeDocRuntimeCapabilityReadersource ↗
type DocRuntimeCapabilityReader = RuntimeCapabilityReader

Read-only view of editor-local document runtime capabilities exposed to hosts.

typeDocRuntimeCapabilityTokensource ↗
type DocRuntimeCapabilityToken = RuntimeCapability<T>

Typed token used to publish and consume document runtime capabilities.

typeDocVirtualLayoutRenderPhasesource ↗
type DocVirtualLayoutRenderPhase = "initial" | "realtime"

Render phase reported by virtual document layout instrumentation.

typeDocVirtualLayoutSummaryListenersource ↗
type DocVirtualLayoutSummaryListener = (summary: DocVirtualLayoutSummary): void

Listener notified when the virtual layout summary changes.

variableClearDocCompositionCommandsource ↗
ClearDocCompositionCommand: DocCommandDefinition<void, DocCommandResult>

Clears the active IME composition preview text.

variableDeleteDocBackwardCommandsource ↗
DeleteDocBackwardCommand: DocCommandDefinition<void, DocCommandResult>

Deletes content before the current document selection.

variableDocCaretPluginKeysource ↗
DocCaretPluginKey: PluginKey
variableDocCompositionPluginKeysource ↗
DocCompositionPluginKey: PluginKey
variableDocContentRenderPluginKeysource ↗
DocContentRenderPluginKey: PluginKey

Default document feature plugin keys used by command pipelines.

variableDocPluginRuntimeCapabilitysource ↗
DocPluginRuntimeCapability: { CaretState: DocRuntimeCapability<DocCaretStateCapability>; Composition: DocRuntimeCapability<DocCompositionManager>; InputBindings: DocRuntimeCapability<DocInputBindingRegistryCapability>; Interaction: DocRuntimeCapability<DocInteractionRuntime> }

Runtime extension tokens owned by document plugins assembled by editor composition roots.

variableDocRuntimeCapabilitysource ↗
DocRuntimeCapability: { BlockFlows: DocRuntimeCapability<RichTextBlockFlowRegistry>; Commands: DocRuntimeCapability<DocCommandBus>; Config: DocRuntimeCapability<ConfigEngine<any>>; Document: DocRuntimeCapability<{ blockFlows: RichTextBlockFlowRegistry; core: SearCoreDoc; cursor: DocCursorManager; inlineStyles: RichTextInlineStyleRegistry; input: DocInputPlugin; layout: DocLayoutEngine; lineBoxes: RichTextLineBoxRegistry; nodes: DocNodeRegistry }>; Events: DocRuntimeCapability<{ engine: EventEngine<NodeProperties>; registrar: EventRegistrar }>; InlineStyles: DocRuntimeCapability<RichTextInlineStyleRegistry>; Input: DocRuntimeCapability<{ keyboard: KeyboardRouter; pointer: PointerCapture; text: TextInput }>; LayoutService: DocRuntimeCapability<DocRenderLayoutServiceCapability>; … }

Document runtime capabilities registered by the default assembly root.

variableDocSelectionPluginKeysource ↗
DocSelectionPluginKey: PluginKey
variableFocusDocCommandsource ↗
FocusDocCommand: DocCommandDefinition<void, DocCommandResult>

Focuses the host text-input adapter for the document editor.

variableInsertDocTableCommandsource ↗
InsertDocTableCommand: DocCommandDefinition<InsertDocTableInput, DocCommandResult>

Inserts a table block at the current document position.

variableInsertDocTextCommandsource ↗
InsertDocTextCommand: DocCommandDefinition<InsertDocTextInput, DocCommandResult>

Inserts text at the current document selection.

variableLoadDocumentCommandsource ↗
LoadDocumentCommand: DocCommandDefinition<LoadDocumentInput, DocCommandResult>

Replaces the active document content.

variableMoveDocCursorCommandsource ↗
MoveDocCursorCommand: DocCommandDefinition<MoveDocCursorInput, DocCommandResult>

Moves the current document cursor.

variableRenderDocCommandsource ↗
RenderDocCommand: DocCommandDefinition<void, DocCommandResult>

Requests a document render without changing content.

variableSelectAllDocCommandsource ↗
SelectAllDocCommand: DocCommandDefinition<void, DocCommandResult>

Selects all document content.

variableSetDocBoldCommandsource ↗
SetDocBoldCommand: DocCommandDefinition<SetDocBoldInput, DocCommandResult>

Sets whether the selected document text is bold.

variableSetDocCompositionCommandsource ↗
SetDocCompositionCommand: DocCommandDefinition<SetDocCompositionInput, DocCommandResult>

Sets the active IME composition preview text.

variableSetDocFontFamilyCommandsource ↗
SetDocFontFamilyCommand: DocCommandDefinition<SetDocFontFamilyInput, DocCommandResult>

Sets the font family on the selected document text.

variableSetDocFontSizeCommandsource ↗
SetDocFontSizeCommand: DocCommandDefinition<SetDocFontSizeInput, DocCommandResult>

Sets the font size in pixels on the selected document text.

variableSetDocItalicCommandsource ↗
SetDocItalicCommand: DocCommandDefinition<SetDocItalicInput, DocCommandResult>
variableSetDocLineSpacingCommandsource ↗
SetDocLineSpacingCommand: DocCommandDefinition<SetDocLineSpacingInput, DocCommandResult>

Sets or clears line-spacing overrides on the selected paragraphs.

variableSetDocParagraphSpacingAfterCommandsource ↗
SetDocParagraphSpacingAfterCommand: DocCommandDefinition<SetDocParagraphSpacingAfterInput, DocCommandResult>

Sets or clears after-spacing overrides on the selected paragraphs.

variableSetDocSelectionCommandsource ↗
SetDocSelectionCommand: DocCommandDefinition<SetDocSelectionInput, DocCommandResult>

Sets the active document selection without changing content.

variableSetDocStrikethroughCommandsource ↗
SetDocStrikethroughCommand: DocCommandDefinition<SetDocStrikethroughInput, DocCommandResult>
variableSetDocTextColorCommandsource ↗
SetDocTextColorCommand: DocCommandDefinition<SetDocTextColorInput, DocCommandResult>

Sets the text color on the selected document text.

variableSetDocUnderlineCommandsource ↗
SetDocUnderlineCommand: DocCommandDefinition<SetDocUnderlineInput, DocCommandResult>
variableSplitDocParagraphCommandsource ↗
SplitDocParagraphCommand: DocCommandDefinition<void, DocCommandResult>

Splits the current paragraph at the current document selection.

variableToggleDocBoldCommandsource ↗
ToggleDocBoldCommand: DocCommandDefinition<void, DocCommandResult>

Toggles bold on the selected document text.

variableToggleDocItalicCommandsource ↗
ToggleDocItalicCommand: DocCommandDefinition<void, DocCommandResult>
variableToggleDocStrikethroughCommandsource ↗
ToggleDocStrikethroughCommand: DocCommandDefinition<void, DocCommandResult>
variableToggleDocUnderlineCommandsource ↗
ToggleDocUnderlineCommand: DocCommandDefinition<void, DocCommandResult>
functioncreateBoldContributionsource ↗
createBoldContribution(): RichTextInlineStyleContribution

Creates the shared bold inline style contribution.

functioncreateBoldRenderContributionsource ↗
createBoldRenderContribution(): RichTextRunRenderContribution

Creates the render-layer bold contribution.

functioncreateDocCommandsource ↗
createDocCommand(id: string, renderPluginKey: PluginKey | readonly PluginKey[], createTransaction?: (): Transaction, effects?: readonly DocCommandEffect[] | undefined, localAction?: (): void): DocEditorCommand

Creates a pipeline-backed document command with an optional transaction or local action.

id: string
renderPluginKey: PluginKey | readonly PluginKey[]
createTransaction: (): Transaction
effects: readonly DocCommandEffect[] | undefined
localAction: (): void
functioncreateFontFamilyContributionsource ↗
createFontFamilyContribution(): RichTextInlineStyleContribution

Creates the shared font-family inline style contribution.

functioncreateFontFamilyRenderContributionsource ↗
createFontFamilyRenderContribution(): RichTextRunRenderContribution

Creates the render-layer font-family contribution.

functioncreateFontSizeContributionsource ↗
createFontSizeContribution(): RichTextInlineStyleContribution

Creates the shared font-size inline style contribution.

functioncreateFontSizeRenderContributionsource ↗
createFontSizeRenderContribution(): RichTextRunRenderContribution

Creates the render-layer font-size contribution.

functioncreateItalicContributionsource ↗
createItalicContribution(): RichTextInlineStyleContribution
functioncreateItalicRenderContributionsource ↗
createItalicRenderContribution(): RichTextRunRenderContribution

Creates the render-layer italic contribution.

functioncreateStrikethroughContributionsource ↗
createStrikethroughContribution(): RichTextInlineStyleContribution
functioncreateStrikethroughRenderContributionsource ↗
createStrikethroughRenderContribution(): RichTextRunRenderContribution

Creates the render-layer strikethrough contribution.

functioncreateTextColorContributionsource ↗
createTextColorContribution(): RichTextInlineStyleContribution

Creates the shared text-color inline style contribution.

functioncreateTextColorRenderContributionsource ↗
createTextColorRenderContribution(): RichTextRunRenderContribution

Creates the render-layer text-color contribution.

functioncreateUnderlineContributionsource ↗
createUnderlineContribution(): RichTextInlineStyleContribution
functioncreateUnderlineRenderContributionsource ↗
createUnderlineRenderContribution(): RichTextRunRenderContribution

Creates the render-layer underline contribution.

functiondefineDocRuntimeCapabilitysource ↗
defineDocRuntimeCapability<T>(id: string): DocRuntimeCapability<T>

Creates a typed document runtime capability token.

id: string
functionregisterDocPluginBlockFlowssource ↗
registerDocPluginBlockFlows(plugins: readonly unknown[], registry: RichTextBlockFlowRegistry): (): void

Registers every top-level block flow contribution owned by document plugins.

plugins: readonly unknown[]
registry: RichTextBlockFlowRegistry
functionregisterDocPluginCapabilitiessource ↗
registerDocPluginCapabilities(plugins: readonly unknown[], registry: DocRuntimeExtensionRegistry): void

Publishes every typed runtime capability contributed by document plugins.

plugins: readonly unknown[]
registry: DocRuntimeExtensionRegistry
functionregisterDocPluginCommandssource ↗
registerDocPluginCommands(plugins: readonly unknown[], commands: DocCommandBus): (): void

Runs the register document plugin commands helper.

plugins: readonly unknown[]
commands: DocCommandBus
functionregisterDocPluginInlineStyleRendererssource ↗
registerDocPluginInlineStyleRenderers(plugins: readonly unknown[], registry: RichTextRunRenderRegistry): (): void

Registers every rich-text run renderer contributed by document plugins.

plugins: readonly unknown[]
registry: RichTextRunRenderRegistry
functionregisterDocPluginInlineStylessource ↗
registerDocPluginInlineStyles(plugins: readonly unknown[], registry: RichTextInlineStyleRegistry): (): void

Registers every inline text-style contribution owned by document plugins.

plugins: readonly unknown[]
registry: RichTextInlineStyleRegistry
functionregisterDocPluginKeyboardHandlerssource ↗
registerDocPluginKeyboardHandlers(plugins: readonly unknown[], context: DocKeyboardHandlerRegistrationContext): (): void

Registers every keyboard binding contributed by document plugins.

plugins: readonly unknown[]
context: DocKeyboardHandlerRegistrationContext
functionregisterDocPluginLineBoxessource ↗
registerDocPluginLineBoxes(plugins: readonly unknown[], registry: RichTextLineBoxRegistry): (): void

Registers every rich-text line box contribution owned by document plugins.

plugins: readonly unknown[]
registry: RichTextLineBoxRegistry
functionregisterDocPluginObservationssource ↗
registerDocPluginObservations(plugins: readonly unknown[], observations: ObservationRegistry): void

Registers every typed observation source contributed by document plugins.

plugins: readonly unknown[]
observations: ObservationRegistry
functionregisterDocPluginSessionStatessource ↗
registerDocPluginSessionStates(plugins: readonly unknown[], registry: SessionStateRegistry): void

Registers every local session-state adapter contributed by document plugins.

plugins: readonly unknown[]
registry: SessionStateRegistry