diff --git a/ng2-components/ng2-alfresco-upload/README.md b/ng2-components/ng2-alfresco-upload/README.md index 5fbcea9dda..c9cf31e8dd 100644 --- a/ng2-components/ng2-alfresco-upload/README.md +++ b/ng2-components/ng2-alfresco-upload/README.md @@ -33,6 +33,50 @@ Components included: ### Upload button This component, provide a buttons to upload files to alfresco. +#### Dependencies + +Add the following dependency to your index.html: + +```html + +``` + +Make sure your systemjs.config has the following configuration: + +```javascript + System.config({ + defaultJSExtensions: true, + map: { + 'ng2-alfresco-core': 'node_modules/ng2-alfresco-core/dist', + 'ng2-alfresco-upload': 'node_modules/ng2-alfresco-upload/dist', + 'ng2-translate': 'node_modules/ng2-translate', + 'rxjs': 'node_modules/rxjs', + 'angular2' : 'node_modules/angular2', + 'app': 'dist/src' + }, + packages: { + 'app': { + defaultExtension: 'js' + }, + 'ng2-alfresco-core': { + defaultExtension: 'js' + }, + 'ng2-alfresco-upload': { + defaultExtension: 'js' + }, + 'ng2-translate': { + defaultExtension: 'js' + }, + 'rxjs': { + defaultExtension: 'js' + }, + 'angular2': { + defaultExtension: 'js' + } + } + }); +``` + #### Basic usage @@ -45,15 +89,18 @@ This component, provide a buttons to upload files to alfresco. ``` -Example of a component that declares upload component : - +Example of an App that declares upload button component : ```ts import { Component } from 'angular2/core'; +import { bootstrap } from 'angular2/platform/browser'; +import { HTTP_PROVIDERS } from 'angular2/http'; +import { AlfrescoTranslationService, AlfrescoTranslationLoader } from 'ng2-alfresco-core/services'; import { ALFRESCO_ULPOAD_COMPONENT } from 'ng2-alfresco-upload/ng2-alfresco-upload'; + @Component({ - selector: 'my-view', + selector: 'my-app', template: ``, directives: [ALFRESCO_ULPOAD_COMPONENT] }) -export class MyView { +export class MyDemoApp { + constructor() { + } } + +bootstrap(MyDemoApp, [ + HTTP_PROVIDERS, + AlfrescoTranslationService, + AlfrescoTranslationLoader +]); ``` #### Options @@ -78,10 +133,42 @@ export class MyView { This component, provide a drag and drop are to upload files to alfresco. #### Basic usage + ```html ``` +Example of an App that declares upload drag and drop component : + +```ts +import { Component } from 'angular2/core'; +import { bootstrap } from 'angular2/platform/browser'; +import { HTTP_PROVIDERS } from 'angular2/http'; +import { AlfrescoTranslationService, AlfrescoTranslationLoader } from 'ng2-alfresco-core/services'; +import { ALFRESCO_ULPOAD_COMPONENT } from 'ng2-alfresco-upload/ng2-alfresco-upload'; + + +@Component({ + selector: 'my-app', + template: ` +
+ DRAG HERE +
+
`, + directives: [ALFRESCO_ULPOAD_COMPONENT] +}) +export class MyDemoApp { + constructor() { + + } +} + +bootstrap(MyDemoApp, [ + HTTP_PROVIDERS, + AlfrescoTranslationService, + AlfrescoTranslationLoader +]); +``` #### Options **showDialogUpload**: {boolean} optional) default true. Hide/show upload dialog.
@@ -100,3 +187,13 @@ before performing unit testing. ```sh npm run coverage ``` + +## Demo + +If you want have a demo of how the component works, please check the demo folder : + +```sh +cd demo +npm install +npm start +```