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

chore(readme): background prop types

Browse Source
This commit is contained in:
moklick
2020-05-25 17:19:32 +02:00
parent c46d962ea1
commit d567d00749
1 changed files with 1 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -5
View File
@@ -82,10 +82,6 @@ const BasicFlow = () => (
- `connectionLineStyle`: connection style as svg attributes - `connectionLineStyle`: connection style as svg attributes
- `deleteKeyCode`: default: `8` (delete) - `deleteKeyCode`: default: `8` (delete)
- `selectionKeyCode`: default: `16` (shift) - `selectionKeyCode`: default: `16` (shift)
- `showBackground`: default: `true`
- `backgroundGap`: gap size - default: `16`
- `backgroundColor`: color of dots or lines - default: `#eee`
- `backgroundType`: background type = `dots` or `lines` - default: `dots`
- `snapToGrid`: default: `false` - `snapToGrid`: default: `false`
- `snapGrid`: [x, y] array - default: `[16, 16]` - `snapGrid`: [x, y] array - default: `[16, 16]`
- `onlyRenderVisibleNodes`: default: `true` - `onlyRenderVisibleNodes`: default: `true`
@@ -268,7 +264,7 @@ const FlowWithBackground = () => (
- `variant`: string - has to be 'dots' or 'lines' - default: `dots` - `variant`: string - has to be 'dots' or 'lines' - default: `dots`
- `gap`: number - the gap between the dots or lines - default: `16` - `gap`: number - the gap between the dots or lines - default: `16`
- `size`: number - the radius of the dots or the stroke width of the lines - default: 0.5 - `size`: number - the radius of the dots or the stroke width of the lines - default: 0.5
- `color`: string - the color of the dots or lines - default: `#999` - `color`: string - the color of the dots or lines - default: `#999` for dots, '#eee' for lines
- `style`: css properties - `style`: css properties
- `className`: class name - `className`: class name