alfresco-ng2-components/docs/folder-edit.directive.md

34 lines
819 B
Markdown

---
Added: v2.0.0
Status: Active
---
# 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">
<mat-icon>create</mat-icon>
</button>
</adf-toolbar>
<adf-document-list #documentList ...>
...
</adf-document-list>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| folder | `MinimalNodeEntryEntity` | | Folder node to edit. |
## Details
'FolderEditDirective' directive needs a selection folder entry of #documentList to open the folder dialog component to edit the name and description properties of that selected folder.
If data is valid, on dialog close, it emits folderEdit event.