docs: Update README.md

riceball-tw · Dec 7, 2024 · 3cf8f0a · 3cf8f0a
1 parent 4eb473b
commit 3cf8f0a
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,26 @@ import { EditElement } from '../dist/index.mjs';
 const editableElements = new EditElement('.editable');
 ```
 
+## Advanced Usage
+```typescript
+import EditElement from 'edit-element';
+
+// Make all elements with .editable class editable
+const editableElements = new EditElement('.editable', {
+  onEnter: (element) => {
+    console.log('Editing started', element);
+  },
+  onSubmit: (element) => {
+    console.log('Edit submitted', element.textContent);
+  },
+  onLeave: (element) => {
+    console.log('Editing ended', element);
+  },
+  editingElementClassName: 'editing'
+  submitKey: 'Enter',
+});
+```
+
 ## Configuration Options
 
 ### `Options` Interface