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:21:28 +02:00
parent d567d00749
commit 0a140404dc
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -243,7 +243,7 @@ There is an implementation of a custom edge in the [edges example](/example/src/
### Background ### Background
React Flow comes with two background variants: **dots** and **lines**. React Flow comes with two background variants: **dots** and **lines**. You can use it by passing it as a children to the React Flow component:
```javascript ```javascript
import ReactFlow, { Background } from 'react-flow-renderer'; import ReactFlow, { Background } from 'react-flow-renderer';
@@ -263,8 +263,8 @@ 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` for dots, '#eee' for lines - `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