Grid Events

LyteNyte Grid fires events in response to specific user interactions or when imperative API methods are called. For instance, when a cell is being edited, the system triggers both onCellEditBegin.

This guide explores how to respond to events fired by LyteNyte Grid and demonstrates methods for triggering events imperatively when needed.

For a comprehensive list of available events and their triggers, please refer to the Events API Reference Page.

Listening to Events

The useLyteNyte hook returns the LyteNyte Grid state object, which provides two approaches for listening to events:

• The useEvent hook on the state object
• The imperative api.eventAddListener method

Whenever possible, we recommend using the useEvent hook as it automatically handles event cleanup when components unmount or dependencies change.

The useEvent method is a React hook and therefore must follow all standard hook rules. The following example demonstrates this hook in action:

TODO;

The api.eventAddListener method

There may be situations where you need to add an event listener to LyteNyte Grid outside of a render function. In such cases, the api.eventAddListener method provides an alternative approach. This method adds a listener that will be called whenever the specified event fires, and returns a function that can be used to remove the listener. Alternatively, you can call the api.eventRemoveListener method to remove a previously attached listener.

When using api.eventAddListener, developers are responsible for implementing proper cleanup procedures. The example below demonstrates correct usage with appropriate cleanup:

TODO;

Triggering Events

The LyteNyte Grid API provides the eventFire method that allows developers to manually trigger an event as though it came from the grid. This is useful when building custom functionality that should mimic the grid's event behavior.