sp-dev-fx-webparts/samples/react-twitter/README.md

54 lines
1.8 KiB
Markdown
Raw Normal View History

2020-11-08 23:45:25 -05:00
# Twitter Timeline
Sample web part to display Twitter timeline
![Twitter timeline](./assets/twitter-timeline.png)
## Used SharePoint Framework Version
![drop](https://img.shields.io/badge/drop-1.10.0-green.svg)
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 developer tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
## Solution
Solution|Author(s)
--------|---------
react-twitter-client-side-solution|[AJIXuMuK](https://github.com/AJIXuMuK)
## Version history
Version|Date|Comments
-------|----|--------
1.0|January 20, 2020|Initial release
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
---
## Minimal Path to Awesome
* clone this repo
* move to right folder
* in the command line run:
* `npm install`
* `gulp bundle --ship`
* `gulp package-solution --ship`
* from the _sharepoint/solution_ folder, deploy the .sppkg file to the App catalog in your tenant
* in the site where you want to test this solution
* add the app named _react-twitter-client-side-solution_
* edit a page
* add _Twitter Feed_ web part
* configure web part
## Features
This sample illustrates how to use [react-twitter-embed](https://www.npmjs.com/package/react-twitter-embed) module to display Twitter timeline of specific profile, likes, list, collection or url.
It also uses [PnP React Controls](https://github.com/SharePoint/sp-dev-fx-controls-react) and [PnP Property Controls](https://github.com/SharePoint/sp-dev-fx-property-controls) for rich web part and property pane components.
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-twitter" />