alfresco-ng2-components/docs/folder-edit.directive.md
suzanadirla 5dabc39841 [ADF-1774] Extend "Create Folder" and add "Edit Folder" dialogs to ADF (#2585)
* [ADF-1774] Extend "Create Folder" and add "Edit Folder" dialogs to ADF

- added create and edit folder directives and used them inside the demo-shell file component
- added FolderDialogComponent for edit/create actions with name validators: forbidSpecialCharacters, forbidEndingDot and forbidOnlySpaces
- updated the translation files
- added unit tests for the new components
- removed the CreateFolderDialogComponent and its usage inside demo-shell
- added documentation files for FolderCreateDirective and FolderEditDirective

* [ADF-1774] fix messed up translation files because of previous commit

* [ADF-1774] changes required on code review comments
2017-11-03 14:45:42 +00:00

40 lines
1.1 KiB
Markdown

# Folder Edit directive
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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 | Description |
| ----------------- | ---------------------- | ------- | ----------------------------------- |
| adf-edit-folder | MinimalNodeEntryEntity | | The folder node entity for editing |
## 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.