chore(types): add generic for custom events on node associated types
This commit is contained in:
@@ -157,15 +157,15 @@ type CustomEventHandlers<CustomEvents = {}> = {
|
||||
}
|
||||
|
||||
export type NodeEventsHandler<CustomEvents = {}> = {
|
||||
doubleClick: (event: NodeMouseEvent) => any
|
||||
click: (event: NodeMouseEvent) => any
|
||||
mouseEnter: (event: NodeMouseEvent) => any
|
||||
mouseMove: (event: NodeMouseEvent) => any
|
||||
mouseLeave: (event: NodeMouseEvent) => any
|
||||
contextMenu: (event: NodeMouseEvent) => any
|
||||
dragStart: (event: NodeDragEvent) => any
|
||||
drag: (event: NodeDragEvent) => any
|
||||
dragStop: (event: NodeDragEvent) => any
|
||||
doubleClick: (event: NodeMouseEvent) => void | { off: () => void }
|
||||
click: (event: NodeMouseEvent) => void | { off: () => void }
|
||||
mouseEnter: (event: NodeMouseEvent) => void | { off: () => void }
|
||||
mouseMove: (event: NodeMouseEvent) => void | { off: () => void }
|
||||
mouseLeave: (event: NodeMouseEvent) => void | { off: () => void }
|
||||
contextMenu: (event: NodeMouseEvent) => void | { off: () => void }
|
||||
dragStart: (event: NodeDragEvent) => void | { off: () => void }
|
||||
drag: (event: NodeDragEvent) => void | { off: () => void }
|
||||
dragStop: (event: NodeDragEvent) => void | { off: () => void }
|
||||
} & CustomEventHandlers<CustomEvents>
|
||||
|
||||
export type NodeEventsOn<CustomEvents = {}> = {
|
||||
|
||||
@@ -12,10 +12,13 @@ export interface NodeHandleBounds {
|
||||
target?: HandleElement[]
|
||||
}
|
||||
|
||||
// eslint-disable-next-line no-use-before-define
|
||||
type WidthFunc = <Data = ElementData>(node: GraphNode<Data>) => number | string | void
|
||||
// eslint-disable-next-line no-use-before-define
|
||||
type HeightFunc = <Data = ElementData>(node: GraphNode<Data>) => number | string | void
|
||||
export type WidthFunc<Data = ElementData, CustomEvents extends Record<string, CustomEvent> = any> = (
|
||||
node: GraphNode<Data, CustomEvents>,
|
||||
) => number | string | void
|
||||
|
||||
export type HeightFunc<Data = ElementData, CustomEvents extends Record<string, CustomEvent> = any> = (
|
||||
node: GraphNode<Data, CustomEvents>,
|
||||
) => number | string | void
|
||||
|
||||
export interface Node<Data = ElementData, CustomEvents extends Record<string, CustomEvent> = any> {
|
||||
/** Unique node id */
|
||||
@@ -52,30 +55,31 @@ export interface Node<Data = ElementData, CustomEvents extends Record<string, Cu
|
||||
* You can pass a number which will be used in pixel values (width: 300 -> width: 300px)
|
||||
* or pass a string with units (width: `10rem` -> width: 10rem)
|
||||
*/
|
||||
width?: number | string | WidthFunc
|
||||
width?: number | string | WidthFunc<Data, CustomEvents>
|
||||
|
||||
/**
|
||||
* Fixed height of node, applied as style
|
||||
* You can pass a number which will be used in pixel values (height: 300 -> height: 300px)
|
||||
* or pass a string with units (height: `10rem` -> height: 10rem)
|
||||
*/
|
||||
height?: number | string | HeightFunc
|
||||
height?: number | string | HeightFunc<Data, CustomEvents>
|
||||
|
||||
/** Additional class names, can be a string or a callback returning a string (receives current flow element) */
|
||||
class?: string | ClassFunc<GraphNode<Data>>
|
||||
class?: string | ClassFunc<GraphNode<Data, CustomEvents>>
|
||||
/** Additional styles, can be an object or a callback returning an object (receives current flow element) */
|
||||
style?: Styles | StyleFunc<GraphNode<Data>>
|
||||
style?: Styles | StyleFunc<GraphNode<Data, CustomEvents>>
|
||||
/** Is node hidden */
|
||||
hidden?: boolean
|
||||
/** overwrites current node type */
|
||||
template?: NodeComponent
|
||||
template?: NodeComponent<Data>
|
||||
/** Additional data that is passed to your custom components */
|
||||
data?: Data
|
||||
/** contextual and custom events that are passed to your custom components */
|
||||
events?: Partial<NodeEventsHandler<CustomEvents>>
|
||||
}
|
||||
|
||||
export interface GraphNode<Data = ElementData> extends Node<Data> {
|
||||
export interface GraphNode<Data = ElementData, CustomEvents extends Record<string, CustomEvent> = any>
|
||||
extends Node<Data, CustomEvents> {
|
||||
/** absolute position in relation to parent elements + z-index */
|
||||
computedPosition: XYZPosition
|
||||
handleBounds: NodeHandleBounds
|
||||
|
||||
Reference in New Issue
Block a user