[ADF-616] Document Angular Material Design (#2569)

This commit is contained in:
Andy Stark
2017-10-30 18:23:27 +00:00
committed by Denys Vuika
parent e5fe39fdc1
commit 3240929dd3
7 changed files with 106 additions and 23 deletions

View File

@@ -1,6 +1,6 @@
# Version Manager Component
The Version manager component displays the version history of a node with the ability to upload a new version.
Displays the version history of a node with the ability to upload a new version.
![#f03c15](https://placehold.it/15/f03c15/000000?text=+) `This component is still in experimental phase, it has several limitations which will be resolved soon.`
@@ -12,28 +12,13 @@ The Version manager component displays the version history of a node with the ab
<adf-version-manager [node]="aMinimalNodeEntryEntity"></adf-version-manager>
```
## Properties
### Properties
| Name | Type | 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. |
## Version List component
Inside the version manager component, there is the underlying VersionListComponent. The VersionListComponent loads and displays the version history of a node.
### Basic Usage
```html
<adf-version-list [id]="nodeId"></adf-version-list>
```
### Properties
| Name | Type | Description |
| --- | --- | --- |
| id | string | The node id you want to see the version history of. |
## Details
### Version actions
@@ -43,8 +28,10 @@ Each version has a context menu on the right, with the following actions.
| --- | --- | --- |
| Restore | All | Revert the current version to the selected one with creating a new version of it. |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Version list component](version-list.component.md)
- [Document list component](document-list.component.md)
<!-- seealso end -->