[ADF-3514] Added transclusions sections to doc files (#3756)

* [ADF-3514] Added transclusion sections and guide page

* [ADF-3514] Updated tables of contents where needed

* [ADF-3514] Updated index files
This commit is contained in:
Andy Stark
2018-09-10 11:11:25 +01:00
committed by Eugenio Romano
parent 35e1563fde
commit 2c49de6070
35 changed files with 682 additions and 515 deletions

View File

@@ -11,6 +11,7 @@ Renders a list containing all the tasks matched by the parameters specified.
## Contents
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
@@ -20,7 +21,6 @@ Renders a list containing all the tasks matched by the parameters specified.
- [Pagination strategy](#pagination-strategy)
- [DataTableAdapter example](#datatableadapter-example)
- [DataColumn Features](#datacolumn-features)
- [Show custom template when tasklist is empty](#show-custom-template-when-tasklist-is-empty)
- [See also](#see-also)
## Basic Usage
@@ -33,6 +33,19 @@ Renders a list containing all the tasks matched by the parameters specified.
</adf-tasklist>
```
### [Transclusions](../user-guide/transclusion.md)
Any content inside an `<adf-empty-custom-content>` sub-component will be shown
when the task list is empty:
```html
<adf-tasklist>
<adf-empty-custom-content>
Your Content
</adf-empty-custom-content>
<adf-tasklist>
```
## Class members
### Properties
@@ -47,13 +60,10 @@ Renders a list containing all the tasks matched by the parameters specified.
| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row |
| name | `string` | | Name of the tasklist. |
| page | `number` | 0 | The page number of the tasks to fetch. |
| start | `number` | 0 | Another approach to specify which page you want load. |
| processDefinitionId | `string` | | The Definition Id of the process. |
| processDefinitionKey | `string` | | (**Deprecated:** 2.4.0) The Definition Key of the process. |
| processInstanceId | `string` | | The Instance Id of the process. |
| taskId | `string` | | The taskId you want to be fetched. |
| selectFirstRow | `boolean` | true | Toggles default selection of the first row |
| includeProcessInstance | `boolean` | false | Include the process instance info |
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| size | `number` | | The number of tasks to fetch. Default value: 25. |
| sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` |
@@ -213,18 +223,6 @@ typical tasklist.
You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) page for more information about these features.
### Show custom template when tasklist is empty
You can add your own template or message as shown in the example below:
```html
<adf-tasklist>
<adf-empty-custom-content>
Your Content
</adf-empty-custom-content>
<adf-tasklist>
```
## See also
- [Data column component](../core/data-column.component.md)