Skip to content

Commit 4c2feb4

Browse files
committed
Declares public types in react-d3-tree.d.ts
1 parent 9b61547 commit 4c2feb4

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.12.1",
44
"description": "React component to create interactive D3 tree hierarchies",
55
"main": "lib/react-d3-tree.min.js",
6+
"types": "./react-d3-tree.d.ts",
67
"scripts": {
78
"clean:lib": "rimraf lib/*",
89
"precommit": "lint-staged",

react-d3-tree.d.ts

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
declare module "react-d3-tree" {
2+
type NodeSvgShape = {
3+
shape?: string,
4+
shapeProps?: object
5+
}
6+
7+
type ReactD3TreeItem = {
8+
name: string,
9+
attributes?: {
10+
[key: string]: string,
11+
};
12+
children?: ReactD3TreeItem[],
13+
_collapsed?: boolean,
14+
nodeSvgShape?: NodeSvgShape
15+
};
16+
17+
type ReactD3TreeProps = {
18+
data: ReactD3TreeItem[] | ReactD3TreeItem,
19+
nodeSvgShape?: NodeSvgShape,
20+
nodeLabelComponent?: object,
21+
onClick?: (targetNode: ReactD3TreeItem, event: Event) => any,
22+
onMouseOver?: (targetNode: ReactD3TreeItem, event: Event) => any,
23+
onMouseOut?: (targetNode: ReactD3TreeItem, event: Event) => any,
24+
onUpdate?: (targetNode: ReactD3TreeItem, event: Event) => any,
25+
orientation?: "horizontal" | "vertical",
26+
translate?: {
27+
x?: number,
28+
y?: number
29+
},
30+
pathFunc?: ("diagonal" | "elbow" | "straight") | ((...args: any[]) => any),
31+
transitionDuration?: number,
32+
depthFactor?: number,
33+
collapsible?: boolean,
34+
useCollapseData?: boolean,
35+
initialDepth?: number,
36+
zoomable?: boolean,
37+
zoom?: number,
38+
scaleExtent?: {
39+
min?: number,
40+
max?: number
41+
},
42+
nodeSize?: {
43+
x?: number,
44+
y?: number
45+
},
46+
separation?: {
47+
siblings?: number,
48+
nonSiblings?: number
49+
},
50+
textLayout?: object,
51+
allowForeignObjects?: boolean,
52+
shouldCollapseNeighborNodes?: boolean,
53+
circleRadius?: number,
54+
styles?: {
55+
nodes?: object,
56+
links?: object
57+
}
58+
};
59+
60+
var Tree: React.ComponentClass<ReactD3TreeProps, any>;
61+
62+
export {Tree};
63+
export default Tree;
64+
}

0 commit comments

Comments
 (0)