README for plexus #425
README for plexus #425
Conversation
Signed-off-by: Joe Farro <joef@uber.com>
Signed-off-by: Joe Farro <joef@uber.com>
Codecov Report
@@ Coverage Diff @@
## master #425 +/- ##
==========================================
+ Coverage 91.62% 91.65% +0.02%
==========================================
Files 176 176
Lines 4012 4012
Branches 957 957
==========================================
+ Hits 3676 3677 +1
+ Misses 294 293 -1
Partials 42 42
Continue to review full report at Codecov.
|
Signed-off-by: Joe Farro <joef@uber.com>
|
|
||
| ## Recipes | ||
|
|
||
| TODO: |
There was a problem hiding this comment.
Are these (or some of these) things we think we'll tackle while doing DDG work? If so, can we add a bullet point to related stories to come back here and update this section?
There was a problem hiding this comment.
The only catch is, for the border recipes they're already in the demo app, just need to add them to this section.
Signed-off-by: Joe Farro <joef@uber.com>
|
@everett980 This is ready for another look; I made changes per your feedbabck. |
packages/plexus/README.md
Outdated
| | measureNode | `TMeasureNodeFn` _See below for details on this type._ | | ||
| | | Overrides the default measuring of nodes.<br> | | ||
|
|
||
| sThe types for `setOnNode` and `renderNode` are distinct from the corresponding fields on a non-measurable nodes layer in that the first argument is the `TVertex`, and the `TLayoutVertex` argument is **only available after initial render**. |
There was a problem hiding this comment.
There's an extra s at the beginning
There was a problem hiding this comment.
Thanks. The CMD button on my mac is glitchy :/
packages/plexus/README.md
Outdated
| | useDotEdges | `boolean = false` | | ||
| | | When `true` the dot edges are used; i.e. generating neato edge paths is skipped.<br> | | ||
| | splines | `string = "true"` | | ||
| | | GraphViz [splines](https://www.graphviz.org/doc/info/attrs.html#d:splines) graph attribute.<br> | | ||
| | sep | `number = 0.5` | | ||
| | | GraphViz [sep](https://www.graphviz.org/doc/info/attrs.html#d:sep) graph attribute.<br> | | ||
| | | GraphViz [sep](https://www.graphviz.org/doc/info/attrs.html#d:sep) graph attribute, which defines the space margin around nodes.s<br> | |
There was a problem hiding this comment.
extra s at the end (nodes.s)
README for plexus Signed-off-by: vvvprabhakar <vvvprabhakar@gmail.com>
Which problem is this PR solving?
Provides some information on the plexus package.
Short description of the changes
Added content to the readme.
Also, I revised the ordering of merging props so the default props (like
{ style: { position: 'relative' } }can be overridden via thesetOn*hooks.TODO