alfresco-ng2-components/docs/content-services/version-manager.component.md
Andy Stark 460e33ccdb [ADF- 2670] Checked and updated docs for 2.3 (#3197)
* [ADF-2670] Reviewed docs for 2.3 with only minor changes

* [ADF-2670] Checked and updated docs for 2.3
2018-04-16 15:51:29 +01:00

54 lines
1.7 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>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | --- | ----------- |
| node | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | |The node you want to manage the version history of. |
| showComments | `boolean` | true | Set this to false if version comments should not be displayed. |
| allowDownload | `boolean` | true | Toggles downloads of previous versions. Set this to false to not show the menu item for version download. |
### Events
| Name | Description |
| --- | --- |
| uploadSuccess | Raised when the file is uploaded |
| uploadError | Emitted when an error occurs.|
## 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)