[ADF-3816] Clarified misleading property description in Document List docs (#4056)

* [ADF-3816] Clarified misleading prop description for document list

* [ADF-3816] Removed a link incorrectly added to the word 'User'
This commit is contained in:
Andy Stark
2018-12-06 15:56:30 +00:00
committed by Denys Vuika
parent 474f2e6e5e
commit 811a3f1f7d
2 changed files with 7 additions and 2 deletions

View File

@@ -81,7 +81,7 @@ Displays the documents from a repository.
| showHeader | `boolean` | true | Toggles the header | | showHeader | `boolean` | true | Toggles the header |
| skipCount | `number` | 0 | (**Deprecated:** 2.3.0 - define it in pagination) Number of elements to skip over for pagination purposes | | skipCount | `number` | 0 | (**Deprecated:** 2.3.0 - define it in pagination) Number of elements to skip over for pagination purposes |
| sorting | `string[]` | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | | sorting | `string[]` | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` or `server`. | | sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons | | thumbnails | `boolean` | false | Show document thumbnails rather than icons |
### Events ### Events

View File

@@ -134,7 +134,12 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
@Input() @Input()
sorting = ['name', 'asc']; sorting = ['name', 'asc'];
/** Defines sorting mode. Can be either `client` or `server`. */ /** Defines sorting mode. Can be either `client` (items in the list
* are sorted client-side) or `server` (the ordering supplied by the
* server is used without further client-side sorting).
* Note that the `server` option *does not* request the server to sort the data
* before delivering it.
*/
@Input() @Input()
sortingMode = 'client'; sortingMode = 'client';