Tailwind CSS on GitHub

在 Create React App 中安装 Tailwind CSS

在Create React App项目中配置 Tailwind CSS。

创建您的工程

如果您还没有建立一个新的 Create React App 项目,请先创建一个新的项目。最常见的方法是使用 Create React App

npx create-react-app my-project
cd my-project

初始化 Tailwind CSS

通过 npm 安装 Tailwind

安装 Tailwind 以及其它依赖项:

npm install tailwindcss@npm:@tailwindcss/postcss7-compat @tailwindcss/postcss7-compat postcss@^7 autoprefixer@^9

Create React App 尚未支持 PostCSS 8,所以您需要安装 Tailwind CSS v2.0 PostCSS 7 兼容性版本

安装和配置 CRACO

由于 Create React App 不能让您覆盖原生的 PostCSS 配置,所以我们还需要安装 CRACO 才能配置 Tailwind。

npm install @craco/craco

安装完毕后,更新 package.json 文件中的 scripts,将 eject 以外的所有脚本都用 craco 代替 react-scripts

  {
    // ...
    "scripts": {
-     "start": "react-scripts start",
-     "build": "react-scripts build",
-     "test": "react-scripts test",
+     "start": "craco start",
+     "build": "craco build",
+     "test": "craco test",
      "eject": "react-scripts eject"
    },
  }

接下来,在项目根部创建一个 craco.config.js,并添加 tailwindcssautoprefixer 作为 PostCSS 插件。

// craco.config.js
module.exports = {
  style: {
    postcss: {
      plugins: [
        require('tailwindcss'),
        require('autoprefixer'),
      ],
    },
  },
}

如果您计划使用任何其他 PostCSS 插件,您应该阅读我们的文档使用 PostCSS 作为您的预处理器,以获得更多关于集成它们和 Tailwind 的最佳方式的细节。

创建您的配置文件

接下来,生成您的 tailwind.config.js 文件:

npx tailwindcss init

这将会在您的项目根目录创建一个最小化的 tailwind.config.js 文件:

// tailwind.config.js
module.exports = {
  purge: [],
  darkMode: false, // or 'media' or 'class'
  theme: {
    extend: {},
  },
  variants: {
    extend: {},
  },
  plugins: [],
}

阅读配置文档了解更多。

配置 Tailwind 来移除生产环境下没有使用到的样式声明

在您的 tailwind.config.js 文件中,配置 purge 选项指定所有的 components 文件,使得 Tailwind 可以在生产构建中对未使用的样式进行摇树优化。

  // tailwind.config.js
  module.exports = {
-   purge: [],
+   purge: ['./src/**/*.{js,jsx,ts,tsx}', './public/index.html'],
    darkMode: false, // or 'media' or 'class'
    theme: {
      extend: {},
    },
    variants: {
      extend: {},
    },
    plugins: [],
  }

请阅读我们单独的优化生产指南,以了解更多关于摇树优化未使用的样式来获得最佳性能的信息。

在您的 CSS 中引入 Tailwind

打开 Create React App 默认为您生成的 ./src/index.css 文件 并使用 @tailwind 指令来包含 Tailwind的 basecomponentsutilities 样式,来替换掉原来的文件内容。

/* ./src/index.css */
@tailwind base;
@tailwind components;
@tailwind utilities;

Tailwind 会在构建时将这些指令转换成所有基于您配置的设计系统生成的样式文件。

阅读我们的文档添加基础样式提取组件,和添加新的功能类,以获得用您自己的自定义 CSS 扩展 Tailwind 的最佳实践。

最后,确保您的 CSS 文件被导入到您的 ./src/index.js 文件中。

  // src/index.js
  import React from 'react';
  import ReactDOM from 'react-dom';
+ import './index.css';
  import App from './App';
  import reportWebVitals from './reportWebVitals';

  ReactDOM.render(
    <React.StrictMode>
      <App />
    </React.StrictMode>,
    document.getElementById('root')
  );

  // ...

您已经完成了所有步骤!现在,当您运行 npm run start, Tailwind CSS 就可以在您的 Create React App 项目中使用了。

接下来了解一下功能类优先的工作流程