inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* [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
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/process-services/README.md
View File

@@ -33,7 +33,7 @@ for more information about installing and using the source code.
| [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../../lib/process-services/task-list/components/task-filters.component.ts) |
| [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../../lib/process-services/task-list/components/task-header.component.ts) |
| [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services/task-list/components/task-list.component.ts) |
| [Task standalone component](task-standalone.component.md) | This component can be used when there is no form attached to a task. | [Source](../../lib/process-services/task-list/components/task-standalone.component.ts) |
| [Task standalone component](task-standalone.component.md) | This component can be used when the task doesn't belong to any processes. | [Source](../../lib/process-services/task-list/components/task-standalone.component.ts) |
## Directives

5
docs/process-services/apps-list.component.md
View File

@@ -18,7 +18,10 @@ Shows all available apps.
</adf-apps>
```
You can also show a custom template if there are no apps present:
### [Transclusions](../user-guide/transclusion.md)
You can show custom content when there are no apps available by supplying an
`<adf-empty-custom-content>` section:
```html
<adf-apps

14
docs/process-services/people-search.component.md
View File

@@ -13,6 +13,18 @@ Searches users/people.
<adf-people-search></adf-people-search>
```
### [Transclusions](../user-guide/transclusion.md)
You can provide a title for the search header and a label for the action button using
special sub-components in the body of the `<adf-people-search>` element:
```html
<adf-people-search ...>
<header-title>Custom title</header-title>
<action-button-label>Custom label</action-button-label>
</adf-people-search>
```
## Class members
### Properties
@@ -41,7 +53,7 @@ Searches users/people.
[results]="peopleSearch$">
<header-title>{{ 'TASK_DETAILS.LABELS.ADD_PEOPLE' | translate }}</header-title>
<action-button-label>{{ 'PEOPLE.ADD_USER' | translate }}</action-button-label>
</adf-people-search>
</adf-people-search>
```
<!-- {% endraw %} -->

25
docs/process-services/process-attachment-list.component.md
View File

@@ -36,6 +36,23 @@ export class MyCustomProcessAttachmentComponent {
}
```
### [Transclusions](../user-guide/transclusion.md)
Any content inside the `<adf-process-attachment-list>` element will be shown when
the list is empty:
```html
<adf-process-attachment-list ...>
<div><!-- Custom empty list message goes here --></div>
</adf-process-attachment-list>
```
![custom-no-content-drag-drop-template-sample](../docassets/images/custom-no-content-drag-drop-template.png)
A default template will be used if you don't supply a custom one to override it:
![default-no-content-template-sample](../docassets/images/default-no-content-template.png)
## Class members
### Properties
@@ -84,11 +101,3 @@ a custom _no content template_ (using &lt;adf-empty-list>) to invite the user to
```
<!-- {% endraw %} -->
If the List is empty, the custom no-content template we passed is displayed.
![custom-no-content-drag-drop-template-sample](../docassets/images/custom-no-content-drag-drop-template.png)
A default template will be used if you don't supply a custom one to override it:
![default-no-content-template-sample](../docassets/images/default-no-content-template.png)

27
docs/process-services/process-list.component.md
View File

@@ -11,13 +11,13 @@ Renders a list containing all the process instances matched by the parameters sp
## Contents
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
- [Pagination strategy](#pagination-strategy)
- [Show custom template when processList is empty](#show-custom-template-when-processlist-is-empty)
- [See also](#see-also)
## Basic Usage
@@ -31,6 +31,19 @@ Renders a list containing all the process instances matched by the parameters sp
</adf-process-instance-list>
```
### [Transclusions](../user-guide/transclusion.md)
Any content inside an `<adf-empty-custom-content>` sub-component will be shown
when the process list is empty:
```html
<adf-process-instance-list>
<adf-empty-custom-content>
Your Content
</adf-empty-custom-content>
<adf-process-instance-list>
```
## Class members
### Properties
@@ -170,18 +183,6 @@ The Process Instance List also supports pagination:
</adf-pagination>
```
### Show custom template when processList is empty
You can add your own template or message as shown in the example below:
```html
<adf-process-instance-list>
<adf-empty-custom-content>
Your Content
</adf-empty-custom-content>
<adf-process-instance-list>
```
## See also
- [Data column component](../core/data-column.component.md)

25
docs/process-services/task-attachment-list.component.md
View File

@@ -19,6 +19,23 @@ Displays attached documents on a specified task.
</adf-task-attachment-list>
```
### [Transclusions](../user-guide/transclusion.md)
Any content inside the `<adf-task-attachment-list>` element will be displayed
when the list is empty:
```html
<adf-task-attachment-list ...>
<div><!-- Custom empty list message goes here --></div>
</adf-task-attachment-list>
```
![custom-no-content-drag-drop-template-sample](../docassets/images/custom-no-content-drag-drop-template.png)
A default "no content" template is displayed if you don't supply one to override it:
![default-no-content-template-sample](../docassets/images/default-no-content-template.png)
## Class members
### Properties
@@ -38,10 +55,6 @@ Displays attached documents on a specified task.
## Details
If the List is empty, a default "no content" template is displayed.
![default-no-content-template-sample](../docassets/images/default-no-content-template.png)
### How to Add Drag and Drop Functionality
You can wrap the component with an [Upload Drag Area component](../content-services/upload-drag-area.component.md)
@@ -90,7 +103,3 @@ export class MyCustomTaskAttachmentComponent {
```
[Upload Drag Area Component](../content-services/upload-drag-area.component.md)
If the List is empty, the custom no-content template we passed is displayed.
![custom-no-content-drag-drop-template-sample](../docassets/images/custom-no-content-drag-drop-template.png)

30
docs/process-services/task-list.component.md
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)