honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/samples/react-github-badge
History
Hugo Bernier 103907bdc6 Added compatibility warning on readme and template 2023-02-10 10:22:32 -05:00
..
.devcontainer Added 1.8.2 containers 2022-02-16 00:00:27 -05:00
.vscode Companion sample to js-gitHubBadge sample (#847) 2019-05-04 18:05:57 +03:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Added v2 web part and upgraded to SPFx 1.8.2 (#877) 2019-06-07 11:13:23 +03:00
src Added v2 web part and upgraded to SPFx 1.8.2 (#877) 2019-06-07 11:13:23 +03:00
teams Added v2 web part and upgraded to SPFx 1.8.2 (#877) 2019-06-07 11:13:23 +03:00
.editorconfig Companion sample to js-gitHubBadge sample (#847) 2019-05-04 18:05:57 +03:00
.gitignore Added 1.8.2 containers 2022-02-16 00:00:27 -05:00
.yo-rc.json Added v2 web part and upgraded to SPFx 1.8.2 (#877) 2019-06-07 11:13:23 +03:00
README.md Added compatibility warning on readme and template 2023-02-10 10:22:32 -05:00
gulpfile.js Companion sample to js-gitHubBadge sample (#847) 2019-05-04 18:05:57 +03:00
package-lock.json Bump ua-parser-js from 0.7.19 to 0.7.33 in /samples/react-github-badge 2023-01-26 09:14:55 -05:00
package.json Bump json5, @microsoft/sp-build-web and @microsoft/sp-webpart-workbench 2023-01-01 02:43:35 -05:00
tsconfig.json Added v2 web part and upgraded to SPFx 1.8.2 (#877) 2019-06-07 11:13:23 +03:00
tslint.json Companion sample to js-gitHubBadge sample (#847) 2019-05-04 18:05:57 +03:00

README.md

GitHub Badge (React Version)

Summary

React version of Eric Skaggs @skaggej js-GitHubBadge sample.

Displays information about a GitHub user.

React GitHub Badge in action

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

Applies to

Solution

Solution Author(s)
react-github-badge Hugo Bernier (Tahoe Ninjas, @bernierh)
Converted from: js-GitHubBadge Eric Skaggs @skaggej

Version history

Version Date Comments
1.0 April 18, 2019 Initial release
2.0 June 06, 2019 Upgraded to SPFx 1.8.2. Added GitHub Badge v2.

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This sample illustrates how to convert an existing Javascript-only SPFx web part to a React SPFx web part while keeping the same look and feel. Please refer to the js-GitHubBadge sample for the original Javascript-only web part.

A second web part (called GitHub Badge v2) demonstrates how to render the same data using a Fabric UI persona card.

For more information about the conversion process, refer to this blog article.

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.