PurgeCSS中文文档网PurgeCSS中文文档网
首页
文档
API参考
GitHub
首页
文档
API参考
GitHub
  • PurgeCSS

    • 关于PurgeCSS
    • 快速开始
    • 配置
    • 命令行接口
    • 编程API
    • 安全列表
    • 提取器
  • 插件

    • PostCSS插件
    • Webpack插件
    • Gulp插件
    • Grunt插件
    • Gatsby插件
  • 指南

    • Vue
    • React
    • Next.js
    • Nuxt.js
    • Razzle
    • WordPress
    • Hugo
  • 比较
  • 常见问题

    • 如何与CSS模块一起使用
    • 如何与Ant Design一起使用

PurgeCSS 核心包

安装

npm install purgecss

基本使用

import PurgeCSS from 'purgecss'

const purgeCss = new PurgeCSS({
  content: ['**/*.html'],
  css: ['**/*.css']
})

const result = await purgeCss.purge()

配置选项

content

  • 类型:string[]
  • 描述:包含要分析的文件路径的数组。

css

  • 类型:string[]
  • 描述:要处理的 CSS 文件路径数组。

extractors

  • 类型:Array<{ extractor: Function, extensions: string[] }>
  • 描述:自定义提取器,用于从特定文件类型中提取选择器。

safelist

  • 类型:string[] | { standard?: string[], deep?: string[], greedy?: string[] }
  • 描述:要保留的选择器列表。

blocklist

  • 类型:string[]
  • 描述:要删除的选择器列表。

方法

purge()

  • 返回:Promise<Array<{ css: string, file?: string }>>
  • 描述:分析内容并删除未使用的 CSS。

示例

import PurgeCSS from 'purgecss'

const purgeCss = new PurgeCSS({
  content: ['./src/**/*.html', './src/**/*.js'],
  css: ['./src/styles.css'],
  safelist: {
    standard: ['body', 'html'],
    deep: [/^nav-/],
    greedy: [/^bg-/]
  }
})

const result = await purgeCss.purge()
console.log(result)

相关链接

  • GitHub 仓库
  • 官方文档
Edit this page