@lexical/react/dist/useLexicalSubscription.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.
 *
 */
import type { LexicalEditor } from 'lexical';
/**
 * Describes how {@link useLexicalSubscription} reads a value from the editor: an
 * `initialValueFn` that computes the current value, and a `subscribe` function
 * that registers a listener for changes and returns an unsubscribe callback.
 */
export type LexicalSubscription<T> = {
    initialValueFn: () => T;
    subscribe: (callback: (value: T) => void) => () => void;
};
/**
 * Shortcut to Lexical subscriptions when values are used for render.
 * @param subscription - The function to create the {@link LexicalSubscription}. This function's identity must be stable (e.g. defined at module scope or with useCallback).
 */
export declare function useLexicalSubscription<T>(subscription: (editor: LexicalEditor) => LexicalSubscription<T>): T;