+
+
+Empty form
+
-
-
-Empty form
-- Possible values are:
- assignee : where the current user is the assignee
- candidate: where the current user is a task candidate
- group_x: where the task is assigned to a group where the current user is a member of.
- no value: where the current user is involved
- Possible values are:
- assignee : where the current user is the assignee
- candidate: where the current user is a task candidate
- group_x: where the task is assigned to a group where the current user is a member of.
- no value: where the current user is involved
...
```
-#### Click mode
+##### Click mode
For the click mode you can provide additional attributes for the File Dialog:
@@ -168,12 +610,12 @@ For the click mode you can provide additional attributes for the File Dialog:
```
-#### Drop mode
+##### Drop mode
For the moment upload directive supports only Files (single or multiple).
Support for Folders and `accept` filters is subject to implement.
-### Events
+#### Events
Once a single or multiple files are dropped on the decorated element the `upload-files` [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent) is raised.
The DOM event is configured to have `bubbling` enabled, so any component up the component tree can handle, process or prevent it:
@@ -227,7 +669,7 @@ detail: {
}
```
-### Styling
+#### Styling
The decorated element gets `adf-upload__dragging` CSS class name in the class list every time files are dragged over it.
This allows changing look and feel of your components in case additional visual indication is required,
@@ -256,10 +698,52 @@ for example you may want drawing a dashed border around the table row on drag:
}
```
+## Context Menu directive
+
+### Basic Usage
+
+```html
+
+(node-dblclick)="onNodeDblClicked($event)">
@@ -177,15 +165,15 @@ Here's a basic example on handling DOM events in the parent elements:
```
-### Data Sources
+#### Data Sources
For the Document List data sources you can use one of the following options:
-#### Node ID
+##### Node ID
The unique identifier of the Node. Gets automatically updated when you perform navigation to other folders.
-#### Repository aliases
+##### Repository aliases
You can use one of the well-known reserved aliases:
@@ -193,7 +181,7 @@ You can use one of the well-known reserved aliases:
- `-shared-`
- `-my-`
-#### DocumentList aliases
+##### DocumentList aliases
The DocumentList component also provides support for the following reserved aliases you can use:
@@ -222,7 +210,7 @@ The default column layout for non-reserved views is:
- Modified (date)
- Modified by
-### Trashcan
+__Trashcan__
```html
-
-```
-
-***Note:*** the `` and `` are the same component you can still use the old tag name
-
-
-
-### Properties
-
-| 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. |
-
-### Events
-
-| 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 |
-
-## Dropdown Site Component
-
-DocumentList now provides a simple dropdown component to show and interact with the sites of the current user.
-
-```html
-
-
-```
-
-
-### Events
-
-| Name | Returned Type | Description |
-| --- | --- | --- |
-| change | [SiteModel](https://github.com/Alfresco/alfresco-ng2-components/blob/development/ng2-components/ng2-alfresco-documentlist/src/models/site.model.ts) | emitted when user selects a site. When default option is selected an empty model is emitted |
-
-## Custom columns
+#### Custom columns
It is possible to reorder, extend or completely redefine data columns displayed by the component.
By default special `$thumbnail` and `displayName` columns are rendered.
@@ -576,7 +518,7 @@ You can also use HTML-based schema declaration used by DataTable, TaskList and o
```
-### DataColumn Properties
+#### DataColumn Properties
Here's the list of available properties you can define for a Data Column definition.
@@ -592,7 +534,7 @@ Here's the list of available properties you can define for a Data Column definit
| class | string | | Additional CSS class to be applied to column (header and cells) |
| formatTooltip | Function | | Custom tooltip formatter function. |
-### Column Types
+#### Column Types
The DataColumn `type` property can take one of the following values:
@@ -602,7 +544,7 @@ The DataColumn `type` property can take one of the following values:
- fileSize
- location
-### Underlying node object
+#### Underlying node object
DocumentList component assigns an instance of `MinimalNode` type (`alfresco-js-api`) as a data context of each row.
@@ -647,7 +589,7 @@ Here's a short example:
```
-### Date Column
+#### Date Column
For `date` column type the [DatePipe](https://angular.io/docs/ts/latest/api/common/DatePipe-class.html) formatting is used.
For a full list of available `format` values please refer to [DatePipe](https://angular.io/docs/ts/latest/api/common/DatePipe-class.html) documentation.
@@ -655,7 +597,7 @@ For a full list of available `format` values please refer to [DatePipe](https://
ADF also supports additional `timeAgo` value for the `format` property.
That triggers the date values to be rendered using popular ["Time from now"](https://momentjs.com/docs/#/displaying/fromnow/) format.
-### Location Column
+#### Location Column
This column is used to display a clickable location link pointing to the parent path of the node.
@@ -695,7 +637,7 @@ All links rendered in the column above will have an address mapped to `/files`:
...
```
-### Column Template
+#### Column Template
It is possible to provide custom column/cell template that may contain other Angular components or HTML elements:
@@ -770,7 +712,7 @@ In the Example below we will add the [ng2-alfresco-tag](https://www.npmjs.com/pa
-### Actions
+#### Actions
Properties:
@@ -982,7 +924,7 @@ Shows the destination chooser dialog for copy and move actions. By default the d
```
-###### Error, Permission and success callback
+##### Error, Permission and success callback
Defining error, permission and success callbacks are pretty much the same as doing it for the delete permission handling.
@@ -1044,7 +986,7 @@ export class MyView {
-### Context Menu
+#### Context Menu
DocumentList also provides integration for 'Context Menu Service' from the
[ng2-alfresco-core](https://www.npmjs.com/package/ng2-alfresco-core) library.
@@ -1070,7 +1012,7 @@ export class MyView {
This enables context menu items for documents and folders.
-### Navigation mode
+#### Navigation mode
By default DocumentList component uses 'double-click' mode for navigation.
That means user will see the contents of the folder by double-clicking its name
@@ -1090,18 +1032,56 @@ The following example switches navigation to single clicks:
```
-### Events
+## Breadcrumb Component
-DocumentList emits the following events:
+Indicates the current position within a navigation hierarchy.
-| Name | Description |
-| --- | --- |
-| nodeClick | emitted when user clicks a list node |
-| nodeDblClick | emitted when user double-clicks list node |
-| folderChange | emitted once current display folder has changed |
-| preview | emitted when user acts upon files with either single or double click (depends on `navigation-mode`), recommended for Viewer components integration |
-| permissionError | emitted when user is attempting to create a folder via action menu without having the permission to do it |
-| ready | emitted when the documentList is ready and loads all the elements|
+
+
+### Basic Usage
+
+```html
+
+
+```
+
+***Note:*** the `` and `` are the same component - you can still use the old tag name.
+
+#### Properties
+
+| 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. |
+
+#### Events
+
+| 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 |
+
+## Dropdown Site Component
+
+Displays a dropdown menu to show and interact with the sites of the current user.
+
+
+
+### Basic Usage
+
+```html
+
+
+```
+
+#### Events
+
+| Name | Returned Type | Description |
+| --- | --- | --- |
+| change | [SiteModel](https://github.com/Alfresco/alfresco-ng2-components/blob/development/ng2-components/ng2-alfresco-documentlist/src/models/site.model.ts) | emitted when user selects a site. When default option is selected an empty model is emitted |
## Advanced usage and customization
@@ -1456,7 +1436,25 @@ export class MyView {
Typically you may want populating all your custom actions at the application root level or
by means of custom application service.
-## Build from sources
+## See also
+
+- [Walkthrough: adding indicators to clearly highlight information about a node](docs/metadata-indicators.md)
+
+## Project Information
+
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+### Install
+
+```sh
+npm install ng2-alfresco-documentlist
+
+### Build from sources
You can build component from sources with the following commands:
@@ -1468,7 +1466,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -1477,7 +1475,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -1487,6 +1485,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-login/README.md b/ng2-components/ng2-alfresco-login/README.md
index a03852dc64..bf16091d02 100644
--- a/ng2-components/ng2-alfresco-login/README.md
+++ b/ng2-components/ng2-alfresco-login/README.md
@@ -1,47 +1,39 @@
-# Login Component
+# Login library
+
+Contains the Login component.
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [Basic usage](#basic-usage)
-- [Properties](#properties)
-- [Events](#events)
-- [Change footer content](#change-footer-content)
-- [Change header content](#change-header-content)
-- [Extra content](#extra-content)
-- [Custom logo and background](#custom-logo-and-background)
-- [Customize Validation rules](#customize-validation-rules)
-- [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [Login component](#login-component)
+ * [Basic usage](#basic-usage)
+ + [Properties](#properties)
+ + [Events](#events)
+ * [Details](#details)
+ + [Change footer content](#change-footer-content)
+ + [Change header content](#change-header-content)
+ + [Extra content](#extra-content)
+ + [Custom logo and background](#custom-logo-and-background)
+ + [Customize Validation rules](#customize-validation-rules)
+ + [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Prerequisites
+## Login component
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+Authenticates to Alfresco Content Services and Alfresco Process Services.
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-See it live: [Login Quickstart](http://embed.plnkr.co/PfZytJyHcl3xIsa8pdMo/)
-
-## Install
-
-```sh
-npm install ng2-alfresco-login
-```
-
-## Basic usage
-
-This component allows to authenticate to Alfresco Content Services and Alfresco Process Services.
+### Basic usage
**app.component.html**
@@ -68,7 +60,7 @@ export class AppComponent {
}
```
-## Properties
+#### Properties
| Name | Type | Default Value | Description |
| --- | --- | --- | --- |
@@ -83,7 +75,7 @@ export class AppComponent {
| showRememberMe | boolean | false | Toggle `Remember me` checkbox visibility |
| showLoginActions | boolean | false | Toggle extra actions visibility (`Need Help`, `Register`, etc.) |
-## Events
+#### Events
| Name | Description |
| --- | --- |
@@ -91,7 +83,9 @@ export class AppComponent {
| onError | Raised when the login fails |
| executeSubmit | Raised when the form is submitted |
-## Change footer content
+### Details
+
+#### Change footer content
@@ -103,7 +97,7 @@ You can replace the entire content in the footer of the login component with you
`
```
-## Change header content
+#### Change header content
@@ -115,7 +109,7 @@ You can replace the entire content in the header of the login component with you
`
```
-## Extra content
+#### Extra content
You can put additional html content between `alfresco-login` tags to get it rendered as part of the login dialog.
This becomes handy in case you need to extend it with custom input fields handled by your application or parent component:
@@ -132,7 +126,7 @@ Here's an example of custom content:
-## Custom logo and background
+#### Custom logo and background
It is possible changing logo and background images to custom values.
@@ -156,7 +150,7 @@ Alternatively you can bind to your component properties and provide values dynam
```
-## Customize Validation rules
+#### Customize Validation rules
If needed it is possible to customise the validation rules of the login
form. You can add/modify the default rules of the login form.
@@ -194,7 +188,7 @@ export class MyCustomLogin {
}
```
-## Controlling form submit execution behaviour
+#### Controlling form submit execution behaviour
If absolutely needed it is possible taking full control over form
submit execution by means of `executeSubmit` event.
@@ -236,7 +230,24 @@ export class MyCustomLogin {
**Please note that if `event.preventDefault()` is not called then default behaviour
will also be executed after your custom code.**
-## Build from sources
+## Project Information
+
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+See it live: [Login Quickstart](http://embed.plnkr.co/PfZytJyHcl3xIsa8pdMo/)
+
+### Install
+
+```sh
+npm install ng2-alfresco-login
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -248,7 +259,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -257,7 +268,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -267,6 +278,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-search/README.md b/ng2-components/ng2-alfresco-search/README.md
index 3070403dd4..77df2b6c11 100644
--- a/ng2-components/ng2-alfresco-search/README.md
+++ b/ng2-components/ng2-alfresco-search/README.md
@@ -1,40 +1,36 @@
-# Search Component
+# Search library
+
+Contains the Search and Search Results components.
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [Basic usage](#basic-usage)
-- [Properties](#properties)
-- [Events](#events)
-- [Basic usage Search results](#basic-usage-search-results)
- * [Properties](#properties-1)
- * [Events](#events-1)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [Search component](#search-component)
+ * [Basic usage](#basic-usage)
+ + [Properties](#properties)
+ + [Events](#events)
+ * [Details](#details)
+- [Search Results component](#search-results-component)
+ * [Basic usage](#basic-usage-1)
+ + [Properties](#properties-1)
+ + [Events](#events-1)
+ * [Details](#details-1)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Prerequisites
+## Search component
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
-
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-## Install
-
-```sh
-npm install ng2-alfresco-search
-```
-
-## Basic usage
+### Basic usage
```html
```
-Example of a component that uses the search control. In this example the search term is simply logged to the console
-but instead the component could emit an event to be consumed upstream, or it could trigger a change inside a search
-results component embedded inside the same component.
-
-## Properties
+#### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
@@ -65,7 +57,7 @@ results component embedded inside the same component.
| liveSearchMaxResults | number | 5 | Maximum number of results to show in the live search. |
| liveSearchResultSort | string | | Criteria to sort live search results by, must be one of "name" , "modifiedAt" or "createdAt" |
-## Events
+#### Events
| Name | Description |
| --- | --- |
@@ -74,7 +66,25 @@ results component embedded inside the same component.
| fileSelect | Emitted when a file item from the list of find-as-you-type results is selected |
| expand | Emitted when the expanded state of the control changes based on focus events and the content of the input control |
-## Basic usage Search results
+### Details
+
+```html
+
+
+```
+
+Example of a component that uses the search control. In this example the search term is simply logged to the console
+but instead the component could emit an event to be consumed upstream, or it could trigger a change inside a search
+results component embedded inside the same component.
+
+## Search Results component
+
+### Basic usage
```html
```
-Example of a component that displays search results, using the Angular2 router to supply a 'q' parameter containing the
-search term. If no router is present on the page or if the router does not provide such parameter then an empty
-results page will be shown.
-
-### Properties
+#### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
@@ -98,7 +104,7 @@ results page will be shown.
| navigationMode | string | "dblclick" | Event used to initiate a navigation action to a specific result, one of "click" or "dblclick" |
| navigate | boolean | true | Allow documentlist to navigate or not. For more information see documentlist component's documentation |
-### Events
+#### Events
| Name | Description |
| --- | --- |
@@ -106,7 +112,34 @@ results page will be shown.
| nodeDbClick | Emitted when user acts upon files or folders with double click **only when `navigation-mode` is set to false**, giving more freedom then just simply previewing the file |
| resultsLoad | Emitted when search results have fully loaded |
-## Build from sources
+### Details
+
+```html
+
+
+```
+
+Example of a component that displays search results, using the Angular2 router to supply a 'q' parameter containing the
+search term. If no router is present on the page or if the router does not provide such parameter then an empty
+results page will be shown.
+
+## Project Information
+
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+### Install
+
+```sh
+npm install ng2-alfresco-search
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -118,7 +151,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -127,7 +160,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -137,6 +170,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-social/README.md b/ng2-components/ng2-alfresco-social/README.md
index 1ea0e855b6..52ca2d68df 100644
--- a/ng2-components/ng2-alfresco-social/README.md
+++ b/ng2-components/ng2-alfresco-social/README.md
@@ -1,68 +1,58 @@
-# Alfresco Social Component
+# Alfresco Social library
+
+Contains the ADF Like and ADF Rating components.
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [Basic usage](#basic-usage)
-- [adf-like](#adf-like)
- * [Properties](#properties)
- * [Events](#events)
-- [adf-rating](#adf-rating)
- * [Properties](#properties-1)
- * [Events](#events-1)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [ADF Like component](#adf-like-component)
+ * [Basic Usage](#basic-usage)
+ + [Properties](#properties)
+ + [Events](#events)
+- [ADF Rating component](#adf-rating-component)
+ * [Basic Usage](#basic-usage-1)
+ + [Properties](#properties-1)
+ + [Events](#events-1)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Prerequisites
+## ADF Like component
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-## Install
-
-```sh
-npm install ng2-alfresco-social
-```
-
-## Basic usage
-
-In this component there are two different components:
-
-* adf-like
-* adf-rating
-
-## adf-like
+### Basic Usage
```html
```
-### Properties
+#### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| nodeId | string | | The identifier of a node |
-### Events
+#### Events
| Name | Description |
| --- | --- |
| changeVote | Raised when vote gets changed |
-
+## Project Information
-## Build from sources
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+### Install
+
+```sh
+npm install ng2-alfresco-social
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -96,7 +99,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -105,7 +108,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -115,6 +118,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-tag/README.md b/ng2-components/ng2-alfresco-tag/README.md
index 6a7a12e3b0..c5227a5de0 100644
--- a/ng2-components/ng2-alfresco-tag/README.md
+++ b/ng2-components/ng2-alfresco-tag/README.md
@@ -1,48 +1,35 @@
# Alfresco Tag Component
+Contains the Alfresco Tag Node Actions list, Tag List and Node List components.
+
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [Basic usage](#basic-usage)
-- [alfresco-tag-node-actions-list](#alfresco-tag-node-actions-list)
- * [Properties](#properties)
-- [alfresco-tag-node-list](#alfresco-tag-node-list)
- * [Properties](#properties-1)
-- [alfresco-tag-list](#alfresco-tag-list)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [Alfresco Tag Node Actions List component](#alfresco-tag-node-actions-list-component)
+ * [Basic Usage](#basic-usage)
+ + [Properties](#properties)
+- [Alfresco Tag Node List component](#alfresco-tag-node-list-component)
+ * [Basic Usage](#basic-usage-1)
+ + [Properties](#properties-1)
+- [Alfresco Tag List component](#alfresco-tag-list-component)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Prerequisites
+## Alfresco Tag Node Actions List component
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-## Install
-
-```sh
-npm install ng2-alfresco-tag
-```
-
-## Basic usage
-
-In this component there are three different tags:
-
-* alfresco-tag-node-actions-list
-* alfresco-tag-list
-* alfresco-tag-node-list
-
-## alfresco-tag-node-actions-list
+### Basic Usage
```html
```
-### Properties
+#### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| nodeId | string | | The identifier of a node |
-
+## Alfresco Tag Node List component
-## alfresco-tag-node-list
+### Basic Usage
```html
```
-### Properties
+#### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
@@ -74,11 +61,26 @@ In this component there are three different tags:
-## alfresco-tag-list
+## Alfresco Tag List component
-
-## Build from sources
+
+## Project Information
+
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+### Install
+
+```sh
+npm install ng2-alfresco-tag
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -90,7 +92,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -99,7 +101,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -109,6 +111,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-upload/README.md b/ng2-components/ng2-alfresco-upload/README.md
index 0034a6283c..09f4f444c0 100644
--- a/ng2-components/ng2-alfresco-upload/README.md
+++ b/ng2-components/ng2-alfresco-upload/README.md
@@ -1,69 +1,46 @@
-# Alfresco Upload Component
+# Alfresco Upload library
+
+Contains components for handling uploads to Content Services.
-- [Content](#content)
- * [Components](#components)
- * [Services](#services)
- * [Directives](#directives)
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [UploadButtonComponent](#uploadbuttoncomponent)
- * [Properties](#properties)
- * [Events](#events)
- * [Advanced usage](#advanced-usage)
+- [Upload Button Component](#upload-button-component)
+ * [Basic Usage](#basic-usage)
+ + [Properties](#properties)
+ + [Events](#events)
+ * [Details](#details)
+ [How to show notification message with no permission](#how-to-show-notification-message-with-no-permission)
+ [How to disable the button when the delete permission is missing](#how-to-disable-the-button-when-the-delete-permission-is-missing)
-- [UploadDragAreaComponent](#uploaddragareacomponent)
- * [Properties](#properties-1)
- * [Events](#events-1)
-- [FileUploadingDialogComponent](#fileuploadingdialogcomponent)
- * [Properties](#properties-2)
-- [UploadService](#uploadservice)
- * [Ignore list configuration](#ignore-list-configuration)
- * [Events](#events-2)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [Upload Drag Area Component](#upload-drag-area-component)
+ * [Basic Usage](#basic-usage-1)
+ + [Properties](#properties-1)
+ + [Events](#events-1)
+- [File Uploading Dialog Component](#file-uploading-dialog-component)
+ * [Basic Usage](#basic-usage-2)
+ + [Properties](#properties-2)
+ * [Details](#details-1)
+- [Upload Service](#upload-service)
+ * [Basic Usage](#basic-usage-3)
+ + [Events](#events-2)
+ * [Details](#details-2)
+ + [Ignore list configuration](#ignore-list-configuration)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Content
+## Upload Button Component
-### Components
-
-- [FileUploadingDialogComponent](#fileuploadingdialogcomponent)
-- FileUploadingListComponent
-- [UploadButtonComponent](#uploadbuttoncomponent)
-- [UploadDragAreaComponent](#uploaddragareacomponent)
-
-### Services
-
-- [UploadService](#uploadservice)
-
-### Directives
-
-- FileDraggableDirective
-
-## Prerequisites
-
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
-
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-## Install
-
-```sh
-npm install ng2-alfresco-upload
-```
-
-## UploadButtonComponent
+### Basic Usage
```html
```
-### Properties
+#### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
@@ -87,21 +64,20 @@ npm install ng2-alfresco-upload
| multipleFiles | boolean | false | Allow/disallow multiple files |
| acceptedFilesType | string | * | array of allowed file extensions , example: ".jpg,.gif,.png,.svg" |
| **(deprecated)** currentFolderPath | string | '/Sites/swsdp/documentLibrary' | define the path where the files are uploaded. **Deprecated in 1.6.0: use rootFolderId instead.** |
-| **(deprecated)** rootFolderId | string | '-root-' | The ID of the root folder node.
-**Deprecated in 1.6.2: use parentId instead.** |
+| **(deprecated)** rootFolderId | string | '-root-' | The ID of the root folder node. **Deprecated in 1.6.2: use parentId instead.** |
| parentId | string | empty | The ID of the root. It can be the nodeId if you are using the upload for the Content Service or taskId/processId for the Process Service. |
| versioning | boolean | false | Versioning false is the default uploader behaviour and it renames the file using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created |
| staticTitle | string | (predefined) | define the text of the upload button |
| **(deprecated)** disableWithNoPermission ***use node permission directive from core instead*** | boolean | false | If the value is true and the user doesn't have the permission to delete the node the button will be disabled |
| tooltip | string | | Custom tooltip |
-### Events
+#### Events
| Name | Description |
| --- | --- |
| onSuccess | Raised when the file is uploaded |
-### Advanced usage
+### Details
#### How to show notification message with no permission
@@ -144,9 +120,11 @@ The UploadButtonComponent provides the property disableWithNoPermission that can
-## UploadDragAreaComponent
+## Upload Drag Area Component
-This component provides a drag and drop area to upload files to Alfresco.
+Adds a drag and drop area to upload files to Alfresco.
+
+### Basic Usage
```html
@@ -167,7 +145,7 @@ export class AppComponent {
}
```
-### Properties
+#### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
@@ -178,32 +156,55 @@ export class AppComponent {
| **(deprecated)** currentFolderPath | string | '/' | define the path where the files are uploaded. **Deprecated in 1.6.0: use rootFolderId instead.** |
| versioning | boolean | false | Versioning false is the default uploader behaviour and it renames the file using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created |
-### Events
+#### Events
| Name | Description |
| --- | --- |
| onSuccess | Raised when the file is uploaded |
-## FileUploadingDialogComponent
+## File Uploading Dialog Component
-This component provides a dialog that shows all the files uploaded with upload button or drag & drop area components.
-This component should be used in combination with upload button or drag & drop area.
+Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.
+
+### Basic Usage
```html
+
```
-### Configuring PDF.js library
+Using with file url:
+
+```html
+
+
+```
+
+#### Properties
+
+| Attribute | Options | Default | Description |
+| --- | --- | --- | --- |
+| fileNodeId | string | | Node Id of the file to load |
+| 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 |
+| 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 toolbars |
+| displayName | string | | You can specify the name of the file |
+
+### Details
+
+#### Supported file formats
+
+| Type | Extension |
+| --- | --- |
+| Media | wav, Mp3, Mp4, WebM, Ogv |
+| Images | png, jpg, jpeg, gif, bmp |
+| Text | pdf, txt |
+
+#### PDF Conversion
+
+
+
+Note for unsupported extensions the viewer will offer the possibility to convert to PDF if that kind of extension is supported by the [content service renditions service](https://community.alfresco.com/docs/DOC-5879-rendition-service)
+
+#### Configuring PDF.js library
In order to configure your webpack-enabled application with the PDF.js library please follow the next steps.
@@ -73,54 +116,7 @@ new CopyWebpackPlugin([
The Viewer component now should be able displaying PDF files.
-## Basic usage
-
-Using with node id:
-
-```html
-
-
-```
-
-Using with file url:
-
-```html
-
-
-```
-
-## Properties
-
-| Attribute | Options | Default | Description |
-| --- | --- | --- | --- |
-| fileNodeId | string | | Node Id of the file to load |
-| 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 |
-| 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 toolbars |
-| displayName | string | | You can specify the name of the file |
-
-## Supported file formats
-
-| Type | Extension |
-| --- | --- |
-| Media | wav, Mp3, Mp4, WebM, Ogv |
-| Images | png, jpg, jpeg, gif, bmp |
-| Text | pdf, txt |
-
-## PDF Conversion
-
-
-
-Note for unsupported extensions the viewer will offer the possibility to convert to PDF if that kind of extension is supported by the [content service renditions service](https://community.alfresco.com/docs/DOC-5879-rendition-service)
-
-## Custom extension handler
+#### Custom extension handler
If you want to handle other file formats that are not yet supported by the ng2-alfresco-viewer you can define your own custom handler.
@@ -172,7 +168,22 @@ It is possible to define multiple `extension-viewer` templates:
```
-## Build from sources
+## Project Information
+
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+### Install
+
+```sh
+npm install ng2-alfresco-viewer
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -184,7 +195,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -193,7 +204,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -203,6 +214,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-webscript/README.md b/ng2-components/ng2-alfresco-webscript/README.md
index d543b7bfb3..9f2a2d7dee 100644
--- a/ng2-components/ng2-alfresco-webscript/README.md
+++ b/ng2-components/ng2-alfresco-webscript/README.md
@@ -1,39 +1,33 @@
-# Alfresco Webscript Component
+# Alfresco Webscript library
+
+Contains the Alfresco Webscript Get component.
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [Basic usage](#basic-usage)
-- [Properties](#properties)
-- [Webscript View HTML example](#webscript-view-html-example)
-- [Webscript View DATATABLE example](#webscript-view-datatable-example)
-- [Webscript View JSON example](#webscript-view-json-example)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [Alfresco Webscript Get component](#alfresco-webscript-get-component)
+ * [Basic usage](#basic-usage)
+ + [Properties](#properties)
+ * [Details](#details)
+ + [Webscript View HTML example](#webscript-view-html-example)
+ + [Webscript View DATATABLE example](#webscript-view-datatable-example)
+ + [Webscript View JSON example](#webscript-view-json-example)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Prerequisites
+## Alfresco Webscript Get component
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
-
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-## Install
-
-```sh
-npm install ng2-alfresco-webscript
-```
-
-## Basic usage
+### Basic usage
```html
If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+### Install
+
+```sh
+npm install ng2-alfresco-webscript
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -202,7 +213,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -211,7 +222,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -221,6 +232,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
@@ -103,7 +97,7 @@ You can replace the entire content in the footer of the login component with you
`
```
-## Change header content
+#### Change header content
@@ -115,7 +109,7 @@ You can replace the entire content in the header of the login component with you
`
```
-## Extra content
+#### Extra content
You can put additional html content between `alfresco-login` tags to get it rendered as part of the login dialog.
This becomes handy in case you need to extend it with custom input fields handled by your application or parent component:
@@ -132,7 +126,7 @@ Here's an example of custom content:
-## Custom logo and background
+#### Custom logo and background
It is possible changing logo and background images to custom values.
@@ -156,7 +150,7 @@ Alternatively you can bind to your component properties and provide values dynam
```
-## Customize Validation rules
+#### Customize Validation rules
If needed it is possible to customise the validation rules of the login
form. You can add/modify the default rules of the login form.
@@ -194,7 +188,7 @@ export class MyCustomLogin {
}
```
-## Controlling form submit execution behaviour
+#### Controlling form submit execution behaviour
If absolutely needed it is possible taking full control over form
submit execution by means of `executeSubmit` event.
@@ -236,7 +230,24 @@ export class MyCustomLogin {
**Please note that if `event.preventDefault()` is not called then default behaviour
will also be executed after your custom code.**
-## Build from sources
+## Project Information
+
+### Prerequisites
+
+Before you start using this development framework, make sure you have installed all required software and done all the
+necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
+
+> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
+
+See it live: [Login Quickstart](http://embed.plnkr.co/PfZytJyHcl3xIsa8pdMo/)
+
+### Install
+
+```sh
+npm install ng2-alfresco-login
+```
+
+### Build from sources
You can build component from sources with the following commands:
@@ -248,7 +259,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
-## NPM scripts
+### NPM scripts
| Command | Description |
| --- | --- |
@@ -257,7 +268,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
-## Demo
+### Demo
Please check the demo folder for a demo project
@@ -267,6 +278,6 @@ npm install
npm start
```
-## License
+### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
diff --git a/ng2-components/ng2-alfresco-search/README.md b/ng2-components/ng2-alfresco-search/README.md
index 3070403dd4..77df2b6c11 100644
--- a/ng2-components/ng2-alfresco-search/README.md
+++ b/ng2-components/ng2-alfresco-search/README.md
@@ -1,40 +1,36 @@
-# Search Component
+# Search library
+
+Contains the Search and Search Results components.
-- [Prerequisites](#prerequisites)
-- [Install](#install)
-- [Basic usage](#basic-usage)
-- [Properties](#properties)
-- [Events](#events)
-- [Basic usage Search results](#basic-usage-search-results)
- * [Properties](#properties-1)
- * [Events](#events-1)
-- [Build from sources](#build-from-sources)
-- [NPM scripts](#npm-scripts)
-- [Demo](#demo)
-- [License](#license)
+- [Search component](#search-component)
+ * [Basic usage](#basic-usage)
+ + [Properties](#properties)
+ + [Events](#events)
+ * [Details](#details)
+- [Search Results component](#search-results-component)
+ * [Basic usage](#basic-usage-1)
+ + [Properties](#properties-1)
+ + [Events](#events-1)
+ * [Details](#details-1)
+- [Project Information](#project-information)
+ * [Prerequisites](#prerequisites)
+ * [Install](#install)
+ * [Build from sources](#build-from-sources)
+ * [NPM scripts](#npm-scripts)
+ * [Demo](#demo)
+ * [License](#license)
-## Prerequisites
+## Search component
-Before you start using this development framework, make sure you have installed all required software and done all the
-necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
-
-> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
-
-## Install
-
-```sh
-npm install ng2-alfresco-search
-```
-
-## Basic usage
+### Basic usage
```html