Module: @lexical/text
Type Aliases
EntityMatch
Ƭ EntityMatch: Object
Type declaration
| Name | Type |
|---|---|
end | number |
start | number |
Defined in
lexical-text/src/index.ts:153
TextNodeWithOffset
Ƭ TextNodeWithOffset: Object
Type declaration
| Name | Type |
|---|---|
node | TextNode |
offset | number |
Defined in
lexical-text/src/index.ts:20
Functions
$canShowPlaceholder
▸ $canShowPlaceholder(isComposing, isEditable?): boolean
Parameters
| Name | Type | Default value |
|---|---|---|
isComposing | boolean | undefined |
isEditable | boolean | true |
Returns
boolean
Defined in
lexical-text/src/index.ts:100
$canShowPlaceholderCurry
▸ $canShowPlaceholderCurry(isEditorComposing, isEditable?): () => boolean
Parameters
| Name | Type | Default value |
|---|---|---|
isEditorComposing | boolean | undefined |
isEditable | boolean | true |
Returns
fn
▸ (): boolean
Returns
boolean
Defined in
lexical-text/src/index.ts:145
$findTextIntersectionFromCharacters
▸ $findTextIntersectionFromCharacters(root, targetCharacters): null | { node: TextNode ; offset: number }
Parameters
| Name | Type |
|---|---|
root | RootNode |
targetCharacters | number |
Returns
null | { node: TextNode ; offset: number }
Defined in
lexical-text/src/index.ts:25
$isRootTextContentEmpty
▸ $isRootTextContentEmpty(isEditorComposing, trim?): boolean
Parameters
| Name | Type | Default value |
|---|---|---|
isEditorComposing | boolean | undefined |
trim | boolean | true |
Returns
boolean
Defined in
lexical-text/src/index.ts:70
$isRootTextContentEmptyCurry
▸ $isRootTextContentEmptyCurry(isEditorComposing, trim?): () => boolean
Parameters
| Name | Type |
|---|---|
isEditorComposing | boolean |
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
| Name | Type |
|---|---|
T | extends TextNode<T> |
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
getMatch | (text: string) => null | EntityMatch |
targetNode | Klass<T> |
createNode | (textNode: TextNode) => T |
Returns
() => void[]
Defined in
lexical-text/src/index.ts:155