mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

Andy Stark 2c0e7aa035 [ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240 )

* [ADF-2847] Added class members heading to content services docs

* [ADF-2847] Updated all prop/method tables in content services

2018-04-26 14:54:25 +01:00

2.7 KiB

Raw Blame History

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.0.0	Active	2018-03-23

Upload Button Component

Activates a file upload.

Basic usage

<adf-upload-button 
    [rootFolderId]="-my-"
    [uploadFolders]="true"
    [multipleFiles]="false"
    [acceptedFilesType]=".jpg,.gif,.png,.svg"
    [versioning]="false"
    (success)="customMethod($event)">
</adf-upload-button>
<adf-file-uploading-dialog></adf-file-uploading-dialog>

Class members

Properties

Name	Type	Default value	Description
acceptedFilesType	`string`	"*"	Filter for accepted file types.
disabled	`boolean`	false	Toggles component disabled state (if there is no node permission checking).
maxFilesSize	`number`		Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined.
multipleFiles	`boolean`	false	Allows/disallows multiple files
rootFolderId	`string`	"-root-"	The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services.
staticTitle	`string`		Defines the text of the upload button.
tooltip	`string`	null	Custom tooltip text.
uploadFolders	`boolean`	false	Allows/disallows upload folders (only for Chrome).
versioning	`boolean`	false	Toggles versioning.

Events

Name	Type	Description
createFolder	`EventEmitter<Object>`	Emitted when a folder is created.
error	`EventEmitter<Object>`	Emitted when an error occurs.
permissionEvent	`EventEmitter<PermissionModel>`	Emitted when delete permission is missing.
success	`EventEmitter<Object>`	Emitted when the file is uploaded successfully.

Details

How to show a notification message for bad permission

You can show a notification error when the user doesn't have the right permission to perform the action. The component emits a permissionEvent when the user does not have delete permission. You can subscribe to this event from your component and use the Notification service to show a message.

<adf-upload-button
    [rootFolderId]="currentFolderId"
    (permissionEvent)="onUploadPermissionFailed($event)">
</adf-upload-button>

export class MyComponent {

    onUploadPermissionFailed(event: any) {
        this.notificationService.openSnackMessage(
            `you don't have the ${event.permission} permission to ${event.action} the ${event.type} `, 4000
        );
    }

}

2.7 KiB Raw Blame History