From 8069e95a44dba1b1c9de6dcb3eeb3bf352fdaf9c Mon Sep 17 00:00:00 2001 From: PJ Trainor Date: Tue, 12 Sep 2017 20:20:09 -0400 Subject: [PATCH] [hierarchy] update links and descriptions in readme --- packages/vx-hierarchy/Readme.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/packages/vx-hierarchy/Readme.md b/packages/vx-hierarchy/Readme.md index 117e6cbb7..c2fa7ab4f 100644 --- a/packages/vx-hierarchy/Readme.md +++ b/packages/vx-hierarchy/Readme.md @@ -19,19 +19,20 @@ See [this example](https://vx-demo.now.sh/trees) for additional details. ## `` and `` ### Properties - | Name | Default | Type | Description | |:--------------|:--------|:-----|:------------ | top | 0 | number | Margin to top | left | 0 | number | Margin on left +| className | | string | The className for the component | root | | object | Root node for hierarchical data; see [`d3.hierarchy()`](https://github.com/d3/d3-hierarchy#hierarchy) -| size | [1, 1] | array | Size of tree layout specified by `[width, height]`; see [`tree.size()`](https://github.com/d3/d3-hierarchy#tree_size) -| nodeSize | null | array | Size of tree layout's node size specified by `[width, height]`; see [`tree.nodeSize()`](https://github.com/d3/d3-hierarchy#tree_nodeSize) -| separation | | function | Separation accessor for tree layout; see [`tree.separation()`](https://github.com/d3/d3-hierarchy#tree_separation) -| nodeComponent | | Component | Component to render for links between nodes -| linkComponent | | Component | Component to render for each node +| size | [1, 1] | array | Size of tree/cluster layout specified by `[width, height]`; see [`tree.size()`](https://github.com/d3/d3-hierarchy#tree_size) +| nodeSize | null | array | Size of tree/cluster layout's nodes specified by `[width, height]`; see [`tree.nodeSize()`](https://github.com/d3/d3-hierarchy#tree_nodeSize) +| separation | | function | Separation accessor for tree/cluster layout; see [`tree.separation()`](https://github.com/d3/d3-hierarchy#tree_separation) +| nodeComponent | [``](https://github.com/hshoff/vx/blob/master/packages/vx-hierarchy/src/HierarchyDefaultNode.js) | Component | Component to render for each node +| linkComponent | [``](https://github.com/hshoff/vx/blob/master/packages/vx-hierarchy/src/HierarchyDefaultLink.js) | Component | Component to render for links between nodes + +## Source For Components + +* [``](https://github.com/hshoff/vx/blob/master/packages/vx-hierarchy/src/hierarchies/Tree.js) +* [``](https://github.com/hshoff/vx/blob/master/packages/vx-hierarchy/src/hierarchies/Cluster.js) \ No newline at end of file