@lexical/react/dist/LexicalListPlugin.d.ts

This package provides Lexical components and hooks for React applications.

/**
 * 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.
 *
 */
/**
 * Props for the {@link ListPlugin} component.
 */
export interface ListPluginProps {
    /**
     * When `true`, enforces strict indentation rules for list items, ensuring consistent structure.
     * When `false` (default), indentation is more flexible.
     */
    hasStrictIndent?: boolean;
    /**
     * When `true`, splitting a numbered list will preserve the numbering continuity.
     * When `false` (default), the new split list resets to 1.
     */
    shouldPreserveNumbering?: boolean;
}
/**
 * Enables ordered, unordered, and check list support, registering the commands
 * and transforms that create and maintain {@link ListNode} and
 * {@link ListItemNode} structures. The editor must have both nodes registered.
 *
 * This is a legacy plugin. When building an editor with the extension API,
 * configure {@link ListExtension} instead.
 *
 * @returns `null`, this plugin renders no DOM of its own.
 */
export declare function ListPlugin({ hasStrictIndent, shouldPreserveNumbering, }: ListPluginProps): null;