支持在 uni-app
中使用 TailwindCSS@3
原有语法开发小程序。支持 vite v2,v3 和 v4,要求 node >= 14.18
。
参考 TailwindCSS 文档 在 uni-app
项目中安装配置 TailwindCSS
。你无需禁用 preflight
,也无需调整原有语法(如 .w-[200.5rpx]
等),你只需要正常书写类名,该插件会替你处理剩下的事情。
安装依赖。
npm install @uni-helper/vite-plugin-uni-tailwind -D
配置 vite.config.ts
。
import { defineConfig } from 'vite';
// @ts-ignore
import nested from 'tailwindcss/nesting';
import tailwindcss from 'tailwindcss';
import tailwindcssConfig from './tailwind.config.ts'; // 注意匹配实际文件
import postcssPresetEnv from 'postcss-preset-env';
import uni from '@dcloudio/vite-plugin-uni';
import uniTailwind from '@uni-helper/vite-plugin-uni-tailwind';
// https://vitejs.dev/config/
export default defineConfig({
css: {
postcss: {
plugins: [
nested(),
tailwindcss({
config: tailwindcssConfig,
}),
postcssPresetEnv({
stage: 3,
features: { 'nesting-rules': false },
}),
],
},
},
plugins: [
uni(),
uniTailwind({
/* options */
}),
],
});
完整示例请查看 playground。
- 类型:
boolean | ((currentPlatform: string) => boolean)
- 默认值:
编译为小程序和快应用时应用
是否应用该插件。
APP
使用 WebView
运行,H5
使用浏览器运行,基本都支持特殊字符,所以默认编译为小程序和快应用时应用该插件。
- 类型:
(attribute: string) => boolean
- 默认值:
转换以 class、Class、classname、className、ClassName、class-name 结尾的 attribute
是否转换某个 attribute
。
- 类型:
(fileName: string) => boolean
- 默认值:
转换 pages、components、layouts 开头的脚本文件
是否转换某个脚本文件。
- 类型:
[string, string][]
- 默认值如下
[
['[', '-'],
[']', '-'],
['(', '-'],
[')', '-'],
['$', '-v-'], // css variable
['#', '-h-'], // hash
['!', '-i-'], // important
['/', '-s-'], // slash
['.', '-d-'], // dot
[':', '_'], // colon
['%', '-p-'], // percentage
["'", '-q-'], // quote
['+', '-a-'], // add
['=', '-e-'], // equal
['&', '-n-'], // and
['?', '-qm-'], // question mark
['@', '-at-'], // at
['*', '-w-'], // wildcard
[',\\s', '-c-'], // comma
[',', '-c-'], // comma
['\\2c\\s', '-c-'], // comma
['\\2c', '-c-'], // comma
['\\\\2c\\s', '-c-'], // comma
['\\\\2c', '-c-'], // comma
];
所有生成样式中特殊字符需要替换成什么字符串。
如果不替换,可能会导致无法正常运行。如果确认无需替换,请设置为空数组。
替换顺序:directChildrenElements
-> spaceBetweenElements
-> divideWidthElements
-> characterMap
-> elementMap
。
- 类型:
string[]
- 默认值:
['view', 'button', 'text', 'image']
Space Between 生成样式中,*
需要替换成什么元素。
如果不替换,可能会导致无法正常运行。如果确认无需替换,请设置为空数组。
替换顺序:directChildrenElements
-> spaceBetweenElements
-> divideWidthElements
-> characterMap
-> elementMap
。
- 类型:
string[]
- 默认值:
['view', 'button', 'text', 'image']
Divide Width 生成样式中,*
需要替换成什么元素。
如果不替换,可能会导致无法正常运行。如果确认无需替换,请设置为空数组。
替换顺序:directChildrenElements
-> spaceBetweenElements
-> divideWidthElements
-> characterMap
-> elementMap
。
- 类型:
string[]
- 默认值:
['view', 'button', 'text', 'image']
Direct Children 生成样式中,后一个 *
需要替换成什么元素。
如果不替换,可能会导致无法正常运行。如果确认无需替换,请设置为空数组。
替换顺序:directChildrenElements
-> spaceBetweenElements
-> divideWidthElements
-> characterMap
-> elementMap
。
- 类型:
[string, string[]][]
- 默认值如下
[
['html', ['page']],
['body', ['page']],
['img', ['image']],
['a', ['functional-page-navigator', 'navigator']],
[
'*',
[
'page',
'cover-image',
'cover-view',
'match-media',
'movable-area',
'movable-view',
'scroll-view',
'swiper',
'swiper-item',
'view',
'icon',
'progress',
'rich-text',
'text',
'button',
'checkbox',
'checkbox-group',
'editor',
'form',
'input',
'label',
'picker',
'picker-view',
'picker-view-column',
'radio',
'radio-group',
'slider',
'switch',
'textarea',
'functional-page-navigator',
'navigator',
'audio',
'camera',
'image',
'live-player',
'live-pusher',
'video',
'voip-room',
'map',
'canvas',
'ad',
'ad-custom',
'official-account',
'open-data',
'web-view',
'navigation-bar',
'page-meta',
],
],
];
所有生成样式中特定元素需要替换成什么元素。
如果不替换,可能会导致无法正常运行。如果确认无需替换,请设置为空数组。
替换顺序:directChildrenElements
-> spaceBetweenElements
-> divideWidthElements
-> characterMap
-> elementMap
。
请注意:请不要在新项目中使用 WindiCSS
!详见 Windi CSS is Sunsetting。
如果你没有使用 WindiCSS
内的高级功能(如 Attributify Mode),这个库可以正常工作。
建议使用 unocss-applet 以获取更好的支持。
如果你没有使用 UnoCSS
内的高级功能(如 Attributify Mode、Tagify Mode),这个库可以正常工作。
简而言之,rpx
是一个跟屏幕宽度挂钩的响应式单位,不应该也不需要把所有用到 px
或者 rem
的地方换成 rpx
。
什么时候必须要用 rpx
?我个人的经验是 aside
的宽度需要随屏幕宽度变化、main
根据 aside
宽度变化时,才必须用到 rpx
+ flexbox
的组合,否则用 flexbox
就已经足够了。
所以,这个插件不支持 rpx
转换。你可以直接 使用任意值,如 .w-[750rpx]
、.w-[200rpx]
,我相信可以满足绝大部分的需求。
如果你悲伤地发现这没法满足你的需求,可能这个插件不适合你,请看看以下几个项目是否满足你的需求。
uni-app
+ TailwindCSS
不能编译出小程序能正常运行的代码的错误原因有以下几种:
- 样式文件中含有不支持的字符,如
()[]$#!/.:,%'
等; - 样式文件中含有不支持的元素,如
html
,body
、img
、a
、*
等; - 自带组件传参,模板文件中含有不支持的字符,如
()[]$#!/.:,%'
等; - 自定义组件传参,脚本文件中含有不支持的字符,如
()[]$#!/.:,%'
等,导致参数渲染不正常。
那么,我们只需要做到以下几点就可以让 TailwindCSS
跑在小程序中,而不需要调整 TailwindCSS
的语法来增加开发时的心智负担:
- 使用
postcss
改写样式文件里面的selector
,包括字符和元素; - 使用
babel
改写模板文件里面的class
,只包括字符,这是为了和样式文件里面的selector
相匹配; - 使用
babel
改写脚本文件里面的class
,这也是为了和样式文件里面的selector
相匹配。
但请注意,这个插件不是万能的。
- 插件无法突破小程序的限制,比如
bg-[url(xxxx)]
经过插件处理后可以正常使用,但是小程序平台不支持使用background-image
,此时仍然无法正常渲染出图片。 - 插件不支持特别复杂的情况,如果自定义组件传参过于复杂,仍然可能绕过插件处理。如果你发现这种情况,欢迎提交 Issue 或 PR 协助改进该插件 🙏
该项目从以下项目汲取了灵感并参考了代码。在此对它们的开发者表示由衷的感谢。
也感谢以下项目的开发者,如果没有他们,前端开发比现在更加困难。