@cherrywind/postcss/dist/index.d.ts

A collection of PostCSS plugins for modern CSS development.

import { Plugin as Plugin_2 } from 'postcss';

/**
 *  px 转换为 局部 rem 插件
 */
export declare const postcssPxToLocalVar: {
    (options?: PxToLocalVarOptions): Plugin_2;
    postcss: boolean;
};

/**
 * A PostCSS plugin that converts rem units to CSS variables via calc().
 *
 * @param opts - Plugin options.
 * @returns A PostCSS plugin instance.
 * @deprecated Use `postcss-px-to-local-var` instead.
 */
export declare const postcssRemToCssVars: {
    (opts?: PostcssRemToCssVarsOptions): Plugin_2;
    postcss: boolean;
};

/**
 * Options for the PostCSS rem-to-css-vars plugin.
 */
export declare interface PostcssRemToCssVarsOptions {
    /**
     * The CSS variable name to use for the base rem value.
     * Defaults to "--local-scope-rem".
     */
    varName?: string;
}

export declare interface PxToLocalVarOptions {
    /**
     *  scope rem的根元素字体大小，计算 scope rem 值的基准 (vw = px / rootValue)。
     * @default 16
     */
    rootValue?: number;
    /**
     * 转换后 scope rem 值的小数点位数。
     * @default 5
     */
    unitPrecision?: number;
    /**
     * 选择器黑名单，数组内的选择器不会被转换。支持字符串和正则。
     * @default []
     */
    selectorBlackList?: (string | RegExp)[];
    /**
     * 要转换的 CSS 属性列表，['*'] 表示所有属性。支持通配符和排除（如 '!margin'）。
     * @default ['*']
     */
    propList?: string[];
    /**
     * 是否直接替换 px 值，true 为直接替换，false 为在 px 声明后添加 rem 声明作为回退。
     * 也可以在开发模式传入 'replace'，为false,便于调试
     * @default true
     */
    replace?: boolean;
    /**
     * 是否转换媒体查询中的 px。
     * @default false
     */
    mediaQuery?: boolean;
    /**
     * 小于或等于这个值的 px 不会被转换。
     * @default 0
     */
    minPixelValue?: number;
    /**
     * 排除某些文件或文件夹，支持正则或函数。
     * @default null
     */
    exclude?: RegExp | ((file: string) => boolean) | null;
    /**
     *  自定义生成的 rem 变量名，默认为 --local-scope-rem
     */
    varName?: string;
}

export { }