mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2588] make comment component compatible with content (#3128)
This commit is contained in:
committed by
Eugenio Romano
parent
f985dd11d5
commit
653a510a5c
41
docs/core/comments.component.md
Normal file
41
docs/core/comments.component.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Comments Component
|
||||
|
||||
Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content.
|
||||
|
||||

|
||||
|
||||
## Basic Usage Task
|
||||
|
||||
```html
|
||||
<adf-comments
|
||||
[taskId]="YOUR_TASK_ID"
|
||||
[readOnly]="YOUR_READ_ONLY_FLAG">
|
||||
</adf-comments>
|
||||
```
|
||||
|
||||
## Basic Usage Content
|
||||
|
||||
```html
|
||||
<adf-comments
|
||||
[nodeId]="YOUR_NODE_ID"
|
||||
[readOnly]="YOUR_READ_ONLY_FLAG">
|
||||
</adf-comments>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | | The numeric ID of the task. |
|
||||
| nodeId | `string` | | The ID of the node. |
|
||||
| readOnly | `boolean` | `false` | Are the comments read only? |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs while displaying/adding a comment. |
|
Reference in New Issue
Block a user