@lexical/react
Version:
This package provides Lexical components and hooks for React applications.
18 lines (17 loc) • 819 B
TypeScript
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/
import { type EntityMatch } from '@lexical/text';
import { type Klass, type TextNode } from 'lexical';
/**
* Registers a text entity on the current editor: text matched by `getMatch` is
* automatically wrapped in instances of `targetNode` (created via `createNode`)
* and unwrapped when it no longer matches. This is the React wrapper around
* `registerLexicalTextEntity` and is the basis for features such as hashtags
* and mentions.
*/
export declare function useLexicalTextEntity<T extends TextNode>(getMatch: (text: string) => null | EntityMatch, targetNode: Klass<T>, createNode: (textNode: TextNode) => T): void;