Add setEditable to the documentation of Editor

ueberdosis · Nov 25, 2021 · d59ce5c · d59ce5c
1 parent b37b092
commit d59ce5c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/api/editor.md b/docs/api/editor.md
@@ -124,6 +124,18 @@ editor.setOptions({
   },
 })
 ```
+
+### setEditable()
+Update editable state of the editor.
+
+| Parameter | Type    | Description                                                   |
+| --------- | ------- | ------------------------------------------------------------- |
+| editable  | boolean | `true` when the user should be able to write into the editor. |
+
+```js
+// Make the editor read-only
+editor.setEditable(false)
+```
 
 ### unregisterPlugin()
 Unregister a ProseMirror plugin.