diff --git a/ng2-components/ng2-alfresco-upload/README.md b/ng2-components/ng2-alfresco-upload/README.md index 7941b66513a..f0c688a215b 100644 --- a/ng2-components/ng2-alfresco-upload/README.md +++ b/ng2-components/ng2-alfresco-upload/README.md @@ -1,4 +1,4 @@ -# Alfresco Upload Component for Angular 2 +# Alfresco Upload Component for Angular

@@ -163,22 +163,24 @@ platformBrowserDynamic().bootstrapModule(AppModule); ``` #### Events -Attribute | Description ---- | --- -`onSuccess` | The event is emitted when the file is uploaded - -#### Options - -Attribute | Options | Default | Description | Mandatory ---- | --- | --- | --- | --- -`showNotificationBar` | *boolean* | true | Hide/show notification bar | -`uploadFolders` | *boolean* | false | Allow/disallow upload folders (only for chrome) | -`multipleFiles` | *boolean* | false | Allow/disallow multiple files | -`acceptedFilesType` | *string* | * | array of allowed file extensions , example: ".jpg,.gif,.png,.svg" | -`currentFolderPath` | *string* | '/Sites/swsdp/documentLibrary' | define the path where the files are uploaded | -`versioning` | *boolean* | false | Versioning false is the default uploader behaviour and it rename using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created | -`staticTitle` | *string* | 'FILE_UPLOAD.BUTTON.UPLOAD_FILE' or 'FILE_UPLOAD.BUTTON.UPLOAD_FOLDER' string in the JSON text file | define the text of the upload button| -`disableWithNoPermission` | *boolean* | false | If the value is true and the user doesn't have the permission to delete the node the button will be disabled | + +| Name | Description | +| --- | --- | +| `onSuccess` | The event is emitted when the file is uploaded | + +#### Properties + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `disabled` | *boolean* | false | Toggle component disabled state | +| `showNotificationBar` | *boolean* | true | Hide/show notification bar | +| `uploadFolders` | *boolean* | false | Allow/disallow upload folders (only for chrome) | +| `multipleFiles` | *boolean* | false | Allow/disallow multiple files | +| `acceptedFilesType` | *string* | * | array of allowed file extensions , example: ".jpg,.gif,.png,.svg" | +| `currentFolderPath` | *string* | '/Sites/swsdp/documentLibrary' | define the path where the files are uploaded | +| `versioning` | *boolean* | false | Versioning false is the default uploader behaviour and it rename using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created | +| `staticTitle` | *string* | 'FILE_UPLOAD.BUTTON.UPLOAD_FILE' or 'FILE_UPLOAD.BUTTON.UPLOAD_FOLDER' string in the JSON text file | define the text of the upload button | +| `disableWithNoPermission` | *boolean* | false | If the value is true and the user doesn't have the permission to delete the node the button will be disabled | ### How to show notification message with no permission You can show a notification error when the user doesn't have the right permission to perform the action. @@ -280,23 +282,24 @@ platformBrowserDynamic().bootstrapModule(AppModule); ``` #### Events -Attribute | Description ---- | --- -`onSuccess` | The event is emitted when the file is uploaded -#### Options +| Name | Description | +| --- | --- | +| `onSuccess` | The event is emitted when the file is uploaded | + +#### Propertoes -Attribute | Options | Default | Description | Mandatory ---- | --- | --- | --- | --- -`showNotificationBar` | *boolean* | true | Hide/show notification bar | -`currentFolderPath` | *string* | '/Sites/swsdp/documentLibrary' | define the path where the files are uploaded | -`versioning` | *boolean* | false | Versioning false is the default uploader behaviour and it rename using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created | +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `showNotificationBar` | *boolean* | true | Hide/show notification bar | +| `currentFolderPath` | *string* | '/Sites/swsdp/documentLibrary' | define the path where the files are uploaded | +| `versioning` | *boolean* | false | Versioning false is the default uploader behaviour and it rename using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created | ### Files Dialog -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. + +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. #### Basic usage @@ -308,7 +311,6 @@ with upload button or drag & drop area components. This component should Alternatively you can build component from sources with the following commands: - ```sh npm install npm run build @@ -363,4 +365,4 @@ npm start ## License -[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE) \ No newline at end of file +[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)