sp-dev-fx-webparts/samples/react-tailwindcss
..
assets
config
src
teams
.editorconfig
.gitignore
.yo-rc.json
README.md
gulpfile.js
package-lock.json
package.json
tailwind.config.js
tsconfig.json
tslint.json

README.md

http://aka.ms/m365devprogramhttp://aka.ms/m365devprogramhttp://aka.ms/m365devprogramhttp://aka.ms/m365devprogram--- page_type: sample products:

  • office-sp languages:
  • javascript
  • typescript extensions: contentType: samples technologies:
    • SharePoint Framework
    • TailWind CSS platforms:
    • React createdDate: 10/17/2020 12:00:00 AM

react-tailwindcss

Summary

This project shows how to integrate Tailwind CSS framework into a SPFx React project by:

  • Create a custom Tailwind CSS config file
  • Create a custom Gulp Task to process the Tailwind CSS generated file and optimize it
  • Using CSS custom properties to manage in Tailwind CSS Classes the Theme Variant into sections
  • Avoid writing SASS but only use Tailwind CSS classes to style components

Web Part

Compatibility

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

SPFx 1.11 Node.js v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

Contributors

Version history

Version Date Comments
1.0 October 17, 2020 Initial release

Minimal Path to Awesome

  • Clone this repository
  • Ensure that you are at the solution folder
  • in the command-line run:
    • npm install
    • gulp serve

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

References

Video

Integrating Tailwind CSS framework into a SPFx React project for advance User Experience

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.