alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #813 from ShaMan123/main

Browse Source 
[Types]: Add type inference for data property
This commit is contained in:
Moritz Klack
2021-01-11 11:09:46 +01:00
committed by GitHub
parent e07ed90fe5 ef25b1dd15
commit b071d69e96
1 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/types/index.ts
+25 -25
View File
@@ -2,9 +2,9 @@ import { CSSProperties, MouseEvent as ReactMouseEvent } from 'react';
export type ElementId = string; export type ElementId = string;
export type FlowElement = Node | Edge; export type FlowElement<T = any> = Node<T> | Edge<T>;
export type Elements = Array<FlowElement>; export type Elements<T = any> = Array<FlowElement<T>>;
export type Transform = [number, number, number]; export type Transform = [number, number, number];
@@ -34,12 +34,12 @@ export interface Box extends XYPosition {
export type SnapGrid = [number, number]; export type SnapGrid = [number, number];
export interface Node { export interface Node<T = any> {
id: ElementId; id: ElementId;
position: XYPosition; position: XYPosition;
type?: string; type?: string;
__rf?: any; __rf?: any;
data?: any; data?: T;
style?: CSSProperties; style?: CSSProperties;
className?: string; className?: string;
targetPosition?: Position; targetPosition?: Position;
@@ -55,7 +55,7 @@ export enum ArrowHeadType {
ArrowClosed = 'arrowclosed', ArrowClosed = 'arrowclosed',
} }
export interface Edge { export interface Edge<T = any> {
id: ElementId; id: ElementId;
type?: string; type?: string;
source: ElementId; source: ElementId;
@@ -72,7 +72,7 @@ export interface Edge {
animated?: boolean; animated?: boolean;
arrowHeadType?: ArrowHeadType; arrowHeadType?: ArrowHeadType;
isHidden?: boolean; isHidden?: boolean;
data?: any; data?: T;
className?: string; className?: string;
} }
@@ -93,11 +93,11 @@ export interface SelectionRect extends Rect {
draw: boolean; draw: boolean;
} }
export interface WrapEdgeProps { export interface WrapEdgeProps<T = any> {
id: ElementId; id: ElementId;
className?: string; className?: string;
type: string; type: string;
data?: any; data?: T;
onClick?: (event: React.MouseEvent, edge: Edge) => void; onClick?: (event: React.MouseEvent, edge: Edge) => void;
selected: boolean; selected: boolean;
animated?: boolean; animated?: boolean;
@@ -126,7 +126,7 @@ export interface WrapEdgeProps {
onConnectEdge: OnConnectFunc; onConnectEdge: OnConnectFunc;
} }
export interface EdgeProps { export interface EdgeProps<T = any> {
id: ElementId; id: ElementId;
source: ElementId; source: ElementId;
target: ElementId; target: ElementId;
@@ -147,9 +147,9 @@ export interface EdgeProps {
style?: CSSProperties; style?: CSSProperties;
arrowHeadType?: ArrowHeadType; arrowHeadType?: ArrowHeadType;
markerEndId?: string; markerEndId?: string;
data?: any; data?: T;
} }
export interface EdgeSmoothStepProps extends EdgeProps { export interface EdgeSmoothStepProps<T = any> extends EdgeProps<T> {
borderRadius?: number; borderRadius?: number;
} }
@@ -164,10 +164,10 @@ export interface EdgeTextProps {
labelBgBorderRadius?: number; labelBgBorderRadius?: number;
} }
export interface NodeProps { export interface NodeProps<T = any> {
id: ElementId; id: ElementId;
type: string; type: string;
data: any; data: T;
selected: boolean; selected: boolean;
isConnectable: boolean; isConnectable: boolean;
xPos?: number; xPos?: number;
@@ -177,10 +177,10 @@ export interface NodeProps {
isDragging?: boolean; isDragging?: boolean;
} }
export interface NodeComponentProps { export interface NodeComponentProps<T = any> {
id: ElementId; id: ElementId;
type: string; type: string;
data: any; data: T;
selected?: boolean; selected?: boolean;
isConnectable: boolean; isConnectable: boolean;
transform?: Transform; transform?: Transform;
@@ -199,10 +199,10 @@ export interface NodeComponentProps {
isDragging?: boolean; isDragging?: boolean;
} }
export interface WrapNodeProps { export interface WrapNodeProps<T = any> {
id: ElementId; id: ElementId;
type: string; type: string;
data: any; data: T;
selected: boolean; selected: boolean;
scale: number; scale: number;
xPos: number; xPos: number;
@@ -234,28 +234,28 @@ export type FitViewParams = {
padding: number; padding: number;
}; };
export type FlowExportObject = { export type FlowExportObject<T = any> = {
elements: Elements; elements: Elements<T>;
position: [number, number]; position: [number, number];
zoom: number; zoom: number;
}; };
export type FitViewFunc = (fitViewOptions?: FitViewParams) => void; export type FitViewFunc = (fitViewOptions?: FitViewParams) => void;
export type ProjectFunc = (position: XYPosition) => XYPosition; export type ProjectFunc = (position: XYPosition) => XYPosition;
export type ToObjectFunc = () => FlowExportObject; export type ToObjectFunc<T = any> = () => FlowExportObject<T>;
export type OnLoadParams = { export type OnLoadParams<T = any> = {
zoomIn: () => void; zoomIn: () => void;
zoomOut: () => void; zoomOut: () => void;
zoomTo: (zoomLevel: number) => void; zoomTo: (zoomLevel: number) => void;
fitView: FitViewFunc; fitView: FitViewFunc;
project: ProjectFunc; project: ProjectFunc;
getElements: () => Elements; getElements: () => Elements<T>;
setTransform: (transform: FlowTransform) => void; setTransform: (transform: FlowTransform) => void;
toObject: ToObjectFunc; toObject: ToObjectFunc<T>;
}; };
export type OnLoadFunc = (params: OnLoadParams) => void; export type OnLoadFunc<T = any> = (params: OnLoadParams<T>) => void;
export interface Connection { export interface Connection {
source: ElementId | null; source: ElementId | null;
@@ -359,4 +359,4 @@ export interface ZoomPanHelperFunctions {
initialized: boolean; initialized: boolean;
} }
export type OnEdgeUpdateFunc = (oldEdge: Edge, newConnection: Connection) => void; export type OnEdgeUpdateFunc<T = any> = (oldEdge: Edge<T>, newConnection: Connection) => void;