sp-dev-fx-webparts/samples/react-my-events/README.md

117 lines
6.4 KiB
Markdown
Raw Normal View History

2022-10-17 10:46:09 -04:00
http://aka.ms/m365devprogramhttp://aka.ms/m365devprogramhttp://aka.ms/m365devprogramhttp://aka.ms/m365devprogram# My Events
2021-08-18 03:50:48 -04:00
## Summary
2021-08-26 01:25:19 -04:00
This web part provides loggedin user's outlook events with some advanced features.
2021-08-18 03:50:48 -04:00
## Features
- It shows outlook events of loggedin users.
- Date range selection of events like this week, this month, next two weeks, this quarter, all upcoming and so on.
- Compact/Flimstarp layout selection
- Show number of events configuartion in compact layout
- Redirect to teams link if there is a teams meeting
2021-08-26 01:25:19 -04:00
- Look and feel is same as OOTB events web part
2021-08-18 03:50:48 -04:00
![Preview](assets/preview.png)
![Preview](assets/preview.gif)
2021-08-26 01:25:19 -04:00
## Compatibility
2021-08-18 03:50:48 -04:00
| :warning: Important |
|:---------------------------|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
![SPFx 1.15.0](https://img.shields.io/badge/SPFx-1.15.0-green.svg)
![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg)
2021-10-31 01:59:47 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%202019-Not%20compatible-red.svg)
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%202016%20(Feature%20Pack%202)-Not%20compatible-red.svg)
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
2021-10-31 01:59:47 -04:00
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2022-02-14 02:52:18 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2021-08-18 03:50:48 -04:00
## Applies to
- [SharePoint Framework](https://aka.ms/spfx)
2022-10-24 09:42:45 -04:00
- [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
2021-08-18 03:50:48 -04:00
2023-02-18 22:58:44 -05:00
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/m365devprogram)
2021-08-18 03:50:48 -04:00
## Prerequisites
* SharePoint Online tenant
* Approve below permissions from SharePoint Admin.
2022-03-28 20:38:21 -04:00
```json
2021-08-18 03:50:48 -04:00
"webApiPermissionRequests": [
{
"resource": "Microsoft Graph",
"scope": "Calendars.Read"
},
{
"resource": "Microsoft Graph",
"scope": "Calendars.ReadWrite"
}
]
```
2023-02-18 22:58:44 -05:00
## Contributors
2021-08-18 03:50:48 -04:00
2023-03-15 01:23:34 -04:00
* [Chandani Prajapati](https://github.com/chandaniprajapati)
2021-08-18 03:50:48 -04:00
## Version history
Version|Date|Comments
-------|----|--------
1.0 | August 18, 2021 | Initial release
2021-10-31 01:59:47 -04:00
1.1 | October 4, 2021 | Fixed date issue as start and end date are rendering incorrect in event card.
1.3 | March 25, 2022 | Upgraded to SPFx 1.15.
2021-08-18 03:50:48 -04:00
## Minimal Path to Awesome
2022-03-28 20:38:21 -04:00
- Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-my-events) then unzip it)
- From your command line, change your current directory to the directory containing this sample (`react-my-events`, located under `samples`)
2021-08-18 03:50:48 -04:00
- in the command-line run:
2021-11-07 02:18:53 -05:00
- `npm install`
- `gulp serve`
2021-08-18 03:50:48 -04:00
2022-02-14 02:52:18 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
2021-08-18 03:50:48 -04:00
## References
2022-10-24 09:42:45 -04:00
- [Getting started with SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
- [Building for Microsoft teams](https://learn.microsoft.com/sharepoint/dev/spfx/build-for-teams-overview)
- [Use Microsoft Graph in your solution](https://learn.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
- [Publish SharePoint Framework applications to the Marketplace](https://learn.microsoft.com/sharepoint/dev/spfx/publish-to-marketplace-overview)
2021-08-18 03:50:48 -04:00
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
2022-10-24 09:42:45 -04:00
- [Drive Graph END Point](https://learn.microsoft.com/graph/api/resources/driveitem?view=graph-rest-1.0)
2021-08-18 03:50:48 -04:00
2021-08-26 01:25:19 -04:00
## Help
2022-03-28 20:38:21 -04:00
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-my-events%22) to see if anybody else is having the same issues.
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-my-events) and see what the community is saying.
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-my-events&template=bug-report.yml&sample=react-my-events&authors=@chandaniprajapati&title=react-my-events%20-%20).
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-my-events&template=question.yml&sample=react-my-events&authors=@chandaniprajapati&title=react-my-events%20-%20).
2021-08-26 01:25:19 -04:00
2022-03-28 20:38:21 -04:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-my-events&template=suggestion.yml&sample=react-my-events&authors=@chandaniprajapati&title=react-my-events%20-%20).
2021-08-26 01:25:19 -04:00
2021-11-07 02:11:17 -05:00
## 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.**
2021-08-26 01:25:19 -04:00
2023-03-12 21:16:15 -04:00
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-my-events" />