Skip to content
This repository was archived by the owner on May 15, 2022. It is now read-only.

Commit b8e1869

Browse files
authored
Use tables for DatGUI props in README.md
1 parent 61ed66b commit b8e1869

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,23 @@ class App extends React.Component {
7777
7878
This is the main container component for your GUI and is the default export from the package.
7979
80-
#### props
80+
#### required
8181
82-
##### required
82+
| prop | Description | Type |
83+
|----------|---------------------------------------------------------------------------------|----------|
84+
| data | The data your dat.GUI controller will mutate | object |
85+
| onUpdate | The method which will be called whenever an update is handled by the controller | function |
86+
| children | The dat.GUI components that make up the controller | array |
8387
84-
- `data: object` - The data your dat.GUI controller will mutate
85-
- `onUpdate: func` - The method which will be called whenever an update is handled by the controller
86-
- `children: array` - The dat.GUI components that make up the controller
88+
#### optional
8789
88-
##### optional
90+
| prop | Description | Type | Default |
91+
|------------|------------------------------------------------|---------|---------|
92+
| liveUpdate | Determines if live updates should occur | boolean | true |
93+
| labelWidth | The width of the labels in any valid CSS units | string | "40%" |
94+
| className | The class name to set on the `DatGui` div | string | null |
95+
| style | The style object to set on the `DatGui` div | object | null |
8996
90-
- `liveUpdate: bool` - Determines if live updates should occur, defaults to `true`
91-
- `labelWidth: string` - The width of the labels in any valid CSS units, defaults to `40%`
92-
- `className: string` - The class name to set on the `DatGui` div
93-
- `style: object` - The style object to set on the `DatGui` div
9497
9598
### Components
9699

0 commit comments

Comments
 (0)