0Pricing
Tailwind CSS Academy · 课时

Tailwind 插件 API

学习 plugin() 函数签名，使用 addUtilities、addComponents、addBase 和 addVariant 辅助函数扩展 Tailwind 的输出。

Tailwind 插件 API 是 CoddyKit 上的免费 Tailwind CSS Academy 课时。 这是第 1 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Tailwind CSS Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Tailwind CSS Academy 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

Why Write Tailwind Plugins?

Tailwind's built-in utilities cover the vast majority of CSS needs, but there are gaps. You might need a scrollbar-hide utility, a text-shadow family, or a custom variant like not-last:. Rather than writing raw CSS outside of Tailwind's system, plugins let you add these extensions using the same configuration-driven approach as the rest of Tailwind. Plugins keep your extensions discoverable, consistent, and configurable.

The plugin() Function

Tailwind plugins are registered in the plugins array of tailwind.config.js. Each plugin is defined using the plugin() function from the tailwindcss/plugin package. The function receives a callback that gets four helpers: addUtilities, addComponents, addBase, and addVariant. These helpers inject styles into Tailwind's layer system at the correct position in the generated CSS.

// tailwind.config.js
const plugin = require('tailwindcss/plugin');

module.exports = {
  content: ['./src/**/*.{html,js}'],
  theme: { extend: {} },
  plugins: [
    plugin(function({ addUtilities, addComponents, addBase, addVariant }) {
      // Your extension code here
    })
  ]
};

addUtilities: Adding Utility Classes

addUtilities injects new utility classes into Tailwind's utilities layer. Pass it an object where keys are CSS selector strings (starting with a dot) and values are CSS property objects. These utilities work exactly like built-in Tailwind utilities — they respond to responsive prefixes, hover variants, and JIT arbitrary values when configured correctly.

plugin(function({ addUtilities }) {
  addUtilities({
    '.scrollbar-hide': {
      '-ms-overflow-style': 'none',
      'scrollbar-width': 'none',
      '&::-webkit-scrollbar': {
        display: 'none'
      }
    },
    '.text-balance': {
      'text-wrap': 'balance'
    },
    '.content-auto': {
      'content-visibility': 'auto'
    }
  });
})

// Now usable in markup:
// <div class='scrollbar-hide overflow-auto h-64'>...
// <h1 class='text-balance text-4xl font-bold'>...

addComponents: Adding Component Classes

addComponents injects styles into the components layer, which sits between base styles and utilities. Component styles have lower specificity than utilities, so utility classes can always override them. Use addComponents for reusable multi-property component patterns like .btn, .card, or .badge — the equivalent of using @apply in CSS files, but expressed as a plugin.

plugin(function({ addComponents }) {
  addComponents({
    '.btn': {
      display: 'inline-flex',
      alignItems: 'center',
      justifyContent: 'center',
      padding: '0.5rem 1rem',
      borderRadius: '0.5rem',
      fontWeight: '500',
      fontSize: '0.875rem',
      transitionProperty: 'color, background-color',
      transitionDuration: '150ms',
      cursor: 'pointer'
    },
    '.btn-primary': {
      backgroundColor: '#3b82f6',
      color: '#ffffff',
      '&:hover': {
        backgroundColor: '#1d4ed8'
      }
    }
  });
})

addBase: Adding Base Styles

addBase injects styles into the base layer, which is the lowest-specificity layer in Tailwind. Use it for CSS resets, default element styles, or globally applicable rules that should underlie all other styles. addBase is where you would set box-sizing behavior, set a default font, or style native HTML elements.

plugin(function({ addBase, theme }) {
  addBase({
    // Style all h1-h6 elements with a consistent font
    'h1, h2, h3, h4, h5, h6': {
      fontFamily: theme('fontFamily.heading'),
      fontWeight: theme('fontWeight.semibold'),
      lineHeight: theme('lineHeight.tight')
    },
    // Custom focus style for all focusable elements
    ':focus-visible': {
      outline: '2px solid ' + theme('colors.blue.500'),
      outlineOffset: '2px'
    },
    // Smooth scrolling for the whole page
    'html': {
      scrollBehavior: 'smooth'
    }
  });
})

Accessing the Theme in Plugins

Plugin callbacks receive a theme helper function that retrieves values from your Tailwind config. This lets you reference your design tokens inside plugin-generated CSS, keeping plugin output consistent with the rest of your design system. Use theme('colors.blue.500'), theme('spacing.4'), theme('fontFamily.sans'), and any other config path.

plugin(function({ addUtilities, theme }) {
  // Generate text-shadow utilities using spacing scale
  const shadows = {
    '.text-shadow-sm': {
      textShadow: '0 1px 2px ' + theme('colors.black/20')
    },
    '.text-shadow': {
      textShadow: '0 2px 4px ' + theme('colors.black/30')
    },
    '.text-shadow-lg': {
      textShadow: '0 8px 16px ' + theme('colors.black/40')
    },
    '.text-shadow-none': {
      textShadow: 'none'
    }
  };
  addUtilities(shadows);
})

Generating Utilities From Theme Values

A powerful pattern is generating utility classes programmatically from the theme's color palette, spacing scale, or any other config values. Use JavaScript object spreading and the theme() helper to iterate over your palette and generate multiple utilities at once. This is how Tailwind itself generates its hundreds of color utilities from a single color definition.

