npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@greypan/unplugin-web-components

v1.4.1

Published

Unplugin for web components auto-import

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bopanbopan

Keywords

Readme

@greypan/unplugin-web-components

Unplugin for web components auto-import in React, Vue, and Vite HTML entries

English | 简体中文

Features

  • Auto-import: Automatically import web components when detected in templates
  • Dual tag detection: Supports both kebab-case (<web-ui-button>) and PascalCase (<WebUiButton>) in module source
  • Style injection: Optional CSS import for component styles
  • Vite HTML entries: Inject component imports into index.html and other Vite HTML build inputs
  • Entry points: /vite and /webpack sub-path exports only

Install

# npm
npm install @greypan/unplugin-web-components

# pnpm
pnpm add @greypan/unplugin-web-components

# yarn
yarn add @greypan/unplugin-web-components

# bun
bun add @greypan/unplugin-web-components

Quick Start

// vite.config.ts
import unpluginWebComponents from '@greypan/unplugin-web-components/vite'

export default defineConfig({
  plugins: [
    unpluginWebComponents({
      tagPrefix: 'web-ui',
      packageName: '@greypan/web-ui',
      sideEffects: true
    })
  ]
})

Now when you use <web-ui-button> in a Vue template, React JSX/TSX, or a Vite HTML entry, the import is automatically added:

<!-- Vue: auto-imported -->
<template>
  <web-ui-button>Click me</web-ui-button>
</template>
// React: auto-imported
function App() {
  return <web-ui-button>Click me</web-ui-button>
}

Vite HTML entry

For an HTML entry processed by Vite, the plugin scans the markup and injects a <script type="module"> at the top of <head> with a static import per component:

<!-- index.html -->
<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Vanilla + web-ui</title>
  </head>
  <body>
    <web-ui-button>Click me</web-ui-button>
    <script type="module" src="/src/main.ts"></script>
  </body>
</html>

With sideEffects: true the injected script is roughly:

<script type="module">
  import '@greypan/web-ui/components/button'
</script>

Notes on HTML injection:

  • Only kebab-case custom elements (<web-ui-*> → web-ui-button) are detected. Matching is case-insensitive because HTML tag names are normalized to lowercase by the parser: <WEB-UI-BUTTON> and <web-ui-Button> are both treated as web-ui-button. CamelCase names like <WebUiButton> are not — the parser normalizes them to a different tag (webuibutton).
  • HTML comments and raw-text/RCDATA regions (script, style, title, textarea, iframe, xmp, noembed, noframes, noscript) are ignored, so pseudo-tags in them never produce imports. Unclosed regions are normally treated as running to the end of the file; because a regex scanner cannot model comment and RAWTEXT tokenizer states simultaneously, an unclosed <script>/style pseudo-tag inside a comment (for example, <!-- <script> --><web-ui-button>) may swallow a real tag that follows it. Quoted attribute values are also skipped, including values with whitespace around = — <div data-template = "<web-ui-button>"> does not trigger an import.
  • The HTML must pass through a Vite build (vite build). Files in public/ are served as-is, and HTML opened directly from disk is not transformed.

API

unpluginWebComponents(options)

Create an unplugin instance for web component auto-import.

| Parameter | Type | Default | Description | | --------------------- | --------- | ------- | ------------------------------------------- | | options.tagPrefix | string | - | Component tag prefix (e.g. 'web-ui') | | options.packageName | string | - | NPM package name (e.g. '@greypan/web-ui') | | options.sideEffects | boolean | false | Use side-effect imports (import 'pkg') | | options.withStyle | string | - | CSS file to import with each component |

Supported bundlers

| Entry | Module transforms | HTML injection | | ---------- | ----------------------------------- | ------------------------------ | | /vite | Vue (.vue), React (.tsx/.jsx) | Vite HTML entry (index.html) | | /webpack | Vue (.vue), React (.tsx/.jsx) | — |

  • Only /vite and /webpack sub-path exports are published; Rollup and esbuild entries are not provided.
  • HTML injection is a Vite-only capability. The Webpack adapter performs module-source transforms only and does not inject into HTML — Webpack HTML injection would require a separate HtmlWebpackPlugin integration.