alfresco-ng2-components/docs/process-services/components/process-user-info.component.md
Diogo Bastos 96075ae456
[AAE-10779] User info component refactor (#8187)
* [AAE-10779] Update documentation

* [AAE-10779] Update demo-shell user-info component call

* [AAE-10779] Ecm user info component

* [AAE-10779] Identity user info component

* [AAE-10779] Bpm user info component

* [AAE-10779] Remove ecm-panel id references

* [AAE-10779] add stories and remove old component

* [AAE-10779] Update doc version and remove leftover html tag

* trigger travis

* [AAE-10779] rename ecm-user-info to content-user-info and bpm-user-info to process-user-info

* [AAE-10779] update docs

* [AAE-10779] fix demo-shell user-info

* [AAE-10779] add docs
2023-02-15 14:47:43 +00:00

39 lines
1.7 KiB
Markdown

---
Title: Process User Info component
Added: v6.0.0
Status: Active
Last reviewed: 2023-01-24
---
# [Process User Info component](../../../lib/process-services/src/lib/process-user-info/process-user-info.component.ts "Defined in process-user-info.component.ts")
Shows user information for `PROCESS` and `ALL` mode.
## Basic usage
```html
<adf-process-user-info></adf-process-user-info>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| isLoggedIn | `boolean` | Is user logged in |
| bpmUser | `BpmUserModel` | Bpm user model. |
| ecmUser | `EpmUserModel` | Ecm user model. |
| mode | `UserInfoMode` | `UserInfoMode.PROCESS` | current mode. |
| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. |
| BpmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. |
| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. |
| menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. |
| namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. |
| showName | `boolean` | true | Shows/hides the username next to the user info button. |
## Details
The component shows a round icon for the user and will show extra information about
the user when clicked.