From 103907bdc676e839a534d8c93d8fab5c3c7026c6 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Fri, 10 Feb 2023 10:22:32 -0500 Subject: [PATCH] Added compatibility warning on readme and template --- samples/ace-strategy-pattern/README.md | 5 ++ samples/angular-aad-webapi/README.md | 5 ++ samples/angular-greeting/README.md | 5 ++ .../angular-todo-webpart/README.md | 5 ++ samples/angular-msgraph/README.md | 5 ++ samples/angular-multipage/README.md | 5 ++ .../README.md | 5 ++ samples/angular-search/README.md | 5 ++ samples/angular-todo/README.md | 5 ++ samples/angular2-prototype/README.md | 5 ++ samples/angularelements-helloworld/README.md | 5 ++ .../README.md | 5 ++ samples/bootstrap-slider/README.md | 5 ++ samples/handlebarsjs-webpack-loader/README.md | 5 ++ samples/jquery-cdn/README.md | 5 ++ samples/jquery-photopile/README.md | 5 ++ samples/js-advanced-commenting/README.md | 5 ++ samples/js-display-list/README.md | 5 ++ .../js-dynamic-bundling-libraries/README.md | 5 ++ samples/js-employee-spotlight/README.md | 5 ++ samples/js-extend-gulp/README.md | 5 ++ samples/js-extend-webpack/README.md | 5 ++ samples/js-gitHubBadge/README.md | 5 ++ samples/js-modern-calendar/README.md | 5 ++ samples/js-msgraph-thumbnail/README.md | 5 ++ samples/js-myflows/README.md | 7 ++- samples/js-powerbi-embedded/README.md | 5 ++ samples/js-propertycontrols-svg/README.md | 7 ++- samples/js-public-unjoined-teams/README.md | 5 ++ samples/js-skype-status/README.md | 5 ++ samples/js-solution-editions/README.md | 5 ++ samples/js-teams-meeting-app/README.md | 5 ++ samples/js-theme-manager-2019/README.md | 5 ++ samples/js-theme-manager/README.md | 5 ++ samples/js-workbench-customizer/README.md | 5 ++ .../knockout-dependent-properties/README.md | 5 ++ samples/knockout-sp-pnp-js/README.md | 5 ++ samples/knockout-taxonomy/README.md | 5 ++ samples/react-aad-implicitflow/README.md | 5 ++ .../react-accordion-dynamic-section/README.md | 5 ++ samples/react-accordion-section/README.md | 7 ++- .../react-accordion-with-richtext/README.md | 5 ++ samples/react-accordion/README.md | 5 ++ .../README.md | 5 ++ .../README.md | 5 ++ samples/react-adaptivecards-hooks/README.md | 5 ++ samples/react-adaptivecards/README.md | 5 ++ .../README.md | 5 ++ samples/react-add-js-css-ref/README.md | 5 ++ .../react-admin-sc-catalog-pnpjs/README.md | 5 ++ .../react-advanced-page-properties/README.md | 5 ++ samples/react-aggregated-calendar/README.md | 5 ++ samples/react-app-settings/README.md | 5 ++ samples/react-appinsights-dashboard/README.md | 5 ++ .../react-associated-sites-links/README.md | 5 ++ samples/react-async-await-sp-pnp-js/README.md | 23 ++----- samples/react-at-a-glance/README.md | 5 ++ samples/react-avatar/README.md | 5 ++ samples/react-azfunc-vimeo/README.md | 5 ++ .../react-azurefunction-northwind2/README.md | 5 ++ samples/react-birthdays-per-month/README.md | 5 ++ samples/react-birthdays/README.md | 5 ++ samples/react-bot-framework-secure/README.md | 5 ++ .../webpart/README.md | 5 ++ samples/react-bot-framework-sso/README.md | 5 ++ .../react-bot-framework-sso/webpart/README.md | 5 ++ samples/react-bot-framework/README.md | 5 ++ samples/react-calendar-feed/README.md | 5 ++ samples/react-calendar/README.md | 5 ++ samples/react-caml2table/README.md | 5 ++ samples/react-carousel/README.md | 5 ++ samples/react-chartcontrol/README.md | 5 ++ samples/react-chat-gpt/README.md | 5 ++ samples/react-check-flows/README.md | 7 ++- samples/react-check-user-group/README.md | 5 ++ samples/react-cherry-picked-content/README.md | 5 ++ samples/react-company-stories/README.md | 5 ++ samples/react-comparer/README.md | 5 ++ .../react-components-dynamicloading/README.md | 5 ++ samples/react-content-query-online/README.md | 5 ++ samples/react-content-query-onprem/README.md | 5 ++ samples/react-covid19-info/README.md | 5 ++ samples/react-cross-device-data/README.md | 5 ++ samples/react-css-in-js-typestyle/README.md | 5 ++ samples/react-csv-importer/README.md | 5 ++ samples/react-custom-links/README.md | 25 ++------ .../README.md | 5 ++ .../react-dall-e-image-generation/README.md | 5 ++ .../README.md | 5 ++ samples/react-datatable/README.md | 5 ++ samples/react-daterangepicker/README.md | 5 ++ .../AbstractFactory/README.md | 5 ++ .../Builder/README.md | 5 ++ .../FactoryMethod/README.md | 5 ++ .../Singleton/README.md | 5 ++ .../Solid/README.md | 5 ++ samples/react-dev-radar/README.md | 5 ++ samples/react-directory/README.md | 5 ++ samples/react-display-hierarchy/README.md | 5 ++ samples/react-doccard-faq/README.md | 5 ++ samples/react-documents-detailslist/README.md | 5 ++ samples/react-dynamics-crm-api/README.md | 5 ++ .../README.md | 5 ++ samples/react-emoji-ratings/README.md | 5 ++ .../react-enhanced-list-formatting/README.md | 5 ++ samples/react-enhanced-powerapps/README.md | 5 ++ samples/react-events-aggregator/README.md | 5 ++ samples/react-events-dynamicdata/README.md | 5 ++ samples/react-facebook-plugin/README.md | 5 ++ samples/react-faqapp/README.md | 5 ++ samples/react-faqs/README.md | 5 ++ samples/react-feature-framework/README.md | 5 ++ samples/react-feedback-sidebar/README.md | 5 ++ samples/react-feedback/README.md | 5 ++ samples/react-file-upload/README.md | 5 ++ samples/react-find-parker/README.md | 5 ++ samples/react-flighttracker/README.md | 5 ++ samples/react-flow-button/README.md | 5 ++ samples/react-fluentui-9/README.md | 5 ++ .../react-fluentui-theme-variant/README.md | 5 ++ samples/react-follow-document/README.md | 5 ++ .../README.md | 5 ++ .../README.md | 5 ++ samples/react-functional-component/README.md | 5 ++ .../README.md | 5 ++ .../README.md | 5 ++ samples/react-github-badge/README.md | 5 ++ samples/react-global-news-sp2019/README.md | 7 ++- samples/react-global-news/README.md | 5 ++ samples/react-google-fit/README.md | 5 ++ .../README.md | 5 ++ samples/react-graph-auto-batching/README.md | 5 ++ samples/react-graph-calendar/README.md | 5 ++ .../README.md | 5 ++ samples/react-graph-evalurl/README.md | 5 ++ samples/react-graph-feedback-form/README.md | 5 ++ samples/react-graph-groupviewer/README.md | 5 ++ samples/react-graph-mgt-client/README.md | 5 ++ samples/react-graph-personalemail/README.md | 8 ++- samples/react-graph-pnpjs/README.md | 5 ++ samples/react-graph-profile-awards/README.md | 5 ++ samples/react-graph-reports/README.md | 5 ++ .../react-graph-schema-extensions/README.md | 5 ++ .../react-graph-telephonedirectory/README.md | 5 ++ samples/react-group-members/README.md | 7 ++- .../react-group-membership-manager/README.md | 5 ++ samples/react-groups-teams/README.md | 63 ++++++++++--------- samples/react-hero-webpart/README.md | 5 ++ samples/react-holidays-calendar/README.md | 5 ++ samples/react-hooks/README.md | 5 ++ samples/react-htm-templating/README.md | 5 ++ samples/react-image-editor/README.md | 5 ++ samples/react-image-gallery/README.md | 5 ++ samples/react-image-magnifier/README.md | 5 ++ .../README.md | 7 ++- samples/react-interactive-map/README.md | 5 ++ samples/react-invitation-manager/README.md | 5 ++ samples/react-ioc-tests/README.md | 5 ++ samples/react-item-History/README.md | 5 ++ samples/react-jest-testing/README.md | 5 ++ samples/react-kanban-board/README.md | 5 ++ samples/react-list-form/README.md | 5 ++ .../react-list-items-menu-sp2019/README.md | 5 ++ samples/react-list-items-menu/README.md | 5 ++ samples/react-list-search/README.md | 5 ++ samples/react-lists-hide/README.md | 5 ++ samples/react-listview-context-ecb/README.md | 5 ++ samples/react-manage-o365-groups/README.md | 5 ++ .../README.md | 5 ++ samples/react-manage-sitedesigns/README.md | 5 ++ .../react-manage-spfx-solutions-alm/README.md | 5 ++ samples/react-material-ui/README.md | 5 ++ samples/react-members-with-presence/README.md | 8 ++- samples/react-mgtevents/README.md | 5 ++ samples/react-minesweeper/README.md | 5 ++ samples/react-mobx-multiple-stores/README.md | 11 ++-- samples/react-mobx/README.md | 7 ++- samples/react-modern-birthdays/README.md | 5 ++ samples/react-modern-charts/README.md | 5 ++ .../react-modern-organization-chart/README.md | 5 ++ samples/react-msal-msgraph/README.md | 5 ++ samples/react-msgraph-extension/README.md | 5 ++ samples/react-msgraph-peoplesearch/README.md | 5 ++ samples/react-multilist-grid/README.md | 5 ++ samples/react-multimedia-gallery/README.md | 5 ++ samples/react-multipage/README.md | 5 ++ samples/react-multiscreen-webpart/README.md | 5 ++ samples/react-my-approvals/README.md | 5 ++ samples/react-my-events/README.md | 5 ++ samples/react-my-groups/README.md | 5 ++ samples/react-my-onedrive-info/README.md | 5 ++ samples/react-my-personal-apps/README.md | 5 ++ samples/react-my-sites/README.md | 5 ++ samples/react-my-teams/README.md | 5 ++ samples/react-myonedrive/README.md | 5 ++ samples/react-mytasks/README.md | 5 ++ samples/react-news-banner/README.md | 5 ++ samples/react-news/README.md | 5 ++ samples/react-office-offer-creation/README.md | 5 ++ samples/react-officegraph/README.md | 5 ++ samples/react-offline-first/README.md | 5 ++ samples/react-onedrive-finder/README.md | 5 ++ samples/react-organisationchart/README.md | 7 ++- samples/react-organization-chart/README.md | 5 ++ samples/react-outlook-add-todo-task/README.md | 5 ++ samples/react-outlook-copy2teams/README.md | 5 ++ samples/react-page-navigator/README.md | 5 ++ .../react-page-sections-navigation/README.md | 5 ++ samples/react-pagecontributors/README.md | 5 ++ samples/react-pages-hierarchy/README.md | 5 ++ samples/react-palette-picker/README.md | 5 ++ samples/react-peoplepicker/README.md | 5 ++ samples/react-personal-greeting/README.md | 5 ++ samples/react-photo-sync/README.md | 5 ++ .../README.md | 5 ++ samples/react-pnp-controls/README.md | 5 ++ samples/react-pnp-js-hooks/README.md | 5 ++ samples/react-pnp-js-sample/README.md | 23 ++----- samples/react-pnpjs-project-online/README.md | 5 ++ .../react-pnpjs-spsite-er-diagram/README.md | 5 ++ samples/react-pnpjsexplorer/README.md | 5 ++ samples/react-ppp-pnp-controls/README.md | 5 ++ samples/react-ppw-html/README.md | 5 ++ samples/react-private-libraries/README.md | 5 ++ samples/react-project-online/README.md | 5 ++ samples/react-property-bag-editor/README.md | 5 ++ samples/react-provision-assets/README.md | 5 ++ samples/react-questions-and-answers/README.md | 5 ++ samples/react-quick-poll/README.md | 5 ++ samples/react-quotes/README.md | 5 ++ samples/react-realtime-documents/README.md | 5 ++ samples/react-recaptcha/README.md | 5 ++ .../react-redux-async-immutablejs/README.md | 5 ++ samples/react-redux/README.md | 7 ++- samples/react-reduxform/README.md | 5 ++ .../README.md | 5 ++ samples/react-restaurant-menu/README.md | 5 ++ .../README.md | 5 ++ samples/react-roomchat/README.md | 5 ++ samples/react-rss-reader/README.md | 5 ++ samples/react-rxjs-event-emitter/README.md | 5 ++ samples/react-save-attachments/README.md | 5 ++ .../README.md | 5 ++ .../library/README.md | 5 ++ .../webpart/README.md | 5 ++ samples/react-script-editor-onprem/README.md | 5 ++ samples/react-script-editor/README.md | 5 ++ samples/react-search/README.md | 5 ++ samples/react-securitygrid/README.md | 5 ++ samples/react-side-panel/README.md | 23 ++----- .../react-site-provisioning-manager/README.md | 5 ++ samples/react-sitepages-metadata/README.md | 5 ++ samples/react-sites-selected-admin/README.md | 5 ++ samples/react-skype-status/README.md | 5 ++ samples/react-slide-swiper/README.md | 5 ++ .../README.md | 5 ++ samples/react-soccer-highlights/README.md | 5 ++ samples/react-sp-elevatedprivileges/README.md | 5 ++ .../README.md | 7 ++- samples/react-sp-site-user-groups/README.md | 5 ++ samples/react-spupsproperty-sync/README.md | 5 ++ .../react-staff-directory-sp2019/README.md | 26 ++------ samples/react-staffdirectory/README.md | 5 ++ samples/react-star-ratings/README.md | 5 ++ samples/react-tabacordion/README.md | 5 ++ samples/react-tailwindcss/README.md | 5 ++ samples/react-target-audience/README.md | 5 ++ .../react-taxonomy-file-explorer/README.md | 5 ++ samples/react-taxonomypicker-panel/README.md | 5 ++ samples/react-taxonomypicker/README.md | 5 ++ samples/react-team-creator/README.md | 7 ++- samples/react-teams-configure-tab/README.md | 5 ++ .../react-teams-graph-upload-as-pdf/README.md | 5 ++ samples/react-teams-lead-dashboard/README.md | 5 ++ .../README.md | 5 ++ .../react-teams-membership-updater/README.md | 5 ++ samples/react-teams-message-user/README.md | 5 ++ samples/react-teams-message/README.md | 5 ++ .../README.md | 5 ++ .../react-teams-send-notification/README.md | 5 ++ .../README.md | 5 ++ samples/react-teams-tabs-pnpjs/README.md | 5 ++ samples/react-teams-tagging/README.md | 5 ++ samples/react-tenant-properties/README.md | 5 ++ samples/react-themes/README.md | 23 ++----- samples/react-tiles-v2/README.md | 5 ++ samples/react-timeline/README.md | 5 ++ samples/react-tinymce/README.md | 5 ++ samples/react-todo-basic/README.md | 5 ++ samples/react-tour-pnpjs/README.md | 5 ++ samples/react-tree-orgchart/README.md | 5 ++ samples/react-twitter/README.md | 5 ++ samples/react-upgrade-me/README.md | 7 ++- samples/react-versiondisplay/README.md | 27 ++------ samples/react-video-banner/README.md | 5 ++ samples/react-videolibrary/README.md | 5 ++ samples/react-visio/README.md | 5 ++ samples/react-webcam/README.md | 5 ++ samples/react-webhooks-realtime/README.md | 5 ++ samples/react-webpartdetails/README.md | 5 ++ samples/react-word-game/README.md | 5 ++ samples/react-world-clocks/README.md | 5 ++ samples/react-yammer-api/README.md | 5 ++ samples/react-yammer-praise/README.md | 5 ++ samples/react-youtube/README.md | 7 ++- samples/react-zod/README.md | 5 ++ samples/react-zpl-viewer/README.md | 8 ++- samples/riot-list/README.md | 5 ++ samples/sharepoint-crud/README.md | 5 ++ samples/vue-js-org-chart/README.md | 7 ++- .../README.md | 5 ++ templates/README-template.md | 6 +- 312 files changed, 1601 insertions(+), 198 deletions(-) diff --git a/samples/ace-strategy-pattern/README.md b/samples/ace-strategy-pattern/README.md index 574a00b1c..1f539739f 100644 --- a/samples/ace-strategy-pattern/README.md +++ b/samples/ace-strategy-pattern/README.md @@ -24,6 +24,11 @@ With a better isolation and testability of our actions. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-aad-webapi/README.md b/samples/angular-aad-webapi/README.md index 93c2750e7..c16353f6f 100644 --- a/samples/angular-aad-webapi/README.md +++ b/samples/angular-aad-webapi/README.md @@ -26,6 +26,11 @@ Sample SharePoint Framework client-side web part illustrating communication with ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-greeting/README.md b/samples/angular-greeting/README.md index 7ce17b528..9416f9a3f 100644 --- a/samples/angular-greeting/README.md +++ b/samples/angular-greeting/README.md @@ -11,6 +11,11 @@ Final outcome: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/angular-migration/angular-todo-webpart/README.md b/samples/angular-migration/angular-todo-webpart/README.md index cec0c5787..f4113bace 100755 --- a/samples/angular-migration/angular-todo-webpart/README.md +++ b/samples/angular-migration/angular-todo-webpart/README.md @@ -9,6 +9,11 @@ Sample SharePoint Framework client-side web part for managing tasks stored in a ## 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 for more information on SPFx compatibility. | + ![SPFx 0.5.1](https://img.shields.io/badge/SPFx-0.5.1-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-msgraph/README.md b/samples/angular-msgraph/README.md index 8f243acd8..f52cb2630 100644 --- a/samples/angular-msgraph/README.md +++ b/samples/angular-msgraph/README.md @@ -40,6 +40,11 @@ display all the lists associated with the site followed by all the items inside ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-multipage/README.md b/samples/angular-multipage/README.md index 2706ed6a3..6769cd37d 100644 --- a/samples/angular-multipage/README.md +++ b/samples/angular-multipage/README.md @@ -27,6 +27,11 @@ This sample contains a poll web part allowing users to vote and view the results ## 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 for more information on SPFx compatibility. | + ![SPFx 0.5.0](https://img.shields.io/badge/SPFx-0.5.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-ngofficeuifabric-file-upload/README.md b/samples/angular-ngofficeuifabric-file-upload/README.md index 83e1158d0..0e9b67d79 100644 --- a/samples/angular-ngofficeuifabric-file-upload/README.md +++ b/samples/angular-ngofficeuifabric-file-upload/README.md @@ -27,6 +27,11 @@ Edit web part properties to set Document library Name. Initially, It has been se ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-search/README.md b/samples/angular-search/README.md index dd8ac7296..f6071bf40 100644 --- a/samples/angular-search/README.md +++ b/samples/angular-search/README.md @@ -34,6 +34,11 @@ The logic for querying the SharePoint Content Types in the properties of the web ## 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 for more information on SPFx compatibility. | + ![SPFx 0.9.0](https://img.shields.io/badge/SPFx-0.9.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular-todo/README.md b/samples/angular-todo/README.md index 4b76080f3..7ec32f8fd 100644 --- a/samples/angular-todo/README.md +++ b/samples/angular-todo/README.md @@ -24,6 +24,11 @@ Sample Web Part illustrating using Angular with the SharePoint Framework. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angular2-prototype/README.md b/samples/angular2-prototype/README.md index d55a83ee0..f91ebd5d4 100644 --- a/samples/angular2-prototype/README.md +++ b/samples/angular2-prototype/README.md @@ -31,6 +31,11 @@ Sample To Do Web Part built with Angular2. This sample illustrates how you can u ## 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 for more information on SPFx compatibility. | + ![SPFx 0.9.0](https://img.shields.io/badge/SPFx-0.9.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angularelements-helloworld/README.md b/samples/angularelements-helloworld/README.md index 8cdd9b3af..b62d2b675 100644 --- a/samples/angularelements-helloworld/README.md +++ b/samples/angularelements-helloworld/README.md @@ -22,6 +22,11 @@ Set of sample web parts illustrating how to use Angular Elements in the SharePoi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/angularelements-html-templatefile/README.md b/samples/angularelements-html-templatefile/README.md index 534e79034..771d34dff 100644 --- a/samples/angularelements-html-templatefile/README.md +++ b/samples/angularelements-html-templatefile/README.md @@ -23,6 +23,11 @@ A sample web part illustrating how to use Angular Elements in the SharePoint Fra ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/bootstrap-slider/README.md b/samples/bootstrap-slider/README.md index 9988f8a38..7dfa5e8af 100644 --- a/samples/bootstrap-slider/README.md +++ b/samples/bootstrap-slider/README.md @@ -28,6 +28,11 @@ Sample bootstrap slider which pulls the slides from a list inside the SharePoint ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/handlebarsjs-webpack-loader/README.md b/samples/handlebarsjs-webpack-loader/README.md index b8a70b270..6aebe2e24 100644 --- a/samples/handlebarsjs-webpack-loader/README.md +++ b/samples/handlebarsjs-webpack-loader/README.md @@ -19,6 +19,11 @@ This sample demonstrate how to set up SPFx to use [Handlebars](http://handlebars ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/jquery-cdn/README.md b/samples/jquery-cdn/README.md index 67753d801..b6ef5919d 100644 --- a/samples/jquery-cdn/README.md +++ b/samples/jquery-cdn/README.md @@ -27,6 +27,11 @@ This is a sample web Part that illustrates the use of jQuery and its plugins loa ## 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 for more information on SPFx compatibility. | + ![SPFx 0.2.0](https://img.shields.io/badge/SPFx-0.2.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/jquery-photopile/README.md b/samples/jquery-photopile/README.md index ada66ea6a..61ffd52f6 100644 --- a/samples/jquery-photopile/README.md +++ b/samples/jquery-photopile/README.md @@ -30,6 +30,11 @@ simulates a pile of photos scattered about on a surface. Thumbnail clicks remove ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-advanced-commenting/README.md b/samples/js-advanced-commenting/README.md index 14022bdf4..39dbe8d87 100644 --- a/samples/js-advanced-commenting/README.md +++ b/samples/js-advanced-commenting/README.md @@ -40,6 +40,11 @@ ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/js-display-list/README.md b/samples/js-display-list/README.md index 8bbd1135b..9e73547ae 100644 --- a/samples/js-display-list/README.md +++ b/samples/js-display-list/README.md @@ -24,6 +24,11 @@ This simplistic sample web part demonstrates the use of JavaScript in a SharePoi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/js-dynamic-bundling-libraries/README.md b/samples/js-dynamic-bundling-libraries/README.md index f2aa983ca..596a915e5 100644 --- a/samples/js-dynamic-bundling-libraries/README.md +++ b/samples/js-dynamic-bundling-libraries/README.md @@ -11,6 +11,11 @@ Post Button Click that imports jQuery and additional functionality: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-employee-spotlight/README.md b/samples/js-employee-spotlight/README.md index f7133e064..313f0362e 100644 --- a/samples/js-employee-spotlight/README.md +++ b/samples/js-employee-spotlight/README.md @@ -41,6 +41,11 @@ Simple Web Part that demonstrates the use of SharePoint Framework for show casin ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.0](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v6 | v5](https://img.shields.io/badge/Node.js-v6%20%7C%20v5-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-extend-gulp/README.md b/samples/js-extend-gulp/README.md index d88a27979..e206221c3 100644 --- a/samples/js-extend-gulp/README.md +++ b/samples/js-extend-gulp/README.md @@ -32,6 +32,11 @@ Read the following documentation for detailed information on integrating gulp ta ## 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 for more information on SPFx compatibility. | + ![SPFx 0.7.0](https://img.shields.io/badge/SPFx-0.7.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-extend-webpack/README.md b/samples/js-extend-webpack/README.md index 37ada256d..b1b6d75ac 100644 --- a/samples/js-extend-webpack/README.md +++ b/samples/js-extend-webpack/README.md @@ -26,6 +26,11 @@ Read the following documentation for detailed information on working with webpac ## 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 for more information on SPFx compatibility. | + ![SPFx 1.3.0](https://img.shields.io/badge/SPFx-1.3.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-gitHubBadge/README.md b/samples/js-gitHubBadge/README.md index 9d59692cb..e6cccb52c 100644 --- a/samples/js-gitHubBadge/README.md +++ b/samples/js-gitHubBadge/README.md @@ -7,6 +7,11 @@ Displays information from GitHub for a specified user. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.0](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v6 | v5](https://img.shields.io/badge/Node.js-v6%20%7C%20v5-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-modern-calendar/README.md b/samples/js-modern-calendar/README.md index e1f9499c4..04b950e5f 100644 --- a/samples/js-modern-calendar/README.md +++ b/samples/js-modern-calendar/README.md @@ -23,6 +23,11 @@ This is a modern web part built using the [SharePoint Framework](https://dev.off ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-msgraph-thumbnail/README.md b/samples/js-msgraph-thumbnail/README.md index fd58e3800..29c90f001 100644 --- a/samples/js-msgraph-thumbnail/README.md +++ b/samples/js-msgraph-thumbnail/README.md @@ -26,6 +26,11 @@ The goal of the sample is to illustrate a single call calling pattern for the th ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-myflows/README.md b/samples/js-myflows/README.md index 4eed1c32d..1dda1881f 100755 --- a/samples/js-myflows/README.md +++ b/samples/js-myflows/README.md @@ -23,7 +23,12 @@ ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) diff --git a/samples/js-powerbi-embedded/README.md b/samples/js-powerbi-embedded/README.md index a0815253f..9a88fbfa1 100644 --- a/samples/js-powerbi-embedded/README.md +++ b/samples/js-powerbi-embedded/README.md @@ -25,6 +25,11 @@ This sample SharePoint Framework client-side web part embedding a PowerBI report ## 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 for more information on SPFx compatibility. | + ![SPFx 0.2.0](https://img.shields.io/badge/SPFx-0.2.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-propertycontrols-svg/README.md b/samples/js-propertycontrols-svg/README.md index f08d461df..b27920a58 100644 --- a/samples/js-propertycontrols-svg/README.md +++ b/samples/js-propertycontrols-svg/README.md @@ -10,7 +10,12 @@ An SPFx web part that displays a Scalable Vector Graphics (SVG) image using prop ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v14-green.svg) diff --git a/samples/js-public-unjoined-teams/README.md b/samples/js-public-unjoined-teams/README.md index 2defb0a6b..b39ab3740 100644 --- a/samples/js-public-unjoined-teams/README.md +++ b/samples/js-public-unjoined-teams/README.md @@ -8,6 +8,11 @@ This web part lists all the public teams the current user is not yet a member of ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.1](https://img.shields.io/badge/SPFx-1.7.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-skype-status/README.md b/samples/js-skype-status/README.md index 0cc08f730..1c3edd85f 100644 --- a/samples/js-skype-status/README.md +++ b/samples/js-skype-status/README.md @@ -27,6 +27,11 @@ See the demo: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.0](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v6 | v5](https://img.shields.io/badge/Node.js-v6%20%7C%20v5-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-solution-editions/README.md b/samples/js-solution-editions/README.md index 43f45bfd8..5c6165c66 100644 --- a/samples/js-solution-editions/README.md +++ b/samples/js-solution-editions/README.md @@ -17,6 +17,11 @@ This sample shows a possible approach of handling multiple editions (e.g. trial, ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-teams-meeting-app/README.md b/samples/js-teams-meeting-app/README.md index 8dab5f300..a62e84db1 100644 --- a/samples/js-teams-meeting-app/README.md +++ b/samples/js-teams-meeting-app/README.md @@ -10,6 +10,11 @@ This project demonstrates a SPFx web part used as a Microsoft Teams meetings app ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js LTS 14.x](https://img.shields.io/badge/Node.js-LTS%2014.x-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/js-theme-manager-2019/README.md b/samples/js-theme-manager-2019/README.md index fab71f74c..7c15eee17 100644 --- a/samples/js-theme-manager-2019/README.md +++ b/samples/js-theme-manager-2019/README.md @@ -16,6 +16,11 @@ NOTE: This is a great option to provide theme management of a Site Collection wi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-theme-manager/README.md b/samples/js-theme-manager/README.md index eb2274e90..472123738 100644 --- a/samples/js-theme-manager/README.md +++ b/samples/js-theme-manager/README.md @@ -28,6 +28,11 @@ NOTE: This is a great option to provide theme management of a Site Collection wi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/js-workbench-customizer/README.md b/samples/js-workbench-customizer/README.md index 87116acb4..eaefb5843 100644 --- a/samples/js-workbench-customizer/README.md +++ b/samples/js-workbench-customizer/README.md @@ -26,6 +26,11 @@ Alternatively, you can add the output files for the web part to a custom SPFx pr ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/knockout-dependent-properties/README.md b/samples/knockout-dependent-properties/README.md index a71438e1e..89f676085 100644 --- a/samples/knockout-dependent-properties/README.md +++ b/samples/knockout-dependent-properties/README.md @@ -26,6 +26,11 @@ Sample Web Part illustrating ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.1](https://img.shields.io/badge/SPFx-1.0.1-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/knockout-sp-pnp-js/README.md b/samples/knockout-sp-pnp-js/README.md index d2b717fc4..4b48f0c76 100644 --- a/samples/knockout-sp-pnp-js/README.md +++ b/samples/knockout-sp-pnp-js/README.md @@ -23,6 +23,11 @@ This web part demonstrates how to integrate the @pnp/sp library into the SharePo ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/knockout-taxonomy/README.md b/samples/knockout-taxonomy/README.md index 1fe926abe..6ff771b81 100644 --- a/samples/knockout-taxonomy/README.md +++ b/samples/knockout-taxonomy/README.md @@ -25,6 +25,11 @@ Sample Web Part illustrating ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-aad-implicitflow/README.md b/samples/react-aad-implicitflow/README.md index 6130c0b17..2b430032c 100644 --- a/samples/react-aad-implicitflow/README.md +++ b/samples/react-aad-implicitflow/README.md @@ -29,6 +29,11 @@ Sample SharePoint Framework client-side web part built using React showing upcom ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-accordion-dynamic-section/README.md b/samples/react-accordion-dynamic-section/README.md index 320a1fb22..bab66972b 100644 --- a/samples/react-accordion-dynamic-section/README.md +++ b/samples/react-accordion-dynamic-section/README.md @@ -33,6 +33,11 @@ ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-accordion-section/README.md b/samples/react-accordion-section/README.md index fabf672e5..9790c80d4 100644 --- a/samples/react-accordion-section/README.md +++ b/samples/react-accordion-section/README.md @@ -27,7 +27,12 @@ ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) diff --git a/samples/react-accordion-with-richtext/README.md b/samples/react-accordion-with-richtext/README.md index 33a7b3440..e4f6ed712 100644 --- a/samples/react-accordion-with-richtext/README.md +++ b/samples/react-accordion-with-richtext/README.md @@ -25,6 +25,11 @@ extensions: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-accordion/README.md b/samples/react-accordion/README.md index e337576a0..3d88edf6b 100644 --- a/samples/react-accordion/README.md +++ b/samples/react-accordion/README.md @@ -24,6 +24,11 @@ This is a sample web Part that illustrates the use of React Accessible Accordion ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-adaptive-card-host-control/README.md b/samples/react-adaptive-card-host-control/README.md index 3cd59fe77..f6b34434e 100644 --- a/samples/react-adaptive-card-host-control/README.md +++ b/samples/react-adaptive-card-host-control/README.md @@ -16,6 +16,11 @@ For more information about the component, please see the related page here: [htt ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-adaptive-cards-image-gallery/README.md b/samples/react-adaptive-cards-image-gallery/README.md index 35d43a96e..86f63336e 100644 --- a/samples/react-adaptive-cards-image-gallery/README.md +++ b/samples/react-adaptive-cards-image-gallery/README.md @@ -45,6 +45,11 @@ Below NPM packages are used to develop this sample. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-adaptivecards-hooks/README.md b/samples/react-adaptivecards-hooks/README.md index 2419acf98..58172c88a 100644 --- a/samples/react-adaptivecards-hooks/README.md +++ b/samples/react-adaptivecards-hooks/README.md @@ -9,6 +9,11 @@ A version of [react-adaptivecards](https://github.com/pnp/sp-dev-fx-webparts/tre ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-adaptivecards/README.md b/samples/react-adaptivecards/README.md index e7ea061db..29ac51814 100644 --- a/samples/react-adaptivecards/README.md +++ b/samples/react-adaptivecards/README.md @@ -13,6 +13,11 @@ This sample creates an Adaptive Cards Host web part that you can use to display ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-add-formcustomizer-to-list/README.md b/samples/react-add-formcustomizer-to-list/README.md index 594aaa88a..668d19957 100644 --- a/samples/react-add-formcustomizer-to-list/README.md +++ b/samples/react-add-formcustomizer-to-list/README.md @@ -22,6 +22,11 @@ Note - This web part only serve to associate the Form customizer, so it is requi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.0](https://img.shields.io/badge/SPFx-1.15.0-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) diff --git a/samples/react-add-js-css-ref/README.md b/samples/react-add-js-css-ref/README.md index 193d71b68..2785bf087 100644 --- a/samples/react-add-js-css-ref/README.md +++ b/samples/react-add-js-css-ref/README.md @@ -41,6 +41,11 @@ Path can be `/sites/mysc/style library/js/custom.js` or `/sites/mysc/style libra ## 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 for more information on SPFx compatibility. | + ![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) diff --git a/samples/react-admin-sc-catalog-pnpjs/README.md b/samples/react-admin-sc-catalog-pnpjs/README.md index 3ac8b5102..9c92cc465 100644 --- a/samples/react-admin-sc-catalog-pnpjs/README.md +++ b/samples/react-admin-sc-catalog-pnpjs/README.md @@ -10,6 +10,11 @@ It needs Globlal Administrator or SharePoint Online Administrator permissions in ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-advanced-page-properties/README.md b/samples/react-advanced-page-properties/README.md index ac93acc94..ae3440969 100644 --- a/samples/react-advanced-page-properties/README.md +++ b/samples/react-advanced-page-properties/README.md @@ -16,6 +16,11 @@ Attempts to replicate the functionality of Page Properties with the following im ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-aggregated-calendar/README.md b/samples/react-aggregated-calendar/README.md index 8e997ee85..07a9d8f5f 100644 --- a/samples/react-aggregated-calendar/README.md +++ b/samples/react-aggregated-calendar/README.md @@ -18,6 +18,11 @@ Web part is developed using below technologies ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-app-settings/README.md b/samples/react-app-settings/README.md index 4a60c08a4..1aeb641b4 100644 --- a/samples/react-app-settings/README.md +++ b/samples/react-app-settings/README.md @@ -29,6 +29,11 @@ Azure DevOps pipelines configurations are included to demonstrate how the AppSet ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.1](https://img.shields.io/badge/SPFx-1.7.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-appinsights-dashboard/README.md b/samples/react-appinsights-dashboard/README.md index 41265c69b..0324e716a 100644 --- a/samples/react-appinsights-dashboard/README.md +++ b/samples/react-appinsights-dashboard/README.md @@ -22,6 +22,11 @@ This web part displays different statistics data captured in the **Azure Applica ## 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 for more information on SPFx compatibility. | + ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) ![Node.js v16](https://img.shields.io/badge/Node.js-v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-associated-sites-links/README.md b/samples/react-associated-sites-links/README.md index e820b70f0..ed07ce5d7 100644 --- a/samples/react-associated-sites-links/README.md +++ b/samples/react-associated-sites-links/README.md @@ -12,6 +12,11 @@ For instance, below is the result when there are 5 sites (React Zod, SPFx Sample ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) ![Node.js v14 | v16](https://img.shields.io/badge/Node.js-v14%20%7C%20v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-async-await-sp-pnp-js/README.md b/samples/react-async-await-sp-pnp-js/README.md index 13212556f..90909deb5 100644 --- a/samples/react-async-await-sp-pnp-js/README.md +++ b/samples/react-async-await-sp-pnp-js/README.md @@ -1,21 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - platforms: - - react - createdDate: 5/1/2017 12:00:00 AM ---- # Using @pnp/js with Async / Await ## Summary @@ -26,7 +8,10 @@ This web part demonstrates how to use [PnPJS](https://pnp.github.io/pnpjs/) with ## Compatibility -## 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 for more information on SPFx compatibility. | ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) diff --git a/samples/react-at-a-glance/README.md b/samples/react-at-a-glance/README.md index d4b236b7b..d2ae55546 100644 --- a/samples/react-at-a-glance/README.md +++ b/samples/react-at-a-glance/README.md @@ -34,6 +34,11 @@ The idea is based of the *At a glance* section of a news in the BBC news app (be ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-avatar/README.md b/samples/react-avatar/README.md index a065f3d26..49d252b3c 100644 --- a/samples/react-avatar/README.md +++ b/samples/react-avatar/README.md @@ -16,6 +16,11 @@ This is a sample web part that helps user create their avatar and save as profil ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11.1](https://img.shields.io/badge/SPFx-1.11.1-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-azfunc-vimeo/README.md b/samples/react-azfunc-vimeo/README.md index 32038040e..0115e56c9 100644 --- a/samples/react-azfunc-vimeo/README.md +++ b/samples/react-azfunc-vimeo/README.md @@ -8,6 +8,11 @@ This project contains two separate project folders: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-azurefunction-northwind2/README.md b/samples/react-azurefunction-northwind2/README.md index 67e5f1a16..f5496f021 100644 --- a/samples/react-azurefunction-northwind2/README.md +++ b/samples/react-azurefunction-northwind2/README.md @@ -11,6 +11,11 @@ You must create a database in azure and run the scripts ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/react-birthdays-per-month/README.md b/samples/react-birthdays-per-month/README.md index 64dde60ee..7dae90e22 100644 --- a/samples/react-birthdays-per-month/README.md +++ b/samples/react-birthdays-per-month/README.md @@ -9,6 +9,11 @@ The birthday data is stored in a SharePoint List. ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/react-birthdays/README.md b/samples/react-birthdays/README.md index 3c5c403a2..aa3cd7487 100644 --- a/samples/react-birthdays/README.md +++ b/samples/react-birthdays/README.md @@ -17,6 +17,11 @@ But you can synchronize the Birthdays list with other applications HR Systems, o ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20|%20v12-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-bot-framework-secure/README.md b/samples/react-bot-framework-secure/README.md index 29584b470..f820f1589 100644 --- a/samples/react-bot-framework-secure/README.md +++ b/samples/react-bot-framework-secure/README.md @@ -21,6 +21,11 @@ This demo does not include any threat models and is designed for educational pur ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-bot-framework-secure/webpart/README.md b/samples/react-bot-framework-secure/webpart/README.md index 88a480004..68be506b0 100644 --- a/samples/react-bot-framework-secure/webpart/README.md +++ b/samples/react-bot-framework-secure/webpart/README.md @@ -7,6 +7,11 @@ A web part sample that uses the [botframework-webchat module](https://www.npmjs. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-bot-framework-sso/README.md b/samples/react-bot-framework-sso/README.md index 94e1be374..f77a212c8 100644 --- a/samples/react-bot-framework-sso/README.md +++ b/samples/react-bot-framework-sso/README.md @@ -21,6 +21,11 @@ This demo does not include any threat models and is designed for educational pur ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-bot-framework-sso/webpart/README.md b/samples/react-bot-framework-sso/webpart/README.md index 6c902da9f..f7fcb0f37 100644 --- a/samples/react-bot-framework-sso/webpart/README.md +++ b/samples/react-bot-framework-sso/webpart/README.md @@ -8,6 +8,11 @@ An web parts sample that uses the [botframework-webchat module](https://www.npmj ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-bot-framework/README.md b/samples/react-bot-framework/README.md index c075a3275..dc97fd6d5 100644 --- a/samples/react-bot-framework/README.md +++ b/samples/react-bot-framework/README.md @@ -29,6 +29,11 @@ where sample was demonstrated. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-calendar-feed/README.md b/samples/react-calendar-feed/README.md index 768cd83f7..074a50ebd 100644 --- a/samples/react-calendar-feed/README.md +++ b/samples/react-calendar-feed/README.md @@ -25,6 +25,11 @@ For more information about how this solution was built, including some design de ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/react-calendar/README.md b/samples/react-calendar/README.md index ae7cb2d14..f95e50774 100644 --- a/samples/react-calendar/README.md +++ b/samples/react-calendar/README.md @@ -86,6 +86,11 @@ The Web Part checks the user's permissions for the View, Add, Edit, and Delete e ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10.0](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-caml2table/README.md b/samples/react-caml2table/README.md index 509b28f76..02fa82b0a 100644 --- a/samples/react-caml2table/README.md +++ b/samples/react-caml2table/README.md @@ -8,6 +8,11 @@ Let's the user test CAML queries at ease. ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/react-carousel/README.md b/samples/react-carousel/README.md index 80f196850..069b94878 100644 --- a/samples/react-carousel/README.md +++ b/samples/react-carousel/README.md @@ -27,6 +27,11 @@ It uses Microsoft Graph API to get image/video url and use PnPjs to load files f ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-chartcontrol/README.md b/samples/react-chartcontrol/README.md index 767ae944b..8d066d90d 100644 --- a/samples/react-chartcontrol/README.md +++ b/samples/react-chartcontrol/README.md @@ -170,6 +170,11 @@ This sample shows how to use X and Y coordinate data elements in a scatter chart ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-chat-gpt/README.md b/samples/react-chat-gpt/README.md index bf6f9b179..3fd6fee56 100644 --- a/samples/react-chat-gpt/README.md +++ b/samples/react-chat-gpt/README.md @@ -14,6 +14,11 @@ This webpart uses Chat GPT in an SPFx web part. You can ask questions from the w ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) diff --git a/samples/react-check-flows/README.md b/samples/react-check-flows/README.md index b39adff4b..975f327f7 100644 --- a/samples/react-check-flows/README.md +++ b/samples/react-check-flows/README.md @@ -12,7 +12,12 @@ The web part only displays the flows which are shared with the current user and ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) diff --git a/samples/react-check-user-group/README.md b/samples/react-check-user-group/README.md index 2aae367b2..939b00d74 100644 --- a/samples/react-check-user-group/README.md +++ b/samples/react-check-user-group/README.md @@ -8,6 +8,11 @@ This web part finds all the Office 365 or AAD Security groups a user is a member ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-cherry-picked-content/README.md b/samples/react-cherry-picked-content/README.md index 99a87ebf1..dd6b98e55 100644 --- a/samples/react-cherry-picked-content/README.md +++ b/samples/react-cherry-picked-content/README.md @@ -8,6 +8,11 @@ The Cherry-Picked Content Web Part is a modern replacement for the classic Conte ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-company-stories/README.md b/samples/react-company-stories/README.md index d08edc7e6..55cc830c5 100644 --- a/samples/react-company-stories/README.md +++ b/samples/react-company-stories/README.md @@ -8,6 +8,11 @@ This web part allows you to add images to a SharePoint List, and renders them wi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-comparer/README.md b/samples/react-comparer/README.md index 1b96db71d..e49c75086 100644 --- a/samples/react-comparer/README.md +++ b/samples/react-comparer/README.md @@ -57,6 +57,11 @@ The file picker includes the following tabs: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.1](https://img.shields.io/badge/SPFx-1.7.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-components-dynamicloading/README.md b/samples/react-components-dynamicloading/README.md index a7ef0cf17..5a7d3ef11 100644 --- a/samples/react-components-dynamicloading/README.md +++ b/samples/react-components-dynamicloading/README.md @@ -8,6 +8,11 @@ Load React components and third-party packages on demand in SPFx ## 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 for more information on SPFx compatibility. | + ![SPFx 1.6](https://img.shields.io/badge/SPFx-1.6.0-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-content-query-online/README.md b/samples/react-content-query-online/README.md index 6fbaaf441..620cc349b 100644 --- a/samples/react-content-query-online/README.md +++ b/samples/react-content-query-online/README.md @@ -13,6 +13,11 @@ While the original web part was based on an **XSLT** templating engine, this *Re ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) ![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower") diff --git a/samples/react-content-query-onprem/README.md b/samples/react-content-query-onprem/README.md index aa18e8260..7d78cb46b 100644 --- a/samples/react-content-query-onprem/README.md +++ b/samples/react-content-query-onprem/README.md @@ -26,6 +26,11 @@ The `React Content Query Web Part` is a modern version of the good old `Content ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-covid19-info/README.md b/samples/react-covid19-info/README.md index bbdb73fa4..e56efb0d1 100644 --- a/samples/react-covid19-info/README.md +++ b/samples/react-covid19-info/README.md @@ -13,6 +13,11 @@ The following info is displayed: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-cross-device-data/README.md b/samples/react-cross-device-data/README.md index f4917e0fe..a0f160686 100644 --- a/samples/react-cross-device-data/README.md +++ b/samples/react-cross-device-data/README.md @@ -8,6 +8,11 @@ This solution demonstrates how to use the OneDrive special folder **Apps** in or ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-css-in-js-typestyle/README.md b/samples/react-css-in-js-typestyle/README.md index 21e64930d..c68ffa9da 100644 --- a/samples/react-css-in-js-typestyle/README.md +++ b/samples/react-css-in-js-typestyle/README.md @@ -8,6 +8,11 @@ The web part demonstrates the usage of "CSS in JS" pattern with SharePoint Frame ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-csv-importer/README.md b/samples/react-csv-importer/README.md index f3126dbf7..b2cf761c2 100644 --- a/samples/react-csv-importer/README.md +++ b/samples/react-csv-importer/README.md @@ -10,6 +10,11 @@ This web part allows users to import CSV files into an existing SharePoint list. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-custom-links/README.md b/samples/react-custom-links/README.md index 669872636..ecccbf9a8 100644 --- a/samples/react-custom-links/README.md +++ b/samples/react-custom-links/README.md @@ -1,23 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - - Fluent UI React Controls - platforms: - - React - createdDate: 5/10/2020 12:00:00 AM ---- - # Custom Links ## Summary @@ -39,6 +19,11 @@ In this web part you can full customize the background and foreground color, fon ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-custompropertypanecontrols/README.md b/samples/react-custompropertypanecontrols/README.md index 09bb0bbe1..e76a2a6b3 100644 --- a/samples/react-custompropertypanecontrols/README.md +++ b/samples/react-custompropertypanecontrols/README.md @@ -35,6 +35,11 @@ Cascading drop-downs in the property pane both using external data. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-dall-e-image-generation/README.md b/samples/react-dall-e-image-generation/README.md index 0d73792b8..7c88603ac 100644 --- a/samples/react-dall-e-image-generation/README.md +++ b/samples/react-dall-e-image-generation/README.md @@ -11,6 +11,11 @@ In this sample, we are calling the API asking for Base64 images format, while th ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/react-datatable-using-mui-tables/README.md b/samples/react-datatable-using-mui-tables/README.md index 5388a0cb7..af208b543 100644 --- a/samples/react-datatable-using-mui-tables/README.md +++ b/samples/react-datatable-using-mui-tables/README.md @@ -22,6 +22,11 @@ This web part provides mui datatable features for your lists ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-datatable/README.md b/samples/react-datatable/README.md index 81322bc60..ee7b746ce 100644 --- a/samples/react-datatable/README.md +++ b/samples/react-datatable/README.md @@ -18,6 +18,11 @@ This web part provides easy way to render SharePoint custom list in datatable vi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-daterangepicker/README.md b/samples/react-daterangepicker/README.md index 3b22c2f08..60c7f2bf3 100644 --- a/samples/react-daterangepicker/README.md +++ b/samples/react-daterangepicker/README.md @@ -9,6 +9,11 @@ This web part used the date range picker in the SharePoint Framework (SPFx) web ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-designpatterns-typescript/AbstractFactory/README.md b/samples/react-designpatterns-typescript/AbstractFactory/README.md index 12490cb01..93c85a8b9 100644 --- a/samples/react-designpatterns-typescript/AbstractFactory/README.md +++ b/samples/react-designpatterns-typescript/AbstractFactory/README.md @@ -6,6 +6,11 @@ The abstract factory pattern will allow to define an interface for the creation ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-designpatterns-typescript/Builder/README.md b/samples/react-designpatterns-typescript/Builder/README.md index f0bb51438..75e1f27dd 100644 --- a/samples/react-designpatterns-typescript/Builder/README.md +++ b/samples/react-designpatterns-typescript/Builder/README.md @@ -5,6 +5,11 @@ Builder pattern builds a complex object using simple objects and using a step by ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-designpatterns-typescript/FactoryMethod/README.md b/samples/react-designpatterns-typescript/FactoryMethod/README.md index 358c57132..4edf258f1 100644 --- a/samples/react-designpatterns-typescript/FactoryMethod/README.md +++ b/samples/react-designpatterns-typescript/FactoryMethod/README.md @@ -10,6 +10,11 @@ Another definition which I liked more and fits perfectly my sample is the follo ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-designpatterns-typescript/Singleton/README.md b/samples/react-designpatterns-typescript/Singleton/README.md index 8a8e6e8f5..37ae352d8 100644 --- a/samples/react-designpatterns-typescript/Singleton/README.md +++ b/samples/react-designpatterns-typescript/Singleton/README.md @@ -5,6 +5,11 @@ A singleton is a pattern that guarantees there is a single instance of an object ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-designpatterns-typescript/Solid/README.md b/samples/react-designpatterns-typescript/Solid/README.md index efebf8e91..178a036fb 100644 --- a/samples/react-designpatterns-typescript/Solid/README.md +++ b/samples/react-designpatterns-typescript/Solid/README.md @@ -7,6 +7,11 @@ Blog post here: https://dev.to/kayis/is-react-solid-630 ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-dev-radar/README.md b/samples/react-dev-radar/README.md index 1fa207dd3..898141570 100644 --- a/samples/react-dev-radar/README.md +++ b/samples/react-dev-radar/README.md @@ -10,6 +10,11 @@ One way to find devs from the same stack near you. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-directory/README.md b/samples/react-directory/README.md index b1b83ae77..d1965697a 100644 --- a/samples/react-directory/README.md +++ b/samples/react-directory/README.md @@ -31,6 +31,11 @@ Search People from Organization Directory and show live persona card on hover. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-display-hierarchy/README.md b/samples/react-display-hierarchy/README.md index 7a4a1d2cd..b1b2bc93c 100644 --- a/samples/react-display-hierarchy/README.md +++ b/samples/react-display-hierarchy/README.md @@ -31,6 +31,11 @@ Below NPM packages are used to develop this sample. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-doccard-faq/README.md b/samples/react-doccard-faq/README.md index cc3b14978..bf557d065 100644 --- a/samples/react-doccard-faq/README.md +++ b/samples/react-doccard-faq/README.md @@ -11,6 +11,11 @@ For detailed instructions on how to build this web part and the needed list plea ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-documents-detailslist/README.md b/samples/react-documents-detailslist/README.md index a2fb39ad7..d6022ed49 100644 --- a/samples/react-documents-detailslist/README.md +++ b/samples/react-documents-detailslist/README.md @@ -22,6 +22,11 @@ This sample shows how to build web parts that display documents in accordance wi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-dynamics-crm-api/README.md b/samples/react-dynamics-crm-api/README.md index 9f17635b6..d967153cc 100644 --- a/samples/react-dynamics-crm-api/README.md +++ b/samples/react-dynamics-crm-api/README.md @@ -7,6 +7,11 @@ This sample shows how to consume Dynamics CRM API using AadTokenProvider class. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-edit-applicationcustomizer/README.md b/samples/react-edit-applicationcustomizer/README.md index 04356c237..3ee4f40f3 100644 --- a/samples/react-edit-applicationcustomizer/README.md +++ b/samples/react-edit-applicationcustomizer/README.md @@ -25,6 +25,11 @@ This web part will allow users to view/update application customizers properties ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-emoji-ratings/README.md b/samples/react-emoji-ratings/README.md index eb4501cd9..ebffb17a0 100644 --- a/samples/react-emoji-ratings/README.md +++ b/samples/react-emoji-ratings/README.md @@ -42,6 +42,11 @@ I have added default emoji's images which can be used and uploaded to SharePoint ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-enhanced-list-formatting/README.md b/samples/react-enhanced-list-formatting/README.md index dcd175d92..31a89fc84 100644 --- a/samples/react-enhanced-list-formatting/README.md +++ b/samples/react-enhanced-list-formatting/README.md @@ -23,6 +23,11 @@ This web part allows you to add custom CSS on a page to enhance list formatting. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-enhanced-powerapps/README.md b/samples/react-enhanced-powerapps/README.md index 9b30fef61..f40b8d1c2 100644 --- a/samples/react-enhanced-powerapps/README.md +++ b/samples/react-enhanced-powerapps/README.md @@ -11,6 +11,11 @@ It also resizes the app to fit the web part dimension: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-events-aggregator/README.md b/samples/react-events-aggregator/README.md index d77d1c724..ff0bfba8e 100644 --- a/samples/react-events-aggregator/README.md +++ b/samples/react-events-aggregator/README.md @@ -18,6 +18,11 @@ This sample shows how we can use the SPFx Event Aggregator to communicate betwee ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-events-dynamicdata/README.md b/samples/react-events-dynamicdata/README.md index 5c13e8fa1..70c371070 100644 --- a/samples/react-events-dynamicdata/README.md +++ b/samples/react-events-dynamicdata/README.md @@ -6,6 +6,11 @@ Sample web parts illustrating using the SharePoint Framework Dynamic data capabi ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-facebook-plugin/README.md b/samples/react-facebook-plugin/README.md index f218dd2e3..2114982e4 100644 --- a/samples/react-facebook-plugin/README.md +++ b/samples/react-facebook-plugin/README.md @@ -10,6 +10,11 @@ The key differences between using Embed web part and current example are the str ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-faqapp/README.md b/samples/react-faqapp/README.md index accc60b48..576e64f02 100644 --- a/samples/react-faqapp/README.md +++ b/samples/react-faqapp/README.md @@ -25,6 +25,11 @@ extensions: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-faqs/README.md b/samples/react-faqs/README.md index eebdbaf9f..3a3e02232 100644 --- a/samples/react-faqs/README.md +++ b/samples/react-faqs/README.md @@ -26,6 +26,11 @@ extensions: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-feature-framework/README.md b/samples/react-feature-framework/README.md index c080d8ce7..7a228f5d5 100644 --- a/samples/react-feature-framework/README.md +++ b/samples/react-feature-framework/README.md @@ -34,6 +34,11 @@ More details on the capability is available from the following article ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-feedback-sidebar/README.md b/samples/react-feedback-sidebar/README.md index 434facab5..704a80615 100644 --- a/samples/react-feedback-sidebar/README.md +++ b/samples/react-feedback-sidebar/README.md @@ -11,6 +11,11 @@ Place this web part on top of your page in order to show the Feedback button. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.0](https://img.shields.io/badge/SPFx-1.15.0-green.svg) ![Node.js v16](https://img.shields.io/badge/Node.js-v16-green.svg) ![Node.js v16 | v14 | v12 ](https://img.shields.io/badge/Node.js-v16%20%7C%20v14%20%7C%20v12-green.svg) diff --git a/samples/react-feedback/README.md b/samples/react-feedback/README.md index 637bf6b37..e2c829ef8 100644 --- a/samples/react-feedback/README.md +++ b/samples/react-feedback/README.md @@ -8,6 +8,11 @@ This is an application that supports Feedback through a web part that can be use ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-file-upload/README.md b/samples/react-file-upload/README.md index 83b66d270..4268abf1d 100644 --- a/samples/react-file-upload/README.md +++ b/samples/react-file-upload/README.md @@ -8,6 +8,11 @@ The file upload web part allowing users to upload multiple files to a document l ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.0](https://img.shields.io/badge/SPFx-1.4.0-green.svg) ![Node.js v6 ](https://img.shields.io/badge/Node.js-LTS%206-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-find-parker/README.md b/samples/react-find-parker/README.md index a1c405490..78543f7ce 100644 --- a/samples/react-find-parker/README.md +++ b/samples/react-find-parker/README.md @@ -19,6 +19,11 @@ or good old where's Wally game 😉 ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-flighttracker/README.md b/samples/react-flighttracker/README.md index 817a2c8b4..9fd45c142 100644 --- a/samples/react-flighttracker/README.md +++ b/samples/react-flighttracker/README.md @@ -11,6 +11,11 @@ The SPFx use external API (https://aerodatabox.p.rapidapi.com/flights/number/) t ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15-green.svg) diff --git a/samples/react-flow-button/README.md b/samples/react-flow-button/README.md index 9b7d61d1f..21d16e0c2 100644 --- a/samples/react-flow-button/README.md +++ b/samples/react-flow-button/README.md @@ -8,6 +8,11 @@ This web part demonstrates displaying the list of flow button of Power Automate. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-fluentui-9/README.md b/samples/react-fluentui-9/README.md index 46f2fcc2c..f62ce08eb 100644 --- a/samples/react-fluentui-9/README.md +++ b/samples/react-fluentui-9/README.md @@ -9,6 +9,11 @@ This demos the use of the new [Fluent UI version 9](https://github.com/microsoft ## 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 for more information on SPFx compatibility. | + ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) ![Node.js v16](https://img.shields.io/badge/Node.js-v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-fluentui-theme-variant/README.md b/samples/react-fluentui-theme-variant/README.md index a6dd43507..18d38c9ac 100644 --- a/samples/react-fluentui-theme-variant/README.md +++ b/samples/react-fluentui-theme-variant/README.md @@ -8,6 +8,11 @@ In this way it is possible to implement the same mechanism that is currently imp ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-follow-document/README.md b/samples/react-follow-document/README.md index b70690f66..ad8c84b9f 100644 --- a/samples/react-follow-document/README.md +++ b/samples/react-follow-document/README.md @@ -31,6 +31,11 @@ Usage of following Technologies: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-followed-drag-and-drop-grid/README.md b/samples/react-followed-drag-and-drop-grid/README.md index b7b0742f5..1b658cfcc 100644 --- a/samples/react-followed-drag-and-drop-grid/README.md +++ b/samples/react-followed-drag-and-drop-grid/README.md @@ -22,6 +22,11 @@ Another cool feature is also done using MS Graph in order to save or update the ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-functional-component-with-data-fetch/README.md b/samples/react-functional-component-with-data-fetch/README.md index 98f9ea4da..148388ef3 100644 --- a/samples/react-functional-component-with-data-fetch/README.md +++ b/samples/react-functional-component-with-data-fetch/README.md @@ -9,6 +9,11 @@ This web part demonstrates building a React functional component that uses data ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-functional-component/README.md b/samples/react-functional-component/README.md index ce34ec87d..47eac2e32 100644 --- a/samples/react-functional-component/README.md +++ b/samples/react-functional-component/README.md @@ -9,6 +9,11 @@ This web part is intended to be easier to understand for new developers building ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-functional-servicescope-hooks/README.md b/samples/react-functional-servicescope-hooks/README.md index 1496fbc5a..19540fe3d 100644 --- a/samples/react-functional-servicescope-hooks/README.md +++ b/samples/react-functional-servicescope-hooks/README.md @@ -8,6 +8,11 @@ This web part is designed to help developers understand how to use the Context A ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-functional-stateful-component/README.md b/samples/react-functional-stateful-component/README.md index afb267652..fe58c9651 100644 --- a/samples/react-functional-stateful-component/README.md +++ b/samples/react-functional-stateful-component/README.md @@ -9,6 +9,11 @@ This web part demonstrates building a React functional component that includes s ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-github-badge/README.md b/samples/react-github-badge/README.md index 0feeaf067..012b28344 100644 --- a/samples/react-github-badge/README.md +++ b/samples/react-github-badge/README.md @@ -11,6 +11,11 @@ Displays information about a GitHub user. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-global-news-sp2019/README.md b/samples/react-global-news-sp2019/README.md index 96a96420c..f54692ac7 100644 --- a/samples/react-global-news-sp2019/README.md +++ b/samples/react-global-news-sp2019/README.md @@ -32,7 +32,12 @@ Please go to https://newsapi.org to get more information. ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) diff --git a/samples/react-global-news/README.md b/samples/react-global-news/README.md index 45e5e4c7a..8ed9c02a9 100644 --- a/samples/react-global-news/README.md +++ b/samples/react-global-news/README.md @@ -33,6 +33,11 @@ Please go to https://newsapi.org to get more information. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-google-fit/README.md b/samples/react-google-fit/README.md index 9878d4644..72b1f6c75 100644 --- a/samples/react-google-fit/README.md +++ b/samples/react-google-fit/README.md @@ -44,6 +44,11 @@ Below NPM package is used to develop this sample. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.1](https://img.shields.io/badge/SPFx-1.7.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-app-secret-expiration/README.md b/samples/react-graph-app-secret-expiration/README.md index 886530f8b..6054166c0 100644 --- a/samples/react-graph-app-secret-expiration/README.md +++ b/samples/react-graph-app-secret-expiration/README.md @@ -9,6 +9,11 @@ I got the idea from this great article [Use Power Automate to Notify of Upcoming ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-auto-batching/README.md b/samples/react-graph-auto-batching/README.md index c29d63801..53a9facfd 100644 --- a/samples/react-graph-auto-batching/README.md +++ b/samples/react-graph-auto-batching/README.md @@ -17,6 +17,11 @@ You may ask why I used AadHttpClient instead of MSGraphClient. AadHttpClient sha ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-calendar/README.md b/samples/react-graph-calendar/README.md index a1eae24b2..d731ac291 100644 --- a/samples/react-graph-calendar/README.md +++ b/samples/react-graph-calendar/README.md @@ -18,6 +18,11 @@ Web part is developed using below technologies ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-cascading-managed-metadata/README.md b/samples/react-graph-cascading-managed-metadata/README.md index b3278fbfa..77c845921 100644 --- a/samples/react-graph-cascading-managed-metadata/README.md +++ b/samples/react-graph-cascading-managed-metadata/README.md @@ -10,6 +10,11 @@ This web part shows how to use the Microsoft Graph APIs (beta) for Taxonomy to g ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-evalurl/README.md b/samples/react-graph-evalurl/README.md index fa4ebabd6..05062f78a 100644 --- a/samples/react-graph-evalurl/README.md +++ b/samples/react-graph-evalurl/README.md @@ -39,6 +39,11 @@ src ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-feedback-form/README.md b/samples/react-graph-feedback-form/README.md index f47f11adf..eeb00bacf 100644 --- a/samples/react-graph-feedback-form/README.md +++ b/samples/react-graph-feedback-form/README.md @@ -8,6 +8,11 @@ Sample SPFx React web part which allows sending emails using Microsoft Graph. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-groupviewer/README.md b/samples/react-graph-groupviewer/README.md index d9f1123ab..629ce113b 100644 --- a/samples/react-graph-groupviewer/README.md +++ b/samples/react-graph-groupviewer/README.md @@ -8,6 +8,11 @@ This web part will provide the functionality to search for groups in your tenant ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-graph-mgt-client/README.md b/samples/react-graph-mgt-client/README.md index 67ff9ceb8..df7cba59f 100644 --- a/samples/react-graph-mgt-client/README.md +++ b/samples/react-graph-mgt-client/README.md @@ -27,6 +27,11 @@ This is a sample web part developed using React Framework that showcases how to ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-personalemail/README.md b/samples/react-graph-personalemail/README.md index a691df77a..d0bdc084d 100644 --- a/samples/react-graph-personalemail/README.md +++ b/samples/react-graph-personalemail/README.md @@ -1,6 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: # Personal e-mail ## Summary @@ -12,6 +9,11 @@ Sample React web part showing how to retrieve and display personal e-mail retrie ## 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 for more information on SPFx compatibility. | + ![SPFx 1.6](https://img.shields.io/badge/SPFx-1.6.0-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-pnpjs/README.md b/samples/react-graph-pnpjs/README.md index 747dca96a..1a175c33a 100644 --- a/samples/react-graph-pnpjs/README.md +++ b/samples/react-graph-pnpjs/README.md @@ -10,6 +10,11 @@ It requests a list of Azure AD [groups](https://learn.microsoft.com/graph/api/gr ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.1](https://img.shields.io/badge/SPFx-1.7.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-profile-awards/README.md b/samples/react-graph-profile-awards/README.md index f307eccd2..75ad54e09 100644 --- a/samples/react-graph-profile-awards/README.md +++ b/samples/react-graph-profile-awards/README.md @@ -14,6 +14,11 @@ __Note__: when adding a new award, ensure you set the field __allowedAudiences__ ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.0](https://img.shields.io/badge/SPFx-1.15.0-green.svg) ![Node.js v16 | v14](https://img.shields.io/badge/Node.js-v16%20%7C%20v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-reports/README.md b/samples/react-graph-reports/README.md index 7f3399420..2e6c0f9b1 100644 --- a/samples/react-graph-reports/README.md +++ b/samples/react-graph-reports/README.md @@ -9,6 +9,11 @@ This sample describe a SPFx application which retrieve an office 365 usage repor ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-schema-extensions/README.md b/samples/react-graph-schema-extensions/README.md index 5ee016b2f..1a6215513 100644 --- a/samples/react-graph-schema-extensions/README.md +++ b/samples/react-graph-schema-extensions/README.md @@ -13,6 +13,11 @@ Office 365 Groups, for instance Sales information, and make it available in the ## 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 for more information on SPFx compatibility. | + ![SPFx 1.5.1](https://img.shields.io/badge/SPFx-1.5.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-graph-telephonedirectory/README.md b/samples/react-graph-telephonedirectory/README.md index 6b7821163..39dd7e76f 100644 --- a/samples/react-graph-telephonedirectory/README.md +++ b/samples/react-graph-telephonedirectory/README.md @@ -9,6 +9,11 @@ The web part will fetch data from directory using Graph API and display in detai ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-group-members/README.md b/samples/react-group-members/README.md index 0ba1db9a5..4659f3afc 100644 --- a/samples/react-group-members/README.md +++ b/samples/react-group-members/README.md @@ -6,7 +6,12 @@ Uses the MS Graph client to list the members of a group(s) and displays Person C ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) diff --git a/samples/react-group-membership-manager/README.md b/samples/react-group-membership-manager/README.md index f8f91f2cc..195544aca 100644 --- a/samples/react-group-membership-manager/README.md +++ b/samples/react-group-membership-manager/README.md @@ -8,6 +8,11 @@ This app is an example of managing the membership of a group you own including t ## 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 for more information on SPFx compatibility. | + ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) ![Node.js v16](https://img.shields.io/badge/Node.js-v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-groups-teams/README.md b/samples/react-groups-teams/README.md index ce6029e87..d0cc8509c 100644 --- a/samples/react-groups-teams/README.md +++ b/samples/react-groups-teams/README.md @@ -1,29 +1,28 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: -## Compatibility - -This sample is designed to be used in the following enviroments: # All Microsoft 365 Groups and Teams with SPFx ## Summary + Web part pulls all Microsoft 365 Groups and Teams that the logged in user has access to view. -1. The Microsoft Groups view has filter option for private or public groups and can switch between viewing all groups or just my groups. - - Group Name (hover for group description) - - Link to email - - Link to SharePoint site - - Link to calendar - - Link to Planner plan (if available) - - Group privacy + +1. The Microsoft Groups view has filter option for private or public groups and can switch between viewing all groups or just my groups. + +- Group Name (hover for group description) +- Link to email +- Link to SharePoint site +- Link to calendar +- Link to Planner plan (if available) +- Group privacy + 2. The Microsoft Teams view has filter option for private or public Teams. - - Team Name (hover for group description) - - Link to email - - Link to SharePoint site - - Link to calendar - - Link to Planner plan (if available) - - Link to Team - - Team privacy - Each Team o Uses SharePoint theme. + +- Team Name (hover for group description) +- Link to email +- Link to SharePoint site +- Link to calendar +- Link to Planner plan (if available) +- Link to Team +- Team privacy + Each Team o Uses SharePoint theme. ![picture of the web part in action](./assets/Groups-in-my-organization.png) ![picture of the web part in action](./assets/My-Teams-Teams-Side-By-Side-Theme.png) @@ -32,8 +31,13 @@ Web part pulls all Microsoft 365 Groups and Teams that the logged in user has ac ## Compatibility -![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) -![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) +| :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 for more information on SPFx compatibility. | + +![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) +![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) ![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%202019-Not%20compatible-red.svg) ![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%202016%20(Feature%20Pack%202)-Not%20compatible-red.svg) @@ -41,12 +45,12 @@ Web part pulls all Microsoft 365 Groups and Teams that the logged in user has ac ![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-yellow.svg "Only after API permissions granted") ![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg) -For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix +For more information about SPFx compatibility, please refer to ## Applies to -* [SharePoint Framework Developer Preview](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) -* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) +- [SharePoint Framework Developer Preview](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) +- [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) ## Solution @@ -62,7 +66,6 @@ React-Groups-Teams | [Alison Collins](https://github.com/ReactIntern) ([Blog](ht | 1.0.1 | August 1, 2021 | Fixed references to Office.com | | 1.1.0 | October 8, 2021 | Upgraded to SPFx 1.12.1 for higher compatibility and added Teams Tab deployment support. | - ## Prerequisites - Administrative access to Azure AD of Microsoft 365 tenant @@ -93,7 +96,7 @@ React-Groups-Teams | [Alison Collins](https://github.com/ReactIntern) ([Blog](ht - Open hosted workbench, i.e. `https://.sharepoint.com/sites//_layouts/15/workbench.aspx` - Search and add `O365 Groups Manager` web part to see it in action -> 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. +> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit for further instructions. ## Features @@ -106,7 +109,7 @@ This sample illustrates the following concepts on top of the SharePoint Framewor - Requesting API permissions in a SharePoint Framework package - Communicating with the Microsoft Graph using its REST API - Using Office UI Fabric controls for building SharePoint Framework client-side web parts -- Passing web part properties to React components +- Passing web part properties to React components ## Video @@ -127,10 +130,8 @@ For questions regarding this sample, [create a new question](https://github.com/ 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-groups-teams&template=question.yml&sample=react-groups-teams&authors=@ReactIntern&title=react-groups-teams%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.** - diff --git a/samples/react-hero-webpart/README.md b/samples/react-hero-webpart/README.md index 6cada1829..9a1d00d8b 100644 --- a/samples/react-hero-webpart/README.md +++ b/samples/react-hero-webpart/README.md @@ -9,6 +9,11 @@ This solution creates a customisable Hero web part, it uses a stored collection ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-holidays-calendar/README.md b/samples/react-holidays-calendar/README.md index d2854df8d..60ef36771 100644 --- a/samples/react-holidays-calendar/README.md +++ b/samples/react-holidays-calendar/README.md @@ -19,6 +19,11 @@ ACE card extension provides below functionalities ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) diff --git a/samples/react-hooks/README.md b/samples/react-hooks/README.md index 92ace577b..b3341cbe7 100644 --- a/samples/react-hooks/README.md +++ b/samples/react-hooks/README.md @@ -9,6 +9,11 @@ Hooks is a new feature included in React version 16.8, with the new version of * ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-htm-templating/README.md b/samples/react-htm-templating/README.md index ce25800cd..027dd6777 100644 --- a/samples/react-htm-templating/README.md +++ b/samples/react-htm-templating/README.md @@ -8,6 +8,11 @@ This Web Part provides an example of how to create a dynamic template system (co ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-image-editor/README.md b/samples/react-image-editor/README.md index 552a3ccb2..1d6a68468 100644 --- a/samples/react-image-editor/README.md +++ b/samples/react-image-editor/README.md @@ -38,6 +38,11 @@ The Placeholder and FilePicker are components from the [sp-dev-fx-controls-react ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.0](https://img.shields.io/badge/SPFx-1.4.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-LTS%206.x-green.svg) ![SharePoint 2019 | Online](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg) diff --git a/samples/react-image-gallery/README.md b/samples/react-image-gallery/README.md index f335044e3..1adabbfe5 100644 --- a/samples/react-image-gallery/README.md +++ b/samples/react-image-gallery/README.md @@ -8,6 +8,11 @@ This sample describes an SPFx application which implements an image gallery with ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-image-magnifier/README.md b/samples/react-image-magnifier/README.md index 1565b1342..f62d4b467 100644 --- a/samples/react-image-magnifier/README.md +++ b/samples/react-image-magnifier/README.md @@ -22,6 +22,11 @@ This web part allow to magnify an image, displaying a resolution more detailed t ## 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 for more information on SPFx compatibility. | + ![SPFx 1.2.0](https://img.shields.io/badge/SPFx-1.2.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-image-slider-list-taxonomy-filter/README.md b/samples/react-image-slider-list-taxonomy-filter/README.md index 30f34d107..5061b2055 100644 --- a/samples/react-image-slider-list-taxonomy-filter/README.md +++ b/samples/react-image-slider-list-taxonomy-filter/README.md @@ -12,7 +12,12 @@ This web part display the image in slider based on the filter of Taxonomy from P ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.6](https://img.shields.io/badge/SPFx-1.6.0-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) diff --git a/samples/react-interactive-map/README.md b/samples/react-interactive-map/README.md index 31a0cf480..865f34067 100644 --- a/samples/react-interactive-map/README.md +++ b/samples/react-interactive-map/README.md @@ -17,6 +17,11 @@ This web parts displays a (world) map. An editor can set custom markers directly ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-invitation-manager/README.md b/samples/react-invitation-manager/README.md index b9ed4d757..9547523e0 100644 --- a/samples/react-invitation-manager/README.md +++ b/samples/react-invitation-manager/README.md @@ -36,6 +36,11 @@ Look at this to go deep: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.3](https://img.shields.io/badge/SPFx-1.3.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-ioc-tests/README.md b/samples/react-ioc-tests/README.md index 807d8d9b4..90dd77ed2 100644 --- a/samples/react-ioc-tests/README.md +++ b/samples/react-ioc-tests/README.md @@ -18,6 +18,11 @@ The example also includes a pipeline definition .yaml file for Azure DevOps CI b ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-item-History/README.md b/samples/react-item-History/README.md index f14d1aa94..d03be8cb2 100644 --- a/samples/react-item-History/README.md +++ b/samples/react-item-History/README.md @@ -7,6 +7,11 @@ This listview command is used to show the past versions of the selected list ite ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-jest-testing/README.md b/samples/react-jest-testing/README.md index 89d1417e9..7ca5caf85 100644 --- a/samples/react-jest-testing/README.md +++ b/samples/react-jest-testing/README.md @@ -63,6 +63,11 @@ The sample uses SPFx web part, but the same setup applies for SPFx extensions an ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-kanban-board/README.md b/samples/react-kanban-board/README.md index cf53ad1a6..31dac5ddb 100644 --- a/samples/react-kanban-board/README.md +++ b/samples/react-kanban-board/README.md @@ -27,6 +27,11 @@ The web part uses the default columns of the SharePoint Tasks list for showing t ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-list-form/README.md b/samples/react-list-form/README.md index cb4a34a02..04d2d20e7 100755 --- a/samples/react-list-form/README.md +++ b/samples/react-list-form/README.md @@ -26,6 +26,11 @@ The web part allows configuring which list to use and if a form for adding a new ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-list-items-menu-sp2019/README.md b/samples/react-list-items-menu-sp2019/README.md index e294ff0d4..9b8a094e6 100644 --- a/samples/react-list-items-menu-sp2019/README.md +++ b/samples/react-list-items-menu-sp2019/README.md @@ -17,6 +17,11 @@ When the user clicks on the header it dynamically load documents. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![SharePoint 2019 | Online](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg) diff --git a/samples/react-list-items-menu/README.md b/samples/react-list-items-menu/README.md index 748903e7d..c3c4cca81 100644 --- a/samples/react-list-items-menu/README.md +++ b/samples/react-list-items-menu/README.md @@ -17,6 +17,11 @@ When the user clicks on the header it dynamically load documents. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-list-search/README.md b/samples/react-list-search/README.md index a3a6b5e8a..9dbc2f06f 100644 --- a/samples/react-list-search/README.md +++ b/samples/react-list-search/README.md @@ -58,6 +58,11 @@ This list search web part allows the user to show data from lists or libraries. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-lists-hide/README.md b/samples/react-lists-hide/README.md index 886ed4d6d..c56ff0915 100644 --- a/samples/react-lists-hide/README.md +++ b/samples/react-lists-hide/README.md @@ -24,6 +24,11 @@ PnP JS library to get relevant SharePoint lists and libraries from current Site ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13](https://img.shields.io/badge/version-1.13-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-listview-context-ecb/README.md b/samples/react-listview-context-ecb/README.md index 3fd876562..085f64401 100644 --- a/samples/react-listview-context-ecb/README.md +++ b/samples/react-listview-context-ecb/README.md @@ -19,6 +19,11 @@ For further details see the author's [blog post](https://mmsharepoint.wordpress. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.16.1](https://img.shields.io/badge/version-1.16.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-manage-o365-groups/README.md b/samples/react-manage-o365-groups/README.md index efa5f577c..562970834 100644 --- a/samples/react-manage-o365-groups/README.md +++ b/samples/react-manage-o365-groups/README.md @@ -62,6 +62,11 @@ react-manage-o365-groups ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-manage-profile-card-properties/README.md b/samples/react-manage-profile-card-properties/README.md index ad0a64cba..d5ff35561 100644 --- a/samples/react-manage-profile-card-properties/README.md +++ b/samples/react-manage-profile-card-properties/README.md @@ -22,6 +22,11 @@ Only users with Tenant Admin Role are allowed to managed profile card properties ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-manage-sitedesigns/README.md b/samples/react-manage-sitedesigns/README.md index e75242542..36d5dc480 100644 --- a/samples/react-manage-sitedesigns/README.md +++ b/samples/react-manage-sitedesigns/README.md @@ -87,6 +87,11 @@ Only users with Tenant Admin Role are allowed to managed tenant properties. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-manage-spfx-solutions-alm/README.md b/samples/react-manage-spfx-solutions-alm/README.md index e27322331..aa709fb33 100644 --- a/samples/react-manage-spfx-solutions-alm/README.md +++ b/samples/react-manage-spfx-solutions-alm/README.md @@ -18,6 +18,11 @@ This web part is mainly build for tenant and SharePoint admins, since most of th ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-material-ui/README.md b/samples/react-material-ui/README.md index 5c9ead68c..2b81327e8 100644 --- a/samples/react-material-ui/README.md +++ b/samples/react-material-ui/README.md @@ -9,6 +9,11 @@ This sample also includes RXJS DebounceTime, this feature allows you to wait for ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.1](https://img.shields.io/badge/SPFx-1.8.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-members-with-presence/README.md b/samples/react-members-with-presence/README.md index 027788b4a..8eafb81f0 100644 --- a/samples/react-members-with-presence/README.md +++ b/samples/react-members-with-presence/README.md @@ -1,6 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: # SPFx Web part Group members list with Presence information ## Summary @@ -12,6 +9,11 @@ This sample shows how to get the members of a specific group, including their pr ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-mgtevents/README.md b/samples/react-mgtevents/README.md index aa1c6449f..eda8ba34f 100644 --- a/samples/react-mgtevents/README.md +++ b/samples/react-mgtevents/README.md @@ -8,6 +8,11 @@ This sample shows how to use Microsoft Graph Toolkit in SPFx and custom with Flu ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-minesweeper/README.md b/samples/react-minesweeper/README.md index 88ab9640d..a1fb3b27e 100644 --- a/samples/react-minesweeper/README.md +++ b/samples/react-minesweeper/README.md @@ -9,6 +9,11 @@ This web part is the classic game Minesweeper, put in a Fluent UI powered SPFx w ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-mobx-multiple-stores/README.md b/samples/react-mobx-multiple-stores/README.md index b2448019a..703594ed8 100644 --- a/samples/react-mobx-multiple-stores/README.md +++ b/samples/react-mobx-multiple-stores/README.md @@ -1,9 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: -## Compatibility - -This sample is designed to be used in the following enviroments: # Using Mobx with multiple stores ## Summary @@ -15,6 +9,11 @@ A sample web part that uses the [Mobx](https://mobx.js.org/) library with multip ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-mobx/README.md b/samples/react-mobx/README.md index aeac9978e..e1dceb414 100644 --- a/samples/react-mobx/README.md +++ b/samples/react-mobx/README.md @@ -26,7 +26,12 @@ Sample web part implementation that uses [Mobx](https://github.com/mobxjs/mobx) ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 0.5.1](https://img.shields.io/badge/SPFx-0.5.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) diff --git a/samples/react-modern-birthdays/README.md b/samples/react-modern-birthdays/README.md index 53b262b06..8dc8dfd3e 100644 --- a/samples/react-modern-birthdays/README.md +++ b/samples/react-modern-birthdays/README.md @@ -9,6 +9,11 @@ The Web Part(s) shows the upcoming birthdays in the company, the web parts reads ## 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 for more information on SPFx compatibility. | + ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) ![Node.js v16 | v14](https://img.shields.io/badge/Node.js-v16%20|%20v14-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-modern-charts/README.md b/samples/react-modern-charts/README.md index 788321397..0ed0c26f0 100644 --- a/samples/react-modern-charts/README.md +++ b/samples/react-modern-charts/README.md @@ -45,6 +45,11 @@ Current Data Functions: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js LSTS 8 | LTS 10](https://img.shields.io/badge/Node.js-LTS%208%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-modern-organization-chart/README.md b/samples/react-modern-organization-chart/README.md index 3671a419a..b74598fa1 100644 --- a/samples/react-modern-organization-chart/README.md +++ b/samples/react-modern-organization-chart/README.md @@ -37,6 +37,11 @@ Refresh Status Interval in minutes | number| no | default value 5 min ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-msal-msgraph/README.md b/samples/react-msal-msgraph/README.md index 0ad45d0a5..0d5e59358 100644 --- a/samples/react-msal-msgraph/README.md +++ b/samples/react-msal-msgraph/README.md @@ -35,6 +35,11 @@ After you gave permissions, the following will information will get displayed: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-msgraph-extension/README.md b/samples/react-msgraph-extension/README.md index a12f585cc..1241efc43 100644 --- a/samples/react-msgraph-extension/README.md +++ b/samples/react-msgraph-extension/README.md @@ -15,6 +15,11 @@ This sample shows how to managed Microsoft Graph Open Extension in SPFx. This ap ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-msgraph-peoplesearch/README.md b/samples/react-msgraph-peoplesearch/README.md index 64390d46c..fd8cf1dba 100644 --- a/samples/react-msgraph-peoplesearch/README.md +++ b/samples/react-msgraph-peoplesearch/README.md @@ -22,6 +22,11 @@ I wrote a blog post covering more if the inner workings, you can find it at [SPF ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-multilist-grid/README.md b/samples/react-multilist-grid/README.md index 3a0522148..5f8c6f70f 100644 --- a/samples/react-multilist-grid/README.md +++ b/samples/react-multilist-grid/README.md @@ -67,6 +67,11 @@ Use the Undo icon to undo the changes made to an item. ## 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 for more information on SPFx compatibility. | + ![SPFx 0.7.0](https://img.shields.io/badge/SPFx-0.7.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-multimedia-gallery/README.md b/samples/react-multimedia-gallery/README.md index b9f76fdd4..9c3084a18 100644 --- a/samples/react-multimedia-gallery/README.md +++ b/samples/react-multimedia-gallery/README.md @@ -28,6 +28,11 @@ It uses Microsoft Graph API to get thumbnails and image/video url and use PnPjs ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-multipage/README.md b/samples/react-multipage/README.md index 704c739b5..2fe52bdbd 100644 --- a/samples/react-multipage/README.md +++ b/samples/react-multipage/README.md @@ -27,6 +27,11 @@ Sample poll web part allowing users to vote and view the results. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-multiscreen-webpart/README.md b/samples/react-multiscreen-webpart/README.md index 758837133..247acac31 100644 --- a/samples/react-multiscreen-webpart/README.md +++ b/samples/react-multiscreen-webpart/README.md @@ -15,6 +15,11 @@ The web part utilizes the usage of hashes in the URL so different screen will be ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-my-approvals/README.md b/samples/react-my-approvals/README.md index 1ecee6100..8c3bca5ab 100644 --- a/samples/react-my-approvals/README.md +++ b/samples/react-my-approvals/README.md @@ -8,6 +8,11 @@ This web part demonstrates displaying the list of approval requests of Power Aut ## 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 for more information on SPFx compatibility. | + ![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) diff --git a/samples/react-my-events/README.md b/samples/react-my-events/README.md index ef9e27814..7eee4d43d 100644 --- a/samples/react-my-events/README.md +++ b/samples/react-my-events/README.md @@ -19,6 +19,11 @@ This web part provides loggedin user's outlook events with some advanced feature ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.0](https://img.shields.io/badge/SPFx-1.15.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-my-groups/README.md b/samples/react-my-groups/README.md index 30225e409..ef5970273 100644 --- a/samples/react-my-groups/README.md +++ b/samples/react-my-groups/README.md @@ -31,6 +31,11 @@ You can change between the grid and compact layout through the settings in the p ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-my-onedrive-info/README.md b/samples/react-my-onedrive-info/README.md index 2755cccaf..c8f1367d1 100644 --- a/samples/react-my-onedrive-info/README.md +++ b/samples/react-my-onedrive-info/README.md @@ -13,6 +13,11 @@ MyOneDriveInfo solution contains Adaptive card extension for Viva connection wit ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) diff --git a/samples/react-my-personal-apps/README.md b/samples/react-my-personal-apps/README.md index 5d9c915aa..d0b390765 100644 --- a/samples/react-my-personal-apps/README.md +++ b/samples/react-my-personal-apps/README.md @@ -51,6 +51,11 @@ This Web Part uses MSgraph Open Extension to save the personal information on us ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-my-sites/README.md b/samples/react-my-sites/README.md index 2b9c73394..c513e8aed 100644 --- a/samples/react-my-sites/README.md +++ b/samples/react-my-sites/README.md @@ -38,6 +38,11 @@ If the Group has a microsoft team associated and user has permissions to access ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-my-teams/README.md b/samples/react-my-teams/README.md index 07e1af183..206ba971d 100644 --- a/samples/react-my-teams/README.md +++ b/samples/react-my-teams/README.md @@ -10,6 +10,11 @@ The web part can be configured to open the team on the web browser or client app ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-myonedrive/README.md b/samples/react-myonedrive/README.md index defe3709a..af7fc55c8 100644 --- a/samples/react-myonedrive/README.md +++ b/samples/react-myonedrive/README.md @@ -20,6 +20,11 @@ This web part can be useful on the Intranet home page which can be added as My O ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) diff --git a/samples/react-mytasks/README.md b/samples/react-mytasks/README.md index 60c870015..e263b75c5 100644 --- a/samples/react-mytasks/README.md +++ b/samples/react-mytasks/README.md @@ -52,6 +52,11 @@ The user can search task by name, can filter by progress status, all data are dy ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-news-banner/README.md b/samples/react-news-banner/README.md index 81c970179..b01523b20 100644 --- a/samples/react-news-banner/README.md +++ b/samples/react-news-banner/README.md @@ -9,6 +9,11 @@ This web part shows news information as a Banner, this information come from a l ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![SharePoint 2019 | Online](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg) diff --git a/samples/react-news/README.md b/samples/react-news/README.md index adffd1d12..46474a57d 100644 --- a/samples/react-news/README.md +++ b/samples/react-news/README.md @@ -24,6 +24,11 @@ Web part pulls all SharePoint News Posts that the logged in user has access to v ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-office-offer-creation/README.md b/samples/react-office-offer-creation/README.md index 5db7e6684..18133728d 100644 --- a/samples/react-office-offer-creation/README.md +++ b/samples/react-office-offer-creation/README.md @@ -28,6 +28,11 @@ For further details see the author's [blog series](https://mmsharepoint.wordpres ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) diff --git a/samples/react-officegraph/README.md b/samples/react-officegraph/README.md index 42b881e81..cedcd8b77 100644 --- a/samples/react-officegraph/README.md +++ b/samples/react-officegraph/README.md @@ -52,6 +52,11 @@ Sample SharePoint Framework Client-Side Web Part built using React showing docum ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-offline-first/README.md b/samples/react-offline-first/README.md index 1de0de1ee..63d18550a 100644 --- a/samples/react-offline-first/README.md +++ b/samples/react-offline-first/README.md @@ -31,6 +31,11 @@ read the documentation for ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-onedrive-finder/README.md b/samples/react-onedrive-finder/README.md index e904251e7..036f639c1 100644 --- a/samples/react-onedrive-finder/README.md +++ b/samples/react-onedrive-finder/README.md @@ -26,6 +26,11 @@ Below a draw resuming the custom query's made and what control uses to retrieve ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-organisationchart/README.md b/samples/react-organisationchart/README.md index 0d7fa933d..c30ffa387 100644 --- a/samples/react-organisationchart/README.md +++ b/samples/react-organisationchart/README.md @@ -25,7 +25,12 @@ A simple Organisation Chart web part using Office UI Fabric, React, REST API bat ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) diff --git a/samples/react-organization-chart/README.md b/samples/react-organization-chart/README.md index 7d6bb6a5b..f98754f1d 100644 --- a/samples/react-organization-chart/README.md +++ b/samples/react-organization-chart/README.md @@ -12,6 +12,11 @@ This web part shows an organization chart based on specified user, and user can ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![SharePoint 2019 | Online](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg) diff --git a/samples/react-outlook-add-todo-task/README.md b/samples/react-outlook-add-todo-task/README.md index 79d3ec8b7..e1b7525b2 100644 --- a/samples/react-outlook-add-todo-task/README.md +++ b/samples/react-outlook-add-todo-task/README.md @@ -54,6 +54,11 @@ POST https://graph.microsoft.com/beta/me/todo/lists/{listId}/tasks ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-outlook-copy2teams/README.md b/samples/react-outlook-copy2teams/README.md index 84c9f19e0..3eca034db 100644 --- a/samples/react-outlook-copy2teams/README.md +++ b/samples/react-outlook-copy2teams/README.md @@ -16,6 +16,11 @@ A detailed functionality and technical description can be found in the [author's # ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-page-navigator/README.md b/samples/react-page-navigator/README.md index 8e0ed8661..85833892c 100644 --- a/samples/react-page-navigator/README.md +++ b/samples/react-page-navigator/README.md @@ -10,6 +10,11 @@ When added to a Vertical Section it can be used as a Contents table for the page ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-page-sections-navigation/README.md b/samples/react-page-sections-navigation/README.md index 4d1e7e61f..63c371bdd 100644 --- a/samples/react-page-sections-navigation/README.md +++ b/samples/react-page-sections-navigation/README.md @@ -6,6 +6,11 @@ Sample web parts allowing to add sections navigation to the SharePoint page. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-pagecontributors/README.md b/samples/react-pagecontributors/README.md index 3f5909ea5..0a1280213 100644 --- a/samples/react-pagecontributors/README.md +++ b/samples/react-pagecontributors/README.md @@ -25,6 +25,11 @@ Displays page contributors in reverse chronological order. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js LTS 14.x](https://img.shields.io/badge/Node.js-LTS%2014.x-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-pages-hierarchy/README.md b/samples/react-pages-hierarchy/README.md index 70f727ad2..8d8a48939 100644 --- a/samples/react-pages-hierarchy/README.md +++ b/samples/react-pages-hierarchy/README.md @@ -24,6 +24,11 @@ This web part allows users to create a faux page hierarchy in their pages librar ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-palette-picker/README.md b/samples/react-palette-picker/README.md index 7bad303d1..869e52489 100644 --- a/samples/react-palette-picker/README.md +++ b/samples/react-palette-picker/README.md @@ -10,6 +10,11 @@ Built it to get an understanding of [Property Pane Portal](https://www.npmjs.com ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-peoplepicker/README.md b/samples/react-peoplepicker/README.md index fd8c49367..95401cfe7 100644 --- a/samples/react-peoplepicker/README.md +++ b/samples/react-peoplepicker/README.md @@ -23,6 +23,11 @@ SharePoint Framework solution with the Office UI Fabric People Picker, the clien ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.0](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-LTS%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-personal-greeting/README.md b/samples/react-personal-greeting/README.md index ef988ce48..a8e58b509 100644 --- a/samples/react-personal-greeting/README.md +++ b/samples/react-personal-greeting/README.md @@ -8,6 +8,11 @@ The web part pulls in the current user's name and displays it on the page. The g ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-photo-sync/README.md b/samples/react-photo-sync/README.md index 28696d25f..c513f6ba5 100644 --- a/samples/react-photo-sync/README.md +++ b/samples/react-photo-sync/README.md @@ -48,6 +48,11 @@ This web part will help the administrators to synchronize the **User Profile Pho ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-pnp-controls-list-view-fields/README.md b/samples/react-pnp-controls-list-view-fields/README.md index 245f53c73..405f413a2 100644 --- a/samples/react-pnp-controls-list-view-fields/README.md +++ b/samples/react-pnp-controls-list-view-fields/README.md @@ -6,6 +6,11 @@ Sample web part to display PnP [`ListView`](https://sharepoint.github.io/sp-dev- ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-pnp-controls/README.md b/samples/react-pnp-controls/README.md index 102bb37a3..db17e6673 100644 --- a/samples/react-pnp-controls/README.md +++ b/samples/react-pnp-controls/README.md @@ -26,6 +26,11 @@ This is a sample project that contains a web part which makes use of the PnP SPF ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-pnp-js-hooks/README.md b/samples/react-pnp-js-hooks/README.md index ae2766b3f..0d8249e3e 100644 --- a/samples/react-pnp-js-hooks/README.md +++ b/samples/react-pnp-js-hooks/README.md @@ -25,6 +25,11 @@ This implementation refactors to take aspects out and utilize and showcase PnPjs ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) diff --git a/samples/react-pnp-js-sample/README.md b/samples/react-pnp-js-sample/README.md index a04269363..e5722b0aa 100644 --- a/samples/react-pnp-js-sample/README.md +++ b/samples/react-pnp-js-sample/README.md @@ -1,21 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - platforms: - - react - createdDate: 5/1/2017 12:00:00 AM ---- # SharePoint Framework sample using @pnp/js and ReactJS ## Summary @@ -28,6 +10,11 @@ This implementaiton refactors to take aspects out and utilize and showcase PnPjs ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v12%20%7C%20v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-pnpjs-project-online/README.md b/samples/react-pnpjs-project-online/README.md index a1cb02063..84388916b 100644 --- a/samples/react-pnpjs-project-online/README.md +++ b/samples/react-pnpjs-project-online/README.md @@ -12,6 +12,11 @@ Custom PnPjs module: [pnpjs-project-online-package](https://www.npmjs.com/packag ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-pnpjs-spsite-er-diagram/README.md b/samples/react-pnpjs-spsite-er-diagram/README.md index 9aca3eb04..858ff636c 100644 --- a/samples/react-pnpjs-spsite-er-diagram/README.md +++ b/samples/react-pnpjs-spsite-er-diagram/README.md @@ -9,6 +9,11 @@ This web part loads all lists on a site and display it in a Entity Relationship ## 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 for more information on SPFx compatibility. | + ![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) diff --git a/samples/react-pnpjsexplorer/README.md b/samples/react-pnpjsexplorer/README.md index faabbaa72..40218d207 100644 --- a/samples/react-pnpjsexplorer/README.md +++ b/samples/react-pnpjsexplorer/README.md @@ -28,6 +28,11 @@ Feel free to connect on twitter:@siddh_me or twitter:@sanganikunj for any detail ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-ppp-pnp-controls/README.md b/samples/react-ppp-pnp-controls/README.md index bbf479c29..9d100550a 100644 --- a/samples/react-ppp-pnp-controls/README.md +++ b/samples/react-ppp-pnp-controls/README.md @@ -10,6 +10,11 @@ The React-PPP-PnP-Controls sample showcases the use of the [Property Pane Portal ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-ppw-html/README.md b/samples/react-ppw-html/README.md index e1e4a1107..87c81c0a8 100644 --- a/samples/react-ppw-html/README.md +++ b/samples/react-ppw-html/README.md @@ -16,6 +16,11 @@ The React-PPW-HTML sample showcases the use of the [Property Pane Wrap](https:// ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-private-libraries/README.md b/samples/react-private-libraries/README.md index 58c13c8c7..dd70af40d 100644 --- a/samples/react-private-libraries/README.md +++ b/samples/react-private-libraries/README.md @@ -20,6 +20,11 @@ The application manages all the security groups set up for the various libraries ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-project-online/README.md b/samples/react-project-online/README.md index aef661263..93e2aa9cd 100644 --- a/samples/react-project-online/README.md +++ b/samples/react-project-online/README.md @@ -26,6 +26,11 @@ The web part is currently returning project tasks as a simple proof of concept. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-property-bag-editor/README.md b/samples/react-property-bag-editor/README.md index 10973013b..5a6245c73 100644 --- a/samples/react-property-bag-editor/README.md +++ b/samples/react-property-bag-editor/README.md @@ -7,6 +7,11 @@ A set of webparts that lets you set property bag settings on site collections an ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-provision-assets/README.md b/samples/react-provision-assets/README.md index 85397b6f1..ff8067404 100644 --- a/samples/react-provision-assets/README.md +++ b/samples/react-provision-assets/README.md @@ -25,6 +25,11 @@ This sample shows how we can provision Document Library, Custom List, Web and Li ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-questions-and-answers/README.md b/samples/react-questions-and-answers/README.md index fc3d6a184..47ffdff30 100644 --- a/samples/react-questions-and-answers/README.md +++ b/samples/react-questions-and-answers/README.md @@ -8,6 +8,11 @@ This is an application that supports Questions & Answers through a web part that ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-quick-poll/README.md b/samples/react-quick-poll/README.md index dbfb22fcd..0d981f493 100644 --- a/samples/react-quick-poll/README.md +++ b/samples/react-quick-poll/README.md @@ -43,6 +43,11 @@ Following are some of the features of this component. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-quotes/README.md b/samples/react-quotes/README.md index 1b0b0baaf..ef512db5f 100644 --- a/samples/react-quotes/README.md +++ b/samples/react-quotes/README.md @@ -9,6 +9,11 @@ This web part displays a quote of the day by querying a third-party api or can d ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-realtime-documents/README.md b/samples/react-realtime-documents/README.md index 2d221808c..c9d2dd007 100644 --- a/samples/react-realtime-documents/README.md +++ b/samples/react-realtime-documents/README.md @@ -7,6 +7,11 @@ Sample web part illustrating using the SharePoint Framework List subscription ca ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-recaptcha/README.md b/samples/react-recaptcha/README.md index cf99df4c6..5a41e0dfd 100644 --- a/samples/react-recaptcha/README.md +++ b/samples/react-recaptcha/README.md @@ -12,6 +12,11 @@ business requirement if you need to implement CAPTCHA in SPFx web part. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-redux-async-immutablejs/README.md b/samples/react-redux-async-immutablejs/README.md index 25707fb8a..04a5cdae5 100644 --- a/samples/react-redux-async-immutablejs/README.md +++ b/samples/react-redux-async-immutablejs/README.md @@ -27,6 +27,11 @@ More details in my post here: [Using Redux Async Actions and ImmutableJS in Shar ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-redux/README.md b/samples/react-redux/README.md index d6c402748..b202d481e 100644 --- a/samples/react-redux/README.md +++ b/samples/react-redux/README.md @@ -29,7 +29,12 @@ Sample web part implementation that uses [Redux](https://github.com/reactjs/redu ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 0.4.0](https://img.shields.io/badge/SPFx-0.4.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) diff --git a/samples/react-reduxform/README.md b/samples/react-reduxform/README.md index a151dcef4..31bd7b2ec 100644 --- a/samples/react-reduxform/README.md +++ b/samples/react-reduxform/README.md @@ -11,6 +11,11 @@ Sample web part to demonstrate the use of [Redux-Form](https://github.com/erikra ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-remote-event-receiver-manager/README.md b/samples/react-remote-event-receiver-manager/README.md index 5ca07f65e..f87929e4c 100644 --- a/samples/react-remote-event-receiver-manager/README.md +++ b/samples/react-remote-event-receiver-manager/README.md @@ -8,6 +8,11 @@ A very simple web part that lets you add and delete remote event receivers to li ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-restaurant-menu/README.md b/samples/react-restaurant-menu/README.md index bde956165..e91df3f55 100644 --- a/samples/react-restaurant-menu/README.md +++ b/samples/react-restaurant-menu/README.md @@ -32,6 +32,11 @@ This web part shows a Restaurant Menu, the user can select the options to show i ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-rhythm-of-business-calendar/README.md b/samples/react-rhythm-of-business-calendar/README.md index 8b0c4692e..19b64ac3f 100644 --- a/samples/react-rhythm-of-business-calendar/README.md +++ b/samples/react-rhythm-of-business-calendar/README.md @@ -21,6 +21,11 @@ Edit refiner ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15-green.svg) ![Node.js v16](https://img.shields.io/badge/Node.js-v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-roomchat/README.md b/samples/react-roomchat/README.md index 3b4533f79..e6ede747e 100644 --- a/samples/react-roomchat/README.md +++ b/samples/react-roomchat/README.md @@ -35,6 +35,11 @@ This sample needs the Azure communications services configured on the Azure, Ple ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15.0-green.svg) ![Node.js v16](https://img.shields.io/badge/Node.js-v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-rss-reader/README.md b/samples/react-rss-reader/README.md index c736b37c3..1d785b51e 100644 --- a/samples/react-rss-reader/README.md +++ b/samples/react-rss-reader/README.md @@ -22,6 +22,11 @@ Main features include: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-rxjs-event-emitter/README.md b/samples/react-rxjs-event-emitter/README.md index f8364f0fa..849a5c8a0 100644 --- a/samples/react-rxjs-event-emitter/README.md +++ b/samples/react-rxjs-event-emitter/README.md @@ -23,6 +23,11 @@ This sample shows how we can use the [ReactiveX (RxJs)](http://reactivex.io/) li ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-save-attachments/README.md b/samples/react-save-attachments/README.md index cea52df67..acc4eed0c 100755 --- a/samples/react-save-attachments/README.md +++ b/samples/react-save-attachments/README.md @@ -10,6 +10,11 @@ This SPFx Outlook Add-In lets users save any email attachments to a OneDrive fol ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-save-to-onedrive-app-personal-folder/README.md b/samples/react-save-to-onedrive-app-personal-folder/README.md index c215e2c21..0db5e638e 100644 --- a/samples/react-save-to-onedrive-app-personal-folder/README.md +++ b/samples/react-save-to-onedrive-app-personal-folder/README.md @@ -20,6 +20,11 @@ webpart added to teams ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-save-to-onedrive-app-personal-folder/library/README.md b/samples/react-save-to-onedrive-app-personal-folder/library/README.md index 5dc5b9e20..11f6596fc 100644 --- a/samples/react-save-to-onedrive-app-personal-folder/library/README.md +++ b/samples/react-save-to-onedrive-app-personal-folder/library/README.md @@ -14,6 +14,11 @@ data saved on onedrive in application personal folder ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-save-to-onedrive-app-personal-folder/webpart/README.md b/samples/react-save-to-onedrive-app-personal-folder/webpart/README.md index 7e9587c2c..ac548fef4 100644 --- a/samples/react-save-to-onedrive-app-personal-folder/webpart/README.md +++ b/samples/react-save-to-onedrive-app-personal-folder/webpart/README.md @@ -12,6 +12,11 @@ webpart added to teams ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-script-editor-onprem/README.md b/samples/react-script-editor-onprem/README.md index 43c5e0905..de70088b6 100644 --- a/samples/react-script-editor-onprem/README.md +++ b/samples/react-script-editor-onprem/README.md @@ -100,6 +100,11 @@ If your scripts rely on the classic _spPageContextInfo, you can enable that in t ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-script-editor/README.md b/samples/react-script-editor/README.md index 306602b3e..3b4e1465d 100644 --- a/samples/react-script-editor/README.md +++ b/samples/react-script-editor/README.md @@ -160,6 +160,11 @@ In order to make it available to absolutely all sites you need apply the *Deploy ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-search/README.md b/samples/react-search/README.md index 41ada0aad..cb7f7c071 100644 --- a/samples/react-search/README.md +++ b/samples/react-search/README.md @@ -24,6 +24,11 @@ Sample Search Web Part with internal and external template support. This sample ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-securitygrid/README.md b/samples/react-securitygrid/README.md index 309cb930c..ebc5cb129 100644 --- a/samples/react-securitygrid/README.md +++ b/samples/react-securitygrid/README.md @@ -82,6 +82,11 @@ This is a port of an Angular 1.3 SharePoint hosted App at https://github.com/rus ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-side-panel/README.md b/samples/react-side-panel/README.md index f6a142330..8d656aa48 100644 --- a/samples/react-side-panel/README.md +++ b/samples/react-side-panel/README.md @@ -1,21 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - platforms: - - react - createdDate: 6/1/2017 12:00:00 AM ---- # Side Panel ## Summary @@ -27,6 +9,11 @@ The web part illustrates creation and usage of Side Panel (Sidebar) control. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-site-provisioning-manager/README.md b/samples/react-site-provisioning-manager/README.md index cd7a085c6..b25346447 100644 --- a/samples/react-site-provisioning-manager/README.md +++ b/samples/react-site-provisioning-manager/README.md @@ -11,6 +11,11 @@ You can also find out how you can use React Hooks to manage the state of your ap ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-sitepages-metadata/README.md b/samples/react-sitepages-metadata/README.md index 9e15b276f..6fcc92a2f 100644 --- a/samples/react-sitepages-metadata/README.md +++ b/samples/react-sitepages-metadata/README.md @@ -12,6 +12,11 @@ Solution provides an enhancement to SitePages library that enables updating exis ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-sites-selected-admin/README.md b/samples/react-sites-selected-admin/README.md index 23ed9f7fe..dcef23a5d 100644 --- a/samples/react-sites-selected-admin/README.md +++ b/samples/react-sites-selected-admin/README.md @@ -22,6 +22,11 @@ The web part uses the built in MSGraphClient and needs to be approved in API man ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-skype-status/README.md b/samples/react-skype-status/README.md index 5fc01dc74..789cf3650 100644 --- a/samples/react-skype-status/README.md +++ b/samples/react-skype-status/README.md @@ -28,6 +28,11 @@ See the demo: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-slide-swiper/README.md b/samples/react-slide-swiper/README.md index 5e2263abb..0ea5f0aab 100644 --- a/samples/react-slide-swiper/README.md +++ b/samples/react-slide-swiper/README.md @@ -28,6 +28,11 @@ This sample uses the Swiper JavaScript library thought the npm packages, but jus ## 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 for more information on SPFx compatibility. | + ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-smart-profile-photo-editor/README.md b/samples/react-smart-profile-photo-editor/README.md index 236129bfd..7a73adc69 100644 --- a/samples/react-smart-profile-photo-editor/README.md +++ b/samples/react-smart-profile-photo-editor/README.md @@ -8,6 +8,11 @@ Uses [Azure Cognitive Services](https://azure.microsoft.com/en-us/services/cogni ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-soccer-highlights/README.md b/samples/react-soccer-highlights/README.md index 33cd9edf4..36c59b7fc 100644 --- a/samples/react-soccer-highlights/README.md +++ b/samples/react-soccer-highlights/README.md @@ -24,6 +24,11 @@ ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-sp-elevatedprivileges/README.md b/samples/react-sp-elevatedprivileges/README.md index 1ec79f53e..8d6e615da 100644 --- a/samples/react-sp-elevatedprivileges/README.md +++ b/samples/react-sp-elevatedprivileges/README.md @@ -25,6 +25,11 @@ Sample SharePoint Framework client-side web part illustrating communication with ## 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 for more information on SPFx compatibility. | + ![SPFx 0.4.0](https://img.shields.io/badge/SPFx-0.4.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-sp-pnp-js-property-decorators/README.md b/samples/react-sp-pnp-js-property-decorators/README.md index 20f8d5d4f..6f75af550 100644 --- a/samples/react-sp-pnp-js-property-decorators/README.md +++ b/samples/react-sp-pnp-js-property-decorators/README.md @@ -8,7 +8,12 @@ You can also find more information in the [blog series about working with Custom ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) diff --git a/samples/react-sp-site-user-groups/README.md b/samples/react-sp-site-user-groups/README.md index df18b13c5..08956dcce 100755 --- a/samples/react-sp-site-user-groups/README.md +++ b/samples/react-sp-site-user-groups/README.md @@ -8,6 +8,11 @@ Note: Azure AD Groups are represented as Site Users in SharePoint. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-spupsproperty-sync/README.md b/samples/react-spupsproperty-sync/README.md index 9d0161f15..ccc051584 100644 --- a/samples/react-spupsproperty-sync/README.md +++ b/samples/react-spupsproperty-sync/README.md @@ -55,6 +55,11 @@ This component will help the administrators who are currently maintaining the us ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-staff-directory-sp2019/README.md b/samples/react-staff-directory-sp2019/README.md index 5b263a1a1..e7d2b8a8b 100644 --- a/samples/react-staff-directory-sp2019/README.md +++ b/samples/react-staff-directory-sp2019/README.md @@ -1,24 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - - Msgraph - - Fluent UI React Controls - platforms: - - React - createdDate: 4/9/2020 12:00:00 AM ---- - # Staff Directory (Search Directory) Version 2019 ## Summary @@ -31,6 +10,11 @@ This web part shows the current user's colleagues, and allows the user to search ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![SharePoint 2019 | Online](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg) diff --git a/samples/react-staffdirectory/README.md b/samples/react-staffdirectory/README.md index 0f8008c01..a3f25f72f 100644 --- a/samples/react-staffdirectory/README.md +++ b/samples/react-staffdirectory/README.md @@ -28,6 +28,11 @@ This web part shows the current user's colleagues, and allows the user to search ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20|%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-star-ratings/README.md b/samples/react-star-ratings/README.md index 2c0d2ec34..e0b7b5842 100644 --- a/samples/react-star-ratings/README.md +++ b/samples/react-star-ratings/README.md @@ -8,6 +8,11 @@ This web part demonstrates *Star Ratings* capabilities to SharePoint News. The " ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tabacordion/README.md b/samples/react-tabacordion/README.md index 40b073d64..3f227f309 100644 --- a/samples/react-tabacordion/README.md +++ b/samples/react-tabacordion/README.md @@ -25,6 +25,11 @@ extensions: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tailwindcss/README.md b/samples/react-tailwindcss/README.md index 47b29db7e..413097589 100644 --- a/samples/react-tailwindcss/README.md +++ b/samples/react-tailwindcss/README.md @@ -29,6 +29,11 @@ This project shows how to integrate [Tailwind CSS](https://tailwindcss.com/) fra ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-target-audience/README.md b/samples/react-target-audience/README.md index de1af60c5..a504034eb 100644 --- a/samples/react-target-audience/README.md +++ b/samples/react-target-audience/README.md @@ -9,6 +9,11 @@ Targets SharePoint Groups only within the site. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-taxonomy-file-explorer/README.md b/samples/react-taxonomy-file-explorer/README.md index db9d6f849..d3729e219 100644 --- a/samples/react-taxonomy-file-explorer/README.md +++ b/samples/react-taxonomy-file-explorer/README.md @@ -30,6 +30,11 @@ For further details see the author's [blog post](https://mmsharepoint.wordpress. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.0](https://img.shields.io/badge/version-1.15-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-taxonomypicker-panel/README.md b/samples/react-taxonomypicker-panel/README.md index 9f5db88b9..291b77afd 100644 --- a/samples/react-taxonomypicker-panel/README.md +++ b/samples/react-taxonomypicker-panel/README.md @@ -9,6 +9,11 @@ Sample web part with Single and Multi-select taxonomy pickers using Office UI Fa ## 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 for more information on SPFx compatibility. | + ![SPFx 1.5.1](https://img.shields.io/badge/SPFx-1.5.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-LTS%208%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-taxonomypicker/README.md b/samples/react-taxonomypicker/README.md index 88ff8b616..05a5cb3c0 100644 --- a/samples/react-taxonomypicker/README.md +++ b/samples/react-taxonomypicker/README.md @@ -23,6 +23,11 @@ A Taxonomy Picker control built with [React](https://facebook.github.io/react) b ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-team-creator/README.md b/samples/react-team-creator/README.md index f0800b54a..8240882ce 100644 --- a/samples/react-team-creator/README.md +++ b/samples/react-team-creator/README.md @@ -14,7 +14,12 @@ The web part illustrates usage of MS Graph beta APIs to work with Teams: ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.7.0](https://img.shields.io/badge/SPFx-1.7.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) diff --git a/samples/react-teams-configure-tab/README.md b/samples/react-teams-configure-tab/README.md index c17857b03..3b02c752b 100644 --- a/samples/react-teams-configure-tab/README.md +++ b/samples/react-teams-configure-tab/README.md @@ -13,6 +13,11 @@ When the user selects one of the tab options, the tab is saved pointing to the c ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-graph-upload-as-pdf/README.md b/samples/react-teams-graph-upload-as-pdf/README.md index 933bb6a4a..4f51c290e 100644 --- a/samples/react-teams-graph-upload-as-pdf/README.md +++ b/samples/react-teams-graph-upload-as-pdf/README.md @@ -15,6 +15,11 @@ A detailed functionality and technical description can be found in the [author's ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-lead-dashboard/README.md b/samples/react-teams-lead-dashboard/README.md index 587b7c24a..d92530fea 100644 --- a/samples/react-teams-lead-dashboard/README.md +++ b/samples/react-teams-lead-dashboard/README.md @@ -9,6 +9,11 @@ This sample shows how to integrate SharePoint Framework, PnP React Controls, and ## 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 for more information on SPFx compatibility. | + ![SPFx 1.16.0](https://img.shields.io/badge/SPFx-1.16.0.0-green.svg) ![Node.js >=16.13.0 <17.0.0](https://img.shields.io/badge/Node.js-%3E=16.13.0%20%3C17.0.0-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-meeting-app-questionnaire/README.md b/samples/react-teams-meeting-app-questionnaire/README.md index 0f810aa66..6e1d2945c 100644 --- a/samples/react-teams-meeting-app-questionnaire/README.md +++ b/samples/react-teams-meeting-app-questionnaire/README.md @@ -50,6 +50,11 @@ spfx-react-teams-meeting-app-questionnaire ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-membership-updater/README.md b/samples/react-teams-membership-updater/README.md index 2ba965bad..9853e1d0b 100644 --- a/samples/react-teams-membership-updater/README.md +++ b/samples/react-teams-membership-updater/README.md @@ -12,6 +12,11 @@ Used to update the membership of a team based on the contents of a CSV file, can ## 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 for more information on SPFx compatibility. | + ![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/react-teams-message-user/README.md b/samples/react-teams-message-user/README.md index ddb4f77b1..c271aa0ad 100644 --- a/samples/react-teams-message-user/README.md +++ b/samples/react-teams-message-user/README.md @@ -8,6 +8,11 @@ Sample that shows how to send a message to Microsoft Teams using a SharePoint fr ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-message/README.md b/samples/react-teams-message/README.md index 5841f80d8..8d8cf4691 100644 --- a/samples/react-teams-message/README.md +++ b/samples/react-teams-message/README.md @@ -46,6 +46,11 @@ Configurable Web part Properties ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-personal-app-settings/README.md b/samples/react-teams-personal-app-settings/README.md index 582d497fb..146d1e84c 100644 --- a/samples/react-teams-personal-app-settings/README.md +++ b/samples/react-teams-personal-app-settings/README.md @@ -36,6 +36,11 @@ Downside of this approach is we need to additionally implement "app uninstalled" ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-send-notification/README.md b/samples/react-teams-send-notification/README.md index 9516d68a7..b121fb500 100644 --- a/samples/react-teams-send-notification/README.md +++ b/samples/react-teams-send-notification/README.md @@ -8,6 +8,11 @@ This web part allows you to send MS Teams feed notifications to a selected user. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-tab-field-visit-mashup/README.md b/samples/react-teams-tab-field-visit-mashup/README.md index 6ca065db8..71d3f7993 100644 --- a/samples/react-teams-tab-field-visit-mashup/README.md +++ b/samples/react-teams-tab-field-visit-mashup/README.md @@ -22,6 +22,11 @@ The solution demonstrates: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-tabs-pnpjs/README.md b/samples/react-teams-tabs-pnpjs/README.md index b17312853..bcfdc4150 100644 --- a/samples/react-teams-tabs-pnpjs/README.md +++ b/samples/react-teams-tabs-pnpjs/README.md @@ -13,6 +13,11 @@ A SPFx web part using [@pnp/graph/teams](https://pnp.github.io/pnpjs/graph/docs/ ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-teams-tagging/README.md b/samples/react-teams-tagging/README.md index e95e2a0ad..3d1127ea1 100644 --- a/samples/react-teams-tagging/README.md +++ b/samples/react-teams-tagging/README.md @@ -8,6 +8,11 @@ This sample shows how read and update a custom Schema extension in MS Graph to T ## 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 for more information on SPFx compatibility. | + ![SPFx 1.8](https://img.shields.io/badge/SPFx-1.8.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tenant-properties/README.md b/samples/react-tenant-properties/README.md index bfefb4a2a..5a179e9f3 100644 --- a/samples/react-tenant-properties/README.md +++ b/samples/react-tenant-properties/README.md @@ -29,6 +29,11 @@ Only users with Tenant Admin Role are allowed to managed tenant properties. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-themes/README.md b/samples/react-themes/README.md index 470304906..a22c1cbd6 100644 --- a/samples/react-themes/README.md +++ b/samples/react-themes/README.md @@ -1,21 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - platforms: - - react - createdDate: 5/1/2017 12:00:00 AM ---- # SharePoint Themes ## Summary @@ -31,6 +13,11 @@ The Section Theme web part illustrates how to use theme variant variables to sty ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tiles-v2/README.md b/samples/react-tiles-v2/README.md index c0fceee71..78a6ff120 100644 --- a/samples/react-tiles-v2/README.md +++ b/samples/react-tiles-v2/README.md @@ -10,6 +10,11 @@ This is a rebuild of the awesome project created by @hugoabernier [https://githu ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-timeline/README.md b/samples/react-timeline/README.md index f5f432875..2331fccf4 100644 --- a/samples/react-timeline/README.md +++ b/samples/react-timeline/README.md @@ -71,6 +71,11 @@ Below NPM package is used to develop this sample. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tinymce/README.md b/samples/react-tinymce/README.md index fb0ba8e76..4cd429e15 100644 --- a/samples/react-tinymce/README.md +++ b/samples/react-tinymce/README.md @@ -26,6 +26,11 @@ editor is powered by the community. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg) ![Node.js v8 | v6](https://img.shields.io/badge/Node.js-v8%20%7C%20v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-todo-basic/README.md b/samples/react-todo-basic/README.md index 5bffd4930..b38642c94 100644 --- a/samples/react-todo-basic/README.md +++ b/samples/react-todo-basic/README.md @@ -23,6 +23,11 @@ A simple todo web part built using react to showcase some of the SharePoint Fram ## 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 for more information on SPFx compatibility. | + ![SPFx 1.1.0](https://img.shields.io/badge/SPFx-1.1.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tour-pnpjs/README.md b/samples/react-tour-pnpjs/README.md index 6f51c70f9..4b700ef7c 100644 --- a/samples/react-tour-pnpjs/README.md +++ b/samples/react-tour-pnpjs/README.md @@ -19,6 +19,11 @@ The property pane shows dinamically all webparts in the current page, using [PnP ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-tree-orgchart/README.md b/samples/react-tree-orgchart/README.md index e77f2a2fa..105dd3aeb 100644 --- a/samples/react-tree-orgchart/README.md +++ b/samples/react-tree-orgchart/README.md @@ -18,6 +18,11 @@ You can configure in the web part properties: ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js LTS 10 | LTS 8](https://img.shields.io/badge/Node.js-LTS%2010%20%7C%20LTS%208-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-twitter/README.md b/samples/react-twitter/README.md index e5393514b..0428c13ee 100644 --- a/samples/react-twitter/README.md +++ b/samples/react-twitter/README.md @@ -6,6 +6,11 @@ Sample web part to display Twitter timeline ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js LTS 10 | LTS 8](https://img.shields.io/badge/Node.js-LTS%2010%20%7C%20LTS%208-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-upgrade-me/README.md b/samples/react-upgrade-me/README.md index 2b26b23c4..9dd93dff9 100644 --- a/samples/react-upgrade-me/README.md +++ b/samples/react-upgrade-me/README.md @@ -9,7 +9,12 @@ This web part does nothing, really. It is intended to be used to test upgrading ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![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 v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg "Node.js v6 or v8 is required to run SPFx 1.4.1") diff --git a/samples/react-versiondisplay/README.md b/samples/react-versiondisplay/README.md index 18a9dfdec..45ba048e8 100644 --- a/samples/react-versiondisplay/README.md +++ b/samples/react-versiondisplay/README.md @@ -1,25 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: -## Compatibility - -This sample is designed to be used in the following enviroments: ---- -page_type: sample -products: -- office-sp -languages: -- javascript -- typescript -extensions: - contentType: samples - technologies: - - SharePoint Framework - platforms: - - React - createdDate: 4/10/2020 12:00:00 AM - description: Display your SharePoint solution version within your web parts ---- # Version Display ## Summary @@ -31,6 +9,11 @@ Display your SharePoint solution version within your web parts. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.13.1](https://img.shields.io/badge/SPFx-1.13.1-green.svg) ![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-video-banner/README.md b/samples/react-video-banner/README.md index e6e5ecf84..cbdbc88cd 100644 --- a/samples/react-video-banner/README.md +++ b/samples/react-video-banner/README.md @@ -9,6 +9,11 @@ Use this Web Part to add a video banner with a text on top of it to your pages. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-videolibrary/README.md b/samples/react-videolibrary/README.md index 8f57e2a0d..fd390fdf0 100644 --- a/samples/react-videolibrary/README.md +++ b/samples/react-videolibrary/README.md @@ -64,6 +64,11 @@ See also https://github.com/russgove/O365VideoSync. It's a console app that you ## 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 for more information on SPFx compatibility. | + ![SPFx 0.7.0](https://img.shields.io/badge/SPFx-0.7.0-orange.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-visio/README.md b/samples/react-visio/README.md index 296a37d84..97510036d 100644 --- a/samples/react-visio/README.md +++ b/samples/react-visio/README.md @@ -8,6 +8,11 @@ This sample shows how the [Visio JavaScript APIs](https://docs.microsoft.com/off ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-webcam/README.md b/samples/react-webcam/README.md index 50ae273d6..0ebe90894 100644 --- a/samples/react-webcam/README.md +++ b/samples/react-webcam/README.md @@ -12,6 +12,11 @@ This is sample web part to showcase how to open webcam and take photo in SPFx we ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-webhooks-realtime/README.md b/samples/react-webhooks-realtime/README.md index 31f2e8e9e..c5a862d1f 100644 --- a/samples/react-webhooks-realtime/README.md +++ b/samples/react-webhooks-realtime/README.md @@ -26,6 +26,11 @@ The libraries used by this web part are Socket.io, sp pnp js, moment. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.3.0](https://img.shields.io/badge/SPFx-1.3.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-webpartdetails/README.md b/samples/react-webpartdetails/README.md index 8f34300d8..000ae2723 100644 --- a/samples/react-webpartdetails/README.md +++ b/samples/react-webpartdetails/README.md @@ -11,6 +11,11 @@ Note: This sample will not work in workbench as it loads the web part from curre ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js LTS 10 | LTS 8](https://img.shields.io/badge/Node.js-LTS%2010%20%7C%20LTS%208-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-word-game/README.md b/samples/react-word-game/README.md index ecb63ba25..f3ac91999 100644 --- a/samples/react-word-game/README.md +++ b/samples/react-word-game/README.md @@ -8,6 +8,11 @@ A fun game where you unscramble the words before the time runs out. It stores ev ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-world-clocks/README.md b/samples/react-world-clocks/README.md index 11d34677f..4dd55544d 100644 --- a/samples/react-world-clocks/README.md +++ b/samples/react-world-clocks/README.md @@ -31,6 +31,11 @@ ## 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 for more information on SPFx compatibility. | + ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-yammer-api/README.md b/samples/react-yammer-api/README.md index 9cb62042b..56a1dfe64 100644 --- a/samples/react-yammer-api/README.md +++ b/samples/react-yammer-api/README.md @@ -34,6 +34,11 @@ To enable Office 365 Identity Enforcement on `Office 365 Enterprise E3 Trial ten ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-yammer-praise/README.md b/samples/react-yammer-praise/README.md index f50846130..cdd5fb164 100644 --- a/samples/react-yammer-praise/README.md +++ b/samples/react-yammer-praise/README.md @@ -12,6 +12,11 @@ It also can be added to Microsoft Teams as Personal or Team Tabs. ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js LTS 10 | LTS 8](https://img.shields.io/badge/Node.js-LTS%2010%20%7C%20LTS%208-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-youtube/README.md b/samples/react-youtube/README.md index 6cf500250..1b10d6b51 100644 --- a/samples/react-youtube/README.md +++ b/samples/react-youtube/README.md @@ -24,7 +24,12 @@ This web part allows to search and view the YouTube videos, across the YouTube A ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg) ![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg) diff --git a/samples/react-zod/README.md b/samples/react-zod/README.md index e68970323..bf7d795d2 100644 --- a/samples/react-zod/README.md +++ b/samples/react-zod/README.md @@ -62,6 +62,11 @@ In this example, I used the parsed result data to be displayed on a [DetailsList ## 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 for more information on SPFx compatibility. | + ![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg) ![Node.js v14 | v16](https://img.shields.io/badge/Node.js-v14%20%7C%20v16-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/react-zpl-viewer/README.md b/samples/react-zpl-viewer/README.md index 7dbf44a13..b21ec3de0 100644 --- a/samples/react-zpl-viewer/README.md +++ b/samples/react-zpl-viewer/README.md @@ -1,6 +1,3 @@ -## Compatibility - -This sample is designed to be used in the following enviroments: # react-zpl-viewer ## Summary @@ -12,6 +9,11 @@ This web part will allow a user to select a text file contatining zpl which is u ## 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 for more information on SPFx compatibility. | + ![SPFx 1.9.1](https://img.shields.io/badge/SPFx-1.9.1-green.svg) ![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/riot-list/README.md b/samples/riot-list/README.md index 5f30b2f66..bdc6c7aa3 100644 --- a/samples/riot-list/README.md +++ b/samples/riot-list/README.md @@ -23,6 +23,11 @@ Simplistic sample Web Part that demonstrates the use of RiotJS in creating a Sha ## 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 for more information on SPFx compatibility. | + ![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg) ![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/samples/sharepoint-crud/README.md b/samples/sharepoint-crud/README.md index 6ff8e5a38..19d76071e 100644 --- a/samples/sharepoint-crud/README.md +++ b/samples/sharepoint-crud/README.md @@ -25,6 +25,11 @@ Sample Web Parts illustrating performing SharePoint CRUD operations in React, An ## 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 for more information on SPFx compatibility. | + ![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg) ![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg) diff --git a/samples/vue-js-org-chart/README.md b/samples/vue-js-org-chart/README.md index 07e5d0702..73c9bd5dc 100644 --- a/samples/vue-js-org-chart/README.md +++ b/samples/vue-js-org-chart/README.md @@ -9,7 +9,12 @@ A simple Organisation Chart web part using Office UI Fabric, VueJS, REST API. ## Compatibility -This sample is designed to be used in the following enviroments: +| :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 for more information on SPFx compatibility. | + +This sample is designed to be used in the following environments: ![SPFx 1.8.1](https://img.shields.io/badge/SPFx-1.8.1-green.svg) ![Node.js v8](https://img.shields.io/badge/Node.js-v8-green.svg) diff --git a/samples/vuejs-todo-single-file-component/README.md b/samples/vuejs-todo-single-file-component/README.md index 38a21282c..95928ebeb 100644 --- a/samples/vuejs-todo-single-file-component/README.md +++ b/samples/vuejs-todo-single-file-component/README.md @@ -20,6 +20,11 @@ Sample Todo web part demonstrating how you can utilize [Vue](https://vuejs.org/v ## 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 for more information on SPFx compatibility. | + ![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg) ![Node.js LTS 10 | LTS 8](https://img.shields.io/badge/Node.js-LTS%2010%20%7C%20LTS%208-green.svg) ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) diff --git a/templates/README-template.md b/templates/README-template.md index c9d6d8d7a..ce6ce0e64 100644 --- a/templates/README-template.md +++ b/templates/README-template.md @@ -40,6 +40,11 @@ You can add as many screen shots as you'd like to help users understand your web ## 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 for more information on SPFx compatibility. | + This sample is optimally compatible with the following environment configuration: ![SPFx 1.16.1](https://img.shields.io/badge/SPFx-1.16.1-green.svg) @@ -51,7 +56,6 @@ This sample is optimally compatible with the following environment configuration ![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) -For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix