Skip to content

Commit 0a14040

Browse files
committed
chore(readme): background prop types
1 parent d567d00 commit 0a14040

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ There is an implementation of a custom edge in the [edges example](/example/src/
243243

244244
### Background
245245

246-
React Flow comes with two background variants: **dots** and **lines**.
246+
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:
247247

248248
```javascript
249249
import ReactFlow, { Background } from 'react-flow-renderer';
@@ -263,8 +263,8 @@ const FlowWithBackground = () => (
263263

264264
- `variant`: string - has to be 'dots' or 'lines' - default: `dots`
265265
- `gap`: number - the gap between the dots or lines - default: `16`
266-
- `size`: number - the radius of the dots or the stroke width of the lines - default: 0.5
267-
- `color`: string - the color of the dots or lines - default: `#999` for dots, '#eee' for lines
266+
- `size`: number - the radius of the dots or the stroke width of the lines - default: `0.5`
267+
- `color`: string - the color of the dots or lines - default: `#999` for dots, `#eee` for lines
268268
- `style`: css properties
269269
- `className`: class name
270270

0 commit comments

Comments
 (0)