purgecss-webpack-plugin
- Version 7.0.2
- Published
- 21.2 kB
- 2 dependencies
- MIT license
Install
npm i purgecss-webpack-plugin
yarn add purgecss-webpack-plugin
pnpm add purgecss-webpack-plugin
Overview
PurgeCSS plugin for webpack - Remove unused css
Index
Classes
Interfaces
Type Aliases
Classes
class PurgeCSSPlugin
class PurgeCSSPlugin {}
Modifiers
@public
constructor
constructor(options: UserDefinedOptions);
property options
options: UserDefinedOptions;
property purgedStats
purgedStats: PurgedStats;
method apply
apply: (compiler: Compiler) => void;
method initializePlugin
initializePlugin: (compilation: Compilation) => void;
method runPluginHook
runPluginHook: (compilation: Compilation, entryPaths: string[]) => Promise<void>;
Interfaces
interface ExtractorResultDetailed
interface ExtractorResultDetailed {}
Modifiers
@public
property attributes
attributes: { names: string[]; values: string[];};
property classes
classes: string[];
property ids
ids: string[];
property tags
tags: string[];
property undetermined
undetermined: string[];
interface Extractors
interface Extractors {}
Modifiers
@public
property extensions
extensions: string[];
property extractor
extractor: ExtractorFunction;
interface PurgeCSSUserDefinedOptions
interface PurgeCSSUserDefinedOptions {}
Options used by PurgeCSS to remove unused CSS
Modifiers
@public
property blocklist
blocklist?: StringRegExpArray;
See documentation for Options.blocklist from package purgecss.
property content
content: Array<string | RawContent>;
See documentation for Options.content from package purgecss.
property css
css: Array<string | RawCSS>;
See documentation for Options.css from package purgecss.
property defaultExtractor
defaultExtractor?: ExtractorFunction;
See documentation for Options.defaultExtractor from package purgecss.
property dynamicAttributes
dynamicAttributes?: string[];
See documentation for Options.dynamicAttributes from package purgecss.
property extractors
extractors?: Array<Extractors>;
See documentation for Options.extractors from package purgecss.
property fontFace
fontFace?: boolean;
See documentation for Options.fontFace from package purgecss.
property keyframes
keyframes?: boolean;
See documentation for Options.keyframes from package purgecss.
property output
output?: string;
See documentation for Options.output from package purgecss.
property rejected
rejected?: boolean;
See documentation for Options.rejected from package purgecss.
property rejectedCss
rejectedCss?: boolean;
See documentation for Options.rejectedCss from package purgecss.
property safelist
safelist?: UserDefinedSafelist;
See documentation for Options.safelist from package purgecss.
property skippedContentGlobs
skippedContentGlobs?: Array<string>;
See documentation for Options.skippedContentGlobs from package purgecss.
property sourceMap
sourceMap?: boolean | (postcss.SourceMapOptions & { to?: string });
See documentation for Options.sourceMap from package purgecss.
property stdin
stdin?: boolean;
See documentation for Options.stdin from package purgecss.
property stdout
stdout?: boolean;
See documentation for Options.stdout from package purgecss.
property variables
variables?: boolean;
See documentation for Options.variables from package purgecss.
interface RawContent
interface RawContent<T = string> {}
Modifiers
@public
Type Aliases
type BlocklistFunction
type BlocklistFunction = () => StringRegExpArray;
Modifiers
@public
type ComplexSafelist
type ComplexSafelist = { standard?: StringRegExpArray; /** * You can safelist selectors and their children based on a regular * expression with `safelist.deep` * * @example * * ```ts * const purgecss = await new PurgeCSS().purge({ * content: [], * css: [], * safelist: { * deep: [/red$/] * } * }) * ``` * * In this example, selectors such as `.bg-red .child-of-bg` will be left * in the final CSS, even if `child-of-bg` is not found. * */ deep?: RegExp[]; greedy?: RegExp[]; variables?: StringRegExpArray; keyframes?: StringRegExpArray;};
Modifiers
@public
type ExtractorFunction
type ExtractorFunction<T = string> = (content: T) => ExtractorResult;
Modifiers
@public
type ExtractorResult
type ExtractorResult = ExtractorResultDetailed | string[];
Modifiers
@public
type PathFunction
type PathFunction = () => string[];
Modifiers
@public
type PurgedStats
type PurgedStats = { [index: string]: string[];};
Modifiers
@public
type SafelistFunction
type SafelistFunction = () => ComplexSafelist;
Modifiers
@public
type StringRegExpArray
type StringRegExpArray = Array<RegExp | string>;
Modifiers
@public
type UserDefinedOptions
type UserDefinedOptions = Omit< PurgeCSSUserDefinedOptions, 'css' | 'content' | 'safelist' | 'blocklist' | 'sourceMap'> & { paths: string[] | PathFunction; moduleExtensions?: string[]; verbose?: boolean; safelist: PurgeCSSUserDefinedOptions['safelist'] | SafelistFunction; blocklist: PurgeCSSUserDefinedOptions['blocklist'] | BlocklistFunction; only?: string[];};
Modifiers
@public
type UserDefinedSafelist
type UserDefinedSafelist = StringRegExpArray | ComplexSafelist;
Modifiers
@public
Package Files (1)
Dependencies (2)
Dev Dependencies (3)
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/purgecss-webpack-plugin
.
- Markdown[](https://www.jsdocs.io/package/purgecss-webpack-plugin)
- HTML<a href="https://www.jsdocs.io/package/purgecss-webpack-plugin"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3002 ms. - Missing or incorrect documentation? Open an issue for this package.