@lexical/react
Version:
This package provides Lexical components and hooks for React applications.
27 lines (26 loc) • 1.09 kB
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 { ErrorBoundaryType } from './shared/types.js';
import type { JSX } from 'react';
/**
* Sets up plain text editing by wiring up the core plain text commands and
* rendering the provided `contentEditable`, an optional `placeholder`, and any
* decorator nodes (wrapped in the given `ErrorBoundary`). Use this instead of
* {@link RichTextPlugin} when the editor should not support block-level rich
* text formatting.
*
* This is a legacy plugin. When building an editor with the extension API,
* configure {@link PlainTextExtension} instead.
*
* @returns The element tree to render inside your LexicalComposer.
*/
export declare function PlainTextPlugin({ contentEditable, placeholder, ErrorBoundary, }: {
contentEditable: JSX.Element;
placeholder?: ((isEditable: boolean) => null | JSX.Element) | null | JSX.Element;
ErrorBoundary: ErrorBoundaryType;
}): JSX.Element;