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

70 lines
3.1 KiB
Markdown
Raw Normal View History

2020-11-19 00:28:59 -05:00
# SharePoint Themes
## Summary
2020-11-19 00:28:59 -05:00
The Themes web part illustrates how to use SharePoint Theme variables in custom web parts.
![SharePoint Themes Client Side Web Part](./assets/themes.png)
2020-11-19 00:28:59 -05:00
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)
2022-02-14 02:52:18 -05:00
## Compatibility
2021-11-07 01:43:55 -04:00
| :warning: Important |
|:---------------------------|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
2021-11-07 01:43:55 -04:00
![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)
2022-02-15 00:37:36 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2022-10-17 10:21:52 -04:00
For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix
## Applies to
2022-10-24 09:42:45 -04:00
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
Solution|Author(s)
--------|---------
2020-11-19 00:28:59 -05:00
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
2020-11-19 00:28:59 -05:00
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
2020-11-19 00:28:59 -05:00
**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
2020-11-19 00:28:59 -05:00
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
```
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-themes" />