alfresco-ng2-components/docs/content-services/folder-edit.directive.md
Andy Stark 69d8ff147e [ADF-3323] Updated doc tools to use DocFX intermediate files (#3601)
* [ADF-3323] Moved source file parsing to main doc tool

* [ADF-3323] Moved source info classes

* [ADF-3323] Added doc YAML generator tool

* [ADF-3323] Added doc YAML/JSON source paths to gitignore

* [ADF-3323] Completed templates and template context code

* [ADF-3323] Added source paths and updated type linker

* [ADF-3323] Final fixes to templates and type linking

* [ADF-3323] Fixed filter for private and protected methods

* [ADF-3323] Content services docs after check and rebuild

* [ADF-3323] Updated docbuild script in package.json
2018-08-14 15:42:25 +01:00

1.4 KiB

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-04-10

Folder Edit directive

Allows folders to be edited.

Basic Usage

<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
folder MinimalNodeEntryEntity Folder node to edit.
title string null Title of folder edit dialog.

Events

Name Type Description
error EventEmitter<any> Emitted when an error occurs (eg, a folder with same name already exists).
success EventEmitter<MinimalNodeEntryEntity> Emitted when the folder has been edited successfully.

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.