mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
838842caac
* [ADF-2451] Reviewed component docs and fixed package.json issues * [ADF-2451] Fixed permission list brief desc and rebuilt indexes * [ADF-2451] Fixed incorrect filename for inherited button directive docs
81 lines
2.7 KiB
Markdown
81 lines
2.7 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-03-23
|
|
---
|
|
|
|
# Upload Button Component
|
|
|
|
Activates a file upload.
|
|
|
|
## Basic usage
|
|
|
|
```html
|
|
<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>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| disabled | `boolean` | `false` | Toggles component disabled state (if there is no node permission checking). |
|
|
| uploadFolders | `boolean` | `false` | Allows/disallows upload folders (only for Chrome). |
|
|
| multipleFiles | `boolean` | `false` | Allows/disallows multiple files |
|
|
| versioning | `boolean` | `false` | Toggles versioning. |
|
|
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
|
|
| staticTitle | `string` | | Defines the text of the upload button. |
|
|
| tooltip | `string` | `null` | Custom tooltip text. |
|
|
| rootFolderId | `string` | `'-root-'` | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
|
|
| acceptedFilesType | `string` | `'*'` | Filter for accepted file types. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| success | `EventEmitter<{}>` | Emitted when the file is uploaded successfully. |
|
|
| error | `EventEmitter<{}>` | Emitted when an error occurs. |
|
|
| createFolder | `EventEmitter<{}>` | Emitted when a folder is created. |
|
|
| permissionEvent | `EventEmitter<PermissionModel>` | Emitted when delete permission is missing. |
|
|
|
|
## 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](../core/notification.service.md) to show a message.
|
|
|
|
```html
|
|
<adf-upload-button
|
|
[rootFolderId]="currentFolderId"
|
|
(permissionEvent)="onUploadPermissionFailed($event)">
|
|
</adf-upload-button>
|
|
```
|
|
|
|
```ts
|
|
export class MyComponent {
|
|
|
|
onUploadPermissionFailed(event: any) {
|
|
this.notificationService.openSnackMessage(
|
|
`you don't have the ${event.permission} permission to ${event.action} the ${event.type} `, 4000
|
|
);
|
|
}
|
|
|
|
}
|
|
```
|
|
|
|
|
|
|
|
## See also
|
|
|
|
- [Upload Version Button component](upload-version-button.component.md)
|