mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
54f4a07f53
* ADF-1453: Restructured Activiti Analytics readme * ADF-1453: Restructured Activiti Diagrams readme * ADF-1453: Restructured Activiti Form readme * ADF-1453: Restructured Activiti Process List readme * ADF-1453: Restructured Activiti Task List readme * ADF-1453: Restructured Alfresco Core readme * [ADF-1453] Restructured DataTable readme * [ADF-1453] Restructured Document List readme * [ADF-1453] Restructured Login readme * [ADF-1453] Restructured Alfresco Search readme * [ADF-1453] Restructured Alfresco Social readme * [ADF-1453] Restructured Alfresco Tag readme * [ADF-1453] Restructured Alfresco User Info readme * [ADF-1453] Restructured Alfresco Viewer readme * [ADF-1453] Restructured Alfresco Webscript readme * [ADF-1453] Fixed table display glitch * [ADF-1453] Fixed Markdown lint errors in readme files * [ADF-1453] Adding missing fileUploadDelete event to table in Upload readme * [ADF-1453] Resolved merge conflict with Upload readme * [ADF-1453] Changes from npm run doc
97 lines
2.7 KiB
Markdown
97 lines
2.7 KiB
Markdown
# Alfresco User Info library
|
|
|
|
Contains the Alfresco User Info component.
|
|
|
|
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
|
|
|
<!-- 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)
|
|
|
|
<!-- tocstop -->
|
|
|
|
<!-- markdown-toc end -->
|
|
|
|
## Alfresco User Info component
|
|
|
|
### Basic usage
|
|
|
|
```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
|
|
|
|
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-userinfo
|
|
```
|
|
|
|
### Build from sources
|
|
|
|
You can build component from sources with the following commands:
|
|
|
|
```sh
|
|
npm install
|
|
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
|
|
|
|
| Command | Description |
|
|
| --- | --- |
|
|
| npm run build | Build component |
|
|
| npm run test | Run unit tests in the console |
|
|
| npm run test-browser | Run unit tests in the browser
|
|
| npm run coverage | Run unit tests and display code coverage report |
|
|
|
|
### Demo
|
|
|
|
Please check the demo folder for a demo project
|
|
|
|
```sh
|
|
cd demo
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
### License
|
|
|
|
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
|