sp-dev-fx-webparts/samples/react-upgrade-me/README.md

57 lines
2.2 KiB
Markdown
Raw Normal View History

2020-08-27 00:12:13 -04:00
# Upgrade Me
## Summary
This web part does nothing, really. It is intended to be used to test upgrading SPFx web parts and demonstrating incompatibility issues between versions of SPFx and Node.js.
![picture of the web part in action](./assets/react-upgrade-me.png)
## Compatibility
2021-04-08 12:13:13 -04:00
![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg "SPFx 1.4.1 works with SharePoint 2019 and SharePoint Online")
![Node.js LTS 6.x | LTS 8.x](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20LTS%208.x-green.svg "Node.js LTS 6.x or 8.x is required to run SPFx 1.4.1")
![SharePoint 2019 | Online - It won't work with SharePoint 2016](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg "It won't work on SharePoint 2016")
![Teams Not compatible - Don't waste your time](https://img.shields.io/badge/Teams-Not%20compatible-red.svg "Don't waste your time")
![Workbench Local | Hosted - It works on my machine, and yours, and in the cloud](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg "It works on my machine, your machine, and in the cloud")
2020-08-27 00:12:13 -04:00
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
## Prerequisites
You'll need the [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/) in order to perform an upgrade.
## Solution
Solution|Author(s)
--------|---------
react-upgrade-me | Hugo Bernier ([Tahoe Ninjas](https://tahoeninjas.blog), [@bernierh](https://twitter.com/bernierh))
## Version history
Version|Date|Comments
-------|----|--------
1.0|August 26, 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
2020-08-27 00:53:38 -04:00
Not applicable.
2020-08-27 00:12:13 -04:00
## Features
This web part really does nothing. It is intended to be used with the CLI for Microsoft 365 [SPFx Project Upgrade](https://pnp.github.io/cli-microsoft365/cmd/spfx/project/project-upgrade/).
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-upgrade-me" />