sp-dev-fx-webparts/samples/react-themes/README.md

83 lines
3.0 KiB
Markdown

## 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
The Themes web part illustrates how to use SharePoint Theme variables in custom web parts.
![SharePoint Themes Client Side Web Part](./assets/themes.png)
The Section Theme web part illustrates how to use theme variant variables to style web parts based on selected site theme and section background colors.
![SharePoint Section Themes Client Side Web Part](./assets/SectionThemes.png)
## 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)
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg)
![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
## Applies to
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
Solution|Author(s)
--------|---------
react-themes | Alex Terentiev ([Sharepointalist Inc.](http://www.sharepointalist.com)[AJIXuMuK](https://github.com/AJIXuMuK))
react-themes | Artur Kukharevich ([akukharevich](https://github.com/akukharevich))
react-themes | Don Kirkham ([@DonKirkham](https://twitter.com/DonKirkham))
## Version history
Version|Date|Comments
-------|----|--------
1.0|April 27, 2017|Initial release
1.1|May 8, 2017| themePrimary variable example added
1.2|Nov 6, 2020| Upgrade to 1.11.0 (Don Kirkham)
1.3|Nov 16, 2020| Section awareness web part added (Don Kirkham)
## 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.**
## Features
This project contains two client-side web parts built on the SharePoint Framework illustrating multiple techniques showing how to use SharePoint themes variables and variant variables to style custom web parts
## Path to Awesomeness
```bash
git clone the repo
npm i
npm i -g gulp
gulp
```
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-themes" />