Class: Text

Type that represents text with formatting information.

This type replaces y-richtext as this implementation is able to handle block formats (format information on a paragraph), embeds (complex elements like pictures and videos), and text formats (bold, italic).

Extends

AbstractType< YTextEvent >

Constructors

constructor

new Text(string?): Text

Parameters

Parameter	Type	Description
`string`?	`string`	The initial value of the YText.

Returns

Text

Overrides

AbstractType.constructor

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:97

Properties

_dEH

_dEH: EventHandler< YEvent< any >[], Transaction >

Deep event handlers

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:46

Inherited from

AbstractType._dEH

_eH

_eH: EventHandler< YTextEvent, Transaction >

Event handlers

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:41

Inherited from

AbstractType._eH

_hasFormatting

_hasFormatting: boolean

Whether this YText contains formatting attributes. This flag is updated when a formatting item is integrated (see ContentFormat.integrate)

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:107

_item

_item: null | Item

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:23

Inherited from

AbstractType._item

_length

_length: number

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:36

Inherited from

AbstractType._length

_map

_map: Map< string, Item >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:27

Inherited from

AbstractType._map

_pending

_pending: null | () => void[]

Array of pending operations on this type

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:102

_searchMarker

_searchMarker: null | ArraySearchMarker[]

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:50

Inherited from

AbstractType._searchMarker

_start

_start: null | Item

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:31

Inherited from

AbstractType._start

doc

doc: null | Doc

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:35

Inherited from

AbstractType.doc

Accessors

_first

get _first(): null | Item

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:81

Inherited from

AbstractType._first

length

get length(): number

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:113

parent

get parent(): null | AbstractType< any >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:54

Inherited from

AbstractType.parent

Methods

_callObserver

_callObserver(transaction, _parentSubs): void

Creates YEvent and calls all type observers. Must be implemented by each type.

Parameters

Parameter	Type	Description
`transaction`	`Transaction`	-
`_parentSubs`	`Set`< `null` \| `string` >	Keys changed on this type. `null` if list was modified.

Returns

void

Inherited from

AbstractType._callObserver

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:89

_copy

_copy(): Text

Returns

Text

Overrides

AbstractType._copy

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:119

_integrate

_integrate(y, item): void

Integrate this type into the Yjs instance.

Save this struct in the os
This type is sent to other client
Observer functions are fired

Parameters

Parameter	Type	Description
`y`	`Doc`	The Yjs instance
`item`	`Item`	-

Returns

void

Overrides

AbstractType._integrate

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:118

_write

_write(_encoder): void

Parameters

Parameter	Type
`_encoder`	`UpdateEncoderV1` \| `UpdateEncoderV2`

Returns

void

Inherited from

AbstractType._write

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:77

applyDelta

applyDelta(delta, opts?): void

Apply a Delta on this shared YText type.

Parameters

Parameter	Type	Description
`delta`	`any`	The changes to apply on this element.
`opts`?	`object`	-
`opts.sanitize`?	`boolean`	Sanitize input delta. Removes ending newlines if set to true.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:141

clone

clone(): Text

Returns

Text

Overrides

AbstractType.clone

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:123

delete

delete(index, length): void

Deletes text starting from an index.

Parameters

Parameter	Type	Description
`index`	`number`	Index at which to start deleting.
`length`	`number`	The number of characters to remove. Defaults to 1.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:185

format

format( index, length, attributes): void

Assigns properties to a range of text.

Parameters

Parameter	Type	Description
`index`	`number`	The position where to start formatting.
`length`	`number`	The amount of characters to assign properties to.
`attributes`	`Object`	Attribute information to apply on the text.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:196

getAttribute

getAttribute(attributeName): any

Returns an attribute value that belongs to the attribute name.

Parameters

Parameter	Type	Description
`attributeName`	`string`	The attribute name that identifies the queried value.

Returns

any

The queried attribute value.

Note

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:229

getAttributes

getAttributes(): object

Returns all attribute name/value pairs in a JSON Object.

Returns

object

A JSON Object that describes the attributes.

Note

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:239

insert

insert( index, text, attributes?): void

Insert text at a given index.

Parameters

