Skip to content

Commit 6997565

Browse files
committed
[Project] Fix README for Github
1 parent fc52c5b commit 6997565

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ There is a screenshot of the result :
6969
| rootName | Root name for first object | String | False | root |
7070

7171
### isCollapsed
72-
| Key | Description | Type | Required | Default |
73-
|:-----------:|:--------------------------------------------:|:--------:|:---------:|:-------------------------------:|
74-
| isCollapsed | Is node collapsed ? (For Array/Object/Error) | Function | False | (keyPath, deep) => (deep !== 0) |
72+
| Key | Description | Type | Required | Default |
73+
|:-----------:|:--------------------------------------------:|:--------:|:---------:|:---------------------------------:|
74+
| isCollapsed | Is node collapsed ? (For Array/Object/Error) | Function | False | `(keyPath, deep) => (deep !== 0)` |
7575

7676
Function parameters :
7777

@@ -81,9 +81,9 @@ Function parameters :
8181
| deep | Deep of current node | Number | 1 for data: { object: { string: 'test' } } on 'object' node |
8282

8383
### onFullyUpdate
84-
| Key | Description | Type | Required | Default |
85-
|:-------------:|:---------------------------------------------------------------------:|:--------:|:---------:|:--------:|
86-
| onFullyUpdate | Function called each time an update is done and give the updated data | Function | False | () => {} |
84+
| Key | Description | Type | Required | Default |
85+
|:-------------:|:---------------------------------------------------------------------:|:--------:|:---------:|:----------:|
86+
| onFullyUpdate | Function called each time an update is done and give the updated data | Function | False | `() => {}` |
8787

8888
Function parameters :
8989

@@ -92,9 +92,9 @@ Function parameters :
9292
| data | Updated data | Object/Array (Same as entry) |
9393

9494
### onDeltaUpdate
95-
| Key | Description | Type | Required | Default |
96-
|:-------------:|:-----------------------------------------------------------------:|:--------:|:---------:|:--------:|
97-
| onDeltaUpdate | Function called each time an update is done and give delta update | Function | False | () => {} |
95+
| Key | Description | Type | Required | Default |
96+
|:-------------:|:-----------------------------------------------------------------:|:--------:|:---------:|:----------:|
97+
| onDeltaUpdate | Function called each time an update is done and give delta update | Function | False | `() => {}` |
9898

9999
Function parameters :
100100

@@ -119,9 +119,9 @@ Delta data structure :
119119
| readOnly | Read only boolean for all object | Boolean | False | false |
120120

121121
### getStyle
122-
| Key | Description | Type | Required | Default |
123-
|:-----------:|:--------------------:|:--------:|:---------:|:-------------------------------------------------:|
124-
| getStyle | Get style (CSS keys) | Function | False | (keyName, data, keyPath, deep, dataType) => {...} |
122+
| Key | Description | Type | Required | Default |
123+
|:-----------:|:--------------------:|:--------:|:---------:|:---------------------------------------------------:|
124+
| getStyle | Get style (CSS keys) | Function | False | `(keyName, data, keyPath, deep, dataType) => {...}` |
125125

126126
Function parameters :
127127

@@ -162,51 +162,51 @@ You can see the actual used in `src/utils/styles.js`.
162162
### addButtonElement
163163
| Key | Description | Type | Required | Default |
164164
|:----------------:|:-----------------------------------------:|:-----------:|:--------:|:---------------------:|
165-
| addButtonElement | Add button Element to replace library one | Element | False | <button>+</button> |
165+
| addButtonElement | Add button Element to replace library one | Element | False | `<button>+</button>` |
166166

167167
The library will add a `onClick` props on element.
168168

169169
### cancelButtonElement
170170
| Key | Description | Type | Required | Default |
171171
|:-------------------:|:--------------------------------------------:|:-----------:|:--------:|:---------------------:|
172-
| cancelButtonElement | Cancel button Element to replace library one | Element | False | <button>c</button> |
172+
| cancelButtonElement | Cancel button Element to replace library one | Element | False | `<button>c</button>` |
173173

174174
The library will add a `onClick` props on element.
175175

176176
### editButtonElement
177177
| Key | Description | Type | Required | Default |
178178
|:-----------------:|:------------------------------------------:|:-----------:|:--------:|:---------------------:|
179-
| editButtonElement | Edit button Element to replace library one | Element | False | <button>e</button> |
179+
| editButtonElement | Edit button Element to replace library one | Element | False | `<button>e</button>` |
180180

181181
The library will add a `onClick` props on element.
182182

183183
### inputElement
184184
| Key | Description | Type | Required | Default |
185185
|:------------:|:-----------------------------------------:|:-----------:|:--------:|:------------:|
186-
| inputElement | Input Text Element to replace library one | Element | False | <input /> |
186+
| inputElement | Input Text Element to replace library one | Element | False | `<input />` |
187187

188188
The library will add a `placeholder`, `ref`, `defaultValue` props on element.
189189
This item will be focus when possible.
190190

191191
### textareaElement
192-
| Key | Description | Type | Required | Default |
193-
|:---------------:|:-----------------------------------------:|:-----------:|:--------:|:------------:|
194-
| textareaElement | Textarea Element to replace library one | Element | False | <textarea /> |
192+
| Key | Description | Type | Required | Default |
193+
|:---------------:|:-----------------------------------------:|:-----------:|:--------:|:--------------:|
194+
| textareaElement | Textarea Element to replace library one | Element | False | `<textarea />` |
195195

196196
The library will add a `ref`, `defaultValue` props on element.
197197
This item will be focus when possible.
198198

199199
### minusMenuElement
200200
| Key | Description | Type | Required | Default |
201201
|:----------------:|:-----------------------------------------:|:-----------:|:--------:|:-------------------:|
202-
| minusMenuElement | Minus Menu Element to replace library one | Element | False | <span> - </span> |
202+
| minusMenuElement | Minus Menu Element to replace library one | Element | False | `<span> - </span>` |
203203

204204
The library will add a `onClick`, `className` and `style` props on element.
205205

206206
### plusMenuElement
207207
| Key | Description | Type | Required | Default |
208208
|:---------------:|:----------------------------------------:|:-----------:|:--------:|:-------------------:|
209-
| plusMenuElement | Plus Menu Element to replace library one | Element | False | <span> + </span> |
209+
| plusMenuElement | Plus Menu Element to replace library one | Element | False | `<span> + </span>` |
210210

211211
The library will add a `onClick`, `className` and `style` props on element.
212212

0 commit comments

Comments
 (0)