mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-10-29 15:21:39 +00:00
6dafcb4447
* [ADF-5580] emit commentAdded event from adf-comments component * [ADF-5580] Emit commentAdded event from adf-comments and expose it in adf-node-comments * [ADF-5580] Emit commentAdded event from NodeCommentsComponent, add unit test, and update docs * [ADF-5580] Add unit test for commentAdded output in NodeCommentsComponent, update docs and create testing utils * [ADF-5580] Mark debugElement as readOnly * [ADF-5580] Add mock services and fix unit test setup * [ADF-5580] Reuse shared comment mocks across multiple test files * [ADF-5580] Align comments component documentation * [ADF-5580] Remove redundant setup and use ContentTestingModule in comment components tests
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
---
|
|
Title: Comments Component
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
|
|
# [Comments Component](../../../lib/core/src/lib/comments/comments.component.ts "Defined in comments.component.ts")
|
|
|
|
Displays comments from users involved in a specified environment and allows an involved user to add a comment to a environment.
|
|
|
|
|
|
|
|
## Basic Usage Task
|
|
|
|
```html
|
|
<adf-comments
|
|
[id]="YOUR_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG"
|
|
(commentAdded)="onCommentAdded($event)">
|
|
</adf-comments>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| -------- | --------- | ------------- | --------------------------- |
|
|
| id | `string` | | The numeric ID of the task. |
|
|
| readOnly | `boolean` | false | Are the comments read only? |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ------------ | --------------------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while displaying/adding a comment. |
|
|
| commentAdded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CommentModel>` | Emitted when a new comment is successfully added. |
|