diff --git a/ng2-components/ng2-activiti-tasklist/README.md b/ng2-components/ng2-activiti-tasklist/README.md index 85f4d1a48f..e0c1db7c25 100644 --- a/ng2-components/ng2-activiti-tasklist/README.md +++ b/ng2-components/ng2-activiti-tasklist/README.md @@ -18,22 +18,19 @@ * [Properties](#properties-2) * [Events](#events-2) * [How filter the activiti apps](#how-filter-the-activiti-apps) -- [ADF Card View](#adf-card-view) - * [Properties](#properties-3) - * [CardViewModel](#cardviewmodel) - [Activiti Filter](#activiti-filter) - * [Properties](#properties-4) + * [Properties](#properties-3) * [Events](#events-3) * [How filter the activiti task filters](#how-filter-the-activiti-task-filters) * [FilterParamsModel](#filterparamsmodel) * [How to create an accordion menu with the task filter](#how-to-create-an-accordion-menu-with-the-task-filter) - [Activiti Checklist Component](#activiti-checklist-component) - * [Properties](#properties-5) + * [Properties](#properties-4) - [Task Attachment List Component](#task-attachment-list-component) - * [Properties](#properties-6) + * [Properties](#properties-5) * [Events](#events-4) - [Create Task Attachment Component](#create-task-attachment-component) - * [Properties](#properties-7) + * [Properties](#properties-6) + [Events](#events-5) - [Build from sources](#build-from-sources) - [NPM scripts](#npm-scripts) @@ -243,42 +240,6 @@ You can use inside the filter one of the following property } ``` -## ADF Card View - -The component shows the [CardViewModel](#cardviewmodel)} object. - -```html - - - -``` - -### Properties - -| Name | Type | Description | -| --- | --- | --- | -| properties | {array[CardViewModel](#cardviewmodel)} | (**required**) The custom view to render | - -### CardViewModel - -```json -{ - "label": "string", - "value": "any", - "format": "string", - "default": "string" -} -``` - -| Name | Type | Description | -| --- | --- | --- | -| label | string | The label to render | -| value | string | The value to render | -| format | string | The format to use in case the value is a date | -| default | string | The default value to render in case the value is empty | - -![adf-custom-view](docs/assets/adf-custom-view.png) ## Activiti Filter diff --git a/ng2-components/ng2-alfresco-core/README.md b/ng2-components/ng2-alfresco-core/README.md index 55fd89ab00..9ed772659e 100644 --- a/ng2-components/ng2-alfresco-core/README.md +++ b/ng2-components/ng2-alfresco-core/README.md @@ -4,6 +4,37 @@ +- [Prerequisites](#prerequisites) +- [Install](#install) +- [Library content](#library-content) +- [Toolbar Component](#toolbar-component) + * [Properties](#properties) +- [Upload Directive](#upload-directive) + * [Basic usage](#basic-usage) + * [Modes](#modes) + + [Click mode](#click-mode) + + [Drop mode](#drop-mode) + * [Events](#events) + * [Styling](#styling) +- [Alfresco Api Service](#alfresco-api-service) +- [AppConfigService](#appconfigservice) +- [Notification Service](#notification-service) +- [Context Menu directive](#context-menu-directive) +- [Accordion Component](#accordion-component) + * [Properties](#properties-1) +- [Authentication Service](#authentication-service) + * [Events](#events-1) +- [ADF Card View](#adf-card-view) + * [Properties](#properties-2) + * [CardViewModel](#cardviewmodel) +- [AlfrescoTranslationService](#alfrescotranslationservice) +- [Renditions Service](#renditions-service) +- [Build from sources](#build-from-sources) +- [Build from sources](#build-from-sources-1) +- [NPM scripts](#npm-scripts) +- [Demo](#demo) +- [License](#license) + @@ -459,6 +490,43 @@ export class AppComponent { } ``` +## ADF Card View + +The component shows the [CardViewModel](#cardviewmodel)} object. + +```html + + + +``` + +### Properties + +| Name | Type | Description | +| --- | --- | --- | +| properties | {array[CardViewModel](#cardviewmodel)} | (**required**) The custom view to render | + +### CardViewModel + +```json +{ + "label": "string", + "value": "any", + "format": "string", + "default": "string" +} +``` + +| Name | Type | Description | +| --- | --- | --- | +| label | string | The label to render | +| value | string | The value to render | +| format | string | The format to use in case the value is a date | +| default | string | The default value to render in case the value is empty | + +![adf-custom-view](docs/assets/adf-custom-view.png) + ## AlfrescoTranslationService In order to enable localisation support you will need creating a `/resources/i18n/en.json` file diff --git a/ng2-components/ng2-activiti-tasklist/docs/assets/adf-custom-view.png b/ng2-components/ng2-alfresco-core/docs/assets/adf-custom-view.png similarity index 100% rename from ng2-components/ng2-activiti-tasklist/docs/assets/adf-custom-view.png rename to ng2-components/ng2-alfresco-core/docs/assets/adf-custom-view.png diff --git a/ng2-components/package-base.json b/ng2-components/package-base.json index c0d984220c..73a0fb34a1 100644 --- a/ng2-components/package-base.json +++ b/ng2-components/package-base.json @@ -9,7 +9,7 @@ "pkg-build": "package-json-merge ng2-alfresco-core/package.json ng2-alfresco-datatable/package.json ng2-activiti-diagrams/package.json ng2-activiti-analytics/package.json ng2-activiti-form/package.json ng2-activiti-tasklist/package.json ng2-activiti-processlist/package.json ng2-alfresco-documentlist/package.json ng2-alfresco-login/package.json ng2-alfresco-search/package.json ng2-alfresco-tag/package.json ng2-alfresco-upload/package.json ng2-alfresco-viewer/package.json ng2-alfresco-webscript/package.json ng2-alfresco-webscript/package.json ng2-alfresco-userinfo/package.json ng2-alfresco-social/package.json package-base.json > package.json", "test": "node node_modules/karma/bin/karma start --reporters mocha,coverage --single-run --component .", "test-browser": "node node_modules/karma/bin/karma start karma.conf.js --reporters kjhtml", - "toc": "markdown-toc -i ng2-alfresco-datatable/README.md -i ng2-activiti-diagrams/README.md -i ng2-activiti-analytics/README.md -i ng2-activiti-form/README.md -i ng2-activiti-tasklist/README.md -i ng2-activiti-processlist/README.md -i ng2-alfresco-documentlist/README.md -i ng2-alfresco-login/README.md -i ng2-alfresco-search/README.md -i ng2-alfresco-tag/README.md -i ng2-alfresco-upload/README.md -i ng2-alfresco-viewer/README.md -i ng2-alfresco-webscript/README.md -i ng2-alfresco-webscript/README.md -i ng2-alfresco-userinfo/README.md -i ng2-alfresco-social/README.md package-base.json > README.md", + "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md", "tslint": "", "prepublish": "", "tsc": "", @@ -49,7 +49,6 @@ "tslint": "^4.4.2", "tslint-loader": "^3.3.0", "typescript": "^2.1.6", - "license-check": "1.1.5", "copy-webpack-plugin": "^4.0.1", "extract-text-webpack-plugin": "^2.0.0-rc.3", "html-webpack-plugin": "^2.28.0",