sp-dev-fx-webparts/samples/react-personal-contacts/README.md

55 lines
2.3 KiB
Markdown
Raw Normal View History

2020-11-09 00:04:19 -05:00
# Personal Contacts
2020-07-20 00:55:03 -04:00
2021-05-02 15:04:59 -04:00
> NOTE: This sample is available in the [PnP Starter Kit](https://github.com/pnp/sp-starter-kit). You can find the sample code for this web part at https://github.com/pnp/sp-starter-kit/tree/master/solution/src/webparts/personalContacts.
2020-07-20 00:55:03 -04:00
This web part provides you the ability to add a particular user's personal contacts on a web page. The web part may be configured to display a pre-defined number of contacts at a time. This web part is powered by the Microsoft Graph and currently requires that the Office 365 tenant be configured for targeted release for all users.
![Personal Contacts](https://github.com/pnp/sp-starter-kit/raw/master/assets/images/components/part-personal-contacts.gif)
## How to use this web part on your web pages
1. Place the page you want to add this web part to in edit mode.
2. Search for and insert the **Personal Contacts** web part.
3. Configure the web part to update its properties.
## Configurable Properties
The `Personal Contacts` web part can be configured with the following properties:
| Label | Property | Type | Required | Description |
| ---- | ---- | ---- | ---- | ---- |
| Personal contacts | title | string | no | The web part title, editable inline with the web part itself |
| Number of contacts to show | nrOfContacts | number | no | Default: 5 - The number of contacts to show |
# Installing the web part
2021-05-02 15:04:59 -04:00
See getting started from [SP-Starter-Kit repository readme](https://github.com/pnp/sp-starter-kit).
2020-07-20 00:55:03 -04:00
2021-05-02 15:04:59 -04:00
You can also download just the [SharePoint Framework solution package (spppkg) file](https://github.com/pnp/sp-starter-kit/blob/master/package/sharepoint-starter-kit.sppkg) and install that to your tenant. This web part requires access to the Microsoft Graph.
2020-07-20 00:55:03 -04:00
# Screenshots
![Personal Contacts](https://github.com/pnp/sp-starter-kit/raw/master/assets/images/components/part-personal-contacts.png)
# Source Code
2021-05-02 15:04:59 -04:00
https://github.com/pnp/sp-starter-kit/tree/master/solution/src/webparts/personalContacts
2020-07-20 00:55:03 -04:00
# Minimal Path to Awesome
- Clone this repository
- Move to Solution folder
- in the command line run:
- `npm install`
- `gulp serve`
# Version history
Version|Date|Comments
-------|----|--------
1.0|May 2018|Initial release
2023-03-12 21:16:15 -04:00
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-personal-contacts" />