mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
657e5ef7fd
* Generate docs * Fix duplicated Optional and restore code block ticks * Fix docbuild command errors, improve documentations --------- Co-authored-by: Amedeo Lepore <amedeo.lepore85@gmail.com> Co-authored-by: Amedeo Lepore <amedeo.lepore@hyland.com>
39 lines
1.8 KiB
Markdown
39 lines
1.8 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 |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. |
|
|
| bpmUser | [`BpmUserModel`](../../core/models/bpm-user.model.md) | | BPM user info. |
|
|
| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. |
|
|
| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | ECM user info. |
|
|
| isLoggedIn | `boolean` | | Determines if user is logged in. |
|
|
| 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`. |
|
|
| mode | `UserInfoMode` | | current mode. |
|
|
| 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.
|