Skip to content

Commit 2e9eb1d

Browse files
committed
Update component docs
1 parent 78df474 commit 2e9eb1d

File tree

3 files changed

+49
-36
lines changed

3 files changed

+49
-36
lines changed

docs/components/Link.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,13 @@ type: `enum('horizontal'|'vertical')`
2020

2121
type: `enum('diagonal'|'elbow')`
2222

23+
24+
### `styles` (required)
25+
26+
type: `object`
27+
28+
29+
### `transitionDuration` (required)
30+
31+
type: `number`
32+

docs/components/Node.md

Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,29 @@
66
Props
77
-----
88

9-
### `circleRadius`
10-
11-
type: `number`
12-
defaultValue: `10`
13-
14-
15-
### `circleStyle`
9+
### `attributes`
1610

1711
type: `object`
18-
defaultValue: `{
19-
stroke: '#000',
20-
strokeWidth: 2,
21-
fill: 'grey',
22-
}`
12+
defaultValue: `undefined`
2313

2414

25-
### `depthFactor`
15+
### `circleRadius`
2616

2717
type: `number`
18+
defaultValue: `10`
2819

2920

30-
### `leafCircleStyle`
21+
### `name` (required)
3122

32-
type: `object`
33-
defaultValue: `{
34-
stroke: '#000',
35-
strokeWidth: 2,
36-
fill: 'transparent',
37-
}`
23+
type: `string`
3824

3925

4026
### `nodeData` (required)
4127

4228
type: `object`
4329

4430

45-
### `onClick`
31+
### `onClick` (required)
4632

4733
type: `func`
4834

@@ -52,27 +38,18 @@ type: `func`
5238
type: `enum('horizontal'|'vertical')`
5339

5440

55-
### `primaryLabel`
56-
57-
type: `string`
58-
59-
60-
### `primaryLabelStyle`
61-
62-
type: `object`
63-
64-
65-
### `secondaryLabels`
41+
### `styles` (required)
6642

6743
type: `object`
6844

6945

70-
### `secondaryLabelsStyle`
46+
### `textAnchor`
7147

72-
type: `object`
48+
type: `string`
49+
defaultValue: `'start'`
7350

7451

75-
### `textAnchor`
52+
### `transitionDuration` (required)
7653

77-
type: `string`
54+
type: `number`
7855

docs/components/Tree.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,32 @@ type: `shape[object Object]`
4747
defaultValue: `{ min: 0.1, max: 1 }`
4848

4949

50+
### `styles`
51+
52+
type: `shape[object Object]`
53+
defaultValue: `{
54+
nodes: {
55+
node: {
56+
circle: {},
57+
name: {},
58+
attributes: {},
59+
},
60+
leafNode: {
61+
circle: {},
62+
name: {},
63+
attributes: {},
64+
},
65+
},
66+
links: {},
67+
}`
68+
69+
70+
### `transitionDuration`
71+
72+
type: `number`
73+
defaultValue: `500`
74+
75+
5076
### `translate`
5177

5278
type: `shape[object Object]`

0 commit comments

Comments
 (0)