Skip to content

docs: add missing callback options to events documentation table #412

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

Merged
kevinchappell merged 2 commits into from
Nov 12, 2025
Merged

docs: add missing callback options to events documentation table #412

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b70823
Initial plan
Copilot Nov 12, 2025
7fb50fe
docs: add missing callback options to events documentation
Copilot Nov 12, 2025
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
6 changes: 6 additions & 0 deletions docs/options/events/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ const editor = new FormeoEditor({
| `onUpdateRow` | Function | Fires when row is updated |
| `onUpdateColumn` | Function | Fires when column is updated |
| `onUpdateField` | Function | Fires when field is updated |
| `onAddRow` | Function | Fires when row is added |
| `onAddColumn` | Function | Fires when column is added |
| `onAddField` | Function | Fires when field is added |
| `onRemoveRow` | Function | Fires when row is removed |
| `onRemoveColumn` | Function | Fires when column is removed |
Comment on lines 40 to +46
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The ordering of these callback options doesn't match the pattern used in the "Available DOM Events" section below (lines 81-90). For consistency, consider grouping by component type instead of by operation type.

For example:

| `onUpdateRow`        | Function | Fires when row is updated                |
| `onAddRow`           | Function | Fires when row is added                  |
| `onRemoveRow`        | Function | Fires when row is removed                |
| `onUpdateColumn`     | Function | Fires when column is updated             |
| `onAddColumn`        | Function | Fires when column is added               |
| `onRemoveColumn`     | Function | Fires when column is removed             |
| `onUpdateField`      | Function | Fires when field is updated              |
| `onAddField`         | Function | Fires when field is added                |
| `onRemoveField`      | Function | Fires when field is removed              |

This would match the DOM Events table structure and make it easier for users to find related callbacks.

Suggested change
| `onUpdateColumn` | Function | Fires when column is updated |
| `onUpdateField` | Function | Fires when field is updated |
| `onAddRow` | Function | Fires when row is added |
| `onAddColumn` | Function | Fires when column is added |
| `onAddField` | Function | Fires when field is added |
| `onRemoveRow` | Function | Fires when row is removed |
| `onRemoveColumn` | Function | Fires when column is removed |
| `onAddRow` | Function | Fires when row is added |
| `onRemoveRow` | Function | Fires when row is removed |
| `onUpdateColumn` | Function | Fires when column is updated |
| `onAddColumn` | Function | Fires when column is added |
| `onRemoveColumn` | Function | Fires when column is removed |
| `onUpdateField` | Function | Fires when field is updated |
| `onAddField` | Function | Fires when field is added |

Copilot uses AI. Check for mistakes.
| `onRemoveField` | Function | Fires when field is removed |
| `onSave` | Function | Fires when form is saved |
| `onRender` | Function | Fires when an element is rendered |
| `confirmClearAll` | Function | Fires when form is cleared |
Expand Down