people-list.component.md

Title	Added	Status	Last reviewed
People list component	v2.0.0	Active	2019-01-14

People List Component

Shows a list of users (people).

Basic Usage

Populate the users in the component class:

import { LightUserRepresentation } from '@alfresco/js-api';

export class SomeComponent implements OnInit {

    people: LightUserRepresentation[] = [
        {
            id: 1,
            email: '[email protected]',
            firstName: 'John',
            lastName: 'Doe'
        },
        {
            id: 2,
            email: '[email protected]',
            firstName: 'Jane',
            lastName: 'Doe'
        }
    ];

    onClickPeopleRow(user: LightUserRepresentation) {
        console.log('Clicked row: ', user);
    }

    onClickPeopleAction($event: Event) {
        console.log('Clicked action: ', $event);
    }
}

You can use column templates with the people list component, since it is based on the Datatable component:

<adf-people-list
  [users]="people"
  [actions]="true"
  (clickRow)="onClickPeopleRow($event)"
  (clickAction)="onClickPeopleAction($event)">
  <data-columns>
    <data-column key="firstName" class="people-pic">
      <ng-template let-entry="$implicit">
          {{entry.row.obj.firstName + ' ' + entry.row.obj.lastName}}
      </ng-template>
    </data-column>
    <data-column key="email" class="full-width">
      <ng-template let-entry="$implicit">
        <div class="adf-people-email">{{ entry.row.obj.email }}</div>
      </ng-template>
    </data-column>
  </data-columns>
</adf-people-list>

Class members

Properties

Name	Type	Default value	Description
actions	boolean	false	Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu.
users	LightUserRepresentation[]		The array of user data used to populate the people list.

Events

Name	Type	Description
clickAction	EventEmitter<UserEventModel>	Emitted when the user clicks in the 'Three Dots' drop down menu for a row.
clickRow	EventEmitter<LightUserRepresentation>	Emitted when the user clicks a row in the people list.