alfresco-ng2-components/docs/content-services/file-draggable.directive.md
Andy Stark 431bde3ddf [ADF-3587] Fixed doc comment problems (#3822)
* [ADF-3587] Fixed missing docs for accessor properties

* [ADF-3587] Fixed badly formed doc comments with deprecated tag

* [ADF-3587] Fixed linting issue with doc comment
2018-09-25 21:45:16 +01:00

2.2 KiB

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

File Draggable directive

Provides drag-and-drop features for an element such as a div.

Basic Usage

<div [file-draggable]="true" id="DragAndDropBorder" class="drag-and-drop-border"
     (filesDropped)="onFilesDropped($event)"
     (folderEntityDropped)="onFolderEntityDropped($event)"
     dropzone="" webkitdropzone="*" #dragAndDropArea>
  <ng-content></ng-content>
  Drag and Drop files here!
</div>

Some sample CSS to show the drag and drop area:

.drag-and-drop-border {
  vertical-align: middle;
  text-align: center;
  border: double;
  background-color: lightblue;
  width: 400px;
  height: 100px;
}

Class members

Properties

Name Type Default value Description
enabled boolean true Enables/disables drag-and-drop functionality.

Events

Name Type Description
filesDropped EventEmitter<File[]> Emitted when one or more files are dragged and dropped onto the draggable element.
filesEntityDropped EventEmitter<any> (Deprecated: in 2.4.0: use filesDropped instead) Emitted when one or more files are dragged and dropped onto the draggable element.
folderEntityDropped EventEmitter<any> Emitted when a directory is dragged and dropped onto the draggable element.

Details

Typically you would use the Upload Drag Area component instead of this directive.

Event handler implementations

export class SomeComponent implements OnInit {

 onFilesDropped(files: File[]): void {
    if (files.length) {
      // Use for example the uploadService to upload files to ACS
      console.log('# of files dropped: ', files.length);
    }
  }

  onFolderEntityDropped(folder: any): void {
    if (folder.isDirectory) {
      // Use for example the uploadService to upload folder content to ACS
      console.log('Folder dropped: ', folder);
    }
  }

See also