History

Hugo Bernier c58bf588b8 Merge pull request #4933 from pnp/dependabot/npm_and_yarn/samples/react-css-in-js-typestyle/follow-redirects-1.15.6		2024-03-25 21:43:20 -04:00
..
.devcontainer	Added SPFx 1.10 containers	2022-02-15 00:50:11 -05:00
assets	Changed docs links to learn	2022-10-24 09:42:45 -04:00
config	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
src	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
teams	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
.editorconfig	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
.gitignore	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
.yo-rc.json	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
README.md	Updated contributors for readmes	2023-03-15 00:11:27 -04:00
gulpfile.js	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
package-lock.json	Merge pull request #4933 from pnp/dependabot/npm_and_yarn/samples/react-css-in-js-typestyle/follow-redirects-1.15.6	2024-03-25 21:43:20 -04:00
package.json	Bump debug, @microsoft/sp-build-web and @microsoft/sp-webpart-workbench	2023-01-12 08:46:56 -05:00
tsconfig.json	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00
tslint.json	New sample - CSS in JS with TypeStyle.	2020-04-24 00:07:25 +03:00

README.md

"CSS in JS" with SharePoint Framework and TypeStyle

Summary

The web part demonstrates the usage of "CSS in JS" pattern with SharePoint Framework. "CSS in JS" is implemented using TypeStyle library. Read more in the blog post here.

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

Applies to

Contributors

Sergei Sergeev

Version history

Version	Date	Comments
1.0	April 24, 2020	Initial release

Minimal Path to Awesome

Clone this repository
From your command line, change your current directory to the directory containing this sample (react-css-in-js-typestyle, located under samples)
in the command line run:
- npm install
- gulp build
- gulp bundle --ship
- gulp package-solution --ship
add the web part to your tenant app store
add the app to a SharePoint site and then add the web part to the page

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

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

"CSS in JS" pattern adopted to SharePoint Framework
Theme support using SharePoint Framework's ThemeProvider
Dynamically reacting to theme changes without affecting performance
React hooks

Video

Help

We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.