alfresco-ng2-components/docs/user-info.component.md
Vito 3023d30d38 [ADF - 1681] Added username and created initials pipe for user info (#2479)
* [ADF-1681] appling design spec to userinfo component

* [ADF-1681] added default pipe to userinfo

* [ADF-1681] fixed pipe name and added pipe test

* [ADF-168] fixed test for new userinfo feature

* [ADF-1681] fixed test

* [ADF-1681] fixed style for initials image

* [ADF-1681] fixed button for new material design spec

* [ADF - 1681] Added documentation for the new values

* [ADF - 1681] added some test to check new input attributes
2017-10-16 22:55:40 +01:00

36 lines
1.2 KiB
Markdown

# Alfresco User Info component
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic usage](#basic-usage)
* [Properties](#properties)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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` |
| 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 ECM and BPM the ECM image will be shown.