Skip to main content

Module: @lexical/text

Type Aliases

EntityMatch

Ƭ EntityMatch: Object

Type declaration

NameType
endnumber
startnumber

Defined in

lexical-text/src/index.ts:153


TextNodeWithOffset

Ƭ TextNodeWithOffset: Object

Type declaration

NameType
nodeTextNode
offsetnumber

Defined in

lexical-text/src/index.ts:20

Functions

$canShowPlaceholder

$canShowPlaceholder(isComposing, isEditable?): boolean

Parameters

NameTypeDefault value
isComposingbooleanundefined
isEditablebooleantrue

Returns

boolean

Defined in

lexical-text/src/index.ts:100


$canShowPlaceholderCurry

$canShowPlaceholderCurry(isEditorComposing, isEditable?): () => boolean

Parameters

NameTypeDefault value
isEditorComposingbooleanundefined
isEditablebooleantrue

Returns

fn

▸ (): boolean

Returns

boolean

Defined in

lexical-text/src/index.ts:145


$findTextIntersectionFromCharacters

$findTextIntersectionFromCharacters(root, targetCharacters): null | { node: TextNode ; offset: number }

Parameters

NameType
rootRootNode
targetCharactersnumber

Returns

null | { node: TextNode ; offset: number }

Defined in

lexical-text/src/index.ts:25


$isRootTextContentEmpty

$isRootTextContentEmpty(isEditorComposing, trim?): boolean

Parameters

NameTypeDefault value
isEditorComposingbooleanundefined
trimbooleantrue

Returns

boolean

Defined in

lexical-text/src/index.ts:70


$isRootTextContentEmptyCurry

$isRootTextContentEmptyCurry(isEditorComposing, trim?): () => boolean

Parameters

NameType
isEditorComposingboolean
trim?boolean

Returns

fn

▸ (): boolean

Returns

boolean

Defined in

lexical-text/src/index.ts:87


$rootTextContent

$rootTextContent(): string

Returns

string

Defined in

lexical-text/src/index.ts:94


registerLexicalTextEntity

registerLexicalTextEntity<T>(editor, getMatch, targetNode, createNode): () => void[]

Type parameters

NameType
Textends TextNode<T>

Parameters

NameType
editorLexicalEditor
getMatch(text: string) => null | EntityMatch
targetNodeKlass<T>
createNode(textNode: TextNode) => T

Returns

() => void[]

Defined in

lexical-text/src/index.ts:155