@autobg/postcss v1.5.0

🎨 @autobg/postcss

基于 PostCSS 的插件，提供了名为 @autobg 和 @autobg-aspect 的 AtRule。通过简单的图片路径声明，即可自动设置元素的背景图片和尺寸。

✨ 核心特性

• 🚀 支持 Vite 和 Webpack 构建工具
• 🔄 识别图片尺寸并自动应用
• 📍 灵活支持相对路径和路径别名
• 📐 支持多种灵活的缩放模式
• 🎨 提供 @autobg 和 @autobg-aspect 两种模式

📦 安装

pnpm add @autobg/postcss

⚙️ 配置

Vite 配置

// vite.config.ts
import { resolve } from 'node:path'
import { postcssAutobg } from '@autobg/postcss'
import react from '@vitejs/plugin-react'
import { defineConfig } from 'vite'

export default defineConfig({
  resolve: {
    alias: {
      '@': resolve(__dirname, 'src'),
    },
  },
  css: {
    postcss: {
      plugins: [
        postcssAutobg(),
      ],
    },
  },
})

Webpack 配置

// craco.config.ts
import type { CracoConfig } from '@craco/types'
import { resolve } from 'node:path'

export default {
  webpack: {
    alias: {
      '@': resolve(__dirname, 'src'),
    },
  },
  style: {
    postcss: {
      mode: 'extends',
      loaderOptions: {
        postcssOptions: {
          plugins: [postcssAutobg()],
        }
      }
    }
  },
} satisfies CracoConfig

注意：以上 Webpack 配置示例使用 craco，但同样适用于其他 Webpack 配置。

🎯 使用指南

基础用法

.foo {
  /* 基本用法 - 自动设置背景图和尺寸 */
  @autobg url('./assets/foo.png');
}

等比缩放

固定宽度或高度

.foo {
  /* 固定宽度，高度按比例计算 */
  @autobg url('./assets/foo.png') width(100px);
  @autobg url('./assets/foo.png') w(100px);

  /* 固定高度，宽度按比例计算 */
  @autobg url('./assets/foo.png') height(100px);
  @autobg url('./assets/foo.png') h(100px);
}

整体缩放比例

.foo {
  /* 应用均匀缩放（数字） */
  @autobg url('./assets/foo.png') scale(0.78);
  @autobg url('./assets/foo.png') s(0.78);

  /* 应用均匀缩放（百分比） */
  @autobg url('./assets/foo.png') scale(78%);
  @autobg url('./assets/foo.png') s(78%);
}

使用 aspect-ratio 属性

利用现代 CSS 的 aspect-ratio 属性保持元素宽高比，实现更灵活的布局控制。

特别适用于需要响应式缩放的场景，当父元素尺寸动态变化时尤为有效：

/* 父元素高度可能会动态变化 */
.parent {
  height: 200px;
}

.child {
  /* 子元素会自动保持图片原始宽高比并适应父元素 */
  @autobg-aspect url('./assets/foo.png') height();
}

当父元素的高度发生变化时，子元素会自动保持原始图片的宽高比例，实现等比例缩放。

基础用法

不指定宽高时，仅生成背景和宽高比：

.foo {
  @autobg-aspect url('./assets/foo.png');
  /* 需要手动设置宽度或高度 */
  width: 100%;
}

📐 指定生成宽度或高度

自动生成一个维度的值（默认100%）：

.foo {
  /* 生成高度，保持原图宽高比 */
  @autobg-aspect url('./assets/foo.png') height();
  @autobg-aspect url('./assets/foo.png') h();

  /* 生成宽度，保持原图宽高比 */
  @autobg-aspect url('./assets/foo.png') width();
  @autobg-aspect url('./assets/foo.png') w();
}

💡 注意：所有方法参数都必须带括号，即使不传入具体数值。例如必须使用 height() 而不是 height，这是 PostCSS AtRule 函数调用的语法要求。

自定义比例

设置宽高：

.foo {
  /* 设置高度值，保持原图宽高比 */
  @autobg-aspect url('./assets/foo.png') height(78%);
  @autobg-aspect url('./assets/foo.png') h(78px);
  @autobg-aspect url('./assets/foo.png') h(78rem);

  /* 设置宽度值，保持原图宽高比 */
  @autobg-aspect url('./assets/foo.png') width(78%);
  @autobg-aspect url('./assets/foo.png') w(78px);
  @autobg-aspect url('./assets/foo.png') w(78rem);
}

💡 提示：在 aspect 模式下，值会直接设置到 width 或 height 属性上，不会经过转换。

📋 缩放选项总览

⚠️ 注意事项

如果遇到 css(unknownAtRules) 警告，请参考以下解决方案：

• 解决 Vue.js 项目中的 CSS unknownAtRules 错误

📝 配置项说明

📄 许可证

MIT