A People Picker in Angular 2+, Tries to emulate office 365 / SharePoint online's People picker, implements Angular's Reactive Forms and Angular Material,
This people picker is in abstracted layers, so that you could connect any backend with few code changes to he business class, and in theory this people picker should work with any back end. Current back end is a SharePoint 2010 web service (located in NgSharePointWebServices. I think this should work right away with 2013 and, i believe 2016 as well but not 100% sure. It works on SharePoint Online, i already tested it.
This people picker tries to mimick the way Office 365 / SharePoint online people picker works, to some extent.
Please see the app if you want to completely examine / learn how to consume this people picker.
This project was generated with Angular CLI version 1.4.2)
- No postback / flickering.
- It is made utilizing the reactive forms from angular.
- It will work with mouse and / or keyboard arrows to select the people from the drop down list, and hit enter (or click) to make a selection .
- Resolves the entity at page load to see if the entity is still valid or not
- Currently the back end searches by email, login account, or display name, so it is a very powerful search.
- It implements angular material (2+ ) components.
- Implements the progress bar from material design , so that it let's people know when the picker is busy making a service call.
- Implements the autocomplete from material, very nice control!
- Implements tooltips with the mdtooltip from material design.
- It will try to resolve the person on the blur event.
- Implements an output event "onPeoplePicked"
- current backend retrieves entries from user information list (/_catalogs/userinfo) ( this is the backend project, located in NgSharePointWebServices. )
New People picker:
Search Results:
Hovering with tooltip detail:
Resolved picker:
No results found:
- It does not support multiple people selection. - I have been tested angular material's chips, but they are not fully developed yet. As soon as they finish it, i may look into adding support for multiple people.
- exception / error handling could be enhanced.
- Testing specs are not there yet.
if you run the demo from index.html, (I used angular-cli), you should be able to see at least the initial picker. It won't show any results , you have to connect it to your back end
Trying to make memory, these are the steps that i followed to make this demo run:
- Npm install reactive-people-picker-angular-material
- Added indigo-pink.css from the animations:
(the indigo pink can be grabbed from \node_modules@angular\material\prebuilt-themes), i guess you could grab the other css and it should work. Or you should be able to customize your css. I am a material newbie, please excuse.
<link rel="stylesheet" href="/siteassets/bootstrap3.3.7.min.css"><link href="/siteassets/indigo-pink.css" rel="stylesheet"> - If you will utilize the back end of SharePoint web services, get them from the other git hub or npm project
if that is the case, i am utilizing JQuery ONLY to treat the xml from the web services results.
I am sure that you can do better than me, but i had to quickly treat xml, so go ahead and add this to your index.html or to your webpart code:
<script src="/siteassets/jquery-3.1.1.min.js"></script>3.5 - Make sure that you have angular material and angular/cdk. - then i did an ng serve.
The app.module has this relevant code: NgTaxServices is added because my backend is SharePoint web services (asmx), but you may recode the tax-people-picker-business.ts in order to connect your own service / backend.
/*import the new HTTP Client!!!!!*/
import {HttpClientModule} from '@angular/common/http';
import {NgTaxServices} from 'ng-tax-share-point-web-services-module';
import {ReactivePeoplePickerModule} from 'reactive-people-picker-angular-material';
/*the below is necessary because it's the backend library. You can easily fork the picker and change the backend*/
import {TaxReusableComponentsModule} from 'ng-tax-reusable-components';
then , in the imports we do an NgTaxServices.forRoot(): NgTaxServices is added because my backend is SharePoint web services (asmx), but you may recode the tax-people-picker-business.ts in order to connect your own service / backend.
imports: [
BrowserModule,ReactiveFormsModule,HttpClientModule, NgTaxServices.forRoot(), ReactivePeoplePickerModule
],
Now onto the people picker code itself:
on app.component.html:
<people-picker
(onPeoplePicked)="peoplePickedEventHandler($event);"
controlId="samplePickerId"
[group]="sampleFormGroup.get('ParentPickerGroup')">
</people-picker>
we are consuming the output event 'onPeoplePicked', which is an output event . this is optional. the controlId can really be anything i believe. requiredMessage is an optional input parameter that if you don't specified, it should make the picker think that it's not required. the important property to note is the group, which is initialized in the app.component.ts:
createForm() {
this.sampleFormGroup = this.fb.group({
ParentPickerGroup:TaxPeoplePickerComponent.buildItem(true)
});
}
The FormGroup is created through the static method 'buildItem' from TaxPeoplePickerComponent. You need to specify true if you want to make it required, or false if a people selection is NOT required.
Object UserInfoListEntry: this is the object that is bound and represents a person either in the picker and in the autocomplete (drop down).
it has the following properties: title, jobtitle, name and email and i believe they match to the column names in SharePoint's user information list. It also has an id porperty, which is the id column in Sharepoint.
Example of an object instance that would come from a SharePoint 2010 backend:
id:1212 title:Adams, John jobTitle: Manager3 name: Contoso\JAdams email:John.Adams@contoso.com
getItemProperties():string[]{
return ["title", "jobTitle", "name", "email" ]
}
Use under your own risk, it has not been tested thoroughly.
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.
Before running the tests make sure you are serving the app via ng serve.
Use this under your own risk no warranties
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.