mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2670] Final doc checks for release (#3205)
* [ADF-2670] Fixed files with wrong name or location * [ADF-2670] Fixed display glitch with tutorial index
This commit is contained in:
committed by
Eugenio Romano
parent
1681958d6b
commit
02620f5563
84
docs/content-services/file-draggable.directive.md
Normal file
84
docs/content-services/file-draggable.directive.md
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-10
|
||||
---
|
||||
|
||||
# File Draggable directive
|
||||
|
||||
Provides drag-and-drop features for an element such as a `div`.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<div [file-draggable]="true" id="DragAndDropBorder" class="drag-and-drop-border"
|
||||
(filesDropped)="onFilesDropped($event)"
|
||||
(filesEntityDropped)="onFilesEntityDropped($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:
|
||||
|
||||
```css
|
||||
.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 |
|
||||
| -- | -- | -- | -- |
|
||||
| file-draggable | `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>` | 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
|
||||
|
||||
```ts
|
||||
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);
|
||||
}
|
||||
}
|
||||
|
||||
onFilesEntityDropped(item: any): void {
|
||||
// Use for example the uploadService to upload files to ACS
|
||||
console.log('# of files dropped: ', item);
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
- [Upload Drag Area component](../content-services/upload-drag-area.component.md)
|
Reference in New Issue
Block a user