@lexical/react
Version:
This package provides Lexical components and hooks for React applications.
31 lines (30 loc) • 1.27 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 { JSX } from 'react';
import { TreeView } from '@lexical/react/LexicalTreeView';
/**
* Configuration for {@link TreeViewExtensionComponent}: the props of
* {@link TreeView} except `editor` (which is taken from the composer context),
* i.e. the set of CSS class names used by the debug view.
*/
export type TreeViewConfig = Omit<Parameters<typeof TreeView>[0], 'editor'>;
/**
* Renders the {@link TreeView} debugging panel for the current editor, merging
* the {@link TreeViewExtension} configuration with any `props` you pass. Use it
* inside an extension-based editor to inspect the editor state tree.
*
* @returns The TreeView element.
*/
export declare function TreeViewExtensionComponent(props: Partial<TreeViewConfig>): JSX.Element;
/**
* Provides a configured TreeView debugging tool (React dependent)
* as an output component with configurable class names.
*/
export declare const TreeViewExtension: import("lexical").LexicalExtension<TreeViewConfig, "@lexical/react/TreeView", {
Component: typeof TreeViewExtensionComponent;
}, unknown>;