Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Lexical] Chore: Update default skipInitialization to false for registerMutationListener #6857

Merged
merged 5 commits into from
Nov 23, 2024
Merged

[Lexical] Chore: Update default skipInitialization to false for registerMutationListener #6857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ac23c3a
change default skipInitialization
Shopiley Nov 22, 2024
d49dbce
Merge branch 'main' into change-skipInitializationn-default
Shopiley Nov 22, 2024
3b15093
fix unexpected character error for =
Shopiley Nov 22, 2024
0307ece
Merge branch 'change-skipInitializationn-default' of https://github.c…
Shopiley Nov 22, 2024
60be703
fix error for starting name with =
Shopiley Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/lexical-website/docs/concepts/listeners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ handle external UI state and UI features relating to specific types of node.
If any existing nodes are in the DOM, and skipInitialization is not true, the listener
will be called immediately with an updateTag of 'registerMutationListener' where all
nodes have the 'created' NodeMutation. This can be controlled with the skipInitialization option
(default is currently true for backwards compatibility in 0.17.x but will change to false in 0.18.0).
(whose default was previously true for backwards compatibility with <=0.16.1 but has been changed to false as of 0.21.0).

```js
const removeMutationListener = editor.registerMutationListener(
Expand Down
8 changes: 4 additions & 4 deletions packages/lexical/src/LexicalEditor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,13 +216,13 @@ export interface MutationListenerOptions {
/**
* Skip the initial call of the listener with pre-existing DOM nodes.
*
* The default is currently true for backwards compatibility with <= 0.16.1
* but this default is expected to change to false in 0.17.0.
* The default was previously true for backwards compatibility with <= 0.16.1
* but this default has been changed to false as of 0.21.0.
*/
skipInitialization?: boolean;
}

const DEFAULT_SKIP_INITIALIZATION = true;
const DEFAULT_SKIP_INITIALIZATION = false;

export type UpdateListener = (arg0: {
dirtyElements: Map<NodeKey, IntentionallyMarkedAsDirtyElement>;
Expand Down Expand Up @@ -844,7 +844,7 @@ export class LexicalEditor {
* If any existing nodes are in the DOM, and skipInitialization is not true, the listener
* will be called immediately with an updateTag of 'registerMutationListener' where all
* nodes have the 'created' NodeMutation. This can be controlled with the skipInitialization option
* (default is currently true for backwards compatibility in 0.16.x but will change to false in 0.17.0).
* (whose default was previously true for backwards compatibility with &lt;=0.16.1 but has been changed to false as of 0.21.0).
*
* @param klass - The class of the node that you want to listen to mutations on.
* @param listener - The logic you want to run when the node is mutated.
Expand Down
Loading