mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
[ADF-1453] Restructure README.md files (#2239)
* ADF-1453: Restructured Activiti Analytics readme * ADF-1453: Restructured Activiti Diagrams readme * ADF-1453: Restructured Activiti Form readme * ADF-1453: Restructured Activiti Process List readme * ADF-1453: Restructured Activiti Task List readme * ADF-1453: Restructured Alfresco Core readme * [ADF-1453] Restructured DataTable readme * [ADF-1453] Restructured Document List readme * [ADF-1453] Restructured Login readme * [ADF-1453] Restructured Alfresco Search readme * [ADF-1453] Restructured Alfresco Social readme * [ADF-1453] Restructured Alfresco Tag readme * [ADF-1453] Restructured Alfresco User Info readme * [ADF-1453] Restructured Alfresco Viewer readme * [ADF-1453] Restructured Alfresco Webscript readme * [ADF-1453] Fixed table display glitch * [ADF-1453] Fixed Markdown lint errors in readme files * [ADF-1453] Adding missing fileUploadDelete event to table in Upload readme * [ADF-1453] Resolved merge conflict with Upload readme * [ADF-1453] Changes from npm run doc
This commit is contained in:
Andy Stark
Mario Romano
@@ -1,69 +1,46 @@
|
||||
# Alfresco Upload Component
|
||||
# Alfresco Upload library
|
||||
|
||||
Contains components for handling uploads to Content Services.
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Content](#content)
|
||||
* [Components](#components)
|
||||
* [Services](#services)
|
||||
* [Directives](#directives)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Install](#install)
|
||||
- [UploadButtonComponent](#uploadbuttoncomponent)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
* [Advanced usage](#advanced-usage)
|
||||
- [Upload Button Component](#upload-button-component)
|
||||
* [Basic Usage](#basic-usage)
|
||||
+ [Properties](#properties)
|
||||
+ [Events](#events)
|
||||
* [Details](#details)
|
||||
+ [How to show notification message with no permission](#how-to-show-notification-message-with-no-permission)
|
||||
+ [How to disable the button when the delete permission is missing](#how-to-disable-the-button-when-the-delete-permission-is-missing)
|
||||
- [UploadDragAreaComponent](#uploaddragareacomponent)
|
||||
* [Properties](#properties-1)
|
||||
* [Events](#events-1)
|
||||
- [FileUploadingDialogComponent](#fileuploadingdialogcomponent)
|
||||
* [Properties](#properties-2)
|
||||
- [UploadService](#uploadservice)
|
||||
* [Ignore list configuration](#ignore-list-configuration)
|
||||
* [Events](#events-2)
|
||||
- [Build from sources](#build-from-sources)
|
||||
- [NPM scripts](#npm-scripts)
|
||||
- [Demo](#demo)
|
||||
- [License](#license)
|
||||
- [Upload Drag Area Component](#upload-drag-area-component)
|
||||
* [Basic Usage](#basic-usage-1)
|
||||
+ [Properties](#properties-1)
|
||||
+ [Events](#events-1)
|
||||
- [File Uploading Dialog Component](#file-uploading-dialog-component)
|
||||
* [Basic Usage](#basic-usage-2)
|
||||
+ [Properties](#properties-2)
|
||||
* [Details](#details-1)
|
||||
- [Upload Service](#upload-service)
|
||||
* [Basic Usage](#basic-usage-3)
|
||||
+ [Events](#events-2)
|
||||
* [Details](#details-2)
|
||||
+ [Ignore list configuration](#ignore-list-configuration)
|
||||
- [Project Information](#project-information)
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [Install](#install)
|
||||
* [Build from sources](#build-from-sources)
|
||||
* [NPM scripts](#npm-scripts)
|
||||
* [Demo](#demo)
|
||||
* [License](#license)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## Content
|
||||
## Upload Button Component
|
||||
|
||||
### Components
|
||||
|
||||
- [FileUploadingDialogComponent](#fileuploadingdialogcomponent)
|
||||
- FileUploadingListComponent
|
||||
- [UploadButtonComponent](#uploadbuttoncomponent)
|
||||
- [UploadDragAreaComponent](#uploaddragareacomponent)
|
||||
|
||||
### Services
|
||||
|
||||
- [UploadService](#uploadservice)
|
||||
|
||||
### Directives
|
||||
|
||||
- FileDraggableDirective
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you start using this development framework, make sure you have installed all required software and done all the
|
||||
necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
|
||||
|
||||
> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install ng2-alfresco-upload
|
||||
```
|
||||
|
||||
## UploadButtonComponent
|
||||
### Basic Usage
|
||||
|
||||
```html
|
||||
<adf-upload-button
|
||||
@@ -77,7 +54,7 @@ npm install ng2-alfresco-upload
|
||||
<file-uploading-dialog></file-uploading-dialog>
|
||||
```
|
||||
|
||||
### Properties
|
||||
#### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
@@ -87,21 +64,20 @@ npm install ng2-alfresco-upload
|
||||
| multipleFiles | boolean | false | Allow/disallow multiple files |
|
||||
| acceptedFilesType | string | * | array of allowed file extensions , example: ".jpg,.gif,.png,.svg" |
|
||||
| **(deprecated)** currentFolderPath | string | '/Sites/swsdp/documentLibrary' | define the path where the files are uploaded. **Deprecated in 1.6.0: use rootFolderId instead.** |
|
||||
| **(deprecated)** rootFolderId | string | '-root-' | The ID of the root folder node.
|
||||
**Deprecated in 1.6.2: use parentId instead.** |
|
||||
| **(deprecated)** rootFolderId | string | '-root-' | The ID of the root folder node. **Deprecated in 1.6.2: use parentId instead.** |
|
||||
| parentId | string | empty | The ID of the root. It can be the nodeId if you are using the upload for the Content Service or taskId/processId for the Process Service. |
|
||||
| versioning | boolean | false | Versioning false is the default uploader behaviour and it renames the file using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created |
|
||||
| staticTitle | string | (predefined) | define the text of the upload button |
|
||||
| **(deprecated)** disableWithNoPermission ***use node permission directive from core instead*** | boolean | false | If the value is true and the user doesn't have the permission to delete the node the button will be disabled |
|
||||
| tooltip | string | | Custom tooltip |
|
||||
|
||||
### Events
|
||||
#### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| onSuccess | Raised when the file is uploaded |
|
||||
|
||||
### Advanced usage
|
||||
### Details
|
||||
|
||||
#### How to show notification message with no permission
|
||||
|
||||
@@ -144,9 +120,11 @@ The UploadButtonComponent provides the property disableWithNoPermission that can
|
||||
|
||||
|
||||
|
||||
## UploadDragAreaComponent
|
||||
## Upload Drag Area Component
|
||||
|
||||
This component provides a drag and drop area to upload files to Alfresco.
|
||||
Adds a drag and drop area to upload files to Alfresco.
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```html
|
||||
<adf-upload-drag-area (onSuccess)="customMethod($event)">
|
||||
@@ -167,7 +145,7 @@ export class AppComponent {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
#### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
@@ -178,32 +156,55 @@ export class AppComponent {
|
||||
| **(deprecated)** currentFolderPath | string | '/' | define the path where the files are uploaded. **Deprecated in 1.6.0: use rootFolderId instead.** |
|
||||
| versioning | boolean | false | Versioning false is the default uploader behaviour and it renames the file using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created |
|
||||
|
||||
### Events
|
||||
#### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| onSuccess | Raised when the file is uploaded |
|
||||
|
||||
## FileUploadingDialogComponent
|
||||
## File Uploading Dialog Component
|
||||
|
||||
This component provides a dialog that shows all the files uploaded with upload button or drag & drop area components.
|
||||
This component should be used in combination with upload button or drag & drop area.
|
||||
Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```html
|
||||
<file-uploading-dialog></file-uploading-dialog>
|
||||
```
|
||||
|
||||
### Properties
|
||||
#### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| position | string | 'right' | Dialog position. Accepted values are 'left' or 'right' |
|
||||
|
||||
## UploadService
|
||||
### Details
|
||||
|
||||
This component should be used in combination with upload button or drag & drop area.
|
||||
|
||||
## Upload Service
|
||||
|
||||
Provides access to various APIs related to file upload features.
|
||||
|
||||
### Ignore list configuration
|
||||
### Basic Usage
|
||||
|
||||
#### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| queueChanged | FileModel[] | Raised every time the file queue changes. |
|
||||
| fileUpload | FileUploadEvent | Raised every time a File model changes its state. |
|
||||
| fileUploadStarting | FileUploadEvent | Raised when upload starts. |
|
||||
| fileUploadCancelled | FileUploadEvent | Raised when upload gets cancelled by user. |
|
||||
| fileUploadProgress | FileUploadEvent | Raised during file upload process and contains the current progress for the particular File model. |
|
||||
| fileUploadAborted | FileUploadEvent | Raised when file upload gets aborted by the server. |
|
||||
| fileUploadError | FileUploadEvent | Raised when an error occurs to file upload. |
|
||||
| fileUploadComplete | FileUploadCompleteEvent | Raised when file upload is complete. |
|
||||
| fileUploadDelete | FileUploadDeleteEvent | Raised when uploaded file is removed from server. |
|
||||
|
||||
### Details
|
||||
|
||||
#### Ignore list configuration
|
||||
|
||||
Is possible add an ignore list for files that you don't want to allow upload on your CS.
|
||||
The configuration of this service is saved in the ***app.config.json file***.If you want more details about the configuration service follow this [link](https://github.com/Alfresco/alfresco-ng2-components/tree/master/ng2-components/ng2-alfresco-core#appconfigservice).
|
||||
@@ -228,21 +229,22 @@ Note:
|
||||
- Standard glob patterns work.
|
||||
- You can end patterns with a forward slash / to specify a directory.
|
||||
|
||||
### Events
|
||||
## Project Information
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| queueChanged | FileModel[] | Raised every time the file queue changes. |
|
||||
| fileUpload | FileUploadEvent | Raised every time a File model changes its state. |
|
||||
| fileUploadStarting | FileUploadEvent | Raised when upload starts. |
|
||||
| fileUploadCancelled | FileUploadEvent | Raised when upload gets cancelled by user. |
|
||||
| fileUploadProgress | FileUploadEvent | Raised during file upload process and contains the current progress for the particular File model. |
|
||||
| fileUploadAborted | FileUploadEvent | Raised when file upload gets aborted by the server. |
|
||||
| fileUploadError | FileUploadEvent | Raised when an error occurs to file upload. |
|
||||
| fileUploadComplete | FileUploadCompleteEvent | Raised when file upload is complete. |
|
||||
| fileUploadDelete | FileUploadDeleteEvent | Raised when uploaded file is removed from server. |
|
||||
### Prerequisites
|
||||
|
||||
## Build from sources
|
||||
Before you start using this development framework, make sure you have installed all required software and done all the
|
||||
necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
|
||||
|
||||
> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
|
||||
|
||||
### Install
|
||||
|
||||
```sh
|
||||
npm install ng2-alfresco-upload
|
||||
```
|
||||
|
||||
### Build from sources
|
||||
|
||||
You can build component from sources with the following commands:
|
||||
|
||||
@@ -254,7 +256,7 @@ npm run build
|
||||
> The `build` task rebuilds all the code, runs tslint, license checks
|
||||
> and other quality check tools before performing unit testing.
|
||||
|
||||
## NPM scripts
|
||||
### NPM scripts
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
@@ -263,7 +265,7 @@ npm run build
|
||||
| npm run test-browser | Run unit tests in the browser
|
||||
| npm run coverage | Run unit tests and display code coverage report |
|
||||
|
||||
## Demo
|
||||
### Demo
|
||||
|
||||
Please check the demo folder for a demo project
|
||||
|
||||
@@ -273,6 +275,6 @@ npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
## License
|
||||
### License
|
||||
|
||||
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user