BlockSuite API Documentation / @blocksuite/store / Text

Class: Text

Defined in: packages/framework/store/src/reactive/text.ts:18

Constructors

new Text()

new Text(input?, onChange?): Text

Defined in: packages/framework/store/src/reactive/text.ts:39

Parameters

input?

string | YText | DeltaInsert[]

onChange?

OnTextChange

Returns

Text

Accessors

deltas$

Get Signature

get deltas$(): Signal<DeltaOperation[]>

Defined in: packages/framework/store/src/reactive/text.ts:27

Returns

Signal<DeltaOperation[]>

---

length

Get Signature

get length(): number

Defined in: packages/framework/store/src/reactive/text.ts:31

Returns

number

---

yText

Get Signature

get yText(): YText

Defined in: packages/framework/store/src/reactive/text.ts:35

Returns

YText

Methods

applyDelta()

applyDelta(delta): void

Defined in: packages/framework/store/src/reactive/text.ts:97

Parameters

delta

DeltaOperation[]

Returns

void

---

bind()

bind(onChange?): void

Defined in: packages/framework/store/src/reactive/text.ts:103

Parameters

onChange?

OnTextChange

Returns

void

---

clear()

clear(): void

Defined in: packages/framework/store/src/reactive/text.ts:107

Returns

void

---

clone()

clone(): Text

Defined in: packages/framework/store/src/reactive/text.ts:116

Returns

Text

---

delete()

delete(index, length): void

Defined in: packages/framework/store/src/reactive/text.ts:120

Parameters

index

number

length

number

Returns

void

---

format()

format(index, length, format): void

Defined in: packages/framework/store/src/reactive/text.ts:140

Parameters

index

number

length

number

format

any

Returns

void

---

insert()

insert(content, index, attributes?): void

Defined in: packages/framework/store/src/reactive/text.ts:160

Parameters

content

string

index

number

attributes?

Record<string, unknown>

Returns

void

---

join()

join(other): void

Defined in: packages/framework/store/src/reactive/text.ts:180

Parameters

other

Text

Returns

void

---

replace()

replace(index, length, content, attributes?): void

Defined in: packages/framework/store/src/reactive/text.ts:192

Parameters

index

number

length

number

content

string

attributes?

bold?

null | true

code?

null | true

italic?

null | true

link?

null | string

strike?

null | true

underline?

null | true

Returns

void

---

sliceToDelta()

sliceToDelta(begin, end?): DeltaOperation[]

Defined in: packages/framework/store/src/reactive/text.ts:216

Parameters

begin

number

end?

number

Returns

DeltaOperation[]

---

split()

split(index, length): Text

Defined in: packages/framework/store/src/reactive/text.ts:286

NOTE: The string included in [index, index + length) will be deleted.

Here are three cases for point position(index + length): [{insert: 'abc', ...}, {insert: 'def', ...}, {insert: 'ghi', ...}]

1. abc|de|fghi left: [{insert: 'abc', ...}] right: [{insert: 'f', ...}, {insert: 'ghi', ...}]
2. abc|def|ghi left: [{insert: 'abc', ...}] right: [{insert: 'ghi', ...}]
3. abc|defg|hi left: [{insert: 'abc', ...}] right: [{insert: 'hi', ...}]

Parameters

index

number

length

number = 0

Returns

Text

---

toDelta()

toDelta(): DeltaOperation[]

Defined in: packages/framework/store/src/reactive/text.ts:336

Returns

DeltaOperation[]

---

toString()

toString(): string

Defined in: packages/framework/store/src/reactive/text.ts:340

Returns

string