Parameter	Type	Description
`index`	`number`	The index at which to start inserting.
`text`	`string`	The text to insert at the specified position.
`attributes`?	`Object`	Optionally define some formatting information to apply on the inserted Text.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:165

insertEmbed

insertEmbed( index, embed, attributes?): void

Inserts an embed at a index.

Parameters

Parameter	Type	Description
`index`	`number`	The index to insert the embed at.
`embed`	`Object` \| `AbstractType`< `any` >	The Object that represents the embed.
`attributes`?	`Object`	Attribute information to apply on the embed

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:176

observe

observe(f): void

Observe all events that are created on this type.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.observe

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:95

observeDeep

observeDeep(f): void

Observe all events that are created by this type and its children.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.observeDeep

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:101

removeAttribute

removeAttribute(attributeName): void

Removes an attribute.

Parameters

Parameter	Type	Description
`attributeName`	`string`	The attribute name that is to be removed.

Returns

void

Note

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:206

setAttribute

setAttribute(attributeName, attributeValue): void

Sets or updates an attribute.

Parameters

Parameter	Type	Description
`attributeName`	`string`	The attribute name that is to be set.
`attributeValue`	`any`	The attribute value that is to be set.

Returns

void

Note

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:217

toDelta

toDelta( snapshot?, prevSnapshot?, computeYChange?): any

Returns the Delta representation of this YText type.

Parameters

Parameter	Type
`snapshot`?	`Snapshot`
`prevSnapshot`?	`Snapshot`
`computeYChange`?	`function`

Returns

any

The Delta representation of this type.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:154

toJSON

toJSON(): string

Returns the unformatted string representation of this YText type.

Returns

string

Overrides

AbstractType.toJSON

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YText.d.ts:130

unobserve

unobserve(f): void

Unregister an observer function.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.unobserve

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:107

unobserveDeep

unobserveDeep(f): void

Unregister an observer function.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.unobserveDeep

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/AbstractType.d.ts:113

Class: Text ​

Extends ​

Constructors ​

constructor ​

Parameters ​

Returns ​

Overrides ​

Defined In ​

Properties ​

_dEH ​

Defined In ​

Inherited from ​

_eH ​

Defined In ​

Inherited from ​

_hasFormatting ​

Defined In ​

_item ​

Defined In ​

Inherited from ​

_length ​

Defined In ​

Inherited from ​

_map ​

Defined In ​

Inherited from ​

_pending ​

Defined In ​

_searchMarker ​

Defined In ​

Inherited from ​

_start ​

Defined In ​

Inherited from ​

doc ​

Defined In ​

Inherited from ​

Accessors ​

_first ​

Defined In ​

Inherited from ​

length ​

Defined In ​

parent ​

Defined In ​

Inherited from ​

Methods ​

_callObserver ​

Parameters ​

Returns ​

Inherited from ​

Defined In ​

_copy ​

Returns ​

Overrides ​

Defined In ​

_integrate ​

Parameters ​

Returns ​

Overrides ​

Defined In ​

_write ​

Parameters ​

Returns ​

Inherited from ​

Defined In ​

applyDelta ​

Parameters ​

Returns ​

Defined In ​

clone ​

Returns ​

Overrides ​

Defined In ​

delete ​

Parameters ​

Returns ​

Defined In ​

format ​

Parameters ​

Class: Text

Extends

Constructors

constructor

Parameters

Returns

Overrides

Defined In

Properties

_dEH

Defined In

Inherited from

_eH

Defined In

Inherited from

_hasFormatting

Defined In

_item

Defined In

Inherited from

_length

Defined In

Inherited from

_map

Defined In

Inherited from

_pending

Defined In

_searchMarker

Defined In

Inherited from

_start

Defined In

Inherited from

doc

Defined In

Inherited from

Accessors

_first

Defined In

Inherited from

length

Defined In

parent

Defined In

Inherited from

Methods

_callObserver

Parameters

Returns

Inherited from

Defined In

_copy

Returns

Overrides

Defined In

_integrate

Parameters

Returns

Overrides

Defined In

_write

Parameters

Returns

Inherited from

Defined In

applyDelta

Parameters

Returns

Defined In

clone

Returns

Overrides

Defined In

delete

Parameters

Returns

Defined In

format

Parameters