DialogFrame
Defines a dialog frame configuration used by LyteNyte Grid.
This structure is passed to grid internals to associate a rendering component for dialogs triggered by grid interactions.
component
propertyComponent renderer function to use for this dialog frame.
DialogFrameRenderer
Function responsible for rendering a dialog component.
LyteNyte Grid does not provide a dialog component by default. Instead, it expects developers to use their preferred dialog libraries. This renderer function receives control parameters and should return a valid ReactNode to render as a dialog.
Note: The dialog component used should support controlled open/close behavior.
Parameters
params | DialogFrameRendererParams (docs) |
Returns
ReactNode
DialogFrameRendererParams
Parameters provided to the dialog frame renderer function.
These include the grid context, the frame being rendered, and any additional user-provided context.
context
propertyCustom context data passed to the frame being rendered.
This context is supplied programmatically at the point of invoking the frame. It can contain any arbitrary information required for rendering behavior.
Type
any
frame
propertyThe dialog frame definition currently being rendered.
| Type | DialogFrame |
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
PopoverFrame
Describes a popover frame and the component renderer used to display it.
The popover frame is triggered by LyteNyte Grid interactions and used to display contextual information, editors, or auxiliary UI near a cell or element.
component
propertyRenderer function to generate the popover content.
PopoverFrameRenderer
Function that renders a popover component for a given context.
LyteNyte Grid does not include a built-in popover renderer. Developers must use their own popover UI libraries and integrate them by implementing this renderer interface.
Parameters
params | PopoverFrameRendererParams (docs) |
Returns
ReactNode
PopoverFrameRendererParams
Parameters passed to the popover frame renderer function.
Includes information about the grid, the target HTML element or virtual target to anchor the popover, and the frame being rendered.
context
propertyCustom context data passed to the frame being rendered.
This context is supplied programmatically at the point of invoking the frame. It can contain any arbitrary information required for rendering behavior.
Type
any
frame
propertyThe popover frame definition that should be rendered.
| Type | PopoverFrame |
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
target
propertyThe target element or virtual position where the popover should be anchored.
Type
HTMLElement | VirtualTarget
Variants
HTMLElementVirtualTarget(docs)
VirtualTarget
Represents a virtual DOM target with bounding information, used in situations where a physical DOM element does not exist. Commonly used for positioning popovers or overlays within LyteNyte Grid.
contextElement
propertySpecifies a context element that acts as a reference for the virtual element. Helps in aligning or calculating relative positions.
| Type | HTMLElement |
getBoundingClientRect
propertyReturns the bounding rectangle representing the virtual target.
Equivalent to a DOMRect but without the toJSON method.
Parameters
This function takes no parameters.
Returns
Omit
getClientRects
propertyReturns an array of client rectangles for the virtual target, useful for rendering inline tooltips or positioning logic.
Parameters
This function takes no parameters.
Returns
Omit[]