plugin(function({ addUtilities, theme }) {
  // Generate border-start-* utilities from the color palette
  const colors = theme('colors');
  const utilities = {};

  Object.entries(colors).forEach(([colorName, shades]) => {
    if (typeof shades === 'string') {
      utilities['.border-start-' + colorName] = {
        borderInlineStartColor: shades
      };
    } else {
      Object.entries(shades).forEach(([shade, value]) => {
        utilities['.border-start-' + colorName + '-' + shade] = {
          borderInlineStartColor: value
        };
      });
    }
  });

  addUtilities(utilities);
})

matchUtilities for Arbitrary Values

The matchUtilities helper creates utilities that support Tailwind's arbitrary value syntax — bracket notation like text-shadow-[0_2px_4px_rgba(0,0,0,0.3)]. When you use matchUtilities, users can supply any value within brackets, giving full flexibility while keeping the utility name consistent with your design system convention.

plugin(function({ matchUtilities, theme }) {
  matchUtilities(
    {
      'text-shadow': (value) => ({
        textShadow: value
      })
    },
    {
      // Values from the theme that appear as autocomplete suggestions
      values: theme('textShadow')
    }
  );
  // Usage: text-shadow-sm (from theme) or
  //        text-shadow-[0_4px_8px_rgba(0,0,0,0.5)] (arbitrary)
})

// tailwind.config.js theme extension:
theme: {
  textShadow: {
    sm: '0 1px 2px rgba(0,0,0,0.2)',
    DEFAULT: '0 2px 4px rgba(0,0,0,0.3)',
    lg: '0 8px 16px rgba(0,0,0,0.4)'
  }
}

Plugin Options With withOptions

When you want to share a plugin across projects with configurable behavior, use plugin.withOptions() to create a factory that accepts a configuration object. The outer function receives user options; the inner function receives Tailwind's helpers. Users can then call your plugin as a function with configuration, similar to how @tailwindcss/typography accepts options.

const plugin = require('tailwindcss/plugin');

// scrollbar plugin with options
const scrollbarPlugin = plugin.withOptions(function(options = {}) {
  return function({ addUtilities }) {
    const { width = '6px', track = '#f1f5f9', thumb = '#94a3b8' } = options;

    addUtilities({
      '.scrollbar-custom': {
        '&::-webkit-scrollbar': { width },
        '&::-webkit-scrollbar-track': { background: track },
        '&::-webkit-scrollbar-thumb': { background: thumb, borderRadius: '3px' }
      }
    });
  };
});

// tailwind.config.js usage:
plugins: [
  scrollbarPlugin({ width: '8px', thumb: '#3b82f6' })
]

Debugging Plugins

When a plugin utility does not appear in the output CSS, debug with these steps: verify the plugin is in the plugins array, check that the selector syntax is correct (must start with .), and confirm that a file in the content paths actually uses the class name (JIT only generates classes it detects). Run npx tailwindcss build with --content to inspect the output CSS directly.

# Debug: build CSS and inspect output
npx tailwindcss \
  --input src/input.css \
  --output dist/debug.css \
  --content 'src/**/*.html'

# Then check:
grep 'text-shadow' dist/debug.css

# If missing:
# 1. Is the class used in an HTML file in content paths?
# 2. Does the addUtilities selector start with '.'?
# 3. Is the plugin listed in tailwind.config.js plugins array?

# Safelist it temporarily to confirm plugin works:
safelist: ['text-shadow-lg']

Using Official Tailwind Plugins

Before writing a custom plugin, check the official Tailwind plugins. @tailwindcss/typography adds a prose class for styling HTML content (like markdown). @tailwindcss/forms normalizes form element styles across browsers. @tailwindcss/aspect-ratio (legacy) adds aspect ratio utilities. Install them via npm and add them to the plugins array with optional configuration.

npm install @tailwindcss/typography @tailwindcss/forms

// tailwind.config.js
plugins: [
  require('@tailwindcss/typography'),
  require('@tailwindcss/forms')({
    strategy: 'class'  // use .form-input etc. classes
  })
]

// Usage:
<article class='prose prose-lg prose-blue max-w-none'>
  {/* Beautifully styled HTML content */}
</article>

<input type='text' class='form-input rounded-lg border-gray-300' />

Quick Check

Test your understanding of Tailwind CSS Mastery concepts from this lesson.

Lesson Recap

In this lesson you learned: plugin() is the entry point for all Tailwind extensions, addUtilities/addComponents/addBase inject into the correct CSS layer at the right specificity level, and matchUtilities enables arbitrary value support for custom utilities. Next up we build a practical custom utility plugin that adds scrollbar and text-shadow utilities.

常见问题解答

「Tailwind 插件 API」课时是免费的吗？

是的 — 「Tailwind 插件 API」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Tailwind CSS Academy 课程的其余内容，请升级到 CoddyKit PRO。 Tailwind CSS Academy 课程共包含 4 节课。

「Tailwind 插件 API」这节课中我会学到什么？

学习 plugin() 函数签名，使用 addUtilities、addComponents、addBase 和 addVariant 辅助函数扩展 Tailwind 的输出。 你通过在浏览器中直接运行的动手代码来练习 Tailwind CSS Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Tailwind CSS Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Tailwind CSS Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 1 节课，共 4 节。

「Tailwind 插件 API」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Tailwind CSS Academy 课中编写并运行代码吗？

能。每节 Tailwind CSS Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. Tailwind 插件 API
  2. 通过插件添加自定义工具类
  3. 通过插件添加自定义变体
  4. 发布并复用插件
← 返回 Tailwind CSS Academy