TextBehavior

Class Stability: stable Stable contract

The editing of a block's rich text: wraps a Loro text and offers the reactive text and delta, the selection in that text, and insertion, deletion, splitting, marks and links. Text blocks use it through TextBlock; a container with a header (list item, toggle) owns one.

Related guide: Extensions →

Import

TypeScript

import { TextBehavior } from '@aionbuilders/nabu/extend';

Constructor

TypeScript

new TextBehavior(block: Block, container?: LoroText)

Parameters of the constructor
Parameter	Type	Description
`block`	`Block`	n/a
`container`optional	`LoroText`	n/a

Properties

`block`

TypeScript

block: Block

`container`

TypeScript

container: LoroText

`delta`

TypeScript

delta: DeltaOp[]

`positions`

TypeScript

positions: number

`selection`

TypeScript

selection: {
    direction: 'none' | 'forward' | 'backward';
    from: number;
    isCollapsed: boolean;
    to: number;
  } | null

`text`

TypeScript

text: string

`wordCount` readonly

TypeScript

readonly wordCount: number

Number of words in this text: segmented with Intl.Segmenter in the language of the editor (nabu.lang) when the platform has it, so Chinese or Japanese text counts its words rather than one per sentence; whitespace-separated otherwise. See utils/words.js. Reactive in the text and in nabu.lang.

Methods

`absorbs()`

TypeScript

absorbs(other: Block): boolean

Parameters of absorbs
Parameter	Type	Description
`other`	`Block`	n/a

`applyDelta()`

TypeScript

applyDelta(data?: Delta<string>[]): void

Parameters of applyDelta
Parameter	Type	Default	Description
`data`optional	`Delta<string>[]`	`[]`	n/a

`applyMark()`

TypeScript

applyMark(
  markName: string,
  value: any,
  sel: Pick<{
      direction: 'none' | 'forward' | 'backward';
      from: number;
      isCollapsed: boolean;
      to: number;
    }, 'from' | 'isCollapsed' | 'to'> | null
): void

Parameters of applyMark
Parameter	Type	Description
`markName`	`string`	n/a
`value`	`any`	n/a
`sel`	`Pick<{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; }, 'from' \| 'isCollapsed' \| 'to'> \| null`	n/a

`delete()`

TypeScript

delete(
  deletion?: object,
  selection?: {
    direction: 'none' | 'forward' | 'backward';
    from: number;
    isCollapsed: boolean;
    to: number;
  } | null
): void

Parameters of delete
Parameter	Type	Default	Description
`deletion`optional	`object`	n/a	n/a
`deletion.from`optional	`number`	n/a	n/a
`deletion.index`optional	`number`	n/a	n/a
`deletion.length`optional	`number`	n/a	n/a
`deletion.to`optional	`number`	n/a	n/a
`selection`optional	`{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; } \| null`	`...`	n/a

`getDOMPoint()`

TypeScript

getDOMPoint(targetOffset: number, element?: HTMLElement | null): { node: Node; offset: number } | null

Retrouve le nœud texte et l'offset DOM pour un offset Modèle donné

Parameters of getDOMPoint
Parameter	Type	Default	Description
`targetOffset`	`number`	n/a	n/a
`element`optional	`HTMLElement \| null`	`...`

`handleBeforeInput()`

TypeScript

handleBeforeInput(
  event: InputEvent,
  selection?: {
    direction: 'none' | 'forward' | 'backward';
    from: number;
    isCollapsed: boolean;
    to: number;
  } | null
): any

Parameters of handleBeforeInput
Parameter	Type	Default	Description
`event`	`InputEvent`	n/a	n/a
`selection`optional	`{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; } \| null`	`...`	n/a

`insert()`

TypeScript

insert(index: number, text: string): void

Parameters of insert
Parameter	Type	Description
`index`	`number`	n/a
`text`	`string`	n/a

`isMarkActive()`

TypeScript

isMarkActive(
  markName: string,
  sel: Pick<{
      direction: 'none' | 'forward' | 'backward';
      from: number;
      isCollapsed: boolean;
      to: number;
    }, 'from' | 'isCollapsed' | 'to'> | null
): boolean

Parameters of isMarkActive
Parameter	Type	Description
`markName`	`string`	n/a
`sel`	`Pick<{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; }, 'from' \| 'isCollapsed' \| 'to'> \| null`	n/a

`removeMark()`

TypeScript

removeMark(
  markName: string,
  sel: Pick<{
      direction: 'none' | 'forward' | 'backward';
      from: number;
      isCollapsed: boolean;
      to: number;
    }, 'from' | 'isCollapsed' | 'to'> | null
): void

Parameters of removeMark
Parameter	Type	Description
`markName`	`string`	n/a
`sel`	`Pick<{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; }, 'from' \| 'isCollapsed' \| 'to'> \| null`	n/a

`split()`

TypeScript

split(
  options?: object,
  selection?: {
    direction: 'none' | 'forward' | 'backward';
    from: number;
    isCollapsed: boolean;
    to: number;
  } | null
): { block: Block } | null

Parameters of split
Parameter	Type	Default	Description
`options`optional	`object`	n/a	n/a
`options.from`optional	`number`	n/a	n/a
`options.index`optional	`number`	n/a	n/a
`options.length`optional	`number`	n/a	n/a
`options.offset`optional	`number`	n/a	n/a
`options.to`optional	`number`	n/a	n/a
`selection`optional	`{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; } \| null`	`...`	n/a

Returns { block: Block } | null

`toClipboardBlock()`

TypeScript

toClipboardBlock(context?: object): PasteBlock

Serializes a (partial) range of this block's text as a PasteBlock.

Parameters of toClipboardBlock
Parameter	Type	Default	Description
`context`optional	`object`	`{}`	n/a
`context.from`optional	`number`	`0`	n/a
`context.partial`optional	`false \| 'both' \| 'start' \| 'end'`	`false`	n/a
`context.props`optional	`Record<string, any>`	`{}`	n/a
`context.to`optional	`number \| null`	`null`	n/a

`toggleMark()`

TypeScript

toggleMark(
  markName: string,
  value: any,
  sel: Pick<{
      direction: 'none' | 'forward' | 'backward';
      from: number;
      isCollapsed: boolean;
      to: number;
    }, 'from' | 'isCollapsed' | 'to'> | null
): void

Parameters of toggleMark
Parameter	Type	Description
`markName`	`string`	n/a
`value`	`any`	n/a
`sel`	`Pick<{ direction: 'none' \| 'forward' \| 'backward'; from: number; isCollapsed: boolean; to: number; }, 'from' \| 'isCollapsed' \| 'to'> \| null`	n/a

`toJSON()`

TypeScript

toJSON(): { text: string; [mark: string]: any }[]

Converts the text delta to a Slate-like JSON format.

`toMarkdown()`

TypeScript

toMarkdown(options?: object): string

Parameters of toMarkdown
Parameter	Type	Description
`options`optional	`object`	see `deltaToMarkdown`
`options.rawBreaks`optional	`boolean`	n/a

Source: src/lib/behaviors/text/text.behavior.svelte.js:188

Import

Constructor

Properties

wordCount readonly

Methods

`wordCount` readonly