Skip to main content

TextAsTree 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 TextAsTree

Interfaces

InterfaceAlertsDescription
MembersAlphaInterface for a text node.
StaticsAlphaStatics for text nodes.

Types

TypeAliasAlertsDescription
TreeAlphaNode for the Tree schema exposing the Members API.

Variables

VariableAlertsModifiersTypeDescription
TreeAlphareadonlyStatics & 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.