mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
c9a3b048b4
* [ADF-1769] Added JSDocs and updated prop table script * [ADF-1769] Fixed lint error in JSDoc
28 lines
700 B
Markdown
28 lines
700 B
Markdown
# Comments Component
|
|
|
|
Displays comments from users involved in a specified task and allows an involved user to add a comment to the task.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-comments
|
|
[taskId]="YOUR_TASK_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG">
|
|
</adf-comments>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| taskId | `string` | The numeric ID of the task. |
|
|
| readOnly | `boolean` | Are the comments read only? <br/> Default value: `false` |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| error | `EventEmitter<any>` | Emitted when an error occurs while displaying/adding a comment. |
|