AleksanderSklorz 8ebb8d1b43
[MNT-24660] version list action cannot be disabled using app conf (#10308)
* MNT-24660 Added possibility to hide and show viewing of versions when calling openUploadNewVersionDialog function

* MNT-24660 Unit tests

* MNT-24660 Allow to set allowVersionDelete and showActions by new version uploader service

* MNT-24660 Unit tests and documentation

* MNT-24660 Reformated documentation table

* MNT-24660 Fixed sonar issues

* MNT-24660 Fix sonar and additional fixes
2024-10-21 15:16:20 +02:00

67 lines
4.1 KiB
Markdown

---
Title: Version Manager Component
Added: v2.0.0
Status: Active
Last reviewed: 2019-01-16
---
# [Version Manager Component](../../../lib/content-services/src/lib/version-manager/version-manager.component.ts "Defined in version-manager.component.ts")
Displays the version history of a node with the ability to upload a new version.
![Version Manager](../../docassets/images/version-manager.png)
## Basic Usage
```html
<adf-version-manager
[node]="aNode"
(uploadSuccess)="customMethod($event)"
(uploadError)="customMethod2($event)">
</adf-version-manager>
```
## Class members
### Properties
| Name | Type | Default value | Description |
|-----------------------|-----------|---------------|-------------------------------------------------------------------------------------------------------------------------------|
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| newFileVersion | `File` | | New file for updating current version. |
| node | `Node` | | Target node to manage version history. |
| showComments | `boolean` | true | Toggles showing/hiding of comments. |
| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). |
| showActions | `boolean` | true | Toggles showing/hiding of version actions. |
| allowViewVersions | `boolean` | true | Enable/disable viewing versions of the current node. |
| allowVersionDelete | `boolean` | true | Enable/disable deletion of version |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when an cancelling during upload. |
| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/content-services/src/lib/common/events/file.event.ts)`>` | Emitted when an error occurs during upload. |
| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a file is uploaded successfully. |
| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when viewing a version. |
## Details
### Version actions
Each version has a context menu on the right, with the following actions.
| Action | Versions | Description |
|----------|----------|-----------------------------------------------------------------------------------|
| View | All | View selected version. |
| Restore | All | Revert the current version to the selected one with creating a new version of it. |
| Download | All | Download selected version. |
| Delete | All | Delete selected version. |
## See also
- [Version list component](version-list.component.md)
- [Document list component](document-list.component.md)
- [New Version Uploader service](../services/new-version-uploader.dialog.service.md)
- [New Version Uploader component](new-version-uploader.dialog.md)