sp-dev-fx-webparts/samples/react-birthdays-per-month/README.md

105 lines
5.6 KiB
Markdown
Raw Normal View History

2022-12-02 20:46:31 -05:00
# Birthdays Per Month
2022-11-04 09:28:34 -04:00
## Summary
2022-12-02 21:08:23 -05:00
Display employees birthday per month in an accordion.
The birthday data is stored in a SharePoint List.
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
![App](assets/app.png)
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
## Compatibility
2022-11-04 09:28:34 -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. |
2022-12-02 20:46:31 -05:00
This sample is optimally compatible with the following environment configuration:
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg)
![Node.js v16 | v14 | v12](https://img.shields.io/badge/Node.js-v16%20%7C%20v14%20%7C%20v12-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.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")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
## Applies to
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/m365devprogram)
2022-11-04 09:28:34 -04:00
2023-02-18 22:58:44 -05:00
## Contributors
2022-12-02 20:46:31 -05:00
2023-03-15 00:11:27 -04:00
* [Ari Gunawan](https://github.com/AriGunawan)
2022-11-04 09:28:34 -04:00
## Version history
2022-12-02 20:46:31 -05:00
Version|Date|Comments
-------|----|--------
2022-12-02 20:48:20 -05:00
1.2|December 3, 2022|Initial version
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
## Prerequisites
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
Create `Birthdays` list with below columns:
Name|Type
----|----
Employee|Person
Month|Choice with month options (January, February, March, and so on)
Date|Number (Minimum 1 and maximum 31)
2022-11-04 09:28:34 -04:00
2022-12-02 21:08:23 -05:00
Insert employee birthday items into the list.
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
## Minimal path to awesome
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05: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-birthdays-per-month) then unzip it)
* From your command line, change your current directory to the directory containing this sample (`react-birthdays-per-month`, located under `samples`)
* in the command line run:
* `npm install`
* `gulp serve`
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -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.
2022-11-04 09:28:34 -04:00
## Features
2022-12-02 20:46:31 -05:00
Features of this web part:
2023-01-02 14:51:31 -05:00
2022-12-02 21:08:23 -05:00
* Show grouped employees based on their birthday's month.
2022-12-02 20:46:31 -05:00
* Show photo of the employee
* Button to send email to the selected employee
2022-12-03 21:40:14 -05:00
* Show remaining days until the employee's birthday
2022-12-02 20:46:31 -05:00
* Show month section started from current month
* Expand/Collapse month section
* Initially expand current and next month section
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
This Web Part illustrates the following concepts on top of the SharePoint Framework:
2023-01-02 14:51:31 -05:00
2022-12-02 20:46:31 -05:00
* Get data from a SharePoint List
* Create simple accordion component
* Show user's photo
* Use [Tailwind CSS](https://tailwindcss.com/) for styling component.
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
## Help
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05: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-birthdays-per-month%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-birthdays-per-month) 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-birthdays-per-month&template=bug-report.yml&sample=react-birthdays-per-month&authors=@AriGunawan&title=react-birthdays-per-month%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-birthdays-per-month&template=question.yml&sample=react-birthdays-per-month&authors=@AriGunawan&title=react-birthdays-per-month%20-%20).
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-birthdays-per-month&template=suggestion.yml&sample=react-birthdays-per-month&authors=@AriGunawan&title=react-birthdays-per-month%20-%20).
## Disclaimer
2022-11-04 09:28:34 -04:00
2022-12-02 20:46:31 -05:00
**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.**
2022-11-04 09:28:34 -04:00
2023-03-12 21:16:15 -04:00
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-birthdays-per-month" />