110 lines
6.2 KiB
Markdown
110 lines
6.2 KiB
Markdown
# World Clocks
|
|
|
|
## Summary
|
|
|
|
- This sample is extension of the single World time clock sample that was provided in SP Starter Kit.
|
|
- This web part use SharePoint List to Show multiple Clocks.
|
|
- Each clock item can have Name, Timezone and status (Active, Yes/No).
|
|
- The web part properties will allow you to enter Web Part Title and select a List.
|
|
- The web part properties will allow you to show or hide time.
|
|
- You can show or hide clocks by setting the status to active or inactive.
|
|
- The web part does not update automatically. [Someone need to make the React Tick :)]
|
|
|
|
|
|
|
|
### Web Part in Action
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
**1) Create or use a list for World Clocks. The List should have the following Columns:**
|
|
|
|
- `Title`, `GMTValues`, `ListOrder`, `IsActive`.
|
|
|
|
|
|
|
|
- [World Clocks list Template for use with the Web Part](./assets/WorldClock.stp)
|
|
- [World Clocks Site Script use with the Web Part](./assets/WorldClock.json)
|
|
|
|
**2) Add the World Clocks web part to your page & Enter Title, Select List. You can also enable the other required settings.**
|
|
|
|
## Compatibility
|
|
|
|
| :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. |
|
|
|
|
|
|
|
|
|
|
|
|
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
|
|
|
|
|
|
|
|
|
|
|
## Applies to
|
|
|
|
- [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)
|
|
|
|
## Prerequisites
|
|
|
|
- A package is available for direct download.
|
|
|
|
Please create the list as described above
|
|
|
|
## Contributors
|
|
|
|
* [Jerry Yasir](https://github.com/jyasir) |
|
|
|
|
## Version history
|
|
|
|
| Version | Date | Comments |
|
|
| ------- | ------------------ | ------------- |
|
|
| 1.0 | September 26, 2020 | First Version |
|
|
|
|
## Minimal Path to Awesome
|
|
|
|
- Clone or download this repository
|
|
- From your command line, change your current directory to the directory containing this sample (`react-world-clocks`, located under `samples`)
|
|
- Run in command line:
|
|
- `npm install` to install the npm dependencies
|
|
- `gulp serve` to display in Developer Workbench (recommend using your tenant workbench so you can test with real lists within your site)
|
|
- To package and deploy:
|
|
- Use `gulp bundle --ship` & `gulp package-solution --ship`
|
|
- Add the `.sppkg` to your SharePoint App Catalog
|
|
|
|
> 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.
|
|
|
|
## Video
|
|
|
|
[](https://www.youtube.com/watch?v=91uQHUgpKo8 "Implementing a World Clocks web part with SharePoint Framework")
|
|
|
|
|
|
## Help
|
|
|
|
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-world-clocks") 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-world-clocks) and see what the community is saying.
|
|
|
|
If you encounter any issues while 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-world-clocks&template=bug-report.yml&sample=react-world-clocks&authors=@jyasir&title=react-world-clocks%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-world-clocks&template=question.yml&sample=react-world-clocks&authors=@jyasir&title=react-world-clocks%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-world-clocks&template=question.yml&sample=react-world-clocks&authors=@jyasir&title=react-world-clocks%20-%20).
|
|
|
|
## 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.**
|
|
|
|
|
|
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-world-clocks" />
|