#208 Call onEditEvent when starting and stopping "add key" UI

[CarlosNZ]

Fix #208

Note, does not call event when the actual key is added to the data structure, only when instantiating the "new key" UI (and stopping it).

[Copilot]

Pull Request Overview

This PR ensures the onEditEvent callback is fired when the “Add key” UI starts and stops, without firing when the actual key is added to the data.

• Extends the OnEditEventFunction signature to allow null entries in the path array and makes onEditEvent optional on relevant props.
• Invokes onEditEvent in the tree provider and button panel when entering/exiting “add key” mode.
• Propagates the new prop through JsonEditor, CollectionNode, and updates documentation and demo.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/types.ts	Updated OnEditEventFunction signature; added optional prop
src/contexts/TreeStateProvider.tsx	Added guarded call to onEditEvent when toggling edit state
src/JsonEditor.tsx	Forwarded onEditEvent prop into the editor component
src/CollectionNode.tsx	Propagated onEditEvent to the JSON node renderer
src/ButtonPanels.tsx	Hooked onEditEvent into updateAddingState for add-key UI
demo/src/App.tsx	Added commented example of onEditEvent usage in demo app
README.md	Updated callback signature and added usage note

Comments suppressed due to low confidence (3)

src/types.ts:181

• The updated OnEditEventFunction signature removes support for string paths, potentially breaking existing consumers. Consider supporting both string and array path types or documenting this breaking change in the migration guide.

export type OnEditEventFunction = (path: (CollectionKey | null)[] | null, isKey: boolean) => void

src/ButtonPanels.tsx:81

• There are no tests covering the new onEditEvent calls when starting/stopping the "add key" UI. Consider adding unit/integration tests to verify onEditEvent is invoked with correct parameters.

    if (onEditEvent) onEditEvent(active ? [...path, null] : null, active)

src/contexts/TreeStateProvider.tsx:93

• The conditional check for path only allows arrays or null, but if string paths should also trigger the event (as previously supported), they will be skipped. Verify if string paths need to be included here or update the logic accordingly.

    if (onEditEvent && (Array.isArray(path) || path === null))