Skip to content
This repository was archived by the owner on Aug 7, 2020. It is now read-only.

Commit eb70d12

Browse files
JDownloaderneolitec
authored andcommitted
:docs: docs(datagrid): improve datagrid documentation (#68)
:docs: docs(datagrid): minor correction
1 parent 92b7a80 commit eb70d12

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

packages/oui-datagrid/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ You can use `row-loader`. It take the current row as argument and must return a
245245
| Attribute | Type | Binding | One-time binding | Values | Default | Description |
246246
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
247247
| `page-size` | number | @? | | | 25 | maximum number of rows to show on each pages |
248-
| `rows` | string | <? | yes | | | rows to show |
248+
| `rows` | array<object> | <? | yes | | | rows to show |
249249
| `rows-loader` | function | &? | yes | | | gets all rows (returns a promise with all rows) |
250250
| `row-loader` | function | &? | yes | | | gets row details (returns a promise with details) |
251251

@@ -258,6 +258,13 @@ You can use `row-loader`. It take the current row as argument and must return a
258258
| `property` | string | N/A | yes | | | property path used to get value from value |
259259
| `sortable` | string | N/A | yes | `asc`, `desc` | `asc` on `sortable=""` | makes a column sortable and gives the order |
260260

261+
### rows-loader promise response
262+
263+
| Attribute | Type | Binding | One-time binding | Values | Default | Description |
264+
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
265+
| `data` | array<object> | <? | yes | | | rows to show |
266+
| `meta` | object | N/A | yes | | | an object containing pagination information { totalCount: X } |
267+
261268
### oui-action-menu
262269

263270
Can be used as a column and will be sticked on side on smaller devices. Documentation about `oui-action-menu` can be found [here](#!/oui-angular/action-menu).

0 commit comments

Comments
 (0)