lexical/LexicalUpdateTags.d.ts

Lexical is an extensible text editor framework that provides excellent reliability, accessible and performance.

/**
 * 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.
 *
 */
/**
 * Common update tags used in Lexical. These tags can be used with editor.update() or $addUpdateTag()
 * to indicate the type/purpose of an update. Multiple tags can be used in a single update.
 */
/**
 * Indicates that the update is related to history operations (undo/redo)
 */
export declare const HISTORIC_TAG = "historic";
/**
 * Indicates that a new history entry should be pushed to the history stack
 */
export declare const HISTORY_PUSH_TAG = "history-push";
/**
 * Indicates that the current update should be merged with the previous history entry
 */
export declare const HISTORY_MERGE_TAG = "history-merge";
/**
 * Indicates that the update is related to a paste operation
 */
export declare const PASTE_TAG = "paste";
/**
 * Indicates that the update is related to collaborative editing
 */
export declare const COLLABORATION_TAG = "collaboration";
/**
 * Indicates that the update should skip collaborative sync
 */
export declare const SKIP_COLLAB_TAG = "skip-collab";
/**
 * Indicates that the update should skip scrolling the selection into view
 */
export declare const SKIP_SCROLL_INTO_VIEW_TAG = "skip-scroll-into-view";
/**
 * Indicates that the update should skip updating the DOM selection
 * This is useful when you want to make updates without changing the selection or focus
 */
export declare const SKIP_DOM_SELECTION_TAG = "skip-dom-selection";
/**
 * The update was triggered by editor.focus()
 */
export declare const FOCUS_TAG = "focus";
/**
 * The set of known update tags to help with TypeScript suggestions.
 */
export type UpdateTag = typeof COLLABORATION_TAG | typeof FOCUS_TAG | typeof HISTORIC_TAG | typeof HISTORY_MERGE_TAG | typeof HISTORY_PUSH_TAG | typeof PASTE_TAG | typeof SKIP_COLLAB_TAG | typeof SKIP_DOM_SELECTION_TAG | typeof SKIP_SCROLL_INTO_VIEW_TAG | (string & {});