[ADF-1549] Removed doc content from library README files (#2400)

* [ADF-1549] Removed doc content from library README files

* [ADF-1549] Removed doc content from library README files

* [ADF-1583] Fix change detection error (the quick way) (#2396)

* Fix change detection error (the quick way)

* Fix it the second time

* raise keyboard events, improve task list keyboard handling (#2401)

* [ADF-1549] Removed doc content from library README files

* [ADF-1549] Added doc update from Tasklist readme
This commit is contained in:
Andy Stark
2017-10-02 22:41:44 +01:00
committed by Eugenio Romano
parent 79422ac32c
commit e8235fa7fe
99 changed files with 313 additions and 6345 deletions

View File

@@ -6,61 +6,37 @@ Contains the Alfresco User Info component.
<!-- toc -->
- [Alfresco User Info component](#alfresco-user-info-component)
* [Basic usage](#basic-usage)
+ [Properties](#properties)
* [Details](#details)
- [Project Information](#project-information)
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Build from sources](#build-from-sources)
* [NPM scripts](#npm-scripts)
* [Demo](#demo)
* [License](#license)
- [Documentation](#documentation)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Build from sources](#build-from-sources)
- [NPM scripts](#npm-scripts)
- [Demo](#demo)
- [License](#license)
<!-- tocstop -->
<!-- markdown-toc end -->
## Alfresco User Info component
## Documentation
### Basic usage
See the [ADF Analytics](../../docIndex.md#adf-analytics) section of the [docs index](../../docIndex.md)
for all available documentation on this library.
```html
<adf-userinfo></adf-userinfo>
```
#### Properties
| 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` |
| fallBackThumbnailImage | string | (alfresco image) | Fallback image for profile when thumbnail is missing|
### Details
This will show a round icon with user and on click some user information.
If user is logged in with ECM and BPM the ECM image will be shown.
## Project Information
### Prerequisites
## 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
## Install
```sh
npm install ng2-alfresco-userinfo
```
### Build from sources
## Build from sources
You can build component from sources with the following commands:
@@ -72,7 +48,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 |
| --- | --- |
@@ -81,7 +57,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
@@ -91,6 +67,6 @@ npm install
npm start
```
### License
## License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)