UNPKG

@lexical/react

Version:

This package provides Lexical components and hooks for React applications.

32 lines (31 loc) • 1.49 kB
/** * 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 JSX } from 'react'; import { ContentEditableElement, type ContentEditableElementProps } from './shared/LexicalContentEditableElement.js'; export { ContentEditableElement, type ContentEditableElementProps }; /** * Props for the {@link ContentEditable} component. These are the * {@link ContentEditableElementProps} (minus `editor`, which is read from * context) plus an optional `placeholder`; when a `placeholder` is provided an * `aria-placeholder` string is also required for accessibility. */ export type ContentEditableProps = Omit<ContentEditableElementProps, 'editor'> & ({ 'aria-placeholder'?: void; placeholder?: null; } | { 'aria-placeholder': string; placeholder: ((isEditable: boolean) => null | JSX.Element) | JSX.Element; }); /** * The editable surface of a Lexical editor: the `contentEditable` element that * users type into. Render it inside a {@link LexicalComposer} (it reads the * editor from context) and pass it to {@link RichTextPlugin} or * {@link PlainTextPlugin}. An optional `placeholder` is shown while the editor * is empty. The `ref` is forwarded to the underlying `<div>`. */ export declare const ContentEditable: import("react").ForwardRefExoticComponent<ContentEditableProps & import("react").RefAttributes<HTMLDivElement>>;