@githubocto/tailwind-vscode

中文文档
1.0.5发布于 2023/07/21MITCommonJS零依赖近 30 天下载 3395

Defines Tailwind color classes for VS Code extension colors

原始使用文档
文档目录3 节
  1. How do I use it?
  2. How does it work?
  3. License

tailwind-vscode

Are you authoring VS Code extensions with webviews? Step right up! This is a plugin for Tailwind that exposes VS Code's theme colors as Tailwind colors — with all of the variants (bg, text, border, etc…) Now you can author styles for your extension's webviews with Tailwind and use the active VS Code theme colors.

No, this is not a plugin for VS Code! Your absolutely should check out the Tailwind CSS IntelliSense plugin, though. Not gonna lie, it's pretty fantastic.

How do I use it?

Add via your favorite package manager.

$ npm i -D @githubocto/tailwind-vscode
$ # or yarn, I ain't gonna judge
$ yarn add -D @githubocto/tailwind-vscode

Then add the plugin to your tailwind.config.js:

module.exports = {
  /* other config stuff here */
  plugins: [require('@githubocto/tailwind-vscode')],
}

And style components!

<input className='bg-vscode-input-background text-vscode-input-foreground border-vscode-input-border focus:border-vscode-inputOption-activeBorder'/>

Doing a little celebratory dance in your chair is optional but encouraged.

The VS Code theme colors are represented as Tailwind colors under vscode, with hyphens subtituted for periods (foo.bar → foo-bar).

How does it work?

Webviews are exposed inside an <iframe>. If you open the webview's developer tools and inspect the <html>, you'll see a style property with a honking large list of CSS custom properties, also known by their rapper name, "variables".

These are injected by VS Code, and contain the style colors defined by the active VS Code theme. When a user changes the theme, the variables change. Voilà, themeability inside webviews.

Only, once you get used to Tailwind-y everything, using those color variables is quite jarring.

This plugin creates a vscode Tailwind color object with definitions for every VS Code theme color.

You could map these variables manually, like so:

module.exports = {
  theme: {
    extend: {
      colors: {
        vscode: {
          'contrastBorder': 'var(--vscode-contrastBorder)',
          'focusBorder': 'var(--vscode-focusBorder)',
          'foreground': 'var(--vscode-foreground)',
          'widget-shadow': 'var(--vscode-widget-shadow)'
          /* … and 500 more */

But this is tedious. Use this plugin and spend your time on loftier pursuits.

License

MIT

版本与发布记录

@githubocto/tailwind-vscode 共发布 5 个版本,首次发布于 2021/04/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.5latest2023/07/213 年前
1.0.42021/04/225 年前
1.0.32021/04/225 年前
1.0.22021/04/225 年前
1.0.12021/04/225 年前

关于 @githubocto/tailwind-vscode 的常见问题

@githubocto/tailwind-vscode 是什么?

Defines Tailwind color classes for VS Code extension colors

如何安装 @githubocto/tailwind-vscode?

在项目目录运行 npm install @githubocto/tailwind-vscode,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:tailwindcss(2.0.0-alpha.24 || ^2.0.0 || ^3.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@githubocto/tailwind-vscode 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/githubocto__tailwind-vscode 是否存在。

@githubocto/tailwind-vscode 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@githubocto/tailwind-vscode 可以商用吗?

@githubocto/tailwind-vscode 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@githubocto/tailwind-vscode 的下载量有多少?

根据 npm 官方下载统计,@githubocto/tailwind-vscode 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,395 次,日均约 113 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@githubocto/tailwind-vscode 还在维护吗?

最新版本 1.0.5 发布于 2023/07/21(3 年前);至今共发布 5 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/04/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。