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

:docs: docs(datagrid): improve datagrid documentation #68

Merged
merged 2 commits into from
Jan 23, 2018
Merged

:docs: docs(datagrid): improve datagrid documentation #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3057d41
:docs: docs(datagrid): improve datagrid documentation
JDownloader Jan 22, 2018
55e2f98
:docs: docs(datagrid): doc minor correction
JDownloader Jan 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion packages/oui-datagrid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ You can use `row-loader`. It take the current row as argument and must return a
| Attribute | Type | Binding | One-time binding | Values | Default | Description |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| `page-size` | number | @? | | | 25 | maximum number of rows to show on each pages |
| `rows` | string | <? | yes | | | rows to show |
| `rows` | array<object> | <? | yes | | | rows to show |
| `rows-loader` | function | &? | yes | | | gets all rows (returns a promise with all rows) |
Copy link
Contributor

@tremblaymath tremblaymath Jan 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a link here to your new section could be interesting to relate content in a user-friendly way

| `row-loader` | function | &? | yes | | | gets row details (returns a promise with details) |

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

### rows-loader promise response

| Attribute | Type | Binding | One-time binding | Values | Default | Description |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| `data` | array<object> | <? | yes | | | rows to show |
| `meta` | object | N/A | yes | | | an object containing pagination information { totalCount: X } |

### oui-action-menu

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).
Expand Down