alfresco-ng2-components/docs/content-services/version-manager.component.md
Andy Stark 563af3bbfa [ADF-2905] Updated JSDocs for content services (#3269)
* [ADF-2905] Updated JSDocs for content services

* [ADF-2905] Added missing update to version manager MD file
2018-05-04 13:56:01 +01:00

56 lines
1.6 KiB
Markdown

---
Added: v2.0.0
Status: Experimental
Last reviewed: 2018-04-13
---
# Version Manager Component
Displays the version history of a node with the ability to upload a new version.
![Version Manager](../docassets/images/version-manager.png)
![\#f03c15](https://placehold.it/15/f03c15/000000?text=+) `This component is still in experimental phase. It has several limitations which will be resolved soon.`
## Basic Usage
```html
<adf-version-manager
[node]="aMinimalNodeEntryEntity"
(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. |
| node | `MinimalNodeEntryEntity` | | Target node to manage version history. |
| showComments | `boolean` | true | Toggles showing/hiding of comments. |
### Events
| Name | Type | Description |
| -- | -- | -- |
| uploadError | `EventEmitter<Object>` | Emitted when an error occurs during upload. |
| uploadSuccess | `EventEmitter<Object>` | Emitted when a file is uploaded successfully. |
## Details
### Version actions
Each version has a context menu on the right, with the following actions.
| Action | Versions | Description |
| ------ | -------- | ----------- |
| Restore | All | Revert the current version to the selected one with creating a new version of it. |
## See also
- [Version list component](version-list.component.md)
- [Document list component](document-list.component.md)