PlainText Namespace

A collection of text related types, schema and utilities for working with text beyond the basic string.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

For more information about our API support guarantees, see here.

Signature

export declare namespace PlainText

Interfaces

Interface	Alerts	Modifiers	Description
Members	Alpha	sealed	Interface for a text node.
Statics	Alpha		Statics for text nodes.
TextInsertOp	Alpha	sealed	An insert op in a character-level delta — characters newly added to the text.
TextRemoveOp	Alpha	sealed	A remove op in a character-level delta — a span of characters that has been deleted from the text.
TextRetainOp	Alpha	sealed	A retain op in a character-level delta — a span of unchanged characters that the consumer should skip over.

Types

TypeAlias	Alerts	Description
TextOp	Alpha	A single operation in a character-level delta describing an insert, remove, or retain of text.
Tree	Alpha	Node for the Tree schema exposing the Members API.

Variables

Variable	Alerts	Modifiers	Type	Description
Tree	Alpha	readonly	Statics & TreeNodeSchema<"com.fluidframework.text.Text", NodeKind, Members & TreeNode & WithType<"com.fluidframework.text.Text", NodeKind, unknown>, never, false>	Schema for a Tree node.

Variable Details

Tree

Schema for a Tree node.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

Tree: Statics & TreeNodeSchema<"com.fluidframework.text.Text", NodeKind, Members & TreeNode & WithType<"com.fluidframework.text.Text", NodeKind, unknown>, never, false>

Type: Statics & TreeNodeSchema<"com.fluidframework.text.Text", NodeKind, Members & TreeNode & WithType<"com.fluidframework.text.Text", NodeKind, unknown>, never, false>

Remarks

See Statics for static APIs on this schema, including construction.