Add useLexicalEditable docstring back that got lost in the merge

facebook · May 16, 2024 · 3319e2b · 3319e2b
1 parent e49b7c8
commit 3319e2b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/lexical-react/src/useLexicalEditable.ts b/packages/lexical-react/src/useLexicalEditable.ts
@@ -20,6 +20,14 @@ function subscription(editor: LexicalEditor): LexicalSubscription<boolean> {
   };
 }
 
+/**
+ * Get the current value for {@link LexicalEditor.isEditable}
+ * using {@link useLexicalSubscription}.
+ * You should prefer this over manually observing the value with
+ * {@link LexicalEditor.registerEditableListener},
+ * which is a bit tricky to do correctly, particularly when using
+ * React StrictMode (the default for development) or concurrency.
+ */
 export function useLexicalEditable(): boolean {
   return useLexicalSubscription(subscription);
 }