Files
alfresco-ng2-components/docs/content-services/folder-edit.directive.md
Andy Stark 2c0e7aa035 [ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)
* [ADF-2847] Added class members heading to content services docs

* [ADF-2847] Updated all prop/method tables in content services
2018-04-26 14:54:25 +01:00

48 lines
1.1 KiB
Markdown

---
Added: v2.0.0
Status: Active
Last reviewed: 2018-04-10
---
# Folder Edit directive
Allows folders to be edited.
## Basic Usage
```html
<adf-toolbar title="toolbar example">
<button mat-icon-button
[adf-edit-folder]="documentList.selection[0]?.entry"
title="Title of the dialog"
(success)="doSomething($event)">
<mat-icon>create</mat-icon>
</button>
</adf-toolbar>
<adf-document-list #documentList ...>
...
</adf-document-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| adf-edit-folder | `MinimalNodeEntryEntity` | | Folder node to edit. |
| title | `string` | null | |
### Events
| Name | Type | Description |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when the edit/create folder give error for example a folder with same name already exist |
| success | `EventEmitter<MinimalNodeEntryEntity>` | |
## Details
Pass this directive a folder to edit its name and description using a Folder Dialog component.
If the data is valid then the dialog emits a `folderEdit` event when it closes.