sp-dev-fx-webparts/samples/react-world-clocks
Hugo Bernier 7e97daab76 Added more contributions 2023-03-15 01:23:34 -04:00
..
assets
config
dist
lib
sharepoint/solution
src
teams
tools
README.md Added more contributions 2023-03-15 01:23:34 -04:00
gulpfile.js
package-lock.json
package.json
placeholder.md
tsconfig.json
tslint.json
yarn.lock

README.md

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

Web Part in Action

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.

Create list for use with the World Clocks

2) Add the World Clocks web part to your page & Enter Title, Select List. You can also enable the other required settings.

Compatibility

⚠️ 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.11 Node.js v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Prerequisites

  • A package is available for direct download.

Please create the list as described above

Contributors

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. Visit https://aka.ms/spfx-devcontainer for further instructions.

Video

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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.