alfresco-ng2-components/docs/task-list.component.md

3.7 KiB

Activiti Task List component

Renders a list containing all the tasks matched by the parameters specified.

Basic Usage

<adf-tasklist 
    [appId]="'1'" 
    [state]="'open'" 
    [assignment]="'assignee'">
</adf-tasklist>

You can also use HTML-based schema declaration like shown below:

<adf-tasklist ...>
    <data-columns>
        <data-column key="name" title="NAME" class="full-width name-column"></data-column>
        <data-column key="created" title="Created" class="hidden"></data-column>
    </data-columns>
</adf-tasklist>

Properties

Name Type Default Description
appId string The id of the app.
processDefinitionKey string The processDefinitionKey of the process.
processInstanceId string The processInstanceId of the process.
page number 0 The page of the tasks to fetch.
size number 5 The number of tasks to fetch.
assignment string The assignment of the process.
    Possible values are:
  • assignee : where the current user is the assignee
  • candidate: where the current user is a task candidate
  • group_x: where the task is assigned to a group where the current user is a member of.
  • no value: where the current user is involved
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.
multiselect boolean false Toggles multiple row selection, renders checkboxes at the beginning of each row
state string Define state of the processes. Possible values are: completed, active
hasIcon boolean true Toggle the icon on the left .
landingTaskId string Define which task id should be selected after the reloading. If the task id doesn't exist or nothing is passed it will select the first task
sort string Define the sort of the processes. Possible values are : created-desc, created-asc, due-desc, due-asc
data DataTableAdapter JSON object that represent the number and the type of the columns that you want show (see the example section below)

Events

Name Description
success Raised when the task list is loaded
rowClick Raised when the task in the list is clicked
rowsSelected Raised when the a row is selected/unselected

Details

This component displays lists of process instances both active and completed, using any defined process filter, and render details of any chosen instance.

DataTableAdapter example

See the DataTableAdapter page for full details of the interface and its standard implementation, ObjectDataTableAdapter. Below is an example of how you can set up the adapter for a typical tasklist.

[
 {"type": "text", "key": "id", "title": "Id"},
 {"type": "text", "key": "name", "title": "Name", "cssClass": "full-width name-column", "sortable": true},
 {"type": "text", "key": "formKey", "title": "Form Key", "sortable": true},
 {"type": "text", "key": "created", "title": "Created", "sortable": true}
]

DataColumn Features

You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the DataColumn page for more information about these features.

See also