mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2026-09-16 18:13:06 +00:00
Compare commits
2
Commits
2.2.0-beta2
..
2.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
 Eugenio Romano
|
d09b893a9d | ||
 Eugenio Romano
|
43032c7fd7 |
@@ -20,4 +20,3 @@ src/environments/
|
||||
package-lock.*
|
||||
/ng2-components/ng2-alfresco-core/prebuilt-themes/
|
||||
.ng_pkg_build/
|
||||
/demo-shell/dist-dev-temp/
|
||||
|
||||
@@ -58,10 +58,6 @@ script:
|
||||
(./scripts/start.sh -dev -t -ss -vjsapi alpha || exit 1;);
|
||||
fi
|
||||
fi
|
||||
jobs:
|
||||
include:
|
||||
- stage: Check 2.0.0 Project Update
|
||||
script: ./scripts/test-e2e-bc.sh
|
||||
|
||||
# jobs:
|
||||
# include:
|
||||
|
||||
+5
-7
@@ -9,10 +9,10 @@ environment:
|
||||
nodejs_version: "8"
|
||||
|
||||
matrix:
|
||||
- COMPONENT_NAME: process-service
|
||||
- COMPONENT_NAME: content-service
|
||||
- COMPONENT_NAME: core
|
||||
- COMPONENT_NAME: insights
|
||||
- COMPONENT_NAME: core
|
||||
- COMPONENT_NAME: process-service
|
||||
- COMPONENT_NAME: content-service
|
||||
- COMPONENT_NAME: insights
|
||||
# - COMPONENT_NAME: ng2-demo-shell
|
||||
|
||||
# Install scripts. (runs after repo cloning)
|
||||
@@ -38,7 +38,7 @@ install:
|
||||
else
|
||||
(cd scripts && sh npm-build-all.sh -t "insights" -vjsapi alpha|| exit 1)
|
||||
)
|
||||
- if %COMPONENT_NAME% EQU core (
|
||||
- if %COMPONENT_NAME% EQU core (
|
||||
if %APPVEYOR_REPO_BRANCH EQU master
|
||||
(cd scripts && sh npm-build-all.sh -t "core" || exit 1)
|
||||
else
|
||||
@@ -53,5 +53,3 @@ install:
|
||||
|
||||
# Don't actually build.
|
||||
build: off
|
||||
matrix:
|
||||
fast_finish: true
|
||||
|
||||
@@ -18,11 +18,6 @@
|
||||
"input": "../resources",
|
||||
"output": "./resources"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "./app/components/lazy-loading/i18n",
|
||||
"output": "./resources/lazy-loading/i18n"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../node_modules/@alfresco/adf-core/prebuilt-themes",
|
||||
@@ -97,13 +92,43 @@
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "./app/components/lazy-loading/i18n",
|
||||
"output": "./resources/lazy-loading/i18n"
|
||||
"input": "../../lib/core/prebuilt-themes",
|
||||
"output": "./assets/prebuilt-themes"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../dist-dev-temp/",
|
||||
"output": "./"
|
||||
"input": "../../lib/core/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../../lib/process-services/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../../lib/content-services/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../../lib/core/i18n",
|
||||
"output": "./assets/adf-core/i18n"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../../lib/process-services/i18n",
|
||||
"output": "./assets/adf-process-services/i18n"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../../lib/content-services/i18n",
|
||||
"output": "./assets/adf-content-services/i18n"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../../lib/insights/i18n",
|
||||
"output": "./assets/adf-insights/i18n"
|
||||
},
|
||||
{
|
||||
"glob": "pdf.worker.js",
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
const cpx = require('cpx');
|
||||
|
||||
//Workaround for https://github.com/angular/angular-cli/issues/8783
|
||||
//we copy before the files in dist-dev-temp in the demo shell and after we let the angular cli watch over them..double wathh necessary for dev mode
|
||||
|
||||
cpx.watch('../lib/core/prebuilt-themes/**/*.*', './dist-dev-temp/assets/prebuilt-themes')
|
||||
cpx.watch('../lib/core/assets/**/*.*', './dist-dev-temp/assets/' )
|
||||
cpx.watch('../lib/process-services/assets/**/*.*', './dist-dev-temp/assets/' )
|
||||
cpx.watch('../lib/content-services/assets/**/*.*', './dist-dev-temp/assets/' )
|
||||
|
||||
cpx.watch('../lib/core/i18n/**/*.*', './dist-dev-temp//assets/adf-core/i18n' )
|
||||
cpx.watch('../lib/process-services/i18n/**/*.*', './dist-dev-temp/assets/adf-process-services/i18n' )
|
||||
cpx.watch('../lib/content-services/i18n/**/*.*', './dist-dev-temp/assets/adf-content-services/i18n' )
|
||||
cpx.watch('../lib/insights/i18n/**/*.*', './dist-dev-temp//assets/adf-insights/i18n' )
|
||||
+17
-22
@@ -5,19 +5,16 @@
|
||||
"author": "Alfresco Software, Ltd.",
|
||||
"scripts": {
|
||||
"ng": "ng",
|
||||
"prestart": "npm run validate-config",
|
||||
"start": "npm run server-versions && rimraf dist && ng serve --host 0.0.0.0 --app dist --open --aot=false",
|
||||
"start:dev": " npm run lint && npm run server-versions && rimraf dist && npm run clean-lib-angular && concurrently \"ng serve --host 0.0.0.0 --disable-host-check --app dev pp-dev --proxy-config proxy.conf.js --open\" \"npm run style:dev --watch\" \"npm run copy:dev\" ",
|
||||
"start:dev": "npm run lint && npm run server-versions && rimraf dist && npm run clean-lib-angular && concurrently \"ng serve --host 0.0.0.0 --disable-host-check --app dev pp-dev --proxy-config proxy.conf.js --open\" \"npm run style:dev -- --watch\" ",
|
||||
"start:dist": "npm run server-versions && rimraf dist && node --max_old_space_size=30000 node_modules/.bin/ng serve --prod --build-optimizer=false --aot=false --host 0.0.0.0 --disable-host-check --app dist",
|
||||
"build": "npm run validate-config && npm run server-versions && rimraf dist && ng build --app dist",
|
||||
"build:dev": "npm run validate-config && npm run lint && npm run style:dev && npm run server-versions && rimraf dist && ng build --app dev",
|
||||
"build:dist": "npm run validate-config && npm run style:dev && npm run server-versions && rimraf dist && node --max_old_space_size=30000 node_modules/.bin/ng build --prod --build-optimizer=false --aot=false --app dist",
|
||||
"build": "npm run server-versions && rimraf dist && ng build --app dist",
|
||||
"build:dev": "npm run lint && npm run style:dev && npm run server-versions && rimraf dist && ng build --app dev",
|
||||
"build:dist": "npm run style:dev && npm run server-versions && rimraf dist && node --max_old_space_size=30000 node_modules/.bin/ng build --prod --build-optimizer=false --aot=false --app dist",
|
||||
"style:dev": "npm run webpack -- --config config/webpack.style.js --progress --profile --bail",
|
||||
"copy:dev": "node ./config/dev-copy-watch.js",
|
||||
"test": "ng test",
|
||||
"lint": "ng lint",
|
||||
"e2e": "ng e2e",
|
||||
"validate-config": "ajv validate -s ../lib/core/app-config/schema.json -d ./src/app.config.json --errors=text --verbose",
|
||||
"server-versions": "rimraf ./src/versions.json && npm list --depth=0 --json=true --prod=true > ./src/versions.json || exit 0",
|
||||
"clean": "npm run clean-build && rimraf dist node_modules typings dist",
|
||||
"clean-lib-angular": "rimraf ../lib/node_modules/@angular",
|
||||
@@ -93,7 +90,7 @@
|
||||
"moment": "2.18.1",
|
||||
"moment-es6": "^1.0.0",
|
||||
"ng2-charts": "1.6.0",
|
||||
"pdfjs-dist": "2.0.265",
|
||||
"pdfjs-dist": "1.5.404",
|
||||
"raphael": "2.2.7",
|
||||
"reflect-metadata": "0.1.10",
|
||||
"rxjs": "5.5.2",
|
||||
@@ -102,28 +99,26 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@angular-devkit/core": "0.0.28",
|
||||
"@angular/cli": "1.6.5",
|
||||
"@angular/compiler-cli": "^5.2.0",
|
||||
"@angular/language-service": "^5.2.0",
|
||||
"@types/jasmine": "~2.8.3",
|
||||
"@angular/cli": "1.5.0",
|
||||
"@angular/compiler-cli": "5.1.1",
|
||||
"@angular/language-service": "5.1.1",
|
||||
"@types/jasmine": "~2.5.53",
|
||||
"@types/jasminewd2": "~2.0.2",
|
||||
"@types/node": "~6.0.60",
|
||||
"ajv-cli": "^3.0.0",
|
||||
"codelyzer": "4.1.0",
|
||||
"codelyzer": "4.0.0",
|
||||
"concurrently": "^3.5.1",
|
||||
"cpx": "^1.5.0",
|
||||
"jasmine-core": "~2.8.0",
|
||||
"jasmine-spec-reporter": "~4.2.1",
|
||||
"karma": "~2.0.0",
|
||||
"karma-chrome-launcher": "~2.2.0",
|
||||
"jasmine-core": "~2.6.2",
|
||||
"jasmine-spec-reporter": "~4.1.0",
|
||||
"karma": "~1.7.0",
|
||||
"karma-chrome-launcher": "~2.1.1",
|
||||
"karma-cli": "~1.0.1",
|
||||
"karma-coverage-istanbul-reporter": "^1.2.1",
|
||||
"karma-jasmine": "~1.1.0",
|
||||
"karma-jasmine-html-reporter": "^0.2.2",
|
||||
"protractor": "~5.1.2",
|
||||
"rimraf": "^2.6.2",
|
||||
"ts-node": "~4.1.0",
|
||||
"tslint": "~5.9.1",
|
||||
"typescript": "~2.5.3"
|
||||
"ts-node": "~3.2.0",
|
||||
"tslint": "^5.7.0",
|
||||
"typescript": "2.6.2"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -17,7 +17,6 @@
|
||||
"LOGIN": "Login",
|
||||
"CUSTOM_SOURCES": "Custom Sources",
|
||||
"DATATABLE": "Datatable",
|
||||
"DATATABLE_LAZY": "Datatable (Lazy)",
|
||||
"FORM": "Form",
|
||||
"FORM_LIST": "Form List",
|
||||
"UPLOADER": "Uploader",
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
{
|
||||
"$schema": "../../lib/core/app-config/schema.json",
|
||||
"ecmHost": "http://{hostname}:{port}",
|
||||
"bpmHost": "http://{hostname}:{port}",
|
||||
"application": {
|
||||
|
||||
@@ -4,7 +4,7 @@ import { FormsModule } from '@angular/forms';
|
||||
import { FlexLayoutModule } from '@angular/flex-layout';
|
||||
import { ChartsModule } from 'ng2-charts';
|
||||
import { HttpClientModule } from '@angular/common/http';
|
||||
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
|
||||
import { TranslateService } from '@ngx-translate/core';
|
||||
|
||||
import { AppConfigService, TRANSLATION_PROVIDER } from '@alfresco/adf-core';
|
||||
import { AppComponent } from './app.component';
|
||||
@@ -40,6 +40,7 @@ import { ThemePickerModule } from './components/theme-picker/theme-picker';
|
||||
import { DebugAppConfigService } from './services/debug-app-config.service';
|
||||
|
||||
import { routing } from './app.routes';
|
||||
import { TranslateModule } from '@ngx-translate/core';
|
||||
import { ReactiveFormsModule } from '@angular/forms';
|
||||
import { TaskAttachmentsComponent } from './components/process-service/task-attachments.component';
|
||||
import { ProcessAttachmentsComponent } from './components/process-service/process-attachments.component';
|
||||
@@ -48,8 +49,8 @@ import { SharedLinkViewComponent } from './components/shared-link-view/shared-li
|
||||
|
||||
@NgModule({
|
||||
imports: [
|
||||
BrowserAnimationsModule,
|
||||
ReactiveFormsModule,
|
||||
TranslateModule,
|
||||
BrowserModule,
|
||||
routing,
|
||||
FormsModule,
|
||||
@@ -91,6 +92,7 @@ import { SharedLinkViewComponent } from './components/shared-link-view/shared-li
|
||||
SharedLinkViewComponent
|
||||
],
|
||||
providers: [
|
||||
TranslateService,
|
||||
{ provide: AppConfigService, useClass: DebugAppConfigService },
|
||||
{
|
||||
provide: TRANSLATION_PROVIDER,
|
||||
@@ -99,14 +101,6 @@ import { SharedLinkViewComponent } from './components/shared-link-view/shared-li
|
||||
name: 'app',
|
||||
source: 'resources'
|
||||
}
|
||||
},
|
||||
{
|
||||
provide: TRANSLATION_PROVIDER,
|
||||
multi: true,
|
||||
useValue: {
|
||||
name: 'lazy-loading',
|
||||
source: 'resources/lazy-loading'
|
||||
}
|
||||
}
|
||||
],
|
||||
entryComponents: [
|
||||
|
||||
@@ -166,10 +166,6 @@ export const appRoutes: Routes = [
|
||||
path: 'overlay-viewer',
|
||||
component: OverlayViewerComponent,
|
||||
canActivate: [AuthGuardEcm]
|
||||
},
|
||||
{
|
||||
path: 'datatable-lazy',
|
||||
loadChildren: 'app/components/lazy-loading/lazy-loading.module#LazyLoadingModule'
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -34,7 +34,6 @@ export class AppLayoutComponent {
|
||||
{ href: '/login', icon: 'vpn_key', title: 'APP_LAYOUT.LOGIN' },
|
||||
{ href: '/dl-custom-sources', icon: 'extension', title: 'APP_LAYOUT.CUSTOM_SOURCES' },
|
||||
{ href: '/datatable', icon: 'view_module', title: 'APP_LAYOUT.DATATABLE' },
|
||||
{ href: '/datatable-lazy', icon: 'view_module', title: 'APP_LAYOUT.DATATABLE_LAZY' },
|
||||
{ href: '/form', icon: 'poll', title: 'APP_LAYOUT.FORM' },
|
||||
{ href: '/form-list', icon: 'library_books', title: 'APP_LAYOUT.FORM_LIST' },
|
||||
{ href: '/uploader', icon: 'file_upload', title: 'APP_LAYOUT.UPLOADER' },
|
||||
|
||||
@@ -195,10 +195,11 @@
|
||||
</data-columns>
|
||||
|
||||
<content-actions>
|
||||
<!-- common actions -->
|
||||
<!-- folder actions -->
|
||||
<content-action
|
||||
icon="content_copy"
|
||||
title="DOCUMENT_LIST.ACTIONS.FOLDER.COPY"
|
||||
target="folder"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.FOLDER.COPY' | translate}}"
|
||||
permission="update"
|
||||
[disableWithNoPermission]="true"
|
||||
(error)="onContentActionError($event)"
|
||||
@@ -207,7 +208,8 @@
|
||||
</content-action>
|
||||
<content-action
|
||||
icon="redo"
|
||||
title="DOCUMENT_LIST.ACTIONS.FOLDER.MOVE"
|
||||
target="folder"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.FOLDER.MOVE' | translate}}"
|
||||
permission="update"
|
||||
[disableWithNoPermission]="true"
|
||||
(error)="onContentActionError($event)"
|
||||
@@ -216,14 +218,35 @@
|
||||
</content-action>
|
||||
<content-action
|
||||
icon="delete"
|
||||
target="folder"
|
||||
permission="delete"
|
||||
[disableWithNoPermission]="true"
|
||||
title="DOCUMENT_LIST.ACTIONS.FOLDER.DELETE"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.FOLDER.DELETE' | translate}}"
|
||||
(permissionEvent)="handlePermissionError($event)"
|
||||
(success)="onDeleteActionSuccess($event)"
|
||||
handler="delete">
|
||||
</content-action>
|
||||
<!-- document actions -->
|
||||
<content-action
|
||||
icon="content_copy"
|
||||
target="document"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.DOCUMENT.COPY' | translate}}"
|
||||
permission="update"
|
||||
[disableWithNoPermission]="true"
|
||||
(error)="onContentActionError($event)"
|
||||
(success)="onContentActionSuccess($event)"
|
||||
handler="copy">
|
||||
</content-action>
|
||||
<content-action
|
||||
icon="redo"
|
||||
target="document"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.DOCUMENT.MOVE' | translate}}"
|
||||
permission="update"
|
||||
[disableWithNoPermission]="true"
|
||||
(error)="onContentActionError($event)"
|
||||
(success)="onContentActionSuccess($event)"
|
||||
handler="move">
|
||||
</content-action>
|
||||
<content-action
|
||||
icon="storage"
|
||||
target="document"
|
||||
@@ -233,14 +256,24 @@
|
||||
<content-action
|
||||
icon="file_download"
|
||||
target="document"
|
||||
title="DOCUMENT_LIST.ACTIONS.DOCUMENT.DOWNLOAD"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.DOCUMENT.DOWNLOAD' | translate}}"
|
||||
handler="download">
|
||||
</content-action>
|
||||
<content-action
|
||||
icon="delete"
|
||||
target="document"
|
||||
permission="delete"
|
||||
[disableWithNoPermission]="true"
|
||||
(permissionEvent)="handlePermissionError($event)"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.DOCUMENT.DELETE' | translate}}"
|
||||
(success)="onDeleteActionSuccess($event)"
|
||||
handler="delete">
|
||||
</content-action>
|
||||
<content-action
|
||||
*ngIf="authenticationService.isBpmLoggedIn()"
|
||||
icon="play_arrow"
|
||||
target="document"
|
||||
title="DOCUMENT_LIST.ACTIONS.DOCUMENT.PROCESS_ACTION"
|
||||
title="{{'DOCUMENT_LIST.ACTIONS.DOCUMENT.PROCESS_ACTION' | translate}}"
|
||||
(execute)="startProcesAction($event)">
|
||||
</content-action>
|
||||
</content-actions>
|
||||
|
||||
@@ -34,7 +34,7 @@ import { DocumentListComponent, PermissionStyleModel, DownloadZipDialogComponent
|
||||
import { SelectAppsDialogComponent } from '@alfresco/adf-process-services';
|
||||
|
||||
import { VersionManagerDialogAdapterComponent } from './version-manager-dialog-adapter.component';
|
||||
import { Subscription } from 'rxjs/Subscription';
|
||||
import { Subscription } from 'rxjs/Rx';
|
||||
|
||||
const DEFAULT_FOLDER_TO_SHOW = '-my-';
|
||||
|
||||
@@ -272,7 +272,7 @@ export class FilesComponent implements OnInit, OnChanges, OnDestroy {
|
||||
message,
|
||||
4000
|
||||
);
|
||||
});
|
||||
})
|
||||
}
|
||||
|
||||
handleUploadError(event: any) {
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"LAZY": {
|
||||
"TEXT": "Text from lazy component resources"
|
||||
}
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
import { Component } from '@angular/core';
|
||||
import { ObjectDataTableAdapter, AuthenticationService } from '@alfresco/adf-core';
|
||||
|
||||
@Component({
|
||||
selector: 'app-lazy-component',
|
||||
template: `
|
||||
<adf-datatable [data]="data"></adf-datatable>
|
||||
|
||||
<ul>
|
||||
<li>Global i18n: {{ 'APP_LAYOUT.DATATABLE_LAZY' | translate }}</li>
|
||||
<li>Local i18n (work in progress): {{ 'LAZY.TEXT' | translate }}</li>
|
||||
<li>isLoggedIn: {{ isLoggedIn }}</li>
|
||||
<li>ECM username: {{ username }}
|
||||
</ul>
|
||||
`
|
||||
})
|
||||
export class LazyLoadingComponent {
|
||||
|
||||
data: ObjectDataTableAdapter;
|
||||
|
||||
get isLoggedIn(): boolean {
|
||||
return this.auth.isLoggedIn();
|
||||
}
|
||||
|
||||
get username(): string {
|
||||
return this.auth.getEcmUsername();
|
||||
}
|
||||
|
||||
constructor(private auth: AuthenticationService) {
|
||||
this.data = new ObjectDataTableAdapter(
|
||||
// data
|
||||
[
|
||||
{id: 1, name: 'Name 1'},
|
||||
{id: 2, name: 'Name 2'}
|
||||
],
|
||||
// schema
|
||||
[
|
||||
{
|
||||
type: 'text',
|
||||
key: 'id',
|
||||
title: 'Id',
|
||||
sortable: true
|
||||
},
|
||||
{
|
||||
type: 'text',
|
||||
key: 'name',
|
||||
title: 'Name',
|
||||
cssClass: 'full-width',
|
||||
sortable: true
|
||||
}
|
||||
]
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { CoreModule, TranslationService } from '@alfresco/adf-core';
|
||||
|
||||
import { LazyLoadingRoutes } from './lazy-loading.routes';
|
||||
import { LazyLoadingComponent } from './lazy-loading.component';
|
||||
|
||||
@NgModule({
|
||||
imports: [
|
||||
CoreModule.forChild(),
|
||||
LazyLoadingRoutes
|
||||
],
|
||||
declarations: [
|
||||
LazyLoadingComponent
|
||||
]
|
||||
})
|
||||
export class LazyLoadingModule {
|
||||
constructor(translation: TranslationService) {
|
||||
}
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { LazyLoadingComponent } from './lazy-loading.component';
|
||||
|
||||
export const routes: Routes = [
|
||||
{
|
||||
path: '',
|
||||
component: LazyLoadingComponent
|
||||
}
|
||||
];
|
||||
|
||||
@NgModule({
|
||||
imports: [
|
||||
RouterModule.forChild(routes)
|
||||
],
|
||||
exports: [
|
||||
RouterModule
|
||||
]
|
||||
})
|
||||
export class LazyLoadingRoutes {
|
||||
}
|
||||
@@ -17,7 +17,7 @@
|
||||
|
||||
import { Component, OnDestroy, OnInit } from '@angular/core';
|
||||
import { ActivatedRoute } from '@angular/router';
|
||||
import { Subscription } from 'rxjs/Subscription';
|
||||
import { Subscription } from 'rxjs/Rx';
|
||||
|
||||
@Component({
|
||||
selector: 'app-form-node-viewer',
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
|
||||
import { Component, OnDestroy, OnInit } from '@angular/core';
|
||||
import { ActivatedRoute } from '@angular/router';
|
||||
import { Subscription } from 'rxjs/Subscription';
|
||||
import { Subscription } from 'rxjs/Rx';
|
||||
|
||||
@Component({
|
||||
selector: 'app-form-viewer',
|
||||
|
||||
@@ -133,14 +133,11 @@
|
||||
<div class="adf-grid-item adf-processes-list adf-list" fxFlex.gt-md="335px" [ngClass.gt-md]="{'small-pagination': true}"
|
||||
*ngIf="processFilter && !isStartProcessMode()">
|
||||
<adf-process-instance-list
|
||||
#processList
|
||||
*ngIf="processFilter?.filter" [appId]="processFilter?.appId"
|
||||
[processDefinitionKey]="processFilter?.filter?.processDefinitionKey"
|
||||
[name]="processFilter?.filter?.name"
|
||||
[presetColumn]="presetColoum"
|
||||
[state]="processFilter?.filter?.state"
|
||||
[page]="processPage"
|
||||
[size]="paginationPageSize"
|
||||
[sort]="processFilter?.filter?.sort"
|
||||
[data]="dataProcesses"
|
||||
(rowClick)="onProcessRowClick($event)"
|
||||
@@ -154,16 +151,6 @@
|
||||
</data-columns> -->
|
||||
|
||||
</adf-process-instance-list>
|
||||
<adf-pagination
|
||||
*ngIf="processList"
|
||||
[target]="processList"
|
||||
[supportedPageSizes]="supportedPages"
|
||||
(changePageNumber)="onChangePageNumberProcess($event)"
|
||||
(changePageSize)="onChangePageSizeProcess($event)"
|
||||
(nextPage)="onNextPageProcess($event)"
|
||||
(prevPage)="onPrevPageProcess($event)"
|
||||
#processListPagination>
|
||||
</adf-pagination>
|
||||
</div>
|
||||
<div class="adf-grid-item adf-processes-details" *ngIf="!isStartProcessMode()" fxFlex.gt-md="1 1 auto">
|
||||
<adf-process-instance-details
|
||||
|
||||
@@ -30,7 +30,7 @@ import { ActivatedRoute, Router } from '@angular/router';
|
||||
import { Pagination, ProcessInstanceFilterRepresentation } from 'alfresco-js-api';
|
||||
import {
|
||||
FORM_FIELD_VALIDATORS, FormEvent, FormFieldEvent, FormRenderingService, FormService,
|
||||
DynamicTableRow, ValidateDynamicTableRowEvent, AppConfigService, PaginationComponent
|
||||
DynamicTableRow, ValidateDynamicTableRowEvent, AppConfigService
|
||||
} from '@alfresco/adf-core';
|
||||
|
||||
import { AnalyticsReportListComponent } from '@alfresco/adf-insights';
|
||||
@@ -58,7 +58,7 @@ import {
|
||||
ObjectDataRow,
|
||||
ObjectDataTableAdapter
|
||||
} from '@alfresco/adf-core';
|
||||
import { Subscription } from 'rxjs/Subscription';
|
||||
import { Subscription } from 'rxjs/Rx';
|
||||
import { /*CustomEditorComponent*/ CustomStencil01 } from './custom-editor/custom-editor.component';
|
||||
import { DemoFieldValidator } from './demo-field-validator';
|
||||
|
||||
@@ -76,9 +76,6 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
@ViewChild(TaskFiltersComponent)
|
||||
activitifilter: TaskFiltersComponent;
|
||||
|
||||
@ViewChild(PaginationComponent)
|
||||
processListPagination: PaginationComponent;
|
||||
|
||||
@ViewChild(TaskListComponent)
|
||||
taskList: TaskListComponent;
|
||||
|
||||
@@ -122,8 +119,6 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
totalItems: 0
|
||||
};
|
||||
taskPage = 0;
|
||||
processPage = 0;
|
||||
paginationPageSize = 0;
|
||||
processSchemaColumns: any[] = [];
|
||||
|
||||
supportedPages: number[];
|
||||
@@ -164,7 +159,6 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
this.dataTasks.setSorting(new DataSorting('created', 'desc'));
|
||||
this.supportedPages = this.preferenceService.getDifferentPageSizes();
|
||||
this.taskPagination.maxItems = this.preferenceService.paginationSize;
|
||||
this.paginationPageSize = this.preferenceService.paginationSize;
|
||||
|
||||
this.defaultProcessName = this.appConfig.get<string>('adf-start-process.name');
|
||||
this.defaultProcessDefinitionName = this.appConfig.get<string>('adf-start-process.processDefinitionName');
|
||||
@@ -208,26 +202,11 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
this.taskPage--;
|
||||
}
|
||||
|
||||
onPrevPageProcess(pagination: Pagination): void {
|
||||
this.processPage = this.processListPagination.current - 1;
|
||||
}
|
||||
|
||||
onNextPage(pagination: Pagination): void {
|
||||
this.taskPagination.skipCount = pagination.skipCount;
|
||||
this.taskPage++;
|
||||
}
|
||||
|
||||
onNextPageProcess(pagination: Pagination): void {
|
||||
this.processPage = this.processListPagination.current - 1;
|
||||
}
|
||||
|
||||
onChangePageSizeProcess(pagination: Pagination): void {
|
||||
const { maxItems } = pagination;
|
||||
this.preferenceService.paginationSize = maxItems;
|
||||
this.processPage = this.processListPagination.current - 1;
|
||||
this.paginationPageSize = maxItems;
|
||||
}
|
||||
|
||||
onChangePageSize(pagination: Pagination): void {
|
||||
const { skipCount, maxItems } = pagination;
|
||||
this.taskPage = this.currentPage(skipCount, maxItems);
|
||||
@@ -243,10 +222,6 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
this.taskPagination.skipCount = skipCount;
|
||||
}
|
||||
|
||||
onChangePageNumberProcess(pagination: Pagination): void {
|
||||
this.processPage = this.processListPagination.current - 1;
|
||||
}
|
||||
|
||||
currentPage(skipCount: number, maxItems: number): number {
|
||||
return (skipCount && maxItems) ? Math.floor(skipCount / maxItems) : 0;
|
||||
}
|
||||
@@ -294,12 +269,6 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
|
||||
onTaskFilterClick(filter: FilterRepresentationModel): void {
|
||||
this.applyTaskFilter(filter);
|
||||
this.resetTaskPaginationPage();
|
||||
}
|
||||
|
||||
resetTaskPaginationPage() {
|
||||
this.taskPage = 0;
|
||||
this.taskPagination.skipCount = 0;
|
||||
}
|
||||
|
||||
onReportClick(event: any): void {
|
||||
@@ -333,11 +302,6 @@ export class ProcessServiceComponent implements AfterViewInit, OnDestroy, OnInit
|
||||
|
||||
onProcessFilterClick(event: ProcessInstanceFilterRepresentation): void {
|
||||
this.processFilter = event;
|
||||
this.resetProcessPaginationPage();
|
||||
}
|
||||
|
||||
resetProcessPaginationPage() {
|
||||
this.processPage = 0;
|
||||
}
|
||||
|
||||
onSuccessProcessFilterList(event: ProcessInstanceFilterRepresentation[]): void {
|
||||
|
||||
@@ -28,6 +28,6 @@ export class SettingsComponent {
|
||||
}
|
||||
|
||||
onError(error: string) {
|
||||
this.logService.log(error);
|
||||
this.logService.log(error)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,7 +7,7 @@ import 'hammerjs';
|
||||
import 'chart.js';
|
||||
import 'ng2-charts';
|
||||
|
||||
import * as pdfjsLib from 'pdfjs-dist';
|
||||
import pdfjsLib from 'pdfjs-dist';
|
||||
pdfjsLib.PDFJS.workerSrc = 'pdf.worker.js';
|
||||
|
||||
if (environment.production) {
|
||||
|
||||
@@ -65,6 +65,5 @@ import 'intl'; // Run `npm install --save intl`.
|
||||
* Support custom event in IE11
|
||||
*
|
||||
* */
|
||||
|
||||
import 'custom-event-polyfill/custom-event-polyfill'; // Run `npm install --save custom-event-polyfill`.
|
||||
import 'custom-event-polyfill/custom-event-polyfill' // Run `npm install --save custom-event-polyfill`.
|
||||
|
||||
|
||||
+8
-17
@@ -3,7 +3,6 @@
|
||||
"node_modules/codelyzer"
|
||||
],
|
||||
"rules": {
|
||||
"arrow-return-shorthand": true,
|
||||
"callable-types": true,
|
||||
"class-name": true,
|
||||
"comment-format": [
|
||||
@@ -13,11 +12,7 @@
|
||||
"curly": true,
|
||||
"eofline": true,
|
||||
"forin": true,
|
||||
"import-blacklist": [
|
||||
true,
|
||||
"rxjs",
|
||||
"rxjs/Rx"
|
||||
],
|
||||
"import-blacklist": [true, "rxjs"],
|
||||
"import-spacing": true,
|
||||
"indent": [
|
||||
true,
|
||||
@@ -32,14 +27,8 @@
|
||||
"member-access": false,
|
||||
"member-ordering": [
|
||||
true,
|
||||
{
|
||||
"order": [
|
||||
"static-field",
|
||||
"instance-field",
|
||||
"static-method",
|
||||
"instance-method"
|
||||
]
|
||||
}
|
||||
"static-before-instance",
|
||||
"variables-before-functions"
|
||||
],
|
||||
"no-arg": true,
|
||||
"no-bitwise": true,
|
||||
@@ -54,7 +43,7 @@
|
||||
],
|
||||
"no-construct": true,
|
||||
"no-debugger": true,
|
||||
"no-duplicate-super": true,
|
||||
"no-duplicate-variable": true,
|
||||
"no-empty": false,
|
||||
"no-empty-interface": true,
|
||||
"no-eval": true,
|
||||
@@ -82,7 +71,6 @@
|
||||
],
|
||||
"radix": true,
|
||||
"semicolon": [
|
||||
true,
|
||||
"always"
|
||||
],
|
||||
"triple-equals": [
|
||||
@@ -120,6 +108,9 @@
|
||||
"use-life-cycle-interface": true,
|
||||
"use-pipe-transform-interface": true,
|
||||
"component-class-suffix": true,
|
||||
"directive-class-suffix": true
|
||||
"directive-class-suffix": true,
|
||||
"no-access-missing-member": true,
|
||||
"templates-use-public": true,
|
||||
"invoke-injectable": true
|
||||
}
|
||||
}
|
||||
|
||||
+7
-12
@@ -22,7 +22,6 @@ may be listed here before their documentation is available.
|
||||
- [Angular Material Design](angular-material-design.md)
|
||||
- [Theming](theming.md)
|
||||
- [Typography](typography.md)
|
||||
- [Internationalization](internationalization.md)
|
||||
- [Walkthrough - adding indicators to highlight information about a node](metadata-indicators.md)
|
||||
|
||||
<!--guide end-->
|
||||
@@ -154,9 +153,9 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Data Table Adapter interface](DataTableAdapter.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) |
|
||||
| [Form Field Validator interface](FormFieldValidator.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) |
|
||||
| [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) |
|
||||
| [Data Table Adapter interface](DataTableAdapter.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../core/datatable/data/datatable-adapter.ts) |
|
||||
| [Form Field Validator interface](FormFieldValidator.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../core/form/components/widgets/core/form-field-validator.ts) |
|
||||
| [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../core/services/search-configuration.service.ts) |
|
||||
|
||||
[(Back to Contents)](#contents)
|
||||
|
||||
@@ -245,10 +244,10 @@ for more information about installing and using the source code.
|
||||
| [Task attachment list component](task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) |
|
||||
| [Comment list component](comment-list.component.md) | Shows a list of comments. | [Source](../lib/process-services/comments/comment-list.component.ts) |
|
||||
| [Comments component](comments.component.md) | Displays comments from users involved in a specified task and allows an involved user to add a comment to the task. | [Source](../lib/process-services/comments/comments.component.ts) |
|
||||
| [Process comments component](process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../lib/process-services/comments/process-comments.component.ts) |
|
||||
| [People component](people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/components/people/people.component.ts) |
|
||||
| [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/components/people-list/people-list.component.ts) |
|
||||
| [People search component](people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/components/people-search/people-search.component.ts) |
|
||||
| [Process comments component](process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments | [Source](../lib/process-services/comments/process-comments.component.ts) |
|
||||
| [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/people-list.component.ts) |
|
||||
| [People search component](people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/people-search.component.ts) |
|
||||
| [People component](people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/people.component.ts) |
|
||||
| [Process filters component](process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/process-list/components/process-filters.component.ts) |
|
||||
| [Process instance details component](process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) |
|
||||
| [Process instance header component](process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) |
|
||||
@@ -261,8 +260,6 @@ for more information about installing and using the source code.
|
||||
| [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) |
|
||||
| [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/task-list/components/task-header.component.ts) |
|
||||
| [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/task-list/components/task-list.component.ts) |
|
||||
| _People search field component_ | _Not currently documented_ | [Source](../lib/process-services/people/components/people-search-field/people-search-field.component.ts) |
|
||||
| _People selector component_ | _Not currently documented_ | [Source](../lib/process-services/people/components/people-selector/people-selector.component.ts) |
|
||||
|
||||
## Directives
|
||||
|
||||
@@ -270,8 +267,6 @@ for more information about installing and using the source code.
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information in the pdf or json format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) |
|
||||
| [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in the pdf or json format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) |
|
||||
| _People search action label directive_ | _Not currently documented_ | [Source](../lib/process-services/people/directives/people-search-action-label.directive.ts) |
|
||||
| _People search title directive_ | _Not currently documented_ | [Source](../lib/process-services/people/directives/people-search-title.directive.ts) |
|
||||
|
||||
## Models
|
||||
|
||||
|
||||
@@ -31,14 +31,14 @@ export class MyComponent implements OnInit {
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| heading | `string` | | Title heading for the group. |
|
||||
| headingIcon | `string` | | The material design icon. |
|
||||
| headingIconTooltip | `string` | | Tooltip message to be shown for headingIcon |
|
||||
| hasAccordionIcon | `boolean` | `true` | Should the (expanded) accordion icon be shown? |
|
||||
| isOpen | `boolean` | | Is this group currently open? |
|
||||
| isSelected | `boolean` | | Is this group currently selected? |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| heading | `string` | Title heading for the group. |
|
||||
| headingIcon | `string` | The material design icon. |
|
||||
| headingIconTooltip | `string` | Tooltip message to be shown for headingIcon |
|
||||
| hasAccordionIcon | `boolean` | Should the (expanded) accordion icon be shown? <br/> Default value: `true` |
|
||||
| isOpen | `boolean` | Is this group currently open? |
|
||||
| isSelected | `boolean` | Is this group currently selected? |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -63,3 +63,4 @@ the following example:
|
||||
## See also
|
||||
|
||||
- [Accordion group component](accordion-group.component.md)
|
||||
|
||||
|
||||
@@ -13,14 +13,14 @@ Generates and shows charts
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| reportId | `number` | | |
|
||||
| reportParamQuery | `ReportQuery` | `undefined` | |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| reportId | string | The report id |
|
||||
| reportParamQuery | ReportQuery | The object contains all the parameters that the report needs |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<{}>` | |
|
||||
| error | `EventEmitter<{}>` | |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | Raised when the charts are loaded |
|
||||
| error | Raised when an error occurs during the loading |
|
||||
|
||||
@@ -12,16 +12,16 @@ Shows a list of all available reports
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| layoutType | `string` | `AnalyticsReportListComponent.LAYOUT_LIST` | |
|
||||
| appId | `number` | | |
|
||||
| selectFirst | `boolean` | `false` | |
|
||||
| Name | Type | Required | Default | Description |
|
||||
| ---- | ---- | -------- | ------- | ----------- |
|
||||
| appId | string | optional | | The application id |
|
||||
| layoutType | string | required | | Define the layout of the apps. There are two possible values: GRID or LIST. LIST is the default value |
|
||||
| selectFirst | boolean | optional | false | Change the value to true if you want to select the first item in the list as default |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| reportClick | `EventEmitter<ReportParametersModel>` | |
|
||||
| success | `EventEmitter<{}>` | |
|
||||
| error | `EventEmitter<{}>` | |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | The event is emitted when the report list is loaded |
|
||||
| error | The event is emitted when an error occurs during the loading |
|
||||
| reportClick | The event is emitted when the report in the list is selected |
|
||||
|
||||
+23
-10
@@ -15,16 +15,29 @@ Shows the charts related to the reportId passed as input
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appId | `number` | | |
|
||||
| reportId | `number` | | |
|
||||
| hideParameters | `boolean` | `false` | |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| appId | string | The application id |
|
||||
| reportId | string | The report id |
|
||||
| hideParameters | boolean | Toggle the analytics parameters |
|
||||
|
||||
You can also hide chart parameters UI by setting the `hideParameters` to `true`:
|
||||
|
||||
```html
|
||||
<adf-analytics
|
||||
[appId]="appId"
|
||||
[reportId]="reportId"
|
||||
[hideParameters]="true">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| editReport | `EventEmitter<{}>` | |
|
||||
| reportSaved | `EventEmitter<{}>` | |
|
||||
| reportDeleted | `EventEmitter<{}>` | |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | The event is emitted when the report parameters are loaded |
|
||||
| error | The event is emitted when an error occurs during the loading |
|
||||
| reportSaved | The event is emitted when a report is saved |
|
||||
| reportDeleted | The event is emitted when a report is deleted |
|
||||
|
||||
@@ -14,10 +14,10 @@ Shows all available apps.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| layoutType | `string` | `AppsListComponent.LAYOUT_GRID` | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". |
|
||||
| filtersAppId | `any[]` | | Provides a way to filter the apps to show. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| layoutType | `string` | (\*\*required\*\*) Defines the layout of the apps. There are two possible values, "GRID" and "LIST".<br/> Default value: `AppsListComponent.LAYOUT_GRID` |
|
||||
| filtersAppId | `any[]` | Provides a way to filter the apps to show. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -15,12 +15,12 @@ Indicates the current position within a navigation hierarchy.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
|
||||
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
|
||||
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
||||
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| folderNode | `MinimalNodeEntryEntity` | Active node, builds UI based on folderNode.path.elements collection. <br/> Default value: `null` |
|
||||
| root | `string` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value.<br/> Default value: `null` |
|
||||
| rootId | `string` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with.<br/> Default value: `null` |
|
||||
| target | `DocumentListComponent` | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -14,11 +14,11 @@ Shows the checklist task functionality.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. |
|
||||
| readOnly | `boolean` | `false` | Toggle readonly state of the form. All form widgets will render as readonly if enabled. |
|
||||
| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| taskId | `string` | (required) The id of the parent task to which subtasks are attached. |
|
||||
| readOnly | `boolean` | Toggle readonly state of the form. All form widgets will render as readonly if enabled.<br/> Default value: `false` |
|
||||
| assignee | `string` | (required) The assignee id that the subtasks are assigned to. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -54,9 +54,9 @@ In the component template use the comment list component:
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| comments | `any[]` | | The comments data used to populate the list. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| comments | `any[]` | The comments data used to populate the list. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -15,10 +15,10 @@ Displays comments from users involved in a specified task and allows an involved
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | | The numeric ID of the task. |
|
||||
| readOnly | `boolean` | `false` | Are the comments read only? |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| taskId | `string` | The numeric ID of the task. |
|
||||
| readOnly | `boolean` | Are the comments read only? <br/> Default value: `false` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -74,15 +74,15 @@ export class MyView {
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | `'Action'` | The title of the action as shown in the menu. |
|
||||
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
|
||||
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
|
||||
| target | `string` | [ContentActionTarget.All](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/content-services/document-list/models/content-action.model.ts) | Type of item that the action applies to. Can be one of the values provided by the enum : **All**, **Folder**, **Document** |
|
||||
| permission | `string` | | The permission type. |
|
||||
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
|
||||
| disabled | `boolean` | `false` | Is the menu item disabled? |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| title | `string` | The title of the action as shown in the menu. <br/> Default value: `'Action'` |
|
||||
| icon | `string` | The name of the icon to display next to the menu command (can be left blank). |
|
||||
| handler | `string` | System actions. Can be "delete", "download", "copy" or "move". |
|
||||
| target | `string` | Type of item that the action appies to. Can be "document" or "folder" |
|
||||
| permission | `string` | The permission type. |
|
||||
| disableWithNoPermission | `boolean` | Should this action be disabled in the menu if the user doesn't have permission for it? |
|
||||
| disabled | `boolean` | Is the menu item disabled? <br/> Default value: `false` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -4,38 +4,29 @@ Displays and manages dialogs for selecting content to open, copy or upload.
|
||||
|
||||
## Methods
|
||||
|
||||
- `openFileBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a file browser at a chosen folder location.
|
||||
- `folderNodeId` - ID of the folder to use
|
||||
- `openFileBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a file browser at a chosen site location.
|
||||
`openFileBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a file browser at a chosen folder location.
|
||||
|
||||
- `openFolderBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a folder browser at a chosen site location.
|
||||
`openFolderBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a folder browser at a chosen folder location.
|
||||
|
||||
- `openFolderBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a folder browser at a chosen folder location.
|
||||
- `folderNodeId` - ID of the folder to use
|
||||
- `openCopyMoveDialog(action: string, contentEntry: MinimalNodeEntryEntity, permission?: string): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a dialog to copy or move an item to a new location.
|
||||
- `action` - Name of the action (eg, "Copy" or "Move") to show in the title
|
||||
- `contentEntry` - Item to be copied or moved
|
||||
- `permission` - (Optional) Permission for the operation
|
||||
- `getTitleTranslation(action: string, name: string): string`
|
||||
Gets the translation of the dialog title.
|
||||
- `action` - Name of the action to display in the dialog title
|
||||
- `name` - Name of the item on which the action is being performed
|
||||
- `openUploadFolderDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a dialog to choose a folder to upload.
|
||||
- `action` - Name of the action to show in the title
|
||||
- `contentEntry` - Item to upload
|
||||
- `openUploadFileDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>`
|
||||
Opens a dialog to choose a file to upload.
|
||||
- `action` - Name of the action to show in the title
|
||||
- `contentEntry` - Item to upload
|
||||
- `close()`
|
||||
Closes the currently open dialog.
|
||||
`openFileBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a file browser at a chosen site location.
|
||||
|
||||
`openFolderBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a folder browser at a chosen site location.
|
||||
|
||||
`openCopyMoveDialog(action: string, contentEntry: MinimalNodeEntryEntity, permission?: string): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a dialog to copy or move an item to a new location.
|
||||
|
||||
`openUploadFileDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a dialog to choose a file to upload.
|
||||
|
||||
`openUploadFolderDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>`<br/>
|
||||
Opens a dialog to choose a folder to upload.
|
||||
|
||||
`close()`<br/>
|
||||
Closes the currently open dialog.
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (required) The ID of the process instance to display. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | `string` | (required) The ID of the process instance to display. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -33,16 +33,16 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. |
|
||||
| type | `string` | `'text'` | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'. |
|
||||
| format | `string` | | Value format (if supported by the parent component), for example format of the date. |
|
||||
| sortable | `boolean` | `true` | Toggles ability to sort by this column, for example by clicking the column header. |
|
||||
| title | `string` | `''` | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. |
|
||||
| formatTooltip | `Function` | | Custom tooltip formatter function. |
|
||||
| srTitle | `string` | | Title to be used for screen readers. |
|
||||
| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| key | `string` | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. |
|
||||
| type | `string` | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'.<br/> Default value: `'text'` |
|
||||
| format | `string` | Value format (if supported by the parent component), for example format of the date. |
|
||||
| sortable | `boolean` | Toggles ability to sort by this column, for example by clicking the column header. <br/> Default value: `true` |
|
||||
| title | `string` | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically.<br/> Default value: `''` |
|
||||
| formatTooltip | `Function` | Custom tooltip formatter function. |
|
||||
| srTitle | `string` | Title to be used for screen readers. |
|
||||
| cssClass | `string` | Additional CSS class to be applied to column (header and cells). |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -172,7 +172,6 @@ These events bubble up the component tree and can be handled by any parent compo
|
||||
| row-select | Raised after user selects a row |
|
||||
| row-unselect | Raised after user unselects a row |
|
||||
| row-keyup | Raised on the 'keyup' event for the focused row. |
|
||||
| sorting-changed | Raised after user clicks the sortable column header. |
|
||||
|
||||
For example:
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.9 KiB |
@@ -47,32 +47,32 @@ Displays the documents from a repository.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| permissionsStyle | `PermissionStyleModel[]` | `[]` | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples. |
|
||||
| locationFormat | `string` | `'/'` | The default route for all the location-based columns (if declared). |
|
||||
| navigate | `boolean` | `true` | Toggles navigation to folder content or file preview |
|
||||
| navigationMode | `string` | `DocumentListComponent.DOUBLE_CLICK_NAVIGATION` | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". |
|
||||
| thumbnails | `boolean` | `false` | Show document thumbnails rather than icons |
|
||||
| selectionMode | `string` | `'single'` | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
| multiselect | `boolean` | `false` | Toggles multiselect mode |
|
||||
| contentActions | `boolean` | `false` | Toggles content actions for each row |
|
||||
| contentActionsPosition | `string` | `'right'` | Position of the content actions dropdown menu. Can be set to "left" or "right". |
|
||||
| contextMenuActions | `boolean` | `false` | Toggles context menus for each row |
|
||||
| emptyFolderImageUrl | `string` | `'./assets/images/empty_doc_lib.svg'` | Custom image for empty folder |
|
||||
| allowDropFiles | `boolean` | `false` | Toggle file drop support for rows (see Upload Directive for further details |
|
||||
| sorting | `string[]` | | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
|
||||
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
|
||||
| rowStyleClass | `string` | | The CSS class to apply to every row |
|
||||
| loading | `boolean` | `false` | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. |
|
||||
| rowFilter | `any` | `null` | Custom row filter |
|
||||
| imageResolver | `any` | `null` | Custom image resolver |
|
||||
| currentFolderId | `string` | `null` | The ID of the folder node to display or a reserved string alias for special sources |
|
||||
| folderNode | `MinimalNodeEntryEntity` | `null` | Currently displayed folder node |
|
||||
| node | `NodePaging` | `null` | The Document list will show all the nodes contained in the NodePaging entity |
|
||||
| maxItems | `number` | | Default value is stored into user preference settings |
|
||||
| skipCount | `number` | `0` | Number of elements to skip over for pagination purposes |
|
||||
| enableInfiniteScrolling | `boolean` | `false` | Set document list to work in infinite scrolling mode |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| permissionsStyle | `PermissionStyleModel[]` | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples.<br/> Default value: `[]` |
|
||||
| locationFormat | `string` | The default route for all the location-based columns (if declared). <br/> Default value: `'/'` |
|
||||
| navigate | `boolean` | Toggles navigation to folder content or file preview <br/> Default value: `true` |
|
||||
| navigationMode | `string` | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". <br/> Default value: `DocumentListComponent.DOUBLE_CLICK_NAVIGATION` |
|
||||
| thumbnails | `boolean` | Show document thumbnails rather than icons <br/> Default value: `false` |
|
||||
| selectionMode | `string` | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.<br/> Default value: `'single'` |
|
||||
| multiselect | `boolean` | Toggles multiselect mode <br/> Default value: `false` |
|
||||
| contentActions | `boolean` | Toggles content actions for each row <br/> Default value: `false` |
|
||||
| contentActionsPosition | `string` | Position of the content actions dropdown menu. Can be set to "left" or "right". <br/> Default value: `'right'` |
|
||||
| contextMenuActions | `boolean` | Toggles context menus for each row <br/> Default value: `false` |
|
||||
| emptyFolderImageUrl | `string` | Custom image for empty folder <br/> Default value: `'./assets/images/empty_doc_lib.svg'` |
|
||||
| allowDropFiles | `boolean` | Toggle file drop support for rows (see Upload Directive for further details <br/> Default value: `false` |
|
||||
| sorting | `string[]` | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
|
||||
| rowStyle | `string` | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
|
||||
| rowStyleClass | `string` | The CSS class to apply to every row |
|
||||
| loading | `boolean` | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication.<br/> Default value: `false` |
|
||||
| rowFilter | `any` | Custom row filter <br/> Default value: `null` |
|
||||
| imageResolver | `any` | Custom image resolver <br/> Default value: `null` |
|
||||
| currentFolderId | `string` | The ID of the folder node to display or a reserved string alias for special sources <br/> Default value: `null` |
|
||||
| folderNode | `MinimalNodeEntryEntity` | Currently displayed folder node <br/> Default value: `null` |
|
||||
| node | `NodePaging` | The Document list will show all the nodes contained in the NodePaging entity <br/> Default value: `null` |
|
||||
| maxItems | `number` | Default value is stored into user preference settings |
|
||||
| skipCount | `number` | Number of elements to skip over for pagination purposes <br/> Default value: `0` |
|
||||
| enableInfiniteScrolling | `boolean` | Set document list to work in infinite scrolling mode <br/> Default value: `false` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -15,20 +15,25 @@ Indicates the current position within a navigation hierarchy using a dropdown me
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
|
||||
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
|
||||
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
||||
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| target | DocumentListComponent | (optional) DocumentList component to operate with. Upon clicks will instruct the given component to update. |
|
||||
| folderNode | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | Active node, builds UI based on `folderNode.path.elements` collection. |
|
||||
| root | string | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use i18n resource key for the property value. |
|
||||
| rootId | string | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. |
|
||||
| Name | Returned Type | Description |
|
||||
| ---- | ------------- | ----------- |
|
||||
| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb |
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
|
||||
<!-- seealso start -->
|
||||
|
||||
## See also
|
||||
|
||||
- [Document list component](document-list.component.md)
|
||||
- [Breadcrumb component](breadcrumb.component.md)
|
||||
<!-- seealso end -->
|
||||
|
||||
@@ -10,9 +10,9 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| position | `string` | `'right'` | Dialog position. Can be 'left' or 'right'. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| position | string | 'right' | Dialog position. Accepted values are 'left' or 'right' |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ based on the field type or the metadata information.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| field | `FormFieldModel` | `null` | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| field | FormFieldModel | | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ Shows APS forms as a list.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| forms | `any[]` | `[]` | The array that contains the information to show inside the list. |
|
||||
The recommended set of properties can be found in the following table:
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| forms | any | | The array that contains the information to show inside the list. |
|
||||
|
||||
+36
-30
@@ -101,39 +101,45 @@ and store the form field as metadata. The param nameNode is optional.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| form | `FormModel` | | Underlying form model instance. |
|
||||
| taskId | `string` | | Task id to fetch corresponding form and values. |
|
||||
| nodeId | `string` | | Content Services node ID for the form metadata. |
|
||||
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
||||
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
||||
| saveMetadata | `boolean` | `false` | Toggle saving of form metadata. |
|
||||
| data | `FormValues` | | Custom form values map to be used with the rendered form. |
|
||||
| path | `string` | | Path of the folder where the metadata will be stored. |
|
||||
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
|
||||
| showTitle | `boolean` | `true` | Toggle rendering of the form title. |
|
||||
| showCompleteButton | `boolean` | `true` | Toggle rendering of the `Complete` outcome button. |
|
||||
| disableCompleteButton | `boolean` | `false` | If true then the `Complete` outcome button is shown but it will be disabled. |
|
||||
| disableStartProcessButton | `boolean` | `false` | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
||||
| showSaveButton | `boolean` | `true` | Toggle rendering of the `Save` outcome button. |
|
||||
| showDebugButton | `boolean` | `false` | Toggle debug options. |
|
||||
| readOnly | `boolean` | `false` | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggle rendering of the `Refresh` button. |
|
||||
| showValidationIcon | `boolean` | `true` | Toggle rendering of the validation icon next to the form title. |
|
||||
| fieldValidators | `FormFieldValidator[]` | `[]` | Contains a list of form field validator instances. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| taskId | string | | Task id to fetch corresponding form and values. |
|
||||
| formId | string | | The id of the form definition to load and display with custom values. |
|
||||
| formName | string | | Name of the form definition to load and display with custom values. |
|
||||
| data | FormValues | | Custom form values map to be used with the rendered form. |
|
||||
| showTitle | boolean | true | Toggle rendering of the form title. |
|
||||
| showCompleteButton | boolean | true | Toggle rendering of the `Complete` outcome button. |
|
||||
| disableCompleteButton | boolean | false | The `Complete` outcome button is shown but it will be disabled. |
|
||||
| disableStartProcessButton | boolean | false | The `Start Process` outcome button is shown but it will be disabled. |
|
||||
| showSaveButton | boolean | true | Toggle rendering of the `Save` outcome button. |
|
||||
| readOnly | boolean | false | Toggle readonly state of the form. Enforces all form widgets render readonly if enabled. |
|
||||
| showRefreshButton | boolean | true | Toggle rendering of the `Refresh` button. |
|
||||
| showValidationIcon | boolean | true | Toggle rendering of the validation icon next form title. |
|
||||
| saveMetadata | boolean | false | Store the value of the form as metadata. |
|
||||
| path | string | | Path of the folder where to store the metadata. |
|
||||
| nameNode | string | true | Name to assign to the new node where the metadata are stored. |
|
||||
| fieldValidators | FormFieldValidator\[] | See [Field Validators](#field-validators) section below | Contains a list of form field validator instances. |
|
||||
|
||||
### Advanced properties
|
||||
|
||||
The following properties are for complex customisation purposes:
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| form | FormModel | | Underlying form model instance. |
|
||||
| showDebugButton | boolean | false | Toggle debug options. |
|
||||
| debugMode | boolean | false | Toggle debug mode, allows displaying additional data for development and debugging purposes. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||
| formCompleted | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||
| formContentClicked | `EventEmitter<ContentLinkModel>` | Emitted when form content is clicked. |
|
||||
| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
|
||||
| formDataRefreshed | `EventEmitter<FormModel>` | Emitted when form values are refreshed due to a data property change. |
|
||||
| executeOutcome | `EventEmitter<FormOutcomeEvent>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
|
||||
| onError | `EventEmitter<any>` | Emitted when any error occurs. |
|
||||
| Name | Return Type | Description |
|
||||
| ---- | ----------- | ----------- |
|
||||
| formLoaded | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form is loaded or reloaded. |
|
||||
| formSaved | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form is submitted with `Save` or custom outcomes. |
|
||||
| formCompleted | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form is submitted with `Complete` outcome. |
|
||||
| formDataRefreshed | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form values are refreshed due to a data property change |
|
||||
| executeOutcome | [FormOutcomeEvent](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form-outcome-event.model.ts) | Invoked when any outcome is executed, default behaviour can be prevented via `event.preventDefault()` |
|
||||
| error | any | Invoked at any error |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -13,14 +13,12 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| Name | Type | Default Value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| providers | `string` | `'ALL'` | Determines which configurations are shown. Possible valid values are "ECM", "BPM" or "ALL". |
|
||||
| providers | string | ALL | Possible valid values are ECM, BPM or ALL. It indicate which URL configurations show |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | `EventEmitter<string>` | Emitted when the URL is invalid. |
|
||||
| ecmHostChange | `EventEmitter<string>` | Emitted when the ECM host url is changed. |
|
||||
| bpmHostChange | `EventEmitter<string>` | Emitted when the BPM host url is changed. |
|
||||
| Name | Returned Type | Description |
|
||||
| ---- | ------------- | ----------- |
|
||||
| error | string | emitted when the url inserted is wrong |
|
||||
|
||||
@@ -27,18 +27,19 @@ Adds "infinite" pagination to the component it is used with.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| pagination | `Pagination` | | Pagination object. |
|
||||
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
||||
| pageSize | `number` | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event. |
|
||||
| isLoading | `boolean` | `false` | Is a new page loading? |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| pagination | Pagination | `InfinitePaginationComponent.DEFAULT_PAGINATION` | Pagination object |
|
||||
| pageSize | number | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event |
|
||||
| loading | boolean | false | |
|
||||
| target | PaginatedComponent | | Component that provides custom pagination support |
|
||||
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| loadMore | `EventEmitter<Pagination>` | Emitted when the "Load More" button is clicked. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| loadMore | Emitted when the "Load More" button is clicked |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -26,16 +26,11 @@ Displays a sidebar-style information panel with tabs.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | `null` | The title of the info drawer. |
|
||||
| selectedIndex | `number` | `0` | The selected index tab. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| currentTab | `EventEmitter<number>` | Emitted when the currently active tab changes. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| title | string | null | The title of the info drawer |
|
||||
| selectedIndex | number | 0 | The selected index tab |
|
||||
| currentTab | any | null | The currently active tab |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -1,217 +0,0 @@
|
||||
# Internationalization in ADF
|
||||
|
||||
Internationalization (abbreviated to i18n) is the process of providing UI messages
|
||||
and captions in different human languages to make them easier for readers of those
|
||||
languages to understand. ADF provides full support for i18n in apps. The process does
|
||||
require some extra effort in planning and designing the UI but once implemented, it is
|
||||
fairly straightforward to maintain.
|
||||
|
||||
## Contents
|
||||
|
||||
- [I18n concepts](#i18n-concepts)
|
||||
- [ADF support for i18n](#adf-support-for-i18n)
|
||||
- [Using the translate pipe](#using-the-translate-pipe)
|
||||
- [Adding your own messages](#adding-your-own-messages)
|
||||
- [Interpolations](#interpolations)
|
||||
- [Selecting the display language](#selecting-the-display-language)
|
||||
- [Support for i18n within ADF components](#support-for-i18n-within-adf-components)
|
||||
- [See also](#see-also)
|
||||
|
||||
## I18n concepts
|
||||
|
||||
The main idea behind i18n is to avoid adding natural language text directly into the
|
||||
HTML. Instead, UI messages are represented by short strings known as
|
||||
**keys**. Keys are not displayed directly; they are used to look up the actual text
|
||||
in a list of predefined messages. A typical key/message pair might look like the
|
||||
following:
|
||||
|
||||
"CS_URL_ERROR": "Content Services address doesn't match the URL format"
|
||||
|
||||
Separate lists are kept for each language supported by the app, so for German, the
|
||||
same message would be defined as:
|
||||
|
||||
"CS_URL_ERROR": "Content Services-Adresse nicht im richtigen URL-Format"
|
||||
|
||||
Note that the key is the same in both cases. As long as the UI only ever refers to
|
||||
the keys then changing languages is a simple matter of changing the look-up list.
|
||||
|
||||
## ADF support for i18n
|
||||
|
||||
ADF implements i18n for more than ten languages internally in the display text for
|
||||
components, so you can try out some simple messages without any configuration. The
|
||||
keys are defined in a set of files in the `lib/core/i18n` folder in the ADF sources.
|
||||
|
||||
The files are named according to standard
|
||||
[two-letter language codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes),
|
||||
so `en.json` is the look-up list for English, etc. An excerpt from `en.json` is shown
|
||||
below:
|
||||
|
||||
```json
|
||||
{
|
||||
"FORM": {
|
||||
"START_FORM": {
|
||||
"TITLE": "Start Form"
|
||||
},
|
||||
"PREVIEW": {
|
||||
"IMAGE_NOT_AVAILABLE": "Preview not available"
|
||||
},
|
||||
"FIELD": {
|
||||
"LOCALSTORAGE" : "Local storage",
|
||||
"SOURCE": "Select source from ",
|
||||
"UPLOAD": "UPLOAD",
|
||||
"REQUIRED": "*Required",
|
||||
...
|
||||
```
|
||||
|
||||
The hierarchical structure is referred to in the UI using the familiar "dot"
|
||||
notation (so `FORM.START_FORM.TITLE` would be the key for the "Start Form"
|
||||
string here). This is useful for grouping related messages and providing
|
||||
singular and plural versions, among other things.
|
||||
|
||||
The [Translation service](translation.service.md) defines the `get` method to
|
||||
get the translation of a key in the current language. A simple component might
|
||||
contain code like this:
|
||||
|
||||
```ts
|
||||
import { Component, OnInit } from '@angular/core';
|
||||
|
||||
import { TranslationService } from "@alfresco/adf-core";
|
||||
|
||||
@Component({
|
||||
selector: 'app-home',
|
||||
templateUrl: './home.component.html',
|
||||
styleUrls: ['./home.component.css']
|
||||
})
|
||||
export class HomeComponent implements OnInit {
|
||||
|
||||
constructor(private trans: TranslationService) { }
|
||||
|
||||
translatedText: string = "";
|
||||
|
||||
ngOnInit() {
|
||||
this.trans.get("FORM.START_FORM.TITLE").subscribe(translation => {
|
||||
this.translatedText = translation;
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
...with very simple corresponding HTML:
|
||||
|
||||
```html
|
||||
{{translatedText}}
|
||||
```
|
||||
|
||||
In the browser, this is displayed as:
|
||||
|
||||
|
||||
|
||||
English is used by default but you can easily change the language with the
|
||||
`use` method:
|
||||
|
||||
```ts
|
||||
ngOnInit() {
|
||||
this.trans.use("de");
|
||||
|
||||
this.trans.get("FORM.START_FORM.TITLE").subscribe(translation => {
|
||||
this.translatedText = translation;
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
The user will now see:
|
||||
|
||||
|
||||
|
||||
Note that an unrecognized key will be returned unchanged as the "translation".
|
||||
If you see strings like "FORM.START_FORM.TITLE" displayed in your app then you
|
||||
should check you are using the key correctly.
|
||||
|
||||
## Using the translate pipe
|
||||
|
||||
Using `TranslationService.get` is straightforward but it is often more
|
||||
convenient to add translation keys directly into your page's HTML.
|
||||
Use the `translate` pipe to convert a key in the page directly to the
|
||||
corresponding text. For example, the following will display the
|
||||
"Start Form" text as above but without any code or variables in the
|
||||
component's `.ts` file:
|
||||
|
||||
{{ "FORM.START_FORM.TITLE" | translate }}
|
||||
|
||||
## Adding your own messages
|
||||
|
||||
The built-in translations certainly won't cover everything you will need for
|
||||
your app but you can easily replace them with your own lists. This involves
|
||||
making copies of the existing lists in your app's folder and adding your
|
||||
own keys. See the [Translation service](translation.service.md) page for
|
||||
full details and examples.
|
||||
|
||||
## Interpolations
|
||||
|
||||
Translation messages have support for _interpolation_ (ie, including another
|
||||
string at a specified position within a message). This is very useful for
|
||||
messages whose content can change at runtime. For example, in the built-in
|
||||
`en.json` there is the `CORE.PAGINATION.ITEMS_RANGE` key:
|
||||
|
||||
```json
|
||||
...
|
||||
"CORE": {
|
||||
...
|
||||
"PAGINATION": {
|
||||
"ITEMS_RANGE": "Showing {{ range }} of {{ total }}",
|
||||
"ITEMS_PER_PAGE": "Items per page",
|
||||
...
|
||||
},
|
||||
...
|
||||
```
|
||||
|
||||
The sections in curly braces are _interpolation variables_ that you supply
|
||||
at runtime. You can specify them by passing an extra parameter to
|
||||
`TranslationService.get`; this is an object whose properties have the same
|
||||
names as the interpolation variables in the string:
|
||||
|
||||
```ts
|
||||
this.trans.get(
|
||||
"CORE.PAGINATION.ITEMS_RANGE",
|
||||
{
|
||||
range: "1..10",
|
||||
total: "122"
|
||||
}
|
||||
).subscribe(translation => {
|
||||
this.translatedText = translation;
|
||||
});
|
||||
```
|
||||
|
||||
You can use interpolations with the `translate` pipe in a similar way:
|
||||
|
||||
{{ "CORE.PAGINATION.ITEMS_RANGE" | translate: { range: "1..10", total: "122"} }}
|
||||
|
||||
## Selecting the display language
|
||||
|
||||
ADF provides a [Language Menu component](language-menu.component.md) that
|
||||
you can add to a page to let the user choose their preferred language. The
|
||||
available languages are defined in the `app.config.json` file for the app.
|
||||
|
||||
Note that when the user selects an item from the menu, it simply changes the "locale"
|
||||
preference (which you can get via the [User Preferences service](user-preferences.service.md)).
|
||||
The `translate` pipe reacts automatically to this and changes the page text
|
||||
immediately to the new language. However, text added via a variable set using
|
||||
`TranslationService.get`, as in the example above, will not be updated like this;
|
||||
you will need to get a new translation and set the variable's value again explicitly
|
||||
from the code.
|
||||
|
||||
See the [Language Menu component](language-menu.component.md) page for further
|
||||
details and usage examples.
|
||||
|
||||
## Support for i18n within ADF components
|
||||
|
||||
Some components allow you to use translation keys in places where you would normally
|
||||
supply your own messages directly. For example, the
|
||||
[Data Column component](data-column.component.md) can accept a key instead of
|
||||
normal text to specify the column title. Consult the documentation for a
|
||||
component to see if it has built-in support for i18n.
|
||||
|
||||
## See also
|
||||
|
||||
- [Translation service](translation.service.md)
|
||||
- [Language Menu component](language-menu.component.md)
|
||||
@@ -65,7 +65,3 @@ How to attach an ADF Language Menu as nested menu
|
||||
### Nested menu details
|
||||
|
||||
In the previous example we are using the ADF Language Menu as nested menu.
|
||||
|
||||
## See Also
|
||||
|
||||
- [Internationalization](internationalization.md)
|
||||
|
||||
@@ -12,15 +12,15 @@ Allows a user to add "likes" to an item.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | Identifier of a node to apply likes to. |
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| nodeId | string | | The identifier of a node. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| changeVote | `EventEmitter<{}>` | Emitted when the "vote" gets changed. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| changeVote | Raised when vote gets changed |
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
+17
-17
@@ -32,27 +32,27 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| Name | Type | Default Value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| showRememberMe | `boolean` | `true` | Should the `Remember me` checkbox be shown? |
|
||||
| showLoginActions | `boolean` | `true` | Should the extra actions (`Need Help`, `Register`, etc) be shown? |
|
||||
| needHelpLink | `string` | `''` | Sets the URL of the NEED HELP link in the footer. |
|
||||
| registerLink | `string` | `''` | Sets the URL of the REGISTER link in the footer. |
|
||||
| logoImageUrl | `string` | `'./assets/images/alfresco-logo.svg'` | Path to a custom logo image. |
|
||||
| backgroundImageUrl | `string` | `'./assets/images/background.svg'` | Path to a custom background image. |
|
||||
| copyrightText | `string` | `'\u00A9 2016 Alfresco Software, Inc. All Rights Reserved.'` | The copyright text below the login box. |
|
||||
| providers | `string` | | Possible valid values are ECM, BPM or ALL. By default, this component will log in only to ECM. If you want to log in in both systems then use ALL. |
|
||||
| fieldsValidation | `any` | | Custom validation rules for the login form. |
|
||||
| disableCsrf | `boolean` | | Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. |
|
||||
| successRoute | `string` | `null` | Route to redirect to on successful login. |
|
||||
| providers | string | | Possible valid values are ECM, BPM or ALL. The default behaviour of this component will log in only in the ECM . If you want to log in in both systems the correct value to use is ALL. |
|
||||
| successRoute | string | | Route to redirect to upon successful login. |
|
||||
| disableCsrf | boolean | false | To prevent the CSRF Token from being submitted. Only for Alfresco Process Services call |
|
||||
| needHelpLink | string | | It will change the url of the NEED HELP link in the footer |
|
||||
| registerLink | string | | It will change the url of the REGISTER link in the footer |
|
||||
| logoImageUrl | string | \\<ADF logo image> | To change the logo image with a customised image |
|
||||
| copyrightText | string | \\<ADF copyright string> | The copyright text below the login box |
|
||||
| backgroundImageUrl | string | \\<ADF background image> | To change the background image with a customised image |
|
||||
| fieldsValidation | { [key: string]: any; }, extra?: { [key: string]: any; } | | Use it to customise the validation rules of the login form |
|
||||
| showRememberMe | boolean | false | Toggle `Remember me` checkbox visibility |
|
||||
| showLoginActions | boolean | false | Toggle extra actions visibility (`Need Help`, `Register`, etc.) |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<LoginSuccessEvent>` | Emitted when the login is successful. |
|
||||
| error | `EventEmitter<LoginErrorEvent>` | Emitted when the login fails. |
|
||||
| executeSubmit | `EventEmitter<LoginSubmitEvent>` | Emitted when the login form is submitted. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | Raised when the login is done |
|
||||
| error | Raised when the login fails |
|
||||
| executeSubmit | Raised when the form is submitted |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -29,21 +29,21 @@ Adds pagination to the component it is used with.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
||||
| supportedPageSizes | `number[]` | `[5, 25, 50, 100]` | An array of page sizes. |
|
||||
| pagination | `Pagination` | | Pagination object. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| pagination | Pagination | | Pagination object |
|
||||
| supportedPageSizes | Array<number> | [ 25, 50, 100 ] | An array of page sizes |
|
||||
| target | PaginatedComponent | | Component that provides custom pagination support |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| change | `EventEmitter<PaginationQueryParams>` | Emitted when paginaton changes in any way. |
|
||||
| changePageNumber | `EventEmitter<Pagination>` | Emitted when the page number changes. |
|
||||
| changePageSize | `EventEmitter<Pagination>` | Emitted when the page size changes. |
|
||||
| nextPage | `EventEmitter<Pagination>` | Emitted when the next page is requested. |
|
||||
| prevPage | `EventEmitter<Pagination>` | Emitted when the previous page is requested. |
|
||||
| change | EventEmitter<PaginationQueryParams> | Triggered for any action in pagination |
|
||||
| nextPage | EventEmitter<Pagination> | Triggered on next page action |
|
||||
| prevPage | EventEmitter<Pagination> | Triggered on previous page action |
|
||||
| changePageSize | EventEmitter<Pagination> | Triggered on page size change action |
|
||||
| changePageNumber | EventEmitter<Pagination> | Triggered on page change action |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -71,7 +71,3 @@ export interface PaginatedComponent {
|
||||
|
||||
Your component needs to provide a `pagination` subject to allow Pagination component to reflect to changes.
|
||||
Every time user interacts with the Pagination, it will call the `updatePagination` method and pass the parameters.
|
||||
|
||||
## See also
|
||||
|
||||
- [Infinite Pagination component](infinite-pagination.component.md)
|
||||
|
||||
@@ -60,18 +60,18 @@ In the component template use the people list component:
|
||||
</adf-people-list>
|
||||
```
|
||||
|
||||
Note that the people list component is based on the [Datatable component](datatable.component.md).
|
||||
Note that the people list component is based on the `<adf-datatable` component.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| users | `any[]` | | The array of user data used to populate the people list. |
|
||||
| actions | `boolean` | `false` | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| users | UserProcessModel\[] | | The array of user data that should be used to populate the people list |
|
||||
| actions | boolean | false | true if actions should be visible, i.e. the 'Three-Dots' menu |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| clickRow | `EventEmitter<any>` | Emitted when the user clicks a row in the people list. |
|
||||
| clickAction | `EventEmitter<UserEventModel>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| clickRow | Emitted when the user clicks a row in the people list. |
|
||||
| clickAction | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
|
||||
|
||||
@@ -10,17 +10,17 @@ Searches users/people.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| results | `Observable<any[]>` | | The parameters to show people list. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| results | Observable<User\[]> | The params to show people list |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| searchPeople | `EventEmitter<any>` | Emitted when a search is performed with a new keyword. |
|
||||
| success | `EventEmitter<any>` | Emitted when a user is selected and the action button is clicked. |
|
||||
| closeSearch | `EventEmitter<{}>` | Emitted when the "close" button is clicked. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| searchPeople | Raised when the search people with new keyword |
|
||||
| success | Raised when select the user and click action button |
|
||||
| closeSearch | Raised when click the clse button |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -31,11 +31,15 @@ Displays users involved with a specified task
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| people | `any[]` | `[]` | The array of User objects to display. |
|
||||
| taskId | `string` | `''` | The numeric ID of the task. |
|
||||
| readOnly | `boolean` | `false` | Should the data be read-only? |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| people | User\[] | The array of User object to display |
|
||||
| taskId | string | The numeric ID of the task |
|
||||
| readOnly | boolean | The boolean flag |
|
||||
|
||||
### Events
|
||||
|
||||
No Events
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -18,8 +18,8 @@ If the List is empty, a default no content template is displayed.
|
||||
|
||||
|
||||
Make sure to override the UploadService with the ProcessUploadService
|
||||
|
||||
```ts
|
||||
|
||||
import { UploadService } from '@alfresco/adf-core';
|
||||
import { ProcessUploadService } from '@alfresco/adf-process-services';
|
||||
|
||||
@@ -34,26 +34,9 @@ export class MyCustomProcessAttachmentComponent {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (**required**) The ID of the process instance to display. |
|
||||
| disabled | `boolean` | `false` | Disable/Enable read-only mode for attachment list. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| attachmentClick | `EventEmitter<{}>` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a Blob representing the object that was clicked. |
|
||||
| success | `EventEmitter<{}>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
|
||||
| error | `EventEmitter<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
|
||||
|
||||
## Details
|
||||
|
||||
### How to Add Drag and Drop Functionality
|
||||
|
||||
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom _no content template_ as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
||||
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom *no content template* as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
||||
|
||||
```html
|
||||
<adf-upload-drag-area
|
||||
@@ -77,3 +60,18 @@ If we want user to be able to upload attachments for empty lists, We can wrap ou
|
||||
If the List is empty, the custom no-content template we passed is displayed.
|
||||
|
||||
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | -- |
|
||||
| processInstanceId | string | | (**required**): The ID of the process instance to display |
|
||||
| disabled | boolean | false | Disable/Enable read only mode for attachement list |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| attachmentClick | Raised when the attachment double clicked or selected view option from context menu by the user from within the component and return a Blob obj of the object clicker|
|
||||
| success | Raised when the attachment list fetch all the attach and return a list of attachments |
|
||||
| error | Raised when the attachment list is not able to fetch the attachments for example network error |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Process Instance Comments component
|
||||
|
||||
Displays comments associated with a particular process instance and allows the user to add new comments.
|
||||
Displays comments associated with a particular process instance and allows the user to add new comments
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@@ -12,13 +12,6 @@ Displays comments associated with a particular process instance and allows the u
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. |
|
||||
| readOnly | `boolean` | `true` | Should the comments be read-only? |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| processInstanceId | string | (**required**): The numeric ID of the process instance to display comments for |
|
||||
|
||||
@@ -12,20 +12,22 @@ Collection of criteria used to filter process instances, which may be customized
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| filterParam | `FilterProcessRepresentationModel` | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. |
|
||||
| appId | `number` | | Display filters available to the current user for the application with the specified ID. |
|
||||
| appName | `string` | | Display filters available to the current user for the application with the specified name. |
|
||||
| showIcon | `boolean` | `true` | Toggle to show or hide the filter's icon. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterParam | [FilterParamsModel](#filterparamsmodel) | The params to filter the task filter. If there is no match the default one (first filter of the list) is selected |
|
||||
| appId | string | Display filters available to the current user for the application with the specified ID. |
|
||||
| appName | string | Display filters available to the current user for the application with the specified name. |
|
||||
| hasIcon | boolean | Toggle to show or not the filter's icon. |
|
||||
|
||||
If both `appId` and `appName` are specified then `appName` will take precedence and `appId` will be ignored.
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterClick | `EventEmitter<ProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. |
|
||||
| success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | Raised when the list of filters has been successfully loaded from the server |
|
||||
| error | Raised when an error occurs |
|
||||
| filterClick | Raised when the user selects a filter from the list |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -35,8 +37,6 @@ filter as the active filter.
|
||||
The most common usage is in driving a process instance list to allow the user to choose which
|
||||
process instances are displayed in the list.
|
||||
|
||||
If both `appId` and `appName` are specified then `appName` will take precedence and `appId` will be ignored.
|
||||
|
||||
### How filter the activiti process filters
|
||||
|
||||
```html
|
||||
|
||||
@@ -12,17 +12,14 @@ Displays detailed information on a specified process instance
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. |
|
||||
| showTitle | `boolean` | `true` | Toggles whether to show or hide the title. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggles whether to show or hide the refresh button. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | string | (required): The numeric ID of the process instance to display |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processCancelled | `EventEmitter<any>` | Emitted when the current process is cancelled by the user from within the component. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |
|
||||
| showProcessDiagram | `EventEmitter<any>` | Emitted when the "show diagram" button is clicked. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| processCancelledEmitter | Raised when the current process is cancelled by the user from within the component |
|
||||
| taskFormCompletedEmitter | Raised when the form associated with an active task is completed from within the component |
|
||||
| showProcessDiagram | Raised when the show diagram button is clicked |
|
||||
|
||||
@@ -14,6 +14,10 @@ Sub-component of the process details component, which renders some general infor
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstance | `ProcessInstance` | | (**required**) Full details of the process instance to display information about. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstance | [ProcessInstanceModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-processlist/src/models/process-instance.model.ts) | (**required**): Full details of the process instance to display information about |
|
||||
|
||||
#### Events
|
||||
|
||||
This component does not define any events.
|
||||
|
||||
@@ -13,14 +13,13 @@ Lists both the active and completed tasks associated with a particular process i
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceDetails | `ProcessInstance` | | (**required**) The ID of the process instance to display tasks for. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | string | (**required**): The ID of the process instance to display tasks for |
|
||||
| showRefreshButton | boolean | (default: `true`): Whether to show a refresh button next to the list of tasks to allow this to be updated from the server |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| taskFormCompletedEmitter | Raised when the form associated with an active task is completed from within the component |
|
||||
|
||||
@@ -55,8 +55,6 @@ define custom schema in the app.config.json as shown below json format.
|
||||
| presetColumn | string | | The presetColumn of the custom schema to fetch. |
|
||||
| state | Define state of the processes. Possible values are `running`, `completed` and `all` | | |
|
||||
| sort | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` | | |
|
||||
| page | number | 0 | The page of the tasks to fetch. |
|
||||
| size | number | 25 | The number of tasks to fetch. |
|
||||
| schemaColumn | List of columns to display in the process instances datatable (see the [Details](#details) section below) | | |
|
||||
|
||||
### Events
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Rating component
|
||||
# ADF Rating component
|
||||
|
||||
Allows a user to add ratings to an item.
|
||||
|
||||
@@ -14,15 +14,15 @@ Allows a user to add ratings to an item.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | Identifier of the node to apply the rating to. |
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| nodeId | string | | The identifier of a node |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| changeVote | `EventEmitter<{}>` | Emitted when the "vote" gets changed. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| changeVote | Raised when vote gets changed |
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@@ -16,23 +16,24 @@ Displays a input text which shows find-as-you-type suggestions.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| expandable | `boolean` | `true` | Toggles whether to use an expanding search control. If false then a regular input is used. |
|
||||
| highlight | `boolean` | `false` | Toggles highlighting of the search term in the results. |
|
||||
| inputType | `string` | `'text'` | Type of the input field to render, e.g. "search" or "text" (default). |
|
||||
| autocomplete | `boolean` | `false` | Toggles auto-completion of the search input field. |
|
||||
| liveSearchEnabled | `boolean` | `true` | Toggles "find-as-you-type" suggestions for possible matches. |
|
||||
| liveSearchMaxResults | `number` | `5` | Maximum number of results to show in the live search. |
|
||||
| customQueryBody | `QueryBody` | | |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| searchTerm | string | | Search term to pre-populate the field with |
|
||||
| inputType | string | "text" | Type of the input field to render, e.g. "search" or "text" (default) |
|
||||
| autocomplete | boolean | true | Whether the browser should offer field auto-completion for the input field to the user. |
|
||||
| highlight | boolean | false | Use the true value if you want to see the searched word highlighted. |
|
||||
| expandable | boolean | true | Whether to use an expanding search control, if false then a regular input is used. |
|
||||
| liveSearchEnabled | boolean | true | Whether find-as-you-type suggestions should be offered for matching content items. Set to false to disable. |
|
||||
| liveSearchMaxResults | number | 5 | Maximum number of results to show in the live search. |
|
||||
| customQueryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](search-configuration.interface.md) |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| submit | `EventEmitter<any>` | Emitted when the search is submitted pressing ENTER button. The search term is provided as value of the event. |
|
||||
| searchChange | `EventEmitter<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then the term is truncated to an empty string. |
|
||||
| optionClicked | `EventEmitter<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| searchChange | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then the term is truncated to an empty string. |
|
||||
| submit | Emitted when the search is submitted pressing ENTER button. The search term is provided as value of the event. |
|
||||
| optionClicked | Emitted when a file item from the list of find-as-you-type results is selected |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
+10
-12
@@ -13,21 +13,19 @@ Searches items for supplied search terms.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| displayWith | `(value: any) => string` | `null` | Function that maps an option's value to its display value in the trigger. |
|
||||
| maxResults | `number` | `20` | Maximum number of results to show in the search. |
|
||||
| skipResults | `number` | `0` | Number of results to skip from the results pagination. |
|
||||
| queryBody | `QueryBody` | | |
|
||||
| searchTerm | `string` | `''` | Search term to use when executing the search. Updating this value will run a new search and update the results. |
|
||||
| classList | `string` | | CSS class for display. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| searchTerm | string | | Search term to use when executing the search. Updating this value will run a new search and update the results |
|
||||
| maxResults | number | 20 | Maximum number of results to show in the search. |
|
||||
| skipResults | number | 0 | Number of results to skip from the results pagination. |
|
||||
| displayWith | function | | Function that maps an option's value to its display value in the trigger |
|
||||
| queryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](search-configuration.interface.md) |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| resultLoaded | `EventEmitter<NodePaging>` | Emitted when search results have fully loaded. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| resultLoaded | Emitted when search results have fully loaded |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -24,15 +24,15 @@ Displays a sidebar-action menu information panel.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | | The title of the sidebar action. |
|
||||
| expanded | `boolean` | | Toggle the sidebar action menu on expand. |
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| title | string | null | The title of the Sidebar action |
|
||||
| expanded | boolean | false | Toggle the sidebar action menu on expand.
|
||||
## Details
|
||||
|
||||
As the name suggests, this is basically just a layout with CSS styling. There are three regions where you can add your own content, as shown in the example:
|
||||
|
||||
- sidebar-menu-title-icon
|
||||
- sidebar-menu-options
|
||||
- sidebar-menu-expand-icon
|
||||
- sidebar-menu-title-icon
|
||||
- sidebar-menu-options
|
||||
- sidebar-menu-expand-icon
|
||||
|
||||
|
||||
@@ -15,13 +15,13 @@ Displays a dropdown menu to show and interact with the sites of the current user
|
||||
### Properties
|
||||
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| --- | --- | --- | --- |
|
||||
| hideMyFiles | boolean | false | Hide the "My Files" option added to the list by default |
|
||||
| siteList | [SitePaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. |
|
||||
| placeholder | string | 'DROPDOWN.PLACEHOLDER_LABEL' | The placeholder text/the key from translation files for the placeholder text to be shown by default |
|
||||
| placeholder | string | 'DROPDOWN.PLACEHOLDER_LABEL' | The placeholder text/the key from translation files for the placeholder text to be shown by default|
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Returned Type | Description |
|
||||
| ---- | ------------- | ----------- |
|
||||
| change | [SiteModel](site.model.md) | emitted when user selects a site. When default option is selected an empty model is emitted |
|
||||
| --- | --- | --- |
|
||||
| change | [SiteModel](site.model.md) | emitted when user selects a site. When default option is selected an empty model is emitted |
|
||||
|
||||
@@ -15,46 +15,19 @@ Displays the Start Form for a process.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processDefinitionId | `string` | | Definition ID of the process to start. |
|
||||
| processId | `string` | | Process ID of the process to start. |
|
||||
| showOutcomeButtons | `boolean` | `true` | Should form outcome buttons be shown? |
|
||||
| showRefreshButton | `boolean` | `true` | Should the refresh button be shown? |
|
||||
| readOnlyForm | `boolean` | `false` | Is the form read-only (ie, can't be edited)? |
|
||||
| form | `FormModel` | | Underlying form model instance. |
|
||||
| taskId | `string` | | Task id to fetch corresponding form and values. |
|
||||
| nodeId | `string` | | Content Services node ID for the form metadata. |
|
||||
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
||||
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
||||
| saveMetadata | `boolean` | `false` | Toggle saving of form metadata. |
|
||||
| data | `FormValues` | | Custom form values map to be used with the rendered form. |
|
||||
| path | `string` | | Path of the folder where the metadata will be stored. |
|
||||
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
|
||||
| showTitle | `boolean` | `true` | Toggle rendering of the form title. |
|
||||
| showCompleteButton | `boolean` | `true` | Toggle rendering of the `Complete` outcome button. |
|
||||
| disableCompleteButton | `boolean` | `false` | If true then the `Complete` outcome button is shown but it will be disabled. |
|
||||
| disableStartProcessButton | `boolean` | `false` | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
||||
| showSaveButton | `boolean` | `true` | Toggle rendering of the `Save` outcome button. |
|
||||
| showDebugButton | `boolean` | `false` | Toggle debug options. |
|
||||
| readOnly | `boolean` | `false` | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggle rendering of the `Refresh` button. |
|
||||
| showValidationIcon | `boolean` | `true` | Toggle rendering of the validation icon next to the form title. |
|
||||
| fieldValidators | `FormFieldValidator[]` | `[]` | Contains a list of form field validator instances. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| processDefinitionId | string | | Definition ID of the process to start. |
|
||||
| processId | string | | Process ID of the process to start. |
|
||||
| showOutcomeButtons | boolean | true | Should form outcome buttons be shown? |
|
||||
| showRefreshButton | boolean | true | |
|
||||
| readOnlyForm | boolean | false | Is the form read-only (ie, can't be edited)? |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| outcomeClick | `EventEmitter<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
|
||||
| formContentClicked | `EventEmitter<ContentLinkModel>` | Emitted when a field of the form is clicked. |
|
||||
| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||
| formCompleted | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||
| formContentClicked | `EventEmitter<ContentLinkModel>` | Emitted when form content is clicked. |
|
||||
| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
|
||||
| formDataRefreshed | `EventEmitter<FormModel>` | Emitted when form values are refreshed due to a data property change. |
|
||||
| executeOutcome | `EventEmitter<FormOutcomeEvent>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
|
||||
| onError | `EventEmitter<any>` | Emitted when any error occurs. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| outcomeClick | Emitted when the user clicks one of the outcome buttons that completes the form. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -15,21 +15,21 @@ Starts a process.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| ---- | -- | ----------- |
|
||||
| appId | `number` | (optional): Limit the list of processes which can be started to those contained in the specified app |
|
||||
| name | `string` | (optional) name to assign to the current process |
|
||||
| processDefinitionName | `string` | (optional) definition name of the process to start |
|
||||
| variables | `ProcessInstanceVariable[]` | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
|
||||
| variables | `ProcessInstanceVariable[]` |Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
|
||||
| values | `FormValues` | Parameter to pass form field values in the start form if is associated |
|
||||
| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
|
||||
| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| ---- | -- | --------- |
|
||||
| start | `EventEmitter<ProcessInstance>` | Emitted when the process starts |
|
||||
| cancel | `EventEmitter<ProcessInstance>` | Emitted when the process is canceled |
|
||||
| error | `EventEmitter<ProcessInstance>` | Emitted when the start process operation fails |
|
||||
| cancel | `EventEmitter<ProcessInstance>` | Emitted when the process is canceled |
|
||||
| error | `EventEmitter<ProcessInstance>` | Emitted when the start process operation fails |
|
||||
|
||||
### Start a process with a default name and pre-selected process definition name
|
||||
|
||||
@@ -53,6 +53,7 @@ If your app has more than one process definition, with the property processDefin
|
||||
|
||||
With the property processDefinitionName you can select as dropdown default value your PROCESS_DEFINITION_NAME.
|
||||
|
||||
|
||||
### Custom data example
|
||||
|
||||
Here is an example of how to pass in form field values to initialize the start form that has been
|
||||
|
||||
@@ -14,14 +14,14 @@ Creates/Starts new task for the specified app
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appId | `number` | | (required) The id of the app. |
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| appId | string | (**required**): The id of the app. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<any>` | Emitted when the task is successfully created. |
|
||||
| cancel | `EventEmitter<void>` | Emitted when the cancel button is clicked by the user. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| success | Raised when the task is successfully created |
|
||||
| cancel | Raised when the cancel button is pressed by the user |
|
||||
| error | Raised if there is an error during task creation |
|
||||
|
||||
@@ -14,14 +14,6 @@ Shows available actions for tags.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | The identifier of a node. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| successAdd | `EventEmitter<any>` | Emitted when a tag is added successfully. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| result | `EventEmitter<{}>` | Emitted when an action is chosen. |
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| nodeId | string | | The identifier of a node |
|
||||
|
||||
@@ -4,14 +4,6 @@ Shows tags for an item.
|
||||
|
||||
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| result | `EventEmitter<{}>` | Emitted when a tag is selected. |
|
||||
|
||||
## See Also
|
||||
|
||||
- [Tag service](tag.service.md)
|
||||
|
||||
@@ -14,12 +14,6 @@ Shows tags for a node.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | The identifier of a node. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| results | `EventEmitter<{}>` | Emitted when a tag is selected. |
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| nodeId | string | | The identifier of a node |
|
||||
|
||||
@@ -12,14 +12,13 @@ Displays attached documents on a specified task.
|
||||
(attachmentClick)="YOUR_HANDLER">
|
||||
</adf-task-attachment-list>
|
||||
```
|
||||
|
||||
If the List is empty, a default no content template is displayed.
|
||||
|
||||
|
||||
|
||||
### How to Add Drag and Drop Functionality
|
||||
|
||||
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom _no content template_ as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
||||
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom *no content template* as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
||||
|
||||
```html
|
||||
<adf-upload-drag-area
|
||||
@@ -42,7 +41,6 @@ import { UploadService } from '@alfresco/adf-core';
|
||||
import { TaskUploadService } from '@alfresco/adf-process-services';
|
||||
|
||||
Make sure to override the UploadService with the TaskUploadService
|
||||
|
||||
```ts
|
||||
@Component({
|
||||
selector: 'my-custom-task-attachment',
|
||||
@@ -63,15 +61,15 @@ If the List is empty, the custom no-content template we passed is displayed.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | | (**required**) The ID of the task to display. |
|
||||
| disabled | `boolean` | `false` | Disable/Enable read only mode for attachement list. |
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| taskId | string | (**required**): The ID of the task to display |
|
||||
| disabled | boolean | false | Disable/Enable read only mode for attachement list |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| attachmentClick | `EventEmitter<{}>` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a Blob representing the clicked object. |
|
||||
| success | `EventEmitter<{}>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs while fetching the attachments. |
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| attachmentClick | Raised when the attachment double clicked or selected view option from context menu by the user from within the component and return a Blob obj of the object clicker|
|
||||
| success | Raised when the attachment list fetch all the attach and return a list of attachments |
|
||||
| error | Raised when the attachment list is not able to fetch the attachments for example network error |
|
||||
|
||||
@@ -12,36 +12,33 @@ Shows the details of the task id passed in input
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| debugMode | `boolean` | `false` | Toggles debug mode. |
|
||||
| taskId | `string` | | (**required**) The id of the task whose details we are asking for. |
|
||||
| showNextTask | `boolean` | `true` | Automatically renders the next task when the current one is completed. |
|
||||
| showHeader | `boolean` | `true` | Toggles task details Header component. |
|
||||
| showHeaderContent | `boolean` | `true` | Toggles collapsed/expanded state of the Header component. |
|
||||
| showInvolvePeople | `boolean` | `true` | Toggles `Involve People` feature for the Header component. |
|
||||
| showComments | `boolean` | `true` | Toggles `Comments` feature for the Header component. |
|
||||
| showChecklist | `boolean` | `true` | Toggles `Checklist` feature for the Header component. |
|
||||
| showFormTitle | `boolean` | `true` | Toggles rendering of the form title. |
|
||||
| showFormCompleteButton | `boolean` | `true` | Toggles rendering of the `Complete` outcome button. |
|
||||
| showFormSaveButton | `boolean` | `true` | Toggles rendering of the `Save` outcome button. |
|
||||
| readOnlyForm | `boolean` | `false` | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
|
||||
| showFormRefreshButton | `boolean` | `true` | Toggles rendering of the `Refresh` button. |
|
||||
| fieldValidators | `any[]` | `[]` | Field validators for use with the form. |
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| taskId | string | | (**required**) The id of the task details that we are asking for. |
|
||||
| showNextTask | boolean | true | Automatically render the next one, when the task is completed. |
|
||||
| showFormTitle | boolean | true | Toggle rendering of the form title. |
|
||||
| readOnlyForm | boolean | false | Toggle readonly state of the form. Enforces all form widgets render readonly if enabled. |
|
||||
| showFormRefreshButton | boolean | true | Toggle rendering of the `Refresh` button. |
|
||||
| showFormSaveButton | boolean | true| Toggle rendering of the `Save` outcome button. |
|
||||
| showFormCompleteButton | boolean | true | Toggle rendering of the Form `Complete` outcome button |
|
||||
| peopleIconImageUrl | string | | Define a custom people icon image |
|
||||
| showHeader | boolean | true | Toggle task details Header component |
|
||||
| showHeaderContent | boolean | true | Toggle collapsed/expanded state of the Header component |
|
||||
| showInvolvePeople | boolean | true | Toggle `Involve People` feature for Header component |
|
||||
| showComments | boolean | true | Toggle `Comments` feature for Header component |
|
||||
| showChecklist | boolean | true | Toggle `Checklist` feature for Header component |
|
||||
| fieldValidators | FormFieldValidator[] | [] | Field validators for use with the form. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| formSaved | `EventEmitter<any>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||
| formCompleted | `EventEmitter<any>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||
| formContentClicked | `EventEmitter<any>` | Emitted when the form field content is clicked. |
|
||||
| formLoaded | `EventEmitter<any>` | Emitted when the form is loaded or reloaded. |
|
||||
| taskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a checklist task is created. |
|
||||
| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| executeOutcome | `EventEmitter<any>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
|
||||
| assignTask | `EventEmitter<void>` | Emitted when a task is assigned. |
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| formLoaded | Raised when form is loaded or reloaded. |
|
||||
| formSaved | Raised when form is submitted with `Save` or custom outcomes. |
|
||||
| formCompleted | Raised when form is submitted with `Complete` outcome. |
|
||||
| taskCreated | Raised when a checklist task is created. |
|
||||
| executeOutcome | Raised when any outcome is executed, default behaviour can be prevented via `event.preventDefault()` |
|
||||
| error | Raised at any error |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -10,20 +10,22 @@ Shows all available filters.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| filterParam | `FilterParamsModel` | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. |
|
||||
| appId | `number` | | Display filters available to the current user for the application with the specified ID. |
|
||||
| appName | `string` | | Display filters available to the current user for the application with the specified name. |
|
||||
| hasIcon | `boolean` | `true` | Toggles display of the filter's icon. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterParam | [FilterParamsModel](#filterparamsmodel) | The params to filter the task filter. If there is no match the default one (first filter of the list) is selected |
|
||||
| appId | string | Display filters available to the current user for the application with the specified ID. |
|
||||
| `appName` | string | Display filters available to the current user for the application with the specified name. |
|
||||
| `hasIcon` | boolean | Toggle to show or not the filter's icon. |
|
||||
|
||||
If both `appId` and `appName` are specified then `appName` will take precedence and `appId` will be ignored.
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterClick | `EventEmitter<FilterRepresentationModel>` | Emitted when a filter in the list is clicked. |
|
||||
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs during loading. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| filterClick | Raised when the filter in the list is clicked |
|
||||
| success | Raised when the list is loaded |
|
||||
| error | Raised if there is an error during the loading |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -14,40 +14,22 @@ Shows all the information related to a task.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| formName | `string` | `null` | The name of the form. |
|
||||
| taskDetails | `TaskDetailsModel` | | (required) Details related to the task. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| taskDetails | [TaskDetailsModel](task-details.model.md) | | (**required**) Details related to the task. |
|
||||
| formName | string | | The name of the form. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| claim | `EventEmitter<any>` | Emitted when the task is claimed. |
|
||||
| unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, requeued). |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| claim | Raised when the task is claimed. |
|
||||
| unclaim | Raised when the task is unclaimed (requeued). |
|
||||
|
||||
## Details
|
||||
|
||||
The purpose of the component is to populate the local variable called `properties` (array of CardViewModel), with all the information that we want to display.
|
||||
|
||||
## Customise the property showed
|
||||
By default all the property are showed :
|
||||
***assignee***, ***status***, ***priority***, ***dueDate***, ***category***, ***parentName***, ***created-by***, ***created***, ***id***, ***description***, ***formName***.
|
||||
|
||||
It is possible to customise the showed property via the "app.config.json".
|
||||
This is how the configuration looks like:
|
||||
|
||||
```json
|
||||
|
||||
"adf-task-header": {
|
||||
"presets": {
|
||||
"properties" : [ "assignee", "status", "priority", "parentName"]
|
||||
}
|
||||
},
|
||||
|
||||
```
|
||||
In this way only the listed property will be showed.
|
||||
|
||||
## See also
|
||||
|
||||
- [Task Details model](task-details.model.md)
|
||||
|
||||
@@ -134,7 +134,7 @@ You can also use both HTML-based and app.config.json custom schema declaration a
|
||||
| processInstanceId | string | | The processInstanceId of the process. |
|
||||
| presetColumn | string | | The presetColumn of the custom schema to fetch. |
|
||||
| page | number | 0 | The page of the tasks to fetch. |
|
||||
| size | number | 25 | The number of tasks to fetch. |
|
||||
| size | number | 5 | The number of tasks to fetch. |
|
||||
| assignment | string | | The assignment of the process. <ul>Possible values are: <li>assignee : where the current user is the assignee</li> <li>candidate: where the current user is a task candidate </li><li>group_x: where the task is assigned to a group where the current user is a member of.</li> <li>no value: where the current user is involved</li> </ul> |
|
||||
| selectionMode | string | 'single' | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
| multiselect | boolean | false | Toggles multiple row selection, renders checkboxes at the beginning of each row |
|
||||
|
||||
@@ -19,10 +19,10 @@ Simple container for headers, titles, actions and breadcrumbs.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | `''` | Toolbar title. |
|
||||
| color | `string` | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| title | string | | Toolbar title |
|
||||
| color | string | | Toolbar color, can be changed to empty value (default), `primary`, `accent` or `warn`. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
+18
-104
@@ -2,117 +2,35 @@
|
||||
|
||||
Supports localisation.
|
||||
|
||||
## Methods
|
||||
|
||||
`addTranslationFolder(name: string = '', path: string = '')`<br/>
|
||||
Adds a new folder of translation source files.
|
||||
|
||||
`use(lang: string): Observable<any>`<br/>
|
||||
Sets the target language for translations.
|
||||
|
||||
`get(key: string|Array<string>, interpolateParams?: Object): Observable<string|any>`<br/>
|
||||
Gets the translation for the supplied key.
|
||||
|
||||
`instant(key: string | Array<string>, interpolateParams?: Object): string | any`<br/>
|
||||
Directly returns the translation for the supplied key.
|
||||
|
||||
## Details
|
||||
|
||||
In the `get` and `instant` methods, the `interpolateParams` parameter supplies
|
||||
interpolation strings for keys that include them. For example, in the standard
|
||||
`en.json`, the `CORE.PAGINATION.ITEMS_RANGE` key is defined as:
|
||||
|
||||
"Showing {{ range }} of {{ total }}"
|
||||
|
||||
The `range` and `total` interpolations are supplied to the `get` method using
|
||||
an object with fields of the same name:
|
||||
|
||||
```ts
|
||||
this.trans.get(
|
||||
"CORE.PAGINATION.ITEMS_RANGE",
|
||||
{
|
||||
range: "1..10",
|
||||
total: "122"
|
||||
}
|
||||
).subscribe(translation => {
|
||||
this.translatedText = translation;
|
||||
});
|
||||
```
|
||||
|
||||
### Registering translation sources
|
||||
|
||||
To supply your own set of translation source files, you
|
||||
first need to create a subfolder for them within your application's
|
||||
`assets` folder. The folder can have any name you like but it must also have
|
||||
a sub-folder called `i18n` where the translation lists will be stored. So, the
|
||||
general format of the path to this folder will be:
|
||||
In order to enable localisation support you will need to create a `/resources/i18n/en.json` file
|
||||
and register its parent `i18n` folder with your component or application module.
|
||||
|
||||
`<app>/src/assets/my-translations/i18n`
|
||||
|
||||
If you wanted English and French translations then you would copy the built-in
|
||||
`en.json` and `fr.json` files into the `i18n` folder and add your new keys:
|
||||
|
||||
// en.json
|
||||
|
||||
...
|
||||
"WELCOME_MESSAGE": "Welcome!"
|
||||
...
|
||||
|
||||
// fr.json
|
||||
...
|
||||
"WELCOME_MESSAGE": "Bienvenue !"
|
||||
...
|
||||
|
||||
To enable the new translations in your app, you also need to register them in your
|
||||
`app.module.ts` file. Import `TRANSLATION_PROVIDER` and add the path of your
|
||||
translations folder to the `providers`:
|
||||
For example:
|
||||
|
||||
```ts
|
||||
// Other imports...
|
||||
|
||||
import { TRANSLATION_PROVIDER } from "@alfresco/adf-core";
|
||||
|
||||
...
|
||||
import { TRANSLATION_PROVIDER } from '@alfresco/adf-core';
|
||||
|
||||
@NgModule({
|
||||
imports: [
|
||||
...
|
||||
],
|
||||
declarations: [
|
||||
...
|
||||
],
|
||||
providers: [
|
||||
{
|
||||
provide: TRANSLATION_PROVIDER,
|
||||
multi: true,
|
||||
useValue: {
|
||||
name: 'my-translations',
|
||||
source: 'assets/my-translations'
|
||||
}
|
||||
}
|
||||
...
|
||||
providers: [
|
||||
...
|
||||
{
|
||||
provide: TRANSLATION_PROVIDER,
|
||||
multi: true,
|
||||
useValue: {
|
||||
name: 'ng2-alfresco-core',
|
||||
source: 'assets/ng2-alfresco-core'
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
```
|
||||
|
||||
You can now use your new keys in your component:
|
||||
|
||||
```ts
|
||||
...
|
||||
ngOnInit() {
|
||||
this.trans.use("fr");
|
||||
|
||||
this.trans.get("WELCOME_MESSAGE").subscribe(translation => {
|
||||
this.translatedText = translation;
|
||||
});
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
The new translation files completely replace the built-in ones.
|
||||
If you want to continue using the built-in keys then you must add your new
|
||||
keys to copies of the existing files.
|
||||
|
||||
Note: the `source` property points to the web application root. Ensure you have
|
||||
webpack correctly set up to copy all the i18n files at compile time.
|
||||
Note: the `source` property points to the web application root, please ensure you have webpack settings to copy all the i18n files at compile time.
|
||||
|
||||
```text
|
||||
index.html
|
||||
@@ -120,7 +38,7 @@ assets/ng2-alfresco-core/i18n/en.json
|
||||
...
|
||||
```
|
||||
|
||||
You can register as many entries as you like.
|
||||
You can register as many entries as you would like.
|
||||
|
||||
### Switching languages
|
||||
|
||||
@@ -138,7 +56,3 @@ class MyComponent {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [Internationalization](internationalization.md)
|
||||
|
||||
@@ -18,26 +18,24 @@ Activates a file upload.
|
||||
|
||||
### 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. |
|
||||
| acceptedFilesType | `string` | `'*'` | List of allowed file extensions, for example: ".jpg,.gif,.png,.svg". |
|
||||
| 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. |
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| disabled | boolean | false | Toggle component disabled state if there is no node permission checking |
|
||||
| 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" |
|
||||
| maxFilesSize | number | | if defined allow to upload files only with this max file size. the size of a file is in bytes |
|
||||
| rootFolderId | string | '-root-' | 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 |
|
||||
| tooltip | string | | Custom tooltip |
|
||||
|
||||
### 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. |
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| success | Raised when the file is uploaded |
|
||||
| permissionEvent | permissionEvent that is raised when the delete permission is missing |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -10,16 +10,16 @@ Shows user information.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| ecmBackgroundImage | `string` | `'./assets/images/ecm-background.png'` | Custom path for the background banner image for ACS users. |
|
||||
| bpmBackgroundImage | `string` | `'./assets/images/bpm-background.png'` | Custom path for the background banner image for APS users. |
|
||||
| menuPositionX | `string` | `'after'` | Custom choice for opening the menu at the bottom. Can be `before` or `after`. |
|
||||
| menuPositionY | `string` | `'below'` | Custom choice for opening the menu at the bottom. Can be `above` or `below`. |
|
||||
| showName | `boolean` | `true` | Shows/hides the username next to the user info button. |
|
||||
| namePosition | `string` | `'right'` | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| ecmBackgroundImage | string | (alfresco image) | Custom path for the background banner image for ECM users |
|
||||
| bpmBackgroundImage | string | (alfresco image) | Custom path for the background banner image for BPM users |
|
||||
| menuPositionX | string | | Custom choice for opening the menu bottom : `before` or `after` |
|
||||
| menuPositionY | string | | Custom choice for opening the menu bottom : `above` or `below` |
|
||||
| namePosition | string | `right` | When the username is showed this define his position relatively the user info button. It can be two values : `right` or `left` |
|
||||
| showName | boolean | true | Show/Hide the username next the user info button |
|
||||
|
||||
## Details
|
||||
|
||||
This will show a round icon with user and on click some user information.
|
||||
If user is logged in with both ACS and APS, the ACS image will be shown.
|
||||
If user is logged in with ECM and BPM the ECM image will be shown.
|
||||
|
||||
@@ -10,9 +10,9 @@ Displays the version history of a node in a [Version Manager component](version-
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| id | `string` | | ID of the node whose version history you want to display. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| id | string | The node id you want to see the version history of. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -14,9 +14,9 @@ Displays the version history of a node with the ability to upload a new version.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| node | `MinimalNodeEntryEntity` | | The node whose version history you want to manage. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| node | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | The node you want to manage the version history of. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
+32
-91
@@ -46,55 +46,34 @@ Using with file url:
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| urlFile | `string` | `''` | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. |
|
||||
| urlFileViewer | `string` | `null` | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. |
|
||||
| blobFile | `Blob` | | Loads a Blob File |
|
||||
| fileNodeId | `string` | `null` | Node Id of the file to load. |
|
||||
| sharedLinkId | `string` | `null` | Shared link id (to display shared file). |
|
||||
| overlayMode | `boolean` | `false` | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. |
|
||||
| showViewer | `boolean` | `true` | Hide or show the viewer |
|
||||
| showToolbar | `boolean` | `true` | Hide or show the toolbar |
|
||||
| displayName | `string` | | Specifies the name of the file when it is not available from the URL. |
|
||||
| allowGoBack | `boolean` | `true` | Allows `back` navigation |
|
||||
| allowDownload | `boolean` | `true` | Toggles downloading. |
|
||||
| allowPrint | `boolean` | `false` | Toggles printing. |
|
||||
| allowShare | `boolean` | `false` | Toggles sharing. |
|
||||
| allowFullScreen | `boolean` | `true` | Toggles the 'Full Screen' feature. |
|
||||
| allowNavigate | `boolean` | `false` | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. |
|
||||
| canNavigateBefore | `boolean` | `true` | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. |
|
||||
| canNavigateNext | `boolean` | `true` | Toggles the next (">") button. Requires `allowNavigate` to be enabled. |
|
||||
| allowSidebar | `boolean` | `false` | Toggles the sidebar. |
|
||||
| showSidebar | `boolean` | `false` | Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. |
|
||||
| sidebarPosition | `string` | `'right'` | The position of the sidebar. Can be `left` or `right`. |
|
||||
| sidebarTemplate | `TemplateRef<any>` | `null` | The template for the sidebar. The template context contains the loaded node data. |
|
||||
| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). |
|
||||
| fileName | `string` | | Content filename. |
|
||||
| downloadUrl | `string` | `null` | URL to download. |
|
||||
| maxRetries | `number` | `5` | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. |
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| fileNodeId | string | | Node Id of the file to load |
|
||||
| sharedLinkId | string | | Shared link id (to display shared file) |
|
||||
| urlFile | string | | If you want to load an external file that does not come from ECM you can use this Url where to load the file |
|
||||
| urlFileViewer | string | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. |
|
||||
| urlBlob | Blob | | If you want to load a Blob File |
|
||||
| overlayMode | boolean | false | If `true` show the Viewer full page over the present content otherwise will fit the parent div |
|
||||
| showViewer | boolean | true | Hide or show the viewer |
|
||||
| showToolbar | boolean | true | Hide or show the toolbar |
|
||||
| displayName | string | | You can specify the name of the file |
|
||||
| allowGoBack | boolean | true | Allow `back` navigation |
|
||||
| allowDownload | boolean | true | Toggle download feature |
|
||||
| allowPrint | boolean | false | Toggle printing feature |
|
||||
| allowShare | boolean | false | Toggle sharing feature |
|
||||
| allowSidebar | boolean | false | Toggle sidebar feature |
|
||||
| showSidebar | boolean | false | Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. |
|
||||
| sidebarPosition | string | right | The position of the sidebar. Can be `left` or `right`. |
|
||||
| sidebarTemplate | TemplateRef<any> | null | The template intended to be used as a sidebar. The template context contains the loaded node data. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| goBack | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Back' button. |
|
||||
| download | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Download' button. |
|
||||
| print | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Print' button. |
|
||||
| share | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Share' button. |
|
||||
| showViewerChange | `EventEmitter<boolean>` | Emitted when the viewer is shown or hidden. |
|
||||
| extensionChange | `EventEmitter<string>` | Emitted when the filename extension changes. |
|
||||
| navigateBefore | `EventEmitter<{}>` | Emitted when user clicks 'Navigate Before' ("<") button. |
|
||||
| navigateNext | `EventEmitter<{}>` | Emitted when user clicks 'Navigate Next' (">") button. |
|
||||
|
||||
### Keyboard shortcuts
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| Esc | Close the viewer (overlay mode only). |
|
||||
| Left | Invoke 'Navigate before' action. |
|
||||
| Right | Invoke 'Navigate next' action. |
|
||||
| Ctrl+F | Activate full-screen mode. |
|
||||
| Name | Argument Type | Cancelable | Description |
|
||||
| ---- | ------------- | ---------- | ----------- |
|
||||
| goBack | any | Yes | Raised when user clicks the 'Back' button. |
|
||||
| download | any | Yes | Raised when user clicks the 'Download' button. |
|
||||
| print | any | Yes | Raised when user clicks the 'Print' button. |
|
||||
| share | any | Yes | Raised when user clicks the 'Share' button. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -149,53 +128,15 @@ You can provide custom file parameters, for example a value for the `mimeType` o
|
||||
|
||||
### Supported file formats
|
||||
|
||||
The Viewer component consists of separate Views that handle particular types of type families based on either a file extension or a mime type:
|
||||
| Type | Extension |
|
||||
| ---- | --------- |
|
||||
| Media | wav, Mp3, Mp4, WebM, Ogv |
|
||||
| Images | png, jpg, jpeg, gif, bmp |
|
||||
| Text | pdf, txt |
|
||||
|
||||
- PDF View
|
||||
- application/pdf
|
||||
- \*.pdf
|
||||
- Image View
|
||||
- image/png
|
||||
- image/jpeg
|
||||
- image/gif
|
||||
- image/bmp
|
||||
- image/svg+xml
|
||||
- \*.png
|
||||
- \*.jpg
|
||||
- \*.jpeg
|
||||
- \*.gif
|
||||
- \*.bpm
|
||||
- \*.svg
|
||||
- Text View
|
||||
- text/plain
|
||||
- text/csv
|
||||
- text/xml
|
||||
- text/html
|
||||
- application/x-javascript
|
||||
- \*.txt
|
||||
- \*.xml
|
||||
- \*.js
|
||||
- \*.html
|
||||
- \*.json
|
||||
- \*.ts
|
||||
- Media View
|
||||
- video/mp4
|
||||
- video/webm
|
||||
- video/ogg
|
||||
- audio/mpeg
|
||||
- audio/ogg
|
||||
- audio/wav
|
||||
- \*.wav
|
||||
- \*.mp4
|
||||
- \*.mp3
|
||||
- \*.webm
|
||||
- \*.ogg
|
||||
### PDF Conversion
|
||||
|
||||
### Content Renditions
|
||||
|
||||
For those extensions and mime types that cannot be natively displayed in the browser, the Viewer will try to fetch corresponding rendition by utilising the [renditions service api](https://community.alfresco.com/docs/DOC-5879-rendition-service).
|
||||
|
||||
For the full list of supported types please refer to: [File types that support preview and thumbnail generation](http://docs.alfresco.com/5.2/references/valid-transformations-preview.html).
|
||||
For unsupported extensions or mime types the viewer will try to fetch PDF rendition utilising the [renditions service api](https://community.alfresco.com/docs/DOC-5879-rendition-service)
|
||||
|
||||
### Configuring PDF.js library
|
||||
|
||||
|
||||
+15
-11
@@ -42,20 +42,24 @@ export class AppComponent {
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). |
|
||||
| scriptArgs | `any` | | Arguments to pass to the webscript. |
|
||||
| showData | `boolean` | `true` | Toggles whether to show or hide the data. |
|
||||
| contextRoot | `string` | `'alfresco'` | Path where the application is deployed |
|
||||
| servicePath | `string` | `'service'` | Path that the webscript service is mapped to. |
|
||||
| contentType | `string` | `'TEXT'` | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| scriptPath | string | | (**mandatory**) path to Web Script (as defined by Web Script) |
|
||||
| scriptArgs | Object | | arguments to pass to Web Script |
|
||||
| contextRoot | string | | path where application is deployed |
|
||||
| scriptPath | string | alfresco | path to Web Script (as defined by Web Script) |
|
||||
| contentType | string | service | path where Web Script service is mapped default value |
|
||||
| contentType | string | TEXT | how to handle the data received from the web script JSON , HTML , DATATABLE or TEXT |
|
||||
| showData | boolean | true | render the webscript data |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<{}>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application |
|
||||
|
||||
**contentType** {string}
|
||||
**_data_** {string} data containing the plain value you get from the webscipt as an output parameter
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -1,106 +0,0 @@
|
||||
{
|
||||
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
|
||||
"project": {
|
||||
"name": "myapp"
|
||||
},
|
||||
"apps": [
|
||||
{
|
||||
"name" : "dist",
|
||||
"root": "src",
|
||||
"outDir": "dist",
|
||||
"assets": [
|
||||
"assets",
|
||||
"favicon.ico",
|
||||
"app.config.json",
|
||||
"versions.json",
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../resources",
|
||||
"output": "./resources"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../node_modules/@alfresco/adf-core/prebuilt-themes",
|
||||
"output": "./assets/prebuilt-themes"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../node_modules/@alfresco/adf-core/bundles/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../node_modules/@alfresco/adf-insights/bundles/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../node_modules/@alfresco/adf-process-services/bundles/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{
|
||||
"glob": "**/*",
|
||||
"input": "../node_modules/@alfresco/adf-content-services/bundles/assets",
|
||||
"output": "./assets/"
|
||||
},
|
||||
{ "glob": "pdf.worker.js", "input": "../node_modules/pdfjs-dist/build", "output": "./" }
|
||||
],
|
||||
"index": "index.html",
|
||||
"main": "main.ts",
|
||||
"polyfills": "polyfills.ts",
|
||||
"test": "test.ts",
|
||||
"tsconfig": "tsconfig.app.json",
|
||||
"testTsconfig": "tsconfig.spec.json",
|
||||
"prefix": "app",
|
||||
"styles": [
|
||||
"custom-style.scss"
|
||||
],
|
||||
"stylePreprocessorOptions": {
|
||||
"includePaths": [
|
||||
"../node_modules/"
|
||||
]
|
||||
},
|
||||
"scripts": [
|
||||
"../node_modules/pdfjs-dist/build/pdf.js",
|
||||
"../node_modules/pdfjs-dist/web/pdf_viewer.js",
|
||||
"../node_modules/raphael/raphael.min.js",
|
||||
"../node_modules/moment/min/moment.min.js"
|
||||
],
|
||||
"environmentSource": "environments/environment.ts",
|
||||
"environments": {
|
||||
"dev": "environments/environment.ts",
|
||||
"prod": "environments/environment.prod.ts"
|
||||
}
|
||||
}
|
||||
],
|
||||
"e2e": {
|
||||
"protractor": {
|
||||
"config": "./protractor.conf.js"
|
||||
}
|
||||
},
|
||||
"lint": [
|
||||
{
|
||||
"project": "src/tsconfig.app.json"
|
||||
},
|
||||
{
|
||||
"project": "src/tsconfig.spec.json"
|
||||
},
|
||||
{
|
||||
"project": "e2e/tsconfig.e2e.json"
|
||||
}
|
||||
],
|
||||
"test": {
|
||||
"karma": {
|
||||
"config": "./karma.conf.js"
|
||||
}
|
||||
},
|
||||
"defaults": {
|
||||
"styleExt": "scss",
|
||||
"component": {
|
||||
},
|
||||
"serve": {
|
||||
"proxyConfig": "proxy.conf.json",
|
||||
"port": 4200
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
# Editor configuration, see http://editorconfig.org
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
max_line_length = off
|
||||
trim_trailing_whitespace = false
|
||||
@@ -1,42 +0,0 @@
|
||||
# See http://help.github.com/ignore-files/ for more about ignoring files.
|
||||
|
||||
# compiled output
|
||||
/dist
|
||||
/tmp
|
||||
/out-tsc
|
||||
|
||||
# dependencies
|
||||
/node_modules
|
||||
|
||||
# IDEs and editors
|
||||
/.idea
|
||||
.project
|
||||
.classpath
|
||||
.c9/
|
||||
*.launch
|
||||
.settings/
|
||||
*.sublime-workspace
|
||||
|
||||
# IDE - VSCode
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/extensions.json
|
||||
|
||||
# misc
|
||||
/.sass-cache
|
||||
/connect.lock
|
||||
/coverage
|
||||
/libpeerconnection.log
|
||||
npm-debug.log
|
||||
testem.log
|
||||
/typings
|
||||
|
||||
# e2e
|
||||
/e2e/*.js
|
||||
/e2e/*.map
|
||||
|
||||
# System Files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
@@ -1,19 +0,0 @@
|
||||
dist: trusty
|
||||
sudo: false
|
||||
|
||||
language: node_js
|
||||
node_js:
|
||||
- "8"
|
||||
|
||||
cache:
|
||||
directories:
|
||||
- ./node_modules
|
||||
|
||||
install:
|
||||
- npm install
|
||||
|
||||
script:
|
||||
# Use Chromium instead of Chrome.
|
||||
- export CHROME_BIN=chromium-browser
|
||||
- xvfb-run -a npm run test -- --single-run --no-progress --browser=ChromeNoSandbox
|
||||
#- xvfb-run -a npm run e2e -- --no-progress --config=protractor-ci.conf.js
|
||||
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Denys Vuika
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,56 +0,0 @@
|
||||
# ADF/APS/ACS Application with Angular CLI
|
||||
|
||||
Minimal ready-to-use Angular CLI project template pre-configured with ADF 2.0.0 components.
|
||||
|
||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.5.0
|
||||
|
||||
## Quick start
|
||||
|
||||
```sh
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
## Supported ADF component libraries
|
||||
|
||||
This project has all the existing ADF component libraries already pre-configured.
|
||||
|
||||
The main focus of the project is:
|
||||
|
||||
- ADF integration and setup
|
||||
- Basic demonstration of working components
|
||||
|
||||
## Development server
|
||||
|
||||
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
|
||||
|
||||
### Proxy settings
|
||||
|
||||
The template provides certain proxy settings to allow running web application locally without CORS setup.
|
||||
You can find details in the `proxy.conf.json` file.
|
||||
|
||||
List of URLs being proxied:
|
||||
|
||||
- `/alfresco` -> `http://0.0.0.0:8080`
|
||||
- `/activiti-app` -> `http://0.0.0.0:9999`
|
||||
|
||||
## Code scaffolding
|
||||
|
||||
Run `ng generate component component-name -m app.module` to generate a new component. You can also use `ng generate directive|pipe|service|class|module`.
|
||||
|
||||
## Build
|
||||
|
||||
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
|
||||
|
||||
## Running unit tests
|
||||
|
||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
||||
|
||||
## Running end-to-end tests
|
||||
|
||||
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
|
||||
Before running the tests make sure you are serving the app via `ng serve`.
|
||||
|
||||
## Further help
|
||||
|
||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
|
||||
@@ -1,14 +0,0 @@
|
||||
import { AdfAppPage } from './app.po';
|
||||
|
||||
describe('adf-app App', () => {
|
||||
let page: AdfAppPage;
|
||||
|
||||
beforeEach(() => {
|
||||
page = new AdfAppPage();
|
||||
});
|
||||
|
||||
it('should display toolbar', () => {
|
||||
page.navigateTo();
|
||||
expect(page.getToolbar()).toBeDefined();
|
||||
});
|
||||
});
|
||||
@@ -1,11 +0,0 @@
|
||||
import { browser, by, element } from 'protractor';
|
||||
|
||||
export class AdfAppPage {
|
||||
navigateTo() {
|
||||
return browser.get('/');
|
||||
}
|
||||
|
||||
getToolbar() {
|
||||
return element(by.tagName('adf-toolbar'));
|
||||
}
|
||||
}
|
||||
@@ -1,14 +0,0 @@
|
||||
{
|
||||
"extends": "../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "../out-tsc/e2e",
|
||||
"baseUrl": "./",
|
||||
"module": "commonjs",
|
||||
"target": "es5",
|
||||
"types": [
|
||||
"jasmine",
|
||||
"jasminewd2",
|
||||
"node"
|
||||
]
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user