Update docs

This commit is contained in:
Albert Juhé Lluveras 2018-12-17 12:22:58 +01:00
parent c341137a1b
commit f819f762c4
2 changed files with 31 additions and 8 deletions

View File

@ -43,7 +43,9 @@ A placeholder for the search input.
- label: String
- Default: `[]`
An array of objects describing selected values.
An array of objects describing selected values. If the label of the selected
value is omitted, the Tag of that value will not be rendered inside the
search box.
### `inlineTags`

View File

@ -18,6 +18,13 @@ Props
The string to use as a query parameter when comparing row items.
### `compareParam`
- Type: String
- Default: `'filter'`
Url query parameter compare function operates on
### `headers`
- Type: Array
@ -65,6 +72,13 @@ It will display `TablePlaceholder` component instead of `Table` if that's the ca
A function which returns a callback function to update the query string for a given `param`.
### `onColumnsChange`
- Type: Function
- Default: `noop`
A function which returns a callback function which is called upon the user changing the visiblity of columns.
### `downloadable`
- Type: Boolean
@ -111,6 +125,20 @@ Which column should be the row header, defaults to the first item (`0`) (see `Ta
The total number of rows to display per page.
### `searchBy`
- Type: String
- Default: null
The string to use as a query parameter when searching row items.
### `searchParam`
- Type: String
- Default: null
Url query parameter search function operates on
### `summary`
- Type: Array
@ -137,13 +165,6 @@ The title used in the card header, also used as the caption for the content in t
The total number of rows (across all pages).
### `compareParam`
- Type: String
- Default: `'filter'`
Url query parameter compare function operates on
`EmptyTable` (component)
========================